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

Interface ImageItemType

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

  • Field Details

    • X_AXIS_DEFINITION

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation> X_AXIS_DEFINITION

    • Y_AXIS_DEFINITION

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation> Y_AXIS_DEFINITION

  • Method Details

    • getXAxisDefinition

      org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation getXAxisDefinition() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the XAxisDefinition Node.

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

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

    • setXAxisDefinition

      void setXAxisDefinition(org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the XAxisDefinition Node.

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

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

    • readXAxisDefinition

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

    • writeXAxisDefinition

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

    • readXAxisDefinitionAsync

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

    • writeXAxisDefinitionAsync

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

    • getXAxisDefinitionNode

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

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

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

    • getXAxisDefinitionNodeAsync

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

    • getYAxisDefinition

      org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation getYAxisDefinition() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the YAxisDefinition Node.

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

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

    • setYAxisDefinition

      void setYAxisDefinition(org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the YAxisDefinition Node.

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

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

    • readYAxisDefinition

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

    • writeYAxisDefinition

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

    • readYAxisDefinitionAsync

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

    • writeYAxisDefinitionAsync

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

    • getYAxisDefinitionNode

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

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

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

    • getYAxisDefinitionNodeAsync

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