UA Server SDK C++ Bundle  1.4.1.271
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
UaClientSdk::HistoryReadRawModifiedContext Class Reference

The HistoryReadRawModifiedContext class contains the settings for a HistoryReadRawModified call. More...

#include <uaclientsdk.h>

Public Member Functions

 HistoryReadRawModifiedContext ()
 Creates a HistoryReadRawModifiedContext object with default settings described with the parameters. More...
 
 ~HistoryReadRawModifiedContext ()
 Destroys the HistoryReadRawModifiedContext object. More...
 

Public Attributes

OpcUa_Boolean isReadModified
 Indicates if modified data should be read instead of the raw data. More...
 
OpcUa_TimestampsToReturn timeStamps
 Enumeration for the timestamps to return with the values. More...
 
OpcUa_Boolean bReleaseContinuationPoints
 This parameter must be set to true to release a continuation point without requesting more data. More...
 
OpcUa_UInt32 numValuesPerNode
 Parameter to limit the number of results per node. More...
 
UaDateTime startTime
 The start time of the requested time domain. More...
 
UaDateTime endTime
 The end time of the requested time domain. More...
 
OpcUa_Boolean returnBounds
 Indicates if bounding values should be returned. More...
 

Detailed Description

The HistoryReadRawModifiedContext class contains the settings for a HistoryReadRawModified call.

Constructor & Destructor Documentation

UaClientSdk::HistoryReadRawModifiedContext::HistoryReadRawModifiedContext ( )
inline

Creates a HistoryReadRawModifiedContext object with default settings described with the parameters.

UaClientSdk::HistoryReadRawModifiedContext::~HistoryReadRawModifiedContext ( )
inline

Destroys the HistoryReadRawModifiedContext object.

Member Data Documentation

OpcUa_Boolean UaClientSdk::HistoryReadRawModifiedContext::bReleaseContinuationPoints

This parameter must be set to true to release a continuation point without requesting more data.

The default value is false.

UaDateTime UaClientSdk::HistoryReadRawModifiedContext::endTime

The end time of the requested time domain.

The values can be read in inverse order if the end time is before the start time. The default value is null.

OpcUa_Boolean UaClientSdk::HistoryReadRawModifiedContext::isReadModified

Indicates if modified data should be read instead of the raw data.

The default value is false.

OpcUa_UInt32 UaClientSdk::HistoryReadRawModifiedContext::numValuesPerNode

Parameter to limit the number of results per node.

A server can further limit the number he returns. If the client or server limit exceeds the number of results available, a continuation point is returned in the history read response. The default value is 0.

OpcUa_Boolean UaClientSdk::HistoryReadRawModifiedContext::returnBounds

Indicates if bounding values should be returned.

Bounding values are delivered if this flag is set to true and no value is available for the requested start or end time. The default value is false.

UaDateTime UaClientSdk::HistoryReadRawModifiedContext::startTime

The start time of the requested time domain.

The values can be read in inverse order if the end time is before the start time. The default value is null.

OpcUa_TimestampsToReturn UaClientSdk::HistoryReadRawModifiedContext::timeStamps

Enumeration for the timestamps to return with the values.

The default value is Source.

Possible options are

  • OpcUa_TimestampsToReturn_Source = 0,
  • OpcUa_TimestampsToReturn_Server = 1,
  • OpcUa_TimestampsToReturn_Both = 2,

The option OpcUa_TimestampsToReturn_Neither = 3 is invalid for history read.


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