RTT::types::StdStringTypeInfo Struct Reference

#include <StdStringTypeInfo.hpp>

Inheritance diagram for RTT::types::StdStringTypeInfo:
Inheritance graph
[legend]

List of all members.

Public Member Functions

base::AttributeBasebuildVariable (std::string name, int size) const
base::AttributeBasebuildVariable (std::string name, int size) const
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
 StdStringTypeInfo (const std::string &tname="string")
 StdStringTypeInfo (const std::string &tname="string")

Detailed Description

Standard string specialisation that removes decomposition.

Definition at line 50 of file install/include/rtt/typekit/StdStringTypeInfo.hpp.


Constructor & Destructor Documentation

RTT::types::StdStringTypeInfo::StdStringTypeInfo ( const std::string &  tname = "string"  )  [inline]
RTT::types::StdStringTypeInfo::StdStringTypeInfo ( const std::string &  tname = "string"  )  [inline]

Definition at line 52 of file rtt/typekit/StdStringTypeInfo.hpp.


Member Function Documentation

base::AttributeBase* RTT::types::StdStringTypeInfo::buildVariable ( std::string  name,
int  sizehint 
) const [inline, virtual]

Build a modifyable instance of this type.

Parameters:
sizehint For variable size instances, use it to hint the size of the instance.

Reimplemented from RTT::types::SequenceTypeInfo< std::string, true >.

Definition at line 57 of file rtt/typekit/StdStringTypeInfo.hpp.

base::AttributeBase* RTT::types::StdStringTypeInfo::buildVariable ( std::string  name,
int  sizehint 
) const [inline, virtual]

Build a modifyable instance of this type.

Parameters:
sizehint For variable size instances, use it to hint the size of the instance.

Reimplemented from RTT::types::SequenceTypeInfo< std::string, true >.

Definition at line 57 of file install/include/rtt/typekit/StdStringTypeInfo.hpp.

virtual bool RTT::types::StdStringTypeInfo::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< std::string, has_ostream >.

Definition at line 68 of file rtt/typekit/StdStringTypeInfo.hpp.

virtual bool RTT::types::StdStringTypeInfo::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< std::string, has_ostream >.

Definition at line 68 of file install/include/rtt/typekit/StdStringTypeInfo.hpp.

virtual base::DataSourceBase::shared_ptr RTT::types::StdStringTypeInfo::decomposeType ( base::DataSourceBase::shared_ptr  source  )  const [inline, virtual]

A string is decomposed into itself.

Reimplemented from RTT::types::TemplateTypeInfo< std::string, has_ostream >.

Definition at line 79 of file rtt/typekit/StdStringTypeInfo.hpp.

virtual base::DataSourceBase::shared_ptr RTT::types::StdStringTypeInfo::decomposeType ( base::DataSourceBase::shared_ptr  source  )  const [inline, virtual]

A string is decomposed into itself.

Reimplemented from RTT::types::TemplateTypeInfo< std::string, has_ostream >.

Definition at line 79 of file install/include/rtt/typekit/StdStringTypeInfo.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