Public Member Functions
RTT::types::MatrixTypeInfo< T, has_ostream > Class Template Reference

#include <MatrixTypeInfo.hpp>

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

List of all members.

Public Member Functions

base::AttributeBasebuildVariable (std::string name, int size) const
virtual bool composeTypeImpl (const PropertyBag &bag, 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, base::DataSourceBase::shared_ptr id) const
bool installTypeInfoObject (TypeInfo *ti)
 MatrixTypeInfo (std::string name)
bool resize (base::DataSourceBase::shared_ptr arg, int size_rows, int size_columns) const

Detailed Description

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

Template for data types that are C++ STL Sequences with operator[,], rows() and columns() 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.

The matrix is always square !

Definition at line 100 of file MatrixTypeInfo.hpp.


Constructor & Destructor Documentation

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

Definition at line 103 of file MatrixTypeInfo.hpp.


Member Function Documentation

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

Build a modifyable instance of this type.

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

Reimplemented from RTT::types::ValueFactory.

Definition at line 120 of file MatrixTypeInfo.hpp.

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

Specialize to resize result given the size of source.

Reimplemented from RTT::types::TemplateCompositionFactory< T >.

Definition at line 143 of file MatrixTypeInfo.hpp.

template<typename T , bool has_ostream = false>
virtual base::DataSourceBase::shared_ptr RTT::types::MatrixTypeInfo< 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:
itemThe item of which to return a reference to a member
nameThe 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::MemberFactory.

Definition at line 217 of file MatrixTypeInfo.hpp.

template<typename T , bool has_ostream = false>
virtual base::DataSourceBase::shared_ptr RTT::types::MatrixTypeInfo< 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 identified by a data source id. This will be an int (for indexing) or a string (for the member name).

Warning:
Currently this only works for a SequenceTypeInfo-like object. We don't implement this for StructTypeInfo-like objects, since that would be a very expensive implementation (memory wise).
Parameters:
itemThe item of which to return a member
idOr 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::MemberFactory.

Definition at line 228 of file MatrixTypeInfo.hpp.

template<typename T , bool has_ostream = false>
bool RTT::types::MatrixTypeInfo< T, has_ostream >::installTypeInfoObject ( TypeInfo ti) [inline, virtual]

Installs the type info object in the global data source type info handler and adds any additional features to the type info object. This method will be called by the TypeInfoRepository, in order to register this type's factories into the TypeInfo object.

Parameters:
tiA valid TypeInfo object into which new features may be installed
Returns:
true if this object may be deleted, false if not.
Postcondition:
When true is returned, this instance is still valid and the caller (TypeInfoRepository) will delete it. When false is returned, the validity is undefined and the instance will not be used anymore by the caller.

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

Definition at line 108 of file MatrixTypeInfo.hpp.

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

Definition at line 129 of file MatrixTypeInfo.hpp.


The documentation for this class was generated from the following file:


rtt
Author(s): RTT Developers
autogenerated on Fri Sep 9 2016 04:02:20