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

Interface FrameType

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

  • Field Details

    • CONSTANT

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<Boolean> CONSTANT

    • FIXED_BASE

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<Boolean> FIXED_BASE

  • Method Details

    • getConstant

      Boolean getConstant() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the Constant Node.

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

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

    • setConstant

      void setConstant(Boolean value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the Constant Node.

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

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

    • readConstant

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

    • writeConstant

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

    • readConstantAsync

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

    • writeConstantAsync

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

    • getConstantNode

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

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

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

    • getConstantNodeAsync

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

    • getFixedBase

      Boolean getFixedBase() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the FixedBase Node.

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

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

    • setFixedBase

      void setFixedBase(Boolean value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the FixedBase Node.

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

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

    • readFixedBase

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

    • writeFixedBase

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

    • readFixedBaseAsync

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

    • writeFixedBaseAsync

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

    • getFixedBaseNode

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

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

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

    • getFixedBaseNodeAsync

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

    • getCartesianCoordinates

      org.eclipse.milo.opcua.stack.core.types.structured.CartesianCoordinates 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.

      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.CartesianCoordinates 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.CartesianCoordinates 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.
      Returns:
      the CartesianCoordinates 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.CartesianCoordinates 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 CartesianCoordinates 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.CartesianCoordinates> readCartesianCoordinatesAsync()
      An asynchronous implementation of readCartesianCoordinates().
      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.CartesianCoordinates value)
      An asynchronous implementation of writeCartesianCoordinates(org.eclipse.milo.opcua.stack.core.types.structured.CartesianCoordinates).
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

    • getCartesianCoordinatesNode

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

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

      Returns:
      the CartesianCoordinates CartesianCoordinatesType 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 CartesianCoordinatesType> getCartesianCoordinatesNodeAsync()
      Asynchronous implementation of getCartesianCoordinatesNode().
      Returns:
      a CompletableFuture that completes successfully with the CartesianCoordinatesType Node or completes exceptionally if an error occurs creating or getting the Node.

    • getOrientation

      org.eclipse.milo.opcua.stack.core.types.structured.Orientation 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.

      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.Orientation 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.Orientation 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.
      Returns:
      the Orientation 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.Orientation 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 Orientation 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.Orientation> readOrientationAsync()
      An asynchronous implementation of readOrientation().
      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.Orientation value)
      An asynchronous implementation of writeOrientation(org.eclipse.milo.opcua.stack.core.types.structured.Orientation).
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

    • getOrientationNode

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

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

      Returns:
      the Orientation OrientationType 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 OrientationType> getOrientationNodeAsync()
      Asynchronous implementation of getOrientationNode().
      Returns:
      a CompletableFuture that completes successfully with the OrientationType Node or completes exceptionally if an error occurs creating or getting the Node.

    • getBaseFrame

      org.eclipse.milo.opcua.stack.core.types.builtin.NodeId getBaseFrame() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the BaseFrame Node.

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

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

    • setBaseFrame

      void setBaseFrame(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the BaseFrame Node.

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

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

    • readBaseFrame

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

    • writeBaseFrame

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

    • readBaseFrameAsync

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

    • writeBaseFrameAsync

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

    • getBaseFrameNode

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

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

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

    • getBaseFrameNodeAsync

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