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

Interface ThreeDVectorType

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

  • Method Details

    • getX

      Double getX() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the X Node.

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

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

    • setX

      void setX(Double value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the X Node.

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

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

    • readX

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

    • writeX

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

    • readXAsync

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

    • writeXAsync

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

    • getXNode

      BaseDataVariableType getXNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the X BaseDataVariableType Node, or null if it does not exist.

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

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

    • getXNodeAsync

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

    • getY

      Double getY() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the Y Node.

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

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

    • setY

      void setY(Double value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the Y Node.

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

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

    • readY

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

    • writeY

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

    • readYAsync

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

    • writeYAsync

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

    • getYNode

      BaseDataVariableType getYNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the Y BaseDataVariableType Node, or null if it does not exist.

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

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

    • getYNodeAsync

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

    • getZ

      Double getZ() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the Z Node.

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

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

    • setZ

      void setZ(Double value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the Z Node.

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

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

    • readZ

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

    • writeZ

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

    • readZAsync

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

    • writeZAsync

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

    • getZNode

      BaseDataVariableType getZNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the Z BaseDataVariableType Node, or null if it does not exist.

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

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

    • getZNodeAsync

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