C++ Based OPC UA Client/Server SDK  1.5.5.355
UaClientSdk::HistoryReadProcessedContext Class Reference

The HistoryReadProcessedContext class contains the settings for a HistoryReadProcessed call. More...

#include <uaclientsdk.h>

Public Member Functions

 HistoryReadProcessedContext ()
 Creates a HistoryReadProcessedContext object with default settings described with the parameters. More...
 
 ~HistoryReadProcessedContext ()
 Destructor.
 

Public Attributes

OpcUa_TimestampsToReturn timeStamps
 Indicates if the source timestamp, the server timestamp, or both should be returned. More...
 
OpcUa_Boolean bReleaseContinuationPoints
 The flag indicates if the Service call is used to release ContinuationPoints returned from previous calls without returning additional data. More...
 
UaNodeIdArray aggregateTypes
 The NodeIds of the aggregates used for the calculation of the values. More...
 
UaDateTime startTime
 The start time of the requested time domain. More...
 
UaDateTime endTime
 The end time of the requested time domain. More...
 
OpcUa_Double processingInterval
 Time interval in milliseconds that is used to calculate one aggregated value from the raw values in the history database. More...
 
OpcUa_AggregateConfiguration aggregateConfiguration
 The aggregateConfiguration parameter allows clients to override the Aggregate configuration settings supplied by the AggregateConfiguration object in the server on a per call basis. More...
 

Detailed Description

The HistoryReadProcessedContext class contains the settings for a HistoryReadProcessed call.

Constructor & Destructor Documentation

UaClientSdk::HistoryReadProcessedContext::HistoryReadProcessedContext ( )
inline

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

Member Data Documentation

OpcUa_AggregateConfiguration UaClientSdk::HistoryReadProcessedContext::aggregateConfiguration

The aggregateConfiguration parameter allows clients to override the Aggregate configuration settings supplied by the AggregateConfiguration object in the server on a per call basis.

The default values are

  • UseServerCapabilitiesDefaults = true
  • TreatUncertainAsBad = false
  • PercentDataBad = 100
  • PercentDataGood = 0
  • UseSlopedExtrapolation = false
UaNodeIdArray UaClientSdk::HistoryReadProcessedContext::aggregateTypes

The NodeIds of the aggregates used for the calculation of the values.

The length of this array must match the nodesToRead array.

OpcUa_Boolean UaClientSdk::HistoryReadProcessedContext::bReleaseContinuationPoints

The flag indicates if the Service call is used to release ContinuationPoints returned from previous calls without returning additional data.

This allows clients to free resources in the server if the client does not continue the read. The default value is false.

UaDateTime UaClientSdk::HistoryReadProcessedContext::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_Double UaClientSdk::HistoryReadProcessedContext::processingInterval

Time interval in milliseconds that is used to calculate one aggregated value from the raw values in the history database.

The time domain is divided into subintervals with the length of the ResampleInterval beginning with the start time. If the ResampleInterval is 0, one aggregated value is calculated for the time domain. The default value is 0.

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

Indicates if the source timestamp, the server timestamp, or both should be returned.

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 selected timestamp is also used for the selection of the values in the time domain to read. If both are selected, the source timestamp is used.


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