Classes | Public Member Functions | Private Attributes
OpenRTM_aist.SdoConfiguration.Configuration_impl Class Reference

Configuration implementation class. More...

List of all members.

Classes

class  config_id
 functor for ConfigurationSet More...
class  nv_name
 functor for NVList More...
class  org_id
 functor for Organization More...
class  service_id
 functor for ServiceProfile More...

Public Member Functions

def __init__
 class constructor
def activate_configuration_set
 [CORBA interface] Activate ConfigurationSet
def add_configuration_set
 [CORBA interface] Add ConfigurationSet
def add_organization
 [CORBA interface] Add Organization
def add_service_profile
 [CORBA interface] Set SDO's ServiceProfile
def get_active_configuration_set
 [CORBA interface] Get active ConfigurationSet
def get_configuration_parameter_value
 [CORBA interface] Getting value of configuration parameter
def get_configuration_parameter_values
 [CORBA interface] Getting value list of configuration parameter
def get_configuration_parameters
 [CORBA interface] Getting a list of configuration parameter
def get_configuration_set
 [CORBA interface] Getting a ConfigurationSet
def get_configuration_sets
 [CORBA interface] Getting list of ConfigurationSet
def getDeviceProfile
def getObjRef
def getOrganizations
def getServiceProfile
def getServiceProfiles
def getUUID
def remove_configuration_set
 [CORBA interface] Remove ConfigurationSet
def remove_organization
 [CORBA interface] Remove the reference of Organization
def remove_service_profile
 [CORBA interface] Remove ServiceProfile
def set_configuration_parameter
 [CORBA interface] Modify the parameter value
def set_configuration_set_values
 [CORBA interface] Set ConfigurationSet
def set_device_profile
 [CORBA interface] Set DeviceProfile of SDO

Private Attributes

 _config_mutex
 _configsets
 _deviceProfile
 _dprofile_mutex
 _objref
 _org_mutex
 _organizations
 _parameters
 _params_mutex
 _rtcout
 _sdoservice
 _serviceProfiles
 _sprofile_mutex

Detailed Description

Configuration implementation class.

Configuration interface provides operations to add or remove data specified in resource data model. These operations provide functions to change DeviceProfile, ServiceProfile, ConfigurationProfile, and Organization. This specification does not address access control or security aspects. Access to operations that modifies or removes profiles should be controlled depending upon the application.

Different configurations can be stored for simple and quick activation. Different predefined configurations are stored as different ConfigurationSets or configuration profile. A ConfigurationSet stores the value of all properties assigned for the particular configuration along with its unique id and description to identify and describe the configuration respectively. Operations in the configuration interface help manage these ConfigurationSets.

Since:
0.4.0

Definition at line 164 of file SdoConfiguration.py.


Constructor & Destructor Documentation

def OpenRTM_aist.SdoConfiguration.Configuration_impl.__init__ (   self,
  configAdmin,
  sdoServiceAdmin 
)

class constructor

Parameters:
self
configAdminConfigurationSetList
sdoServiceAdminSdoServiceAdmin

Configuration_impl(RTC::ConfigAdmin& configAdmin, RTC::SdoServiceAdmin& sdoServiceAdmin);

 \var self._deviceProfile SDO DeviceProfile with mutex lock

Definition at line 188 of file SdoConfiguration.py.


Member Function Documentation

[CORBA interface] Activate ConfigurationSet

This operation activates one of the stored ConfigurationSets in the ConfigurationProfile. This operation activates the specified stored ConfigurationSets. This means that the configuration properties of the SDO are changed as the values of these properties specified in the stored ConfigurationSet. In other words, values of the specified ConfigurationSet are now copied to the active configuration.

Parameters:
self
Identifierof ConfigurationSet to be activated.
Returns:
If the operation was successfully completed.
Exceptions:
SDONotExistsif the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_NOT_EXIST.)
InvalidParameterif the argument ("configID") is null or there is no configuration set with identifier specified by the argument.
NotAvailableThe target SDO is reachable but cannot respond.
InternalErrorThe target SDO cannot execute the operation completely due to some internal error.

Definition at line 1128 of file SdoConfiguration.py.

[CORBA interface] Add ConfigurationSet

This operation adds a ConfigurationSet to the ConfigurationProfile.

Parameters:
self
configuration_setThe ConfigurationSet that is added.
Returns:
If the operation was successfully completed.
Exceptions:
SDONotExistsif the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_NOT_EXIST.)
InvalidParameterIf the argument "configurationSet" is null, or if one of the attributes defining "configurationSet" is invalid, or if the specified identifier of the configuration set already exists.
NotAvailableThe target SDO is reachable but cannot respond.
InternalErrorThe target SDO cannot execute the operation completely due to some internal error.

Definition at line 1005 of file SdoConfiguration.py.

[CORBA interface] Add Organization

This operation adds reference of an Organization object.

Parameters:
self
orgOrganization to be added.
Returns:
If the operation was successfully completed.
Exceptions:
SDONotExistsif the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_NOT_EXIST.)
NotAvailableThe target SDO is reachable but cannot respond.
InvalidParameterThe argument "organization" is null.
InternalErrorThe target SDO cannot execute the operation completely due to some internal error.

Definition at line 377 of file SdoConfiguration.py.

[CORBA interface] Set SDO's ServiceProfile

This operation adds ServiceProfile to the target SDO that navigates this Configuration interface. If the id in argument ServiceProfile is null, new id is created and the ServiceProfile is stored. If the id is not null, the target SDO searches for ServiceProfile in it with the same id. It adds the ServiceProfile if not exist, or overwrites if exist.

Parameters:
self
sProfileServiceProfile to be added.
Returns:
If the operation was successfully completed.
Exceptions:
SDONotExistsif the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_NOT_EXIST.)
NotAvailableThe target SDO is reachable but cannot respond.
InvalidParameterThe argument "sProfile" is null.
InternalErrorThe target SDO cannot execute the operation completely due to some internal error.

Definition at line 327 of file SdoConfiguration.py.

[CORBA interface] Get active ConfigurationSet

This operation returns the current active ConfigurationSet of an SDO (i.e., if the current configuration of the SDO was set using predefined configuration set). ConfigurationSet cannot be considered active if the:

  • current configuration of the SDO was not set using any predefined ConfigurationSet, or
  • configuration of the SDO was changed after it has been active, or
  • ConfigurationSet that was used to configure the SDO was modified.

Empty ConfigurationSet is returned in these cases.

Parameters:
self
Returns:
The active ConfigurationSet.
Exceptions:
SDONotExistsif the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_NOT_EXIST.)
NotAvailableThe target SDO is reachable but cannot respond.
InternalErrorThe target SDO cannot execute the operation completely due to some internal error.

Definition at line 947 of file SdoConfiguration.py.

[CORBA interface] Getting value of configuration parameter

This operation returns a value of parameter that is specified by argument "name."

Parameters:
self
Nameof the parameter whose value is requested.
Returns:
The value of the specified parameter.
Exceptions:
SDONotExistsif the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_NOT_EXIST.)
InvalidParameterif the value of the argument "name" is empty String, or null, or if the parameter that is specified by argument "name" does not exist.
NotAvailableThe target SDO is reachable but cannot respond.
InternalErrorThe target SDO cannot execute the operation completely due to some internal error.

Definition at line 631 of file SdoConfiguration.py.

[CORBA interface] Getting value list of configuration parameter

This operation returns all configuration parameters and their values.

Parameters:
self
Returns:
List of all configuration parameters and their values.
Exceptions:
SDONotExistsif the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_NOT_EXIST.)
NotAvailableThe target SDO is reachable but cannot respond.
InternalErrorThe target SDO cannot execute the operation completely due to some internal error.

Definition at line 582 of file SdoConfiguration.py.

[CORBA interface] Getting a list of configuration parameter

This operation returns a list of Parameters. An empty list is returned if the SDO does not have any configurable parameter.

Parameters:
self
Returns:
The list with definitions of parameters characterizing the configuration.
Exceptions:
SDONotExistsif the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_NOT_EXIST.)
NotAvailableThe target SDO is reachable but cannot respond.
InternalErrorThe target SDO cannot execute the operation completely due to some internal error.

Definition at line 537 of file SdoConfiguration.py.

[CORBA interface] Getting a ConfigurationSet

This operation returns the ConfigurationSet specified by the parameter configurationSetID.

Parameters:
self
config_idIdentifier of ConfigurationSet requested.
Returns:
The configuration set specified by the parameter config_id.
Exceptions:
SDONotExistsif the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_NOT_EXIST.)
InvalidParameterIf the parameter 'config_id' is null or if there are no ConfigurationSets stored with such id.
NotAvailableThe target SDO is reachable but cannot respond.
InternalErrorThe target SDO cannot execute the operation completely due to some internal error.

Definition at line 787 of file SdoConfiguration.py.

[CORBA interface] Getting list of ConfigurationSet

This operation returns a list of ConfigurationSets that the ConfigurationProfile has. An empty list is returned if the SDO does not have any ConfigurationSets. This operation returns a list of all ConfigurationSets of the SDO. If no predefined ConfigurationSets exist, then empty list is returned.

Parameters:
self
Returns:
The list of stored configuration with their current values.
Exceptions:
SDONotExistsif the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_NOT_EXIST.)
NotAvailableThe target SDO is reachable but cannot respond.
InternalErrorThe target SDO cannot execute the operation completely due to some internal error.

Definition at line 727 of file SdoConfiguration.py.

Definition at line 1177 of file SdoConfiguration.py.

Definition at line 1159 of file SdoConfiguration.py.

Definition at line 1240 of file SdoConfiguration.py.

Definition at line 1216 of file SdoConfiguration.py.

Definition at line 1195 of file SdoConfiguration.py.

Definition at line 1258 of file SdoConfiguration.py.

[CORBA interface] Remove ConfigurationSet

This operation removes a ConfigurationSet from the ConfigurationProfile.

Parameters:
self
config_idThe id of ConfigurationSet which is removed.
Returns:
If the operation was successfully completed.
Exceptions:
SDONotExistsif the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_NOT_EXIST.)
InvalidParameterThe arguments "configurationSetID" is null, or if the object specified by the argument "configurationSetID" does not exist.
NotAvailableThe target SDO is reachable but cannot respond.
InternalErrorThe target SDO cannot execute the operation completely due to some internal error.

Definition at line 1062 of file SdoConfiguration.py.

[CORBA interface] Remove the reference of Organization

This operation removes the reference of an Organization object.

Parameters:
self
organization_idUnique id of the organization to be removed.
Returns:
If the operation was successfully completed.
Exceptions:
SDONotExistsif the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_NOT_EXIST.)
InvalidParameterThe argument "organizationID" is null, or the object which is specified by argument "organizationID" does not exist.
NotAvailableThe target SDO is reachable but cannot respond.
InternalErrorThe target SDO cannot execute the operation completely due to some internal error.

Definition at line 487 of file SdoConfiguration.py.

[CORBA interface] Remove ServiceProfile

This operation removes ServiceProfile object to the SDO that has this Configuration interface. The ServiceProfile object to be removed is specified by argument.

Parameters:
self
id_serviceID of a ServiceProfile to be removed.
Returns:
If the operation was successfully completed.
Exceptions:
SDONotExistsif the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_NOT_EXIST.)
InvalidParameterThe argument "sProfile" is null, or if the object that is specified by argument "sProfile" does not exist.
NotAvailableThe target SDO is reachable but cannot respond.
InternalErrorThe target SDO cannot execute the operation completely due to some internal error.

Definition at line 433 of file SdoConfiguration.py.

[CORBA interface] Modify the parameter value

This operation sets a parameter to a value that is specified by argument "value." The parameter to be modified is specified by argument " name."

Parameters:
self
nameThe name of parameter to be modified.
valueNew value of the specified parameter.
Returns:
If the operation was successfully completed.
Exceptions:
SDONotExistsif the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_NOT_EXIST.)
InvalidParameterif arguments ("name" and/or "value") is null, or if the parameter that is specified by the argument "name" does not exist.
NotAvailableThe target SDO is reachable but cannot respond.
InternalErrorThe target SDO cannot execute the operation completely due to some internal error.

Definition at line 684 of file SdoConfiguration.py.

[CORBA interface] Set ConfigurationSet

This operation modifies the specified ConfigurationSet of an SDO.

Parameters:
self
configuration_setConfigurationSet to be replaced.
Returns:
A flag indicating if the ConfigurationSet was modified successfully. "true" - The ConfigurationSet was modified successfully. "false" - The ConfigurationSet could not be modified successfully.
Exceptions:
InvalidParameterif the parameter 'configurationSetID' is null or if there is no ConfigurationSet stored with such id. This exception is also raised if one of the attributes defining ConfigurationSet is not valid.
SDONotExistsif the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_NOT_EXIST.)
NotAvailableThe target SDO is reachable but cannot respond.
InternalErrorThe target SDO cannot execute the operation completely due to some internal error.

Definition at line 861 of file SdoConfiguration.py.

[CORBA interface] Set DeviceProfile of SDO

This operation sets the DeviceProfile of an SDO. If the SDO does not have DeviceProfile, the operation will create a new DeviceProfile, otherwise it will replace the existing DeviceProfile.

Parameters:
self
dProfileThe device profile that is to be assigned to this SDO.
Returns:
If the operation was successfully completed.
Exceptions:
SDONotExistsif the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_NOT_EXIST.)
NotAvailableThe target SDO is reachable but cannot respond.
InvalidParameterThe argument "dProfile" is null.
InternalErrorThe target SDO cannot execute the operation completely due to some internal error.

Definition at line 266 of file SdoConfiguration.py.


Member Data Documentation

Definition at line 192 of file SdoConfiguration.py.

Definition at line 192 of file SdoConfiguration.py.

Definition at line 190 of file SdoConfiguration.py.

Definition at line 190 of file SdoConfiguration.py.

Definition at line 194 of file SdoConfiguration.py.

Definition at line 194 of file SdoConfiguration.py.

Definition at line 194 of file SdoConfiguration.py.

Definition at line 192 of file SdoConfiguration.py.

Definition at line 192 of file SdoConfiguration.py.

Definition at line 194 of file SdoConfiguration.py.

Definition at line 192 of file SdoConfiguration.py.

Definition at line 192 of file SdoConfiguration.py.

Definition at line 192 of file SdoConfiguration.py.


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


openrtm_aist_python
Author(s): Shinji Kurihara
autogenerated on Thu Aug 27 2015 14:17:30