OpenRTM_aist.SdoConfiguration.Configuration_impl Class Reference

Configuration implementation class. More...

Inheritance diagram for OpenRTM_aist.SdoConfiguration.Configuration_impl:

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__ (self, configAdmin, sdoServiceAdmin)
	class constructor More...
def	set_device_profile (self, dProfile)
	[CORBA interface] Set DeviceProfile of SDO More...
def	add_service_profile (self, sProfile)
	[CORBA interface] Set SDO's ServiceProfile More...
def	add_organization (self, org)
	[CORBA interface] Add Organization More...
def	remove_service_profile (self, id_)
	[CORBA interface] Remove ServiceProfile More...
def	remove_organization (self, organization_id)
	[CORBA interface] Remove the reference of Organization More...
def	get_configuration_parameters (self)
	[CORBA interface] Getting a list of configuration parameter More...
def	get_configuration_parameter_values (self)
	[CORBA interface] Getting value list of configuration parameter More...
def	get_configuration_parameter_value (self, name)
	[CORBA interface] Getting value of configuration parameter More...
def	set_configuration_parameter (self, name, value)
	[CORBA interface] Modify the parameter value More...
def	get_configuration_sets (self)
	[CORBA interface] Getting list of ConfigurationSet More...
def	get_configuration_set (self, config_id)
	[CORBA interface] Getting a ConfigurationSet More...
def	set_configuration_set_values (self, configuration_set)
	[CORBA interface] Set ConfigurationSet More...
def	get_active_configuration_set (self)
	[CORBA interface] Get active ConfigurationSet More...
def	add_configuration_set (self, configuration_set)
	[CORBA interface] Add ConfigurationSet More...
def	remove_configuration_set (self, config_id)
	[CORBA interface] Remove ConfigurationSet More...
def	activate_configuration_set (self, config_id)
	[CORBA interface] Activate ConfigurationSet More...

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

Constructor & Destructor Documentation

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

class constructor

Parameters

self
configAdmin	ConfigurationSetList
sdoServiceAdmin	SdoServiceAdmin

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

 \var self._deviceProfile SDO DeviceProfile with mutex lock

Member Function Documentation

def OpenRTM_aist.SdoConfiguration.Configuration_impl.activate_configuration_set	(		self,
			config_id
	)

[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
Identifier	of ConfigurationSet to be activated.

Returns

If the operation was successfully completed.

Exceptions

SDONotExists	if the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_NOT_EXIST.)
InvalidParameter	if the argument ("configID") is null or there is no configuration set with identifier specified by the argument.
NotAvailable	The target SDO is reachable but cannot respond.
InternalError	The target SDO cannot execute the operation completely due to some internal error.

def OpenRTM_aist.SdoConfiguration.Configuration_impl.add_configuration_set	(		self,
			configuration_set
	)

[CORBA interface] Add ConfigurationSet

This operation adds a ConfigurationSet to the ConfigurationProfile.

Parameters

self
configuration_set	The ConfigurationSet that is added.

Returns

If the operation was successfully completed.

Exceptions

SDONotExists	if the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_NOT_EXIST.)
InvalidParameter	If 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.
NotAvailable	The target SDO is reachable but cannot respond.
InternalError	The target SDO cannot execute the operation completely due to some internal error.

def OpenRTM_aist.SdoConfiguration.Configuration_impl.add_organization	(		self,
			org
	)

[CORBA interface] Add Organization

This operation adds reference of an Organization object.

Parameters

self
org	Organization to be added.

Returns

If the operation was successfully completed.

Exceptions

SDONotExists	if the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_NOT_EXIST.)
NotAvailable	The target SDO is reachable but cannot respond.
InvalidParameter	The argument "organization" is null.
InternalError	The target SDO cannot execute the operation completely due to some internal error.

def OpenRTM_aist.SdoConfiguration.Configuration_impl.add_service_profile	(		self,
			sProfile
	)

[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
sProfile	ServiceProfile to be added.

Returns

If the operation was successfully completed.

Exceptions

SDONotExists	if the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_NOT_EXIST.)
NotAvailable	The target SDO is reachable but cannot respond.
InvalidParameter	The argument "sProfile" is null.
InternalError	The target SDO cannot execute the operation completely due to some internal error.

def OpenRTM_aist.SdoConfiguration.Configuration_impl.get_active_configuration_set

(

self

)

[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

SDONotExists	if the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_NOT_EXIST.)
NotAvailable	The target SDO is reachable but cannot respond.
InternalError	The target SDO cannot execute the operation completely due to some internal error.

def OpenRTM_aist.SdoConfiguration.Configuration_impl.get_configuration_parameter_value	(		self,
			name
	)

[CORBA interface] Getting value of configuration parameter

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

Parameters

self
Name	of the parameter whose value is requested.

Returns

The value of the specified parameter.

Exceptions

SDONotExists	if the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_NOT_EXIST.)
InvalidParameter	if the value of the argument "name" is empty String, or null, or if the parameter that is specified by argument "name" does not exist.
NotAvailable	The target SDO is reachable but cannot respond.
InternalError	The target SDO cannot execute the operation completely due to some internal error.

def OpenRTM_aist.SdoConfiguration.Configuration_impl.get_configuration_parameter_values

(

self

)

[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

SDONotExists	if the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_NOT_EXIST.)
NotAvailable	The target SDO is reachable but cannot respond.
InternalError	The target SDO cannot execute the operation completely due to some internal error.

def OpenRTM_aist.SdoConfiguration.Configuration_impl.get_configuration_parameters

(

self

)

[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

SDONotExists	if the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_NOT_EXIST.)
NotAvailable	The target SDO is reachable but cannot respond.
InternalError	The target SDO cannot execute the operation completely due to some internal error.

def OpenRTM_aist.SdoConfiguration.Configuration_impl.get_configuration_set	(		self,
			config_id
	)

[CORBA interface] Getting a ConfigurationSet

This operation returns the ConfigurationSet specified by the parameter configurationSetID.

Parameters

self
config_id	Identifier of ConfigurationSet requested.

Returns

The configuration set specified by the parameter config_id.

Exceptions

SDONotExists	if the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_NOT_EXIST.)
InvalidParameter	If the parameter 'config_id' is null or if there are no ConfigurationSets stored with such id.
NotAvailable	The target SDO is reachable but cannot respond.
InternalError	The target SDO cannot execute the operation completely due to some internal error.

def OpenRTM_aist.SdoConfiguration.Configuration_impl.get_configuration_sets

(

self

)

[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

SDONotExists	if the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_NOT_EXIST.)
NotAvailable	The target SDO is reachable but cannot respond.
InternalError	The target SDO cannot execute the operation completely due to some internal error.

def OpenRTM_aist.SdoConfiguration.Configuration_impl.remove_configuration_set	(		self,
			config_id
	)

[CORBA interface] Remove ConfigurationSet

This operation removes a ConfigurationSet from the ConfigurationProfile.

Parameters

self
config_id	The id of ConfigurationSet which is removed.

Returns

If the operation was successfully completed.

Exceptions

SDONotExists	if the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_NOT_EXIST.)
InvalidParameter	The arguments "configurationSetID" is null, or if the object specified by the argument "configurationSetID" does not exist.
NotAvailable	The target SDO is reachable but cannot respond.
InternalError	The target SDO cannot execute the operation completely due to some internal error.

def OpenRTM_aist.SdoConfiguration.Configuration_impl.remove_organization	(		self,
			organization_id
	)

[CORBA interface] Remove the reference of Organization

This operation removes the reference of an Organization object.

Parameters

self
organization_id	Unique id of the organization to be removed.

Returns

If the operation was successfully completed.

Exceptions

SDONotExists	if the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_NOT_EXIST.)
InvalidParameter	The argument "organizationID" is null, or the object which is specified by argument "organizationID" does not exist.
NotAvailable	The target SDO is reachable but cannot respond.
InternalError	The target SDO cannot execute the operation completely due to some internal error.

def OpenRTM_aist.SdoConfiguration.Configuration_impl.remove_service_profile	(		self,
			id_
	)

[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

SDONotExists	if the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_NOT_EXIST.)
InvalidParameter	The argument "sProfile" is null, or if the object that is specified by argument "sProfile" does not exist.
NotAvailable	The target SDO is reachable but cannot respond.
InternalError	The target SDO cannot execute the operation completely due to some internal error.

def OpenRTM_aist.SdoConfiguration.Configuration_impl.set_configuration_parameter	(		self,
			name,
			value
	)

[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
name	The name of parameter to be modified.
value	New value of the specified parameter.

Returns

If the operation was successfully completed.

Exceptions

SDONotExists	if the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_NOT_EXIST.)
InvalidParameter	if arguments ("name" and/or "value") is null, or if the parameter that is specified by the argument "name" does not exist.
NotAvailable	The target SDO is reachable but cannot respond.
InternalError	The target SDO cannot execute the operation completely due to some internal error.

def OpenRTM_aist.SdoConfiguration.Configuration_impl.set_configuration_set_values	(		self,
			configuration_set
	)

[CORBA interface] Set ConfigurationSet

This operation modifies the specified ConfigurationSet of an SDO.

Parameters

self
configuration_set	ConfigurationSet 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

InvalidParameter	if 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.
SDONotExists	if the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_NOT_EXIST.)
NotAvailable	The target SDO is reachable but cannot respond.
InternalError	The target SDO cannot execute the operation completely due to some internal error.

def OpenRTM_aist.SdoConfiguration.Configuration_impl.set_device_profile	(		self,
			dProfile
	)

[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
dProfile	The device profile that is to be assigned to this SDO.

Returns

If the operation was successfully completed.

Exceptions

SDONotExists	if the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_NOT_EXIST.)
NotAvailable	The target SDO is reachable but cannot respond.
InvalidParameter	The argument "dProfile" is null.
InternalError	The target SDO cannot execute the operation completely due to some internal error.

---

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

• /home/openrtm/git-src/OpenRTM-aist-Python/OpenRTM_aist/SdoConfiguration.py