Orocos Real-Time Toolkit  2.9.0
Public Types | Static Public Member Functions | List of all members
RTT::internal::create_sequence< List > Struct Template Reference

This class can create three kinds of Boost Fusion Sequences. More...

#include <rtt/internal/CreateSequence.hpp>

Inheritance diagram for RTT::internal::create_sequence< List >:
RTT::internal::create_sequence_impl< List, mpl::size< List >::value >

Public Types

typedef create_sequence< typename mpl::pop_front< List >::typetail
 The tail is ourselves minus the head. More...
 
typedef mpl::front< List >::type arg_type
 The argument type. More...
 
typedef AStore< arg_typearg_store_type
 The argument storage type. More...
 
typedef remove_cr< arg_type >::type ds_arg_type
 The data source value type of an assignable data source is non-const, non-reference. More...
 
typedef mpl::if_< typename is_pure_reference< arg_type >::type, typename AssignableDataSource< ds_arg_type >::shared_ptr, typename DataSource< ds_arg_type >::shared_ptr >::type ds_type
 The type of a single element of the vector. More...
 
typedef AssignableDataSource< ds_arg_type >::shared_ptr ads_type
 
typedef tail::type tail_type
 The type of the tail (List - head) of our sequence. More...
 
typedef bf::cons< ds_type, tail_typetype
 The joint DataSource<T>::shared_ptr type of head and tail, again a fusion cons. More...
 
typedef tail::atype atail_type
 
typedef bf::cons< ads_type, atail_typeatype
 
typedef tail::data_type arg_tail_type
 
typedef tail::data_store_type arg_store_tail_type
 
typedef bf::cons< arg_type, arg_tail_typedata_type
 The joint T data type of head and tail. More...
 
typedef bf::cons< arg_store_type, arg_store_tail_typedata_store_type
 The joint T data storage type of head and tail. More...
 

Static Public Member Functions

static type sources (std::vector< base::DataSourceBase::shared_ptr >::const_iterator args, int argnbr=1)
 Converts a std::vector of DataSourceBase types into a boost::fusion Sequence of DataSources of the types given in List. More...
 
static atype assignable (std::vector< base::DataSourceBase::shared_ptr >::const_iterator args, int argnbr=1)
 Converts a std::vector of DataSourceBase types into a boost::fusion Sequence of AssignableDataSources of the types given in List. More...
 
static data_type data (const type &seq)
 Returns the data contained in the data sources as a Fusion Sequence. More...
 
static void set (const data_type &in, const atype &seq)
 Sets the values of a sequence of AssignableDataSource<T> data sources ot the values contained in in using set(). More...
 
static void load (const data_store_type &in, const atype &seq)
 Sets the values of a sequence of AssignableDataSource<T> data sources ot the values contained in in using set(). More...
 
static data_store_type store (const data_type &in)
 Stores the values of a sequence of data_type into a data_store_type sequence for later retrieval during load. More...
 
static void update (const type &seq)
 Calls the DataSourceBase::updated() function for each element in sequence seq, in case the element is a non-const reference type. More...
 
static type copy (const type &seq, std::map< const base::DataSourceBase *, base::DataSourceBase * > &alreadyCloned)
 Copies a sequence of DataSource<T>::shared_ptr according to the copy/clone semantics of data sources. More...
 
static const types::TypeInfoGetTypeInfo (int i)
 Returns the i'th argument type info as returned by DataSource<ArgI>::GetTypeInfo(), starting from 1. More...
 
static std::string GetType (int i)
 Returns the i'th argument type name as returned by DataSource<ArgI>::GetType(), starting from 1. More...
 

Detailed Description

template<class List>
struct RTT::internal::create_sequence< List >

This class can create three kinds of Boost Fusion Sequences.

sources() creates a fusion sequence of (Assignable)DataSource<T>::shared_ptr from an mpl sequence and a std::vector<DataSourceBase*>. Both must have same length. The mpl sequence is typically obtained from the function_types parameter_types traits class.

assignable() creates a fusion sequence of AssignableDataSource<T>::shared_ptr from an mpl sequence and a std::vector<DataSourceBase*>. Both must have same length. The mpl sequence is typically obtained from the function_types parameter_types traits class. If the mpl sequence elements contain const qualifiers, these are removed, so T is always a value type.

data() creates a fusion sequence of T,U,V,... from the fusion sequence returned by operator(). It contains the values of the data sources obtained by calling get().

copy() creates a fusion sequence of DataSource<T>::shared_ptr from an mpl sequence and a sequence returned by operator() to do the scripting copy/clone semantics on each element of the sequence.

This is a typical head-tail recursive implementation where operator() calls itself, but in another type specialisation.

Definition at line 182 of file CreateSequence.hpp.

Member Typedef Documentation

Definition at line 217 of file CreateSequence.hpp.

Definition at line 234 of file CreateSequence.hpp.

The argument storage type.

Definition at line 203 of file CreateSequence.hpp.

Definition at line 233 of file CreateSequence.hpp.

typedef mpl::front<List>::type RTT::internal::create_sequence_impl< List, size >::arg_type
inherited

The argument type.

Definition at line 198 of file CreateSequence.hpp.

Definition at line 230 of file CreateSequence.hpp.

typedef bf::cons<ads_type, atail_type> RTT::internal::create_sequence_impl< List, size >::atype
inherited

Definition at line 231 of file CreateSequence.hpp.

The joint T data storage type of head and tail.

Definition at line 244 of file CreateSequence.hpp.

The joint T data type of head and tail.

Definition at line 239 of file CreateSequence.hpp.

The data source value type of an assignable data source is non-const, non-reference.

Definition at line 208 of file CreateSequence.hpp.

typedef mpl::if_<typename is_pure_reference<arg_type>::type, typename AssignableDataSource< ds_arg_type >::shared_ptr, typename DataSource<ds_arg_type>::shared_ptr>::type RTT::internal::create_sequence_impl< List, size >::ds_type
inherited

The type of a single element of the vector.

Definition at line 215 of file CreateSequence.hpp.

typedef create_sequence<typename mpl::pop_front<List>::type> RTT::internal::create_sequence_impl< List, size >::tail
inherited

The tail is ourselves minus the head.

Definition at line 193 of file CreateSequence.hpp.

The type of the tail (List - head) of our sequence.

It is recursively formulated in terms of create_sequence.

Definition at line 223 of file CreateSequence.hpp.

typedef bf::cons<ds_type, tail_type> RTT::internal::create_sequence_impl< List, size >::type
inherited

The joint DataSource<T>::shared_ptr type of head and tail, again a fusion cons.

Definition at line 228 of file CreateSequence.hpp.

Member Function Documentation

static atype RTT::internal::create_sequence_impl< List, size >::assignable ( std::vector< base::DataSourceBase::shared_ptr >::const_iterator  args,
int  argnbr = 1 
)
inlinestaticinherited

Converts a std::vector of DataSourceBase types into a boost::fusion Sequence of AssignableDataSources of the types given in List.

Will throw if an element of the vector could not be dynamic casted to the respective element type of List.

Parameters
argsA vector of data sources
argnbrLeave as default. Used internally to count recursive calls.
Returns
a Fusion Sequence of DataSource<T>::shared_ptr objects

Definition at line 270 of file CreateSequence.hpp.

static type RTT::internal::create_sequence_impl< List, size >::copy ( const type seq,
std::map< const base::DataSourceBase *, base::DataSourceBase * > &  alreadyCloned 
)
inlinestaticinherited

Copies a sequence of DataSource<T>::shared_ptr according to the copy/clone semantics of data sources.

Parameters
seqA Fusion Sequence of DataSource<T>::shared_ptr
alreadyClonedthe copy/clone map
Returns
A Fusion Sequence of DataSource<T>::shared_ptr containing the copies.

Definition at line 341 of file CreateSequence.hpp.

static data_type RTT::internal::create_sequence_impl< List, size >::data ( const type seq)
inlinestaticinherited

Returns the data contained in the data sources as a Fusion Sequence.

Parameters
seqA Fusion Sequence of DataSource<T> types.
Returns
A sequence of type T holding the values of the DataSource<T>.

Definition at line 284 of file CreateSequence.hpp.

static std::string RTT::internal::create_sequence_impl< List, size >::GetType ( int  i)
inlinestaticinherited

Returns the i'th argument type name as returned by DataSource<ArgI>::GetType(), starting from 1.

Parameters
iA number between 1..N with N being the number of types in the mpl List of this class.
Returns
An full qualified type name.

Definition at line 371 of file CreateSequence.hpp.

References RTT::internal::DataSourceTypeInfo< T >::getType().

static const types::TypeInfo* RTT::internal::create_sequence_impl< List, size >::GetTypeInfo ( int  i)
inlinestaticinherited

Returns the i'th argument type info as returned by DataSource<ArgI>::GetTypeInfo(), starting from 1.

Parameters
iA number between 1..N with N being the number of types in the mpl List of this class.
Returns
An Orocos registered type info object.

Definition at line 354 of file CreateSequence.hpp.

References RTT::internal::DataSourceTypeInfo< T >::getTypeInfo().

static void RTT::internal::create_sequence_impl< List, size >::load ( const data_store_type in,
const atype seq 
)
inlinestaticinherited

Sets the values of a sequence of AssignableDataSource<T> data sources ot the values contained in in using set().

Parameters
inThe values to write.
seqThe receiving assignable data sources. Because the datasources are shared pointers, it's ok to work on the temporary copies of seq.

Definition at line 307 of file CreateSequence.hpp.

References RTT::internal::AssignHelper< Seq, Data, Enable >::set().

static void RTT::internal::create_sequence_impl< List, size >::set ( const data_type in,
const atype seq 
)
inlinestaticinherited

Sets the values of a sequence of AssignableDataSource<T> data sources ot the values contained in in using set().

Parameters
inThe values to write.
seqThe receiving assignable data sources.

Definition at line 294 of file CreateSequence.hpp.

References RTT::internal::AssignHelper< Seq, Data, Enable >::set().

static type RTT::internal::create_sequence_impl< List, size >::sources ( std::vector< base::DataSourceBase::shared_ptr >::const_iterator  args,
int  argnbr = 1 
)
inlinestaticinherited

Converts a std::vector of DataSourceBase types into a boost::fusion Sequence of DataSources of the types given in List.

Will throw if an element of the vector could not be dynamic casted to the respective element type of List.

Parameters
argsA vector of data sources
argnbrLeave as default. Used internally to count recursive calls.
Returns
a Fusion Sequence of DataSource<T>::shared_ptr objects

Definition at line 254 of file CreateSequence.hpp.

References RTT::internal::DataSourceTypeInfo< T >::getType().

Referenced by RTT::types::TemplateConstructor< S >::build().

static data_store_type RTT::internal::create_sequence_impl< List, size >::store ( const data_type in)
inlinestaticinherited

Stores the values of a sequence of data_type into a data_store_type sequence for later retrieval during load.

We must return the resulting sequence by value, since boost fusion returns temporaries, which we can't take a reference to.

Parameters
inThe values to store
Returns
The receiving AStore sequence.

Definition at line 320 of file CreateSequence.hpp.

static void RTT::internal::create_sequence_impl< List, size >::update ( const type seq)
inlinestaticinherited

Calls the DataSourceBase::updated() function for each element in sequence seq, in case the element is a non-const reference type.

Parameters
seqA sequence of DataSource<T> objects

Definition at line 329 of file CreateSequence.hpp.

References RTT::internal::UpdateHelper< T >::update().


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