Typedefs | |
typedef boost::shared_ptr< CompositionFactory > | CompositionFactoryPtr |
typedef boost::shared_ptr< internal::ConnFactory > | ConnFactoryPtr |
typedef boost::shared_ptr< MemberFactory > | MemberFactoryPtr |
typedef boost::shared_ptr< StreamFactory > | StreamFactoryPtr |
typedef boost::shared_ptr< ValueFactory > | ValueFactoryPtr |
Functions | |
int | _EatSpace (std::istream &is, int *countp) |
bool RTT_API | composePropertyBag (PropertyBag const &sourcebag, PropertyBag &target) |
template<class T > | |
bool | composeTemplateProperty (const PropertyBag &bag, T &result) |
bool RTT_API | decomposePropertyBag (PropertyBag const &sourcebag, PropertyBag &target) |
bool | Eat (std::istream &is, int delim) |
bool | EatEnd (std::istream &is, int delim) |
template<class T > | |
int | get_capacity (T const &cont) |
template<class T > | |
int | get_columns (T const &cont) |
bool | get_container_item (std::vector< bool > &cont, int index) |
template<class T > | |
T::reference | get_container_item (T &cont, int index_row, int index_column) |
template<class T > | |
T::reference | get_container_item (T &cont, int index) |
bool | get_container_item_copy (const std::vector< bool > &cont, int index) |
template<class T > | |
T::value_type | get_container_item_copy (const T &cont, int index) |
template<class T > | |
int | get_rows (T const &cont) |
template<class T > | |
int | get_size (T const &cont) |
void | loadOrocosTypes (TypeInfoRepository::shared_ptr ti) |
void | loadStdTypes (TypeInfoRepository::shared_ptr ti) |
template<typename function > | |
BinaryOperator< function > * | newBinaryOperator (const char *op, function f) |
template<class Function > | |
TypeConstructor * | newConstructor (Function *foo, bool automatic=false) |
template<class Object > | |
TypeConstructor * | newConstructor (Object obj, bool automatic=false) |
template<typename function > | |
UnaryOperator< function > * | newUnaryOperator (const char *op, function f) |
std::ostream & | operator<< (std::ostream &os, const std::vector< double > &v) |
std::istream & | operator>> (std::istream &os, std::vector< double > &v) |
RTT_API OperatorRepository::shared_ptr | operators () |
bool | propertyDecomposition (base::PropertyBase *source, PropertyBag &targetbag, bool recurse) |
bool | typeDecomposition (base::DataSourceBase::shared_ptr dsb, PropertyBag &targetbag, bool recurse) |
TypeInfoRepository::shared_ptr | Types () |
Classes for typekits for describing and handling user data types.
typedef boost::shared_ptr<CompositionFactory> RTT::types::CompositionFactoryPtr |
Definition at line 103 of file CompositionFactory.hpp.
typedef boost::shared_ptr<internal::ConnFactory> RTT::types::ConnFactoryPtr |
Definition at line 59 of file TypeInfo.hpp.
typedef boost::shared_ptr<MemberFactory> RTT::types::MemberFactoryPtr |
Definition at line 113 of file MemberFactory.hpp.
typedef boost::shared_ptr<StreamFactory> RTT::types::StreamFactoryPtr |
Definition at line 93 of file StreamFactory.hpp.
typedef boost::shared_ptr<ValueFactory> RTT::types::ValueFactoryPtr |
Definition at line 116 of file ValueFactory.hpp.
int RTT::types::_EatSpace | ( | std::istream & | is, |
int * | countp | ||
) |
Definition at line 47 of file TypeStream-io.cpp.
bool RTT::types::composePropertyBag | ( | PropertyBag const & | sourcebag, |
PropertyBag & | target | ||
) |
Uses the type composition to compose all typed properties from a property bag.
For each PropertyBag found with a type not equal to 'PropertyBag', it will use the type's TypeInfo::composeType function and return that in target if it generates a Property.
sourcebag | Contains a PropertyBag to be composed into a known type. |
target | The target type to compose the source bag into. |
Definition at line 48 of file PropertyComposition.cpp.
bool RTT::types::composeTemplateProperty | ( | const PropertyBag & | bag, |
T & | result | ||
) |
Definition at line 49 of file VectorTemplateComposition.hpp.
bool RTT::types::decomposePropertyBag | ( | PropertyBag const & | sourcebag, |
PropertyBag & | target | ||
) |
Inverse of RTT::types::composePropertyBag(). This function effectively replaces the property introspection mechanism for decomposition.
sourcebag | The bag from which to compose the type. |
target | Contains a C++ type to be composed into a hierarchy of properties. |
Definition at line 98 of file PropertyComposition.cpp.
bool RTT::types::Eat | ( | std::istream & | is, |
int | delim | ||
) |
Definition at line 64 of file TypeStream-io.cpp.
bool RTT::types::EatEnd | ( | std::istream & | is, |
int | delim | ||
) |
Definition at line 81 of file TypeStream-io.cpp.
int RTT::types::get_capacity | ( | T const & | cont | ) |
Returns the capacity of an STL container which has the capacity() member function.
cont | A const ref to an STL container. |
Definition at line 61 of file SequenceTypeInfoBase.hpp.
int RTT::types::get_columns | ( | T const & | cont | ) |
Returns the number of columns of a matrix container which has the columns() member function.
cont | A const ref to a matrix container. |
Definition at line 69 of file MatrixTypeInfo.hpp.
bool RTT::types::get_container_item | ( | std::vector< bool > & | cont, |
int | index | ||
) |
Specialisation for vector<bool>, we don't return references to bits aka std::_Bit_reference. vector<bool> is an outlier and should not be used. Use vector<int> or vector<char> instead.
cont | Is a vector<bool> |
index | The item to read. |
Definition at line 45 of file SequenceTypeInfoBase.cpp.
T::reference RTT::types::get_container_item | ( | T & | cont, |
int | index_row, | ||
int | index_column | ||
) |
Returns a reference to one item in a matrix container.
cont | The container to access |
index_row | The row index of the item to reference |
index_column | The column index of the item to reference |
Definition at line 82 of file MatrixTypeInfo.hpp.
T::reference RTT::types::get_container_item | ( | T & | cont, |
int | index | ||
) |
Returns a reference to one item in an STL container.
cont | The container to access |
index | The item to reference |
Definition at line 85 of file SequenceTypeInfoBase.hpp.
bool RTT::types::get_container_item_copy | ( | const std::vector< bool > & | cont, |
int | index | ||
) |
Definition at line 52 of file SequenceTypeInfoBase.cpp.
T::value_type RTT::types::get_container_item_copy | ( | const T & | cont, |
int | index | ||
) |
Returns a copy to one item in an STL container.
cont | The container to access |
index | The item to extract from the sequence |
Definition at line 100 of file SequenceTypeInfoBase.hpp.
int RTT::types::get_rows | ( | T const & | cont | ) |
Returns the number of rows of a matrix container which has the rows() member function.
cont | A const ref to a matrix container. |
Definition at line 58 of file MatrixTypeInfo.hpp.
int RTT::types::get_size | ( | T const & | cont | ) |
Returns the size of an STL container which has the size() member function.
cont | A const ref to an STL container. |
Definition at line 72 of file SequenceTypeInfoBase.hpp.
void RTT::types::loadOrocosTypes | ( | TypeInfoRepository::shared_ptr | ti | ) |
Definition at line 69 of file RealTimeTypekitTypes2.cpp.
void RTT::types::loadStdTypes | ( | TypeInfoRepository::shared_ptr | ti | ) |
Definition at line 53 of file RealTimeTypekitStdTypes.cpp.
BinaryOperator<function>* RTT::types::newBinaryOperator | ( | const char * | op, |
function | f | ||
) |
helper function to create a new BinaryOperator
Definition at line 138 of file OperatorTypes.hpp.
TypeConstructor* RTT::types::newConstructor | ( | Function * | foo, |
bool | automatic = false |
||
) |
Create a new Constructor.
foo | A pointer to the 'C' function which creates an object. |
automatic | Set to true to allow automatic conversion (without warning) to this type. |
Definition at line 122 of file TemplateConstructor.hpp.
TypeConstructor* RTT::types::newConstructor | ( | Object | obj, |
bool | automatic = false |
||
) |
Create a new Constructor.
obj | A function object which has operator(). |
automatic | Set to true to allow automatic conversion (without warning) to this type. |
Definition at line 135 of file TemplateConstructor.hpp.
UnaryOperator<function>* RTT::types::newUnaryOperator | ( | const char * | op, |
function | f | ||
) |
helper function to create a new UnaryOperator
Definition at line 128 of file OperatorTypes.hpp.
RTT_API std::ostream & RTT::types::operator<< | ( | std::ostream & | os, |
const std::vector< double > & | v | ||
) |
Definition at line 46 of file TypeStream.cpp.
RTT_API std::istream & RTT::types::operator>> | ( | std::istream & | os, |
std::vector< double > & | v | ||
) |
Definition at line 61 of file TypeStream.cpp.
RTT_API OperatorRepository::shared_ptr RTT::types::operators | ( | ) |
This global function provides the short notation for OperatorRepository::Instance()
Definition at line 132 of file Operators.cpp.
bool RTT_API RTT::types::propertyDecomposition | ( | base::PropertyBase * | source, |
PropertyBag & | targetbag, | ||
bool | recurse = true |
||
) |
Uses the type decomposition to decompose a property into a property bag that refers to all its parts.
It will first try to use the user's TypeInfo::decomposeType function and return that in targetbag if it generates a PropertyBag. If it generated something else than a PropertyBag, this function returns false. If decomposeType did not return anything, it will try the TypeInfo::getMember() approach to decompose source into the targetbag. If no members are returned, this function fails.
In case the source type info supports it, each modification of a part in the targetbag will modify source too. This is so for typekits using the boost::serialization functions in combination with TypeInfo::getMember(). In case the type decompositions were written manually using TypeInfo::decomposeType(), this relation can no longer be guaranteed, and a composition step using TypeInfo::composeType() of the same type must be tried to update source with the modifications in targetbag.
For the TypeInfo::getMember() method: This function can only work if every part of the source is known by the RTT type system. Only the parts of source that are assignable will be decomposed. The read-only parts will be silently omitted.
source | Contains a C++ type to be decomposed into a hierarchy of properties. |
targetbag | The bag in which to place the result. |
Definition at line 63 of file PropertyDecomposition.cpp.
bool RTT_API RTT::types::typeDecomposition | ( | base::DataSourceBase::shared_ptr | source, |
PropertyBag & | targetbag, | ||
bool | recurse = true |
||
) |
Identical to RTT::types::propertyDecomposition(), but takes a DataSourceBase as source.
source | Contains a C++ type to be decomposed into a hierarchy of properties. |
targetbag | The bag in which to place the result. |
Definition at line 73 of file PropertyDecomposition.cpp.
RTT_API TypeInfoRepository::shared_ptr RTT::types::Types | ( | ) |
Obtain a pointer to the global type system. This is a short notation for TypeInfoRepository::Instance().