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

#include <SequenceTypeInfo.hpp>

Inheritance diagram for RTT::types::SequenceTypeInfo< T, has_ostream >:
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 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, 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
bool resize (base::DataSourceBase::shared_ptr arg, int size) const
bool resize (base::DataSourceBase::shared_ptr arg, int size) const
 SequenceTypeInfo (std::string name)
 SequenceTypeInfo (std::string name)

Detailed Description

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

Template for data types that are C++ STL Sequences with operator[], size() and capacity() methods.

This class requires that your STL Sequence 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.

Definition at line 118 of file install/include/rtt/types/SequenceTypeInfo.hpp.


Constructor & Destructor Documentation

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

Definition at line 121 of file rtt/types/SequenceTypeInfo.hpp.


Member Function Documentation

template<typename T, bool has_ostream = false>
base::AttributeBase* RTT::types::SequenceTypeInfo< T, has_ostream >::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::TypeInfo.

Reimplemented in RTT::types::RTStringTypeInfo, RTT::types::StdStringTypeInfo, RTT::types::RTStringTypeInfo, and RTT::types::StdStringTypeInfo.

Definition at line 130 of file rtt/types/SequenceTypeInfo.hpp.

template<typename T, bool has_ostream = false>
base::AttributeBase* RTT::types::SequenceTypeInfo< T, has_ostream >::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::TypeInfo.

Reimplemented in RTT::types::RTStringTypeInfo, RTT::types::StdStringTypeInfo, RTT::types::RTStringTypeInfo, and RTT::types::StdStringTypeInfo.

Definition at line 130 of file install/include/rtt/types/SequenceTypeInfo.hpp.

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

Specialize to resize result given the size of source.

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

Definition at line 153 of file rtt/types/SequenceTypeInfo.hpp.

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

Specialize to resize result given the size of source.

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

Definition at line 153 of file install/include/rtt/types/SequenceTypeInfo.hpp.

template<typename T, bool has_ostream = false>
virtual base::DataSourceBase::shared_ptr RTT::types::SequenceTypeInfo< T, has_ostream >::getMember ( base::DataSourceBase::shared_ptr  item,
base::DataSourceBase::shared_ptr  id 
) const [inline, virtual]

Returns a member of a given data source struct identified by a data source id.

Parameters:
item The item of which to return a member
id Or a string data source containing the name of a member if item is a struct, Or an unsigned int data source containing the index of an element if item is a sequence

Reimplemented from RTT::types::TypeInfo.

Definition at line 206 of file rtt/types/SequenceTypeInfo.hpp.

template<typename T, bool has_ostream = false>
virtual base::DataSourceBase::shared_ptr RTT::types::SequenceTypeInfo< 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 195 of file rtt/types/SequenceTypeInfo.hpp.

template<typename T, bool has_ostream = false>
virtual base::DataSourceBase::shared_ptr RTT::types::SequenceTypeInfo< T, has_ostream >::getMember ( base::DataSourceBase::shared_ptr  item,
base::DataSourceBase::shared_ptr  id 
) const [inline, virtual]

Returns a member of a given data source struct identified by a data source id.

Parameters:
item The item of which to return a member
id Or a string data source containing the name of a member if item is a struct, Or an unsigned int data source containing the index of an element if item is a sequence

Reimplemented from RTT::types::TypeInfo.

Definition at line 206 of file install/include/rtt/types/SequenceTypeInfo.hpp.

template<typename T, bool has_ostream = false>
virtual base::DataSourceBase::shared_ptr RTT::types::SequenceTypeInfo< 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 195 of file install/include/rtt/types/SequenceTypeInfo.hpp.

template<typename T, bool has_ostream = false>
virtual std::vector<std::string> RTT::types::SequenceTypeInfo< 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 187 of file rtt/types/SequenceTypeInfo.hpp.

template<typename T, bool has_ostream = false>
virtual std::vector<std::string> RTT::types::SequenceTypeInfo< 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 187 of file install/include/rtt/types/SequenceTypeInfo.hpp.

template<typename T, bool has_ostream = false>
bool RTT::types::SequenceTypeInfo< T, has_ostream >::resize ( base::DataSourceBase::shared_ptr  arg,
int  size 
) const [inline, virtual]

Tries to resize a data source in case it's a resizable sequence.

Returns:
true if the resizing could be done, false otherwise.

Reimplemented from RTT::types::TypeInfo.

Definition at line 139 of file rtt/types/SequenceTypeInfo.hpp.

template<typename T, bool has_ostream = false>
bool RTT::types::SequenceTypeInfo< T, has_ostream >::resize ( base::DataSourceBase::shared_ptr  arg,
int  size 
) const [inline, virtual]

Tries to resize a data source in case it's a resizable sequence.

Returns:
true if the resizing could be done, false otherwise.

Reimplemented from RTT::types::TypeInfo.

Definition at line 139 of file install/include/rtt/types/SequenceTypeInfo.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