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

Interface TwoStateDiscreteType

All Superinterfaces:
BaseDataVariableType, BaseVariableType, DataItemType, DiscreteItemType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.VariableNode
All Known Implementing Classes:
TwoStateDiscreteTypeNode
public interface TwoStateDiscreteType extends DiscreteItemType
See Also:

  • Field Details

    • FALSE_STATE

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText> FALSE_STATE

    • TRUE_STATE

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText> TRUE_STATE

  • Method Details

    • getFalseState

      org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText getFalseState() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the FalseState Node.

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

      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

      void setFalseState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the FalseState Node.

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

      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

      org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText readFalseState() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the FalseState Node from the server and update the local value if the operation succeeds.
      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

      void writeFalseState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the FalseState Node to the server and update the local value if the operation succeeds.
      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

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

    • writeFalseStateAsync

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

    • getFalseStateNode

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

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

      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

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

    • getTrueState

      org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText getTrueState() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the TrueState Node.

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

      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

      void setTrueState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the TrueState Node.

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

      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

      org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText readTrueState() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the TrueState Node from the server and update the local value if the operation succeeds.
      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

      void writeTrueState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the TrueState Node to the server and update the local value if the operation succeeds.
      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

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

    • writeTrueStateAsync

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

    • getTrueStateNode

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

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

      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

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