| Previous | Table of Contents | Next |
//File: DAISAESourceCondition.idl #ifndef _DAIS_AESOURCE_CONDITION_IDL #define _DAIS_AESOURCE_CONDITION_IDL #pragma prefix
"omg.org" #include <DAISAECommon.idl>
module DAIS { module AlarmsAndEvents { module SourceCondition {
struct Id {
| ResourceID | source; | ||||
| ResourceID | condition_space; | ||||
| }; |
typedef sequence<Id>Ids;
struct Description {
Id source_condition;SourceConditionOpState source_condition_op_state;unsigned long active_condition;string ac_logic;unsigned long ac_severity;string ac_description;Quality dais_quality;DateTime last_acknowledge;DateTime condition_last_active;DateTime condition_space_last_active;DateTime condition_space_last_inactive;string acknowledger_name;string comment;PropertyValues property_values;
};typedef sequence< Description > Descriptions;
struct AcknowledgeSpec { Id source_condition; DateTime active_time; EventID cookie;
}; typedef sequence<AcknowledgeSpec>AcknowledgeSpecs;
interface Iterator { boolean next_n (
| in | unsigned long | n, | |||
| out | Descriptions | c_descriptions | |||
| ); |
void reset(); Iterator clone(); void destroy();
};
interface IHome
{ exception UnknownId {string reason;}; exception UnknownPropertyID {string reason;};
Description find ( in Id source_condition, in PropertyIDs properties
) raises (UnknownId, UnknownPropertyID);
Iterator find_each( in Ids source_conditions, in PropertyIDs properties
) raises (UnknownId, UnknownPropertyID);
Descriptions ack_condition ( #endif // _DAIS_AESOURCE_CONDITION_IDL Id
| in string | acknowledger_name, | ||||
| in string | comment, | ||||
| in AcknowledgeSpecs ack_spec | |||||
| ); | |||||
| }; | |||||
| };};}; |
A struct that identifies a source condition.
Member |
Description |
||||
| source | The ResourceID identifying the associated source. | ||||
| condition_space | The ResourceID identifying the associated condition space. |
Description
A struct describing the source condition.
| Member | Description | ||||
| id | The Id identifying the source condition. | ||||
| source_condition_op_state | The DAISSourceConditionOpState as described in Section 5.2.2, “Alarms and Events Common IDL Definitions,? on page 5-7. | ||||
| active_condition | The identification number of the currently active condition. | ||||
| ac_logic | The condition logic from the active condition. | ||||
| ac_severity | The severity from the active condition. | ||||
| ac_description | The description from the active condition. | ||||
| dais_quality | The quality is evaluated from the qualities from the properties used to evaluate the condition logic. | ||||
| last_acknowledge | The last time the condition was acknowledged. | ||||
| condition_last_active | Time for the latest condition transition. |
condition_space_last_activecondition_space_last_inactiveacknowledger_namecommentproperty_values |
|||||
| The last time when the condition space became active. After this time more condition transitions may occur. The condition_last_active will then be later than condition_space_last_active. | |||||
| The last time when the condition space became inactive; that is, no conditions are active. | |||||
| The name of the client making an acknowledge. | |||||
| A comment passed by the client making an acknowledge. | |||||
| A sequence of property values as selected by the Manager::select_returned_properties call. |
AcknowledgeSpec
A struct specifying an alarm to acknowledge.
| Member | Description | ||||
| source_condition | The Id identifying the source condition for which to acknowledge an alarm. | ||||
| active_time | The time when the alarm activated. | ||||
| cookie | A identification of the alarm. |
Iterator
A standard iterator. Refer to Section 3.1.6, “Iterator Methods IDL,? on page 3-10.
IHome
An object for browsing and accessing source conditions.
UnknownDAISSourceConditionID
An exception telling that the source condition identification was not recognized.
UnknownPropertyID
An exception telling that a property identification was not recognized.
find()
A method for getting the description of a source condition. The corresponding OPC method is IOPCEventServer::GetConditionState().
Parameter |
Description |
||||
| source_condition | A ResourceID identifying a source condition. | ||||
| return | The source condition description. |
find_each()
A method for getting the descriptions for a number of source conditions.
Parameter |
Description |
||||
| condition_spaces | A sequence identifying source conditions. | ||||
| return | A sequence of source condition descriptions. |
ack_condition()
A method to acknowledge a number of source condition alarms. The corresponding OPC method is IOPCEventServer::AckCondition().
| Parameter | Description | ||||
| acknowledger_name | The name of the client making the acknowledge. | ||||
| comment | A comment to be added to source condition and the event. | ||||
| ack_spec | A sequence specifying the alarms to acknowledge. | ||||
| return | A sequence containing descriptions for the acknowledged source conditions. |
Inspect a specific source condition
Figure 5-16 Inspect a specific source condition interaction
Acknowledge alarm
Figure 5-17 Acknowledge alarm interaction