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

The HistoryReadEventContext class contains the settings for a HistoryReadEvent call. More...

#include <uaclientsdk.h>

Public Member Functions

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

Public Attributes

OpcUa_TimestampsToReturn timeStamps
 Enumeration for the timestamps to return with the events. 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...
 
UaEventFilter eventFilter
 The event filter for the history read. More...
 

Detailed Description

The HistoryReadEventContext class contains the settings for a HistoryReadEvent call.

Constructor & Destructor Documentation

UaClientSdk::HistoryReadEventContext::HistoryReadEventContext ( )
inline

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

UaClientSdk::HistoryReadEventContext::~HistoryReadEventContext ( )
inline

Destroys the HistoryReadEventContext object.

Member Data Documentation

OpcUa_Boolean UaClientSdk::HistoryReadEventContext::bReleaseContinuationPoints

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

The default value is false.

UaDateTime UaClientSdk::HistoryReadEventContext::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.

UaEventFilter UaClientSdk::HistoryReadEventContext::eventFilter

The event filter for the history read.

This is the same event filter used for getting new events through an event monitored item. The default value is null.

OpcUa_UInt32 UaClientSdk::HistoryReadEventContext::numValuesPerNode

Parameter to limit the number of results per node.

A server can further limit the number it 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.

UaDateTime UaClientSdk::HistoryReadEventContext::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::HistoryReadEventContext::timeStamps

Enumeration for the timestamps to return with the events.

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: