OperationInterfacePart implementation that only provides synchronous access to an operation. More...

#include <rtt/internal/OperationInterfacePartFused.hpp>

Inheritance diagram for RTT::internal::SynchronousOperationInterfacePartFused< Signature >:

Public Member Functions
	SynchronousOperationInterfacePartFused (Operation< Signature > *o)

virtual base::DataSourceBase::shared_ptr	produceSend (const std::vector< base::DataSourceBase::shared_ptr > &args, ExecutionEngine *caller) const
	Create a DataSource for a given send operation. More...

virtual base::DataSourceBase::shared_ptr	produceCollect (const std::vector< base::DataSourceBase::shared_ptr > &args, internal::DataSource< bool >::shared_ptr blocking) const
	Create a DataSource for collecting the results of a Send. More...

virtual base::DataSourceBase::shared_ptr	produceHandle () const
	Create an empty SendHandle object for this operation. More...

virtual std::string	getName () const
	Returns the name of this operation. More...

virtual std::string	description () const
	Returns the description of this operation. More...

virtual std::vector< ArgumentDescription >	getArgumentList () const
	Get a description of the desired arguments in the ArgumentDescription format. More...

std::string	resultType () const
	Return the result (return) type of this operation. More...

unsigned int	arity () const
	Returns the arity (number of arguments) of this operation. More...

const types::TypeInfo *	getArgumentType (unsigned int arg) const
	Returns the type information of the n'th argument, with argument zero being the return value. More...

unsigned int	collectArity () const
	Returns the number of collectable arguments of this operation's function. More...

const types::TypeInfo *	getCollectType (unsigned int arg) const
	Returns the type information of the n'th collectable argument. More...

base::DataSourceBase::shared_ptr	produce (const std::vector< base::DataSourceBase::shared_ptr > &args, ExecutionEngine *caller) const
	Create a DataSource for a given callable operation. More...

boost::shared_ptr< base::DisposableInterface >	getLocalOperation () const
	Returns any local operation associated with this operation. More...

Detailed Description

template<typename Signature>
class RTT::internal::SynchronousOperationInterfacePartFused< Signature >

OperationInterfacePart implementation that only provides synchronous access to an operation.

Only produce() can be called, the others will throw a no_asynchronous_operation_exception.

Definition at line 251 of file OperationInterfacePartFused.hpp.

Constructor & Destructor Documentation

template<typename Signature >

RTT::internal::SynchronousOperationInterfacePartFused< Signature >::SynchronousOperationInterfacePartFused ( Operation< Signature > * o )

inline

Definition at line 261 of file OperationInterfacePartFused.hpp.

Member Function Documentation

template<typename Signature >

unsigned int RTT::internal::SynchronousOperationInterfacePartFused< Signature >::arity ( ) const

inlinevirtual

Returns the arity (number of arguments) of this operation.

See also: produce, produceSend

Implements RTT::OperationInterfacePart.

Definition at line 296 of file OperationInterfacePartFused.hpp.

Referenced by RTT::internal::SynchronousOperationInterfacePartFused< Signature >::getArgumentList(), and RTT::internal::SynchronousOperationInterfacePartFused< Signature >::produce().

template<typename Signature >

unsigned int RTT::internal::SynchronousOperationInterfacePartFused< Signature >::collectArity ( ) const

inlinevirtual

Returns the number of collectable arguments of this operation's function.

These consist of the return value and the reference arguments.

See also: produceCollect

Implements RTT::OperationInterfacePart.

Definition at line 305 of file OperationInterfacePartFused.hpp.

template<typename Signature >

virtual std::string RTT::internal::SynchronousOperationInterfacePartFused< Signature >::description ( ) const

inlinevirtual

Returns the description of this operation.

Returns

Implements RTT::OperationInterfacePart.

Definition at line 280 of file OperationInterfacePartFused.hpp.

References RTT::internal::OperationInterfacePartHelper::description().

template<typename Signature >

virtual std::vector<ArgumentDescription> RTT::internal::SynchronousOperationInterfacePartFused< Signature >::getArgumentList ( ) const

inlinevirtual

Get a description of the desired arguments in the ArgumentDescription format.

Implements RTT::OperationInterfacePart.

Definition at line 284 of file OperationInterfacePartFused.hpp.

References RTT::internal::SynchronousOperationInterfacePartFused< Signature >::arity(), and RTT::internal::OperationInterfacePartHelper::getArgumentList().

template<typename Signature >

const types::TypeInfo* RTT::internal::SynchronousOperationInterfacePartFused< Signature >::getArgumentType ( unsigned int arg ) const

inlinevirtual

Returns the type information of the n'th argument, with argument zero being the return value.

Parameters

arg	0: get return value type, 1..arity(): get n'th argument type.

Returns

A TypeInfo Object or null if

is out of range

Implements RTT::OperationInterfacePart.

Definition at line 298 of file OperationInterfacePartFused.hpp.

References RTT::internal::DataSourceTypeInfo< T >::getTypeInfo().

template<typename Signature >

const types::TypeInfo* RTT::internal::SynchronousOperationInterfacePartFused< Signature >::getCollectType ( unsigned int arg ) const

inlinevirtual

Returns the type information of the n'th collectable argument.

The numbering of arg starts from 1.

Parameters

arg	1..collectArity(): get n'th argument type.

Returns

A TypeInfo Object or null if

is out of range

Implements RTT::OperationInterfacePart.

Definition at line 307 of file OperationInterfacePartFused.hpp.

template<typename Signature >

boost::shared_ptr<base::DisposableInterface> RTT::internal::SynchronousOperationInterfacePartFused< Signature >::getLocalOperation ( ) const

inlinevirtual

Returns any local operation associated with this operation.

Returns: null if no such operation exists, the operation's implementation otherwise.

Reimplemented from RTT::OperationInterfacePart.

Definition at line 321 of file OperationInterfacePartFused.hpp.

References RTT::Operation< Signature >::getImplementation().

template<typename Signature >

virtual std::string RTT::internal::SynchronousOperationInterfacePartFused< Signature >::getName ( ) const

inlinevirtual

Returns the name of this operation.

Returns

Implements RTT::OperationInterfacePart.

Definition at line 277 of file OperationInterfacePartFused.hpp.

References RTT::base::OperationBase::getName().

template<typename Signature >

base::DataSourceBase::shared_ptr RTT::internal::SynchronousOperationInterfacePartFused< Signature >::produce	(	const std::vector< base::DataSourceBase::shared_ptr > &	args,
		ExecutionEngine *	caller
	)		const

inlinevirtual

Create a DataSource for a given callable operation.

Parameters

args	The arguments for the target object's function. The number of arguments must be identical to this->arity()
caller	The Engine that will receive notifications when the method has been executed, in case it runs in the owner's thread. Normally, this is the engine of the caller's TaskContext.

Returns: a DataSource which will return the result of this operation.

Exceptions

wrong_number_of_args_exception
wrong_types_of_args_exception
name_not_found_exception

Implements RTT::OperationInterfacePart.

Definition at line 312 of file OperationInterfacePartFused.hpp.

References RTT::internal::SynchronousOperationInterfacePartFused< Signature >::arity(), and RTT::Operation< Signature >::getOperationCaller().

template<typename Signature >

virtual base::DataSourceBase::shared_ptr RTT::internal::SynchronousOperationInterfacePartFused< Signature >::produceCollect	(	const std::vector< base::DataSourceBase::shared_ptr > &	args,
		internal::DataSource< bool >::shared_ptr	blocking
	)		const

inlinevirtual

Create a DataSource for collecting the results of a Send.

Parameters

args	A vector of data sources of which the first element contains a properly initialised sendhandle and the remainder of the elements contains datasources for collecting the return value and reference arguments. The total number of items in args must be collectArity() + 1
blocking	Set to true to do a blocking collect, false for a polling version.

Returns: A DataSource which collects the results when evaluated and which returns the SendStatus.

Exceptions

wrong_number_of_args_exception
wrong_types_of_args_exception
name_not_found_exception
no_asynchronous_operation_exception

Implements RTT::OperationInterfacePart.

Definition at line 268 of file OperationInterfacePartFused.hpp.

template<typename Signature >

virtual base::DataSourceBase::shared_ptr RTT::internal::SynchronousOperationInterfacePartFused< Signature >::produceHandle ( ) const

inlinevirtual

Create an empty SendHandle object for this operation.

Returns: a DataSource which contains an empty SendHandle.

Exceptions

wrong_number_of_args_exception
wrong_types_of_args_exception
name_not_found_exception
no_asynchronous_operation_exception

Implements RTT::OperationInterfacePart.

Definition at line 274 of file OperationInterfacePartFused.hpp.

template<typename Signature >

virtual base::DataSourceBase::shared_ptr RTT::internal::SynchronousOperationInterfacePartFused< Signature >::produceSend	(	const std::vector< base::DataSourceBase::shared_ptr > &	args,
		ExecutionEngine *	caller
	)		const

inlinevirtual

Create a DataSource for a given send operation.

Parameters

args	The arguments for the target object's function. The number of arguments must be identical to this->arity()
caller	The Engine that will receive notifications when the method has been executed. Normally, this is the engine of the caller's TaskContext.

Returns: a DataSource which contains the SendHandle of this operation.

See also: produceHandle

Exceptions

wrong_number_of_args_exception
wrong_types_of_args_exception
name_not_found_exception
no_asynchronous_operation_exception

Implements RTT::OperationInterfacePart.

Definition at line 266 of file OperationInterfacePartFused.hpp.

template<typename Signature >

std::string RTT::internal::SynchronousOperationInterfacePartFused< Signature >::resultType ( ) const

inlinevirtual

Return the result (return) type of this operation.

Implements RTT::OperationInterfacePart.

Definition at line 291 of file OperationInterfacePartFused.hpp.

References RTT::internal::DataSourceTypeInfo< T >::getQualifier(), and RTT::internal::DataSourceTypeInfo< T >::getType().

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

rtt/internal/OperationInterfacePartFused.hpp

Public Member Functions

Detailed Description

template<typename Signature> class RTT::internal::SynchronousOperationInterfacePartFused< Signature >

Constructor & Destructor Documentation

Member Function Documentation

template<typename Signature>
class RTT::internal::SynchronousOperationInterfacePartFused< Signature >