org.eclipse.milo.opcua.sdk.client.model.types.objects

Interface ProgramStateMachineType

All Superinterfaces:

BaseObjectType, FiniteStateMachineType, Node, ObjectNode, StateMachineType

All Known Implementing Classes:

ProgramStateMachineTypeNode

public interface ProgramStateMachineType
extends FiniteStateMachineType

Field Summary

Fields

Modifier and Type	Field and Description
static QualifiedProperty<Boolean>	AUTO_DELETE
static QualifiedProperty<Boolean>	CREATABLE
static QualifiedProperty<Boolean>	DELETABLE
static QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger>	INSTANCE_COUNT
static QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger>	MAX_INSTANCE_COUNT
static QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger>	MAX_RECYCLE_COUNT
static QualifiedProperty<Integer>	RECYCLE_COUNT

Method Summary

Modifier and Type	Method and Description
Boolean	getAutoDelete() Get the local value of the AutoDelete Node.
PropertyType	getAutoDeleteNode() Get the AutoDelete PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getAutoDeleteNodeAsync() Asynchronous implementation of getAutoDeleteNode().
Boolean	getCreatable() Get the local value of the Creatable Node.
PropertyType	getCreatableNode() Get the Creatable PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getCreatableNodeAsync() Asynchronous implementation of getCreatableNode().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	getCurrentState() Get the local value of the CurrentState Node.
FiniteStateVariableType	getCurrentStateNode() Get the CurrentState FiniteStateVariableType Node, or null if it does not exist.
CompletableFuture<? extends FiniteStateVariableType>	getCurrentStateNodeAsync() Asynchronous implementation of getCurrentStateNode().
Boolean	getDeletable() Get the local value of the Deletable Node.
PropertyType	getDeletableNode() Get the Deletable PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getDeletableNodeAsync() Asynchronous implementation of getDeletableNode().
BaseObjectType	getFinalResultDataNode() Get the FinalResultData BaseObjectType Node, or null if it does not exist.
CompletableFuture<? extends BaseObjectType>	getFinalResultDataNodeAsync() Asynchronous implementation of getFinalResultDataNode().
StateType	getHaltedNode() Get the Halted StateType Node, or null if it does not exist.
CompletableFuture<? extends StateType>	getHaltedNodeAsync() Asynchronous implementation of getHaltedNode().
TransitionType	getHaltedToReadyNode() Get the HaltedToReady TransitionType Node, or null if it does not exist.
CompletableFuture<? extends TransitionType>	getHaltedToReadyNodeAsync() Asynchronous implementation of getHaltedToReadyNode().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	getInstanceCount() Get the local value of the InstanceCount Node.
PropertyType	getInstanceCountNode() Get the InstanceCount PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getInstanceCountNodeAsync() Asynchronous implementation of getInstanceCountNode().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	getLastTransition() Get the local value of the LastTransition Node.
FiniteTransitionVariableType	getLastTransitionNode() Get the LastTransition FiniteTransitionVariableType Node, or null if it does not exist.
CompletableFuture<? extends FiniteTransitionVariableType>	getLastTransitionNodeAsync() Asynchronous implementation of getLastTransitionNode().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	getMaxInstanceCount() Get the local value of the MaxInstanceCount Node.
PropertyType	getMaxInstanceCountNode() Get the MaxInstanceCount PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getMaxInstanceCountNodeAsync() Asynchronous implementation of getMaxInstanceCountNode().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	getMaxRecycleCount() Get the local value of the MaxRecycleCount Node.
PropertyType	getMaxRecycleCountNode() Get the MaxRecycleCount PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getMaxRecycleCountNodeAsync() Asynchronous implementation of getMaxRecycleCountNode().
org.eclipse.milo.opcua.stack.core.types.structured.ProgramDiagnosticDataType	getProgramDiagnostics() Get the local value of the ProgramDiagnostics Node.
ProgramDiagnosticType	getProgramDiagnosticsNode() Get the ProgramDiagnostics ProgramDiagnosticType Node, or null if it does not exist.
CompletableFuture<? extends ProgramDiagnosticType>	getProgramDiagnosticsNodeAsync() Asynchronous implementation of getProgramDiagnosticsNode().
StateType	getReadyNode() Get the Ready StateType Node, or null if it does not exist.
CompletableFuture<? extends StateType>	getReadyNodeAsync() Asynchronous implementation of getReadyNode().
TransitionType	getReadyToHaltedNode() Get the ReadyToHalted TransitionType Node, or null if it does not exist.
CompletableFuture<? extends TransitionType>	getReadyToHaltedNodeAsync() Asynchronous implementation of getReadyToHaltedNode().
TransitionType	getReadyToRunningNode() Get the ReadyToRunning TransitionType Node, or null if it does not exist.
CompletableFuture<? extends TransitionType>	getReadyToRunningNodeAsync() Asynchronous implementation of getReadyToRunningNode().
Integer	getRecycleCount() Get the local value of the RecycleCount Node.
PropertyType	getRecycleCountNode() Get the RecycleCount PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getRecycleCountNodeAsync() Asynchronous implementation of getRecycleCountNode().
StateType	getRunningNode() Get the Running StateType Node, or null if it does not exist.
CompletableFuture<? extends StateType>	getRunningNodeAsync() Asynchronous implementation of getRunningNode().
TransitionType	getRunningToHaltedNode() Get the RunningToHalted TransitionType Node, or null if it does not exist.
CompletableFuture<? extends TransitionType>	getRunningToHaltedNodeAsync() Asynchronous implementation of getRunningToHaltedNode().
TransitionType	getRunningToReadyNode() Get the RunningToReady TransitionType Node, or null if it does not exist.
CompletableFuture<? extends TransitionType>	getRunningToReadyNodeAsync() Asynchronous implementation of getRunningToReadyNode().
TransitionType	getRunningToSuspendedNode() Get the RunningToSuspended TransitionType Node, or null if it does not exist.
CompletableFuture<? extends TransitionType>	getRunningToSuspendedNodeAsync() Asynchronous implementation of getRunningToSuspendedNode().
StateType	getSuspendedNode() Get the Suspended StateType Node, or null if it does not exist.
CompletableFuture<? extends StateType>	getSuspendedNodeAsync() Asynchronous implementation of getSuspendedNode().
TransitionType	getSuspendedToHaltedNode() Get the SuspendedToHalted TransitionType Node, or null if it does not exist.
CompletableFuture<? extends TransitionType>	getSuspendedToHaltedNodeAsync() Asynchronous implementation of getSuspendedToHaltedNode().
TransitionType	getSuspendedToReadyNode() Get the SuspendedToReady TransitionType Node, or null if it does not exist.
CompletableFuture<? extends TransitionType>	getSuspendedToReadyNodeAsync() Asynchronous implementation of getSuspendedToReadyNode().
TransitionType	getSuspendedToRunningNode() Get the SuspendedToRunning TransitionType Node, or null if it does not exist.
CompletableFuture<? extends TransitionType>	getSuspendedToRunningNodeAsync() Asynchronous implementation of getSuspendedToRunningNode().
Boolean	readAutoDelete() Read the value of the AutoDelete Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends Boolean>	readAutoDeleteAsync() An asynchronous implementation of readAutoDelete().
Boolean	readCreatable() Read the value of the Creatable Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends Boolean>	readCreatableAsync() An asynchronous implementation of readCreatable().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	readCurrentState() Read the value of the CurrentState Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText>	readCurrentStateAsync() An asynchronous implementation of readCurrentState().
Boolean	readDeletable() Read the value of the Deletable Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends Boolean>	readDeletableAsync() An asynchronous implementation of readDeletable().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	readInstanceCount() Read the value of the InstanceCount Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger>	readInstanceCountAsync() An asynchronous implementation of readInstanceCount().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	readLastTransition() Read the value of the LastTransition Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText>	readLastTransitionAsync() An asynchronous implementation of readLastTransition().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	readMaxInstanceCount() Read the value of the MaxInstanceCount Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger>	readMaxInstanceCountAsync() An asynchronous implementation of readMaxInstanceCount().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	readMaxRecycleCount() Read the value of the MaxRecycleCount Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger>	readMaxRecycleCountAsync() An asynchronous implementation of readMaxRecycleCount().
org.eclipse.milo.opcua.stack.core.types.structured.ProgramDiagnosticDataType	readProgramDiagnostics() Read the value of the ProgramDiagnostics Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.ProgramDiagnosticDataType>	readProgramDiagnosticsAsync() An asynchronous implementation of readProgramDiagnostics().
Integer	readRecycleCount() Read the value of the RecycleCount Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends Integer>	readRecycleCountAsync() An asynchronous implementation of readRecycleCount().
void	setAutoDelete(Boolean autoDelete) Set the local value of the AutoDelete Node.
void	setCreatable(Boolean creatable) Set the local value of the Creatable Node.
void	setCurrentState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText currentState) Set the local value of the CurrentState Node.
void	setDeletable(Boolean deletable) Set the local value of the Deletable Node.
void	setInstanceCount(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger instanceCount) Set the local value of the InstanceCount Node.
void	setLastTransition(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText lastTransition) Set the local value of the LastTransition Node.
void	setMaxInstanceCount(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxInstanceCount) Set the local value of the MaxInstanceCount Node.
void	setMaxRecycleCount(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxRecycleCount) Set the local value of the MaxRecycleCount Node.
void	setProgramDiagnostics(org.eclipse.milo.opcua.stack.core.types.structured.ProgramDiagnosticDataType programDiagnostics) Set the local value of the ProgramDiagnostics Node.
void	setRecycleCount(Integer recycleCount) Set the local value of the RecycleCount Node.
void	writeAutoDelete(Boolean autoDelete) Write a new value for the AutoDelete Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeAutoDeleteAsync(Boolean autoDelete) An asynchronous implementation of writeAutoDelete(Boolean).
void	writeCreatable(Boolean creatable) Write a new value for the Creatable Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeCreatableAsync(Boolean creatable) An asynchronous implementation of writeCreatable(Boolean).
void	writeCurrentState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText currentState) Write a new value for the CurrentState Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeCurrentStateAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText currentState) An asynchronous implementation of writeCurrentState(LocalizedText).
void	writeDeletable(Boolean deletable) Write a new value for the Deletable Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeDeletableAsync(Boolean deletable) An asynchronous implementation of writeDeletable(Boolean).
void	writeInstanceCount(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger instanceCount) Write a new value for the InstanceCount Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeInstanceCountAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger instanceCount) An asynchronous implementation of writeInstanceCount(UInteger).
void	writeLastTransition(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText lastTransition) Write a new value for the LastTransition Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeLastTransitionAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText lastTransition) An asynchronous implementation of writeLastTransition(LocalizedText).
void	writeMaxInstanceCount(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxInstanceCount) Write a new value for the MaxInstanceCount Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeMaxInstanceCountAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxInstanceCount) An asynchronous implementation of writeMaxInstanceCount(UInteger).
void	writeMaxRecycleCount(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxRecycleCount) Write a new value for the MaxRecycleCount Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeMaxRecycleCountAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxRecycleCount) An asynchronous implementation of writeMaxRecycleCount(UInteger).
void	writeProgramDiagnostics(org.eclipse.milo.opcua.stack.core.types.structured.ProgramDiagnosticDataType programDiagnostics) Write a new value for the ProgramDiagnostics Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeProgramDiagnosticsAsync(org.eclipse.milo.opcua.stack.core.types.structured.ProgramDiagnosticDataType programDiagnostics) An asynchronous implementation of writeProgramDiagnostics(ProgramDiagnosticDataType).
void	writeRecycleCount(Integer recycleCount) Write a new value for the RecycleCount Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeRecycleCountAsync(Integer recycleCount) An asynchronous implementation of writeRecycleCount(Integer).

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

getEventNotifier, setEventNotifier

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

Field Detail

CREATABLE

static final QualifiedProperty<Boolean> CREATABLE

DELETABLE

static final QualifiedProperty<Boolean> DELETABLE

AUTO_DELETE

static final QualifiedProperty<Boolean> AUTO_DELETE

RECYCLE_COUNT

static final QualifiedProperty<Integer> RECYCLE_COUNT

INSTANCE_COUNT

static final QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> INSTANCE_COUNT

MAX_INSTANCE_COUNT

static final QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> MAX_INSTANCE_COUNT

MAX_RECYCLE_COUNT

static final QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> MAX_RECYCLE_COUNT

Method Detail

getCreatable

Boolean getCreatable()
              throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the Creatable Node.

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

Returns:

the local value of the Creatable Node.

Throws:

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

setCreatable

void setCreatable(Boolean creatable)
           throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the Creatable Node.

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

Parameters:

creatable - the local value to set for the Creatable Node.

Throws:

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

readCreatable

Boolean readCreatable()
               throws org.eclipse.milo.opcua.stack.core.UaException

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

Returns:

the Boolean value read from the server.

Throws:

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

writeCreatable

void writeCreatable(Boolean creatable)
             throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

creatable - the Boolean value to write to the server.

Throws:

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

readCreatableAsync

CompletableFuture<? extends Boolean> readCreatableAsync()

An asynchronous implementation of readCreatable().

Returns:

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

writeCreatableAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeCreatableAsync(Boolean creatable)

An asynchronous implementation of writeCreatable(Boolean).

Returns:

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

getCreatableNode

PropertyType getCreatableNode()
                       throws org.eclipse.milo.opcua.stack.core.UaException

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

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

Returns:

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

getCreatableNodeAsync

CompletableFuture<? extends PropertyType> getCreatableNodeAsync()

Asynchronous implementation of getCreatableNode().

Returns:

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

getDeletable

Boolean getDeletable()
              throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the Deletable Node.

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

Returns:

the local value of the Deletable Node.

Throws:

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

setDeletable

void setDeletable(Boolean deletable)
           throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the Deletable Node.

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

Parameters:

deletable - the local value to set for the Deletable Node.

Throws:

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

readDeletable

Boolean readDeletable()
               throws org.eclipse.milo.opcua.stack.core.UaException

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

Returns:

the Boolean value read from the server.

Throws:

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

writeDeletable

void writeDeletable(Boolean deletable)
             throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

deletable - the Boolean value to write to the server.

Throws:

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

readDeletableAsync

CompletableFuture<? extends Boolean> readDeletableAsync()

An asynchronous implementation of readDeletable().

Returns:

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

writeDeletableAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeDeletableAsync(Boolean deletable)

An asynchronous implementation of writeDeletable(Boolean).

Returns:

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

getDeletableNode

PropertyType getDeletableNode()
                       throws org.eclipse.milo.opcua.stack.core.UaException

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

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

Returns:

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

getDeletableNodeAsync

CompletableFuture<? extends PropertyType> getDeletableNodeAsync()

Asynchronous implementation of getDeletableNode().

Returns:

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

getAutoDelete

Boolean getAutoDelete()
               throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the AutoDelete Node.

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

Returns:

the local value of the AutoDelete Node.

Throws:

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

setAutoDelete

void setAutoDelete(Boolean autoDelete)
            throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the AutoDelete Node.

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

Parameters:

autoDelete - the local value to set for the AutoDelete Node.

Throws:

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

readAutoDelete

Boolean readAutoDelete()
                throws org.eclipse.milo.opcua.stack.core.UaException

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

Returns:

the Boolean value read from the server.

Throws:

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

writeAutoDelete

void writeAutoDelete(Boolean autoDelete)
              throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

autoDelete - the Boolean value to write to the server.

Throws:

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

readAutoDeleteAsync

CompletableFuture<? extends Boolean> readAutoDeleteAsync()

An asynchronous implementation of readAutoDelete().

Returns:

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

writeAutoDeleteAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeAutoDeleteAsync(Boolean autoDelete)

An asynchronous implementation of writeAutoDelete(Boolean).

Returns:

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

getAutoDeleteNode

PropertyType getAutoDeleteNode()
                        throws org.eclipse.milo.opcua.stack.core.UaException

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

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

Returns:

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

getAutoDeleteNodeAsync

CompletableFuture<? extends PropertyType> getAutoDeleteNodeAsync()

Asynchronous implementation of getAutoDeleteNode().

Returns:

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

getRecycleCount

Integer getRecycleCount()
                 throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the RecycleCount Node.

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

Returns:

the local value of the RecycleCount Node.

Throws:

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

setRecycleCount

void setRecycleCount(Integer recycleCount)
              throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the RecycleCount Node.

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

Parameters:

recycleCount - the local value to set for the RecycleCount Node.

Throws:

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

readRecycleCount

Integer readRecycleCount()
                  throws org.eclipse.milo.opcua.stack.core.UaException

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

Returns:

the Integer value read from the server.

Throws:

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

writeRecycleCount

void writeRecycleCount(Integer recycleCount)
                throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

recycleCount - the Integer value to write to the server.

Throws:

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

readRecycleCountAsync

CompletableFuture<? extends Integer> readRecycleCountAsync()

An asynchronous implementation of readRecycleCount().

Returns:

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

writeRecycleCountAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeRecycleCountAsync(Integer recycleCount)

An asynchronous implementation of writeRecycleCount(Integer).

Returns:

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

getRecycleCountNode

PropertyType getRecycleCountNode()
                          throws org.eclipse.milo.opcua.stack.core.UaException

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

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

Returns:

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

getRecycleCountNodeAsync

CompletableFuture<? extends PropertyType> getRecycleCountNodeAsync()

Asynchronous implementation of getRecycleCountNode().

Returns:

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

getInstanceCount

org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger getInstanceCount()
                                                                            throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the InstanceCount Node.

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

Returns:

the local value of the InstanceCount Node.

Throws:

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

setInstanceCount

void setInstanceCount(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger instanceCount)
               throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the InstanceCount Node.

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

Parameters:

instanceCount - the local value to set for the InstanceCount Node.

Throws:

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

readInstanceCount

org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger readInstanceCount()
                                                                             throws org.eclipse.milo.opcua.stack.core.UaException

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

Returns:

the UInteger value read from the server.

Throws:

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

writeInstanceCount

void writeInstanceCount(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger instanceCount)
                 throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

instanceCount - the UInteger value to write to the server.

Throws:

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

readInstanceCountAsync

CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> readInstanceCountAsync()

An asynchronous implementation of readInstanceCount().

Returns:

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

writeInstanceCountAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeInstanceCountAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger instanceCount)

An asynchronous implementation of writeInstanceCount(UInteger).

Returns:

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

getInstanceCountNode

PropertyType getInstanceCountNode()
                           throws org.eclipse.milo.opcua.stack.core.UaException

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

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

Returns:

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

getInstanceCountNodeAsync

CompletableFuture<? extends PropertyType> getInstanceCountNodeAsync()

Asynchronous implementation of getInstanceCountNode().

Returns:

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

getMaxInstanceCount

org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger getMaxInstanceCount()
                                                                               throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the MaxInstanceCount Node.

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

Returns:

the local value of the MaxInstanceCount Node.

Throws:

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

setMaxInstanceCount

void setMaxInstanceCount(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxInstanceCount)
                  throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the MaxInstanceCount Node.

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

Parameters:

maxInstanceCount - the local value to set for the MaxInstanceCount Node.

Throws:

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

readMaxInstanceCount

org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger readMaxInstanceCount()
                                                                                throws org.eclipse.milo.opcua.stack.core.UaException

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

Returns:

the UInteger value read from the server.

Throws:

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

writeMaxInstanceCount

void writeMaxInstanceCount(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxInstanceCount)
                    throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

maxInstanceCount - the UInteger value to write to the server.

Throws:

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

readMaxInstanceCountAsync

CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> readMaxInstanceCountAsync()

An asynchronous implementation of readMaxInstanceCount().

Returns:

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

writeMaxInstanceCountAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeMaxInstanceCountAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxInstanceCount)

An asynchronous implementation of writeMaxInstanceCount(UInteger).

Returns:

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

getMaxInstanceCountNode

PropertyType getMaxInstanceCountNode()
                              throws org.eclipse.milo.opcua.stack.core.UaException

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

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

Returns:

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

getMaxInstanceCountNodeAsync

CompletableFuture<? extends PropertyType> getMaxInstanceCountNodeAsync()

Asynchronous implementation of getMaxInstanceCountNode().

Returns:

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

getMaxRecycleCount

org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger getMaxRecycleCount()
                                                                              throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the MaxRecycleCount Node.

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

Returns:

the local value of the MaxRecycleCount Node.

Throws:

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

setMaxRecycleCount

void setMaxRecycleCount(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxRecycleCount)
                 throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the MaxRecycleCount Node.

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

Parameters:

maxRecycleCount - the local value to set for the MaxRecycleCount Node.

Throws:

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

readMaxRecycleCount

org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger readMaxRecycleCount()
                                                                               throws org.eclipse.milo.opcua.stack.core.UaException

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

Returns:

the UInteger value read from the server.

Throws:

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

writeMaxRecycleCount

void writeMaxRecycleCount(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxRecycleCount)
                   throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

maxRecycleCount - the UInteger value to write to the server.

Throws:

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

readMaxRecycleCountAsync

CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> readMaxRecycleCountAsync()

An asynchronous implementation of readMaxRecycleCount().

Returns:

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

writeMaxRecycleCountAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeMaxRecycleCountAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxRecycleCount)

An asynchronous implementation of writeMaxRecycleCount(UInteger).

Returns:

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

getMaxRecycleCountNode

PropertyType getMaxRecycleCountNode()
                             throws org.eclipse.milo.opcua.stack.core.UaException

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

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

Returns:

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

getMaxRecycleCountNodeAsync

CompletableFuture<? extends PropertyType> getMaxRecycleCountNodeAsync()

Asynchronous implementation of getMaxRecycleCountNode().

Returns:

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

getCurrentState

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

Get the local value of the CurrentState Node.

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

Specified by:

getCurrentState in interface FiniteStateMachineType

Specified by:

getCurrentState in interface StateMachineType

Returns:

the local value of the CurrentState Node.

Throws:

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

setCurrentState

void setCurrentState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText currentState)
              throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the CurrentState Node.

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

Specified by:

setCurrentState in interface FiniteStateMachineType

Specified by:

setCurrentState in interface StateMachineType

Parameters:

currentState - the local value to set for the CurrentState Node.

Throws:

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

readCurrentState

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

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

Specified by:

readCurrentState in interface FiniteStateMachineType

Specified by:

readCurrentState in interface StateMachineType

Returns:

the LocalizedText value read from the server.

Throws:

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

writeCurrentState

void writeCurrentState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText currentState)
                throws org.eclipse.milo.opcua.stack.core.UaException

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

Specified by:

writeCurrentState in interface FiniteStateMachineType

Specified by:

writeCurrentState in interface StateMachineType

Parameters:

currentState - the LocalizedText value to write to the server.

Throws:

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

readCurrentStateAsync

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

An asynchronous implementation of readCurrentState().

Specified by:

readCurrentStateAsync in interface FiniteStateMachineType

Specified by:

readCurrentStateAsync in interface StateMachineType

Returns:

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

writeCurrentStateAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeCurrentStateAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText currentState)

An asynchronous implementation of writeCurrentState(LocalizedText).

Specified by:

writeCurrentStateAsync in interface FiniteStateMachineType

Specified by:

writeCurrentStateAsync in interface StateMachineType

Returns:

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

getCurrentStateNode

FiniteStateVariableType getCurrentStateNode()
                                     throws org.eclipse.milo.opcua.stack.core.UaException

Get the CurrentState FiniteStateVariableType Node, or null if it does not exist.

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

Specified by:

getCurrentStateNode in interface FiniteStateMachineType

Specified by:

getCurrentStateNode in interface StateMachineType

Returns:

the CurrentState FiniteStateVariableType 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.

getCurrentStateNodeAsync

CompletableFuture<? extends FiniteStateVariableType> getCurrentStateNodeAsync()

Asynchronous implementation of getCurrentStateNode().

Specified by:

getCurrentStateNodeAsync in interface FiniteStateMachineType

Specified by:

getCurrentStateNodeAsync in interface StateMachineType

Returns:

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

getLastTransition

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

Get the local value of the LastTransition Node.

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

Specified by:

getLastTransition in interface FiniteStateMachineType

Specified by:

getLastTransition in interface StateMachineType

Returns:

the local value of the LastTransition Node.

Throws:

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

setLastTransition

void setLastTransition(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText lastTransition)
                throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the LastTransition Node.

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

Specified by:

setLastTransition in interface FiniteStateMachineType

Specified by:

setLastTransition in interface StateMachineType

Parameters:

lastTransition - the local value to set for the LastTransition Node.

Throws:

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

readLastTransition

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

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

Specified by:

readLastTransition in interface FiniteStateMachineType

Specified by:

readLastTransition in interface StateMachineType

Returns:

the LocalizedText value read from the server.

Throws:

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

writeLastTransition

void writeLastTransition(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText lastTransition)
                  throws org.eclipse.milo.opcua.stack.core.UaException

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

Specified by:

writeLastTransition in interface FiniteStateMachineType

Specified by:

writeLastTransition in interface StateMachineType

Parameters:

lastTransition - the LocalizedText value to write to the server.

Throws:

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

readLastTransitionAsync

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

An asynchronous implementation of readLastTransition().

Specified by:

readLastTransitionAsync in interface FiniteStateMachineType

Specified by:

readLastTransitionAsync in interface StateMachineType

Returns:

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

writeLastTransitionAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeLastTransitionAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText lastTransition)

An asynchronous implementation of writeLastTransition(LocalizedText).

Specified by:

writeLastTransitionAsync in interface FiniteStateMachineType

Specified by:

writeLastTransitionAsync in interface StateMachineType

Returns:

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

getLastTransitionNode

FiniteTransitionVariableType getLastTransitionNode()
                                            throws org.eclipse.milo.opcua.stack.core.UaException

Get the LastTransition FiniteTransitionVariableType Node, or null if it does not exist.

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

Specified by:

getLastTransitionNode in interface FiniteStateMachineType

Specified by:

getLastTransitionNode in interface StateMachineType

Returns:

the LastTransition FiniteTransitionVariableType 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.

getLastTransitionNodeAsync

CompletableFuture<? extends FiniteTransitionVariableType> getLastTransitionNodeAsync()

Asynchronous implementation of getLastTransitionNode().

Specified by:

getLastTransitionNodeAsync in interface FiniteStateMachineType

Specified by:

getLastTransitionNodeAsync in interface StateMachineType

Returns:

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

getProgramDiagnostics

org.eclipse.milo.opcua.stack.core.types.structured.ProgramDiagnosticDataType getProgramDiagnostics()
                                                                                            throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the ProgramDiagnostics Node.

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

Returns:

the local value of the ProgramDiagnostics Node.

Throws:

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

setProgramDiagnostics

void setProgramDiagnostics(org.eclipse.milo.opcua.stack.core.types.structured.ProgramDiagnosticDataType programDiagnostics)
                    throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the ProgramDiagnostics Node.

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

Parameters:

programDiagnostics - the local value to set for the ProgramDiagnostics Node.

Throws:

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

readProgramDiagnostics

org.eclipse.milo.opcua.stack.core.types.structured.ProgramDiagnosticDataType readProgramDiagnostics()
                                                                                             throws org.eclipse.milo.opcua.stack.core.UaException

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

Returns:

the ProgramDiagnosticDataType value read from the server.

Throws:

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

writeProgramDiagnostics

void writeProgramDiagnostics(org.eclipse.milo.opcua.stack.core.types.structured.ProgramDiagnosticDataType programDiagnostics)
                      throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

programDiagnostics - the ProgramDiagnosticDataType value to write to the server.

Throws:

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

readProgramDiagnosticsAsync

CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.ProgramDiagnosticDataType> readProgramDiagnosticsAsync()

An asynchronous implementation of readProgramDiagnostics().

Returns:

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

writeProgramDiagnosticsAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeProgramDiagnosticsAsync(org.eclipse.milo.opcua.stack.core.types.structured.ProgramDiagnosticDataType programDiagnostics)

An asynchronous implementation of writeProgramDiagnostics(ProgramDiagnosticDataType).

Returns:

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

getProgramDiagnosticsNode

ProgramDiagnosticType getProgramDiagnosticsNode()
                                         throws org.eclipse.milo.opcua.stack.core.UaException

Get the ProgramDiagnostics ProgramDiagnosticType Node, or null if it does not exist.

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

Returns:

the ProgramDiagnostics ProgramDiagnosticType 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.

getProgramDiagnosticsNodeAsync

CompletableFuture<? extends ProgramDiagnosticType> getProgramDiagnosticsNodeAsync()

Asynchronous implementation of getProgramDiagnosticsNode().

Returns:

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

getFinalResultDataNode

BaseObjectType getFinalResultDataNode()
                               throws org.eclipse.milo.opcua.stack.core.UaException

Get the FinalResultData BaseObjectType Node, or null if it does not exist.

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

Returns:

the FinalResultData BaseObjectType 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.

getFinalResultDataNodeAsync

CompletableFuture<? extends BaseObjectType> getFinalResultDataNodeAsync()

Asynchronous implementation of getFinalResultDataNode().

Returns:

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

getReadyNode

StateType getReadyNode()
                throws org.eclipse.milo.opcua.stack.core.UaException

Get the Ready StateType Node, or null if it does not exist.

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

Returns:

the Ready StateType 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.

getReadyNodeAsync

CompletableFuture<? extends StateType> getReadyNodeAsync()

Asynchronous implementation of getReadyNode().

Returns:

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

getRunningNode

StateType getRunningNode()
                  throws org.eclipse.milo.opcua.stack.core.UaException

Get the Running StateType Node, or null if it does not exist.

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

Returns:

the Running StateType 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.

getRunningNodeAsync

CompletableFuture<? extends StateType> getRunningNodeAsync()

Asynchronous implementation of getRunningNode().

Returns:

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

getSuspendedNode

StateType getSuspendedNode()
                    throws org.eclipse.milo.opcua.stack.core.UaException

Get the Suspended StateType Node, or null if it does not exist.

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

Returns:

the Suspended StateType 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.

getSuspendedNodeAsync

CompletableFuture<? extends StateType> getSuspendedNodeAsync()

Asynchronous implementation of getSuspendedNode().

Returns:

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

getHaltedNode

StateType getHaltedNode()
                 throws org.eclipse.milo.opcua.stack.core.UaException

Get the Halted StateType Node, or null if it does not exist.

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

Returns:

the Halted StateType 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.

getHaltedNodeAsync

CompletableFuture<? extends StateType> getHaltedNodeAsync()

Asynchronous implementation of getHaltedNode().

Returns:

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

getHaltedToReadyNode

TransitionType getHaltedToReadyNode()
                             throws org.eclipse.milo.opcua.stack.core.UaException

Get the HaltedToReady TransitionType Node, or null if it does not exist.

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

Returns:

the HaltedToReady TransitionType 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.

getHaltedToReadyNodeAsync

CompletableFuture<? extends TransitionType> getHaltedToReadyNodeAsync()

Asynchronous implementation of getHaltedToReadyNode().

Returns:

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

getReadyToRunningNode

TransitionType getReadyToRunningNode()
                              throws org.eclipse.milo.opcua.stack.core.UaException

Get the ReadyToRunning TransitionType Node, or null if it does not exist.

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

Returns:

the ReadyToRunning TransitionType 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.

getReadyToRunningNodeAsync

CompletableFuture<? extends TransitionType> getReadyToRunningNodeAsync()

Asynchronous implementation of getReadyToRunningNode().

Returns:

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

getRunningToHaltedNode

TransitionType getRunningToHaltedNode()
                               throws org.eclipse.milo.opcua.stack.core.UaException

Get the RunningToHalted TransitionType Node, or null if it does not exist.

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

Returns:

the RunningToHalted TransitionType 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.

getRunningToHaltedNodeAsync

CompletableFuture<? extends TransitionType> getRunningToHaltedNodeAsync()

Asynchronous implementation of getRunningToHaltedNode().

Returns:

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

getRunningToReadyNode

TransitionType getRunningToReadyNode()
                              throws org.eclipse.milo.opcua.stack.core.UaException

Get the RunningToReady TransitionType Node, or null if it does not exist.

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

Returns:

the RunningToReady TransitionType 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.

getRunningToReadyNodeAsync

CompletableFuture<? extends TransitionType> getRunningToReadyNodeAsync()

Asynchronous implementation of getRunningToReadyNode().

Returns:

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

getRunningToSuspendedNode

TransitionType getRunningToSuspendedNode()
                                  throws org.eclipse.milo.opcua.stack.core.UaException

Get the RunningToSuspended TransitionType Node, or null if it does not exist.

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

Returns:

the RunningToSuspended TransitionType 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.

getRunningToSuspendedNodeAsync

CompletableFuture<? extends TransitionType> getRunningToSuspendedNodeAsync()

Asynchronous implementation of getRunningToSuspendedNode().

Returns:

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

getSuspendedToRunningNode

TransitionType getSuspendedToRunningNode()
                                  throws org.eclipse.milo.opcua.stack.core.UaException

Get the SuspendedToRunning TransitionType Node, or null if it does not exist.

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

Returns:

the SuspendedToRunning TransitionType 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.

getSuspendedToRunningNodeAsync

CompletableFuture<? extends TransitionType> getSuspendedToRunningNodeAsync()

Asynchronous implementation of getSuspendedToRunningNode().

Returns:

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

getSuspendedToHaltedNode

TransitionType getSuspendedToHaltedNode()
                                 throws org.eclipse.milo.opcua.stack.core.UaException

Get the SuspendedToHalted TransitionType Node, or null if it does not exist.

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

Returns:

the SuspendedToHalted TransitionType 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.

getSuspendedToHaltedNodeAsync

CompletableFuture<? extends TransitionType> getSuspendedToHaltedNodeAsync()

Asynchronous implementation of getSuspendedToHaltedNode().

Returns:

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

getSuspendedToReadyNode

TransitionType getSuspendedToReadyNode()
                                throws org.eclipse.milo.opcua.stack.core.UaException

Get the SuspendedToReady TransitionType Node, or null if it does not exist.

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

Returns:

the SuspendedToReady TransitionType 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.

getSuspendedToReadyNodeAsync

CompletableFuture<? extends TransitionType> getSuspendedToReadyNodeAsync()

Asynchronous implementation of getSuspendedToReadyNode().

Returns:

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

getReadyToHaltedNode

TransitionType getReadyToHaltedNode()
                             throws org.eclipse.milo.opcua.stack.core.UaException

Get the ReadyToHalted TransitionType Node, or null if it does not exist.

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

Returns:

the ReadyToHalted TransitionType 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.

getReadyToHaltedNodeAsync

CompletableFuture<? extends TransitionType> getReadyToHaltedNodeAsync()

Asynchronous implementation of getReadyToHaltedNode().

Returns:

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