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

New-style SequenceTypeInfo which offers type info for sequences which can NOT be sent over flow ports. More...

#include <rtt/types/PrimitiveSequenceTypeInfo.hpp>

Inheritance diagram for RTT::types::PrimitiveSequenceTypeInfo< T, has_ostream >:

List of all members.

Public Types
typedef T	DataType
	The given T parameter is the type of the DataSources.
Public Member Functions
	PrimitiveSequenceTypeInfo (std::string name)
bool	installTypeInfoObject (TypeInfo *ti)
base::AttributeBase *	buildVariable (std::string name, int size) const
virtual bool	composeType (base::DataSourceBase::shared_ptr dssource, base::DataSourceBase::shared_ptr dsresult) const
	Compose a type (target) from a DataSourceBase (source) containing its members.
virtual bool	resize (base::DataSourceBase::shared_ptr arg, int size) const
virtual base::DataSourceBase::shared_ptr	decomposeType (base::DataSourceBase::shared_ptr source) const
	Specialize this function to return an alternate type which represents this one in a compatible way.
virtual std::vector< std::string >	getMemberNames () 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
boost::shared_ptr < PrimitiveTypeInfo< T, use_ostream > >	getSharedPtr ()
TypeInfo *	getTypeInfoObject () const
	Returns the TypeInfo object of this type, or null if none exists yet.
virtual const std::string &	getTypeName () const
	Return the type name for which this generator generates type info features.
virtual std::ostream &	write (std::ostream &os, base::DataSourceBase::shared_ptr in) const
virtual std::istream &	read (std::istream &os, base::DataSourceBase::shared_ptr out) const
virtual bool	isStreamable () const
virtual bool	decomposeType (base::DataSourceBase::shared_ptr source, PropertyBag &targetbag) const
base::AttributeBase *	buildConstant (std::string name, base::DataSourceBase::shared_ptr dsb) const
base::AttributeBase *	buildVariable (std::string name) const
base::AttributeBase *	buildAttribute (std::string name, base::DataSourceBase::shared_ptr in) const
base::AttributeBase *	buildAlias (std::string name, base::DataSourceBase::shared_ptr in) const
base::DataSourceBase::shared_ptr	buildActionAlias (base::ActionInterface *action, base::DataSourceBase::shared_ptr in) const
virtual base::PropertyBase *	buildProperty (const std::string &name, const std::string &desc, base::DataSourceBase::shared_ptr source=0) const
virtual base::DataSourceBase::shared_ptr	buildValue () const
virtual base::DataSourceBase::shared_ptr	buildReference (void *ptr) const
virtual base::DataSourceBase::shared_ptr	convertType (base::DataSourceBase::shared_ptr source) const
	Specialize this function to return an alternate type which represents this one in a compatible way.
Type building/factory functions
Used to create objects that hold data of a certain type.
virtual base::AttributeBase *	buildConstant (std::string name, base::DataSourceBase::shared_ptr, int sizehint) const
	Build a non modifyable instance of this type.
Conversion to/from text
Used to convert data to human readable text and vice versa.
virtual std::string	toString (base::DataSourceBase::shared_ptr in) const
	Usability function which converts data to a string.
virtual bool	fromString (const std::string &value, base::DataSourceBase::shared_ptr out) const
	Usability function which converts a string to data.
Inspecting data structures.
Used to write a complex type to an external representation, like XML.
virtual bool	getMember (internal::Reference *ref, base::DataSourceBase::shared_ptr item, const std::string &name) const
	Stores a reference to a member of a struct identified by its name.
Protected Attributes
const std::string	tname
boost::shared_ptr < PrimitiveTypeInfo< T, use_ostream > >	mshared

---

Detailed Description

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

New-style SequenceTypeInfo which offers type info for sequences which can NOT be sent over flow ports.

This has huge code size reduction, while still being able to use these sequences in structs which are sent over flow ports.

Definition at line 19 of file PrimitiveSequenceTypeInfo.hpp.

---

Member Function Documentation

AttributeBase * RTT::ValueFactory::buildConstant	(	std::string	name,
		base::DataSourceBase::shared_ptr	dsb,
		int	sizehint
	)		const [virtual, inherited]

Build a non modifyable instance of this type.

Parameters:

sizehint

For variable size instances, use it to hint the size of the instance.

Definition at line 14 of file ValueFactory.cpp.

template<class T , bool has_ostream = false>

virtual bool RTT::types::PrimitiveSequenceTypeInfo< 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 52 of file PrimitiveSequenceTypeInfo.hpp.

base::DataSourceBase::shared_ptr CompositionFactory::convertType

(

base::DataSourceBase::shared_ptr

source

)

const [virtual, inherited]

Specialize this function to return an alternate type which represents this one in a compatible way.

For example, a short converts to an long or an enum to an int or a string.

Returns:

null if this type is not convertible to anything else.

Deprecated:

by decomposeType. We want to rename convertType to decomposeType. This function is left here for transitional purposes.

Definition at line 6 of file CompositionFactory.cpp.

template<class T , bool has_ostream = false>

virtual base::DataSourceBase::shared_ptr RTT::types::PrimitiveSequenceTypeInfo< T, has_ostream >::decomposeType

(

base::DataSourceBase::shared_ptr

source

)

const [inline, virtual]

Specialize this function to return an alternate type which represents this one in a compatible way.

For example, a short converts to an long or an enum to an int or a string. If your return a datasource containing a property bag, then this function should do the inverse of composeType: the returned property bag contains all parts of the current type (source) which can be modified and merged back into this type with composeType. Mathematically: composeType( decomposeType( A ), B); assert( A == B );

Returns:

null in order to indicate that decomposition through getMember() may be tried. You may return source itself in order to prevent any further decomposition of your type (using getMember(), which is used as fall-back by the rest of the software. For example, to avoid that a string is decomposed into a sequence of chars, or to avoid that a primitive type like 'int' is further queried.

Reimplemented from RTT::types::CompositionFactory.

Definition at line 61 of file PrimitiveSequenceTypeInfo.hpp.

virtual bool RTT::types::MemberFactory::getMember	(	internal::Reference *	ref,
		base::DataSourceBase::shared_ptr	item,
		const std::string &	name
	)		const [virtual, inherited]

Stores a reference to a member of a struct identified by its name.

This method does not allocate memory when item is assignable..

Parameters:

ref	The reference object in which to store the reference.
item	The item of which to return a reference to a member. It must be assignable, otherwise, a reference to a copy of item will be returned. This copy will allocate memory.
name	The name of a member within item.

Returns:

false if no such member exists, true if ref got filled in otherwise.

TypeInfo* RTT::types::PrimitiveTypeInfo< T, use_ostream >::getTypeInfoObject

(

)

const [inline, virtual, inherited]

Returns the TypeInfo object of this type, or null if none exists yet.

Returns:

All generators should return here TypeInfoRepository::Instance()->getTypeInfo<T>();

Implements RTT::types::TypeInfoGenerator.

Definition at line 83 of file PrimitiveTypeInfo.hpp.

virtual const std::string& RTT::types::PrimitiveTypeInfo< T, use_ostream >::getTypeName

(

)

const [inline, virtual, inherited]

Return the type name for which this generator generates type info features.

This name will be aliased by the TypeInfo object.

Implements RTT::types::TypeInfoGenerator.

Definition at line 87 of file PrimitiveTypeInfo.hpp.

---

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

• rtt/types/PrimitiveSequenceTypeInfo.hpp