RTT::internal::OperationCallerC Class Reference

#include <OperationCallerC.hpp>

Classes
class	D

Public Member Functions
OperationCallerC &	arg (base::DataSourceBase::shared_ptr a)
template<class ArgT >
OperationCallerC &	arg (ArgT &a)
template<class ArgT >
OperationCallerC &	argC (const ArgT a)
bool	call ()
void	check ()
base::DataSourceBase::shared_ptr	getCallDataSource ()
std::string const &	getName () const
OperationInterfacePart *	getOrp () const
base::DataSourceBase::shared_ptr	getSendDataSource ()
base::DataSourceBase::shared_ptr	getSendHandleDataSource ()
	OperationCallerC ()
	OperationCallerC (OperationInterfacePart *mr, const std::string &name, ExecutionEngine *caller)
	OperationCallerC (const OperationCallerC &other)
	OperationCallerC (const OperationCallerC &other, ExecutionEngine *caller)
OperationCallerC &	operator= (const OperationCallerC &other)
bool	ready () const
OperationCallerC &	ret (base::AttributeBase *r)
OperationCallerC &	ret (base::DataSourceBase::shared_ptr r)
template<class RetT >
OperationCallerC &	ret (RetT &r)
SendHandleC	send ()
	~OperationCallerC ()

Private Attributes
D *	d
base::DataSourceBase::shared_ptr	m
std::string	mname
OperationInterfacePart *	ofp
base::DataSourceBase::shared_ptr	s

Detailed Description

A template-less manager for OperationCaller calls.

Definition at line 55 of file OperationCallerC.hpp.

Constructor & Destructor Documentation

RTT::internal::OperationCallerC::OperationCallerC

(

)

The default constructor. Make a copy from another OperationCallerC object in order to make it usable.

Definition at line 124 of file OperationCallerC.cpp.

RTT::internal::OperationCallerC::OperationCallerC	(	OperationInterfacePart *	mr,
		const std::string &	name,
		ExecutionEngine *	caller
	)

The constructor.

See also

Service

Definition at line 129 of file OperationCallerC.cpp.

RTT::internal::OperationCallerC::OperationCallerC

(

const OperationCallerC &

other

)

A OperationCallerC is copyable by value.

Definition at line 143 of file OperationCallerC.cpp.

RTT::internal::OperationCallerC::OperationCallerC	(	const OperationCallerC &	other,
		ExecutionEngine *	caller
	)

A OperationCallerC is copyable by value, with assignment of a new caller.

Definition at line 148 of file OperationCallerC.cpp.

RTT::internal::OperationCallerC::~OperationCallerC

(

)

Definition at line 171 of file OperationCallerC.cpp.

Member Function Documentation

OperationCallerC & RTT::internal::OperationCallerC::arg

(

base::DataSourceBase::shared_ptr

a

)

Add a datasource argument to the OperationCaller.

Parameters

a	A DataSource which contents are consulted each time when call() is called.

Definition at line 176 of file OperationCallerC.cpp.

template<class ArgT >

OperationCallerC& RTT::internal::OperationCallerC::arg ( ArgT &  a )

inline

Add an argument by reference to the OperationCaller.

Parameters

a	A value of which the reference is used and re-read each time the method is called. Thus if the contents of the source of a changes, call() will use the new contents.

Definition at line 123 of file OperationCallerC.hpp.

template<class ArgT >

OperationCallerC& RTT::internal::OperationCallerC::argC ( const ArgT  a )

inline

Add a constant argument to the OperationCaller.

Parameters

a	A value of which a copy is made and this value is used each time in call().

Definition at line 111 of file OperationCallerC.hpp.

bool RTT::internal::OperationCallerC::call

(

)

Call the contained method.

Definition at line 223 of file OperationCallerC.cpp.

void RTT::internal::OperationCallerC::check

(

)

Checks if this method is ready for calling, will throw if not so. Otherwise, does nothing.

Exceptions

name_not_found_exception
wrong_number_of_args_exception
wrong_types_of_args_exception

Definition at line 239 of file OperationCallerC.cpp.

DataSourceBase::shared_ptr RTT::internal::OperationCallerC::getCallDataSource

(

)

Get the contained data source for 'call'.

Definition at line 292 of file OperationCallerC.cpp.

std::string const & RTT::internal::OperationCallerC::getName

(

)

const

Returns the name of the operation that will be called.

Definition at line 288 of file OperationCallerC.cpp.

OperationInterfacePart * RTT::internal::OperationCallerC::getOrp

(

)

const

Returns the factory which we use to produce the operation call.

Definition at line 284 of file OperationCallerC.cpp.

DataSourceBase::shared_ptr RTT::internal::OperationCallerC::getSendDataSource

(

)

Get the contained data source for 'send'.

Definition at line 293 of file OperationCallerC.cpp.

base::DataSourceBase::shared_ptr RTT::internal::OperationCallerC::getSendHandleDataSource

(

)

Get the contained data source for send handle.

OperationCallerC & RTT::internal::OperationCallerC::operator=

(

const OperationCallerC &

other

)

A OperationCallerC is assignable.

Definition at line 158 of file OperationCallerC.cpp.

bool RTT::internal::OperationCallerC::ready

(

)

const

Returns true if this method is ready for execution.

Definition at line 279 of file OperationCallerC.cpp.

OperationCallerC & RTT::internal::OperationCallerC::ret

(

base::AttributeBase *

r

)

Store the result of the method in a task's attribute.

Parameters

r	A task attribute in which the result is stored.

Definition at line 192 of file OperationCallerC.cpp.

OperationCallerC & RTT::internal::OperationCallerC::ret

(

base::DataSourceBase::shared_ptr

r

)

Store the result of the method in a DataSource.

Parameters

r	A data source in which the result is stored.

Definition at line 209 of file OperationCallerC.cpp.

template<class RetT >

OperationCallerC& RTT::internal::OperationCallerC::ret ( RetT &  r )

inline

Store the result of the method in variable.

Parameters

r	A reference to the variable in which the result is stored.

Definition at line 145 of file OperationCallerC.hpp.

SendHandleC RTT::internal::OperationCallerC::send

(

)

Send the contained method. The returned SendHandleC is properly constructed, but still requires the .arg() arguments. The arguments to provide are the ones that collect requires for the sent operation. Once they have been added to the SendHandleC, you can collect() on that object.

Definition at line 249 of file OperationCallerC.cpp.

Member Data Documentation

D* RTT::internal::OperationCallerC::d

private

Definition at line 60 of file OperationCallerC.hpp.

base::DataSourceBase::shared_ptr RTT::internal::OperationCallerC::m

private

Definition at line 62 of file OperationCallerC.hpp.

std::string RTT::internal::OperationCallerC::mname

private

Definition at line 65 of file OperationCallerC.hpp.

OperationInterfacePart* RTT::internal::OperationCallerC::ofp

private

Definition at line 64 of file OperationCallerC.hpp.

base::DataSourceBase::shared_ptr RTT::internal::OperationCallerC::s

private

Definition at line 63 of file OperationCallerC.hpp.

---

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

• OperationCallerC.hpp
• OperationCallerC.cpp