Module org.eclipse.milo.opcua.sdk.client
Package org.eclipse.milo.opcua.sdk.client.model.objects

Interface StateType

All Superinterfaces:
BaseObjectType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.ObjectNode
All Known Subinterfaces:
ChoiceStateType, InitialStateType
All Known Implementing Classes:
ChoiceStateTypeNode, InitialStateTypeNode, StateTypeNode
public interface StateType extends BaseObjectType
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger>
    STATE_NUMBER
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger
    getStateNumber()
    Get the local value of the StateNumber Node.
    PropertyType
    getStateNumberNode()
    Get the StateNumber PropertyType Node, or null if it does not exist.
    CompletableFuture<? extends PropertyType>
    getStateNumberNodeAsync()
    Asynchronous implementation of getStateNumberNode().
    org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger
    readStateNumber()
    Read the value of the StateNumber 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>
    readStateNumberAsync()
    An asynchronous implementation of readStateNumber().
    void
    setStateNumber(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value)
    Set the local value of the StateNumber Node.
    void
    writeStateNumber(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value)
    Write a new value for the StateNumber Node to the server and update the local value if the operation succeeds.
    CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>
    writeStateNumberAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value)
    An asynchronous implementation of writeStateNumber(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger).

    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.ObjectNode

    getEventNotifier, setEventNotifier

  • Field Details

    • STATE_NUMBER

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

  • Method Details

    • getStateNumber

      org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger getStateNumber() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the StateNumber Node.

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

      Returns:
      the local value of the StateNumber Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the StateNumber Node.

    • setStateNumber

      void setStateNumber(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the StateNumber Node.

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

      Parameters:
      value - the local value to set for the StateNumber Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the StateNumber Node.

    • readStateNumber

      org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger readStateNumber() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the StateNumber 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.

    • writeStateNumber

      void writeStateNumber(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the StateNumber Node to the server and update the local value if the operation succeeds.
      Parameters:
      value - the UInteger value to write to the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • readStateNumberAsync

      CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> readStateNumberAsync()
      An asynchronous implementation of readStateNumber().
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.

    • writeStateNumberAsync

      CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeStateNumberAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value)
      An asynchronous implementation of writeStateNumber(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger).
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

    • getStateNumberNode

      PropertyType getStateNumberNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the StateNumber PropertyType Node, or null if it does not exist.

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

      Returns:
      the StateNumber 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.

    • getStateNumberNodeAsync

      CompletableFuture<? extends PropertyType> getStateNumberNodeAsync()
      Asynchronous implementation of getStateNumberNode().
      Returns:
      a CompletableFuture that completes successfully with the PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.