Reference

IOpcNodeHistoryProvider Members

Type

IOpcNodeHistoryProvider

Namespace

Opc.UaFx.Server

Assembly

Opc.UaFx.Advanced.dll

Package

Opc.UaFx.Advanced v2.59.0

Properties

Node

Gets the OpcVariableNode for which this instance provides and maintains historical values.

OpcVariableNode Node { get; }

ReadOnly Property Node As OpcVariableNode

Property value

OpcVariableNode

An instance of the OpcVariableNode class this provider is responsible for.

Methods

CreateHistory

Creates the history entries of the values specified.

OpcStatusCollection CreateHistory(
    OpcContext context,
    OpcHistoryModificationInfo modificationInfo,
    OpcValueCollection values)

Function CreateHistory(
    context As OpcContext,
    modificationInfo As OpcHistoryModificationInfo,
    values As OpcValueCollection) As OpcStatusCollection

Parameters

Name	Type	Description
context	OpcContext	The OpcContext of the operation.
modificationInfo	OpcHistoryModificationInfo	The OpcHistoryModificationInfo which describes the modification.
values	OpcValueCollection	The OpcValueCollection with the values to create.

Returns

OpcStatusCollection

An OpcStatusCollection with the result per value, which the server returns to the client.

DeleteHistory

3 overloads

Overload	Description
DeleteHistory(OpcContext, OpcHistoryModificationInfo, IEnumerable<DateTime>)	Deletes the history entries at the times specified.
DeleteHistory(OpcContext, OpcHistoryModificationInfo, OpcValueCollection)	Deletes the history entries of the values specified.
DeleteHistory(OpcContext, OpcHistoryModificationInfo, DateTime?, DateTime?, OpcDeleteHistoryOptions)	Deletes the history entries within the time range specified.

DeleteHistory(OpcContext, OpcHistoryModificationInfo, IEnumerable<DateTime>)

Deletes the history entries at the times specified.

OpcStatusCollection DeleteHistory(
    OpcContext context,
    OpcHistoryModificationInfo modificationInfo,
    IEnumerable<DateTime> times)

Function DeleteHistory(
    context As OpcContext,
    modificationInfo As OpcHistoryModificationInfo,
    times As IEnumerable(Of Date)) As OpcStatusCollection

Parameters

Name	Type	Description
context	OpcContext	The OpcContext of the operation.
modificationInfo	OpcHistoryModificationInfo	The OpcHistoryModificationInfo which describes the modification.
times	IEnumerable<DateTime>	A sequence of the timestamps of the entries to delete.

Returns

OpcStatusCollection

An OpcStatusCollection with the result per timestamp, which the server returns to the client.

DeleteHistory(OpcContext, OpcHistoryModificationInfo, OpcValueCollection)

Deletes the history entries of the values specified.

OpcStatusCollection DeleteHistory(
    OpcContext context,
    OpcHistoryModificationInfo modificationInfo,
    OpcValueCollection values)

Function DeleteHistory(
    context As OpcContext,
    modificationInfo As OpcHistoryModificationInfo,
    values As OpcValueCollection) As OpcStatusCollection

Parameters

Name	Type	Description
context	OpcContext	The OpcContext of the operation.
modificationInfo	OpcHistoryModificationInfo	The OpcHistoryModificationInfo which describes the modification.
values	OpcValueCollection	The OpcValueCollection with the values whose entries are to be deleted.

Returns

OpcStatusCollection

An OpcStatusCollection with the result per value, which the server returns to the client.

DeleteHistory(OpcContext, OpcHistoryModificationInfo, DateTime?, DateTime?, OpcDeleteHistoryOptions)

Deletes the history entries within the time range specified.

OpcStatusCollection DeleteHistory(
    OpcContext context,
    OpcHistoryModificationInfo modificationInfo,
    DateTime? startTime,
    DateTime? endTime,
    OpcDeleteHistoryOptions options)

Function DeleteHistory(
    context As OpcContext,
    modificationInfo As OpcHistoryModificationInfo,
    startTime As Date?,
    endTime As Date?,
    options As OpcDeleteHistoryOptions) As OpcStatusCollection

Parameters

Name	Type	Description
context	OpcContext	The OpcContext of the operation.
modificationInfo	OpcHistoryModificationInfo	The OpcHistoryModificationInfo which describes the modification.
startTime	Nullable<DateTime>	The begin of the time range or a null reference (Nothing in Visual Basic) if the range is not limited at its begin.
endTime	Nullable<DateTime>	The end of the time range or a null reference (Nothing in Visual Basic) if the range is not limited at its end.
options	OpcDeleteHistoryOptions	A combination of the OpcDeleteHistoryOptions flags which specify the entries to delete.

Returns

OpcStatusCollection

An OpcStatusCollection with the results of the operation, which the server returns to the client.

ReadHistory

since v2.51

Reads the history of the values within the time range specified.

IEnumerable<OpcHistoryValue> ReadHistory(
    OpcContext context,
    DateTime? startTime,
    DateTime? endTime,
    bool timeFlowsBackward,
    uint? maxCount,
    OpcReadHistoryOptions options)

Function ReadHistory(
    context As OpcContext,
    startTime As Date?,
    endTime As Date?,
    timeFlowsBackward As Boolean,
    maxCount As UInteger?,
    options As OpcReadHistoryOptions) As IEnumerable(Of OpcHistoryValue)

Parameters

Name	Type	Description
context	OpcContext	The OpcContext of the read operation.
startTime	Nullable<DateTime>	The begin of the time range to read or a null reference (Nothing in Visual Basic) if the range is not limited at its begin.
endTime	Nullable<DateTime>	The end of the time range to read or a null reference (Nothing in Visual Basic) if the range is not limited at its end.
timeFlowsBackward	Boolean	The value true to provide the values in descending order of their timestamps; otherwise the value false to provide them in ascending order.
maxCount	Nullable<UInt32>	The maximum number of values the server uses or a null reference (Nothing in Visual Basic) if the number is not limited. A provider can use it to optimize reading.
options	OpcReadHistoryOptions	A combination of the OpcReadHistoryOptions flags which specify the values to provide.

Returns

IEnumerable<OpcHistoryValue>

A sequence of the OpcHistoryValue instances read.

Remarks

The server does not swap the bounds of the time range, so that the startTime can be later than the endTime, e.g. when a client reads backward in time.

ReplaceHistory

Replaces the existing history entries with the values specified.

OpcStatusCollection ReplaceHistory(
    OpcContext context,
    OpcHistoryModificationInfo modificationInfo,
    OpcValueCollection values)

Function ReplaceHistory(
    context As OpcContext,
    modificationInfo As OpcHistoryModificationInfo,
    values As OpcValueCollection) As OpcStatusCollection

Parameters

Name	Type	Description
context	OpcContext	The OpcContext of the operation.
modificationInfo	OpcHistoryModificationInfo	The OpcHistoryModificationInfo which describes the modification.
values	OpcValueCollection	The OpcValueCollection with the values to replace the existing entries with.

Returns

OpcStatusCollection

An OpcStatusCollection with the result per value, which the server returns to the client.

UpdateHistory

Updates the history entries of the values specified.

OpcStatusCollection UpdateHistory(
    OpcContext context,
    OpcHistoryModificationInfo modificationInfo,
    OpcValueCollection values)

Function UpdateHistory(
    context As OpcContext,
    modificationInfo As OpcHistoryModificationInfo,
    values As OpcValueCollection) As OpcStatusCollection

Parameters

Name	Type	Description
context	OpcContext	The OpcContext of the operation.
modificationInfo	OpcHistoryModificationInfo	The OpcHistoryModificationInfo which describes the modification.
values	OpcValueCollection	The OpcValueCollection with the values to create or to replace the existing entries with.

Returns

OpcStatusCollection

An OpcStatusCollection with the result per value, which the server returns to the client.