Orocos Real-Time Toolkit
2.8.3
|
An Orocos Service which hosts operations, attributes and properties. More...
import"rtt/transports/corba/Service.idl";
Public Types | |
typedef sequence< string > | CProviderNames |
typedef sequence< string > | COperationList |
typedef sequence< CProperty > | CPropertyNames |
typedef sequence< string > | CAttributeNames |
typedef sequence< string > | CPortNames |
typedef sequence< CPortDescription > | CPortDescriptions |
Public Member Functions | |
string | getName () |
Return the name of this service. More... | |
string | getServiceDescription () |
Return the description of this service. More... | |
CProviderNames | getProviderNames () |
Get a list of all the child services this service offers. More... | |
CService | getService (in string name) |
Get a child service this service provides. More... | |
boolean | hasService (in string name) |
Has this service a child service with given name ? More... | |
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... | |
CAttributeNames | getAttributeList () |
CPropertyNames | getPropertyList () |
any | getAttribute (in string name) raises (StdException) |
boolean | setAttribute (in string name, in any value) |
boolean | hasAttribute (in string name) |
boolean | hasProperty (in string name) |
any | getProperty (in string name) raises (StdException) |
Get a property by name. More... | |
boolean | setProperty (in string name, in any value) |
Set a property by name. More... | |
string | getPropertyType (in string name) |
Return the type of the attribute or property. More... | |
string | getAttributeType (in string name) |
string | getPropertyTypeName (in string name) |
Return the type name of the expression as it is known to the Orocos Type System. More... | |
string | getAttributeTypeName (in string name) |
string | attributeToString (in string name) |
Return the result of an attribute or property as a text string. More... | |
string | propertyToString (in string name) |
boolean | attributeFromString (in string name, in string value) |
Assign a given property or attribute a stringified value. More... | |
boolean | propertyFromString (in string name, in string value) |
boolean | isAttributeAssignable (in string name) |
Returns true if the attribute can be changed. More... | |
CPortNames | getPorts () |
Returns the names of the ports of this component. More... | |
CPortDescriptions | getPortDescriptions () |
Returns the names of the ports of this component. More... | |
CPortType | getPortType (in string port_name) raises (CNoSuchPortException) |
Returns the type of the given port. More... | |
string | getDataType (in string port_name) raises (CNoSuchPortException) |
Returns the data type for the given port. More... | |
boolean | isConnected (in string port_name) raises (CNoSuchPortException) |
Check if the given port is already connected to something. More... | |
void | disconnectPort (in string port_name) raises (CNoSuchPortException) |
Disconnects this port from all connections it is part of. More... | |
CChannelElement | buildChannelOutput (in string input_port, inout CConnPolicy policy) raises (CNoCorbaTransport,CNoSuchPortException) |
Use this to write to an input port with the given policy. More... | |
CChannelElement | buildChannelInput (in string output_port, inout CConnPolicy policy) raises (CNoCorbaTransport,CNoSuchPortException) |
Use this to read from an output port with the given policy. More... | |
boolean | createConnection (in string local_port, in CDataFlowInterface remote_ports, in string remote_port, inout CConnPolicy policy) raises (CNoSuchPortException) |
Connect the given named port to the given remote port. More... | |
boolean | removeConnection (in string local_port, in CDataFlowInterface remote_ports, in string remote_port) raises (CNoSuchPortException) |
Removes the specified connection created with createConnection. More... | |
boolean | createStream (in string local_port, inout CConnPolicy policy) raises (CNoSuchPortException) |
Create an out-of-band data stream with a given policy. More... | |
void | removeStream (in string local_port, in string stream_name) raises (CNoSuchPortException) |
Removes a stream added with createStream. More... | |
boolean | channelReady (in string input_port, in CChannelElement channel, in CConnPolicy cp) raises (CNoSuchPortException) |
Checks if the connection channel elements are ready for a given input port. More... | |
An Orocos Service which hosts operations, attributes and properties.
Definition at line 22 of file Service.idl.
|
inherited |
Definition at line 28 of file ConfigurationInterface.idl.
|
inherited |
Definition at line 128 of file OperationInterface.idl.
|
inherited |
Definition at line 122 of file DataFlow.idl.
|
inherited |
Definition at line 121 of file DataFlow.idl.
|
inherited |
Definition at line 27 of file ConfigurationInterface.idl.
typedef sequence<string> RTT::corba::CService::CProviderNames |
Definition at line 24 of file Service.idl.
|
inherited |
Assign a given property or attribute a stringified value.
|
inherited |
Return the result of an attribute or property as a text string.
|
inherited |
Use this to read from an output port with the given policy.
Some protocols may adjust the policy, or pass additional information into the policy, such as the name of the newly created connection.
|
inherited |
Use this to write to an input port with the given policy.
Some protocols may adjust the policy, or pass additional information into the policy, such as the name of the newly created connection.
The returned channel element will not be functional until channelReady() has been called for it
|
inherited |
Call an operation with a list of arguments.
This method will block until the operation completes and returns its result.
|
inherited |
Checks if the connection channel elements are ready for a given input port.
This is typically called by the createConnection setup logic to see if the input side agrees with the connection and can use it. For example, the input port can use this opportunity to check the
CNoSuchPortException | if input_port is not an input port or not present in this interface. |
|
inherited |
Checks if a given operation accepts the list of arguments.
If no exception is thrown, the arguments and operation name were valid.
|
inherited |
Connect the given named port to the given remote port.
Use this method to connect two Orocos data flow ports.
The local port needs to be the output, while the remote port is the input. In case you only want to write a port without using this function, use buildChannelOutput. For only reading a port, use buildChannelInput.
This method combines both buildChannelOutput() and buildChannelInput() and is generally better in setting up and checking a data flow connection between two ports than the separate methods.
This method will call the remote_ports interface back to orchestrate the connection building.
|
inherited |
Create an out-of-band data stream with a given policy.
You may specify a name_id in the policy object, or if left empty, a name will be chosen for you.
|
inherited |
Disconnects this port from all connections it is part of.
|
inherited |
Get a list of all arguments of a given operation.
|
inherited |
Returns the argument or return type name of call as known to the Orocos type system.
|
inherited |
Returns the number of arguments required in callOperation() and sendOperation() for a given operation.
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
Returns the number of arguments required in CSendHandle::collect() and CSendHandle::collectIfDone() for a given operation.
|
inherited |
Returns the argument type of collect as known to the Orocos type system.
|
inherited |
Returns the data type for the given port.
|
inherited |
Get a description of a given operation.
string RTT::corba::CService::getName | ( | ) |
Return the name of this service.
|
inherited |
Get a list of all operations.
|
inherited |
Returns the names of the ports of this component.
|
inherited |
Returns the names of the ports of this component.
|
inherited |
Returns the type of the given port.
|
inherited |
Get a property by name.
You can scope the name for entering sub-properties. For example 'controlparameters.gains.k' to retrieve nested property with name 'k'.
|
inherited |
|
inherited |
Return the type of the attribute or property.
|
inherited |
Return the type name of the expression as it is known to the Orocos Type System.
CProviderNames RTT::corba::CService::getProviderNames | ( | ) |
Get a list of all the child services this service offers.
|
inherited |
Get a result type of a given operation.
CService RTT::corba::CService::getService | ( | in string | name | ) |
Get a child service this service provides.
string RTT::corba::CService::getServiceDescription | ( | ) |
Return the description of this service.
|
inherited |
|
inherited |
boolean RTT::corba::CService::hasService | ( | in string | name | ) |
Has this service a child service with given name ?
|
inherited |
Returns true if the attribute can be changed.
|
inherited |
Check if the given port is already connected to something.
|
inherited |
|
inherited |
|
inherited |
Removes the specified connection created with createConnection.
|
inherited |
Removes a stream added with createStream.
local_port | The port to remove the stream from. |
stream_name | The name_id returned in the CConnPolicy object after the call to createStream. |
|
inherited |
Send an operation with a list of arguments.
This method will return immediately and return a CSendHandle.
|
inherited |
|
inherited |
Set a property by name.
You can scope the name for entering sub-properties. For example 'controlparameters.gains.k' to write nested property with name 'k'.