Skip to content

Reference

OpcReadNodeHistoryDetails Members

Provides an abstract base class which defines the time domain, number of values and additional criteria to use to select values from historical database for one or more variables.

Reference

OpcReadNodeHistoryDetails Members ​

Type
OpcReadNodeHistoryDetails
Namespace
Opc.UaFx
Assembly
Opc.UaFx.Advanced.dll
Package
Opc.UaFx.Advanced v2.59.0
Also in
Opc.UaFx.Client

Constructors ​

OpcReadNodeHistoryDetails ​

protected · 5 overloads

OverloadDescription
OpcReadNodeHistoryDetails(int)protectedInitializes a new instance of the OpcReadNodeHistoryDetails class using the specified numberOfValues to select the historical values.
OpcReadNodeHistoryDetails(DateTime?, int)protectedInitializes a new instance of the OpcReadNodeHistoryDetails class using the specified startTime and numberOfValues to use to select the historical values.
OpcReadNodeHistoryDetails(DateTime?, DateTime?, int)protectedInitializes a new instance of the OpcReadNodeHistoryDetails class using the specified startTime, endTime and numberOfValues to use to select the historical values.
OpcReadNodeHistoryDetails(DateTime?, DateTime?)protectedInitializes a new instance of the OpcReadNodeHistoryDetails class using the specified startTime and endTime to use to select the historical values.
OpcReadNodeHistoryDetails(ReadRawModifiedDetails)protectedInitializes a new instance of the OpcReadNodeHistoryDetails class using the content specified.

OpcReadNodeHistoryDetails(int) ​

protected

Initializes a new instance of the OpcReadNodeHistoryDetails class using the specified numberOfValues to select the historical values.

csharp
protected OpcReadNodeHistoryDetails(int numberOfValues)
vbnet
Protected Sub New(numberOfValues As Integer)

Parameters

NameTypeDescription
numberOfValuesInt32The maximum number of values returned for any node over the time range.

Exceptions

ExceptionCondition
ArgumentOutOfRangeExceptionThe numberOfValues is lower or equals zero.

OpcReadNodeHistoryDetails(DateTime?, int) ​

protected

Initializes a new instance of the OpcReadNodeHistoryDetails class using the specified startTime and numberOfValues to use to select the historical values.

csharp
protected OpcReadNodeHistoryDetails(DateTime? startTime, int numberOfValues)
vbnet
Protected Sub New(startTime As Date?, numberOfValues As Integer)

Parameters

NameTypeDescription
startTimeNullable<DateTime>The beginning of the period to read.
numberOfValuesInt32The maximum number of values returned for any node over the time range. If only one time is specified, the time range shall extend to return this number of values.

Exceptions

ExceptionCondition
ArgumentExceptionThe startTime is a null reference (Nothing in Visual Basic) or equals MinValue.
ArgumentOutOfRangeExceptionThe numberOfValues is lower or equals zero.

OpcReadNodeHistoryDetails(DateTime?, DateTime?, int) ​

protected

Initializes a new instance of the OpcReadNodeHistoryDetails class using the specified startTime, endTime and numberOfValues to use to select the historical values.

csharp
protected OpcReadNodeHistoryDetails(
    DateTime? startTime,
    DateTime? endTime,
    int numberOfValues)
vbnet
Protected Sub New(
    startTime As Date?,
    endTime As Date?,
    numberOfValues As Integer)

Parameters

NameTypeDescription
startTimeNullable<DateTime>The beginning of the period to read or a null reference (Nothing in Visual Basic) if no specific start time is specified. If startTime is not specified and the numberOfValues is equals zero the endTime needs to be specified.
endTimeNullable<DateTime>The end of the period to read or a null reference (Nothing in Visual Basic) if no specific end time is specified. If endTime is not specified and the numberOfValues is equals zero the startTime needs to be specified.
numberOfValuesInt32The maximum number of values returned for any node over the time range. If only one time is specified, the time range shall extend to return this number of values.

Exceptions

ExceptionCondition
ArgumentExceptionThe startTime and endTime are a null reference (Nothing in Visual Basic) or are equals MinValue and numberOfValues is lower or equals zero.

OpcReadNodeHistoryDetails(DateTime?, DateTime?) ​

protected

Initializes a new instance of the OpcReadNodeHistoryDetails class using the specified startTime and endTime to use to select the historical values.

csharp
protected OpcReadNodeHistoryDetails(DateTime? startTime, DateTime? endTime)
vbnet
Protected Sub New(startTime As Date?, endTime As Date?)

Parameters

NameTypeDescription
startTimeNullable<DateTime>The beginning of the period to read or a null reference (Nothing in Visual Basic) if no specific start time is specified. If startTime is not specified the endTime needs to be specified.
endTimeNullable<DateTime>The end of the period to read or a null reference (Nothing in Visual Basic) if no specific end time is specified. If endTime is not specified the startTime needs to be specified.

Exceptions

ExceptionCondition
ArgumentExceptionThe startTime and endTime are a null reference (Nothing in Visual Basic) or are equals MinValue.

OpcReadNodeHistoryDetails(ReadRawModifiedDetails) ​

protected

Initializes a new instance of the OpcReadNodeHistoryDetails class using the content specified.

csharp
[CLSCompliant(false)]
protected OpcReadNodeHistoryDetails(ReadRawModifiedDetails content)
vbnet
<CLSCompliant(False)>
Protected Sub New(content As ReadRawModifiedDetails)

Parameters

NameTypeDescription
contentReadRawModifiedDetailsThe ReadRawModifiedDetails to wrap, maintain and represented.

Exceptions

ExceptionCondition
ArgumentNullExceptionThe content is a null reference (Nothing in Visual Basic).

Properties ​

EndTime ​

Gets or sets the end of the period to read.

csharp
public DateTime? EndTime { get; set; }
vbnet
Public Property EndTime As Date?

Property value

Nullable<DateTime>

The DateTime of the end of the period to read or a null reference (Nothing in Visual Basic) if no specific end time is specified.

Remarks

If EndTime is not specified and NumberOfValues is equals zero the StartTime needs to be specified.

NumberOfValues ​

Gets or sets the maximum number of values returned for any node over the time range.

csharp
public int NumberOfValues { get; set; }
vbnet
Public Property NumberOfValues As Integer

Property value

Int32

The maximum number of values returned over the time range. The default value is zero and indicates that there is no maximum.

Remarks

If only time (either StartTime or EndTime) is specified, the time range shall extend to return this number of values.

ReturnBounds ​

since v2.23

Gets or sets a value indicating whether the bounding values should be returned.

csharp
public bool ReturnBounds { get; set; }
vbnet
Public Property ReturnBounds As Boolean

Property value

Boolean

The value true to return the bounding values; otherwise the value false. The default value is false.

StartTime ​

Gets or sets the beginning of the period to read.

csharp
public DateTime? StartTime { get; set; }
vbnet
Public Property StartTime As Date?

Property value

Nullable<DateTime>

The DateTime of the beginning of the period read or a null reference (Nothing in Visual Basic) if no specific start time is specified.

Remarks

If StartTime is not specified the EndTime needs to be specified.