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

Interface ThreeDFrameType

All Superinterfaces:
BaseDataVariableType, BaseVariableType, FrameType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.VariableNode
All Known Implementing Classes:
ThreeDFrameTypeNode
public interface ThreeDFrameType extends FrameType
See Also:

  • Method Details

    • getCartesianCoordinates

      org.eclipse.milo.opcua.stack.core.types.structured.ThreeDCartesianCoordinates getCartesianCoordinates() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the CartesianCoordinates Node.

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

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

    • setCartesianCoordinates

      void setCartesianCoordinates(org.eclipse.milo.opcua.stack.core.types.structured.ThreeDCartesianCoordinates value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the CartesianCoordinates Node.

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

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

    • readCartesianCoordinates

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

    • writeCartesianCoordinates

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

    • readCartesianCoordinatesAsync

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

    • writeCartesianCoordinatesAsync

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

    • getCartesianCoordinatesNode

      ThreeDCartesianCoordinatesType getCartesianCoordinatesNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the CartesianCoordinates ThreeDCartesianCoordinatesType Node, or null if it does not exist.

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

      Specified by:
      getCartesianCoordinatesNode in interface FrameType
      Returns:
      the CartesianCoordinates ThreeDCartesianCoordinatesType 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.

    • getCartesianCoordinatesNodeAsync

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

    • getOrientation

      org.eclipse.milo.opcua.stack.core.types.structured.ThreeDOrientation getOrientation() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the Orientation Node.

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

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

    • setOrientation

      void setOrientation(org.eclipse.milo.opcua.stack.core.types.structured.ThreeDOrientation value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the Orientation Node.

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

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

    • readOrientation

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

    • writeOrientation

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

    • readOrientationAsync

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

    • writeOrientationAsync

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

    • getOrientationNode

      ThreeDOrientationType getOrientationNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the Orientation ThreeDOrientationType Node, or null if it does not exist.

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

      Specified by:
      getOrientationNode in interface FrameType
      Returns:
      the Orientation ThreeDOrientationType 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.

    • getOrientationNodeAsync

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