Skip to content

Reference

OpcAddNode Members

Defines an abstract base class for a single command of the IOpcAddNodesService used to add one node.

Reference

OpcAddNode Members ​

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

Inherits members from OpcNodeServiceCommand, OpcServiceCommand.

Constructors ​

OpcAddNode ​

protected · 3 overloads

OverloadDescription
OpcAddNode(OpcNodeCategory, OpcName)protectedInitializes a new instance of the OpcAddNode class using the specified category of node to add, which shall be accessible by the name defined.
OpcAddNode(OpcNodeCategory, OpcName, OpcNodeId)protectedInitializes a new instance of the OpcAddNode class using the specified category of node to add, which shall be accessible by the name and nodeId defined.
OpcAddNode(OpcNodeCategory, OpcName, OpcNodeId, OpcNodeId)protectedInitializes a new instance of the OpcAddNode class using the specified category of node to add, which shall be accessible by the name and nodeId defined.

OpcAddNode(OpcNodeCategory, OpcName) ​

protected

Initializes a new instance of the OpcAddNode class using the specified category of node to add, which shall be accessible by the name defined. The according OpcNodeId to identify and access the new node is determined by the service.

csharp
protected OpcAddNode(OpcNodeCategory category, OpcName name)
vbnet
Protected Sub New(category As OpcNodeCategory, name As OpcName)

Parameters

NameTypeDescription
categoryOpcNodeCategoryThe OpcNodeCategory which classifies the new node to add regarding one of the classifications defined by the OpcNodeCategory enumeration.
nameOpcNameThe OpcName through that the new node can be accessed.

Exceptions

ExceptionCondition
ArgumentExceptionThe name is equals Null.
ArgumentNullExceptionThe name is a null reference (Nothing in Visual Basic).

OpcAddNode(OpcNodeCategory, OpcName, OpcNodeId) ​

protected

Initializes a new instance of the OpcAddNode class using the specified category of node to add, which shall be accessible by the name and nodeId defined. The new node will be a child of the ObjectsFolder node.

csharp
protected OpcAddNode(OpcNodeCategory category, OpcName name, OpcNodeId nodeId)
vbnet
Protected Sub New(
    category As OpcNodeCategory,
    name As OpcName,
    nodeId As OpcNodeId)

Parameters

NameTypeDescription
categoryOpcNodeCategoryThe OpcNodeCategory which classifies the new node to add regarding one of the classifications defined by the OpcNodeCategory enumeration.
nameOpcNameThe OpcName through that the new node can be accessed.
nodeIdOpcNodeIdThe OpcNodeId through that the new node can be identified and accessed. In case there Null is specified the server will determine the according OpcNodeId by its own.

Exceptions

ExceptionCondition
ArgumentExceptionThe name is equals Null.
ArgumentNullExceptionThe name or nodeId is a null reference (Nothing in Visual Basic).

OpcAddNode(OpcNodeCategory, OpcName, OpcNodeId, OpcNodeId) ​

protected

Initializes a new instance of the OpcAddNode class using the specified category of node to add, which shall be accessible by the name and nodeId defined. The new node will be a child of the node identified by parentNodeId.

csharp
protected OpcAddNode(
    OpcNodeCategory category,
    OpcName name,
    OpcNodeId nodeId,
    OpcNodeId parentNodeId)
vbnet
Protected Sub New(
    category As OpcNodeCategory,
    name As OpcName,
    nodeId As OpcNodeId,
    parentNodeId As OpcNodeId)

Parameters

NameTypeDescription
categoryOpcNodeCategoryThe OpcNodeCategory which classifies the new node to add regarding one of the classifications defined by the OpcNodeCategory enumeration.
nameOpcNameThe OpcName through that the new node can be accessed.
nodeIdOpcNodeIdThe OpcNodeId through that the new node can be identified and accessed. In case there Null is specified the server will determine the according OpcNodeId by its own.
parentNodeIdOpcNodeIdThe OpcNodeId of the parent node.

Exceptions

ExceptionCondition
ArgumentExceptionThe parentNodeId is equals Null or name is equals Null.
ArgumentNullExceptionThe name, nodeId or parentNodeId is a null reference (Nothing in Visual Basic).

Properties ​

Category ​

Gets a value indicating the classification of the node in the address space.

csharp
public OpcNodeCategory Category { get; }
vbnet
Public ReadOnly Property Category As OpcNodeCategory

Property value

OpcNodeCategory

One of the members defined by the OpcNodeCategory enumeration which classifies the node within the address space.

Description ​

Gets or sets the localized description of the meaning of the node.

csharp
public OpcText Description { get; set; }
vbnet
Public Property Description As OpcText

Property value

OpcText

An instance of the OpcText class which provides the localized description of the node or a null reference (Nothing in Visual Basic). In case of a null reference (Nothing in Visual Basic) the server defined default value of the attribute is used.

DisplayName ​

Gets or sets the localized name of the node.

csharp
public OpcText DisplayName { get; set; }
vbnet
Public Property DisplayName As OpcText

Property value

OpcText

An instance of the OpcText class which provides the localized name of the node or a null reference (Nothing in Visual Basic). In case of a null reference (Nothing in Visual Basic) the server defined default value of the attribute is used.

Name ​

Gets the non-localised human-readable name of the node in the address space.

csharp
public OpcName Name { get; }
vbnet
Public ReadOnly Property Name As OpcName

Property value

OpcName

An instance of the OpcName class used to identify a node when browsing the address space.

ParentNodeId ​

Gets the identifier of the existing parent node of the new node.

csharp
public OpcNodeId ParentNodeId { get; }
vbnet
Public ReadOnly Property ParentNodeId As OpcNodeId

Property value

OpcNodeId

An instance of the OpcNodeId which identifies an existing node to use as the parent node of the new node.

SupportsNullNodeId ​

protected · override

Gets a value indicating whether the OpcAddNode supports instances of the OpcNodeId class its IsNull provides a value equals to the value true.

csharp
protected override bool SupportsNullNodeId { get; }
vbnet
Protected Overrides ReadOnly Property SupportsNullNodeId As Boolean

Property value

Boolean

The value true in the case there the OpcNodeId instance of the command can be a null-node-id; otherwise the value false.

Overrides

SupportsNullNodeId

Remarks

In case there this property provides the value false and an instance of the OpcNodeId is passed to the constructor of this class an ArgumentException will be thrown.

UserWriteAccess ​

Gets or sets a value which exposes the possibilities of a client to write the attributes of the node taking user access rights into account.

csharp
public OpcAttributeWriteAccess? UserWriteAccess { get; set; }
vbnet
Public Property UserWriteAccess As OpcAttributeWriteAccess?

Property value

Nullable<OpcAttributeWriteAccess>

One of the members defined by the OpcAttributeWriteAccess enumeration if specified; otherwise a null reference (Nothing in Visual Basic). In case of a null reference (Nothing in Visual Basic) the server defined default value of the attribute is used.

WriteAccess ​

Gets or sets a value which exposes the possibilities of a client to write the attributes of the node without taking user access rights into account.

csharp
public OpcAttributeWriteAccess? WriteAccess { get; set; }
vbnet
Public Property WriteAccess As OpcAttributeWriteAccess?

Property value

Nullable<OpcAttributeWriteAccess>

One of the members defined by the OpcAttributeWriteAccess enumeration if specified; otherwise a null reference (Nothing in Visual Basic). In case of a null reference (Nothing in Visual Basic) the server defined default value of the attribute is used.