Reference

OpcHistoryConfigurationNode Members

Type

OpcHistoryConfigurationNode

Namespace

Opc.UaFx

Assembly

Opc.UaFx.Advanced.dll

Package

Opc.UaFx.Advanced v2.59.0

Inherits members from OpcObjectNode, OpcInstanceNode, OpcNode.

Constructors

OpcHistoryConfigurationNode

14 overloads

Overload	Description
OpcHistoryConfigurationNode()	Initializes a new instance of the OpcHistoryConfigurationNode class.
OpcHistoryConfigurationNode(OpcNodeModel)since v2.50	Initializes a new instance of the OpcHistoryConfigurationNode class.
OpcHistoryConfigurationNode(OpcName)	Initializes a new instance of the OpcHistoryConfigurationNode class accessible by the name specified.
OpcHistoryConfigurationNode(OpcNodeModel, OpcName)since v2.50	Initializes a new instance of the OpcHistoryConfigurationNode class accessible by the name specified.
OpcHistoryConfigurationNode(OpcName, OpcNodeId)	Initializes a new instance of the OpcHistoryConfigurationNode class accessible by the name and id specified.
OpcHistoryConfigurationNode(OpcNodeModel, OpcName, OpcNodeId)since v2.50	Initializes a new instance of the OpcHistoryConfigurationNode class accessible by the name and id specified.
OpcHistoryConfigurationNode(IOpcNode)	Initializes a new instance of the OpcHistoryConfigurationNode class as a child node of the parent node given.
OpcHistoryConfigurationNode(OpcNodeModel, IOpcNode)since v2.50	Initializes a new instance of the OpcHistoryConfigurationNode class as a child node of the parent node given.
OpcHistoryConfigurationNode(IOpcNode, OpcName)	Initializes a new instance of the OpcHistoryConfigurationNode class accessible by the name specified as a child node of the parent node given.
OpcHistoryConfigurationNode(OpcNodeModel, IOpcNode, OpcName)since v2.50	Initializes a new instance of the OpcHistoryConfigurationNode class accessible by the name specified as a child node of the parent node given.
OpcHistoryConfigurationNode(IOpcNode, OpcName, OpcNodeId)	Initializes a new instance of the OpcHistoryConfigurationNode class accessible by the name and id specified as a child node of the parent node given.
OpcHistoryConfigurationNode(OpcNodeModel, IOpcNode, OpcName, OpcNodeId)since v2.50	Initializes a new instance of the OpcHistoryConfigurationNode class accessible by the name and id specified as a child node of the parent node given.
OpcHistoryConfigurationNode(HistoricalDataConfigurationState)protected · since v2.50	Initializes a new instance of the OpcHistoryConfigurationNode class using the content as the instance to wrap.
OpcHistoryConfigurationNode(HistoricalDataConfigurationState, OpcNodeModel)protected · since v2.50	Initializes a new instance of the OpcHistoryConfigurationNode class using the content as the instance to wrap.

OpcHistoryConfigurationNode()

Initializes a new instance of the OpcHistoryConfigurationNode class.

public OpcHistoryConfigurationNode()

Public Sub New()

OpcHistoryConfigurationNode(OpcNodeModel)

since v2.50

Initializes a new instance of the OpcHistoryConfigurationNode class.

public OpcHistoryConfigurationNode(OpcNodeModel model)

Public Sub New(model As OpcNodeModel)

Parameters

Name	Type	Description
model	OpcNodeModel	The OpcNodeModel which defines the modelling directives for the new object node or a null reference (Nothing in Visual Basic) if there are no directives are to be applied to the object node.

OpcHistoryConfigurationNode(OpcName)

Initializes a new instance of the OpcHistoryConfigurationNode class accessible by the name specified.

public OpcHistoryConfigurationNode(OpcName name)

Public Sub New(name As OpcName)

Parameters

Name	Type	Description
name	OpcName	The OpcName through that the new history configurtion node can be accessed.

OpcHistoryConfigurationNode(OpcNodeModel, OpcName)

since v2.50

Initializes a new instance of the OpcHistoryConfigurationNode class accessible by the name specified.

public OpcHistoryConfigurationNode(OpcNodeModel model, OpcName name)

Public Sub New(model As OpcNodeModel, name As OpcName)

Parameters

Name	Type	Description
model	OpcNodeModel	The OpcNodeModel which defines the modelling directives for the new object node or a null reference (Nothing in Visual Basic) if there are no directives are to be applied to the object node.
name	OpcName	The OpcName through that the new history configurtion node can be accessed.

OpcHistoryConfigurationNode(OpcName, OpcNodeId)

Initializes a new instance of the OpcHistoryConfigurationNode class accessible by the name and id specified.

public OpcHistoryConfigurationNode(OpcName name, OpcNodeId id)

Public Sub New(name As OpcName, id As OpcNodeId)

Parameters

Name	Type	Description
name	OpcName	The OpcName through that the new history configurtion node can be accessed.
id	OpcNodeId	The OpcNodeId through that the new history configurtion node can be identified and accessed.

OpcHistoryConfigurationNode(OpcNodeModel, OpcName, OpcNodeId)

since v2.50

Initializes a new instance of the OpcHistoryConfigurationNode class accessible by the name and id specified.

public OpcHistoryConfigurationNode(
    OpcNodeModel model,
    OpcName name,
    OpcNodeId id)

Public Sub New(model As OpcNodeModel, name As OpcName, id As OpcNodeId)

Parameters

Name	Type	Description
model	OpcNodeModel	The OpcNodeModel which defines the modelling directives for the new object node or a null reference (Nothing in Visual Basic) if there are no directives are to be applied to the object node.
name	OpcName	The OpcName through that the new history configurtion node can be accessed.
id	OpcNodeId	The OpcNodeId through that the new history configurtion node can be identified and accessed.

OpcHistoryConfigurationNode(IOpcNode)

Initializes a new instance of the OpcHistoryConfigurationNode class as a child node of the parent node given.

public OpcHistoryConfigurationNode(IOpcNode parent)

Public Sub New(parent As IOpcNode)

Parameters

Name	Type	Description
parent	IOpcNode	The IOpcNode used as the parent node or a null reference (Nothing in Visual Basic) in the case there is no parent node available.

OpcHistoryConfigurationNode(OpcNodeModel, IOpcNode)

since v2.50

Initializes a new instance of the OpcHistoryConfigurationNode class as a child node of the parent node given.

public OpcHistoryConfigurationNode(OpcNodeModel model, IOpcNode parent)

Public Sub New(model As OpcNodeModel, parent As IOpcNode)

Parameters

Name	Type	Description
model	OpcNodeModel	The OpcNodeModel which defines the modelling directives for the new object node or a null reference (Nothing in Visual Basic) if there are no directives are to be applied to the object node.
parent	IOpcNode	The IOpcNode used as the parent node or a null reference (Nothing in Visual Basic) in the case there is no parent node available.

OpcHistoryConfigurationNode(IOpcNode, OpcName)

Initializes a new instance of the OpcHistoryConfigurationNode class accessible by the name specified as a child node of the parent node given.

public OpcHistoryConfigurationNode(IOpcNode parent, OpcName name)

Public Sub New(parent As IOpcNode, name As OpcName)

Parameters

Name	Type	Description
parent	IOpcNode	The IOpcNode used as the parent node or a null reference (Nothing in Visual Basic) in the case there is no parent node available.
name	OpcName	The OpcName through that the new history configurtion node can be accessed.

OpcHistoryConfigurationNode(OpcNodeModel, IOpcNode, OpcName)

since v2.50

Initializes a new instance of the OpcHistoryConfigurationNode class accessible by the name specified as a child node of the parent node given.

public OpcHistoryConfigurationNode(
    OpcNodeModel model,
    IOpcNode parent,
    OpcName name)

Public Sub New(model As OpcNodeModel, parent As IOpcNode, name As OpcName)

Parameters

Name	Type	Description
model	OpcNodeModel	The OpcNodeModel which defines the modelling directives for the new object node or a null reference (Nothing in Visual Basic) if there are no directives are to be applied to the object node.
parent	IOpcNode	The IOpcNode used as the parent node or a null reference (Nothing in Visual Basic) in the case there is no parent node available.
name	OpcName	The OpcName through that the new history configurtion node can be accessed.

OpcHistoryConfigurationNode(IOpcNode, OpcName, OpcNodeId)

Initializes a new instance of the OpcHistoryConfigurationNode class accessible by the name and id specified as a child node of the parent node given.

public OpcHistoryConfigurationNode(IOpcNode parent, OpcName name, OpcNodeId id)

Public Sub New(parent As IOpcNode, name As OpcName, id As OpcNodeId)

Parameters

Name	Type	Description
parent	IOpcNode	The IOpcNode used as the parent node or a null reference (Nothing in Visual Basic) in the case there is no parent node available.
name	OpcName	The OpcName through that the new history configurtion node can be accessed.
id	OpcNodeId	The OpcNodeId through that the new history configurtion node can be identified and accessed.

OpcHistoryConfigurationNode(OpcNodeModel, IOpcNode, OpcName, OpcNodeId)

since v2.50

Initializes a new instance of the OpcHistoryConfigurationNode class accessible by the name and id specified as a child node of the parent node given.

public OpcHistoryConfigurationNode(
    OpcNodeModel model,
    IOpcNode parent,
    OpcName name,
    OpcNodeId id)

Public Sub New(
    model As OpcNodeModel,
    parent As IOpcNode,
    name As OpcName,
    id As OpcNodeId)

Parameters

Name	Type	Description
model	OpcNodeModel	The OpcNodeModel which defines the modelling directives for the new object node or a null reference (Nothing in Visual Basic) if there are no directives are to be applied to the object node.
parent	IOpcNode	The IOpcNode used as the parent node or a null reference (Nothing in Visual Basic) in the case there is no parent node available.
name	OpcName	The OpcName through that the new history configurtion node can be accessed.
id	OpcNodeId	The OpcNodeId through that the new history configurtion node can be identified and accessed.

OpcHistoryConfigurationNode(HistoricalDataConfigurationState)

protected · since v2.50

Initializes a new instance of the OpcHistoryConfigurationNode class using the content as the instance to wrap.

protected OpcHistoryConfigurationNode(HistoricalDataConfigurationState content)

Protected Sub New(content As HistoricalDataConfigurationState)

Parameters

Name	Type	Description
content	HistoricalDataConfigurationState	The HistoricalDataConfigurationState to wrap.

Exceptions

Exception	Condition
ArgumentNullException	The content is a null reference (Nothing in Visual Basic).

OpcHistoryConfigurationNode(HistoricalDataConfigurationState, OpcNodeModel)

protected · since v2.50

Initializes a new instance of the OpcHistoryConfigurationNode class using the content as the instance to wrap.

protected OpcHistoryConfigurationNode(
    HistoricalDataConfigurationState content,
    OpcNodeModel model)

Protected Sub New(
    content As HistoricalDataConfigurationState,
    model As OpcNodeModel)

Parameters

Name	Type	Description
content	HistoricalDataConfigurationState	The HistoricalDataConfigurationState to wrap.
model	OpcNodeModel	The OpcNodeModel which defines the modelling directives for the new object node or a null reference (Nothing in Visual Basic) if there are no directives are to be applied to the object node.

Exceptions

Exception	Condition
ArgumentNullException	The content is a null reference (Nothing in Visual Basic).

Properties

AggregateConfiguration

Gets the node used as the browse entry point for information on how the server treats aggregate specific functionality such as handling uncertain data.

public OpcAggregateConfigurationNode AggregateConfiguration { get; }

Public ReadOnly Property AggregateConfiguration As OpcAggregateConfigurationNode

Property value

OpcAggregateConfigurationNode

An instance of the OpcAggregateConfigurationNode for information on how the server treats aggregate specific functionality.

AggregateFunctions

Gets the node used as an entry point to browse to all aggregate capabilities supported by the server for historical access.

public OpcFolderNode AggregateFunctions { get; }

Public ReadOnly Property AggregateFunctions As OpcFolderNode

Property value

OpcFolderNode

An instance of the OpcFolderNode with all history aggregates supported by the server. If the server does not support aggregates then the folder is left empty.

DefaultTypeDefinitionId

protected · override

Gets the default identifier which identifies the node that defines the underlying node type from that this OpcInstanceNode has been created.

protected override OpcNodeId DefaultTypeDefinitionId { get; }

Protected Overrides ReadOnly Property DefaultTypeDefinitionId As OpcNodeId

Property value

OpcNodeId

The OpcNodeId of the type node from that this OpcInstanceNode has been created from. These type node defines the typical structure of an instance node of its type definition. If there exists no specific type definition node a null reference (Nothing in Visual Basic).

Overrides

DefaultTypeDefinitionId

Definition

Gets or sets is a vendor-specific, human readable string that specifies how the value of this historical data node is calculated.

public string Definition { get; set; }

Public Property Definition As String

Property value

String

A non-localized value which will often contain an equation that can be parsed by certain client.

DefinitionNode

Gets the OpcPropertyNode<T> of the Definition property.

public OpcPropertyNode<string> DefinitionNode { get; }

Public ReadOnly Property DefinitionNode As OpcPropertyNode(Of String)

Property value

OpcPropertyNode<String>

An instance of the OpcPropertyNode<T> class.

ExceptionDeviation

Gets or sets a value which specifies the minimum amount that the data for the historical data node must change in order for the change to be reported to the history database.

public double ExceptionDeviation { get; set; }

Public Property ExceptionDeviation As Double

Property value

Double

The minimum amount that the data node must change in order for the change to be reported to the history database.

ExceptionDeviationFormat

Gets or sets the format how the ExceptionDeviation is determined.

public OpcExceptionDeviationFormat ExceptionDeviationFormat { get; set; }

Public Property ExceptionDeviationFormat As OpcExceptionDeviationFormat

Property value

OpcExceptionDeviationFormat

One of the members defined by the OpcExceptionDeviationFormat enumeration.

ExceptionDeviationFormatNode

Gets the OpcPropertyNode<T> of the ExceptionDeviationFormat property.

public OpcPropertyNode<ExceptionDeviationFormat> ExceptionDeviationFormatNode { get; }

Public ReadOnly Property ExceptionDeviationFormatNode As OpcPropertyNode(Of ExceptionDeviationFormat)

Property value

OpcPropertyNode<ExceptionDeviationFormat>

An instance of the OpcPropertyNode<T> class.

ExceptionDeviationNode

Gets the OpcPropertyNode<T> of the ExceptionDeviation property.

public OpcPropertyNode<double> ExceptionDeviationNode { get; }

Public ReadOnly Property ExceptionDeviationNode As OpcPropertyNode(Of Double)

Property value

OpcPropertyNode<Double>

An instance of the OpcPropertyNode<T> class.

MaxTimeInterval

Gets or sets which specifies the maximum interval between data points in the history repository regardless of their value change.

public double MaxTimeInterval { get; set; }

Public Property MaxTimeInterval As Double

Property value

Double

The maximum interval between data points.

MaxTimeIntervalNode

Gets the OpcPropertyNode<T> of the MaxTimeInterval property.

public OpcPropertyNode<double> MaxTimeIntervalNode { get; }

Public ReadOnly Property MaxTimeIntervalNode As OpcPropertyNode(Of Double)

Property value

OpcPropertyNode<Double>

An instance of the OpcPropertyNode<T> class.

MinTimeInterval

Gets or sets which specifies the minimum interval between data points in the history repository regardless of their value change.

public double MinTimeInterval { get; set; }

Public Property MinTimeInterval As Double

Property value

Double

The minimum interval between data points.

MinTimeIntervalNode

Gets the OpcPropertyNode<T> of the MinTimeInterval property.

public OpcPropertyNode<double> MinTimeIntervalNode { get; }

Public ReadOnly Property MinTimeIntervalNode As OpcPropertyNode(Of Double)

Property value

OpcPropertyNode<Double>

An instance of the OpcPropertyNode<T> class.

StartOfArchive

Gets or sets a value which specifies the date before which there is no data in the archive either online or offline.

public DateTime StartOfArchive { get; set; }

Public Property StartOfArchive As Date

Property value

DateTime

The DateTime before which there is no data in the archive either online or offline.

StartOfArchiveNode

Gets the OpcPropertyNode<T> of the StartOfArchive property.

public OpcPropertyNode<DateTime> StartOfArchiveNode { get; }

Public ReadOnly Property StartOfArchiveNode As OpcPropertyNode(Of Date)

Property value

OpcPropertyNode<DateTime>

An instance of the OpcPropertyNode<T> class.

StartOfOnlineArchive

Gets or sets a value which specifies the date of the earliest data in the online archive.

public DateTime StartOfOnlineArchive { get; set; }

Public Property StartOfOnlineArchive As Date

Property value

DateTime

The DateTime of the date of the earliest data in the online archive.

StartOfOnlineArchiveNode

Gets the OpcPropertyNode<T> of the StartOfOnlineArchive property.

public OpcPropertyNode<DateTime> StartOfOnlineArchiveNode { get; }

Public ReadOnly Property StartOfOnlineArchiveNode As OpcPropertyNode(Of Date)

Property value

OpcPropertyNode<DateTime>

An instance of the OpcPropertyNode<T> class.

Stepped

Gets or sets a value indicating whether the historical data was collected in such a manner that it should be displayed as sloped interpolation (sloped line between points) or as stepped interpolation (vertically-connected horizontal lines between points) when raw data is examined.

public bool Stepped { get; set; }

Public Property Stepped As Boolean

Property value

Boolean

A value of true indicates stepped interpolation mode. A value equals false indicates sloped interpolated mode. The default value is false.

Remarks

This property also effects how some aggregates are calculated.

SteppedNode

Gets the OpcPropertyNode<T> of the Stepped property.

public OpcPropertyNode<bool> SteppedNode { get; }

Public ReadOnly Property SteppedNode As OpcPropertyNode(Of Boolean)

Property value

OpcPropertyNode<Boolean>

An instance of the OpcPropertyNode<T> class.

Methods

InitializeDefaults

protected · override

Initializes the default values used by the OpcHistoryConfigurationNode.

protected override void InitializeDefaults()

Protected Overrides Sub InitializeDefaults()

Overrides

InitializeDefaults

Remarks

This method is used to ensure the availability of appropriate node specific default values. For more information like when this method is to be overwritten see InitializeDefaults.