RTT::corba::CorbaOperationCallerFactory Class Reference

#include <CorbaOperationCallerFactory.hpp>

Inheritance diagram for RTT::corba::CorbaOperationCallerFactory:

Public Types
typedef std::vector < base::DataSourceBase::shared_ptr >	CArguments
typedef std::vector < base::DataSourceBase::shared_ptr >	CArguments
typedef std::vector < ArgumentDescription >	CDescriptions
typedef std::vector < ArgumentDescription >	CDescriptions
typedef std::vector< std::string >	Members
typedef std::vector< std::string >	Members
Public Member Functions
virtual unsigned int	arity () const
virtual unsigned int	arity () const
virtual unsigned int	collectArity () const
virtual unsigned int	collectArity () const
	CorbaOperationCallerFactory (const std::string &method_name, corba::CService_ptr fact, PortableServer::POA_ptr the_poa)
	CorbaOperationCallerFactory (const std::string &method_name, corba::CService_ptr fact, PortableServer::POA_ptr the_poa)
virtual std::string	description () const
virtual std::string	description () const
virtual std::vector < ArgumentDescription >	getArgumentList () const
virtual std::vector < ArgumentDescription >	getArgumentList () const
virtual const types::TypeInfo *	getArgumentType (unsigned int i) const
virtual const types::TypeInfo *	getArgumentType (unsigned int i) const
virtual const types::TypeInfo *	getCollectType (unsigned int i) const
virtual const types::TypeInfo *	getCollectType (unsigned int i) const
virtual std::string	getName () const
virtual std::string	getName () const
corba::CService_ptr	getService ()
corba::CService_ptr	getService ()
virtual base::DataSourceBase::shared_ptr	produce (const std::vector< base::DataSourceBase::shared_ptr > &args, ExecutionEngine *caller) const
virtual base::DataSourceBase::shared_ptr	produce (const std::vector< base::DataSourceBase::shared_ptr > &args, ExecutionEngine *caller) const
virtual base::DataSourceBase::shared_ptr	produceCollect (const std::vector< base::DataSourceBase::shared_ptr > &args, internal::DataSource< bool >::shared_ptr blocking) const
virtual base::DataSourceBase::shared_ptr	produceCollect (const std::vector< base::DataSourceBase::shared_ptr > &args, internal::DataSource< bool >::shared_ptr blocking) const
virtual base::DataSourceBase::shared_ptr	produceHandle () const
virtual base::DataSourceBase::shared_ptr	produceHandle () const
virtual base::DataSourceBase::shared_ptr	produceSend (const std::vector< base::DataSourceBase::shared_ptr > &args, ExecutionEngine *caller) const
virtual base::DataSourceBase::shared_ptr	produceSend (const std::vector< base::DataSourceBase::shared_ptr > &args, ExecutionEngine *caller) const
Handle	produceSignal (base::ActionInterface *func, const std::vector< base::DataSourceBase::shared_ptr > &args) const
Handle	produceSignal (base::ActionInterface *func, const std::vector< base::DataSourceBase::shared_ptr > &args) const
virtual std::string	resultType () const
virtual std::string	resultType () const
virtual	~CorbaOperationCallerFactory ()
virtual	~CorbaOperationCallerFactory ()
Private Attributes
std::string	method
corba::CService_var	mfact
PortableServer::POA_var	mpoa

Detailed Description

A local factory for creating remote Corba methods. It connects to an corba::Service and translates C++ calls to corba idl.

Definition at line 62 of file install/include/rtt/transports/corba/CorbaOperationCallerFactory.hpp.

Member Typedef Documentation

typedef std::vector<base::DataSourceBase::shared_ptr> RTT::corba::CorbaOperationCallerFactory::CArguments

Definition at line 69 of file rtt/transports/corba/CorbaOperationCallerFactory.hpp.

typedef std::vector<base::DataSourceBase::shared_ptr> RTT::corba::CorbaOperationCallerFactory::CArguments

Definition at line 69 of file install/include/rtt/transports/corba/CorbaOperationCallerFactory.hpp.

typedef std::vector< ArgumentDescription > RTT::corba::CorbaOperationCallerFactory::CDescriptions

Definition at line 71 of file rtt/transports/corba/CorbaOperationCallerFactory.hpp.

typedef std::vector< ArgumentDescription > RTT::corba::CorbaOperationCallerFactory::CDescriptions

Definition at line 71 of file install/include/rtt/transports/corba/CorbaOperationCallerFactory.hpp.

typedef std::vector<std::string> RTT::corba::CorbaOperationCallerFactory::Members

Definition at line 70 of file rtt/transports/corba/CorbaOperationCallerFactory.hpp.

typedef std::vector<std::string> RTT::corba::CorbaOperationCallerFactory::Members

Definition at line 70 of file install/include/rtt/transports/corba/CorbaOperationCallerFactory.hpp.

Constructor & Destructor Documentation

RTT::corba::CorbaOperationCallerFactory::CorbaOperationCallerFactory	(	const std::string &	method_name,
		corba::CService_ptr	fact,
		PortableServer::POA_ptr	the_poa
	)

virtual RTT::corba::CorbaOperationCallerFactory::~CorbaOperationCallerFactory ( ) [virtual]

RTT::corba::CorbaOperationCallerFactory::CorbaOperationCallerFactory	(	const std::string &	method_name,
		corba::CService_ptr	fact,
		PortableServer::POA_ptr	the_poa
	)

virtual RTT::corba::CorbaOperationCallerFactory::~CorbaOperationCallerFactory ( ) [virtual]

Member Function Documentation

virtual unsigned int RTT::corba::CorbaOperationCallerFactory::arity ( ) const [virtual]

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

See also:: produce, produceSend

Implements RTT::OperationInterfacePart.

virtual unsigned int RTT::corba::CorbaOperationCallerFactory::arity ( ) const [virtual]

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

See also:: produce, produceSend

Implements RTT::OperationInterfacePart.

virtual unsigned int RTT::corba::CorbaOperationCallerFactory::collectArity ( ) const [virtual]

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.

virtual unsigned int RTT::corba::CorbaOperationCallerFactory::collectArity ( ) const [virtual]

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.

virtual std::string RTT::corba::CorbaOperationCallerFactory::description ( ) const [virtual]

Returns the description of this operation.

Returns:

Implements RTT::OperationInterfacePart.

virtual std::string RTT::corba::CorbaOperationCallerFactory::description ( ) const [virtual]

Returns the description of this operation.

Returns:

Implements RTT::OperationInterfacePart.

virtual std::vector< ArgumentDescription > RTT::corba::CorbaOperationCallerFactory::getArgumentList ( ) const [virtual]

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

Implements RTT::OperationInterfacePart.

virtual std::vector< ArgumentDescription > RTT::corba::CorbaOperationCallerFactory::getArgumentList ( ) const [virtual]

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

Implements RTT::OperationInterfacePart.

virtual const types::TypeInfo* RTT::corba::CorbaOperationCallerFactory::getArgumentType ( unsigned int arg ) const [virtual]

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.

virtual const types::TypeInfo* RTT::corba::CorbaOperationCallerFactory::getArgumentType ( unsigned int arg ) const [virtual]

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.

virtual const types::TypeInfo* RTT::corba::CorbaOperationCallerFactory::getCollectType ( unsigned int arg ) const [virtual]

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.

virtual const types::TypeInfo* RTT::corba::CorbaOperationCallerFactory::getCollectType ( unsigned int arg ) const [virtual]

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.

virtual std::string RTT::corba::CorbaOperationCallerFactory::getName ( ) const [virtual]

Returns the name of this operation.

Returns:

Implements RTT::OperationInterfacePart.

virtual std::string RTT::corba::CorbaOperationCallerFactory::getName ( ) const [virtual]

Returns the name of this operation.

Returns:

Implements RTT::OperationInterfacePart.

corba::CService_ptr RTT::corba::CorbaOperationCallerFactory::getService ( ) [inline]

Returns the remote service that hosts this part.

Returns:: The pointer to a CService object. You need to duplicate it if you want to keep using it.

Definition at line 82 of file rtt/transports/corba/CorbaOperationCallerFactory.hpp.

corba::CService_ptr RTT::corba::CorbaOperationCallerFactory::getService ( ) [inline]

Returns the remote service that hosts this part.

Returns:: The pointer to a CService object. You need to duplicate it if you want to keep using it.

Definition at line 82 of file install/include/rtt/transports/corba/CorbaOperationCallerFactory.hpp.

virtual base::DataSourceBase::shared_ptr RTT::corba::CorbaOperationCallerFactory::produce	(	const std::vector< base::DataSourceBase::shared_ptr > &	args,
		ExecutionEngine *	caller
	)			const `[virtual]`

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.

virtual base::DataSourceBase::shared_ptr RTT::corba::CorbaOperationCallerFactory::produce	(	const std::vector< base::DataSourceBase::shared_ptr > &	args,
		ExecutionEngine *	caller
	)			const `[virtual]`

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.

virtual base::DataSourceBase::shared_ptr RTT::corba::CorbaOperationCallerFactory::produceCollect	(	const std::vector< base::DataSourceBase::shared_ptr > &	args,
		internal::DataSource< bool >::shared_ptr	blocking
	)			const `[virtual]`

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.

virtual base::DataSourceBase::shared_ptr RTT::corba::CorbaOperationCallerFactory::produceCollect	(	const std::vector< base::DataSourceBase::shared_ptr > &	args,
		internal::DataSource< bool >::shared_ptr	blocking
	)			const `[virtual]`

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.

virtual base::DataSourceBase::shared_ptr RTT::corba::CorbaOperationCallerFactory::produceHandle ( ) const [virtual]

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.

virtual base::DataSourceBase::shared_ptr RTT::corba::CorbaOperationCallerFactory::produceHandle ( ) const [virtual]

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.

virtual base::DataSourceBase::shared_ptr RTT::corba::CorbaOperationCallerFactory::produceSend	(	const std::vector< base::DataSourceBase::shared_ptr > &	args,
		ExecutionEngine *	caller
	)			const `[virtual]`

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.

virtual base::DataSourceBase::shared_ptr RTT::corba::CorbaOperationCallerFactory::produceSend	(	const std::vector< base::DataSourceBase::shared_ptr > &	args,
		ExecutionEngine *	caller
	)			const `[virtual]`

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.

Handle RTT::corba::CorbaOperationCallerFactory::produceSignal	(	base::ActionInterface *	func,
		const std::vector< base::DataSourceBase::shared_ptr > &	args
	)			const `[virtual]`

Attach a Signal Handle to this operation which fills in the given data sources and executes a given function.

Parameters:

	func	The function to execute
	args	The data sources to fill in with the arguments the operation was given. The number of elements and their type must match the signature of the operation.

Returns:: A valid Signal Handle if the arguments were valid.

Exceptions:

no_asynchronous_operation_exception

Implements RTT::OperationInterfacePart.

Handle RTT::corba::CorbaOperationCallerFactory::produceSignal	(	base::ActionInterface *	func,
		const std::vector< base::DataSourceBase::shared_ptr > &	args
	)			const `[virtual]`

Attach a Signal Handle to this operation which fills in the given data sources and executes a given function.

Parameters:

	func	The function to execute
	args	The data sources to fill in with the arguments the operation was given. The number of elements and their type must match the signature of the operation.