.NET Based OPC UA Client/Server SDK  2.6.0.418
UnifiedAutomation.UaBase.HistoryReadValueId Class Reference

A structure that is defined as the type of the nodesToRead parameter of the HistoryRead Service. More...

Inherits UnifiedAutomation.UaBase.IEncodeable.

Public Member Functions

 HistoryReadValueId ()
 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

NodeId NodeId [get, set]
 The nodeId to be read depends on HistoryReadDetails. More...
 
string IndexRange [get, set]
 This parameter is used to identify a single element of an array, or a single range of indexes for arrays. More...
 
QualifiedName DataEncoding [get, set]
 A QualifiedName that specifies the data encoding to be returned for the Value to be read. More...
 
byte[] ContinuationPoint [get, set]
 For each NodeToRead this parameter specifies a continuation point returned from a previous HistoryRead call, allowing the Client to continue that read from the last value received. 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 nodesToRead parameter of the HistoryRead Service.

Constructor & Destructor Documentation

UnifiedAutomation.UaBase.HistoryReadValueId.HistoryReadValueId ( )
inline

The default constructor.

Member Function Documentation

virtual bool UnifiedAutomation.UaBase.HistoryReadValueId.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

byte [] UnifiedAutomation.UaBase.HistoryReadValueId.ContinuationPoint
getset

For each NodeToRead this parameter specifies a continuation point returned from a previous HistoryRead call, allowing the Client to continue that read from the last value received.

The HistoryRead is used to select an ordered sequence of historical values or events. A continuation point marks a point in that ordered sequence, such that the Server returns the subset of the sequence that follows that point.

A null value indicates that this parameter is not used.

This continuation point is described in more detail in Part 11 of the OPC UA Specification.

QualifiedName UnifiedAutomation.UaBase.HistoryReadValueId.DataEncoding
getset

A QualifiedName that specifies the data encoding to be returned for the Value to be read.

See ReadValueId for a definition on how to specify the data encoding.

The parameter is ignored when reading history of Events.

string UnifiedAutomation.UaBase.HistoryReadValueId.IndexRange
getset

This parameter is used to identify a single element of 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 value is not an array. However, if the value is an array, and this parameter is null, then all elements are to be included in the range.

NodeId UnifiedAutomation.UaBase.HistoryReadValueId.NodeId
getset

The nodeId to be read depends on HistoryReadDetails.

If HistoryReadDetails is

RAW, PROCESSED, MODIFIED or ATTIME
The nodeId of the Nodes whose historical values are to be read. The value returned shall always include a timestamp.
EVENTS
The NodeId of the Node whose Event history is to be read.

If the Node does not support the requested access for historical values or historical events, the appropriate error response for the given node shall be generated.


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