Main Page | Namespace List | Class Hierarchy | Class List | File List | Class Members | File Members

Configuration_impl Class Reference

Configuration implementation class. More...

List of all members.

Public Member Functions

 __init__ (configsets)
 set_device_profile (dProfile)
 [CORBA interface] Set DeviceProfile of SDO
 set_service_profile (sProfile)
 [CORBA interface] Set SDO's ServiceProfile
 add_organization (org)
 [CORBA interface] Add Organization
 remove_service_profile (id_)
 [CORBA interface] Remove ServiceProfile
 remove_organization (organization_id)
 [CORBA interface] Remove the reference of Organization
 get_configuration_parameters ()
 [CORBA interface] Getting a list of configuration parameter
 get_configuration_parameter_values ()
 [CORBA interface] Getting value list of configuration parameter
 get_configuration_parameter_value (name)
 [CORBA interface] Getting value of configuration parameter
 set_configuration_parameter (name, value)
 [CORBA interface] Modify the parameter value
 get_configuration_sets ()
 [CORBA interface] Getting list of ConfigurationSet
 get_configuration_set (config_id)
 [CORBA interface] Getting a ConfigurationSet
 set_configuration_set_values (config_id, configuration_set)
 [CORBA interface] Set ConfigurationSet
 get_active_configuration_set ()
 [CORBA interface] Get active ConfigurationSet
 add_configuration_set (configuration_set)
 [CORBA interface] Add ConfigurationSet
 remove_configuration_set (config_id)
 [CORBA interface] Remove ConfigurationSet
 activate_configuration_set (config_id)
 [CORBA interface] Activate ConfigurationSet
 getObjRef ()
 getDeviceProfile ()
 getServiceProfiles ()
 getServiceProfile (id)
 getOrganizations ()
 getUUID ()

Classes

class  config_id
class  nv_name
 Active ConfigurationSet id. More...
class  org_id
class  service_id


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.


Member Function Documentation

Configuration_impl::__init__ configsets   ) 
 

Configuration_impl::activate_configuration_set 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:
Identifier of ConfigurationSet to be activated.
Returns:
If the operation was successfully completed.
Exceptions:
SDONotExists The target SDO does 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.

Configuration_impl::add_configuration_set configuration_set   ) 
 

[CORBA interface] Add ConfigurationSet

This operation adds a ConfigurationSet to the ConfigurationProfile.

Parameters:
configuration_set The ConfigurationSet that is added.
Returns:
If the operation was successfully completed.
Exceptions:
SDONotExists The target SDO does 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.

Configuration_impl::add_organization org   ) 
 

[CORBA interface] Add Organization

This operation adds reference of an Organization object.

Parameters:
org Organization to be added.
Returns:
If the operation was successfully completed.
Exceptions:
SDONotExists The target SDO does 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.

Configuration_impl::get_active_configuration_set  ) 
 

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

Returns:
The active ConfigurationSet.
Exceptions:
SDONotExists The target SDO 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.

Configuration_impl::get_configuration_parameter_value name   ) 
 

[CORBA interface] Getting value of configuration parameter

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

Parameters:
Name of the parameter whose value is requested.
Returns:
The value of the specified parameter.
Exceptions:
SDONotExists The target SDO 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.

Configuration_impl::get_configuration_parameter_values  ) 
 

[CORBA interface] Getting value list of configuration parameter

This operation returns all configuration parameters and their values.

Returns:
List of all configuration parameters and their values.
Exceptions:
SDONotExists The target SDO 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.

Configuration_impl::get_configuration_parameters  ) 
 

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

Returns:
The list with definitions of parameters characterizing the configuration.
Exceptions:
SDONotExists The target SDO 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.

Configuration_impl::get_configuration_set config_id   ) 
 

[CORBA interface] Getting a ConfigurationSet

This operation returns the ConfigurationSet specified by the parameter configurationSetID.

Parameters:
config_id Identifier of ConfigurationSet requested.
Returns:
The configuration set specified by the parameter config_id.
Exceptions:
SDONotExists The target SDO 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.

Configuration_impl::get_configuration_sets  ) 
 

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

Returns:
The list of stored configuration with their current values.
Exceptions:
SDONotExists The target SDO 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.

Configuration_impl::getDeviceProfile  ) 
 

Configuration_impl::getObjRef  ) 
 

Configuration_impl::getOrganizations  ) 
 

Configuration_impl::getServiceProfile id   ) 
 

Configuration_impl::getServiceProfiles  ) 
 

Configuration_impl::getUUID  ) 
 

Configuration_impl::remove_configuration_set config_id   ) 
 

[CORBA interface] Remove ConfigurationSet

This operation removes a ConfigurationSet from the ConfigurationProfile.

Parameters:
config_id The id of ConfigurationSet which is removed.
Returns:
If the operation was successfully completed.
Exceptions:
SDONotExists The target SDO does 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.

Configuration_impl::remove_organization organization_id   ) 
 

[CORBA interface] Remove the reference of Organization

This operation removes the reference of an Organization object.

Parameters:
organization_id Unique id of the organization to be removed.
Returns:
If the operation was successfully completed.
Exceptions:
SDONotExists The target SDO does 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.

Configuration_impl::remove_service_profile 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:
id serviceID of a ServiceProfile to be removed.
Returns:
If the operation was successfully completed.
Exceptions:
SDONotExists The target SDO does 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.

Configuration_impl::set_configuration_parameter 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:
name The name of parameter to be modified.
value New value of the specified parameter.
Returns:
If the operation was successfully completed.
Exceptions:
SDONotExists The target SDO does 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.

Configuration_impl::set_configuration_set_values config_id  ,
configuration_set 
 

[CORBA interface] Set ConfigurationSet

This operation modifies the specified ConfigurationSet of an SDO.

※ パラメータの数が spec と IDL で異なる!!!

Parameters:
configu_id The ID of ConfigurationSet to be modified.
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 The target SDO 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.

Configuration_impl::set_device_profile 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:
dProfile The device profile that is to be assigned to this SDO.
Returns:
If the operation was successfully completed.
Exceptions:
SDONotExists The target SDO does 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.

Configuration_impl::set_service_profile 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:
sProfile ServiceProfile to be added.
Returns:
If the operation was successfully completed.
Exceptions:
SDONotExists The target SDO does 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.


The documentation for this class was generated from the following file:
Generated on Mon Oct 29 15:51:43 2007 for OpenRTM by  doxygen 1.4.3