AssignableDataSource Class Template Reference

#include <rtt/DataSource.hpp>

Inheritance diagram for AssignableDataSource:

List of all members.

Detailed Description

template<typename T>
class RTT::AssignableDataSource< T >

A DataSource which has set() methods.

Parameters:

See DataSource for the semantics of T.

Definition at line 144 of file DataSource.hpp.


Public Types
typedef DataSource < T >::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 < T > >	shared_ptr
	Use this type to store a pointer to an AssignableDataSource.
typedef boost::intrusive_ptr < const AssignableDataSource < T > >	const_ptr
	Use this type to store a const pointer to a DataSourceBase.
typedef T	result_t
Public Member Functions
virtual void	set (param_t t)=0
	Set this DataSource with a value.
virtual reference_t	set ()=0
	Get a reference (or null) to the value of this DataSource.
virtual const_reference_t	rvalue () const =0
	Get a const reference (or null) to the value of this DataSource.
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 AssignableDataSource < T > *	clone () const =0
	Return a shallow clone of this DataSource.
virtual AssignableDataSource < T > *	copy (std::map< const DataSourceBase , DataSourceBase > &alreadyCloned) const =0
	Create a deep copy of this DataSource, unless it is already cloned.
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 result_t	get () const =0
	Return the data as type T.
virtual result_t	value () const =0
	Return the result of the last evaluate() function.
virtual bool	evaluate () const
	Force an evaluation of the DataSourceBase.
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	reset ()
	Reset the data to initial values.
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 < T > *	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.
Protected Member Functions
	~AssignableDataSource ()
Protected Attributes
oro_atomic_t	refcount
	We keep the refcount ourselves.

Member Function Documentation

virtual reference_t set ( ) [pure 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.

Implemented in CORBAAssignableExpression, DataObjectInterface, ValueDataSource, ReferenceDataSource, ValueDataSource< R >, ValueDataSource< A >, ValueDataSource< boost::weak_ptr< ProgramInterface > >, ValueDataSource< boost::function_traits< DataType >::arg3_type >, ValueDataSource< boost::function_traits< DataType >::arg1_type >, ValueDataSource< boost::function_traits< DataType >::arg2_type >, ValueDataSource< boost::weak_ptr< StateMachine > >, ValueDataSource< boost::function_traits< DataType >::result_type >, and ValueDataSource< boost::function_traits< DataType >::arg4_type >.

virtual const_reference_t rvalue ( ) const [pure 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.

Referenced by CORBAAssignableExpression::get(), CORBAAssignableExpression::rvalue(), and CORBAAssignableExpression::value().

bool update ( DataSourceBase * other ) [inline, 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.

Reimplemented from DataSourceBase.

Definition at line 131 of file DataSource.inl.

References DataSource::get().

CommandInterface * updateCommand ( DataSourceBase * other ) [inline, 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.

Reimplemented from DataSourceBase.

Reimplemented in CORBAAssignableExpression, and IndexedValueDataSource.

Definition at line 142 of file DataSource.inl.

Referenced by CORBAAssignableExpression::updateCommand().

virtual AssignableDataSource<T>* 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.

Implements DataSource.

Implemented in CorbaDataObject, CorbaDataObjectProxy, CORBAAssignableExpression, DataObjectLocked, DataObjectPrioritySet, DataObjectPriorityGet, DataObjectLockFree, DataObject, ValueDataSource, ReferenceDataSource, IndexedValueDataSource, ValueDataSource< R >, ValueDataSource< A >, ValueDataSource< boost::weak_ptr< ProgramInterface > >, ValueDataSource< boost::function_traits< DataType >::arg3_type >, ValueDataSource< boost::function_traits< DataType >::arg1_type >, ValueDataSource< boost::function_traits< DataType >::arg2_type >, ValueDataSource< boost::weak_ptr< StateMachine > >, ValueDataSource< boost::function_traits< DataType >::result_type >, and ValueDataSource< boost::function_traits< DataType >::arg4_type >.

virtual AssignableDataSource<T>* 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.

Implements DataSource.

Referenced by EvalCommand::copy(), TryCommand::copy(), and CommandExecFunction::copy().

bool updateBlob	(	int	protocol,
		const void *	data
	)			`[inline, 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.

Reimplemented from DataSourceBase.

Definition at line 67 of file DataSource.inl.

References TypeInfo::getProtocol(), DataSource::getTypeInfo(), and TypeTransporter::updateBlob().

Referenced by CorbaBufferProxy::front(), CORBAExpression::get(), CorbaDataObjectProxy::Get(), ExpressionProxy::NarrowAssignableDataSource(), ExpressionProxy::NarrowDataSource(), and CorbaBufferProxy::Pop().

void * server	(	int	protocol,
		void *	arg
	)			`[inline, 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

Reimplemented from DataSourceBase.

Reimplemented in CORBAAssignableExpression.

Definition at line 79 of file DataSource.inl.

References TypeInfo::getProtocol(), DataSource::getTypeInfo(), and TypeTransporter::server().

bool evaluate ( ) const [inline, virtual, inherited]

Force an evaluation of the DataSourceBase.

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

Implements DataSourceBase.

Definition at line 52 of file DataSource.inl.

Referenced by EvalCommand::readArguments(), FunctorImpl< 4, FunctionT >::readArguments(), FunctorImpl< 3, FunctionT >::readArguments(), FunctorImpl< 2, FunctionT >::readArguments(), FunctorImpl< 1, FunctionT >::readArguments(), FunctorDS1::readArguments(), and CommandDataSourceBool::readArguments().

bool 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.

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

Definition at line 101 of file DataSource.cpp.

CommandInterface * 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.

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

Reimplemented in CORBAAssignableExpression, and IndexedValueDataSource.

Definition at line 105 of file DataSource.cpp.

Referenced by CORBAAssignableExpression::updatePartCommand().

std::ostream & write ( std::ostream & os ) [inherited]

Stream the contents of this object.

See also:: TypeInfo

Definition at line 59 of file DataSource.cpp.

std::string toString ( ) [inherited]

Get the contents of this object as a string.

See also:: TypeInfo

Definition at line 71 of file DataSource.cpp.

bool decomposeType ( PropertyBag & targetbag ) [inherited]

Decompose the contents of this object into properties.

See also:: TypeInfo

Definition at line 77 of file DataSource.cpp.

bool composeType ( DataSourceBase::shared_ptr source ) [inherited]

Compose the contents of this object from another datasource.

See also:: TypeInfo

Definition at line 83 of file DataSource.cpp.

void * 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.

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

Reimplemented in ExpressionProxy.

Definition at line 116 of file DataSource.cpp.

References TypeTransporter::createBlob(), TypeInfo::getProtocol(), and DataSourceBase::getTypeInfo().

Referenced by CorbaBufferProxy::Push(), CORBAAssignableExpression::set(), and CorbaDataObjectProxy::Set().

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

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

Reimplemented in ExpressionProxy.

Definition at line 126 of file DataSource.cpp.

References TypeTransporter::createBlob(), DataSourceBase::evaluate(), TypeInfo::getProtocol(), and DataSourceBase::getTypeInfo().

int serverProtocol ( ) const [virtual, inherited]

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 AnyDataSource, CORBAExpression, CORBAExpression< void >, CORBAAssignableExpression, and ExpressionProxy.

Definition at line 142 of file DataSource.cpp.

Referenced by AssignableDataSource::narrow(), DataSource::narrow(), CorbaTemplateProtocol::narrowAssignableDataSource(), and CorbaTemplateProtocol::narrowDataSource().

void * method	(	int	protocol,
		MethodC *	orig,
		void *	arg
	)			`[virtual, inherited]`

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 ExpressionProxy.

Definition at line 157 of file DataSource.cpp.

References TypeInfo::getProtocol(), DataSourceBase::getTypeInfo(), and TypeTransporter::method().

Member Data Documentation

oro_atomic_t 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.

Referenced by DataSourceBase::DataSourceBase(), DataSourceBase::deref(), and DataSourceBase::ref().

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

rtt/DataSource.hpp
rtt/DataSource.inl

Generated on Tue Mar 25 17:41:55 2008 for OrocosReal-TimeToolkit by

1.5.3

AssignableDataSource Class Template Reference

Detailed Description

template<typename T> class RTT::AssignableDataSource< T >

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Member Function Documentation

Member Data Documentation

template<typename T>
class RTT::AssignableDataSource< T >