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

Exposes both attributes and properties of a service. More...

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

Inheritance diagram for RTT::corba::CConfigurationInterface:
RTT::corba::CService

Classes

struct  CProperty
 

Public Types

typedef sequence< CPropertyCPropertyNames
 
typedef sequence< string > CAttributeNames
 

Public Member Functions

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...
 

Detailed Description

Exposes both attributes and properties of a service.

Definition at line 20 of file ConfigurationInterface.idl.

Member Typedef Documentation

Definition at line 28 of file ConfigurationInterface.idl.

Definition at line 27 of file ConfigurationInterface.idl.

Member Function Documentation

boolean RTT::corba::CConfigurationInterface::attributeFromString ( in string  name,
in string  value 
)

Assign a given property or attribute a stringified value.

Returns
true if the assignment could be done.
string RTT::corba::CConfigurationInterface::attributeToString ( in string  name)

Return the result of an attribute or property as a text string.

any RTT::corba::CConfigurationInterface::getAttribute ( in string  name)
raises (StdException
)
CAttributeNames RTT::corba::CConfigurationInterface::getAttributeList ( )
string RTT::corba::CConfigurationInterface::getAttributeType ( in string  name)
string RTT::corba::CConfigurationInterface::getAttributeTypeName ( in string  name)
any RTT::corba::CConfigurationInterface::getProperty ( in string  name)
raises (StdException
)

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'.

CPropertyNames RTT::corba::CConfigurationInterface::getPropertyList ( )
string RTT::corba::CConfigurationInterface::getPropertyType ( in string  name)

Return the type of the attribute or property.

string RTT::corba::CConfigurationInterface::getPropertyTypeName ( in string  name)

Return the type name of the expression as it is known to the Orocos Type System.

boolean RTT::corba::CConfigurationInterface::hasAttribute ( in string  name)
boolean RTT::corba::CConfigurationInterface::hasProperty ( in string  name)
boolean RTT::corba::CConfigurationInterface::isAttributeAssignable ( in string  name)

Returns true if the attribute can be changed.

boolean RTT::corba::CConfigurationInterface::propertyFromString ( in string  name,
in string  value 
)
string RTT::corba::CConfigurationInterface::propertyToString ( in string  name)
boolean RTT::corba::CConfigurationInterface::setAttribute ( in string  name,
in any  value 
)
boolean RTT::corba::CConfigurationInterface::setProperty ( in string  name,
in any  value 
)

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'.


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