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

Interface OffNormalAlarmType

All Superinterfaces:
AcknowledgeableConditionType, AlarmConditionType, BaseEventType, BaseObjectType, ConditionType, DiscreteAlarmType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.ObjectNode
All Known Subinterfaces:
CertificateExpirationAlarmType, InstrumentDiagnosticAlarmType, SystemDiagnosticAlarmType, SystemOffNormalAlarmType, TripAlarmType, TrustListOutOfDateAlarmType
All Known Implementing Classes:
CertificateExpirationAlarmTypeNode, InstrumentDiagnosticAlarmTypeNode, OffNormalAlarmTypeNode, SystemDiagnosticAlarmTypeNode, SystemOffNormalAlarmTypeNode, TripAlarmTypeNode, TrustListOutOfDateAlarmTypeNode
public interface OffNormalAlarmType extends DiscreteAlarmType
See Also:

  • Field Details

    • NORMAL_STATE

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

  • Method Details

    • getNormalState

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

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

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

    • setNormalState

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

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

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

    • readNormalState

      org.eclipse.milo.opcua.stack.core.types.builtin.NodeId readNormalState() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the NormalState 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.

    • writeNormalState

      void writeNormalState(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the NormalState 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.

    • readNormalStateAsync

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

    • writeNormalStateAsync

      CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeNormalStateAsync(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId value)
      An asynchronous implementation of writeNormalState(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.

    • getNormalStateNode

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

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

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

    • getNormalStateNodeAsync

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