Skip to content

Reference

OpcReadEventsHistoryRequest Members

Represents the request of the HistoryRead service of OPC UA, which reads the history of events of nodes.

Reference

OpcReadEventsHistoryRequest Members ​

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

Inherits members from OpcServiceRequest<HistoryReadValueId, HistoryReadValueIdCollection>, OpcServiceRequest.

Constructors ​

OpcReadEventsHistoryRequest ​

4 overloads

OverloadDescription
OpcReadEventsHistoryRequest(OpcReadEventHistoryDetails, IEnumerable<HistoryReadValueId>)Initializes a new instance of the OpcReadEventsHistoryRequest class using the specified details and commands and a new header.
OpcReadEventsHistoryRequest(OpcReadEventHistoryDetails, params HistoryReadValueId[])Initializes a new instance of the OpcReadEventsHistoryRequest class using the specified details and commands and a new header.
OpcReadEventsHistoryRequest(IOpcServiceRequestHeader, OpcReadEventHistoryDetails, IEnumerable<HistoryReadValueId>)Initializes a new instance of the OpcReadEventsHistoryRequest class using the specified header, details and commands.
OpcReadEventsHistoryRequest(IOpcServiceRequestHeader, OpcReadEventHistoryDetails, params HistoryReadValueId[])Initializes a new instance of the OpcReadEventsHistoryRequest class using the specified header, details and commands.

OpcReadEventsHistoryRequest(OpcReadEventHistoryDetails, IEnumerable<HistoryReadValueId>) ​

Initializes a new instance of the OpcReadEventsHistoryRequest class using the specified details and commands and a new header.

csharp
[CLSCompliant(false)]
public OpcReadEventsHistoryRequest(
    OpcReadEventHistoryDetails details,
    IEnumerable<HistoryReadValueId> commands)
vbnet
<CLSCompliant(False)>
Public Sub New(
    details As OpcReadEventHistoryDetails,
    commands As IEnumerable(Of HistoryReadValueId))

Parameters

NameTypeDescription
detailsOpcReadEventHistoryDetailsThe details which specify the events to read.
commandsIEnumerable<HistoryReadValueId>The commands which specify the nodes whose event history is to be read.

Exceptions

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

OpcReadEventsHistoryRequest(OpcReadEventHistoryDetails, params HistoryReadValueId[]) ​

Initializes a new instance of the OpcReadEventsHistoryRequest class using the specified details and commands and a new header.

csharp
[CLSCompliant(false)]
public OpcReadEventsHistoryRequest(
    OpcReadEventHistoryDetails details,
    params HistoryReadValueId[] commands)
vbnet
<CLSCompliant(False)>
Public Sub New(
    details As OpcReadEventHistoryDetails,
    ParamArray commands As HistoryReadValueId())

Parameters

NameTypeDescription
detailsOpcReadEventHistoryDetailsThe details which specify the events to read.
commandsparams HistoryReadValueId[]The commands which specify the nodes whose event history is to be read.

Exceptions

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

OpcReadEventsHistoryRequest(IOpcServiceRequestHeader, OpcReadEventHistoryDetails, IEnumerable<HistoryReadValueId>) ​

Initializes a new instance of the OpcReadEventsHistoryRequest class using the specified header, details and commands.

csharp
[CLSCompliant(false)]
public OpcReadEventsHistoryRequest(
    IOpcServiceRequestHeader header,
    OpcReadEventHistoryDetails details,
    IEnumerable<HistoryReadValueId> commands)
vbnet
<CLSCompliant(False)>
Public Sub New(
    header As IOpcServiceRequestHeader,
    details As OpcReadEventHistoryDetails,
    commands As IEnumerable(Of HistoryReadValueId))

Parameters

NameTypeDescription
headerIOpcServiceRequestHeaderThe header of the request.
detailsOpcReadEventHistoryDetailsThe details which specify the events to read.
commandsIEnumerable<HistoryReadValueId>The commands which specify the nodes whose event history is to be read.

Exceptions

ExceptionCondition
ArgumentNullExceptionThe header or the commands is a null reference (Nothing in Visual Basic).

OpcReadEventsHistoryRequest(IOpcServiceRequestHeader, OpcReadEventHistoryDetails, params HistoryReadValueId[]) ​

Initializes a new instance of the OpcReadEventsHistoryRequest class using the specified header, details and commands.

csharp
[CLSCompliant(false)]
public OpcReadEventsHistoryRequest(
    IOpcServiceRequestHeader header,
    OpcReadEventHistoryDetails details,
    params HistoryReadValueId[] commands)
vbnet
<CLSCompliant(False)>
Public Sub New(
    header As IOpcServiceRequestHeader,
    details As OpcReadEventHistoryDetails,
    ParamArray commands As HistoryReadValueId())

Parameters

NameTypeDescription
headerIOpcServiceRequestHeaderThe header of the request.
detailsOpcReadEventHistoryDetailsThe details which specify the events to read.
commandsparams HistoryReadValueId[]The commands which specify the nodes whose event history is to be read.

Exceptions

ExceptionCondition
ArgumentNullExceptionThe header or the commands is a null reference (Nothing in Visual Basic).

Properties ​

Details ​

Gets the details which specify the events to read.

csharp
public OpcReadEventHistoryDetails Details { get; }
vbnet
Public ReadOnly Property Details As OpcReadEventHistoryDetails

Property value

OpcReadEventHistoryDetails

The OpcReadEventHistoryDetails specified when the request was created.

ReleaseContinuationPoints ​

Gets or sets a value indicating whether the continuation points of the commands are to be released.

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

Property value

Boolean

The value true to release the continuation points without reading further events; otherwise the value false to continue reading. The default value is false.

TimestampsToReturn ​

Gets or sets a value which specifies the timestamps to be returned for each requested Value attribute.

csharp
public OpcTimestampsToReturn TimestampsToReturn { get; set; }
vbnet
Public Property TimestampsToReturn As OpcTimestampsToReturn

Property value

OpcTimestampsToReturn

One of the members defined by the OpcTimestampsToReturn enumeration except Neither.

Remarks

Using the value Neither as the timestamps to return is not valid and results into a response with the status code BadInvalidTimestampArgument.