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

Interface UnitType

All Superinterfaces:
BaseObjectType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.ObjectNode
All Known Subinterfaces:
AlternativeUnitType, ServerUnitType
All Known Implementing Classes:
AlternativeUnitTypeNode, ServerUnitTypeNode, UnitTypeNode
public interface UnitType extends BaseObjectType
See Also:

  • Field Details

    • SYMBOL

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText> SYMBOL

    • UNIT_SYSTEM

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<String> UNIT_SYSTEM

    • DISCIPLINE

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<String> DISCIPLINE

  • Method Details

    • getSymbol

      org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText getSymbol() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the Symbol Node.

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

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

    • setSymbol

      void setSymbol(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the Symbol Node.

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

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

    • readSymbol

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

    • writeSymbol

      void writeSymbol(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the Symbol Node to the server and update the local value if the operation succeeds.
      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.

    • readSymbolAsync

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

    • writeSymbolAsync

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

    • getSymbolNode

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

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

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

    • getSymbolNodeAsync

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

    • getUnitSystem

      String getUnitSystem() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the UnitSystem Node.

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

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

    • setUnitSystem

      void setUnitSystem(String value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the UnitSystem Node.

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

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

    • readUnitSystem

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

    • writeUnitSystem

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

    • readUnitSystemAsync

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

    • writeUnitSystemAsync

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

    • getUnitSystemNode

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

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

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

    • getUnitSystemNodeAsync

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

    • getDiscipline

      String getDiscipline() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the Discipline Node.

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

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

    • setDiscipline

      void setDiscipline(String value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the Discipline Node.

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

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

    • readDiscipline

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

    • writeDiscipline

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

    • readDisciplineAsync

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

    • writeDisciplineAsync

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

    • getDisciplineNode

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

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

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

    • getDisciplineNodeAsync

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