This class represents a read port using the data source interface. More...

#include <rtt/internal/InputPortSource.hpp>

Inheritance diagram for RTT::internal::InputPortSource< T >:

Public Types
typedef boost::intrusive_ptr < InputPortSource< T > >	shared_ptr
	Use this type to store a pointer to a DataSourceBase.
typedef T	value_t
	The bare type of T is extracted into value_t.
typedef T	result_t
typedef details::GetConstRef < T >::type	const_reference_t
typedef boost::intrusive_ptr < const DataSource< T > >	const_ptr
	Use this type to store a const pointer to a DataSourceBase.
Public Member Functions
	InputPortSource (InputPort< T > &port)
void	dropPort ()
	Called by owner port to notify that it is being destructed.
void	reset ()
	Reset the data to initial values.
bool	evaluate () const
	Force an evaluation of the DataSourceBase.
DataSource< T >::result_t	value () const
	Return the result of the last evaluate() function.
DataSource< T >::const_reference_t	rvalue () const
	Get a const reference to the value of this DataSource.
DataSource< T >::result_t	get () const
	Return the data as type T.
DataSource< T > *	clone () const
	Return a shallow clone of this DataSource.
DataSource< T > *	copy (std::map< const base::DataSourceBase , base::DataSourceBase > &alreadyCloned) const
	Create a deep copy of this internal::DataSource, unless it is already cloned.
	BOOST_STATIC_ASSERT (!details::HasConst< T >::value)
	If you get a compile error here, it means T has const or reference qualifiers, which is not allowed for DataSource<T>
void const *	getRawConstPointer ()
	Generic implementation of getRawConstPointer() based on rvalue()
template<>
void const *	getRawConstPointer ()
	Returns a const pointer to the sample contained in this data source, if there is any.
virtual std::string	getType () const
	Return useful type info in a human readable format.
virtual const types::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 bool	isAssignable () const
	Returns true if this object can be cast to an AssignableDataSource.
virtual void	updated ()
	In case the internal::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 internal::DataSource with the value of an other DataSource.
virtual ActionInterface *	updateAction (DataSourceBase *other)
	Generate a ActionInterface object which will update this internal::DataSource with the value of another internal::DataSource when execute()'ed.
virtual shared_ptr	getMember (const std::string &member_name)
	Get a (const) reference data source to a member of the structure of this data source.
virtual shared_ptr	getMember (DataSourceBase::shared_ptr member_id, DataSourceBase::shared_ptr offset)
	Same as above, but with run-time lookup of the member to use.
virtual std::vector< std::string >	getMemberNames () const
	Returns the names of all members of the structure contained in this data source, or an empty list if none.
virtual shared_ptr	getParent ()
	Returns the top level data source that contains the full data structure this data source refers to.
std::ostream &	write (std::ostream &os)
	Stream the contents of this object.
std::string	toString ()
	Get the contents of this object as a string.
virtual void *	getRawPointer ()
	Returns a pointer to the sample contained in this data source, if there is any, and if it is an lvalue.
Static Public Member Functions
static std::string	GetType ()
	Return usefull type info in a human readable format.
static const types::TypeInfo *	GetTypeInfo ()
	Return the Orocos type info.
static std::string	GetTypeName ()
	Return the Orocos type name, without const, pointer or reference qualifiers.
static DataSource< T > *	narrow (base::DataSourceBase *db)
	This method narrows a base::DataSourceBase to a typeded DataSource, possibly returning a new object.
static shared_ptr	stack_shared_ptr (DataSourceBase *dsb)
	Returns a shared ptr to a DataSourceBase living on the stack.
static const_ptr	stack_const_ptr (const DataSourceBase *dsb)
	Returns a const shared_ptr to a DataSourceBase living on the stack.
Protected Attributes
os::AtomicInt	refcount
	We keep the refcount ourselves.

Detailed Description

template<typename T>
class RTT::internal::InputPortSource< T >

This class represents a read port using the data source interface.

Beware that, depending on the connection used, ports actually change their state when read. For instance, a buffer connection *will* lose one element when get() or evaluate() are called. For that reason, it is considered bad practice to use a data source on a read port that is bound to a buffer connection.

This class should not be used directly in normal code. What you would usually do is create a new read port using OutputPort::antiClone() and call base::InputPortInterface::getDataSource() to get the corresponding data source. This is your duty to destroy the port when it is not needed anymore.

Definition at line 62 of file InputPortSource.hpp.

Member Function Documentation

template<typename T>

DataSource<T>* RTT::internal::InputPortSource< T >::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 internal::DataSource holds reference to. The clone() function is thus a non-deep copy.

Implements RTT::internal::DataSource< T >.

Definition at line 100 of file InputPortSource.hpp.

template<typename T>

DataSource<T>* RTT::internal::InputPortSource< T >::copy ( std::map< const base::DataSourceBase *, base::DataSourceBase * > & alreadyCloned ) const [inline, virtual]

Create a deep copy of this internal::DataSource, unless it is already cloned.

Places the association (parent, clone) in alreadyCloned. If the internal::DataSource is non-copyable (for example it represents the Property of a Task ), this may be returned.

Implements RTT::internal::DataSource< T >.

Definition at line 102 of file InputPortSource.hpp.

template<typename T>

void RTT::internal::InputPortSource< T >::dropPort ( ) [inline]

Called by owner port to notify that it is being destructed.

Since this InputPortSource is refcounted, we need a way to tell it that the port no longer exists.

Definition at line 79 of file InputPortSource.hpp.

template<typename T>

bool RTT::internal::InputPortSource< T >::evaluate ( ) const [inline, virtual]

Force an evaluation of the DataSourceBase.

Returns:: true on successful evaluation.

Reimplemented from RTT::internal::DataSource< T >.

Definition at line 84 of file InputPortSource.hpp.

Referenced by RTT::internal::InputPortSource< T >::get().

DataSourceBase::shared_ptr RTT::DataSourceBase::getMember ( const std::string & member_name ) [virtual, inherited]

Get a (const) reference data source to a member of the structure of this data source.

You must call getMember() in turn on the returned member to access sub-members.

Parameters:

member_name The name of the member to get access to.

Returns:: null if the member does not exist, this if member_name.empty(), and a reference data source to the member otherwise.

Definition at line 124 of file DataSource.cpp.

References RTT::types::TypeInfo::getMember(), and RTT::base::DataSourceBase::getTypeInfo().

DataSourceBase::shared_ptr RTT::DataSourceBase::getMember	(	DataSourceBase::shared_ptr	member_id,
		DataSourceBase::shared_ptr	offset
	)		`[virtual, inherited]`

Same as above, but with run-time lookup of the member to use.

Also takes an optional offset argument which can be used to offset the member in memory. This is necessary when using sequences of sequences. DataSources which are a sequence/offset member themselves must override this function to let the returned member take the offset into account.

Definition at line 130 of file DataSource.cpp.

References RTT::types::TypeInfo::getMember(), and RTT::base::DataSourceBase::getTypeInfo().

vector< string > RTT::DataSourceBase::getMemberNames ( ) const [virtual, inherited]

Returns the names of all members of the structure contained in this data source, or an empty list if none.

If this data source is a sequence, it will not return the allowed index numbers.

Definition at line 134 of file DataSource.cpp.

References RTT::types::TypeInfo::getMemberNames(), and RTT::base::DataSourceBase::getTypeInfo().

DataSourceBase::shared_ptr RTT::DataSourceBase::getParent ( ) [virtual, inherited]

Returns the top level data source that contains the full data structure this data source refers to.

Defaults to returning this.

Reimplemented in RTT::internal::OffsetPartDataSource< T >.

Definition at line 138 of file DataSource.cpp.

template<>

void const * RTT::internal::DataSource< void >::getRawConstPointer ( ) [inline, virtual, inherited]

Returns a const pointer to the sample contained in this data source, if there is any.

Returns 0 otherwise

Reimplemented from RTT::base::DataSourceBase.

Definition at line 59 of file DataSource.inl.

void * RTT::DataSourceBase::getRawPointer ( ) [virtual, inherited]

Returns a pointer to the sample contained in this data source, if there is any, and if it is an lvalue.

Returns 0 otherwise

Definition at line 115 of file DataSource.cpp.

bool RTT::DataSourceBase::isAssignable ( ) const [virtual, inherited]

Returns true if this object can be cast to an AssignableDataSource.

When this method returns true, all update functions below will return as well when valid input is given.

Definition at line 104 of file DataSource.cpp.

template<typename T>

DataSource<T>::const_reference_t RTT::internal::InputPortSource< T >::rvalue ( ) const [inline, virtual]

Get a const reference to the value of this DataSource.

You must call evaluate() prior to calling this function in order to get the most recent value of this attribute.

Note:: Getting a reference to an internal data structure is not thread-safe.

Implements RTT::internal::DataSource< T >.

Definition at line 91 of file InputPortSource.hpp.

DataSourceBase::const_ptr RTT::DataSourceBase::stack_const_ptr ( const DataSourceBase * dsb ) [static, inherited]

Returns a const shared_ptr to a DataSourceBase living on the stack.

Make sure that the const_ptr does not outlive the stacked element.

Definition at line 74 of file DataSource.cpp.

References RTT::base::DataSourceBase::ref().

DataSourceBase::shared_ptr RTT::DataSourceBase::stack_shared_ptr ( DataSourceBase * dsb ) [static, inherited]

Returns a shared ptr to a DataSourceBase living on the stack.

Make sure that the shared_ptr does not outlive the stacked element.

Definition at line 69 of file DataSource.cpp.

References RTT::base::DataSourceBase::ref().

std::string RTT::DataSourceBase::toString ( ) [inherited]

Get the contents of this object as a string.

See also:: types::TypeInfo

Definition at line 98 of file DataSource.cpp.

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

Update the value of this internal::DataSource with the value of an other DataSource.

Update does a full update of the value, adding extra information if necessary.

Precondition:: this->isAssignable() == true

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

Definition at line 108 of file DataSource.cpp.

ActionInterface * RTT::DataSourceBase::updateAction ( DataSourceBase * other ) [virtual, inherited]

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

Precondition:: this->isAssignable() == true

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

Definition at line 120 of file DataSource.cpp.

template<typename T>

DataSource<T>::result_t RTT::internal::InputPortSource< T >::value ( ) const [inline, virtual]

Return the result of the last evaluate() function.

You must call evaluate() prior to calling this function in order to get the most recent value of this attribute.

Implements RTT::internal::DataSource< T >.

Definition at line 89 of file InputPortSource.hpp.

Referenced by RTT::internal::InputPortSource< T >::get().

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

Stream the contents of this object.

See also:: types::TypeInfo

Definition at line 91 of file DataSource.cpp.

Member Data Documentation

os::AtomicInt RTT::base::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 88 of file DataSourceBase.hpp.

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

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

rtt/internal/InputPortSource.hpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

template<typename T> class RTT::internal::InputPortSource< T >

Member Function Documentation

Member Data Documentation

template<typename T>
class RTT::internal::InputPortSource< T >