RTT::types::TemplateTypeInfo< T, use_ostream > Class Template Reference

#include <TemplateTypeInfo.hpp>

Inheritance diagram for RTT::types::TemplateTypeInfo< T, use_ostream >:
Inheritance graph
[legend]

List of all members.

Public Types

typedef Property< T >
::DataSourceType 
PropertyType
typedef Property< T >
::DataSourceType 
PropertyType
typedef T UserType
typedef T UserType

Public Member Functions

base::DataSourceBase::shared_ptr buildActionAlias (base::ActionInterface *action, base::DataSourceBase::shared_ptr in) const
base::DataSourceBase::shared_ptr buildActionAlias (base::ActionInterface *action, base::DataSourceBase::shared_ptr in) const
base::AttributeBasebuildAlias (std::string name, base::DataSourceBase::shared_ptr in) const
base::AttributeBasebuildAlias (std::string name, base::DataSourceBase::shared_ptr in) const
base::AttributeBasebuildAttribute (std::string name, base::DataSourceBase::shared_ptr in) const
base::AttributeBasebuildAttribute (std::string name, base::DataSourceBase::shared_ptr in) const
base::ChannelElementBase::shared_ptr buildChannelInput (base::OutputPortInterface &port) const
base::ChannelElementBase::shared_ptr buildChannelInput (base::OutputPortInterface &port) const
base::ChannelElementBase::shared_ptr buildChannelOutput (base::InputPortInterface &port) const
base::ChannelElementBase::shared_ptr buildChannelOutput (base::InputPortInterface &port) const
base::AttributeBasebuildConstant (std::string name, base::DataSourceBase::shared_ptr dsb) const
base::AttributeBasebuildConstant (std::string name, base::DataSourceBase::shared_ptr dsb) const
base::ChannelElementBase::shared_ptr buildDataStorage (ConnPolicy const &policy) const
base::ChannelElementBase::shared_ptr buildDataStorage (ConnPolicy const &policy) const
virtual base::PropertyBasebuildProperty (const std::string &name, const std::string &desc, base::DataSourceBase::shared_ptr source=0) const
virtual base::PropertyBasebuildProperty (const std::string &name, const std::string &desc, base::DataSourceBase::shared_ptr source=0) const
virtual
base::DataSourceBase::shared_ptr 
buildReference (void *ptr) const
virtual
base::DataSourceBase::shared_ptr 
buildReference (void *ptr) const
virtual
base::DataSourceBase::shared_ptr 
buildValue () const
virtual
base::DataSourceBase::shared_ptr 
buildValue () const
base::AttributeBasebuildVariable (std::string name) const
base::AttributeBasebuildVariable (std::string name) 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 bool composeTypeImpl (const PropertyBag &source, typename internal::AssignableDataSource< T >::reference_t result) const
virtual bool composeTypeImpl (const PropertyBag &source, typename internal::AssignableDataSource< T >::reference_t result) const
virtual bool decomposeType (base::DataSourceBase::shared_ptr source, PropertyBag &targetbag) const
virtual
base::DataSourceBase::shared_ptr 
decomposeType (base::DataSourceBase::shared_ptr source) const
virtual bool decomposeType (base::DataSourceBase::shared_ptr source, PropertyBag &targetbag) const
virtual
base::DataSourceBase::shared_ptr 
decomposeType (base::DataSourceBase::shared_ptr source) const
virtual bool decomposeTypeImpl (typename internal::AssignableDataSource< T >::const_reference_t source, PropertyBag &targetbag) const
virtual bool decomposeTypeImpl (typename internal::AssignableDataSource< T >::const_reference_t source, PropertyBag &targetbag) const
std::string getTypeIdName () const
std::string getTypeIdName () const
virtual const std::string & getTypeName () const
virtual const std::string & getTypeName () const
base::InputPortInterfaceinputPort (std::string const &name) const
base::InputPortInterfaceinputPort (std::string const &name) const
bool installTypeInfoObject ()
bool installTypeInfoObject ()
virtual bool isStreamable () const
virtual bool isStreamable () const
base::OutputPortInterfaceoutputPort (std::string const &name) const
base::OutputPortInterfaceoutputPort (std::string const &name) const
virtual std::istream & read (std::istream &os, base::DataSourceBase::shared_ptr out) const
virtual std::istream & read (std::istream &os, base::DataSourceBase::shared_ptr out) const
 TemplateTypeInfo (std::string name)
 TemplateTypeInfo (std::string name)
virtual std::ostream & write (std::ostream &os, base::DataSourceBase::shared_ptr in) const
virtual std::ostream & write (std::ostream &os, base::DataSourceBase::shared_ptr in) const
virtual ~TemplateTypeInfo ()
virtual ~TemplateTypeInfo ()

Private Attributes

const std::string tname

Detailed Description

template<typename T, bool use_ostream = false>
class RTT::types::TemplateTypeInfo< T, use_ostream >

This template class allows user types to be added to Orocos. It provides 'default' implementations for virtual functions of TypeInfo. For user defined types, this is very likely not satisfactory and the user needs to override the methods of this class in a subclass or provide specialised global functions.

Parameters:
T The user class type.
use_ostream When set to true, the class will use operator<<(std::ostream&, T) to write out the type to a stream. When set to false, the class will use this function and write '( type name )' to a stream instead. Defaults to false. Set to true if your class T has the above mentioned function.
See also:
TypeInfoRepository.
operator<<
StructTypeInfo, SequenceTypeInfo

Definition at line 111 of file install/include/rtt/types/TemplateTypeInfo.hpp.


Member Typedef Documentation

template<typename T, bool use_ostream = false>
typedef Property<T>::DataSourceType RTT::types::TemplateTypeInfo< T, use_ostream >::PropertyType

When Properties of T are constructed, they are non-const, non-reference.

Definition at line 126 of file rtt/types/TemplateTypeInfo.hpp.

template<typename T, bool use_ostream = false>
typedef Property<T>::DataSourceType RTT::types::TemplateTypeInfo< T, use_ostream >::PropertyType

When Properties of T are constructed, they are non-const, non-reference.

Definition at line 126 of file install/include/rtt/types/TemplateTypeInfo.hpp.

template<typename T, bool use_ostream = false>
typedef T RTT::types::TemplateTypeInfo< T, use_ostream >::UserType

The given T parameter is the type for reading DataSources.

Definition at line 122 of file rtt/types/TemplateTypeInfo.hpp.

template<typename T, bool use_ostream = false>
typedef T RTT::types::TemplateTypeInfo< T, use_ostream >::UserType

The given T parameter is the type for reading DataSources.

Definition at line 122 of file install/include/rtt/types/TemplateTypeInfo.hpp.


Constructor & Destructor Documentation

template<typename T, bool use_ostream = false>
RTT::types::TemplateTypeInfo< T, use_ostream >::TemplateTypeInfo ( std::string  name  )  [inline]

Setup Type Information for type name. This causes a switch from 'unknown' type to basic type information for type T.

Parameters:
name the 'Orocos' type name.

Definition at line 135 of file install/include/rtt/types/TemplateTypeInfo.hpp.

template<typename T, bool use_ostream = false>
virtual RTT::types::TemplateTypeInfo< T, use_ostream >::~TemplateTypeInfo (  )  [inline, virtual]
template<typename T, bool use_ostream = false>
RTT::types::TemplateTypeInfo< T, use_ostream >::TemplateTypeInfo ( std::string  name  )  [inline]

Setup Type Information for type name. This causes a switch from 'unknown' type to basic type information for type T.

Parameters:
name the 'Orocos' type name.

Definition at line 135 of file rtt/types/TemplateTypeInfo.hpp.

template<typename T, bool use_ostream = false>
virtual RTT::types::TemplateTypeInfo< T, use_ostream >::~TemplateTypeInfo (  )  [inline, virtual]

Definition at line 140 of file rtt/types/TemplateTypeInfo.hpp.


Member Function Documentation

template<typename T, bool use_ostream = false>
base::DataSourceBase::shared_ptr RTT::types::TemplateTypeInfo< T, use_ostream >::buildActionAlias ( base::ActionInterface action,
base::DataSourceBase::shared_ptr  source 
) const [inline, virtual]

Returns a DataSource that first executes an action and returns the result of another data source. If source is an AssignableDataSource, an AssignableDataSource is returned of the same type, otherwise, a plain DataSource is returned.

Implements RTT::types::TypeInfo.

Definition at line 213 of file rtt/types/TemplateTypeInfo.hpp.

template<typename T, bool use_ostream = false>
base::DataSourceBase::shared_ptr RTT::types::TemplateTypeInfo< T, use_ostream >::buildActionAlias ( base::ActionInterface action,
base::DataSourceBase::shared_ptr  source 
) const [inline, virtual]

Returns a DataSource that first executes an action and returns the result of another data source. If source is an AssignableDataSource, an AssignableDataSource is returned of the same type, otherwise, a plain DataSource is returned.

Implements RTT::types::TypeInfo.

Definition at line 213 of file install/include/rtt/types/TemplateTypeInfo.hpp.

template<typename T, bool use_ostream = false>
base::AttributeBase* RTT::types::TemplateTypeInfo< T, use_ostream >::buildAlias ( std::string  name,
base::DataSourceBase::shared_ptr  b 
) const [inline, virtual]

build an alias with b as the value. If b is of the wrong type, 0 will be returned..

Implements RTT::types::TypeInfo.

Definition at line 205 of file rtt/types/TemplateTypeInfo.hpp.

template<typename T, bool use_ostream = false>
base::AttributeBase* RTT::types::TemplateTypeInfo< T, use_ostream >::buildAlias ( std::string  name,
base::DataSourceBase::shared_ptr  b 
) const [inline, virtual]

build an alias with b as the value. If b is of the wrong type, 0 will be returned..

Implements RTT::types::TypeInfo.

Definition at line 205 of file install/include/rtt/types/TemplateTypeInfo.hpp.

template<typename T, bool use_ostream = false>
base::AttributeBase* RTT::types::TemplateTypeInfo< T, use_ostream >::buildAttribute ( std::string  name,
base::DataSourceBase::shared_ptr  source 
) const [inline, virtual]

Build an Attribute of this type.

Implements RTT::types::TypeInfo.

Definition at line 191 of file rtt/types/TemplateTypeInfo.hpp.

template<typename T, bool use_ostream = false>
base::AttributeBase* RTT::types::TemplateTypeInfo< T, use_ostream >::buildAttribute ( std::string  name,
base::DataSourceBase::shared_ptr  source 
) const [inline, virtual]

Build an Attribute of this type.

Implements RTT::types::TypeInfo.

Definition at line 191 of file install/include/rtt/types/TemplateTypeInfo.hpp.

template<typename T, bool use_ostream = false>
base::ChannelElementBase::shared_ptr RTT::types::TemplateTypeInfo< T, use_ostream >::buildChannelInput ( base::OutputPortInterface port  )  const [inline, virtual]

Implements RTT::types::TypeInfo.

Definition at line 363 of file rtt/types/TemplateTypeInfo.hpp.

template<typename T, bool use_ostream = false>
base::ChannelElementBase::shared_ptr RTT::types::TemplateTypeInfo< T, use_ostream >::buildChannelInput ( base::OutputPortInterface port  )  const [inline, virtual]
template<typename T, bool use_ostream = false>
base::ChannelElementBase::shared_ptr RTT::types::TemplateTypeInfo< T, use_ostream >::buildChannelOutput ( base::InputPortInterface port  )  const [inline, virtual]

Implements RTT::types::TypeInfo.

Definition at line 357 of file rtt/types/TemplateTypeInfo.hpp.

template<typename T, bool use_ostream = false>
base::ChannelElementBase::shared_ptr RTT::types::TemplateTypeInfo< T, use_ostream >::buildChannelOutput ( base::InputPortInterface port  )  const [inline, virtual]
template<typename T, bool use_ostream = false>
base::AttributeBase* RTT::types::TemplateTypeInfo< T, use_ostream >::buildConstant ( std::string  name,
base::DataSourceBase::shared_ptr  dsb 
) const [inline, virtual]

Implements RTT::types::TypeInfo.

Definition at line 171 of file rtt/types/TemplateTypeInfo.hpp.

template<typename T, bool use_ostream = false>
base::AttributeBase* RTT::types::TemplateTypeInfo< T, use_ostream >::buildConstant ( std::string  name,
base::DataSourceBase::shared_ptr  dsb 
) const [inline, virtual]
template<typename T, bool use_ostream = false>
base::ChannelElementBase::shared_ptr RTT::types::TemplateTypeInfo< T, use_ostream >::buildDataStorage ( ConnPolicy const &  policy  )  const [inline, virtual]

Creates single data or buffered storage for this type.

Parameters:
policy Describes the kind of storage requested by the user
Returns:
a storage element.

Implements RTT::types::TypeInfo.

Definition at line 353 of file rtt/types/TemplateTypeInfo.hpp.

template<typename T, bool use_ostream = false>
base::ChannelElementBase::shared_ptr RTT::types::TemplateTypeInfo< T, use_ostream >::buildDataStorage ( ConnPolicy const &  policy  )  const [inline, virtual]

Creates single data or buffered storage for this type.

Parameters:
policy Describes the kind of storage requested by the user
Returns:
a storage element.

Implements RTT::types::TypeInfo.

Definition at line 353 of file install/include/rtt/types/TemplateTypeInfo.hpp.

template<typename T, bool use_ostream = false>
virtual base::PropertyBase* RTT::types::TemplateTypeInfo< T, use_ostream >::buildProperty ( const std::string &  name,
const std::string &  desc,
base::DataSourceBase::shared_ptr  source = 0 
) const [inline, virtual]

Build a Property of this type.

Implements RTT::types::TypeInfo.

Definition at line 227 of file rtt/types/TemplateTypeInfo.hpp.

template<typename T, bool use_ostream = false>
virtual base::PropertyBase* RTT::types::TemplateTypeInfo< T, use_ostream >::buildProperty ( const std::string &  name,
const std::string &  desc,
base::DataSourceBase::shared_ptr  source = 0 
) const [inline, virtual]

Build a Property of this type.

Implements RTT::types::TypeInfo.

Definition at line 227 of file install/include/rtt/types/TemplateTypeInfo.hpp.

template<typename T, bool use_ostream = false>
virtual base::DataSourceBase::shared_ptr RTT::types::TemplateTypeInfo< T, use_ostream >::buildReference ( void *  ptr  )  const [inline, virtual]

Build a internal::ReferenceDataSource of this type, pointing to the given pointer

Implements RTT::types::TypeInfo.

Definition at line 243 of file rtt/types/TemplateTypeInfo.hpp.

template<typename T, bool use_ostream = false>
virtual base::DataSourceBase::shared_ptr RTT::types::TemplateTypeInfo< T, use_ostream >::buildReference ( void *  ptr  )  const [inline, virtual]

Build a internal::ReferenceDataSource of this type, pointing to the given pointer

Implements RTT::types::TypeInfo.

Definition at line 243 of file install/include/rtt/types/TemplateTypeInfo.hpp.

template<typename T, bool use_ostream = false>
virtual base::DataSourceBase::shared_ptr RTT::types::TemplateTypeInfo< T, use_ostream >::buildValue (  )  const [inline, virtual]

Build a internal::ValueDataSource of this type.

Implements RTT::types::TypeInfo.

Definition at line 240 of file rtt/types/TemplateTypeInfo.hpp.

template<typename T, bool use_ostream = false>
virtual base::DataSourceBase::shared_ptr RTT::types::TemplateTypeInfo< T, use_ostream >::buildValue (  )  const [inline, virtual]

Build a internal::ValueDataSource of this type.

Implements RTT::types::TypeInfo.

Definition at line 240 of file install/include/rtt/types/TemplateTypeInfo.hpp.

template<typename T, bool use_ostream = false>
base::AttributeBase* RTT::types::TemplateTypeInfo< T, use_ostream >::buildVariable ( std::string  name  )  const [inline, virtual]

Implements RTT::types::TypeInfo.

Definition at line 184 of file rtt/types/TemplateTypeInfo.hpp.

template<typename T, bool use_ostream = false>
base::AttributeBase* RTT::types::TemplateTypeInfo< T, use_ostream >::buildVariable ( std::string  name  )  const [inline, virtual]
template<typename T, bool use_ostream = false>
virtual bool RTT::types::TemplateTypeInfo< T, use_ostream >::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.

Implements RTT::types::TypeInfo.

Reimplemented in RTT::types::RTStringTypeInfo, RTT::types::StdStringTypeInfo, RTT::types::StdTypeInfo< T >, RTT::types::EnumTypeInfo< T >, RTT::types::RTStringTypeInfo, RTT::types::StdStringTypeInfo, RTT::types::StdTypeInfo< T >, and RTT::types::EnumTypeInfo< T >.

Definition at line 274 of file rtt/types/TemplateTypeInfo.hpp.

template<typename T, bool use_ostream = false>
virtual bool RTT::types::TemplateTypeInfo< T, use_ostream >::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.

Implements RTT::types::TypeInfo.

Reimplemented in RTT::types::RTStringTypeInfo, RTT::types::StdStringTypeInfo, RTT::types::StdTypeInfo< T >, RTT::types::EnumTypeInfo< T >, RTT::types::RTStringTypeInfo, RTT::types::StdStringTypeInfo, RTT::types::StdTypeInfo< T >, and RTT::types::EnumTypeInfo< T >.

Definition at line 274 of file install/include/rtt/types/TemplateTypeInfo.hpp.

template<typename T, bool use_ostream = false>
virtual bool RTT::types::TemplateTypeInfo< T, use_ostream >::composeTypeImpl ( const PropertyBag source,
typename internal::AssignableDataSource< T >::reference_t  result 
) const [inline, virtual]
template<typename T, bool use_ostream = false>
virtual bool RTT::types::TemplateTypeInfo< T, use_ostream >::composeTypeImpl ( const PropertyBag source,
typename internal::AssignableDataSource< T >::reference_t  result 
) const [inline, virtual]
template<typename T, bool use_ostream = false>
virtual bool RTT::types::TemplateTypeInfo< T, use_ostream >::decomposeType ( base::DataSourceBase::shared_ptr  source,
PropertyBag targetbag 
) const [inline, virtual]

Definition at line 323 of file rtt/types/TemplateTypeInfo.hpp.

template<typename T, bool use_ostream = false>
virtual base::DataSourceBase::shared_ptr RTT::types::TemplateTypeInfo< T, use_ostream >::decomposeType ( base::DataSourceBase::shared_ptr  source  )  const [inline, virtual]

This default implementation sets up a PropertyBag which is passed to decomposeTypeImpl(). It is advised to implement that function and to leave this function as-is, unless you don't want to return a PropertyBag, but another data type.

Reimplemented from RTT::types::TypeInfo.

Reimplemented in RTT::types::RTStringTypeInfo, RTT::types::StdStringTypeInfo, RTT::types::StdTypeInfo< T >, RTT::types::EnumTypeInfo< T >, RTT::types::RTStringTypeInfo, RTT::types::StdStringTypeInfo, RTT::types::StdTypeInfo< T >, and RTT::types::EnumTypeInfo< T >.

Definition at line 304 of file rtt/types/TemplateTypeInfo.hpp.

template<typename T, bool use_ostream = false>
virtual bool RTT::types::TemplateTypeInfo< T, use_ostream >::decomposeType ( base::DataSourceBase::shared_ptr  source,
PropertyBag targetbag 
) const [inline, virtual]
template<typename T, bool use_ostream = false>
virtual base::DataSourceBase::shared_ptr RTT::types::TemplateTypeInfo< T, use_ostream >::decomposeType ( base::DataSourceBase::shared_ptr  source  )  const [inline, virtual]

This default implementation sets up a PropertyBag which is passed to decomposeTypeImpl(). It is advised to implement that function and to leave this function as-is, unless you don't want to return a PropertyBag, but another data type.

Reimplemented from RTT::types::TypeInfo.

Reimplemented in RTT::types::RTStringTypeInfo, RTT::types::StdStringTypeInfo, RTT::types::StdTypeInfo< T >, RTT::types::EnumTypeInfo< T >, RTT::types::RTStringTypeInfo, RTT::types::StdStringTypeInfo, RTT::types::StdTypeInfo< T >, and RTT::types::EnumTypeInfo< T >.

Definition at line 304 of file install/include/rtt/types/TemplateTypeInfo.hpp.

template<typename T, bool use_ostream = false>
virtual bool RTT::types::TemplateTypeInfo< T, use_ostream >::decomposeTypeImpl ( typename internal::AssignableDataSource< T >::const_reference_t  source,
PropertyBag targetbag 
) const [inline, virtual]

User, implement this function in case you want to control writing the XML data format. Add the structural elements of source to targetbag.

Definition at line 343 of file rtt/types/TemplateTypeInfo.hpp.

template<typename T, bool use_ostream = false>
virtual bool RTT::types::TemplateTypeInfo< T, use_ostream >::decomposeTypeImpl ( typename internal::AssignableDataSource< T >::const_reference_t  source,
PropertyBag targetbag 
) const [inline, virtual]

User, implement this function in case you want to control writing the XML data format. Add the structural elements of source to targetbag.

Definition at line 343 of file install/include/rtt/types/TemplateTypeInfo.hpp.

template<typename T, bool use_ostream = false>
std::string RTT::types::TemplateTypeInfo< T, use_ostream >::getTypeIdName (  )  const [inline, virtual]

Implements RTT::types::TypeInfo.

Definition at line 347 of file rtt/types/TemplateTypeInfo.hpp.

template<typename T, bool use_ostream = false>
std::string RTT::types::TemplateTypeInfo< T, use_ostream >::getTypeIdName (  )  const [inline, virtual]
template<typename T, bool use_ostream = false>
virtual const std::string& RTT::types::TemplateTypeInfo< T, use_ostream >::getTypeName (  )  const [inline, virtual]

Return unique the type name.

Implements RTT::types::TypeInfo.

Definition at line 225 of file rtt/types/TemplateTypeInfo.hpp.

template<typename T, bool use_ostream = false>
virtual const std::string& RTT::types::TemplateTypeInfo< T, use_ostream >::getTypeName (  )  const [inline, virtual]

Return unique the type name.

Implements RTT::types::TypeInfo.

Definition at line 225 of file install/include/rtt/types/TemplateTypeInfo.hpp.

template<typename T, bool use_ostream = false>
base::InputPortInterface* RTT::types::TemplateTypeInfo< T, use_ostream >::inputPort ( std::string const &  name  )  const [inline, virtual]

Returns a new InputPort<T> object where T is the type represented by this TypeInfo object.

Implements RTT::types::TypeInfo.

Definition at line 350 of file rtt/types/TemplateTypeInfo.hpp.

template<typename T, bool use_ostream = false>
base::InputPortInterface* RTT::types::TemplateTypeInfo< T, use_ostream >::inputPort ( std::string const &  name  )  const [inline, virtual]

Returns a new InputPort<T> object where T is the type represented by this TypeInfo object.

Implements RTT::types::TypeInfo.

Definition at line 350 of file install/include/rtt/types/TemplateTypeInfo.hpp.

template<typename T, bool use_ostream = false>
bool RTT::types::TemplateTypeInfo< T, use_ostream >::installTypeInfoObject (  )  [inline, 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.

Implements RTT::types::TypeInfo.

Definition at line 146 of file rtt/types/TemplateTypeInfo.hpp.

template<typename T, bool use_ostream = false>
bool RTT::types::TemplateTypeInfo< T, use_ostream >::installTypeInfoObject (  )  [inline, 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.

Implements RTT::types::TypeInfo.

Definition at line 146 of file install/include/rtt/types/TemplateTypeInfo.hpp.

template<typename T, bool use_ostream = false>
virtual bool RTT::types::TemplateTypeInfo< T, use_ostream >::isStreamable (  )  const [inline, virtual]

Returns true if this type is directly streamable using read()/write() or toString()/fromString().

Implements RTT::types::TypeInfo.

Definition at line 270 of file rtt/types/TemplateTypeInfo.hpp.

template<typename T, bool use_ostream = false>
virtual bool RTT::types::TemplateTypeInfo< T, use_ostream >::isStreamable (  )  const [inline, virtual]

Returns true if this type is directly streamable using read()/write() or toString()/fromString().

Implements RTT::types::TypeInfo.

Definition at line 270 of file install/include/rtt/types/TemplateTypeInfo.hpp.

template<typename T, bool use_ostream = false>
base::OutputPortInterface* RTT::types::TemplateTypeInfo< T, use_ostream >::outputPort ( std::string const &  name  )  const [inline, virtual]

Returns a new OutputPort<T> object where T is the type represented by this TypeInfo object.

Implements RTT::types::TypeInfo.

Definition at line 351 of file rtt/types/TemplateTypeInfo.hpp.

template<typename T, bool use_ostream = false>
base::OutputPortInterface* RTT::types::TemplateTypeInfo< T, use_ostream >::outputPort ( std::string const &  name  )  const [inline, virtual]

Returns a new OutputPort<T> object where T is the type represented by this TypeInfo object.

Implements RTT::types::TypeInfo.

Definition at line 351 of file install/include/rtt/types/TemplateTypeInfo.hpp.

template<typename T, bool use_ostream = false>
virtual std::istream& RTT::types::TemplateTypeInfo< T, use_ostream >::read ( std::istream &  os,
base::DataSourceBase::shared_ptr  out 
) const [inline, virtual]

Read a new value for this datasource from a human readable string. The default does nothing.

Implements RTT::types::TypeInfo.

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

Definition at line 261 of file rtt/types/TemplateTypeInfo.hpp.

template<typename T, bool use_ostream = false>
virtual std::istream& RTT::types::TemplateTypeInfo< T, use_ostream >::read ( std::istream &  os,
base::DataSourceBase::shared_ptr  out 
) const [inline, virtual]

Read a new value for this datasource from a human readable string. The default does nothing.

Implements RTT::types::TypeInfo.

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

Definition at line 261 of file install/include/rtt/types/TemplateTypeInfo.hpp.

template<typename T, bool use_ostream = false>
virtual std::ostream& RTT::types::TemplateTypeInfo< T, use_ostream >::write ( std::ostream &  os,
base::DataSourceBase::shared_ptr  in 
) const [inline, virtual]

Output this datasource as a human readable string. The default just writes the type name in parentheses to os.

Implements RTT::types::TypeInfo.

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

Definition at line 247 of file rtt/types/TemplateTypeInfo.hpp.

template<typename T, bool use_ostream = false>
virtual std::ostream& RTT::types::TemplateTypeInfo< T, use_ostream >::write ( std::ostream &  os,
base::DataSourceBase::shared_ptr  in 
) const [inline, virtual]

Output this datasource as a human readable string. The default just writes the type name in parentheses to os.

Implements RTT::types::TypeInfo.

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

Definition at line 247 of file install/include/rtt/types/TemplateTypeInfo.hpp.


Member Data Documentation

template<typename T, bool use_ostream = false>
const std::string RTT::types::TemplateTypeInfo< T, use_ostream >::tname [private]

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