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

Interface TwoStateVariableType

All Superinterfaces:
BaseDataVariableType, BaseVariableType, org.eclipse.milo.opcua.sdk.core.nodes.Node, StateVariableType, org.eclipse.milo.opcua.sdk.core.nodes.VariableNode
All Known Implementing Classes:
TwoStateVariableTypeNode
public interface TwoStateVariableType extends StateVariableType
See Also:

  • Field Details

    • ID

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<Boolean> ID

    • TRANSITION_TIME

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.DateTime> TRANSITION_TIME

    • EFFECTIVE_TRANSITION_TIME

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.DateTime> EFFECTIVE_TRANSITION_TIME

    • TRUE_STATE

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

    • FALSE_STATE

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

  • Method Details

    • getId

      Boolean getId() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the Id Node.

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

      Specified by:
      getId in interface StateVariableType
      Returns:
      the local value of the Id Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Id Node.

    • setId

      void setId(Boolean value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the Id Node.

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

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

    • readId

      Boolean readId() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the Id Node from the server and update the local value if the operation succeeds.
      Specified by:
      readId in interface StateVariableType
      Returns:
      the Boolean value read from the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • writeId

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

    • readIdAsync

      CompletableFuture<? extends Boolean> readIdAsync()
      An asynchronous implementation of readId().
      Specified by:
      readIdAsync in interface StateVariableType
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.

    • writeIdAsync

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

    • getIdNode

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

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

      Specified by:
      getIdNode in interface StateVariableType
      Returns:
      the Id PropertyType Node, or null if it does not exist.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Node.

    • getIdNodeAsync

      CompletableFuture<? extends PropertyType> getIdNodeAsync()
      Asynchronous implementation of getIdNode().
      Specified by:
      getIdNodeAsync in interface StateVariableType
      Returns:
      a CompletableFuture that completes successfully with the PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.

    • getTransitionTime

      org.eclipse.milo.opcua.stack.core.types.builtin.DateTime getTransitionTime() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the TransitionTime Node.

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

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

    • setTransitionTime

      void setTransitionTime(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the TransitionTime Node.

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

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

    • readTransitionTime

      org.eclipse.milo.opcua.stack.core.types.builtin.DateTime readTransitionTime() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the TransitionTime Node from the server and update the local value if the operation succeeds.
      Returns:
      the DateTime value read from the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • writeTransitionTime

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

    • readTransitionTimeAsync

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

    • writeTransitionTimeAsync

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

    • getTransitionTimeNode

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

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

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

    • getTransitionTimeNodeAsync

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

    • getEffectiveTransitionTime

      org.eclipse.milo.opcua.stack.core.types.builtin.DateTime getEffectiveTransitionTime() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the EffectiveTransitionTime Node.

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

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

    • setEffectiveTransitionTime

      void setEffectiveTransitionTime(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the EffectiveTransitionTime Node.

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

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

    • readEffectiveTransitionTime

      org.eclipse.milo.opcua.stack.core.types.builtin.DateTime readEffectiveTransitionTime() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the EffectiveTransitionTime Node from the server and update the local value if the operation succeeds.
      Returns:
      the DateTime value read from the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • writeEffectiveTransitionTime

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

    • readEffectiveTransitionTimeAsync

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

    • writeEffectiveTransitionTimeAsync

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

    • getEffectiveTransitionTimeNode

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

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

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

    • getEffectiveTransitionTimeNodeAsync

      CompletableFuture<? extends PropertyType> getEffectiveTransitionTimeNodeAsync()
      Asynchronous implementation of getEffectiveTransitionTimeNode().
      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.

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