org.eclipse.milo.opcua.sdk.client.model.nodes.variables

Class FiniteTransitionVariableTypeNode

java.lang.Object

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

org.eclipse.milo.opcua.sdk.client.nodes.UaVariableNode

org.eclipse.milo.opcua.sdk.client.model.nodes.variables.BaseVariableTypeNode

org.eclipse.milo.opcua.sdk.client.model.nodes.variables.BaseDataVariableTypeNode

org.eclipse.milo.opcua.sdk.client.model.nodes.variables.TransitionVariableTypeNode

org.eclipse.milo.opcua.sdk.client.model.nodes.variables.FiniteTransitionVariableTypeNode

All Implemented Interfaces:

BaseDataVariableType, BaseVariableType, FiniteTransitionVariableType, TransitionVariableType, Node, VariableNode

public class FiniteTransitionVariableTypeNode
extends TransitionVariableTypeNode
implements FiniteTransitionVariableType

Field Summary

Fields inherited from class org.eclipse.milo.opcua.sdk.client.nodes.UaNode

client

Fields inherited from interface org.eclipse.milo.opcua.sdk.client.model.types.variables.FiniteTransitionVariableType

ID

Fields inherited from interface org.eclipse.milo.opcua.sdk.client.model.types.variables.TransitionVariableType

EFFECTIVE_TRANSITION_TIME, NAME, NUMBER, TRANSITION_TIME

Constructor Summary

Constructors

Constructor and Description

FiniteTransitionVariableTypeNode(OpcUaClient client, org.eclipse.milo.opcua.stack.core.types.builtin.NodeId nodeId, org.eclipse.milo.opcua.stack.core.types.enumerated.NodeClass nodeClass, org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName browseName, org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText displayName, org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText description, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger writeMask, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger userWriteMask, org.eclipse.milo.opcua.stack.core.types.builtin.DataValue value, org.eclipse.milo.opcua.stack.core.types.builtin.NodeId dataType, Integer valueRank, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger[] arrayDimensions, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte accessLevel, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte userAccessLevel, Double minimumSamplingInterval, Boolean historizing)

Method Summary

Modifier and Type	Method and Description
org.eclipse.milo.opcua.stack.core.types.builtin.NodeId	getId() Get the local value of the Id Node.
PropertyTypeNode	getIdNode() Get the Id PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getIdNodeAsync() Asynchronous implementation of TransitionVariableType.getIdNode().
org.eclipse.milo.opcua.stack.core.types.builtin.NodeId	readId() Read the value of the Id Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.NodeId>	readIdAsync() An asynchronous implementation of TransitionVariableType.readId().
void	setId(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId id) Set the local value of the Id Node.
void	writeId(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId id) Write a new value for the Id Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeIdAsync(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId id) An asynchronous implementation of FiniteTransitionVariableType.writeId(NodeId).

Methods inherited from class org.eclipse.milo.opcua.sdk.client.model.nodes.variables.TransitionVariableTypeNode

getEffectiveTransitionTime, getEffectiveTransitionTimeNode, getEffectiveTransitionTimeNodeAsync, getName, getNameNode, getNameNodeAsync, getNumber, getNumberNode, getNumberNodeAsync, getTransitionTime, getTransitionTimeNode, getTransitionTimeNodeAsync, readEffectiveTransitionTime, readEffectiveTransitionTimeAsync, readName, readNameAsync, readNumber, readNumberAsync, readTransitionTime, readTransitionTimeAsync, setEffectiveTransitionTime, setId, setName, setNumber, setTransitionTime, writeEffectiveTransitionTime, writeEffectiveTransitionTimeAsync, writeId, writeIdAsync, writeName, writeNameAsync, writeNumber, writeNumberAsync, writeTransitionTime, writeTransitionTimeAsync

Methods inherited from class org.eclipse.milo.opcua.sdk.client.nodes.UaVariableNode

getAccessLevel, getArrayDimensions, getAttributeValue, getDataType, getHistorizing, getMinimumSamplingInterval, getTypeDefinition, getTypeDefinitionAsync, getUserAccessLevel, getValue, getValueRank, getVariableComponent, getVariableComponent, getVariableComponent, getVariableComponentAsync, getVariableComponentAsync, getVariableComponentAsync, readAccessLevel, readAllowNullsAsync, readArrayDimensions, readDataType, readDataTypeVersionAsync, readDictionaryFragmentAsync, readEngineeringUnitsAsync, readHistorizing, readLocalTimeAsync, readMaxArrayLengthAsync, readMaxStringLengthAsync, readMinimumSamplingInterval, readNodeVersionAsync, readUserAccessLevel, readValue, readValueAsTextAsync, readValueRank, setAccessLevel, setArrayDimensions, setAttributeValue, setDataType, setHistorizing, setMinimumSamplingInterval, setUserAccessLevel, setValue, setValue, setValueRank, writeAccessLevel, writeAllowNullsAsync, writeArrayDimensions, writeDataType, writeDataTypeVersionAsync, writeDictionaryFragmentAsync, writeEngineeringUnitsAsync, writeHistorizing, writeLocalTimeAsync, writeMaxArrayLengthAsync, writeMaxStringLengthAsync, writeMinimumSamplingInterval, writeNodeVersionAsync, writeUserAccessLevel, writeValue, writeValue, writeValueAsTextAsync, writeValueRank

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

browse, browse, browseAsync, browseAsync, browseNodes, browseNodes, browseNodesAsync, browseNodesAsync, canonicalize, cast, findMemberNodeId, getBrowseName, getComponentAsync, getDescription, getDisplayName, getMemberNodeAsync, getNodeClass, getNodeId, getProperty, getPropertyNodeAsync, getPropertyNodeAsync, getUserWriteMask, getWriteMask, invalidate, readAttribute, readAttributeAsync, readBrowseName, readDescription, readDisplayName, readNamespaceIndex, readNodeClass, readNodeId, readProperty, readUserWriteMask, readWriteMask, refresh, refreshAsync, setBrowseName, setDescription, setDisplayName, setNodeClass, setNodeId, setProperty, setUserWriteMask, setWriteMask, synchronize, synchronizeAsync, writeAttribute, writeAttributeAsync, writeBrowseName, writeDescription, writeDisplayName, writeNodeClass, writeNodeId, writeProperty, writeUserWriteMask, writeWriteMask

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.client.model.types.variables.TransitionVariableType

getEffectiveTransitionTime, getEffectiveTransitionTimeNode, getEffectiveTransitionTimeNodeAsync, getName, getNameNode, getNameNodeAsync, getNumber, getNumberNode, getNumberNodeAsync, getTransitionTime, getTransitionTimeNode, getTransitionTimeNodeAsync, readEffectiveTransitionTime, readEffectiveTransitionTimeAsync, readName, readNameAsync, readNumber, readNumberAsync, readTransitionTime, readTransitionTimeAsync, setEffectiveTransitionTime, setId, setName, setNumber, setTransitionTime, writeEffectiveTransitionTime, writeEffectiveTransitionTimeAsync, writeId, writeIdAsync, writeName, writeNameAsync, writeNumber, writeNumberAsync, writeTransitionTime, writeTransitionTimeAsync

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

getAccessLevel, getArrayDimensions, getDataType, getHistorizing, getMinimumSamplingInterval, getUserAccessLevel, getValue, getValueRank, setAccessLevel, setArrayDimensions, setDataType, setHistorizing, setMinimumSamplingInterval, setUserAccessLevel, setValue, setValueRank

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

Constructor Detail

FiniteTransitionVariableTypeNode

public FiniteTransitionVariableTypeNode(OpcUaClient client,
                                        org.eclipse.milo.opcua.stack.core.types.builtin.NodeId nodeId,
                                        org.eclipse.milo.opcua.stack.core.types.enumerated.NodeClass nodeClass,
                                        org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName browseName,
                                        org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText displayName,
                                        org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText description,
                                        org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger writeMask,
                                        org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger userWriteMask,
                                        org.eclipse.milo.opcua.stack.core.types.builtin.DataValue value,
                                        org.eclipse.milo.opcua.stack.core.types.builtin.NodeId dataType,
                                        Integer valueRank,
                                        org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger[] arrayDimensions,
                                        org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte accessLevel,
                                        org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte userAccessLevel,
                                        Double minimumSamplingInterval,
                                        Boolean historizing)

Method Detail

getId

public org.eclipse.milo.opcua.stack.core.types.builtin.NodeId getId()
                                                             throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: TransitionVariableType

Get the local value of the Id Node.

The returned value is the last seen; it is not read live from the server.

Specified by:

getId in interface FiniteTransitionVariableType

Specified by:

getId in interface TransitionVariableType

Overrides:

getId in class TransitionVariableTypeNode

Returns:

the local value of the Id Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Id Node.

setId

public void setId(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId id)
           throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: FiniteTransitionVariableType

Set the local value of the Id Node.

The value is only updated locally; it is not written to the server.

Specified by:

setId in interface FiniteTransitionVariableType

Parameters:

id - the local value to set for the Id Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Id Node.

readId

public org.eclipse.milo.opcua.stack.core.types.builtin.NodeId readId()
                                                              throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: TransitionVariableType

Read the value of the Id Node from the server and update the local value if the operation succeeds.

Specified by:

readId in interface FiniteTransitionVariableType

Specified by:

readId in interface TransitionVariableType

Overrides:

readId in class TransitionVariableTypeNode

Returns:

the Object value read from the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

writeId

public void writeId(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId id)
             throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: FiniteTransitionVariableType

Write a new value for the Id Node to the server and update the local value if the operation succeeds.

Specified by:

writeId in interface FiniteTransitionVariableType

Parameters:

id - the NodeId value to write to the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

readIdAsync

public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> readIdAsync()

Description copied from interface: TransitionVariableType

An asynchronous implementation of TransitionVariableType.readId().

Specified by:

readIdAsync in interface FiniteTransitionVariableType

Specified by:

readIdAsync in interface TransitionVariableType

Overrides:

readIdAsync in class TransitionVariableTypeNode

Returns:

a CompletableFuture that completes successfully with the property value or completes exceptionally if an operation- or service-level error occurs.

writeIdAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeIdAsync(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId id)

Description copied from interface: FiniteTransitionVariableType

An asynchronous implementation of FiniteTransitionVariableType.writeId(NodeId).

Specified by:

writeIdAsync in interface FiniteTransitionVariableType

Returns:

a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

getIdNode

public PropertyTypeNode getIdNode()
                           throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: TransitionVariableType

Get the Id PropertyType Node, or null if it does not exist.

The Node is created when first accessed and cached for subsequent calls.

Specified by:

getIdNode in interface FiniteTransitionVariableType

Specified by:

getIdNode in interface TransitionVariableType

Overrides:

getIdNode in class TransitionVariableTypeNode

Returns:

the Id PropertyType Node, or null if it does not exist.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Node.

getIdNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getIdNodeAsync()

Description copied from interface: TransitionVariableType

Asynchronous implementation of TransitionVariableType.getIdNode().

Specified by:

getIdNodeAsync in interface FiniteTransitionVariableType

Specified by:

getIdNodeAsync in interface TransitionVariableType

Overrides:

getIdNodeAsync in class TransitionVariableTypeNode

Returns:

a CompletableFuture that completes successfully with the ? extends PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.