RTT::types::StdTypeInfo< T > Struct Template Reference

#include <StdTypeInfo.hpp>

Inheritance diagram for RTT::types::StdTypeInfo< T >:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual bool composeType (base::DataSourceBase::shared_ptr source, base::DataSourceBase::shared_ptr result) const
virtual bool composeType (base::DataSourceBase::shared_ptr source, base::DataSourceBase::shared_ptr result) const
virtual
base::DataSourceBase::shared_ptr 
decomposeType (base::DataSourceBase::shared_ptr source) const
virtual
base::DataSourceBase::shared_ptr 
decomposeType (base::DataSourceBase::shared_ptr source) const
 StdTypeInfo (const char *type)
 StdTypeInfo (const char *type)

Detailed Description

template<class T>
struct RTT::types::StdTypeInfo< T >

Type information for standard C types or structs of which no introspection is required. No boost::serialization function is required to use this class.

See also:
StructTypeInfo

Definition at line 56 of file install/include/rtt/typekit/StdTypeInfo.hpp.


Constructor & Destructor Documentation

template<class T >
RTT::types::StdTypeInfo< T >::StdTypeInfo ( const char *  type  )  [inline]

Definition at line 59 of file install/include/rtt/typekit/StdTypeInfo.hpp.

template<class T >
RTT::types::StdTypeInfo< T >::StdTypeInfo ( const char *  type  )  [inline]

Definition at line 59 of file rtt/typekit/StdTypeInfo.hpp.


Member Function Documentation

template<class T >
virtual bool RTT::types::StdTypeInfo< T >::composeType ( base::DataSourceBase::shared_ptr  source,
base::DataSourceBase::shared_ptr  target 
) const [inline, virtual]

Compose a type (target) from a DataSourceBase (source) containing its members. The default behavior tries to assign source to target. If that fails, it tries to decompose target into its members and update the members of target with the contents of source.

The default implementation in TemplateTypeInfo works for most types, but can be overridden in case there are multiple versions/possibilities to make a target from a source. For example, in order to support legacy formats or in order to do the inverse of decomposeType().

Parameters:
source A data source of the same type as target OR a PropertyBag that contains the parts of target to be refreshed.
target A data source of the same type as this TypeInfo object which contains the data to be updated from source.
Returns:
true if source could be updated, false otherwise.
See also:
types::propertyDecomposition and types::typeDecomposition for the inverse function, decomposing a type into datasources and hierarchical properties.
decomposeType to do the inverse operation.

Reimplemented from RTT::types::TemplateTypeInfo< T, true >.

Definition at line 63 of file rtt/typekit/StdTypeInfo.hpp.

template<class T >
virtual bool RTT::types::StdTypeInfo< T >::composeType ( base::DataSourceBase::shared_ptr  source,
base::DataSourceBase::shared_ptr  target 
) const [inline, virtual]

Compose a type (target) from a DataSourceBase (source) containing its members. The default behavior tries to assign source to target. If that fails, it tries to decompose target into its members and update the members of target with the contents of source.

The default implementation in TemplateTypeInfo works for most types, but can be overridden in case there are multiple versions/possibilities to make a target from a source. For example, in order to support legacy formats or in order to do the inverse of decomposeType().

Parameters:
source A data source of the same type as target OR a PropertyBag that contains the parts of target to be refreshed.
target A data source of the same type as this TypeInfo object which contains the data to be updated from source.
Returns:
true if source could be updated, false otherwise.
See also:
types::propertyDecomposition and types::typeDecomposition for the inverse function, decomposing a type into datasources and hierarchical properties.
decomposeType to do the inverse operation.

Reimplemented from RTT::types::TemplateTypeInfo< T, true >.

Definition at line 63 of file install/include/rtt/typekit/StdTypeInfo.hpp.

template<class T >
virtual base::DataSourceBase::shared_ptr RTT::types::StdTypeInfo< T >::decomposeType ( base::DataSourceBase::shared_ptr  source  )  const [inline, virtual]

A primitive type is decomposed into itself.

Reimplemented from RTT::types::TemplateTypeInfo< T, true >.

Definition at line 73 of file rtt/typekit/StdTypeInfo.hpp.

template<class T >
virtual base::DataSourceBase::shared_ptr RTT::types::StdTypeInfo< T >::decomposeType ( base::DataSourceBase::shared_ptr  source  )  const [inline, virtual]

A primitive type is decomposed into itself.

Reimplemented from RTT::types::TemplateTypeInfo< T, true >.

Definition at line 73 of file install/include/rtt/typekit/StdTypeInfo.hpp.


The documentation for this struct was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


rtt
Author(s): RTT Developers
autogenerated on Fri Jan 11 09:50:18 2013