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

Interface AnalogUnitType

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

  • Field Details

    • ENGINEERING_UNITS

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.structured.EUInformation> ENGINEERING_UNITS

  • Method Details

    • getEngineeringUnits

      org.eclipse.milo.opcua.stack.core.types.structured.EUInformation getEngineeringUnits() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the EngineeringUnits Node.

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

      Specified by:
      getEngineeringUnits in interface BaseAnalogType
      Returns:
      the local value of the EngineeringUnits Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the EngineeringUnits Node.

    • setEngineeringUnits

      void setEngineeringUnits(org.eclipse.milo.opcua.stack.core.types.structured.EUInformation value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the EngineeringUnits Node.

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

      Specified by:
      setEngineeringUnits in interface BaseAnalogType
      Parameters:
      value - the local value to set for the EngineeringUnits Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the EngineeringUnits Node.

    • readEngineeringUnits

      org.eclipse.milo.opcua.stack.core.types.structured.EUInformation readEngineeringUnits() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the EngineeringUnits Node from the server and update the local value if the operation succeeds.
      Specified by:
      readEngineeringUnits in interface BaseAnalogType
      Returns:
      the EUInformation value read from the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • writeEngineeringUnits

      void writeEngineeringUnits(org.eclipse.milo.opcua.stack.core.types.structured.EUInformation value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the EngineeringUnits Node to the server and update the local value if the operation succeeds.
      Specified by:
      writeEngineeringUnits in interface BaseAnalogType
      Parameters:
      value - the EUInformation value to write to the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • readEngineeringUnitsAsync

      CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.EUInformation> readEngineeringUnitsAsync()
      An asynchronous implementation of readEngineeringUnits().
      Specified by:
      readEngineeringUnitsAsync in interface BaseAnalogType
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.

    • writeEngineeringUnitsAsync

      CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeEngineeringUnitsAsync(org.eclipse.milo.opcua.stack.core.types.structured.EUInformation value)
      An asynchronous implementation of writeEngineeringUnits(org.eclipse.milo.opcua.stack.core.types.structured.EUInformation).
      Specified by:
      writeEngineeringUnitsAsync in interface BaseAnalogType
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

    • getEngineeringUnitsNode

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

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

      Specified by:
      getEngineeringUnitsNode in interface BaseAnalogType
      Returns:
      the EngineeringUnits 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.

    • getEngineeringUnitsNodeAsync

      CompletableFuture<? extends PropertyType> getEngineeringUnitsNodeAsync()
      Asynchronous implementation of getEngineeringUnitsNode().
      Specified by:
      getEngineeringUnitsNodeAsync in interface BaseAnalogType
      Returns:
      a CompletableFuture that completes successfully with the PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.