Orocos Real-Time Toolkit  2.8.3
Public Types | Public Member Functions | List of all members
RTT::corba::COperationInterface Interface Reference

Exposes the operations this service offers. More...

import"rtt/transports/corba/OperationInterface.idl";

Inheritance diagram for RTT::corba::COperationInterface:
RTT::corba::CService

Public Types

typedef sequence< string > COperationList
 

Public Member Functions

COperationList getOperations ()
 Get a list of all operations. More...
 
CDescriptions getArguments (in string operation) raises (CNoSuchNameException)
 Get a list of all arguments of a given operation. More...
 
unsigned short getArity (in string operation) raises (CNoSuchNameException)
 Returns the number of arguments required in callOperation() and sendOperation() for a given operation. More...
 
unsigned short getCollectArity (in string operation) raises (CNoSuchNameException)
 Returns the number of arguments required in CSendHandle::collect() and CSendHandle::collectIfDone() for a given operation. More...
 
string getResultType (in string operation) raises (CNoSuchNameException)
 Get a result type of a given operation. More...
 
string getArgumentType (in string operation, in unsigned short nbr) raises (CNoSuchNameException, CWrongArgumentException)
 Returns the argument or return type name of call as known to the Orocos type system. More...
 
string getCollectType (in string operation, in unsigned short nbr) raises (CNoSuchNameException, CWrongArgumentException)
 Returns the argument type of collect as known to the Orocos type system. More...
 
string getDescription (in string operation) raises (CNoSuchNameException)
 Get a description of a given operation. More...
 
void checkOperation (in string operation, in CAnyArguments args) raises ( CNoSuchNameException, CWrongNumbArgException, CWrongTypeArgException)
 Checks if a given operation accepts the list of arguments. More...
 
any callOperation (in string operation, inout CAnyArguments args) raises ( CNoSuchNameException, CWrongNumbArgException, CWrongTypeArgException, CCallInterrupted, CCallError)
 Call an operation with a list of arguments. More...
 
CSendHandle sendOperation (in string operation, in CAnyArguments args) raises ( CNoSuchNameException, CWrongNumbArgException, CWrongTypeArgException, CCallInterrupted)
 Send an operation with a list of arguments. More...
 

Detailed Description

Exposes the operations this service offers.

Definition at line 126 of file OperationInterface.idl.

Member Typedef Documentation

Definition at line 128 of file OperationInterface.idl.

Member Function Documentation

any RTT::corba::COperationInterface::callOperation ( in string  operation,
inout CAnyArguments  args 
)
raises ( CNoSuchNameException,
CWrongNumbArgException,
CWrongTypeArgException,
CCallInterrupted,
CCallError
)

Call an operation with a list of arguments.

This method will block until the operation completes and returns its result.

void RTT::corba::COperationInterface::checkOperation ( in string  operation,
in CAnyArguments  args 
)
raises ( CNoSuchNameException,
CWrongNumbArgException,
CWrongTypeArgException
)

Checks if a given operation accepts the list of arguments.

If no exception is thrown, the arguments and operation name were valid.

CDescriptions RTT::corba::COperationInterface::getArguments ( in string  operation)
raises (CNoSuchNameException
)

Get a list of all arguments of a given operation.

string RTT::corba::COperationInterface::getArgumentType ( in string  operation,
in unsigned short  nbr 
)
raises (CNoSuchNameException,
CWrongArgumentException
)

Returns the argument or return type name of call as known to the Orocos type system.

unsigned short RTT::corba::COperationInterface::getArity ( in string  operation)
raises (CNoSuchNameException
)

Returns the number of arguments required in callOperation() and sendOperation() for a given operation.

unsigned short RTT::corba::COperationInterface::getCollectArity ( in string  operation)
raises (CNoSuchNameException
)

Returns the number of arguments required in CSendHandle::collect() and CSendHandle::collectIfDone() for a given operation.

string RTT::corba::COperationInterface::getCollectType ( in string  operation,
in unsigned short  nbr 
)
raises (CNoSuchNameException,
CWrongArgumentException
)

Returns the argument type of collect as known to the Orocos type system.

string RTT::corba::COperationInterface::getDescription ( in string  operation)
raises (CNoSuchNameException
)

Get a description of a given operation.

COperationList RTT::corba::COperationInterface::getOperations ( )

Get a list of all operations.

string RTT::corba::COperationInterface::getResultType ( in string  operation)
raises (CNoSuchNameException
)

Get a result type of a given operation.

CSendHandle RTT::corba::COperationInterface::sendOperation ( in string  operation,
in CAnyArguments  args 
)
raises ( CNoSuchNameException,
CWrongNumbArgException,
CWrongTypeArgException,
CCallInterrupted
)

Send an operation with a list of arguments.

This method will return immediately and return a CSendHandle.


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