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

Interface AlarmStateVariableType

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

  • Field Details

    • HIGHEST_ACTIVE_SEVERITY

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort> HIGHEST_ACTIVE_SEVERITY

    • HIGHEST_UNACK_SEVERITY

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort> HIGHEST_UNACK_SEVERITY

    • ACTIVE_COUNT

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> ACTIVE_COUNT

    • UNACKNOWLEDGED_COUNT

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> UNACKNOWLEDGED_COUNT

    • UNCONFIRMED_COUNT

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> UNCONFIRMED_COUNT

    • FILTER

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.structured.ContentFilter> FILTER

  • Method Details

    • getHighestActiveSeverity

      org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort getHighestActiveSeverity() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the HighestActiveSeverity Node.

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

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

    • setHighestActiveSeverity

      void setHighestActiveSeverity(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the HighestActiveSeverity Node.

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

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

    • readHighestActiveSeverity

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

    • writeHighestActiveSeverity

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

    • readHighestActiveSeverityAsync

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

    • writeHighestActiveSeverityAsync

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

    • getHighestActiveSeverityNode

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

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

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

    • getHighestActiveSeverityNodeAsync

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

    • getHighestUnackSeverity

      org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort getHighestUnackSeverity() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the HighestUnackSeverity Node.

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

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

    • setHighestUnackSeverity

      void setHighestUnackSeverity(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the HighestUnackSeverity Node.

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

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

    • readHighestUnackSeverity

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

    • writeHighestUnackSeverity

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

    • readHighestUnackSeverityAsync

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

    • writeHighestUnackSeverityAsync

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

    • getHighestUnackSeverityNode

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

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

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

    • getHighestUnackSeverityNodeAsync

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

    • getActiveCount

      org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger getActiveCount() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the ActiveCount Node.

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

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

    • setActiveCount

      void setActiveCount(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the ActiveCount Node.

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

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

    • readActiveCount

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

    • writeActiveCount

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

    • readActiveCountAsync

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

    • writeActiveCountAsync

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

    • getActiveCountNode

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

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

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

    • getActiveCountNodeAsync

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

    • getUnacknowledgedCount

      org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger getUnacknowledgedCount() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the UnacknowledgedCount Node.

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

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

    • setUnacknowledgedCount

      void setUnacknowledgedCount(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the UnacknowledgedCount Node.

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

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

    • readUnacknowledgedCount

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

    • writeUnacknowledgedCount

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

    • readUnacknowledgedCountAsync

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

    • writeUnacknowledgedCountAsync

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

    • getUnacknowledgedCountNode

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

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

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

    • getUnacknowledgedCountNodeAsync

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

    • getUnconfirmedCount

      org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger getUnconfirmedCount() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the UnconfirmedCount Node.

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

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

    • setUnconfirmedCount

      void setUnconfirmedCount(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the UnconfirmedCount Node.

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

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

    • readUnconfirmedCount

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

    • writeUnconfirmedCount

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

    • readUnconfirmedCountAsync

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

    • writeUnconfirmedCountAsync

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

    • getUnconfirmedCountNode

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

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

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

    • getUnconfirmedCountNodeAsync

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

    • getFilter

      org.eclipse.milo.opcua.stack.core.types.structured.ContentFilter getFilter() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the Filter Node.

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

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

    • setFilter

      void setFilter(org.eclipse.milo.opcua.stack.core.types.structured.ContentFilter value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the Filter Node.

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

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

    • readFilter

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

    • writeFilter

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

    • readFilterAsync

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

    • writeFilterAsync

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

    • getFilterNode

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

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

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

    • getFilterNodeAsync

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