All Implemented Interfaces:
BaseDataVariableType, BaseVariableType, StateVariableType, TwoStateVariableType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.VariableNode

public class TwoStateVariableTypeNode extends StateVariableTypeNode implements TwoStateVariableType
  • Constructor Details

    • TwoStateVariableTypeNode

      public TwoStateVariableTypeNode(OpcUaClient client, org.eclipse.milo.opcua.stack.core.types.builtin.NodeId nodeId, org.eclipse.milo.opcua.stack.core.types.enumerated.NodeClass nodeClass, org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName browseName, org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText displayName, org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText description, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger writeMask, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger userWriteMask, org.eclipse.milo.opcua.stack.core.types.structured.RolePermissionType[] rolePermissions, org.eclipse.milo.opcua.stack.core.types.structured.RolePermissionType[] userRolePermissions, org.eclipse.milo.opcua.stack.core.types.structured.AccessRestrictionType accessRestrictions, org.eclipse.milo.opcua.stack.core.types.builtin.DataValue value, org.eclipse.milo.opcua.stack.core.types.builtin.NodeId dataType, Integer valueRank, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger[] arrayDimensions, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte accessLevel, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte userAccessLevel, Double minimumSamplingInterval, Boolean historizing, org.eclipse.milo.opcua.stack.core.types.structured.AccessLevelExType accessLevelEx)
  • Method Details

    • getId

      public Boolean getId() throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: StateVariableType
      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
      Specified by:
      getId in interface TwoStateVariableType
      Overrides:
      getId in class StateVariableTypeNode
      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

      public void setId(Boolean value) throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: TwoStateVariableType
      Set the local value of the Id Node.

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

      Specified by:
      setId in interface TwoStateVariableType
      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

      public Boolean readId() throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: StateVariableType
      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
      Specified by:
      readId in interface TwoStateVariableType
      Overrides:
      readId in class StateVariableTypeNode
      Returns:
      the Object value read from the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.
    • writeId

      public void writeId(Boolean value) throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: TwoStateVariableType
      Write a new value for the Id Node to the server and update the local value if the operation succeeds.
      Specified by:
      writeId in interface TwoStateVariableType
      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

      public CompletableFuture<? extends Boolean> readIdAsync()
      Description copied from interface: StateVariableType
      An asynchronous implementation of StateVariableType.readId().
      Specified by:
      readIdAsync in interface StateVariableType
      Specified by:
      readIdAsync in interface TwoStateVariableType
      Overrides:
      readIdAsync in class StateVariableTypeNode
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.
    • writeIdAsync

      public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeIdAsync(Boolean id)
      Description copied from interface: TwoStateVariableType
      An asynchronous implementation of TwoStateVariableType.writeId(java.lang.Boolean).
      Specified by:
      writeIdAsync in interface TwoStateVariableType
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.
    • getIdNode

      public PropertyTypeNode getIdNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: StateVariableType
      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
      Specified by:
      getIdNode in interface TwoStateVariableType
      Overrides:
      getIdNode in class StateVariableTypeNode
      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

      public CompletableFuture<? extends PropertyTypeNode> getIdNodeAsync()
      Description copied from interface: StateVariableType
      Asynchronous implementation of StateVariableType.getIdNode().
      Specified by:
      getIdNodeAsync in interface StateVariableType
      Specified by:
      getIdNodeAsync in interface TwoStateVariableType
      Overrides:
      getIdNodeAsync in class StateVariableTypeNode
      Returns:
      a CompletableFuture that completes successfully with the PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.
    • getTransitionTime

      public org.eclipse.milo.opcua.stack.core.types.builtin.DateTime getTransitionTime() throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: TwoStateVariableType
      Get the local value of the TransitionTime Node.

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

      Specified by:
      getTransitionTime in interface TwoStateVariableType
      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

      public void setTransitionTime(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime value) throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: TwoStateVariableType
      Set the local value of the TransitionTime Node.

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

      Specified by:
      setTransitionTime in interface TwoStateVariableType
      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

      public org.eclipse.milo.opcua.stack.core.types.builtin.DateTime readTransitionTime() throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: TwoStateVariableType
      Read the value of the TransitionTime Node from the server and update the local value if the operation succeeds.
      Specified by:
      readTransitionTime in interface TwoStateVariableType
      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

      public void writeTransitionTime(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime value) throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: TwoStateVariableType
      Write a new value for the TransitionTime Node to the server and update the local value if the operation succeeds.
      Specified by:
      writeTransitionTime in interface TwoStateVariableType
      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

      public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.DateTime> readTransitionTimeAsync()
      Description copied from interface: TwoStateVariableType
      An asynchronous implementation of TwoStateVariableType.readTransitionTime().
      Specified by:
      readTransitionTimeAsync in interface TwoStateVariableType
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.
    • writeTransitionTimeAsync

      public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeTransitionTimeAsync(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime transitionTime)
      Description copied from interface: TwoStateVariableType
      Specified by:
      writeTransitionTimeAsync in interface TwoStateVariableType
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.
    • getTransitionTimeNode

      public PropertyTypeNode getTransitionTimeNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: TwoStateVariableType
      Get the TransitionTime PropertyType Node, or null if it does not exist.

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

      Specified by:
      getTransitionTimeNode in interface TwoStateVariableType
      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

      public CompletableFuture<? extends PropertyTypeNode> getTransitionTimeNodeAsync()
      Description copied from interface: TwoStateVariableType
      Asynchronous implementation of TwoStateVariableType.getTransitionTimeNode().
      Specified by:
      getTransitionTimeNodeAsync in interface TwoStateVariableType
      Returns:
      a CompletableFuture that completes successfully with the PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.
    • getEffectiveTransitionTime

      public org.eclipse.milo.opcua.stack.core.types.builtin.DateTime getEffectiveTransitionTime() throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: TwoStateVariableType
      Get the local value of the EffectiveTransitionTime Node.

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

      Specified by:
      getEffectiveTransitionTime in interface TwoStateVariableType
      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

      public void setEffectiveTransitionTime(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime value) throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: TwoStateVariableType
      Set the local value of the EffectiveTransitionTime Node.

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

      Specified by:
      setEffectiveTransitionTime in interface TwoStateVariableType
      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

      public org.eclipse.milo.opcua.stack.core.types.builtin.DateTime readEffectiveTransitionTime() throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: TwoStateVariableType
      Read the value of the EffectiveTransitionTime Node from the server and update the local value if the operation succeeds.
      Specified by:
      readEffectiveTransitionTime in interface TwoStateVariableType
      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

      public void writeEffectiveTransitionTime(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime value) throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: TwoStateVariableType
      Write a new value for the EffectiveTransitionTime Node to the server and update the local value if the operation succeeds.
      Specified by:
      writeEffectiveTransitionTime in interface TwoStateVariableType
      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

      public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.DateTime> readEffectiveTransitionTimeAsync()
      Description copied from interface: TwoStateVariableType
      An asynchronous implementation of TwoStateVariableType.readEffectiveTransitionTime().
      Specified by:
      readEffectiveTransitionTimeAsync in interface TwoStateVariableType
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.
    • writeEffectiveTransitionTimeAsync

      public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeEffectiveTransitionTimeAsync(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime effectiveTransitionTime)
      Description copied from interface: TwoStateVariableType
      Specified by:
      writeEffectiveTransitionTimeAsync in interface TwoStateVariableType
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.
    • getEffectiveTransitionTimeNode

      public PropertyTypeNode getEffectiveTransitionTimeNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: TwoStateVariableType
      Get the EffectiveTransitionTime PropertyType Node, or null if it does not exist.

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

      Specified by:
      getEffectiveTransitionTimeNode in interface TwoStateVariableType
      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

      public CompletableFuture<? extends PropertyTypeNode> getEffectiveTransitionTimeNodeAsync()
      Description copied from interface: TwoStateVariableType
      Specified by:
      getEffectiveTransitionTimeNodeAsync in interface TwoStateVariableType
      Returns:
      a CompletableFuture that completes successfully with the PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.
    • getTrueState

      public org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText getTrueState() throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: TwoStateVariableType
      Get the local value of the TrueState Node.

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

      Specified by:
      getTrueState in interface TwoStateVariableType
      Returns:
      the local value of the TrueState Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the TrueState Node.
    • setTrueState

      public void setTrueState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value) throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: TwoStateVariableType
      Set the local value of the TrueState Node.

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

      Specified by:
      setTrueState in interface TwoStateVariableType
      Parameters:
      value - the local value to set for the TrueState Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the TrueState Node.
    • readTrueState

      public org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText readTrueState() throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: TwoStateVariableType
      Read the value of the TrueState Node from the server and update the local value if the operation succeeds.
      Specified by:
      readTrueState in interface TwoStateVariableType
      Returns:
      the LocalizedText value read from the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.
    • writeTrueState

      public void writeTrueState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value) throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: TwoStateVariableType
      Write a new value for the TrueState Node to the server and update the local value if the operation succeeds.
      Specified by:
      writeTrueState in interface TwoStateVariableType
      Parameters:
      value - the LocalizedText value to write to the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.
    • readTrueStateAsync

      public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText> readTrueStateAsync()
      Description copied from interface: TwoStateVariableType
      An asynchronous implementation of TwoStateVariableType.readTrueState().
      Specified by:
      readTrueStateAsync in interface TwoStateVariableType
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.
    • writeTrueStateAsync

      public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeTrueStateAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText trueState)
      Description copied from interface: TwoStateVariableType
      Specified by:
      writeTrueStateAsync in interface TwoStateVariableType
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.
    • getTrueStateNode

      public PropertyTypeNode getTrueStateNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: TwoStateVariableType
      Get the TrueState PropertyType Node, or null if it does not exist.

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

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

      public CompletableFuture<? extends PropertyTypeNode> getTrueStateNodeAsync()
      Description copied from interface: TwoStateVariableType
      Asynchronous implementation of TwoStateVariableType.getTrueStateNode().
      Specified by:
      getTrueStateNodeAsync in interface TwoStateVariableType
      Returns:
      a CompletableFuture that completes successfully with the PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.
    • getFalseState

      public org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText getFalseState() throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: TwoStateVariableType
      Get the local value of the FalseState Node.

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

      Specified by:
      getFalseState in interface TwoStateVariableType
      Returns:
      the local value of the FalseState Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the FalseState Node.
    • setFalseState

      public void setFalseState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value) throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: TwoStateVariableType
      Set the local value of the FalseState Node.

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

      Specified by:
      setFalseState in interface TwoStateVariableType
      Parameters:
      value - the local value to set for the FalseState Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the FalseState Node.
    • readFalseState

      public org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText readFalseState() throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: TwoStateVariableType
      Read the value of the FalseState Node from the server and update the local value if the operation succeeds.
      Specified by:
      readFalseState in interface TwoStateVariableType
      Returns:
      the LocalizedText value read from the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.
    • writeFalseState

      public void writeFalseState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value) throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: TwoStateVariableType
      Write a new value for the FalseState Node to the server and update the local value if the operation succeeds.
      Specified by:
      writeFalseState in interface TwoStateVariableType
      Parameters:
      value - the LocalizedText value to write to the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.
    • readFalseStateAsync

      public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText> readFalseStateAsync()
      Description copied from interface: TwoStateVariableType
      An asynchronous implementation of TwoStateVariableType.readFalseState().
      Specified by:
      readFalseStateAsync in interface TwoStateVariableType
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.
    • writeFalseStateAsync

      public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeFalseStateAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText falseState)
      Description copied from interface: TwoStateVariableType
      Specified by:
      writeFalseStateAsync in interface TwoStateVariableType
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.
    • getFalseStateNode

      public PropertyTypeNode getFalseStateNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: TwoStateVariableType
      Get the FalseState PropertyType Node, or null if it does not exist.

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

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

      public CompletableFuture<? extends PropertyTypeNode> getFalseStateNodeAsync()
      Description copied from interface: TwoStateVariableType
      Asynchronous implementation of TwoStateVariableType.getFalseStateNode().
      Specified by:
      getFalseStateNodeAsync in interface TwoStateVariableType
      Returns:
      a CompletableFuture that completes successfully with the PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.