RTT::scripting::CmdFunction Class Reference

#include <CmdFunction.hpp>

Inheritance diagram for RTT::scripting::CmdFunction:

Public Member Functions
CmdFunction *	clone () const
	CmdFunction (base::ActionInterface *init_com, boost::shared_ptr< ProgramInterface > foo, ExecutionEngine *p, ExecutionEngine *caller)
CmdFunction *	copy (std::map< const base::DataSourceBase *, base::DataSourceBase * > &alreadyCloned) const
virtual bool	evaluate () const
virtual SendStatus	get () const
virtual void	reset ()
virtual SendStatus const &	rvalue () const
virtual SendStatus	value () const
	~CmdFunction ()
Public Member Functions inherited from RTT::internal::DataSource< SendStatus >
	BOOST_STATIC_ASSERT (!details::HasConst< SendStatus >::value)
void const *	getRawConstPointer ()
virtual std::string	getType () const
virtual const types::TypeInfo *	getTypeInfo () const
virtual std::string	getTypeName () const
Public Member Functions inherited from RTT::base::DataSourceBase
virtual DataSourceBase *	copy (std::map< const DataSourceBase *, DataSourceBase * > &alreadyCloned) const =0
	DataSourceBase ()
void	deref () const
virtual shared_ptr	getMember (const std::string &member_name)
virtual shared_ptr	getMember (DataSourceBase::shared_ptr member_id, DataSourceBase::shared_ptr offset)
virtual std::vector< std::string >	getMemberNames () const
virtual shared_ptr	getParent ()
virtual void *	getRawPointer ()
virtual bool	isAssignable () const
void	ref () const
std::string	toString ()
virtual bool	update (DataSourceBase *other)
virtual ActionInterface *	updateAction (DataSourceBase *other)
virtual void	updated ()
std::ostream &	write (std::ostream &os)

Private Attributes
boost::shared_ptr< ProgramInterface >	_foo
bool	isqueued
bool	maccept
ExecutionEngine *	mcaller
base::ActionInterface *	minit
ExecutionEngine *	mrunner
SendStatus	ss

Additional Inherited Members
Public Types inherited from RTT::internal::DataSource< SendStatus >
typedef boost::intrusive_ptr< const DataSource< SendStatus > >	const_ptr
typedef details::GetConstRef< SendStatus >::type	const_reference_t
typedef SendStatus	result_t
typedef boost::intrusive_ptr< DataSource< SendStatus > >	shared_ptr
typedef SendStatus	value_t
Public Types inherited from RTT::base::DataSourceBase
typedef boost::intrusive_ptr< const DataSourceBase >	const_ptr
typedef boost::intrusive_ptr< DataSourceBase >	shared_ptr
Static Public Member Functions inherited from RTT::internal::DataSource< SendStatus >
static std::string	GetType ()
static const types::TypeInfo *	GetTypeInfo ()
static std::string	GetTypeName ()
static DataSource< SendStatus > *	narrow (base::DataSourceBase *db)
Static Public Member Functions inherited from RTT::base::DataSourceBase
static const_ptr	stack_const_ptr (const DataSourceBase *dsb)
static shared_ptr	stack_shared_ptr (DataSourceBase *dsb)
Protected Member Functions inherited from RTT::internal::DataSource< SendStatus >
virtual	~DataSource ()
Protected Member Functions inherited from RTT::base::DataSourceBase
virtual	~DataSourceBase ()
Protected Attributes inherited from RTT::base::DataSourceBase
os::AtomicInt	refcount

Detailed Description

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

Definition at line 64 of file CmdFunction.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_com	The command to execute before sending the function into the processor, in order to initialise it.
foo	The function to run in the processor.
p	The target processor which will run the function.

Definition at line 83 of file CmdFunction.hpp.

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

inline

Definition at line 93 of file CmdFunction.hpp.

Member Function Documentation

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 147 of file CmdFunction.hpp.

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

inlinevirtual

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

Definition at line 152 of file CmdFunction.hpp.

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 135 of file CmdFunction.hpp.

virtual SendStatus RTT::scripting::CmdFunction::get ( ) const

inlinevirtual

Return the data as type T.

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

Definition at line 98 of file CmdFunction.hpp.

virtual void RTT::scripting::CmdFunction::reset ( )

inlinevirtual

Reset the data to initial values.

Reimplemented from RTT::base::DataSourceBase.

Definition at line 140 of file CmdFunction.hpp.

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 131 of file CmdFunction.hpp.

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 127 of file CmdFunction.hpp.

Member Data Documentation

boost::shared_ptr<ProgramInterface> RTT::scripting::CmdFunction::_foo

private

Definition at line 70 of file CmdFunction.hpp.

bool RTT::scripting::CmdFunction::isqueued

mutableprivate

Definition at line 72 of file CmdFunction.hpp.

bool RTT::scripting::CmdFunction::maccept

mutableprivate

Definition at line 73 of file CmdFunction.hpp.

ExecutionEngine* RTT::scripting::CmdFunction::mcaller

private

Definition at line 69 of file CmdFunction.hpp.

base::ActionInterface* RTT::scripting::CmdFunction::minit

private

Definition at line 67 of file CmdFunction.hpp.

ExecutionEngine* RTT::scripting::CmdFunction::mrunner

private

Definition at line 68 of file CmdFunction.hpp.

SendStatus RTT::scripting::CmdFunction::ss

mutableprivate

Definition at line 71 of file CmdFunction.hpp.

---

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

• CmdFunction.hpp