Module org.eclipse.milo.opcua.sdk.client

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

Class TwoStateDiscreteTypeNode

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.variables.BaseVariableTypeNode

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

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

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

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

All Implemented Interfaces:

BaseDataVariableType, BaseVariableType, DataItemType, DiscreteItemType, TwoStateDiscreteType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.VariableNode

public class TwoStateDiscreteTypeNode
extends DiscreteItemTypeNode
implements TwoStateDiscreteType

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.variables.DataItemType

DEFINITION, VALUE_PRECISION

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

FALSE_STATE, TRUE_STATE

Constructor Summary

Constructors

Constructor

Description

TwoStateDiscreteTypeNode(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.structured.RolePermissionType[] rolePermissions, org.eclipse.milo.opcua.stack.core.types.structured.RolePermissionType[] userRolePermissions, org.eclipse.milo.opcua.stack.core.types.structured.AccessRestrictionType accessRestrictions, 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, org.eclipse.milo.opcua.stack.core.types.structured.AccessLevelExType accessLevelEx)

Method Summary

Modifier and Type	Method	Description
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	getFalseState()	Get the local value of the FalseState Node.
PropertyTypeNode	getFalseStateNode()	Get the FalseState PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getFalseStateNodeAsync()	Asynchronous implementation of TwoStateDiscreteType.getFalseStateNode().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	getTrueState()	Get the local value of the TrueState Node.
PropertyTypeNode	getTrueStateNode()	Get the TrueState PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getTrueStateNodeAsync()	Asynchronous implementation of TwoStateDiscreteType.getTrueStateNode().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	readFalseState()	Read the value of the FalseState Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText>	readFalseStateAsync()	An asynchronous implementation of TwoStateDiscreteType.readFalseState().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	readTrueState()	Read the value of the TrueState Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText>	readTrueStateAsync()	An asynchronous implementation of TwoStateDiscreteType.readTrueState().
void	setFalseState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value)	Set the local value of the FalseState Node.
void	setTrueState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value)	Set the local value of the TrueState Node.
void	writeFalseState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value)	Write a new value for the FalseState Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeFalseStateAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText falseState)	An asynchronous implementation of TwoStateDiscreteType.writeFalseState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText).
void	writeTrueState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value)	Write a new value for the TrueState Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeTrueStateAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText trueState)	An asynchronous implementation of TwoStateDiscreteType.writeTrueState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText).

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

getDefinition, getDefinitionNode, getDefinitionNodeAsync, getValuePrecision, getValuePrecisionNode, getValuePrecisionNodeAsync, readDefinition, readDefinitionAsync, readValuePrecision, readValuePrecisionAsync, setDefinition, setValuePrecision, writeDefinition, writeDefinitionAsync, writeValuePrecision, writeValuePrecisionAsync

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

getAccessLevel, getAccessLevelEx, getArrayDimensions, getAttributeValue, getDataType, getHistorizing, getMinimumSamplingInterval, getTypeDefinition, getTypeDefinitionAsync, getUserAccessLevel, getValue, getValueRank, getVariableComponent, getVariableComponent, getVariableComponent, getVariableComponentAsync, getVariableComponentAsync, getVariableComponentAsync, readAccessLevel, readAccessLevelEx, readAllowNullsAsync, readArrayDimensions, readDataType, readDataTypeVersionAsync, readDictionaryFragmentAsync, readEngineeringUnitsAsync, readHistorizing, readLocalTimeAsync, readMaxArrayLengthAsync, readMaxStringLengthAsync, readMinimumSamplingInterval, readNodeVersionAsync, readUserAccessLevel, readValue, readValueAsTextAsync, readValueRank, setAccessLevel, setAccessLevelEx, setArrayDimensions, setAttributeValue, setDataType, setHistorizing, setMinimumSamplingInterval, setUserAccessLevel, setValue, setValue, setValueRank, writeAccessLevel, writeAccessLevelEx, 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, getAccessRestrictions, getBrowseName, getComponentAsync, getDescription, getDisplayName, getMemberNodeAsync, getNodeClass, getNodeId, getProperty, getPropertyNodeAsync, getPropertyNodeAsync, getRolePermissions, getUserRolePermissions, getUserWriteMask, getWriteMask, invalidate, readAccessRestrictions, readAttribute, readAttributeAsync, readBrowseName, readDescription, readDisplayName, readNamespaceIndex, readNodeClass, readNodeId, readProperty, readRolePermissions, readUserRolePermissions, readUserWriteMask, readWriteMask, refresh, refreshAsync, setAccessRestrictions, setBrowseName, setDescription, setDisplayName, setNodeClass, setNodeId, setProperty, setRolePermissions, setUserRolePermissions, setUserWriteMask, setWriteMask, synchronize, synchronizeAsync, writeAccessRestrictions, writeAttribute, writeAttributeAsync, writeBrowseName, writeDescription, writeDisplayName, writeNodeClass, writeNodeId, writeProperty, writeRolePermissions, writeUserRolePermissions, 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.variables.DataItemType

getDefinition, getDefinitionNode, getDefinitionNodeAsync, getValuePrecision, getValuePrecisionNode, getValuePrecisionNodeAsync, readDefinition, readDefinitionAsync, readValuePrecision, readValuePrecisionAsync, setDefinition, setValuePrecision, writeDefinition, writeDefinitionAsync, writeValuePrecision, writeValuePrecisionAsync

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

getAccessRestrictions, getBrowseName, getDescription, getDisplayName, getNodeClass, getNodeId, getRolePermissions, getUserRolePermissions, getUserWriteMask, getWriteMask, setAccessRestrictions, setBrowseName, setDescription, setDisplayName, setNodeClass, setNodeId, setRolePermissions, setUserRolePermissions, setUserWriteMask, setWriteMask

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

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

Constructor Details

TwoStateDiscreteTypeNode

public TwoStateDiscreteTypeNode(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.structured.RolePermissionType[] rolePermissions,
 org.eclipse.milo.opcua.stack.core.types.structured.RolePermissionType[] userRolePermissions,
 org.eclipse.milo.opcua.stack.core.types.structured.AccessRestrictionType accessRestrictions,
 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,
 org.eclipse.milo.opcua.stack.core.types.structured.AccessLevelExType accessLevelEx)

Method Details

getFalseState

public org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText getFalseState()
                                                                            throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: TwoStateDiscreteType

Get the local value of the FalseState Node.

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

Specified by:

getFalseState in interface TwoStateDiscreteType

Returns:

the local value of the FalseState Node.

Throws:

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

setFalseState

public void setFalseState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value)
                   throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: TwoStateDiscreteType

Set the local value of the FalseState Node.

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

Specified by:

setFalseState in interface TwoStateDiscreteType

Parameters:

value - the local value to set for the FalseState Node.

Throws:

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

readFalseState

public org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText readFalseState()
                                                                             throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: TwoStateDiscreteType

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

Specified by:

readFalseState in interface TwoStateDiscreteType

Returns:

the LocalizedText value read from the server.

Throws:

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

writeFalseState

public void writeFalseState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value)
                     throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: TwoStateDiscreteType

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

Specified by:

writeFalseState in interface TwoStateDiscreteType

Parameters:

value - the LocalizedText value to write to the server.

Throws:

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

readFalseStateAsync

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

Description copied from interface: TwoStateDiscreteType

An asynchronous implementation of TwoStateDiscreteType.readFalseState().

Specified by:

readFalseStateAsync in interface TwoStateDiscreteType

Returns:

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

writeFalseStateAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeFalseStateAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText falseState)

Description copied from interface: TwoStateDiscreteType

An asynchronous implementation of TwoStateDiscreteType.writeFalseState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText).

Specified by:

writeFalseStateAsync in interface TwoStateDiscreteType

Returns:

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

getFalseStateNode

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

Description copied from interface: TwoStateDiscreteType

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

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

Specified by:

getFalseStateNode in interface TwoStateDiscreteType

Returns:

the FalseState 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.

getFalseStateNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getFalseStateNodeAsync()

Description copied from interface: TwoStateDiscreteType

Asynchronous implementation of TwoStateDiscreteType.getFalseStateNode().

Specified by:

getFalseStateNodeAsync in interface TwoStateDiscreteType

Returns:

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

getTrueState

public org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText getTrueState()
                                                                           throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: TwoStateDiscreteType

Get the local value of the TrueState Node.

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

Specified by:

getTrueState in interface TwoStateDiscreteType

Returns:

the local value of the TrueState Node.

Throws:

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

setTrueState

public void setTrueState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value)
                  throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: TwoStateDiscreteType

Set the local value of the TrueState Node.

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

Specified by:

setTrueState in interface TwoStateDiscreteType

Parameters:

value - the local value to set for the TrueState Node.

Throws:

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

readTrueState

public org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText readTrueState()
                                                                            throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: TwoStateDiscreteType

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

Specified by:

readTrueState in interface TwoStateDiscreteType

Returns:

the LocalizedText value read from the server.

Throws:

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

writeTrueState

public void writeTrueState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value)
                    throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: TwoStateDiscreteType

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

Specified by:

writeTrueState in interface TwoStateDiscreteType

Parameters:

value - the LocalizedText value to write to the server.

Throws:

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

readTrueStateAsync

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

Description copied from interface: TwoStateDiscreteType

An asynchronous implementation of TwoStateDiscreteType.readTrueState().

Specified by:

readTrueStateAsync in interface TwoStateDiscreteType

Returns:

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

writeTrueStateAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeTrueStateAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText trueState)

Description copied from interface: TwoStateDiscreteType

An asynchronous implementation of TwoStateDiscreteType.writeTrueState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText).

Specified by:

writeTrueStateAsync in interface TwoStateDiscreteType

Returns:

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

getTrueStateNode

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

Description copied from interface: TwoStateDiscreteType

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

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

Specified by:

getTrueStateNode in interface TwoStateDiscreteType

Returns:

the TrueState 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.

getTrueStateNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getTrueStateNodeAsync()

Description copied from interface: TwoStateDiscreteType

Asynchronous implementation of TwoStateDiscreteType.getTrueStateNode().

Specified by:

getTrueStateNodeAsync in interface TwoStateDiscreteType

Returns:

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