Previous Table of Contents Next


5.2.2.1 IDL


   // File: DAISAECommon.idl #ifndef _DAIS_AECOMMON_IDL #define _DAIS_AECOMMON_IDL #pragma prefix "omg.org" #include <DAISCommon.idl>

   module DAIS { module AlarmsAndEvents {

   typedef ResourceID EventID;

   struct ResourceError

   { Error err; ResourceID id;

   string reason; }; typedef sequence<ResourceError> ResourceErrors;

   // error codesconst Error RES_ERROR_DAISOK= 0;const Error RES_ERROR_UNKOWN_RESOURCE= 1;

   typedef unsigned longSourceConditionOpState;const SourceConditionOpStateCONDITION_ENABLED= 0x0001;const SourceConditionOpStateCONDITION_ACTIVE= 0x0002;const SourceConditionOpStateCONDITION_ACKED= 0x0004;

   typedef unsigned short EventFormat;const EventFormat OPC_SIMPLE_EVENT = 0x0001;const EventFormat OPC_TRACKING_EVENT = 0x0002;const EventFormat OPC_CONDITION_EVENT= 0x0004;const EventFormat OPC_ALL_EVENTS = 0x0007;};};#endif // _DAIS_AECOMMON_IDL

   EventID

   A ResourceID uniquely identifying an event notification.

   ResourceError

   A struct for reporting of resource related errors.

Member

Description

err An error code as described below.
id The identification of the resource.
reason An additional text explaining the error.

   ResourceErrors

   ResourceErrors is a sequence containing errors. If no errors are present, no entry shall be included in the sequence rather than including a large number of no errors. An empty sequence means no errors.

   Error

   The error codes for ResourceError.

Member

Description

RES_ERROR_DAISOK No error.
RES_ERROR_UNKOWN_RESOURCE The resource was not found.

   SourceConditionOpState

   Flag word holding for the operational state of a SourceCondition. The definitions of the state variable in the flag word are listed below.

Flag Description
CONDITION_ENABLED The Condition is enabled and supervision is active.
CONDITION_ACTIVE The Condition is active; that is, the supervision has determined that a fault has activated the condition.
CONDITION_ACKED The Condition alarm has been acknowledged.

   The combinations of the state variables result in eight states. The valid SourceCondition operational states are listed below.

State Description
Disabled Not supervised by server.
Enabled, Inactive, Acked Supervised by server, no fault detected and all alarms are acknowledged.
Enabled, Inactive, Unacked Supervised by server, no fault detected and unacknowledged alarms exist.
Enabled, Active, Unacked Supervised by server, a fault is detected and unacknowledged alarms exist.
Enabled, Active, Acked Supervised by server, a fault is persistent and all alarms are acknowledged.

   When enabled the state {Enabled, Inactive, Acked} is entered and from there the supervision will generate the appropriate state depending on the result of the supervision. Each state change results in sending an alarm and event notification. All notifications contain the state.

   EventFormat

   This constant tells the format of an event.

Member Description
OPC_SIMPLE_EVENT The event is a simple event.
OPC_TRACKING_EVENT The event is a tracking event.
OPC_CONDITION_EVENT The event is a condition event.
OPC_ALL_EVENTS This constant value is used to ask for all event formats in a subscription set up.