org.eclipse.milo.opcua.sdk.server.nodes

Class UaObjectNode

java.lang.Object

org.eclipse.milo.opcua.sdk.server.nodes.UaNode

org.eclipse.milo.opcua.sdk.server.nodes.UaObjectNode

All Implemented Interfaces:

Node, ObjectNode, UaServerNode

Direct Known Subclasses:

BaseObjectTypeNode, UaFolderNode

public class UaObjectNode
extends UaNode
implements ObjectNode

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UaObjectNode.UaObjectNodeBuilder

Constructor Summary

Constructors

Constructor and Description
UaObjectNode(UaNodeContext context, NodeId nodeId, ObjectTypeNode objectTypeNode)
UaObjectNode(UaNodeContext context, NodeId nodeId, QualifiedName browseName, LocalizedText displayName)
UaObjectNode(UaNodeContext context, NodeId nodeId, QualifiedName browseName, LocalizedText displayName, LocalizedText description, UInteger writeMask, UInteger userWriteMask)
UaObjectNode(UaNodeContext context, NodeId nodeId, QualifiedName browseName, LocalizedText displayName, LocalizedText description, UInteger writeMask, UInteger userWriteMask, UByte eventNotifier)

Method Summary

Modifier and Type	Method and Description
void	addComponent(UaNode node) Add a 'HasComponent' reference from this Object to node and an inverse 'ComponentOf' reference from node back to this Object.
static UaObjectNode	build(UaNodeContext context, Function<UaObjectNode.UaObjectNodeBuilder,UaObjectNode> build) Build a UaObjectNode using the UaObjectNode.UaObjectNodeBuilder supplied to the build function.
static UaObjectNode.UaObjectNodeBuilder	builder(UaNodeContext context) Deprecated. use UaObjectNodeBuilder#UaObjectNodeBuilder(UaNodeContext) or build(UaNodeContext, Function).
@Nullable UaMethodNode	findMethodNode(NodeId methodId)
Object	getAttribute(AttributeId attributeId) Direct read access to the field for attributeId, bypassing the AttributeFilterChain.
List<UaNode>	getComponentNodes()
UByte	getEventNotifier()
List<Node>	getEventSourceNodes()
@Nullable ByteString	getIcon() Get the value of the Icon Property, if it exists.
List<UaMethodNode>	getMethodNodes()
@Nullable NamingRuleType	getNamingRule() Get the value of the NamingRule Property, if it exists.
@Nullable String	getNodeVersion() Get the value of the NodeVersion Property, if it exists.
List<Node>	getNotifierNodes()
List<Node>	getOrganizesNodes()
List<UaNode>	getPropertyNodes()
ObjectTypeNode	getTypeDefinitionNode()
void	removeComponent(UaNode node) Remove the 'HasComponent' reference from this Object to node and the inverse 'ComponentOf' reference from node back to this Object.
void	setAttribute(AttributeId attributeId, Object value) Direct write access to the field for attributeId, bypassing the AttributeFilterChain.
void	setEventNotifier(UByte eventNotifier)
void	setIcon(ByteString icon) Set the value of the Icon Property.
void	setNamingRule(NamingRuleType namingRule) Set the value of the NamingRule Property.
void	setNodeVersion(String nodeVersion) Set the value of the NodeVersion Property.

Methods inherited from class org.eclipse.milo.opcua.sdk.server.nodes.UaNode

addAttributeObserver, addReference, delete, findNode, findNode, findNode, findNode, fireAttributeChanged, getAttribute, getAttributeDelegate, getBrowseName, getDescription, getDisplayName, getFilterChain, getManagedNode, getManagedNode, getNodeClass, getNodeContext, getNodeId, getNodeManager, getObjectComponent, getObjectComponent, getObjectComponent, getProperty, getProperty, getPropertyNode, getPropertyNode, getPropertyNode, getReferences, getUserWriteMask, getVariableComponent, getVariableComponent, getVariableComponent, getWriteMask, removeAttributeObserver, removeReference, setAttribute, setAttributeDelegate, setBrowseName, setDescription, setDisplayName, setNodeClass, setNodeId, setProperty, setUserWriteMask, setWriteMask

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.eclipse.milo.opcua.sdk.core.nodes.Node

getBrowseName, getDescription, getDisplayName, getNodeClass, getNodeId, getUserWriteMask, getWriteMask, setBrowseName, setDescription, setDisplayName, setNodeClass, setNodeId, setUserWriteMask, setWriteMask

Methods inherited from interface org.eclipse.milo.opcua.sdk.server.nodes.UaServerNode

readAttribute, readAttribute, readAttribute, writeAttribute, writeAttribute

Constructor Detail

UaObjectNode

public UaObjectNode(UaNodeContext context,
                    NodeId nodeId,
                    ObjectTypeNode objectTypeNode)

UaObjectNode

public UaObjectNode(UaNodeContext context,
                    NodeId nodeId,
                    QualifiedName browseName,
                    LocalizedText displayName)

UaObjectNode

public UaObjectNode(UaNodeContext context,
                    NodeId nodeId,
                    QualifiedName browseName,
                    LocalizedText displayName,
                    LocalizedText description,
                    UInteger writeMask,
                    UInteger userWriteMask)

UaObjectNode

public UaObjectNode(UaNodeContext context,
                    NodeId nodeId,
                    QualifiedName browseName,
                    LocalizedText displayName,
                    LocalizedText description,
                    UInteger writeMask,
                    UInteger userWriteMask,
                    UByte eventNotifier)

Method Detail

getEventNotifier

public UByte getEventNotifier()

Specified by:

getEventNotifier in interface ObjectNode

setEventNotifier

public void setEventNotifier(UByte eventNotifier)

Specified by:

setEventNotifier in interface ObjectNode

getAttribute

public Object getAttribute(AttributeId attributeId)

Description copied from class: UaNode

Direct read access to the field for attributeId, bypassing the AttributeFilterChain.

Overrides:

getAttribute in class UaNode

Parameters:

attributeId - the AttributeId to get the value for.

Returns:

the value for attributeId.

setAttribute

public void setAttribute(AttributeId attributeId,
                         Object value)

Description copied from class: UaNode

Direct write access to the field for attributeId, bypassing the AttributeFilterChain.

Setting an attribute value invokes UaNode.fireAttributeChanged(AttributeId, Object), notifying any registered AttributeObservers of the change.

Overrides:

setAttribute in class UaNode

Parameters:

attributeId - the AttributeId to set the value for.

value - the value to set.

findMethodNode

@Nullable
public @Nullable UaMethodNode findMethodNode(NodeId methodId)

getComponentNodes

public List<UaNode> getComponentNodes()

getPropertyNodes

public List<UaNode> getPropertyNodes()

getMethodNodes

public List<UaMethodNode> getMethodNodes()

getTypeDefinitionNode

public ObjectTypeNode getTypeDefinitionNode()

getEventSourceNodes

public List<Node> getEventSourceNodes()

getNotifierNodes

public List<Node> getNotifierNodes()

getOrganizesNodes

public List<Node> getOrganizesNodes()

addComponent

public void addComponent(UaNode node)

Add a 'HasComponent' reference from this Object to node and an inverse 'ComponentOf' reference from node back to this Object.

Parameters:

node - the node to add as a component of this Object.

removeComponent

public void removeComponent(UaNode node)

Remove the 'HasComponent' reference from this Object to node and the inverse 'ComponentOf' reference from node back to this Object.

Parameters:

node - the node to remove as a component of this Object.

getNodeVersion

@Nullable
public @Nullable String getNodeVersion()

Get the value of the NodeVersion Property, if it exists.

Returns:

the value of the NodeVersion Property, if it exists.

See Also:

ObjectNodeProperties.NodeVersion

getIcon

@Nullable
public @Nullable ByteString getIcon()

Get the value of the Icon Property, if it exists.

Returns:

the value of the Icon Property, if it exists.

See Also:

ObjectNodeProperties.Icon

getNamingRule

@Nullable
public @Nullable NamingRuleType getNamingRule()

Get the value of the NamingRule Property, if it exists.

Returns:

the value of the NamingRule Property, if it exists.

See Also:

ObjectNodeProperties.NamingRule

setNodeVersion

public void setNodeVersion(String nodeVersion)

Set the value of the NodeVersion Property.

A PropertyNode will be created if it does not already exist.

Parameters:

nodeVersion - the value to set.

See Also:

ObjectNodeProperties.NodeVersion

setIcon

public void setIcon(ByteString icon)

Set the value of the Icon Property.

A PropertyNode will be created if it does not already exist.

Parameters:

icon - the value to set.

See Also:

ObjectNodeProperties.Icon

setNamingRule

public void setNamingRule(NamingRuleType namingRule)

Set the value of the NamingRule Property.

A PropertyNode will be created if it does not already exist.

Parameters:

namingRule - the value to set.

See Also:

ObjectNodeProperties.NamingRule

builder

@Deprecated
public static UaObjectNode.UaObjectNodeBuilder builder(UaNodeContext context)

Deprecated. use UaObjectNodeBuilder#UaObjectNodeBuilder(UaNodeContext) or build(UaNodeContext, Function).

build

public static UaObjectNode build(UaNodeContext context,
                                 Function<UaObjectNode.UaObjectNodeBuilder,UaObjectNode> build)

Build a UaObjectNode using the UaObjectNode.UaObjectNodeBuilder supplied to the build function.

Parameters:

context - a UaNodeContext.

build - a function that accepts a UaObjectNode.UaObjectNodeBuilder and uses it to build and return a UaObjectNode.

Returns:

a UaObjectNode built using the supplied UaObjectNode.UaObjectNodeBuilder.