RTT::types::TypeInfo Class Reference

#include <TypeInfo.hpp>

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

List of all members.

Public Member Functions

virtual const std::string & getTypeName () const =0
virtual const std::string & getTypeName () const =0
virtual bool installTypeInfoObject ()=0
virtual bool installTypeInfoObject ()=0
virtual ~TypeInfo ()
virtual ~TypeInfo ()
Type building/factory functions

Used to create objects that hold data of a certain type.

virtual void addConstructor (TypeBuilder *tb)
virtual void addConstructor (TypeBuilder *tb)
virtual
base::DataSourceBase::shared_ptr 
buildActionAlias (base::ActionInterface *action, base::DataSourceBase::shared_ptr source) const =0
virtual
base::DataSourceBase::shared_ptr 
buildActionAlias (base::ActionInterface *action, base::DataSourceBase::shared_ptr source) const =0
virtual base::AttributeBasebuildAlias (std::string name, base::DataSourceBase::shared_ptr b) const =0
virtual base::AttributeBasebuildAlias (std::string name, base::DataSourceBase::shared_ptr b) const =0
virtual base::AttributeBasebuildAttribute (std::string name, base::DataSourceBase::shared_ptr source=0) const =0
virtual base::AttributeBasebuildAttribute (std::string name, base::DataSourceBase::shared_ptr source=0) const =0
virtual base::AttributeBasebuildConstant (std::string name, base::DataSourceBase::shared_ptr) const =0
virtual base::AttributeBasebuildConstant (std::string name, base::DataSourceBase::shared_ptr, int sizehint) const
virtual base::AttributeBasebuildConstant (std::string name, base::DataSourceBase::shared_ptr) const =0
virtual base::AttributeBasebuildConstant (std::string name, base::DataSourceBase::shared_ptr, int sizehint) const
virtual base::PropertyBasebuildProperty (const std::string &name, const std::string &desc, base::DataSourceBase::shared_ptr source=0) const =0
virtual base::PropertyBasebuildProperty (const std::string &name, const std::string &desc, base::DataSourceBase::shared_ptr source=0) const =0
virtual
base::DataSourceBase::shared_ptr 
buildReference (void *ptr) const =0
virtual
base::DataSourceBase::shared_ptr 
buildReference (void *ptr) const =0
virtual
base::DataSourceBase::shared_ptr 
buildValue () const =0
virtual
base::DataSourceBase::shared_ptr 
buildValue () const =0
virtual base::AttributeBasebuildVariable (std::string name) const =0
virtual base::AttributeBasebuildVariable (std::string name, int sizehint) const
virtual base::AttributeBasebuildVariable (std::string name) const =0
virtual base::AttributeBasebuildVariable (std::string name, int sizehint) const
virtual
base::DataSourceBase::shared_ptr 
construct (const std::vector< base::DataSourceBase::shared_ptr > &args) const
virtual
base::DataSourceBase::shared_ptr 
construct (const std::vector< base::DataSourceBase::shared_ptr > &args) const
virtual
base::DataSourceBase::shared_ptr 
convert (base::DataSourceBase::shared_ptr arg) const
virtual
base::DataSourceBase::shared_ptr 
convert (base::DataSourceBase::shared_ptr arg) const
virtual bool resize (base::DataSourceBase::shared_ptr arg, int size) const
virtual bool resize (base::DataSourceBase::shared_ptr arg, int size) const
Inspecting data structures.

Used to write a complex type to an external representation, like XML.

virtual bool composeType (base::DataSourceBase::shared_ptr source, base::DataSourceBase::shared_ptr target) const =0
virtual bool composeType (base::DataSourceBase::shared_ptr source, base::DataSourceBase::shared_ptr target) const =0
virtual
base::DataSourceBase::shared_ptr 
convertType (base::DataSourceBase::shared_ptr source) const
virtual
base::DataSourceBase::shared_ptr 
convertType (base::DataSourceBase::shared_ptr source) 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
virtual
base::DataSourceBase::shared_ptr 
getMember (base::DataSourceBase::shared_ptr item, base::DataSourceBase::shared_ptr id) const
virtual
base::DataSourceBase::shared_ptr 
getMember (base::DataSourceBase::shared_ptr item, const std::string &name) const
virtual
base::DataSourceBase::shared_ptr 
getMember (base::DataSourceBase::shared_ptr item, base::DataSourceBase::shared_ptr id) const
virtual
base::DataSourceBase::shared_ptr 
getMember (base::DataSourceBase::shared_ptr item, const std::string &name) const
virtual std::vector< std::string > getMemberNames () const
virtual std::vector< std::string > getMemberNames () const
Conversion to/from text

Used to convert data to human readable text and vice versa.

virtual bool fromString (const std::string &value, base::DataSourceBase::shared_ptr out) const
virtual bool fromString (const std::string &value, base::DataSourceBase::shared_ptr out) const
virtual bool isStreamable () const =0
virtual bool isStreamable () const =0
virtual std::istream & read (std::istream &os, base::DataSourceBase::shared_ptr out) const =0
virtual std::istream & read (std::istream &os, base::DataSourceBase::shared_ptr out) const =0
virtual std::string toString (base::DataSourceBase::shared_ptr in) const
virtual std::string toString (base::DataSourceBase::shared_ptr in) const
virtual std::ostream & write (std::ostream &os, base::DataSourceBase::shared_ptr in) const =0
virtual std::ostream & write (std::ostream &os, base::DataSourceBase::shared_ptr in) const =0

Protected Types

typedef std::vector
< TypeBuilder * > 
Constructors
typedef std::vector
< TypeBuilder * > 
Constructors
typedef std::vector
< TypeTransporter * > 
Transporters
typedef std::vector
< TypeTransporter * > 
Transporters

Protected Attributes

Constructors constructors
Transporters transporters

Distribution of objects

Used to transport data over a network.



bool addProtocol (int protocol_id, TypeTransporter *tt)
bool addProtocol (int protocol_id, TypeTransporter *tt)
virtual
base::ChannelElementBase::shared_ptr 
buildChannelInput (base::OutputPortInterface &port) const =0
virtual
base::ChannelElementBase::shared_ptr 
buildChannelInput (base::OutputPortInterface &port) const =0
virtual
base::ChannelElementBase::shared_ptr 
buildChannelOutput (base::InputPortInterface &port) const =0
virtual
base::ChannelElementBase::shared_ptr 
buildChannelOutput (base::InputPortInterface &port) const =0
virtual
base::ChannelElementBase::shared_ptr 
buildDataStorage (ConnPolicy const &policy) const =0
virtual
base::ChannelElementBase::shared_ptr 
buildDataStorage (ConnPolicy const &policy) const =0
TypeTransportergetProtocol (int protocol_id) const
TypeTransportergetProtocol (int protocol_id) const
std::vector< int > getTransportNames () const
std::vector< int > getTransportNames () const
virtual std::string getTypeIdName () const =0
virtual std::string getTypeIdName () const =0
bool hasProtocol (int protocol_id) const
bool hasProtocol (int protocol_id) const
virtual base::InputPortInterfaceinputPort (std::string const &name) const =0
virtual base::InputPortInterfaceinputPort (std::string const &name) const =0
virtual base::OutputPortInterfaceoutputPort (std::string const &name) const =0
virtual base::OutputPortInterfaceoutputPort (std::string const &name) const =0
void migrateProtocols (TypeInfo *orig)
void migrateProtocols (TypeInfo *orig)

Detailed Description

A class for representing a user type, and which can build instances of that type.

Definition at line 53 of file install/include/rtt/types/TypeInfo.hpp.


Member Typedef Documentation

typedef std::vector<TypeBuilder*> RTT::types::TypeInfo::Constructors [protected]

Definition at line 56 of file rtt/types/TypeInfo.hpp.

typedef std::vector<TypeBuilder*> RTT::types::TypeInfo::Constructors [protected]

Definition at line 56 of file install/include/rtt/types/TypeInfo.hpp.

typedef std::vector<TypeTransporter*> RTT::types::TypeInfo::Transporters [protected]

Definition at line 57 of file rtt/types/TypeInfo.hpp.

typedef std::vector<TypeTransporter*> RTT::types::TypeInfo::Transporters [protected]

Definition at line 57 of file install/include/rtt/types/TypeInfo.hpp.


Constructor & Destructor Documentation

RTT::TypeInfo::~TypeInfo (  )  [virtual]

Definition at line 68 of file TypeInfo.cpp.

virtual RTT::types::TypeInfo::~TypeInfo (  )  [virtual]

Member Function Documentation

virtual void RTT::types::TypeInfo::addConstructor ( TypeBuilder tb  )  [virtual]

Add a constructor/convertor object.

void RTT::TypeInfo::addConstructor ( TypeBuilder tb  )  [virtual]

Add a constructor/convertor object.

Definition at line 106 of file TypeInfo.cpp.

bool RTT::types::TypeInfo::addProtocol ( int  protocol_id,
TypeTransporter tt 
)

Register a protocol for data transport over a network.

bool RTT::TypeInfo::addProtocol ( int  protocol_id,
TypeTransporter tt 
)

Register a protocol for data transport over a network.

Definition at line 160 of file TypeInfo.cpp.

virtual base::DataSourceBase::shared_ptr RTT::types::TypeInfo::buildActionAlias ( base::ActionInterface action,
base::DataSourceBase::shared_ptr  source 
) const [pure virtual]
virtual base::DataSourceBase::shared_ptr RTT::types::TypeInfo::buildActionAlias ( base::ActionInterface action,
base::DataSourceBase::shared_ptr  source 
) const [pure virtual]
virtual base::AttributeBase* RTT::types::TypeInfo::buildAlias ( std::string  name,
base::DataSourceBase::shared_ptr  b 
) const [pure virtual]
virtual base::AttributeBase* RTT::types::TypeInfo::buildAlias ( std::string  name,
base::DataSourceBase::shared_ptr  b 
) const [pure virtual]
virtual base::AttributeBase* RTT::types::TypeInfo::buildAttribute ( std::string  name,
base::DataSourceBase::shared_ptr  source = 0 
) const [pure virtual]
virtual base::AttributeBase* RTT::types::TypeInfo::buildAttribute ( std::string  name,
base::DataSourceBase::shared_ptr  source = 0 
) const [pure virtual]
virtual base::ChannelElementBase::shared_ptr RTT::types::TypeInfo::buildChannelInput ( base::OutputPortInterface port  )  const [pure virtual]
virtual base::ChannelElementBase::shared_ptr RTT::types::TypeInfo::buildChannelInput ( base::OutputPortInterface port  )  const [pure virtual]
virtual base::ChannelElementBase::shared_ptr RTT::types::TypeInfo::buildChannelOutput ( base::InputPortInterface port  )  const [pure virtual]
virtual base::ChannelElementBase::shared_ptr RTT::types::TypeInfo::buildChannelOutput ( base::InputPortInterface port  )  const [pure virtual]
virtual base::AttributeBase* RTT::types::TypeInfo::buildConstant ( std::string  name,
base::DataSourceBase::shared_ptr   
) const [pure virtual]
virtual base::AttributeBase* RTT::types::TypeInfo::buildConstant ( std::string  name,
base::DataSourceBase::shared_ptr  ,
int  sizehint 
) const [virtual]

Build a non modifyable instance of this type.

Parameters:
sizehint For variable size instances, use it to hint the size of the instance.
virtual base::AttributeBase* RTT::types::TypeInfo::buildConstant ( std::string  name,
base::DataSourceBase::shared_ptr   
) const [pure virtual]
virtual base::AttributeBase* RTT::types::TypeInfo::buildConstant ( std::string  name,
base::DataSourceBase::shared_ptr  ,
int  sizehint 
) const [virtual]

Build a non modifyable instance of this type.

Parameters:
sizehint For variable size instances, use it to hint the size of the instance.
virtual base::ChannelElementBase::shared_ptr RTT::types::TypeInfo::buildDataStorage ( ConnPolicy const &  policy  )  const [pure virtual]
virtual base::ChannelElementBase::shared_ptr RTT::types::TypeInfo::buildDataStorage ( ConnPolicy const &  policy  )  const [pure virtual]
virtual base::PropertyBase* RTT::types::TypeInfo::buildProperty ( const std::string &  name,
const std::string &  desc,
base::DataSourceBase::shared_ptr  source = 0 
) const [pure virtual]
virtual base::PropertyBase* RTT::types::TypeInfo::buildProperty ( const std::string &  name,
const std::string &  desc,
base::DataSourceBase::shared_ptr  source = 0 
) const [pure virtual]
virtual base::DataSourceBase::shared_ptr RTT::types::TypeInfo::buildReference ( void *  ptr  )  const [pure virtual]
virtual base::DataSourceBase::shared_ptr RTT::types::TypeInfo::buildReference ( void *  ptr  )  const [pure virtual]
virtual base::DataSourceBase::shared_ptr RTT::types::TypeInfo::buildValue (  )  const [pure virtual]
virtual base::DataSourceBase::shared_ptr RTT::types::TypeInfo::buildValue (  )  const [pure virtual]
virtual base::AttributeBase* RTT::types::TypeInfo::buildVariable ( std::string  name  )  const [pure virtual]
virtual base::AttributeBase* RTT::types::TypeInfo::buildVariable ( std::string  name,
int  sizehint 
) const [virtual]
virtual base::AttributeBase* RTT::types::TypeInfo::buildVariable ( std::string  name  )  const [pure virtual]
AttributeBase * RTT::TypeInfo::buildVariable ( std::string  name,
int  sizehint 
) const [virtual]
virtual bool RTT::types::TypeInfo::composeType ( base::DataSourceBase::shared_ptr  source,
base::DataSourceBase::shared_ptr  target 
) const [pure 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.

Implemented in RTT::types::RTStringTypeInfo, RTT::types::StdStringTypeInfo, RTT::types::StdTypeInfo< T >, RTT::types::EnumTypeInfo< T >, RTT::types::TemplateTypeInfo< T, use_ostream >, RTT::types::EmptyTypeInfo, RTT::types::RTStringTypeInfo, RTT::types::StdStringTypeInfo, RTT::types::StdTypeInfo< T >, RTT::types::EnumTypeInfo< T >, RTT::types::TemplateTypeInfo< T, use_ostream >, RTT::types::EmptyTypeInfo, RTT::types::TemplateTypeInfo< T, has_ostream >, RTT::types::TemplateTypeInfo< T, has_ostream >, RTT::types::TemplateTypeInfo< std::string, has_ostream >, RTT::types::TemplateTypeInfo< std::string, has_ostream >, RTT::types::TemplateTypeInfo< rt_string, has_ostream >, RTT::types::TemplateTypeInfo< rt_string, has_ostream >, RTT::types::TemplateTypeInfo< std::vector< double >, has_ostream >, RTT::types::TemplateTypeInfo< std::vector< double >, has_ostream >, RTT::types::TemplateTypeInfo< T, true >, RTT::types::TemplateTypeInfo< T, true >, RTT::types::TemplateTypeInfo< bool >, RTT::types::TemplateTypeInfo< bool >, RTT::types::TemplateTypeInfo< std::vector< T >, has_ostream >, RTT::types::TemplateTypeInfo< std::vector< T >, has_ostream >, RTT::types::TemplateTypeInfo< T, false >, and RTT::types::TemplateTypeInfo< T, false >.

virtual bool RTT::types::TypeInfo::composeType ( base::DataSourceBase::shared_ptr  source,
base::DataSourceBase::shared_ptr  target 
) const [pure 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.

Implemented in RTT::types::RTStringTypeInfo, RTT::types::StdStringTypeInfo, RTT::types::StdTypeInfo< T >, RTT::types::EnumTypeInfo< T >, RTT::types::TemplateTypeInfo< T, use_ostream >, RTT::types::EmptyTypeInfo, RTT::types::RTStringTypeInfo, RTT::types::StdStringTypeInfo, RTT::types::StdTypeInfo< T >, RTT::types::EnumTypeInfo< T >, RTT::types::TemplateTypeInfo< T, use_ostream >, RTT::types::EmptyTypeInfo, RTT::types::TemplateTypeInfo< T, has_ostream >, RTT::types::TemplateTypeInfo< T, has_ostream >, RTT::types::TemplateTypeInfo< std::string, has_ostream >, RTT::types::TemplateTypeInfo< std::string, has_ostream >, RTT::types::TemplateTypeInfo< rt_string, has_ostream >, RTT::types::TemplateTypeInfo< rt_string, has_ostream >, RTT::types::TemplateTypeInfo< std::vector< double >, has_ostream >, RTT::types::TemplateTypeInfo< std::vector< double >, has_ostream >, RTT::types::TemplateTypeInfo< T, true >, RTT::types::TemplateTypeInfo< T, true >, RTT::types::TemplateTypeInfo< bool >, RTT::types::TemplateTypeInfo< bool >, RTT::types::TemplateTypeInfo< std::vector< T >, has_ostream >, RTT::types::TemplateTypeInfo< std::vector< T >, has_ostream >, RTT::types::TemplateTypeInfo< T, false >, and RTT::types::TemplateTypeInfo< T, false >.

virtual base::DataSourceBase::shared_ptr RTT::types::TypeInfo::construct ( const std::vector< base::DataSourceBase::shared_ptr > &  args  )  const [virtual]

Constructor syntax: construct a internal::DataSource which returns an instance of data depending on the given arguments. When args is empty, the default 'variable' is returned.

Reimplemented in RTT::types::EmptyTypeInfo, and RTT::types::EmptyTypeInfo.

virtual base::DataSourceBase::shared_ptr RTT::types::TypeInfo::construct ( const std::vector< base::DataSourceBase::shared_ptr > &  args  )  const [virtual]

Constructor syntax: construct a internal::DataSource which returns an instance of data depending on the given arguments. When args is empty, the default 'variable' is returned.

Reimplemented in RTT::types::EmptyTypeInfo, and RTT::types::EmptyTypeInfo.

virtual base::DataSourceBase::shared_ptr RTT::types::TypeInfo::convert ( base::DataSourceBase::shared_ptr  arg  )  const [virtual]

Automatic conversion: convert a internal::DataSource to this type. For example, for converting float -> double. If no valid conversion was found, returns arg again, otherwise, a new data source.

virtual base::DataSourceBase::shared_ptr RTT::types::TypeInfo::convert ( base::DataSourceBase::shared_ptr  arg  )  const [virtual]

Automatic conversion: convert a internal::DataSource to this type. For example, for converting float -> double. If no valid conversion was found, returns arg again, otherwise, a new data source.

virtual base::DataSourceBase::shared_ptr RTT::types::TypeInfo::convertType ( base::DataSourceBase::shared_ptr  source  )  const [virtual]

Specialize this function to return an alternate type which represents this one in a compatible way. For example, a short converts to an long or an enum to an int or a string.

Returns:
null if this type is not convertible to anything else.
Deprecated:
by decomposeType. We want to rename convertType to decomposeType. This function is left here for transitional purposes.
base::DataSourceBase::shared_ptr RTT::TypeInfo::convertType ( base::DataSourceBase::shared_ptr  source  )  const [virtual]

Specialize this function to return an alternate type which represents this one in a compatible way. For example, a short converts to an long or an enum to an int or a string.

Returns:
null if this type is not convertible to anything else.
Deprecated:
by decomposeType. We want to rename convertType to decomposeType. This function is left here for transitional purposes.

Definition at line 134 of file TypeInfo.cpp.

virtual base::DataSourceBase::shared_ptr RTT::types::TypeInfo::decomposeType ( base::DataSourceBase::shared_ptr  source  )  const [virtual]

Specialize this function to return an alternate type which represents this one in a compatible way. For example, a short converts to an long or an enum to an int or a string. If your return a datasource containing a property bag, then this function should do the inverse of composeType: the returned property bag contains all parts of the current type (source) which can be modified and merged back into this type with composeType. Mathematically: composeType( decomposeType( A ), B); assert( A == B );

Returns:
null if this type is not convertible to anything else. You may return source itself in order to prevent any further decomposition of your type (using getMember(), which is used as fall-back by the rest of the software). For example, to avoid that a string is decomposed into a sequence of chars.

Reimplemented in RTT::types::RTStringTypeInfo, RTT::types::StdStringTypeInfo, RTT::types::StdTypeInfo< T >, RTT::types::EnumTypeInfo< T >, RTT::types::TemplateTypeInfo< T, use_ostream >, RTT::types::EmptyTypeInfo, RTT::types::RTStringTypeInfo, RTT::types::StdStringTypeInfo, RTT::types::StdTypeInfo< T >, RTT::types::EnumTypeInfo< T >, RTT::types::TemplateTypeInfo< T, use_ostream >, RTT::types::EmptyTypeInfo, RTT::types::TemplateTypeInfo< T, has_ostream >, RTT::types::TemplateTypeInfo< T, has_ostream >, RTT::types::TemplateTypeInfo< std::string, has_ostream >, RTT::types::TemplateTypeInfo< std::string, has_ostream >, RTT::types::TemplateTypeInfo< rt_string, has_ostream >, RTT::types::TemplateTypeInfo< rt_string, has_ostream >, RTT::types::TemplateTypeInfo< std::vector< double >, has_ostream >, RTT::types::TemplateTypeInfo< std::vector< double >, has_ostream >, RTT::types::TemplateTypeInfo< T, true >, RTT::types::TemplateTypeInfo< T, true >, RTT::types::TemplateTypeInfo< bool >, RTT::types::TemplateTypeInfo< bool >, RTT::types::TemplateTypeInfo< std::vector< T >, has_ostream >, RTT::types::TemplateTypeInfo< std::vector< T >, has_ostream >, RTT::types::TemplateTypeInfo< T, false >, and RTT::types::TemplateTypeInfo< T, false >.

base::DataSourceBase::shared_ptr RTT::TypeInfo::decomposeType ( base::DataSourceBase::shared_ptr  source  )  const [virtual]

Specialize this function to return an alternate type which represents this one in a compatible way. For example, a short converts to an long or an enum to an int or a string. If your return a datasource containing a property bag, then this function should do the inverse of composeType: the returned property bag contains all parts of the current type (source) which can be modified and merged back into this type with composeType. Mathematically: composeType( decomposeType( A ), B); assert( A == B );

Returns:
null if this type is not convertible to anything else. You may return source itself in order to prevent any further decomposition of your type (using getMember(), which is used as fall-back by the rest of the software). For example, to avoid that a string is decomposed into a sequence of chars.

Reimplemented in RTT::types::RTStringTypeInfo, RTT::types::StdStringTypeInfo, RTT::types::StdTypeInfo< T >, RTT::types::EnumTypeInfo< T >, RTT::types::TemplateTypeInfo< T, use_ostream >, RTT::types::EmptyTypeInfo, RTT::types::RTStringTypeInfo, RTT::types::StdStringTypeInfo, RTT::types::StdTypeInfo< T >, RTT::types::EnumTypeInfo< T >, RTT::types::TemplateTypeInfo< T, use_ostream >, RTT::types::EmptyTypeInfo, RTT::types::TemplateTypeInfo< T, has_ostream >, RTT::types::TemplateTypeInfo< T, has_ostream >, RTT::types::TemplateTypeInfo< std::string, has_ostream >, RTT::types::TemplateTypeInfo< std::string, has_ostream >, RTT::types::TemplateTypeInfo< rt_string, has_ostream >, RTT::types::TemplateTypeInfo< rt_string, has_ostream >, RTT::types::TemplateTypeInfo< std::vector< double >, has_ostream >, RTT::types::TemplateTypeInfo< std::vector< double >, has_ostream >, RTT::types::TemplateTypeInfo< T, true >, RTT::types::TemplateTypeInfo< T, true >, RTT::types::TemplateTypeInfo< bool >, RTT::types::TemplateTypeInfo< bool >, RTT::types::TemplateTypeInfo< std::vector< T >, has_ostream >, RTT::types::TemplateTypeInfo< std::vector< T >, has_ostream >, RTT::types::TemplateTypeInfo< T, false >, and RTT::types::TemplateTypeInfo< T, false >.

Definition at line 128 of file TypeInfo.cpp.

virtual bool RTT::types::TypeInfo::fromString ( const std::string &  value,
base::DataSourceBase::shared_ptr  out 
) const [virtual]

Usability function which converts a string to data.

virtual bool RTT::types::TypeInfo::fromString ( const std::string &  value,
base::DataSourceBase::shared_ptr  out 
) const [virtual]

Usability function which converts a string to data.

virtual base::DataSourceBase::shared_ptr RTT::types::TypeInfo::getMember ( base::DataSourceBase::shared_ptr  item,
base::DataSourceBase::shared_ptr  id 
) const [virtual]
virtual base::DataSourceBase::shared_ptr RTT::types::TypeInfo::getMember ( base::DataSourceBase::shared_ptr  item,
const std::string &  name 
) const [virtual]
virtual base::DataSourceBase::shared_ptr RTT::types::TypeInfo::getMember ( base::DataSourceBase::shared_ptr  item,
base::DataSourceBase::shared_ptr  id 
) const [virtual]
virtual base::DataSourceBase::shared_ptr RTT::types::TypeInfo::getMember ( base::DataSourceBase::shared_ptr  item,
const std::string &  name 
) const [virtual]
virtual std::vector<std::string> RTT::types::TypeInfo::getMemberNames (  )  const [virtual]
vector< string > RTT::TypeInfo::getMemberNames (  )  const [virtual]
TypeTransporter* RTT::types::TypeInfo::getProtocol ( int  protocol_id  )  const

Returns this type's transport for a given protocol. Will print a warning when returning null. Use hasProtocol() to query without warning.

TypeTransporter * RTT::TypeInfo::getProtocol ( int  protocol_id  )  const

Returns this type's transport for a given protocol. Will print a warning when returning null. Use hasProtocol() to query without warning.

Definition at line 172 of file TypeInfo.cpp.

std::vector<int> RTT::types::TypeInfo::getTransportNames (  )  const

Return a list of protocols that have transporters

std::vector< int > RTT::TypeInfo::getTransportNames (  )  const

Return a list of protocols that have transporters

Definition at line 209 of file TypeInfo.cpp.

virtual std::string RTT::types::TypeInfo::getTypeIdName (  )  const [pure virtual]
virtual std::string RTT::types::TypeInfo::getTypeIdName (  )  const [pure virtual]
virtual const std::string& RTT::types::TypeInfo::getTypeName (  )  const [pure virtual]
virtual const std::string& RTT::types::TypeInfo::getTypeName (  )  const [pure virtual]
bool RTT::types::TypeInfo::hasProtocol ( int  protocol_id  )  const

Check if this type is transporable over a given protocol.

bool RTT::TypeInfo::hasProtocol ( int  protocol_id  )  const

Check if this type is transporable over a given protocol.

Definition at line 197 of file TypeInfo.cpp.

virtual base::InputPortInterface* RTT::types::TypeInfo::inputPort ( std::string const &  name  )  const [pure virtual]
virtual base::InputPortInterface* RTT::types::TypeInfo::inputPort ( std::string const &  name  )  const [pure virtual]
virtual bool RTT::types::TypeInfo::installTypeInfoObject (  )  [pure virtual]

Installs the type info object in the global data source type info handler. This will be called by the TypeInfoRepository, prior to registering this type. If installation fails the TypeInfoRepository will delete this object, and all its associated constructors.

Return values:
true installation succeeded. This object should not be deleted during the execution of the current process.
false installation failed. This object is not used and may be deleted.

Implemented in RTT::types::TemplateTypeInfo< T, use_ostream >, RTT::types::EmptyTypeInfo, RTT::types::TypeInfoName< T >, RTT::types::TemplateTypeInfo< T, use_ostream >, RTT::types::EmptyTypeInfo, RTT::types::TypeInfoName< T >, RTT::types::TemplateTypeInfo< T, has_ostream >, RTT::types::TemplateTypeInfo< T, has_ostream >, RTT::types::TemplateTypeInfo< std::string, has_ostream >, RTT::types::TemplateTypeInfo< std::string, has_ostream >, RTT::types::TemplateTypeInfo< rt_string, has_ostream >, RTT::types::TemplateTypeInfo< rt_string, has_ostream >, RTT::types::TemplateTypeInfo< std::vector< double >, has_ostream >, RTT::types::TemplateTypeInfo< std::vector< double >, has_ostream >, RTT::types::TemplateTypeInfo< T, true >, RTT::types::TemplateTypeInfo< T, true >, RTT::types::TemplateTypeInfo< bool >, RTT::types::TemplateTypeInfo< bool >, RTT::types::TemplateTypeInfo< std::vector< T >, has_ostream >, RTT::types::TemplateTypeInfo< std::vector< T >, has_ostream >, RTT::types::TemplateTypeInfo< T, false >, and RTT::types::TemplateTypeInfo< T, false >.

virtual bool RTT::types::TypeInfo::installTypeInfoObject (  )  [pure virtual]

Installs the type info object in the global data source type info handler. This will be called by the TypeInfoRepository, prior to registering this type. If installation fails the TypeInfoRepository will delete this object, and all its associated constructors.

Return values:
true installation succeeded. This object should not be deleted during the execution of the current process.
false installation failed. This object is not used and may be deleted.

Implemented in RTT::types::TemplateTypeInfo< T, use_ostream >, RTT::types::EmptyTypeInfo, RTT::types::TypeInfoName< T >, RTT::types::TemplateTypeInfo< T, use_ostream >, RTT::types::EmptyTypeInfo, RTT::types::TypeInfoName< T >, RTT::types::TemplateTypeInfo< T, has_ostream >, RTT::types::TemplateTypeInfo< T, has_ostream >, RTT::types::TemplateTypeInfo< std::string, has_ostream >, RTT::types::TemplateTypeInfo< std::string, has_ostream >, RTT::types::TemplateTypeInfo< rt_string, has_ostream >, RTT::types::TemplateTypeInfo< rt_string, has_ostream >, RTT::types::TemplateTypeInfo< std::vector< double >, has_ostream >, RTT::types::TemplateTypeInfo< std::vector< double >, has_ostream >, RTT::types::TemplateTypeInfo< T, true >, RTT::types::TemplateTypeInfo< T, true >, RTT::types::TemplateTypeInfo< bool >, RTT::types::TemplateTypeInfo< bool >, RTT::types::TemplateTypeInfo< std::vector< T >, has_ostream >, RTT::types::TemplateTypeInfo< std::vector< T >, has_ostream >, RTT::types::TemplateTypeInfo< T, false >, and RTT::types::TemplateTypeInfo< T, false >.

virtual bool RTT::types::TypeInfo::isStreamable (  )  const [pure virtual]
virtual bool RTT::types::TypeInfo::isStreamable (  )  const [pure virtual]
void RTT::types::TypeInfo::migrateProtocols ( TypeInfo orig  )  [protected]

Migrates all protocols present in orig to this type info object. It is meant as a helper when a type info object is replaced by a new instance.

Precondition:
This type has no transports registered yet, ie, it is newly constructed.
void RTT::TypeInfo::migrateProtocols ( TypeInfo orig  )  [protected]

Migrates all protocols present in orig to this type info object. It is meant as a helper when a type info object is replaced by a new instance.

Precondition:
This type has no transports registered yet, ie, it is newly constructed.

Definition at line 190 of file TypeInfo.cpp.

virtual base::OutputPortInterface* RTT::types::TypeInfo::outputPort ( std::string const &  name  )  const [pure virtual]
virtual base::OutputPortInterface* RTT::types::TypeInfo::outputPort ( std::string const &  name  )  const [pure virtual]
virtual std::istream& RTT::types::TypeInfo::read ( std::istream &  os,
base::DataSourceBase::shared_ptr  out 
) const [pure virtual]
virtual std::istream& RTT::types::TypeInfo::read ( std::istream &  os,
base::DataSourceBase::shared_ptr  out 
) const [pure virtual]
virtual bool RTT::types::TypeInfo::resize ( base::DataSourceBase::shared_ptr  arg,
int  size 
) const [virtual]
bool RTT::TypeInfo::resize ( base::DataSourceBase::shared_ptr  arg,
int  size 
) const [virtual]
virtual std::string RTT::types::TypeInfo::toString ( base::DataSourceBase::shared_ptr  in  )  const [virtual]

Usability function which converts data to a string.

virtual std::string RTT::types::TypeInfo::toString ( base::DataSourceBase::shared_ptr  in  )  const [virtual]

Usability function which converts data to a string.

virtual std::ostream& RTT::types::TypeInfo::write ( std::ostream &  os,
base::DataSourceBase::shared_ptr  in 
) const [pure virtual]
virtual std::ostream& RTT::types::TypeInfo::write ( std::ostream &  os,
base::DataSourceBase::shared_ptr  in 
) const [pure virtual]

Member Data Documentation

Definition at line 58 of file install/include/rtt/types/TypeInfo.hpp.

Definition at line 59 of file install/include/rtt/types/TypeInfo.hpp.


The documentation for this class 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:19 2013