Skip to content

Reference

OpcServerStatePropertyNode Members

Defines a property node for server state properties.

Reference

OpcServerStatePropertyNode Members ​

Type
OpcServerStatePropertyNode
Namespace
Opc.UaFx
Assembly
Opc.UaFx.Advanced.dll
Package
Opc.UaFx.Advanced v2.59.0

Inherits members from OpcPropertyNode, OpcVariableNode, OpcInstanceNode, OpcNode.

Constructors ​

OpcServerStatePropertyNode ​

10 overloads

OverloadDescription
OpcServerStatePropertyNode(OpcName)Initializes a new instance of the OpcServerStatePropertyNode class accessible by the name specified.
OpcServerStatePropertyNode(OpcName, OpcServerState)Initializes a new instance of the OpcServerStatePropertyNode class accessible by the name specified with the initial value given by value.
OpcServerStatePropertyNode(OpcName, OpcNodeId)Initializes a new instance of the OpcServerStatePropertyNode class accessible by the name and id specified.
OpcServerStatePropertyNode(OpcName, OpcNodeId, OpcServerState)Initializes a new instance of the OpcServerStatePropertyNode class accessible by the name and id specified with the initial value given by value.
OpcServerStatePropertyNode(IOpcNode, OpcName)Initializes a new instance of the OpcServerStatePropertyNode class accessible by the name specified as a child node of the parent node given.
OpcServerStatePropertyNode(IOpcNode, OpcName, OpcServerState)Initializes a new instance of the OpcServerStatePropertyNode class accessible by the name specified with the initial value defined by value as a child node of the parent node given.
OpcServerStatePropertyNode(IOpcNode, OpcName, OpcNodeId)Initializes a new instance of the OpcServerStatePropertyNode class accessible by the name and id specified as a child node of the parent node given.
OpcServerStatePropertyNode(IOpcNode, OpcName, OpcNodeId, OpcServerState)Initializes a new instance of the OpcServerStatePropertyNode class accessible by the name and id specified with the initial value defined by value as a child node of the parent node given.
OpcServerStatePropertyNode(PropertyState<ServerState>)protected · since v2.50Initializes a new instance of the OpcServerStatePropertyNode class using the content as the instance to wrap.
OpcServerStatePropertyNode(PropertyState<ServerState>, OpcNodeModel)protected · since v2.50Initializes a new instance of the OpcServerStatePropertyNode class using the content as the instance to wrap.

OpcServerStatePropertyNode(OpcName) ​

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

csharp
public OpcServerStatePropertyNode(OpcName name)
vbnet
Public Sub New(name As OpcName)

Parameters

NameTypeDescription
nameOpcNameThe OpcName through that the new server state property node can be accessed.

OpcServerStatePropertyNode(OpcName, OpcServerState) ​

Initializes a new instance of the OpcServerStatePropertyNode class accessible by the name specified with the initial value given by value.

csharp
public OpcServerStatePropertyNode(OpcName name, OpcServerState value)
vbnet
Public Sub New(name As OpcName, value As OpcServerState)

Parameters

NameTypeDescription
nameOpcNameThe OpcName through that the new server state property node can be accessed.
valueOpcServerStateThe initial value of the new server state property node.

OpcServerStatePropertyNode(OpcName, OpcNodeId) ​

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

csharp
public OpcServerStatePropertyNode(OpcName name, OpcNodeId id)
vbnet
Public Sub New(name As OpcName, id As OpcNodeId)

Parameters

NameTypeDescription
nameOpcNameThe OpcName through that the new server state property node can be accessed.
idOpcNodeIdThe OpcNodeId through that the new server state property node can be identified and accessed.

OpcServerStatePropertyNode(OpcName, OpcNodeId, OpcServerState) ​

Initializes a new instance of the OpcServerStatePropertyNode class accessible by the name and id specified with the initial value given by value.

csharp
public OpcServerStatePropertyNode(
    OpcName name,
    OpcNodeId id,
    OpcServerState value)
vbnet
Public Sub New(name As OpcName, id As OpcNodeId, value As OpcServerState)

Parameters

NameTypeDescription
nameOpcNameThe OpcName through that the new server state property node can be accessed.
idOpcNodeIdThe OpcNodeId through that the new server state property node can be identified and accessed.
valueOpcServerStateThe initial value of the new server state property node.

OpcServerStatePropertyNode(IOpcNode, OpcName) ​

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

csharp
public OpcServerStatePropertyNode(IOpcNode parent, OpcName name)
vbnet
Public Sub New(parent As IOpcNode, name As OpcName)

Parameters

NameTypeDescription
parentIOpcNodeThe IOpcNode used as the parent node or a null reference (Nothing in Visual Basic) in the case there is no parent node available.
nameOpcNameThe OpcName through that the new server state property node can be accessed.

OpcServerStatePropertyNode(IOpcNode, OpcName, OpcServerState) ​

Initializes a new instance of the OpcServerStatePropertyNode class accessible by the name specified with the initial value defined by value as a child node of the parent node given.

csharp
public OpcServerStatePropertyNode(
    IOpcNode parent,
    OpcName name,
    OpcServerState value)
vbnet
Public Sub New(parent As IOpcNode, name As OpcName, value As OpcServerState)

Parameters

NameTypeDescription
parentIOpcNodeThe IOpcNode used as the parent node or a null reference (Nothing in Visual Basic) in the case there is no parent node available.
nameOpcNameThe OpcName through that the new server state property node can be accessed.
valueOpcServerStateThe initial value of the new server state property node.

OpcServerStatePropertyNode(IOpcNode, OpcName, OpcNodeId) ​

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

csharp
public OpcServerStatePropertyNode(IOpcNode parent, OpcName name, OpcNodeId id)
vbnet
Public Sub New(parent As IOpcNode, name As OpcName, id As OpcNodeId)

Parameters

NameTypeDescription
parentIOpcNodeThe IOpcNode used as the parent node or a null reference (Nothing in Visual Basic) in the case there is no parent node available.
nameOpcNameThe OpcName through that the new server state property node can be accessed.
idOpcNodeIdThe OpcNodeId through that the new server state property node can be identified and accessed.

OpcServerStatePropertyNode(IOpcNode, OpcName, OpcNodeId, OpcServerState) ​

Initializes a new instance of the OpcServerStatePropertyNode class accessible by the name and id specified with the initial value defined by value as a child node of the parent node given.

csharp
public OpcServerStatePropertyNode(
    IOpcNode parent,
    OpcName name,
    OpcNodeId id,
    OpcServerState value)
vbnet
Public Sub New(
    parent As IOpcNode,
    name As OpcName,
    id As OpcNodeId,
    value As OpcServerState)

Parameters

NameTypeDescription
parentIOpcNodeThe IOpcNode used as the parent node or a null reference (Nothing in Visual Basic) in the case there is no parent node available.
nameOpcNameThe OpcName through that the new server state property node can be accessed.
idOpcNodeIdThe OpcNodeId through that the new server state property node can be identified and accessed.
valueOpcServerStateThe initial value of the new server state property node.

OpcServerStatePropertyNode(PropertyState<ServerState>) ​

protected · since v2.50

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

csharp
protected OpcServerStatePropertyNode(PropertyState<ServerState> content)
vbnet
Protected Sub New(content As PropertyState(Of ServerState))

Parameters

NameTypeDescription
contentPropertyState<ServerState>The PropertyState<T> to wrap.

Exceptions

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

OpcServerStatePropertyNode(PropertyState<ServerState>, OpcNodeModel) ​

protected · since v2.50

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

csharp
protected OpcServerStatePropertyNode(
    PropertyState<ServerState> content,
    OpcNodeModel model)
vbnet
Protected Sub New(
    content As PropertyState(Of ServerState),
    model As OpcNodeModel)

Parameters

NameTypeDescription
contentPropertyState<ServerState>The PropertyState<T> to wrap.
modelOpcNodeModelThe 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

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

Properties ​

ReadServerStatePropertyValueCallback ​

Gets or sets a callback used to read the server state property value.

csharp
public OpcReadServerStatePropertyValueCallback ReadServerStatePropertyValueCallback { get; set; }
vbnet
Public Property ReadServerStatePropertyValueCallback As OpcReadServerStatePropertyValueCallback

Property value

OpcReadServerStatePropertyValueCallback

A OpcReadServerStatePropertyValueCallback used to read the server state property value as the type OpcServerState. The value can also be a null reference (Nothing in Visual Basic).

Remarks

This callback is used in call chain with the ReadPropertyValueCallback and will be called with the outcome of that callback routine (in case there is one defined).

Value ​

Gets or sets the value of the property node.

csharp
public OpcServerState Value { get; set; }
vbnet
Public Property Value As OpcServerState

Property value

OpcServerState

A value of the type OpcServerState.

WriteServerStatePropertyValueCallback ​

Gets or sets a callback used to write the server state property value.

csharp
public OpcWriteServerStatePropertyValueCallback WriteServerStatePropertyValueCallback { get; set; }
vbnet
Public Property WriteServerStatePropertyValueCallback As OpcWriteServerStatePropertyValueCallback

Property value

OpcWriteServerStatePropertyValueCallback

A OpcWriteServerStatePropertyValueCallback used to write the server state property value as the type OpcServerState. The value can also be a null reference (Nothing in Visual Basic).

Remarks

This callback is used in call chain with the WritePropertyValueCallback and will be called with the outcome of that callback routine (in case there is one defined).

Methods ​

ReadPropertyValueCore ​

protected · override

Reads the value of the property node using the context and value information specified.

csharp
protected override sealed OpcPropertyValue<object> ReadPropertyValueCore(
    OpcReadPropertyValueContext context,
    OpcPropertyValue<object> value)
vbnet
Protected NotOverridable Overrides Function ReadPropertyValueCore(
    context As OpcReadPropertyValueContext,
    value As OpcPropertyValue(Of Object)) As OpcPropertyValue(Of Object)

Parameters

NameTypeDescription
contextOpcReadPropertyValueContextThe OpcReadPropertyValueContext to use to read the property node value.
valueOpcPropertyValue<Object>The OpcPropertyValue<T> containing the currently used value constructed by the value information contained in the property node cache.

Returns

OpcPropertyValue<Object>

The OpcPropertyValue<T> read using the ReadPropertyValueCallback or the value if there is no custom callback routine defined.

Overrides

ReadPropertyValueCore

ReadServerStatePropertyValueCore ​

protected · virtual

Reads the server state value of the property node using the context and value information specified.

csharp
protected virtual OpcPropertyValue<OpcServerState> ReadServerStatePropertyValueCore(
    OpcReadPropertyValueContext<OpcServerStatePropertyNode> context,
    OpcPropertyValue<OpcServerState> value)
vbnet
Protected Overridable Function ReadServerStatePropertyValueCore(
    context As OpcReadPropertyValueContext(Of OpcServerStatePropertyNode),
    value As OpcPropertyValue(Of OpcServerState)) As OpcPropertyValue(Of OpcServerState)

Parameters

NameTypeDescription
contextOpcReadPropertyValueContext<OpcServerStatePropertyNode>The OpcReadPropertyValueContext<T> to use to read the property node value.
valueOpcPropertyValue<OpcServerState>The OpcPropertyValue<T> containing the currently used value constructed by the value information contained in the property node cache.

Returns

OpcPropertyValue<OpcServerState>

The OpcPropertyValue<T> read using the ReadServerStatePropertyValueCallback or the value if there is no custom callback routine defined.

ReadServerStateValue ​

Reads the server state value of the property node.

csharp
public OpcServerState ReadServerStateValue(OpcReadVariableValueContext context)
vbnet
Public Function ReadServerStateValue(
    context As OpcReadVariableValueContext) As OpcServerState

Parameters

NameTypeDescription
contextOpcReadVariableValueContextThe OpcReadVariableValueContext to use when reading the value.

Returns

OpcServerState

The OpcServerState value of the server state property node read.

Exceptions

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

WritePropertyValueCore ​

protected · override

Writes the value of the property node using the context and value information specified.

csharp
protected override sealed OpcPropertyValue<object> WritePropertyValueCore(
    OpcWritePropertyValueContext context,
    OpcPropertyValue<object> value)
vbnet
Protected NotOverridable Overrides Function WritePropertyValueCore(
    context As OpcWritePropertyValueContext,
    value As OpcPropertyValue(Of Object)) As OpcPropertyValue(Of Object)

Parameters

NameTypeDescription
contextOpcWritePropertyValueContextThe OpcWritePropertyValueContext to use to write the property node value.
valueOpcPropertyValue<Object>The OpcPropertyValue<T> containing the currently used value constructed by the value information contained in the property node cache.

Returns

OpcPropertyValue<Object>

The OpcPropertyValue<T> written using the WritePropertyValueCallback or the value if there is no custom callback routine defined.

Overrides

WritePropertyValueCore

WriteServerStatePropertyValueCore ​

protected · virtual

Writes the server state value of the property node using the context and value information specified.

csharp
protected virtual OpcPropertyValue<OpcServerState> WriteServerStatePropertyValueCore(
    OpcWritePropertyValueContext<OpcServerStatePropertyNode> context,
    OpcPropertyValue<OpcServerState> value)
vbnet
Protected Overridable Function WriteServerStatePropertyValueCore(
    context As OpcWritePropertyValueContext(Of OpcServerStatePropertyNode),
    value As OpcPropertyValue(Of OpcServerState)) As OpcPropertyValue(Of OpcServerState)

Parameters

NameTypeDescription
contextOpcWritePropertyValueContext<OpcServerStatePropertyNode>The OpcWritePropertyValueContext<T> to use to write the property node value.
valueOpcPropertyValue<OpcServerState>The OpcPropertyValue<T> containing the currently used value constructed by the value information contained in the property node cache.

Returns

OpcPropertyValue<OpcServerState>

The OpcPropertyValue<T> written using the WriteServerStatePropertyValueCallback or the value if there is no custom callback routine defined.

WriteServerStateValue ​

Writes the value of the property node specified by value.

csharp
public void WriteServerStateValue(
    OpcWriteVariableValueContext context,
    OpcServerState value)
vbnet
Public Sub WriteServerStateValue(
    context As OpcWriteVariableValueContext,
    value As OpcServerState)

Parameters

NameTypeDescription
contextOpcWriteVariableValueContextThe OpcWriteVariableValueContext to use when writing the value.
valueOpcServerStateThe OpcServerState value of the server state property node to write.

Exceptions

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