#include <CArrayTypeInfo.hpp>
Public Member Functions | |
| virtual base::AttributeBase * | buildVariable (std::string name, int sizehint) const |
| CArrayTypeInfo (std::string name) | |
| virtual bool | composeType (base::DataSourceBase::shared_ptr dssource, base::DataSourceBase::shared_ptr dsresult) const |
| virtual base::DataSourceBase::shared_ptr | decomposeType (base::DataSourceBase::shared_ptr source) 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 std::vector< std::string > | getMemberNames () const |
| bool | installTypeInfoObject (TypeInfo *ti) |
Detailed Description
template<typename T, bool has_ostream = false>
class RTT::types::CArrayTypeInfo< T, has_ostream >
Template for data types that are C-style arrays. You can not use this type as a port data type.
C-style arrays are represented by the carray<T> wrapper in the RTT type system.
- Parameters:
-
T A carray<U> wrapper, where U is a C data type.
Definition at line 63 of file CArrayTypeInfo.hpp.
Constructor & Destructor Documentation
| RTT::types::CArrayTypeInfo< T, has_ostream >::CArrayTypeInfo | ( | std::string | name | ) | [inline] |
Definition at line 68 of file CArrayTypeInfo.hpp.
Member Function Documentation
| virtual base::AttributeBase* RTT::types::CArrayTypeInfo< 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::ValueFactory.
Definition at line 87 of file CArrayTypeInfo.hpp.
| virtual bool RTT::types::CArrayTypeInfo< T, has_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::CompositionFactory.
Definition at line 176 of file CArrayTypeInfo.hpp.
| virtual base::DataSourceBase::shared_ptr RTT::types::CArrayTypeInfo< T, has_ostream >::decomposeType | ( | base::DataSourceBase::shared_ptr | source | ) | const [inline, virtual] |
Use getMember() for decomposition...
Reimplemented from RTT::types::CompositionFactory.
Definition at line 171 of file CArrayTypeInfo.hpp.
| virtual base::DataSourceBase::shared_ptr RTT::types::CArrayTypeInfo< 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::MemberFactory.
Definition at line 110 of file CArrayTypeInfo.hpp.
| virtual base::DataSourceBase::shared_ptr RTT::types::CArrayTypeInfo< 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:
-
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::MemberFactory.
Definition at line 134 of file CArrayTypeInfo.hpp.
| virtual std::vector<std::string> RTT::types::CArrayTypeInfo< 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::MemberFactory.
Definition at line 102 of file CArrayTypeInfo.hpp.
| bool RTT::types::CArrayTypeInfo< 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.
- 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::PrimitiveTypeInfo< T, has_ostream >.
Definition at line 73 of file CArrayTypeInfo.hpp.
The documentation for this class was generated from the following file: