import "baci.idl";
Public Member Functions | |
| any | get_characteristic_by_name (in string name) raises (NoSuchCharacteristic) |
| stringSeq | find_characteristic (in string reg_exp) |
| CosPropertyService::PropertySet | get_all_characteristics () |
Detailed Description
The main BACI components, such as CharacteristicComponent and Property have characteristics:
A characteristic is a data item that is considered static. It is represented by a name/value pair, where the value parameter is typed. A characteristic is accessed either through a single accessor method (a CORBA readonly attribute) which returns its value, or through general BACI functionality that encapsulates names and values into CORBA Property Service PropertySet interface, or through generic methods declared by components and properties. Some characteristics can be state-dependent, which means that their value can change depending on the condition the owner of the characteristic is in. This does not break the notion of a static item, since every possible value is prescribed in advance and is, by itself, considered static. The state only determines which of the values should be used at the moment. It is possible for the user to obtain the set of all possible values of a state-dependent characteristic through this interface.
Member Function Documentation
| stringSeq ACS::CharacteristicModel::find_characteristic | ( | in string | reg_exp | ) |
Returns a sequence of characteristic names that match the regular expressions reg_exp. It returns a sequence of length 0 if no match is found.
- Parameters:
-
reg_exp A Windows style regular expression (e.g., "*").
- Returns:
- A sequence of strings where each string is the name of a characteristic (to be passed as the parameter to the get_characteristic_by_name method) which matched the regular expression passed in as the parameter to this method. 3AC90A240301
| CosPropertyService::PropertySet ACS::CharacteristicModel::get_all_characteristics | ( | ) |
Returns all of the derived interfaces characteristics conveniently packaged within a PropertySet interface.
- Returns:
- PropertySet Provides support for defining and modifying properties, getting properties and their names and deleting properties.
| any ACS::CharacteristicModel::get_characteristic_by_name | ( | in string | name | ) | raises (NoSuchCharacteristic) |
Generic access to characteristics, even those that are not declared in the IDL interfaces.
- Parameters:
-
name The name of the characteristic to be accessed.
- Returns:
- The characteristic's value encoded inside a CORBA any.
- Exceptions:
-
NoSuchCharacteristic Thrown if the derived interface does not implement the characteristic. 3AC90A2402FF
The documentation for this interface was generated from the following file:
