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

Interface PubSubDiagnosticsCounterType

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

  • Field Details

    • ACTIVE

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

    • CLASSIFICATION

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.enumerated.PubSubDiagnosticsCounterClassification> CLASSIFICATION

    • DIAGNOSTICS_LEVEL

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.enumerated.DiagnosticsLevel> DIAGNOSTICS_LEVEL

    • TIME_FIRST_CHANGE

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

  • Method Details

    • getActive

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

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

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

    • setActive

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

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

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

    • readActive

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

    • writeActive

      void writeActive(Boolean value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the Active 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.

    • readActiveAsync

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

    • writeActiveAsync

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

    • getActiveNode

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

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

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

    • getActiveNodeAsync

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

    • getClassification

      org.eclipse.milo.opcua.stack.core.types.enumerated.PubSubDiagnosticsCounterClassification getClassification() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the Classification Node.

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

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

    • setClassification

      void setClassification(org.eclipse.milo.opcua.stack.core.types.enumerated.PubSubDiagnosticsCounterClassification value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the Classification Node.

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

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

    • readClassification

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

    • writeClassification

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

    • readClassificationAsync

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

    • writeClassificationAsync

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

    • getClassificationNode

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

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

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

    • getClassificationNodeAsync

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

    • getDiagnosticsLevel

      org.eclipse.milo.opcua.stack.core.types.enumerated.DiagnosticsLevel getDiagnosticsLevel() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the DiagnosticsLevel Node.

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

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

    • setDiagnosticsLevel

      void setDiagnosticsLevel(org.eclipse.milo.opcua.stack.core.types.enumerated.DiagnosticsLevel value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the DiagnosticsLevel Node.

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

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

    • readDiagnosticsLevel

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

    • writeDiagnosticsLevel

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

    • readDiagnosticsLevelAsync

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

    • writeDiagnosticsLevelAsync

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

    • getDiagnosticsLevelNode

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

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

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

    • getDiagnosticsLevelNodeAsync

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

    • getTimeFirstChange

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

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

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

    • setTimeFirstChange

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

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

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

    • readTimeFirstChange

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

    • writeTimeFirstChange

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

    • readTimeFirstChangeAsync

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

    • writeTimeFirstChangeAsync

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

    • getTimeFirstChangeNode

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

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

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

    • getTimeFirstChangeNodeAsync

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