Previous Table of Contents Next


3.1.9.2 IDL


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

   module DAIS {module Property {

   struct Description { PropertyID id; string label; string descrip; SimpleValueType canonical_data_type;

   };typedef sequence<Description> Descriptions;

   interface IHome { exception UnknownResourceID {string reason;};

   Description find ( in PropertyID property ) raises (UnknownResourceID);

   Descriptions find_each ( in PropertyIDs properties ) raises (UnknownResourceID);

   Descriptions find_by_node ( in ResourceID node ) raises (UnknownResourceID);

   Descriptions find_by_type ( in ResourceID type

   ) raises (UnknownResourceID); };};}; #endif // _DAIS_PROPERTY_IDL

   Description

   Describe a property.

Member Description
id The identification of this property.
label The label (single level designation) of the property.
descrip A description of the property.
canonical_data_type The data type used for the property in the server.

   Home

   An object used for browsing properties defined for a type or existing at a node. It corresponds to the OPC interface IOPCItemProperties.

   UnknownResourceID

   An exception telling that the ResourceID is unknown. The likely reason behind this exception is some misunderstanding between the server and client code due to a programming error.

   find()

   For a given property, return information about that property.

Parameter

Description

property A property identification.
return The property description.

   find_each()

   For a given property, return information about that property.

Parameter

Description

properties A sequence of property identifications.
return The sequence of property descriptions.

   find_by_node ()

   For a node, return information about each property describing its items. This method corresponds to IOPCItemProperties::QueryAvailableProperties().

Parameter

Description

node A node identification.
return A sequence of property descriptions.

   find_by_type ()

   For a given type, return all property descriptions.

Parameter

Description

type A type identification.
return A sequence of property descriptions.