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

Interface DiscrepancyAlarmType

All Superinterfaces:
AcknowledgeableConditionType, AlarmConditionType, BaseEventType, BaseObjectType, ConditionType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.ObjectNode
All Known Implementing Classes:
DiscrepancyAlarmTypeNode
public interface DiscrepancyAlarmType extends AlarmConditionType
See Also:

  • Field Details

    • TARGET_VALUE_NODE

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> TARGET_VALUE_NODE

    • EXPECTED_TIME

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<Double> EXPECTED_TIME

    • TOLERANCE

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<Double> TOLERANCE

  • Method Details

    • getTargetValueNode

      org.eclipse.milo.opcua.stack.core.types.builtin.NodeId getTargetValueNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the TargetValueNode Node.

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

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

    • setTargetValueNode

      void setTargetValueNode(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the TargetValueNode Node.

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

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

    • readTargetValueNode

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

    • writeTargetValueNode

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

    • readTargetValueNodeAsync

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

    • writeTargetValueNodeAsync

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

    • getTargetValueNodeNode

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

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

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

    • getTargetValueNodeNodeAsync

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

    • getExpectedTime

      Double getExpectedTime() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the ExpectedTime Node.

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

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

    • setExpectedTime

      void setExpectedTime(Double value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the ExpectedTime Node.

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

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

    • readExpectedTime

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

    • writeExpectedTime

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

    • readExpectedTimeAsync

      CompletableFuture<? extends Double> readExpectedTimeAsync()
      An asynchronous implementation of readExpectedTime().
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.

    • writeExpectedTimeAsync

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

    • getExpectedTimeNode

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

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

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

    • getExpectedTimeNodeAsync

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

    • getTolerance

      Double getTolerance() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the Tolerance Node.

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

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

    • setTolerance

      void setTolerance(Double value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the Tolerance Node.

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

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

    • readTolerance

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

    • writeTolerance

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

    • readToleranceAsync

      CompletableFuture<? extends Double> readToleranceAsync()
      An asynchronous implementation of readTolerance().
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.

    • writeToleranceAsync

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

    • getToleranceNode

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

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

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

    • getToleranceNodeAsync

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