RTT::types::StructTypeInfo< T, has_ostream > Class Template Reference

#include <StructTypeInfo.hpp>

Inheritance diagram for RTT::types::StructTypeInfo< T, has_ostream >:
Inheritance graph
[legend]

List of all members.

Public Member Functions

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
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, const std::string &name) const
virtual std::vector< std::string > getMemberNames () const
virtual std::vector< std::string > getMemberNames () const
 StructTypeInfo (std::string name)
 StructTypeInfo (std::string name)

Detailed Description

template<typename T, bool has_ostream = false>
class RTT::types::StructTypeInfo< T, has_ostream >

Type Information for data types that are structs, ie all user data types fall in this category.

Use this class to register your data type to the Orocos type system.

This class requires that your struct is compatible with the boost::serialization API. This means that it must provide a serialize() function or that you define a free function serialize() in the boost::serialization namespace. If no such function exists, you can fall back to StdTypeInfo or even TemplateTypeInfo.

Definition at line 60 of file install/include/rtt/types/StructTypeInfo.hpp.


Constructor & Destructor Documentation

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

Definition at line 63 of file install/include/rtt/types/StructTypeInfo.hpp.

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

Definition at line 63 of file rtt/types/StructTypeInfo.hpp.


Member Function Documentation

template<typename T , bool has_ostream = false>
virtual bool RTT::types::StructTypeInfo< T, has_ostream >::composeTypeImpl ( const PropertyBag source,
typename internal::AssignableDataSource< T >::reference_t  result 
) const [inline, virtual]

Implementation that updates result with the matching parts in source Relies on the fact that getMember returns a C++ reference to each part of result, which is then updated with a property found in source.

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

Definition at line 101 of file rtt/types/StructTypeInfo.hpp.

template<typename T , bool has_ostream = false>
virtual bool RTT::types::StructTypeInfo< T, has_ostream >::composeTypeImpl ( const PropertyBag source,
typename internal::AssignableDataSource< T >::reference_t  result 
) const [inline, virtual]

Implementation that updates result with the matching parts in source Relies on the fact that getMember returns a C++ reference to each part of result, which is then updated with a property found in source.

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

Definition at line 101 of file install/include/rtt/types/StructTypeInfo.hpp.

template<typename T , bool has_ostream = false>
virtual base::DataSourceBase::shared_ptr RTT::types::StructTypeInfo< T, has_ostream >::getMember ( base::DataSourceBase::shared_ptr  item,
const std::string &  name 
) const [inline, virtual]

Returns a member of a given data source struct identified by its name.

Parameters:
item The item of which to return a reference to a member
name The name of a member within item. Is a name of a member in case of a struct or an index number in case of a sequence.
Returns:
null if no such member exists, an assignable datasource referencing that member otherwise.

Reimplemented from RTT::types::TypeInfo.

Definition at line 76 of file rtt/types/StructTypeInfo.hpp.

template<typename T , bool has_ostream = false>
virtual base::DataSourceBase::shared_ptr RTT::types::StructTypeInfo< T, has_ostream >::getMember ( base::DataSourceBase::shared_ptr  item,
const std::string &  name 
) const [inline, virtual]

Returns a member of a given data source struct identified by its name.

Parameters:
item The item of which to return a reference to a member
name The name of a member within item. Is a name of a member in case of a struct or an index number in case of a sequence.
Returns:
null if no such member exists, an assignable datasource referencing that member otherwise.

Reimplemented from RTT::types::TypeInfo.

Definition at line 76 of file install/include/rtt/types/StructTypeInfo.hpp.

template<typename T , bool has_ostream = false>
virtual std::vector<std::string> RTT::types::StructTypeInfo< T, has_ostream >::getMemberNames (  )  const [inline, virtual]

Returns the list of struct member names of this type. In case this type is not a struct, returns an empty list.

Reimplemented from RTT::types::TypeInfo.

Definition at line 68 of file rtt/types/StructTypeInfo.hpp.

template<typename T , bool has_ostream = false>
virtual std::vector<std::string> RTT::types::StructTypeInfo< T, has_ostream >::getMemberNames (  )  const [inline, virtual]

Returns the list of struct member names of this type. In case this type is not a struct, returns an empty list.

Reimplemented from RTT::types::TypeInfo.

Definition at line 68 of file install/include/rtt/types/StructTypeInfo.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:18 2013