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

Class UaMethodNode

java.lang.Object

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

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

All Implemented Interfaces:

MethodNode, Node, UaServerNode

public class UaMethodNode
extends UaNode
implements MethodNode

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UaMethodNode.UaMethodNodeBuilder

Constructor Summary

Constructors

Constructor and Description
UaMethodNode(UaNodeContext context, NodeId nodeId, QualifiedName browseName, LocalizedText displayName, LocalizedText description, UInteger writeMask, UInteger userWriteMask, Boolean executable, Boolean userExecutable)

Method Summary

Modifier and Type	Method and Description
static UaMethodNode	build(UaNodeContext context, Function<UaMethodNode.UaMethodNodeBuilder,UaMethodNode> build) Build a UaMethodNode using the UaMethodNode.UaMethodNodeBuilder supplied to the build function.
static UaMethodNode.UaMethodNodeBuilder	builder(UaNodeContext context)
List<Node>	getAlwaysGeneratesEventNodes()
Object	getAttribute(AttributeId attributeId) Direct read access to the field for attributeId, bypassing the AttributeFilterChain.
@Nullable Argument[]	getInputArguments() Get the value of the InputArguments Property, if it exists.
MethodInvocationHandler	getInvocationHandler()
Optional<ObjectNode>	getModellingRuleNode()
@Nullable String	getNodeVersion() Get the value of the NodeVersion Property, if it exists.
@Nullable Argument[]	getOutputArguments() Get the value of the OutputArguments Property, if it exists.
List<Node>	getPropertyNodes()
Boolean	isExecutable()
Boolean	isUserExecutable()
void	setAttribute(AttributeId attributeId, Object value) Direct write access to the field for attributeId, bypassing the AttributeFilterChain.
void	setExecutable(Boolean executable)
void	setInputArguments(Argument[] inputArguments) Set the value of the InputArguments Property.
void	setInvocationHandler(MethodInvocationHandler handler)
void	setNodeVersion(String nodeVersion) Set the value of the NodeVersion Property.
void	setOutputArguments(Argument[] outputArguments) Set the value of the OutputArguments Property.
void	setUserExecutable(Boolean userExecutable)

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

UaMethodNode

public UaMethodNode(UaNodeContext context,
                    NodeId nodeId,
                    QualifiedName browseName,
                    LocalizedText displayName,
                    LocalizedText description,
                    UInteger writeMask,
                    UInteger userWriteMask,
                    Boolean executable,
                    Boolean userExecutable)

Method Detail

isExecutable

public Boolean isExecutable()

Specified by:

isExecutable in interface MethodNode

isUserExecutable

public Boolean isUserExecutable()

Specified by:

isUserExecutable in interface MethodNode

setExecutable

public void setExecutable(Boolean executable)

Specified by:

setExecutable in interface MethodNode

setUserExecutable

public void setUserExecutable(Boolean userExecutable)

Specified by:

setUserExecutable in interface MethodNode

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.

getPropertyNodes

public List<Node> getPropertyNodes()

getModellingRuleNode

public Optional<ObjectNode> getModellingRuleNode()

getAlwaysGeneratesEventNodes

public List<Node> getAlwaysGeneratesEventNodes()

getInvocationHandler

public MethodInvocationHandler getInvocationHandler()

setInvocationHandler

public void setInvocationHandler(MethodInvocationHandler handler)

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:

MethodNodeProperties.NodeVersion

getInputArguments

@Nullable
public @Nullable Argument[] getInputArguments()

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

Returns:

the value of the InputArguments Property, if it exists.

See Also:

MethodNodeProperties.InputArguments

getOutputArguments

@Nullable
public @Nullable Argument[] getOutputArguments()

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

Returns:

the value of the OutputArguments Property, if it exists.

See Also:

MethodNodeProperties.OutputArguments

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:

MethodNodeProperties.NodeVersion

setInputArguments

public void setInputArguments(Argument[] inputArguments)

Set the value of the InputArguments Property.

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

Parameters:

inputArguments - the value to set.

See Also:

MethodNodeProperties.InputArguments

setOutputArguments

public void setOutputArguments(Argument[] outputArguments)

Set the value of the OutputArguments Property.

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

Parameters:

outputArguments - the value to set.

See Also:

MethodNodeProperties.OutputArguments

builder

public static UaMethodNode.UaMethodNodeBuilder builder(UaNodeContext context)

Returns:

a new UaMethodNode.UaMethodNodeBuilder.

build

public static UaMethodNode build(UaNodeContext context,
                                 Function<UaMethodNode.UaMethodNodeBuilder,UaMethodNode> build)

Build a UaMethodNode using the UaMethodNode.UaMethodNodeBuilder supplied to the build function.

Parameters:

context - a UaNodeContext.

build - a function that accepts a UaMethodNode.UaMethodNodeBuilder and uses it to build and return a UaMethodNode.

Returns:

a UaMethodNode built using the supplied UaMethodNode.UaMethodNodeBuilder.