Reference

OpcAggregateConfigurationNode Members

Type

OpcAggregateConfigurationNode

Namespace

Opc.UaFx

Assembly

Opc.UaFx.Advanced.dll

Package

Opc.UaFx.Advanced v2.59.0

Inherits members from OpcObjectNode, OpcInstanceNode, OpcNode.

Constructors

OpcAggregateConfigurationNode

14 overloads

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

OpcAggregateConfigurationNode()

Initializes a new instance of the OpcAggregateConfigurationNode class.

public OpcAggregateConfigurationNode()

Public Sub New()

OpcAggregateConfigurationNode(OpcNodeModel)

since v2.50

Initializes a new instance of the OpcAggregateConfigurationNode class.

public OpcAggregateConfigurationNode(OpcNodeModel model)

Public Sub New(model As OpcNodeModel)

Parameters

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

OpcAggregateConfigurationNode(OpcName)

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

public OpcAggregateConfigurationNode(OpcName name)

Public Sub New(name As OpcName)

Parameters

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

OpcAggregateConfigurationNode(OpcNodeModel, OpcName)

since v2.50

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

public OpcAggregateConfigurationNode(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 node or a null reference (Nothing in Visual Basic) if there are no directives are to be applied to the node.
name	OpcName	The OpcName through that the new aggregate configurtion node can be accessed.

OpcAggregateConfigurationNode(OpcName, OpcNodeId)

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

public OpcAggregateConfigurationNode(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 aggregate configurtion node can be accessed.
id	OpcNodeId	The OpcNodeId through that the new aggregate configurtion node can be identified and accessed.

OpcAggregateConfigurationNode(OpcNodeModel, OpcName, OpcNodeId)

since v2.50

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

public OpcAggregateConfigurationNode(
    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 node or a null reference (Nothing in Visual Basic) if there are no directives are to be applied to the node.
name	OpcName	The OpcName through that the new aggregate configurtion node can be accessed.
id	OpcNodeId	The OpcNodeId through that the new aggregate configurtion node can be identified and accessed.

OpcAggregateConfigurationNode(IOpcNode)

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

public OpcAggregateConfigurationNode(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.

OpcAggregateConfigurationNode(OpcNodeModel, IOpcNode)

since v2.50

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

public OpcAggregateConfigurationNode(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 node or a null reference (Nothing in Visual Basic) if there are no directives are to be applied to the 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.

OpcAggregateConfigurationNode(IOpcNode, OpcName)

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

public OpcAggregateConfigurationNode(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 aggregate configurtion node can be accessed.

OpcAggregateConfigurationNode(OpcNodeModel, IOpcNode, OpcName)

since v2.50

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

public OpcAggregateConfigurationNode(
    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 node or a null reference (Nothing in Visual Basic) if there are no directives are to be applied to the 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 aggregate configurtion node can be accessed.

OpcAggregateConfigurationNode(IOpcNode, OpcName, OpcNodeId)

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

public OpcAggregateConfigurationNode(
    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 aggregate configurtion node can be accessed.
id	OpcNodeId	The OpcNodeId through that the new aggregate configurtion node can be identified and accessed.

OpcAggregateConfigurationNode(OpcNodeModel, IOpcNode, OpcName, OpcNodeId)

since v2.50

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

public OpcAggregateConfigurationNode(
    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 node or a null reference (Nothing in Visual Basic) if there are no directives are to be applied to the 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 aggregate configurtion node can be accessed.
id	OpcNodeId	The OpcNodeId through that the new aggregate configurtion node can be identified and accessed.

OpcAggregateConfigurationNode(AggregateConfigurationState)

protected · since v2.50

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

protected OpcAggregateConfigurationNode(AggregateConfigurationState content)

Protected Sub New(content As AggregateConfigurationState)

Parameters

Name	Type	Description
content	AggregateConfigurationState	The AggregateConfigurationState to wrap.

Exceptions

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

OpcAggregateConfigurationNode(AggregateConfigurationState, OpcNodeModel)

protected · since v2.50

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

protected OpcAggregateConfigurationNode(
    AggregateConfigurationState content,
    OpcNodeModel model)

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

Parameters

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

Exceptions

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

Properties

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

PercentDataBad

Gets or sets a value which indicates the minimum percentage of bad data in a given interval required for the status code for the given interval for the processed data requests to be set to bad.

public byte PercentDataBad { get; set; }

Public Property PercentDataBad As Byte

Property value

Byte

A value indicating the percentage of bad data for the processed data requests set to bad. The default value is 100.

Remarks

The PercentDataGood and PercentDataBad must follow the following relationship PercentDataGood >= (100 – PercentDataBad). If they are equal the result of the PercentDataGood calculation is used.

PercentDataBadNode

Gets the OpcPropertyNode<T> of the PercentDataBad property.

public OpcPropertyNode<byte> PercentDataBadNode { get; }

Public ReadOnly Property PercentDataBadNode As OpcPropertyNode(Of Byte)

Property value

OpcPropertyNode<Byte>

An instance of the OpcPropertyNode<T> class.

PercentDataGood

Gets or sets a value which indicates the minimum percentage of good data in a given interval required for the status code for the given interval for the processed data requests to be set to good.

public byte PercentDataGood { get; set; }

Public Property PercentDataGood As Byte

Property value

Byte

A value indicating the percentage of bad data for the processed data requests set to bad. The default value is 100.

Remarks

The PercentDataGood and PercentDataBad must follow the following relationship PercentDataGood >= (100 – PercentDataBad). If they are equal the result of the PercentDataGood calculation is used.

PercentDataGoodNode

Gets the OpcPropertyNode<T> of the PercentDataGood property.

public OpcPropertyNode<byte> PercentDataGoodNode { get; }

Public ReadOnly Property PercentDataGoodNode As OpcPropertyNode(Of Byte)

Property value

OpcPropertyNode<Byte>

An instance of the OpcPropertyNode<T> class.

TreatUncertainAsBad

Gets or sets a value indicating whether the server treats data returned with a status code severity uncertain with respect to aggregate calculations.

public bool TreatUncertainAsBad { get; set; }

Public Property TreatUncertainAsBad As Boolean

Property value

Boolean

The value true indicates the server considers the severity equivalent to bad, a value equals false indicates the server considers the severity equivalent to good, unless the aggregate definition says otherwise. The default value is true. Note that the value is still treated as uncertain when the status code for the result is calculated.

TreatUncertainAsBadNode

Gets the OpcPropertyNode<T> of the TreatUncertainAsBad property.

public OpcPropertyNode<bool> TreatUncertainAsBadNode { get; }

Public ReadOnly Property TreatUncertainAsBadNode As OpcPropertyNode(Of Boolean)

Property value

OpcPropertyNode<Boolean>

An instance of the OpcPropertyNode<T> class.

UseSlopedExtrapolation

Gets or sets a value indicating whether the server interpolates data when no boundary value exists (i.e. extrapolating into the future from the last known value).

public bool UseSlopedExtrapolation { get; set; }

Public Property UseSlopedExtrapolation As Boolean

Property value

Boolean

The value false indicates that the server will use a stepped extrapolation format, and hold the last known value constant. A value of true indicates the server will project the value using UseSlopedExtrapolation mode. The default value is false.

UseSlopedExtrapolationNode

Gets the OpcPropertyNode<T> of the UseSlopedExtrapolation property.

public OpcPropertyNode<bool> UseSlopedExtrapolationNode { get; }

Public ReadOnly Property UseSlopedExtrapolationNode As OpcPropertyNode(Of Boolean)

Property value

OpcPropertyNode<Boolean>

An instance of the OpcPropertyNode<T> class.

Methods

ApplyConfiguration

Applies the configuration specified to the aggregation setup of this OpcAggregateConfigurationNode.

public void ApplyConfiguration(OpcAggregateConfiguration configuration)

Public Sub ApplyConfiguration(configuration As OpcAggregateConfiguration)

Parameters

Name	Type	Description
configuration	OpcAggregateConfiguration	The OpcAggregateConfiguration to apply.

Exceptions

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