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

SDOPackage::Configuration_impl Class Reference

Configuration implementation class. More...

#include <SdoConfiguration.h>

List of all members.

Public Member Functions

 Configuration_impl (RTC::ConfigAdmin &configAdmin)
virtual ~Configuration_impl ()
virtual CORBA::Boolean set_device_profile (const DeviceProfile &dProfile) throw (InvalidParameter, NotAvailable, InternalError)
 [CORBA interface] Set DeviceProfile of SDO
virtual CORBA::Boolean set_service_profile (const ServiceProfile &sProfile) throw (InvalidParameter, NotAvailable, InternalError)
 [CORBA interface] Set SDO's ServiceProfile
virtual CORBA::Boolean add_organization (Organization_ptr org) throw (InvalidParameter, NotAvailable, InternalError)
 [CORBA interface] Add Organization
virtual CORBA::Boolean remove_service_profile (const char *id) throw (InvalidParameter, NotAvailable, InternalError)
 [CORBA interface] Remove ServiceProfile
virtual CORBA::Boolean remove_organization (const char *organization_id) throw (InvalidParameter, NotAvailable, InternalError)
 [CORBA interface] Remove the reference of Organization
virtual ParameterList * get_configuration_parameters () throw (NotAvailable, InternalError)
 [CORBA interface] Getting a list of configuration parameter
virtual NVList * get_configuration_parameter_values () throw (NotAvailable, InternalError)
 [CORBA interface] Getting value list of configuration parameter
virtual CORBA::Any * get_configuration_parameter_value (const char *name) throw (InvalidParameter, NotAvailable, InternalError)
 [CORBA interface] Getting value of configuration parameter
virtual CORBA::Boolean set_configuration_parameter (const char *name, const CORBA::Any &value) throw (InvalidParameter, NotAvailable, InternalError)
 [CORBA interface] Modify the parameter value
virtual ConfigurationSetList * get_configuration_sets () throw (NotAvailable, InternalError)
 [CORBA interface] Getting list of ConfigurationSet
virtual ConfigurationSet * get_configuration_set (const char *config_id) throw (NotAvailable, InternalError)
 [CORBA interface] Getting a ConfigurationSet
virtual CORBA::Boolean set_configuration_set_values (const char *config_id, const ConfigurationSet &configuration_set) throw (InvalidParameter, NotAvailable, InternalError)
 [CORBA interface] Set ConfigurationSet
virtual ConfigurationSet * get_active_configuration_set () throw (NotAvailable, InternalError)
 [CORBA interface] Get active ConfigurationSet
virtual CORBA::Boolean add_configuration_set (const ConfigurationSet &configuration_set) throw (InvalidParameter, NotAvailable, InternalError)
 [CORBA interface] Add ConfigurationSet
virtual CORBA::Boolean remove_configuration_set (const char *config_id) throw (InvalidParameter, NotAvailable, InternalError)
 [CORBA interface] Remove ConfigurationSet
virtual CORBA::Boolean activate_configuration_set (const char *config_id) throw (InvalidParameter, NotAvailable, InternalError)
 [CORBA interface] Activate ConfigurationSet
Configuration_ptr getObjRef ()
const DeviceProfile getDeviceProfile ()
const ServiceProfileList getServiceProfiles ()
const ServiceProfile getServiceProfile (const char *id)
const OrganizationList getOrganizations ()

Protected Types

typedef ACE_Guard< ACE_Thread_Mutex > Guard

Protected Member Functions

const std::string getUUID () const

Protected Attributes

Configuration_var m_objref
DeviceProfile m_deviceProfile
 SDO DeviceProfile with mutex lock.
ACE_Thread_Mutex m_dprofile_mutex
ServiceProfileList m_serviceProfiles
 SDO ServiceProfileList.
ACE_Thread_Mutex m_sprofile_mutex
ParameterList m_parameters
 SDO ParameterList.
ACE_Thread_Mutex m_params_mutex
RTC::ConfigAdmin & m_configsets
 SDO ConfigurationSetList.
ACE_Thread_Mutex m_config_mutex
OrganizationList m_organizations
 SDO OrganizationList.
ACE_Thread_Mutex m_org_mutex

Classes

struct  config_id
struct  nv_name
 Active ConfigurationSet id. More...
struct  org_id
struct  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 Typedef Documentation

typedef ACE_Guard<ACE_Thread_Mutex> SDOPackage::Configuration_impl::Guard [protected]
 


Constructor & Destructor Documentation

SDOPackage::Configuration_impl::Configuration_impl RTC::ConfigAdmin &  configAdmin  ) 
 

virtual SDOPackage::Configuration_impl::~Configuration_impl  )  [virtual]
 


Member Function Documentation

virtual CORBA::Boolean SDOPackage::Configuration_impl::activate_configuration_set const char *  config_id  )  throw (InvalidParameter, NotAvailable, InternalError) [virtual]
 

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

virtual CORBA::Boolean SDOPackage::Configuration_impl::add_configuration_set const ConfigurationSet &  configuration_set  )  throw (InvalidParameter, NotAvailable, InternalError) [virtual]
 

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

virtual CORBA::Boolean SDOPackage::Configuration_impl::add_organization Organization_ptr  org  )  throw (InvalidParameter, NotAvailable, InternalError) [virtual]
 

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

virtual ConfigurationSet* SDOPackage::Configuration_impl::get_active_configuration_set  )  throw (NotAvailable, InternalError) [virtual]
 

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

virtual CORBA::Any* SDOPackage::Configuration_impl::get_configuration_parameter_value const char *  name  )  throw (InvalidParameter, NotAvailable, InternalError) [virtual]
 

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

virtual NVList* SDOPackage::Configuration_impl::get_configuration_parameter_values  )  throw (NotAvailable, InternalError) [virtual]
 

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

virtual ParameterList* SDOPackage::Configuration_impl::get_configuration_parameters  )  throw (NotAvailable, InternalError) [virtual]
 

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

virtual ConfigurationSet* SDOPackage::Configuration_impl::get_configuration_set const char *  config_id  )  throw (NotAvailable, InternalError) [virtual]
 

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

virtual ConfigurationSetList* SDOPackage::Configuration_impl::get_configuration_sets  )  throw (NotAvailable, InternalError) [virtual]
 

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

const DeviceProfile SDOPackage::Configuration_impl::getDeviceProfile  ) 
 

Configuration_ptr SDOPackage::Configuration_impl::getObjRef  ) 
 

const OrganizationList SDOPackage::Configuration_impl::getOrganizations  ) 
 

const ServiceProfile SDOPackage::Configuration_impl::getServiceProfile const char *  id  ) 
 

const ServiceProfileList SDOPackage::Configuration_impl::getServiceProfiles  ) 
 

const std::string SDOPackage::Configuration_impl::getUUID  )  const [protected]
 

virtual CORBA::Boolean SDOPackage::Configuration_impl::remove_configuration_set const char *  config_id  )  throw (InvalidParameter, NotAvailable, InternalError) [virtual]
 

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

virtual CORBA::Boolean SDOPackage::Configuration_impl::remove_organization const char *  organization_id  )  throw (InvalidParameter, NotAvailable, InternalError) [virtual]
 

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

virtual CORBA::Boolean SDOPackage::Configuration_impl::remove_service_profile const char *  id  )  throw (InvalidParameter, NotAvailable, InternalError) [virtual]
 

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

virtual CORBA::Boolean SDOPackage::Configuration_impl::set_configuration_parameter const char *  name,
const CORBA::Any &  value
throw (InvalidParameter, NotAvailable, InternalError) [virtual]
 

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

virtual CORBA::Boolean SDOPackage::Configuration_impl::set_configuration_set_values const char *  config_id,
const ConfigurationSet &  configuration_set
throw (InvalidParameter, NotAvailable, InternalError) [virtual]
 

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

virtual CORBA::Boolean SDOPackage::Configuration_impl::set_device_profile const DeviceProfile &  dProfile  )  throw (InvalidParameter, NotAvailable, InternalError) [virtual]
 

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

virtual CORBA::Boolean SDOPackage::Configuration_impl::set_service_profile const ServiceProfile &  sProfile  )  throw (InvalidParameter, NotAvailable, InternalError) [virtual]
 

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


Member Data Documentation

ACE_Thread_Mutex SDOPackage::Configuration_impl::m_config_mutex [protected]
 

RTC::ConfigAdmin& SDOPackage::Configuration_impl::m_configsets [protected]
 

SDO ConfigurationSetList.

DeviceProfile SDOPackage::Configuration_impl::m_deviceProfile [protected]
 

SDO DeviceProfile with mutex lock.

ACE_Thread_Mutex SDOPackage::Configuration_impl::m_dprofile_mutex [protected]
 

Configuration_var SDOPackage::Configuration_impl::m_objref [protected]
 

ACE_Thread_Mutex SDOPackage::Configuration_impl::m_org_mutex [protected]
 

OrganizationList SDOPackage::Configuration_impl::m_organizations [protected]
 

SDO OrganizationList.

ParameterList SDOPackage::Configuration_impl::m_parameters [protected]
 

SDO ParameterList.

ACE_Thread_Mutex SDOPackage::Configuration_impl::m_params_mutex [protected]
 

ServiceProfileList SDOPackage::Configuration_impl::m_serviceProfiles [protected]
 

SDO ServiceProfileList.

ACE_Thread_Mutex SDOPackage::Configuration_impl::m_sprofile_mutex [protected]
 


The documentation for this class was generated from the following file:
Generated on Fri Oct 5 05:16:07 2007 for OpenRTM by  doxygen 1.4.1