.NET Based OPC UA Client/Server SDK  3.0.10.493
UnifiedAutomation.UaBase.QueryDataDescription Class Reference

A structure that is defined as the type of the dataToReturn parameter of the nodeTypes parameter of the Query service. More...

Inherits UnifiedAutomation.UaBase.IEncodeable.

Public Member Functions

 QueryDataDescription ()
 The default constructor. More...
 
virtual void Encode (IEncoder encoder)
 
virtual void Decode (IDecoder decoder)
 
virtual bool IsEqual (IEncodeable encodeable)
 Checks if encodeable is the same object or has the same content More...
 
virtual object Clone ()
 

Properties

RelativePath RelativePath [get, set]
 Browse path relative to the originating node that identifies the node which contains the data that is being requested, where the originating node is an instance node of the type defined by the type definition node. More...
 
uint AttributeId [get, set]
 The ID of the attribute. More...
 
string IndexRange [get, set]
 Used to identify a single element of a structure or an array, or a single range of indexes for arrays. More...
 
virtual ExpandedNodeId TypeId [get]
 
virtual ExpandedNodeId BinaryEncodingId [get]
 
virtual ExpandedNodeId XmlEncodingId [get]
 
- Properties inherited from UnifiedAutomation.UaBase.IEncodeable
ExpandedNodeId TypeId [get]
 Returns the UA type identifier for the encodable type. More...
 
ExpandedNodeId BinaryEncodingId [get]
 Returns the UA type identifier for the default binary encoding for the type. More...
 
ExpandedNodeId XmlEncodingId [get]
 Returns the UA type identifier for the default XML encoding for the type. More...
 

Detailed Description

A structure that is defined as the type of the dataToReturn parameter of the nodeTypes parameter of the Query service.

Constructor & Destructor Documentation

UnifiedAutomation.UaBase.QueryDataDescription.QueryDataDescription ( )
inline

The default constructor.

Member Function Documentation

virtual bool UnifiedAutomation.UaBase.QueryDataDescription.IsEqual ( IEncodeable  encodeable)
inlinevirtual

Checks if encodeable is the same object or has the same content

Parameters
encodeable
Returns

Implements UnifiedAutomation.UaBase.IEncodeable.

Property Documentation

uint UnifiedAutomation.UaBase.QueryDataDescription.AttributeId
getset

The ID of the attribute.

This shall be a valid attribute ID. If the RelativePath ended in a reference, this parameter is 0 and ignored by the server.

string UnifiedAutomation.UaBase.QueryDataDescription.IndexRange
getset

Used to identify a single element of a structure or an array, or a single range of indexes for arrays.

If a range of elements is specified, the values are returned as a composite. The first element is identified by index 0 (zero). This parameter is null if the specified attribute is not an array or a structure. However, if the specified attribute is an array or a structure and this parameter is null, all elements are to be included in the range.

RelativePath UnifiedAutomation.UaBase.QueryDataDescription.RelativePath
getset

Browse path relative to the originating node that identifies the node which contains the data that is being requested, where the originating node is an instance node of the type defined by the type definition node.

The instance nodes are further limited by the filter provided as part of this call.

This relative path could end on a reference, in which case the ReferenceDescription of the reference would be returned as its value.

The targetName field of the relativePath may contain a type NodeId. This is done by setting the namespaceIndex of the targetName to zero and the name part of the targetName to the XML representation of the NodeId.

When matching instances are returned as the target node, the target node shall be an instance of the specified type or subtype of the specified type.


The documentation for this class was generated from the following file: