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

Interface QuantityType

All Superinterfaces:
BaseObjectType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.ObjectNode
All Known Implementing Classes:
QuantityTypeNode
public interface QuantityType 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

    • ANNOTATION

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.structured.AnnotationDataType[]> ANNOTATION

    • CONVERSION_SERVICE

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

    • DIMENSION

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.structured.QuantityDimension> DIMENSION

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

    • getAnnotation

      org.eclipse.milo.opcua.stack.core.types.structured.AnnotationDataType[] getAnnotation() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the Annotation Node.

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

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

    • setAnnotation

      void setAnnotation(org.eclipse.milo.opcua.stack.core.types.structured.AnnotationDataType[] value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the Annotation Node.

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

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

    • readAnnotation

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

    • writeAnnotation

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

    • readAnnotationAsync

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

    • writeAnnotationAsync

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

    • getAnnotationNode

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

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

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

    • getAnnotationNodeAsync

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

    • getConversionService

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

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

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

    • setConversionService

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

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

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

    • readConversionService

      String readConversionService() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the ConversionService 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.

    • writeConversionService

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

    • readConversionServiceAsync

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

    • writeConversionServiceAsync

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

    • getConversionServiceNode

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

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

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

    • getConversionServiceNodeAsync

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

    • getDimension

      org.eclipse.milo.opcua.stack.core.types.structured.QuantityDimension getDimension() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the Dimension Node.

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

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

    • setDimension

      void setDimension(org.eclipse.milo.opcua.stack.core.types.structured.QuantityDimension value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the Dimension Node.

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

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

    • readDimension

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

    • writeDimension

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

    • readDimensionAsync

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

    • writeDimensionAsync

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

    • getDimensionNode

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

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

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

    • getDimensionNodeAsync

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

    • getServerUnitsNode

      BaseObjectType getServerUnitsNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the ServerUnits BaseObjectType Node, or null if it does not exist.

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

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

    • getServerUnitsNodeAsync

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