Adapt from non-const reference-type to non-const reference-type, yielding an AssignableDataSource, since references are always assignable. More...
#include <rtt/DataSourceAdaptor.hpp>
Public Types | |
typedef TFrom & | From |
typedef TFrom & | To |
typedef DataSource< TFrom & > ::value_t | value_t |
The bare type of T is extracted into value_t. | |
typedef boost::call_traits < value_t >::param_type | param_t |
typedef boost::call_traits < value_t >::reference | reference_t |
typedef boost::call_traits < value_t >::const_reference | const_reference_t |
typedef boost::remove_const < typename boost::call_traits < value_t >::param_type > ::type | copy_t |
typedef boost::intrusive_ptr < AssignableDataSource< TFrom & > > | shared_ptr |
Use this type to store a pointer to an AssignableDataSource. | |
typedef boost::intrusive_ptr < const AssignableDataSource < TFrom & > > | const_ptr |
Use this type to store a const pointer to a DataSourceBase. | |
typedef TFrom & | result_t |
Public Member Functions | |
DataSourceAdaptor (typename DataSource< From >::shared_ptr orig) | |
virtual DataSource< To >::result_t | get () const |
Return the data as type T. | |
virtual DataSource< To >::result_t | value () const |
Return the result of the last evaluate() function. | |
virtual AssignableDataSource < To >::const_reference_t | rvalue () const |
Get a const reference (or null) to the value of this DataSource. | |
virtual AssignableDataSource < To >::reference_t | set () |
Get a reference (or null) to the value of this DataSource. | |
virtual void | set (typename AssignableDataSource< To >::param_t v) |
virtual void | reset () |
Reset the data to initial values. | |
virtual bool | evaluate () const |
Force an evaluation of the DataSourceBase. | |
virtual AssignableDataSource < To > * | clone () const |
Return a shallow clone of this DataSource. | |
virtual AssignableDataSource < To > * | copy (std::map< const DataSourceBase *, DataSourceBase * > &alreadyCloned) const |
Create a deep copy of this DataSource, unless it is already cloned. | |
virtual void | set (param_t t)=0 |
Set this DataSource with a value. | |
virtual bool | update (DataSourceBase *other) |
Update the value of this DataSource with the value of an other DataSource. | |
virtual CommandInterface * | updateCommand (DataSourceBase *other) |
Generate a CommandInterface object which will update this DataSource with the value of another DataSource when execute()'ed. | |
virtual bool | updateBlob (int protocol, const void *data) |
Updates the value of this DataSource with the value of a transportable data object. | |
virtual void * | server (int protocol, void *data) |
Create an object server which 'mirrors' this DataSource. | |
virtual std::string | getType () const |
Return useful type info in a human readable format. | |
virtual const TypeInfo * | getTypeInfo () const |
Return the Orocos type info object. | |
virtual std::string | getTypeName () const |
Return the Orocos type name, without const, pointer or reference qualifiers. | |
void | ref () const |
Increase the reference count by one. | |
void | deref () const |
Decrease the reference count by one and delete this on zero. | |
virtual void | updated () |
In case the DataSource returns a 'reference' type, call this method to notify it that the data was updated in the course of an invocation of get(). | |
virtual bool | updatePart (DataSourceBase *part, DataSourceBase *other) |
Update part of the value of this DataSource with the value of an other DataSource. | |
virtual CommandInterface * | updatePartCommand (DataSourceBase *part, DataSourceBase *other) |
Generate a CommandInterface object which will partially update this DataSource with the value of another DataSource when execute()'ed. | |
std::ostream & | write (std::ostream &os) |
Stream the contents of this object. | |
std::string | toString () |
Get the contents of this object as a string. | |
bool | decomposeType (PropertyBag &targetbag) |
Decompose the contents of this object into properties. | |
bool | composeType (DataSourceBase::shared_ptr source) |
Compose the contents of this object from another datasource. | |
virtual void * | createBlob (int protocol) |
Creates a transportable data object with the current value of this DataSource. | |
virtual void * | getBlob (int protocol) |
Creates a transportable data object with the current value of this DataSource. | |
virtual int | serverProtocol () const |
Inspect if this DataSource is a proxy for a remote server object. | |
virtual void * | method (int protocol, MethodC *orig, void *arg) |
Create an object server which 'mirrors' this DataSource. | |
Static Public Member Functions | |
static AssignableDataSource < TFrom & > * | narrow (DataSourceBase *db) |
This method narrows a DataSourceBase to a typeded AssignableDataSource, possibly returning a new object. | |
static std::string | GetType () |
Return usefull type info in a human readable format. | |
static const TypeInfo * | GetTypeInfo () |
Return the Orocos type info. | |
static std::string | GetTypeName () |
Return the Orocos type name, without const, pointer or reference qualifiers. | |
Public Attributes | |
DataSource< From >::shared_ptr | orig_ |
Protected Attributes | |
OS::AtomicInt | refcount |
We keep the refcount ourselves. |
Adapt from non-const reference-type to non-const reference-type, yielding an AssignableDataSource, since references are always assignable.
Specialises for example DataSourceAdaptor<int &, int&> (Rare case).
Definition at line 219 of file DataSourceAdaptor.hpp.
virtual AssignableDataSource<To>* RTT::detail::DataSourceAdaptor< TFrom &, TFrom & >::clone | ( | ) | const [inline, virtual] |
Return a shallow clone of this DataSource.
This method returns a duplicate of this instance which re-uses the DataSources this DataSource holds reference to. The clone() function is thus a non-deep copy.
Implements RTT::AssignableDataSource< TFrom & >.
Definition at line 243 of file DataSourceAdaptor.hpp.
References RTT::DataSource< T >::clone().
bool RTT::DataSourceBase::composeType | ( | DataSourceBase::shared_ptr | source | ) | [inherited] |
Compose the contents of this object from another datasource.
virtual AssignableDataSource<To>* RTT::detail::DataSourceAdaptor< TFrom &, TFrom & >::copy | ( | std::map< const DataSourceBase *, DataSourceBase * > & | alreadyCloned | ) | const [inline, virtual] |
Create a deep copy of this DataSource, unless it is already cloned.
Places the association (parent, clone) in alreadyCloned. If the DataSource is non-copyable (for example it represents the Property of a Task ), this may be returned.
Implements RTT::AssignableDataSource< TFrom & >.
Definition at line 247 of file DataSourceAdaptor.hpp.
References RTT::DataSource< T >::copy().
virtual void* RTT::DataSourceBase::createBlob | ( | int | protocol | ) | [virtual, inherited] |
Creates a transportable data object with the current value of this DataSource.
This does not trigger the evaluation() of this data source.
Reimplemented in RTT::Corba::ExpressionProxy.
Referenced by RTT::Corba::CorbaDataObjectProxy< T >::Set().
bool RTT::DataSourceBase::decomposeType | ( | PropertyBag & | targetbag | ) | [inherited] |
Decompose the contents of this object into properties.
virtual bool RTT::detail::DataSourceAdaptor< TFrom &, TFrom & >::evaluate | ( | ) | const [inline, virtual] |
Force an evaluation of the DataSourceBase.
Reimplemented from RTT::DataSource< TFrom & >.
Definition at line 241 of file DataSourceAdaptor.hpp.
References RTT::DataSource< T >::evaluate().
virtual void* RTT::DataSourceBase::getBlob | ( | int | protocol | ) | [virtual, inherited] |
Creates a transportable data object with the current value of this DataSource.
This does trigger the evaluation() of this data source. Equivalent to this->evaluate(); this->createBlob();
Reimplemented in RTT::Corba::ExpressionProxy.
virtual void* RTT::DataSourceBase::method | ( | int | protocol, | |
MethodC * | orig, | |||
void * | arg | |||
) | [virtual, inherited] |
Create an object server which 'mirrors' this DataSource.
Reimplemented in RTT::Corba::ExpressionProxy.
virtual AssignableDataSource<To>::const_reference_t RTT::detail::DataSourceAdaptor< TFrom &, TFrom & >::rvalue | ( | ) | const [inline, virtual] |
Get a const reference (or null) to the value of this DataSource.
Getting a reference to an internal data structure is not thread-safe. DataSources which wish to protect their data from concurrent access may return the null reference with this method. All calls to rvalue() must first check whether they do not return null.
Implements RTT::AssignableDataSource< TFrom & >.
Definition at line 233 of file DataSourceAdaptor.hpp.
References RTT::DataSource< T >::value().
virtual void* RTT::AssignableDataSource< TFrom & >::server | ( | int | protocol, | |
void * | arg | |||
) | [virtual, inherited] |
Create an object server which 'mirrors' this DataSource.
Reimplemented from RTT::DataSourceBase.
virtual int RTT::DataSourceBase::serverProtocol | ( | ) | const [virtual, inherited] |
Inspect if this DataSource is a proxy for a remote server object.
Reimplemented in RTT::Corba::AnyDataSource, RTT::Corba::CORBAExpression< T >, RTT::Corba::CORBAExpression< void >, RTT::Corba::CORBAAssignableExpression< T >, and RTT::Corba::ExpressionProxy.
Referenced by RTT::AssignableDataSource< T >::narrow(), and RTT::DataSource< T >::narrow().
virtual AssignableDataSource<To>::reference_t RTT::detail::DataSourceAdaptor< TFrom &, TFrom & >::set | ( | ) | [inline, virtual] |
Get a reference (or null) to the value of this DataSource.
Getting a reference to an internal data structure is not thread-safe. DataSources which wish to protect their data from concurrent access may return the null reference with this method. All calls to set() must first check whether they do not return null.
Implements RTT::AssignableDataSource< TFrom & >.
Definition at line 235 of file DataSourceAdaptor.hpp.
References RTT::DataSource< T >::get().
std::string RTT::DataSourceBase::toString | ( | ) | [inherited] |
Get the contents of this object as a string.
virtual bool RTT::AssignableDataSource< TFrom & >::update | ( | DataSourceBase * | other | ) | [virtual, inherited] |
Update the value of this DataSource with the value of an other DataSource.
Update does a full update of the value, adding extra information if necessary.
Reimplemented from RTT::DataSourceBase.
virtual bool RTT::AssignableDataSource< TFrom & >::updateBlob | ( | int | protocol, | |
const void * | data | |||
) | [virtual, inherited] |
Updates the value of this DataSource with the value of a transportable data object.
any | The value to update to. |
Reimplemented from RTT::DataSourceBase.
virtual CommandInterface* RTT::AssignableDataSource< TFrom & >::updateCommand | ( | DataSourceBase * | other | ) | [virtual, inherited] |
Generate a CommandInterface object which will update this DataSource with the value of another DataSource when execute()'ed.
Reimplemented from RTT::DataSourceBase.
virtual bool RTT::DataSourceBase::updatePart | ( | DataSourceBase * | part, | |
DataSourceBase * | other | |||
) | [virtual, inherited] |
Update part of the value of this DataSource with the value of an other DataSource.
Update does a partial update of the value, according to part, which is most likely an index or hash value of some type.
Reimplemented in RTT::detail::AssignableDataSourceAdaptor< To const &, To >.
Referenced by RTT::detail::AssignableDataSourceAdaptor< To const &, To >::updatePart().
virtual CommandInterface* RTT::DataSourceBase::updatePartCommand | ( | DataSourceBase * | part, | |
DataSourceBase * | other | |||
) | [virtual, inherited] |
Generate a CommandInterface object which will partially update this DataSource with the value of another DataSource when execute()'ed.
part is an index or hash value of some type.
Reimplemented in RTT::Corba::CORBAAssignableExpression< T >, RTT::detail::AssignableDataSourceAdaptor< To const &, To >, and RTT::IndexedValueDataSource< T, Index, SetType, IPred, APred >.
Referenced by RTT::detail::AssignableDataSourceAdaptor< To const &, To >::updatePartCommand().
std::ostream& RTT::DataSourceBase::write | ( | std::ostream & | os | ) | [inherited] |
Stream the contents of this object.
OS::AtomicInt RTT::DataSourceBase::refcount [mutable, protected, inherited] |
We keep the refcount ourselves.
We aren't using boost::shared_ptr, because boost::intrusive_ptr is better, exactly because it can be used with refcounts that are stored in the class itself. Advantages are that the shared_ptr's for derived classes use the same refcount, which is of course very much desired, and that refcounting happens in an efficient way, which is also nice :)
Definition at line 89 of file DataSourceBase.hpp.