RTT::DataSourceBase Class Reference

The base class for all DataSource's. More...

#include <rtt/DataSourceBase.hpp>

Inheritance diagram for RTT::DataSourceBase:

Public Types
typedef boost::intrusive_ptr < DataSourceBase >	shared_ptr
	Use this type to store a pointer to a DataSourceBase.
typedef boost::intrusive_ptr < const DataSourceBase >	const_ptr
	Use this type to store a const pointer to a DataSourceBase.
Public Member Functions
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	reset ()
	Reset the data to initial values.
virtual bool	evaluate () const =0
	Force an evaluation of the DataSourceBase.
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	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	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.
virtual DataSourceBase *	clone () const =0
	Return a shallow clone of this DataSource.
virtual DataSourceBase *	copy (std::map< const DataSourceBase , DataSourceBase > &alreadyCloned) const =0
	Create a deep copy of this DataSource, unless it is already cloned.
virtual std::string	getType () const =0
	Return useful type info in a human readable format.
virtual const TypeInfo *	getTypeInfo () const =0
	Return the Orocos type info object.
virtual std::string	getTypeName () const =0
	Return the Orocos type name, without const, pointer or reference qualifiers.
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 bool	updateBlob (int protocol, const void *data)
	Updates the value of this DataSource with the value of a transportable data object.
virtual int	serverProtocol () const
	Inspect if this DataSource is a proxy for a remote server object.
virtual void *	server (int protocol, void *arg)
	Create an object server which 'mirrors' this DataSource.
virtual void *	method (int protocol, MethodC orig, void arg)
	Create an object server which 'mirrors' this DataSource.
Protected Member Functions
virtual	~DataSourceBase ()
	the destructor is private.
Protected Attributes
OS::AtomicInt	refcount
	We keep the refcount ourselves.

Detailed Description

The base class for all DataSource's.

The DataSource is an object containing Data of any type. It's interface is designed for dynamic build-up and destruction of these objects and allowing Commands, Properties etc to use them as 'storage' devices which have the dual copy() /clone() semantics (which is heavily used by the Orocos Task Infrastructure).

DataSource's are reference counted and must be allocated on the headp. Use DataSourceBase::shared_ptr or DataSource<T>::shared_ptr to deal with cleanup of allocated DataSources. You are not allowed to delete a DataSource. If you must have the pointer of a DataSource, use the .get() method of the shared_ptr class.

Once a newly created DataSource is assigned to a shared_ptr, it will be deleted when that pointer goes out of scope and is not shared by other shared_ptr objects.

See also:: DataSource

Definition at line 77 of file DataSourceBase.hpp.

Constructor & Destructor Documentation

virtual RTT::DataSourceBase::~DataSourceBase ( ) [protected, virtual]

the destructor is private.

You are not allowed to delete this class RTT_API yourself, use a shared pointer !

Member Function Documentation

virtual DataSourceBase* RTT::DataSourceBase::clone ( ) const [pure 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.

bool RTT::DataSourceBase::composeType ( DataSourceBase::shared_ptr source )

Compose the contents of this object from another datasource.

See also:: TypeInfo

virtual DataSourceBase* RTT::DataSourceBase::copy ( std::map< const DataSourceBase *, DataSourceBase * > & alreadyCloned ) const [pure 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.

virtual void* RTT::DataSourceBase::createBlob ( int protocol ) [virtual]

Creates a transportable data object with the current value of this DataSource.

This does not trigger the evaluation() of this data source.

Returns:: a valid object or nill if this type is not supported.

Reimplemented in RTT::Corba::ExpressionProxy.

Referenced by RTT::Corba::CorbaDataObjectProxy< T >::Set().

bool RTT::DataSourceBase::decomposeType ( PropertyBag & targetbag )

Decompose the contents of this object into properties.

See also:: TypeInfo

virtual bool RTT::DataSourceBase::evaluate ( ) const [pure virtual]

Force an evaluation of the DataSourceBase.

Returns:: true on successful evaluation. If the DataSource itself contains a boolean, return that boolean.

virtual void* RTT::DataSourceBase::getBlob ( int protocol ) [virtual]

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();

Returns:: a valid object or nill if this type is not supported.

Reimplemented in RTT::Corba::ExpressionProxy.

virtual void* RTT::DataSourceBase::method	(	int	protocol,
		MethodC *	orig,
		void *	arg
	)			`[virtual]`

Create an object server which 'mirrors' this DataSource.

Returns:: The existing server if serverProtocol() == protocol, or a new method object reference otherwise.

See also:: Operations.idl

Reimplemented in RTT::Corba::ExpressionProxy.

virtual void* RTT::DataSourceBase::server	(	int	protocol,
		void *	arg
	)			`[virtual]`

Create an object server which 'mirrors' this DataSource.

Returns:: The existing server if serverProtocol() == protocol, or a new server object reference otherwise.

See also:: Operations.idl

virtual int RTT::DataSourceBase::serverProtocol ( ) const [virtual]

Inspect if this DataSource is a proxy for a remote server object.

Returns:: 0 if it is a local DataSource, or the protocol id if it is a proxy for a remove server.

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().

std::string RTT::DataSourceBase::toString ( )

Get the contents of this object as a string.

See also:: TypeInfo

virtual bool RTT::DataSourceBase::update ( DataSourceBase * other ) [virtual]

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.

Returns:: false if the DataSources are of different type OR if the contents of this DataSource can not be updated.

virtual bool RTT::DataSourceBase::updateBlob	(	int	protocol,
		const void *	data
	)			`[virtual]`

Updates the value of this DataSource with the value of a transportable data object.

Parameters:

any

The value to update to.

Returns:: true if any had the correct type.

virtual CommandInterface* RTT::DataSourceBase::updateCommand ( DataSourceBase * other ) [virtual]

Generate a CommandInterface object which will update this DataSource with the value of another DataSource when execute()'ed.

Returns:: zero if the DataSource types do not match OR if the contents of this DataSource can not be updated.

virtual bool RTT::DataSourceBase::updatePart	(	DataSourceBase *	part,
		DataSourceBase *	other
	)			`[virtual]`

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.

Returns:: false if the DataSources are of different type OR if the contents of this DataSource can not be partially updated.

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]`

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.

Returns:: zero if the DataSource types do not match OR if the contents of this DataSource can not be partially updated.

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 )

Stream the contents of this object.

See also:: TypeInfo

Member Data Documentation

OS::AtomicInt RTT::DataSourceBase::refcount [mutable, protected]

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.

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

rtt/DataSourceBase.hpp

RTT::DataSourceBase Class Reference

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation