Previous Table of Contents Next


5.2.7.2 IDL


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

   module DAIS {module AlarmsAndEvents {module ConditionSpace {

   struct ConditionDescription {

unsigned long id_number;
string name;
string condition_logic;
unsigned long severity;
string descrip;
};

   typedef sequence<ConditionDescription> ConditionDescriptions;

   struct Description

   {

   ResourceID id;

   string name;

   string descrip;

   ConditionDescriptionsconditions; }; typedef sequence< Description >Descriptions;

   interface IHome {

   exception UnknownResourceID {string reason;};

   Description find ( in ResourceID condition_space ) raises (UnknownResourceID);

   Descriptions find_each ( in ResourceIDs condition_spaces ) raises (UnknownResourceID);

   Descriptions find_by_category ( in ResourceID category ) raises (UnknownResourceID);

   Descriptions find_by_source ( in ResourceID source ) raises (UnknownResourceID);

   Strings get_names ( in ResourceIDs condition_spaces );

   ResourceIDs get_ids ( in Strings names );

   };};};};#endif // _DAIS_AECONDITION_SPACE_IDL

   ConditionDescription

   A struct describing a condition.

Member Description
id_number A numeric identification unique within the condition space.
name The name of the condition.
condition_logic The logic telling when the condition is active. Refer to Section 5.2.7.3, “Condition Logic,? on page 5-38 for a description.
severity Severity is a number between 1 and 1000 having the following meaning: • Low severity 1-200 • Medium low severity 201-400 • Medium severity 401-600 • Medium high severity 601-800 • High severity 801-1000
description A text that to be included in event notifications when the condition is active.

   Description

   A struct describing the condition space.

Member Description
id A ResourceID identifying the condition space.
name The name of the condition space.
description A description of the condition space.
conditions A sequence of the conditions creates the condition space. In OPC the conditions are called sub-conditions and are retrieved by the method IOPCEventServer::QuerySubConditionNames().

   IHome

   An object for browsing the condition spaces defined by a server.

   find()

   A method for getting the description of a condition space.

Parameter

Description

condition_space A ResourceID identifying a condition space.
return The condition space description.

   find_each()

   A method for getting the descriptions for a number of condition spaces.

Parameter

Description

condition_spaces A sequence of ResourceID identifying condition spaces.
return A sequence of condition space descriptions.

   find_by_category()

   A method for finding all condition spaces defined for a category. The corresponding OPC method is IOPCEventServer::QueryConditionNames().

Parameter Description
category A ResourceID identifying the category for which to get the condition spaces.
return A sequence of condition space descriptions.

   find_by_source()

   A method for finding all condition spaces defined for a source. The corresponding OPC method is IOPCEventServer::QuerySourceConditions().

Parameter Description
source A ResourceID identifying the source for which to get the condition spaces.
return A sequence of condition space descriptions.

   get_names()

   A method translating a number of condition space identifications into name strings.

Parameter Description
condition_spaces A sequence of ResourceID identifying condition spaces.
return A sequence of condition space names. Non-translated identifications are returned as empty strings.

   get_ids()

   A method translating a number of condition space names into ResourceIDs.

Parameter Description
names A sequence of condition space names.
return A sequence of condition space ResourceIDs. Non- translated identifications are returned as NULL IDs.

   Browse condition space by source


   Figure 5-13 Browse condition space by source interaction

   Browse condition space by category


   find_by_category( )


   Figure 5-14 Browse condition space by category interaction