RTT::internal::OperationCallerC Class Reference

#include <OperationCallerC.hpp>

List of all members.

Public Member Functions
template<class ArgT >
OperationCallerC &	arg (ArgT &a)
OperationCallerC &	arg (base::DataSourceBase::shared_ptr a)
template<class ArgT >
OperationCallerC &	arg (ArgT &a)
OperationCallerC &	arg (base::DataSourceBase::shared_ptr a)
template<class ArgT >
OperationCallerC &	argC (const ArgT a)
template<class ArgT >
OperationCallerC &	argC (const ArgT a)
bool	call ()
bool	call ()
void	check ()
void	check ()
base::DataSourceBase::shared_ptr	getCallDataSource ()
base::DataSourceBase::shared_ptr	getCallDataSource ()
std::string const &	getName () const
std::string const &	getName () const
OperationInterfacePart *	getOrp () const
OperationInterfacePart *	getOrp () const
base::DataSourceBase::shared_ptr	getSendDataSource ()
base::DataSourceBase::shared_ptr	getSendDataSource ()
base::DataSourceBase::shared_ptr	getSendHandleDataSource ()
base::DataSourceBase::shared_ptr	getSendHandleDataSource ()
	OperationCallerC (const OperationCallerC &other)
	OperationCallerC (OperationInterfacePart *mr, const std::string &name, ExecutionEngine *caller)
	OperationCallerC ()
	OperationCallerC (const OperationCallerC &other)
	OperationCallerC (OperationInterfacePart *mr, const std::string &name, ExecutionEngine *caller)
	OperationCallerC ()
OperationCallerC &	operator= (const OperationCallerC &other)
OperationCallerC &	operator= (const OperationCallerC &other)
bool	ready () const
bool	ready () const
template<class RetT >
OperationCallerC &	ret (RetT &r)
OperationCallerC &	ret (base::DataSourceBase::shared_ptr r)
OperationCallerC &	ret (base::AttributeBase *r)
template<class RetT >
OperationCallerC &	ret (RetT &r)
OperationCallerC &	ret (base::DataSourceBase::shared_ptr r)
OperationCallerC &	ret (base::AttributeBase *r)
SendHandleC	send ()
SendHandleC	send ()
	~OperationCallerC ()
	~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 53 of file install/include/rtt/internal/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.

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

The constructor.

See also:

Service

RTT::internal::OperationCallerC::OperationCallerC

(

const OperationCallerC &

other

)

A OperationCallerC is copyable by value.

RTT::internal::OperationCallerC::~OperationCallerC

(

)

RTT::internal::OperationCallerC::OperationCallerC

(

)

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

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

The constructor.

See also:

Service

RTT::internal::OperationCallerC::OperationCallerC

(

const OperationCallerC &

other

)

A OperationCallerC is copyable by value.

RTT::internal::OperationCallerC::~OperationCallerC

(

)

---

Member Function Documentation

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 118 of file rtt/internal/OperationCallerC.hpp.

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.

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 110 of file install/include/rtt/internal/OperationCallerC.hpp.

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.

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 106 of file rtt/internal/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 98 of file install/include/rtt/internal/OperationCallerC.hpp.

bool RTT::internal::OperationCallerC::call

(

)

Call the contained method.

bool RTT::internal::OperationCallerC::call

(

)

Call the contained method.

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

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

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

(

)

Get the contained data source for 'call'.

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

(

)

Get the contained data source for 'call'.

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

(

)

const

Returns the name of the operation that will be called.

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

(

)

const

Returns the name of the operation that will be called.

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

(

)

const

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

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

(

)

const

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

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

(

)

Get the contained data source for 'send'.

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

(

)

Get the contained data source for 'send'.

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

(

)

Get the contained data source for send handle.

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.

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

(

const OperationCallerC &

other

)

A OperationCallerC is assignable.

bool RTT::internal::OperationCallerC::ready

(

)

const

Returns true if this method is ready for execution.

bool RTT::internal::OperationCallerC::ready

(

)

const

Returns true if this method is ready for execution.

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 140 of file rtt/internal/OperationCallerC.hpp.

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.

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.

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 132 of file install/include/rtt/internal/OperationCallerC.hpp.

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.

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.

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.

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.

---

Member Data Documentation

D * RTT::internal::OperationCallerC::d [private]

Definition at line 52 of file install/include/rtt/internal/OperationCallerC.hpp.

base::DataSourceBase::shared_ptr RTT::internal::OperationCallerC::m [private]

Definition at line 54 of file install/include/rtt/internal/OperationCallerC.hpp.

std::string RTT::internal::OperationCallerC::mname [private]

Definition at line 57 of file install/include/rtt/internal/OperationCallerC.hpp.

OperationInterfacePart * RTT::internal::OperationCallerC::ofp [private]

Definition at line 56 of file install/include/rtt/internal/OperationCallerC.hpp.

base::DataSourceBase::shared_ptr RTT::internal::OperationCallerC::s [private]

Definition at line 55 of file install/include/rtt/internal/OperationCallerC.hpp.

---

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

• install/include/rtt/internal/OperationCallerC.hpp
• rtt/internal/OperationCallerC.hpp