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

Interface BaseAnalogType

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

  • Field Details

    • INSTRUMENT_RANGE

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.structured.Range> INSTRUMENT_RANGE

    • EU_RANGE

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.structured.Range> EU_RANGE

    • ENGINEERING_UNITS

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

  • Method Details

    • getInstrumentRange

      org.eclipse.milo.opcua.stack.core.types.structured.Range getInstrumentRange() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the InstrumentRange Node.

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

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

    • setInstrumentRange

      void setInstrumentRange(org.eclipse.milo.opcua.stack.core.types.structured.Range value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the InstrumentRange Node.

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

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

    • readInstrumentRange

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

    • writeInstrumentRange

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

    • readInstrumentRangeAsync

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

    • writeInstrumentRangeAsync

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

    • getInstrumentRangeNode

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

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

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

    • getInstrumentRangeNodeAsync

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

    • getEuRange

      org.eclipse.milo.opcua.stack.core.types.structured.Range getEuRange() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the EURange Node.

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

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

    • setEuRange

      void setEuRange(org.eclipse.milo.opcua.stack.core.types.structured.Range value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the EURange Node.

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

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

    • readEuRange

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

    • writeEuRange

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

    • readEuRangeAsync

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

    • writeEuRangeAsync

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

    • getEuRangeNode

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

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

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

    • getEuRangeNodeAsync

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

    • 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.

      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.

      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.
      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.
      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().
      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).
      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.

      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().
      Returns:
      a CompletableFuture that completes successfully with the PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.