All Implemented Interfaces:
BaseAnalogType, BaseDataVariableType, BaseVariableType, DataItemType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.VariableNode
Direct Known Subclasses:
AnalogItemTypeNode, AnalogUnitTypeNode

public class BaseAnalogTypeNode extends DataItemTypeNode implements BaseAnalogType
  • Constructor Details

    • BaseAnalogTypeNode

      public BaseAnalogTypeNode(OpcUaClient client, org.eclipse.milo.opcua.stack.core.types.builtin.NodeId nodeId, org.eclipse.milo.opcua.stack.core.types.enumerated.NodeClass nodeClass, org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName browseName, org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText displayName, org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText description, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger writeMask, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger userWriteMask, org.eclipse.milo.opcua.stack.core.types.structured.RolePermissionType[] rolePermissions, org.eclipse.milo.opcua.stack.core.types.structured.RolePermissionType[] userRolePermissions, org.eclipse.milo.opcua.stack.core.types.structured.AccessRestrictionType accessRestrictions, org.eclipse.milo.opcua.stack.core.types.builtin.DataValue value, org.eclipse.milo.opcua.stack.core.types.builtin.NodeId dataType, Integer valueRank, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger[] arrayDimensions, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte accessLevel, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte userAccessLevel, Double minimumSamplingInterval, Boolean historizing, org.eclipse.milo.opcua.stack.core.types.structured.AccessLevelExType accessLevelEx)
  • Method Details

    • getInstrumentRange

      public org.eclipse.milo.opcua.stack.core.types.structured.Range getInstrumentRange() throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: BaseAnalogType
      Get the local value of the InstrumentRange Node.

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

      Specified by:
      getInstrumentRange in interface BaseAnalogType
      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

      public void setInstrumentRange(org.eclipse.milo.opcua.stack.core.types.structured.Range value) throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: BaseAnalogType
      Set the local value of the InstrumentRange Node.

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

      Specified by:
      setInstrumentRange in interface BaseAnalogType
      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

      public org.eclipse.milo.opcua.stack.core.types.structured.Range readInstrumentRange() throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: BaseAnalogType
      Read the value of the InstrumentRange Node from the server and update the local value if the operation succeeds.
      Specified by:
      readInstrumentRange in interface BaseAnalogType
      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

      public void writeInstrumentRange(org.eclipse.milo.opcua.stack.core.types.structured.Range value) throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: BaseAnalogType
      Write a new value for the InstrumentRange Node to the server and update the local value if the operation succeeds.
      Specified by:
      writeInstrumentRange in interface BaseAnalogType
      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

      public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.Range> readInstrumentRangeAsync()
      Description copied from interface: BaseAnalogType
      An asynchronous implementation of BaseAnalogType.readInstrumentRange().
      Specified by:
      readInstrumentRangeAsync in interface BaseAnalogType
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.
    • writeInstrumentRangeAsync

      public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeInstrumentRangeAsync(org.eclipse.milo.opcua.stack.core.types.structured.Range instrumentRange)
      Description copied from interface: BaseAnalogType
      Specified by:
      writeInstrumentRangeAsync in interface BaseAnalogType
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.
    • getInstrumentRangeNode

      public PropertyTypeNode getInstrumentRangeNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: BaseAnalogType
      Get the InstrumentRange PropertyType Node, or null if it does not exist.

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

      Specified by:
      getInstrumentRangeNode in interface BaseAnalogType
      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

      public CompletableFuture<? extends PropertyTypeNode> getInstrumentRangeNodeAsync()
      Description copied from interface: BaseAnalogType
      Asynchronous implementation of BaseAnalogType.getInstrumentRangeNode().
      Specified by:
      getInstrumentRangeNodeAsync 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.
    • getEuRange

      public org.eclipse.milo.opcua.stack.core.types.structured.Range getEuRange() throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: BaseAnalogType
      Get the local value of the EURange Node.

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

      Specified by:
      getEuRange in interface BaseAnalogType
      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

      public void setEuRange(org.eclipse.milo.opcua.stack.core.types.structured.Range value) throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: BaseAnalogType
      Set the local value of the EURange Node.

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

      Specified by:
      setEuRange in interface BaseAnalogType
      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

      public org.eclipse.milo.opcua.stack.core.types.structured.Range readEuRange() throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: BaseAnalogType
      Read the value of the EURange Node from the server and update the local value if the operation succeeds.
      Specified by:
      readEuRange in interface BaseAnalogType
      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

      public void writeEuRange(org.eclipse.milo.opcua.stack.core.types.structured.Range value) throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: BaseAnalogType
      Write a new value for the EURange Node to the server and update the local value if the operation succeeds.
      Specified by:
      writeEuRange in interface BaseAnalogType
      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

      public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.Range> readEuRangeAsync()
      Description copied from interface: BaseAnalogType
      An asynchronous implementation of BaseAnalogType.readEuRange().
      Specified by:
      readEuRangeAsync in interface BaseAnalogType
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.
    • writeEuRangeAsync

      public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeEuRangeAsync(org.eclipse.milo.opcua.stack.core.types.structured.Range euRange)
      Description copied from interface: BaseAnalogType
      Specified by:
      writeEuRangeAsync in interface BaseAnalogType
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.
    • getEuRangeNode

      public PropertyTypeNode getEuRangeNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: BaseAnalogType
      Get the EURange PropertyType Node, or null if it does not exist.

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

      Specified by:
      getEuRangeNode in interface BaseAnalogType
      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

      public CompletableFuture<? extends PropertyTypeNode> getEuRangeNodeAsync()
      Description copied from interface: BaseAnalogType
      Asynchronous implementation of BaseAnalogType.getEuRangeNode().
      Specified by:
      getEuRangeNodeAsync 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.
    • getEngineeringUnits

      public org.eclipse.milo.opcua.stack.core.types.structured.EUInformation getEngineeringUnits() throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: BaseAnalogType
      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

      public void setEngineeringUnits(org.eclipse.milo.opcua.stack.core.types.structured.EUInformation value) throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: BaseAnalogType
      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

      public org.eclipse.milo.opcua.stack.core.types.structured.EUInformation readEngineeringUnits() throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: BaseAnalogType
      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

      public void writeEngineeringUnits(org.eclipse.milo.opcua.stack.core.types.structured.EUInformation value) throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: BaseAnalogType
      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

      public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.EUInformation> readEngineeringUnitsAsync()
      Description copied from class: UaVariableNode
      Get the value of the VariableNodeProperties.EngineeringUnits Property, if it exists.
      Specified by:
      readEngineeringUnitsAsync in interface BaseAnalogType
      Overrides:
      readEngineeringUnitsAsync in class UaVariableNode
      Returns:
      the value of the EngineeringUnits Property, if it exists.
      See Also:
      • VariableNodeProperties
    • writeEngineeringUnitsAsync

      public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeEngineeringUnitsAsync(org.eclipse.milo.opcua.stack.core.types.structured.EUInformation engineeringUnits)
      Description copied from class: UaVariableNode
      Set the value of the VariableNodeProperties.EngineeringUnits Property, if it exists.
      Specified by:
      writeEngineeringUnitsAsync in interface BaseAnalogType
      Overrides:
      writeEngineeringUnitsAsync in class UaVariableNode
      Parameters:
      engineeringUnits - the value to set.
      Returns:
      a CompletableFuture that completes with the StatusCode of the write operation.
      See Also:
      • VariableNodeProperties
    • getEngineeringUnitsNode

      public PropertyTypeNode getEngineeringUnitsNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: BaseAnalogType
      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

      public CompletableFuture<? extends PropertyTypeNode> getEngineeringUnitsNodeAsync()
      Description copied from interface: BaseAnalogType
      Asynchronous implementation of BaseAnalogType.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.