Orocos Real-Time Toolkit  2.9.0
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
RTT::scripting::CmdFunction Class Reference

A DataSource which sends a FunctionFraph for execution in a ExecutionEngine. More...

#include <rtt/scripting/CmdFunction.hpp>

Inheritance diagram for RTT::scripting::CmdFunction:
RTT::internal::DataSource< SendStatus > RTT::base::DataSourceBase

Public Types

typedef SendStatus value_t
 The bare type of T is extracted into value_t. More...
 
typedef SendStatus result_t
 
typedef details::GetConstRef< SendStatus >::type const_reference_t
 
typedef boost::intrusive_ptr< DataSource< SendStatus > > shared_ptr
 
typedef boost::intrusive_ptr< const DataSource< SendStatus > > const_ptr
 

Public Member Functions

 CmdFunction (base::ActionInterface *init_com, boost::shared_ptr< ProgramInterface > foo, ExecutionEngine *p, ExecutionEngine *caller)
 Create a Command to send a function to a ExecutionEngine. More...
 
 ~CmdFunction ()
 
virtual SendStatus get () const
 Return the data as type T. More...
 
virtual SendStatus value () const
 Return the result of the last evaluate() function. More...
 
virtual SendStatus const & rvalue () const
 Get a const reference to the value of this DataSource. More...
 
virtual bool evaluate () const
 Force an evaluation of the DataSourceBase. More...
 
virtual void reset ()
 Reset the data to initial values. More...
 
CmdFunctionclone () const
 Return a shallow clone of this DataSource. More...
 
CmdFunctioncopy (std::map< const base::DataSourceBase *, base::DataSourceBase * > &alreadyCloned) const
 Create a deep copy of this internal::DataSource, unless it is already cloned. More...
 
 BOOST_STATIC_ASSERT (!details::HasConst< SendStatus >::value)
 If you get a compile error here, it means T has const or reference qualifiers, which is not allowed for DataSource<T> More...
 
void const * getRawConstPointer ()
 Generic implementation of getRawConstPointer() based on rvalue() More...
 
virtual std::string getType () const
 Return useful type info in a human readable format. More...
 
virtual const types::TypeInfogetTypeInfo () const
 Return the Orocos type info object. More...
 
virtual std::string getTypeName () const
 Return the Orocos type name, without const, pointer or reference qualifiers. More...
 
void ref () const
 Increase the reference count by one. More...
 
void deref () const
 Decrease the reference count by one and delete this on zero. More...
 
virtual bool isAssignable () const
 Returns true if this object can be cast to an AssignableDataSource. More...
 
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(). More...
 
virtual bool update (DataSourceBase *other)
 Update the value of this internal::DataSource with the value of an other DataSource. More...
 
virtual ActionInterfaceupdateAction (DataSourceBase *other)
 Generate a ActionInterface object which will update this internal::DataSource with the value of another internal::DataSource when execute()'ed. More...
 
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. More...
 
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. More...
 
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. More...
 
virtual shared_ptr getParent ()
 Returns the top level data source that contains the full data structure this data source refers to. More...
 
std::ostream & write (std::ostream &os)
 Stream the contents of this object. More...
 
std::string toString ()
 Get the contents of this object as a string. More...
 
virtual void * getRawPointer ()
 Returns a pointer to the sample contained in this data source, if there is any, and if it is an lvalue. More...
 

Static Public Member Functions

static std::string GetType ()
 Return usefull type info in a human readable format. More...
 
static const types::TypeInfoGetTypeInfo ()
 Return the Orocos type info. More...
 
static std::string GetTypeName ()
 Return the Orocos type name, without const, pointer or reference qualifiers. More...
 
static DataSource< SendStatus > * narrow (base::DataSourceBase *db)
 This method narrows a base::DataSourceBase to a typeded DataSource, possibly returning a new object. More...
 
static shared_ptr stack_shared_ptr (DataSourceBase *dsb)
 Returns a shared ptr to a DataSourceBase living on the stack. More...
 
static const_ptr stack_const_ptr (const DataSourceBase *dsb)
 Returns a const shared_ptr to a DataSourceBase living on the stack. More...
 

Protected Attributes

os::AtomicInt refcount
 We keep the refcount ourselves. More...
 

Detailed Description

A DataSource which sends a FunctionFraph for execution in a ExecutionEngine.

Definition at line 26 of file CmdFunction.hpp.

Member Typedef Documentation

typedef boost::intrusive_ptr<const DataSource<SendStatus > > RTT::internal::DataSource< SendStatus >::const_ptr
inherited

Definition at line 117 of file DataSource.hpp.

Definition at line 107 of file DataSource.hpp.

Definition at line 106 of file DataSource.hpp.

typedef boost::intrusive_ptr<DataSource<SendStatus > > RTT::internal::DataSource< SendStatus >::shared_ptr
inherited

Definition at line 115 of file DataSource.hpp.

The bare type of T is extracted into value_t.

Definition at line 105 of file DataSource.hpp.

Constructor & Destructor Documentation

RTT::scripting::CmdFunction::CmdFunction ( base::ActionInterface init_com,
boost::shared_ptr< ProgramInterface foo,
ExecutionEngine p,
ExecutionEngine caller 
)
inline

Create a Command to send a function to a ExecutionEngine.

Parameters
init_comThe command to execute before sending the function into the processor, in order to initialise it.
fooThe function to run in the processor.
pThe target processor which will run the function.

Definition at line 45 of file CmdFunction.hpp.

RTT::scripting::CmdFunction::~CmdFunction ( )
inline

Definition at line 55 of file CmdFunction.hpp.

Member Function Documentation

RTT::internal::DataSource< SendStatus >::BOOST_STATIC_ASSERT ( !details::HasConst< SendStatus >::value  )
inherited

If you get a compile error here, it means T has const or reference qualifiers, which is not allowed for DataSource<T>

CmdFunction* RTT::scripting::CmdFunction::clone ( ) const
inlinevirtual

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

Definition at line 109 of file CmdFunction.hpp.

CmdFunction* RTT::scripting::CmdFunction::copy ( std::map< const base::DataSourceBase *, base::DataSourceBase * > &  alreadyCloned) const
inlinevirtual

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

Definition at line 114 of file CmdFunction.hpp.

void RTT::DataSourceBase::deref ( ) const
inherited

Decrease the reference count by one and delete this on zero.

Definition at line 81 of file DataSource.cpp.

References RTT::os::AtomicInt::dec_and_test(), and RTT::base::DataSourceBase::refcount.

Referenced by RTT::base::intrusive_ptr_release().

virtual bool RTT::scripting::CmdFunction::evaluate ( ) const
inlinevirtual

Force an evaluation of the DataSourceBase.

Returns
true on successful evaluation.

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

Definition at line 97 of file CmdFunction.hpp.

References RTT::SendNotReady.

virtual SendStatus RTT::scripting::CmdFunction::get ( ) const
inlinevirtual
DataSourceBase::shared_ptr RTT::DataSourceBase::getMember ( const std::string &  member_name)
virtualinherited

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_nameThe 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 
)
virtualinherited

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
virtualinherited

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

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

Defaults to returning this.

Definition at line 138 of file DataSource.cpp.

void const* RTT::internal::DataSource< SendStatus >::getRawConstPointer ( )
inlinevirtualinherited

Generic implementation of getRawConstPointer() based on rvalue()

Reimplemented from RTT::base::DataSourceBase.

Definition at line 141 of file DataSource.hpp.

void * RTT::DataSourceBase::getRawPointer ( )
virtualinherited
virtual std::string RTT::internal::DataSource< SendStatus >::getType ( ) const
virtualinherited

Return useful type info in a human readable format.

Implements RTT::base::DataSourceBase.

static std::string RTT::internal::DataSource< SendStatus >::GetType ( )
staticinherited

Return usefull type info in a human readable format.

virtual const types::TypeInfo* RTT::internal::DataSource< SendStatus >::getTypeInfo ( ) const
virtualinherited

Return the Orocos type info object.

Implements RTT::base::DataSourceBase.

static const types::TypeInfo* RTT::internal::DataSource< SendStatus >::GetTypeInfo ( )
staticinherited

Return the Orocos type info.

static std::string RTT::internal::DataSource< SendStatus >::GetTypeName ( )
staticinherited

Return the Orocos type name, without const, pointer or reference qualifiers.

virtual std::string RTT::internal::DataSource< SendStatus >::getTypeName ( ) const
virtualinherited

Return the Orocos type name, without const, pointer or reference qualifiers.

Implements RTT::base::DataSourceBase.

bool RTT::DataSourceBase::isAssignable ( ) const
virtualinherited
static DataSource<SendStatus >* RTT::internal::DataSource< SendStatus >::narrow ( base::DataSourceBase db)
staticinherited

This method narrows a base::DataSourceBase to a typeded DataSource, possibly returning a new object.

void RTT::DataSourceBase::ref ( ) const
inherited
virtual void RTT::scripting::CmdFunction::reset ( )
inlinevirtual

Reset the data to initial values.

Reimplemented from RTT::base::DataSourceBase.

Definition at line 102 of file CmdFunction.hpp.

References RTT::ExecutionEngine::removeFunction(), and RTT::SendFailure.

virtual SendStatus const& RTT::scripting::CmdFunction::rvalue ( ) const
inlinevirtual

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

Definition at line 93 of file CmdFunction.hpp.

DataSourceBase::const_ptr RTT::DataSourceBase::stack_const_ptr ( const DataSourceBase dsb)
staticinherited

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)
staticinherited

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)
virtualinherited
ActionInterface * RTT::DataSourceBase::updateAction ( DataSourceBase other)
virtualinherited
void RTT::DataSourceBase::updated ( )
virtualinherited
virtual SendStatus RTT::scripting::CmdFunction::value ( ) const
inlinevirtual

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

Definition at line 89 of file CmdFunction.hpp.

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
mutableprotectedinherited

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: