com.inductiveautomation.xopc.driver.api

Interface DriverNodeBuilder

public interface DriverNodeBuilder

Method Summary

Modifier and Type	Method and Description
void	buildFolderNode(java.lang.String displayName) Builds a UA ObjectNode with a type definition of "Folder".
void	buildObjectNode(java.lang.String displayName) Builds a UA ObjectNode with a type definition of "Object".
void	buildVariableNode(java.lang.String displayName, DataType dataType, DataValue value) Builds a UA DataVariableNode (more specifically, a DriverDataVariableNode) with a type definition of "Variable".
void	buildVariableNode(java.lang.String displayName, DataType dataType, DataValue value, byte accessLevel) Builds a UA DataVariableNode (more specifically, a DriverDataVariableNode) with a type definition of "Variable".
void	buildVariableNode(java.lang.String displayName, DataType dataType, DataValue value, byte accessLevel, ValueRank valueRank, UInt32[] arrayDimensions) Builds a UA DataVariableNode (more specifically, a DriverDataVariableNode) with a type definition of "Variable".
void	buildVariableNode(java.lang.String displayName, DataType dataType, DataValue value, ValueRank valueRank, UInt32[] arrayDimensions) Builds a UA DataVariableNode (more specifically, a DriverDataVariableNode) with a type definition of "Variable".

Method Detail

buildFolderNode

void buildFolderNode(java.lang.String displayName)

Builds a UA ObjectNode with a type definition of "Folder".

Should be used to build nodes that have a BrowseNodeType of Folder.

Parameters:

displayName - The display name for this node.

buildObjectNode

void buildObjectNode(java.lang.String displayName)

Builds a UA ObjectNode with a type definition of "Object".

Should be used to build nodes that have a BrowseNodeType of Object.

Parameters:

displayName - The display name for this node.

buildVariableNode

void buildVariableNode(java.lang.String displayName,
                       DataType dataType,
                       DataValue value)

Builds a UA DataVariableNode (more specifically, a DriverDataVariableNode) with a type definition of "Variable".

The default access level will be read+write.

Should be used to build nodes with a type definition of Variable (or Property).

Parameters:

displayName - The display name of this node.

dataType - The DataType of the value.

value - The value of this node.

buildVariableNode

void buildVariableNode(java.lang.String displayName,
                       DataType dataType,
                       DataValue value,
                       byte accessLevel)

Builds a UA DataVariableNode (more specifically, a DriverDataVariableNode) with a type definition of "Variable".

Should be used to build nodes with a type definition of Variable (or Property).

Parameters:

displayName - The display name of this node.

dataType - The DataType of the value.

value - The value of this node.

accessLevel - Read = 1 << 0 Write = 1 << 1

buildVariableNode

void buildVariableNode(java.lang.String displayName,
                       DataType dataType,
                       DataValue value,
                       ValueRank valueRank,
                       UInt32[] arrayDimensions)

Builds a UA DataVariableNode (more specifically, a DriverDataVariableNode) with a type definition of "Variable".

The default access level will be read+write.

Should be used to build nodes with a type definition of Variable (or Property).

This nodes value will be an array. While the ValueRank and array dimensions must represent the array contained accurately, you must remember to "flatten" any values contained in a Variant to one-dimension.

Parameters:

displayName - The display name of this node.

dataType - The DataType of the value.

value - The value of this node.

valueRank - The ValueRank of this node.

arrayDimensions - The length of each dimension of the array.

buildVariableNode

void buildVariableNode(java.lang.String displayName,
                       DataType dataType,
                       DataValue value,
                       byte accessLevel,
                       ValueRank valueRank,
                       UInt32[] arrayDimensions)

Builds a UA DataVariableNode (more specifically, a DriverDataVariableNode) with a type definition of "Variable".

The default access level will be read+write.

Should be used to build nodes with a type definition of Variable (or Property).

This nodes value will be an array. While the ValueRank and array dimensions must represent the array contained accurately, you must remember to "flatten" any values contained in a Variant to one-dimension.

Parameters:

displayName - The display name of this node.

dataType - The DataType of the value.

value - The value of this node.

accessLevel - Read = 1 << 0 Write = 1 << 1

valueRank - The ValueRank of this node.

arrayDimensions - The length of each dimension of the array.