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

Interface CartesianCoordinatesType

All Superinterfaces:
BaseDataVariableType, BaseVariableType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.VariableNode
All Known Subinterfaces:
ThreeDCartesianCoordinatesType
All Known Implementing Classes:
CartesianCoordinatesTypeNode, ThreeDCartesianCoordinatesTypeNode
public interface CartesianCoordinatesType extends BaseDataVariableType
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.structured.EUInformation>
    LENGTH_UNIT
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.eclipse.milo.opcua.stack.core.types.structured.EUInformation
    getLengthUnit()
    Get the local value of the LengthUnit Node.
    PropertyType
    getLengthUnitNode()
    Get the LengthUnit PropertyType Node, or null if it does not exist.
    CompletableFuture<? extends PropertyType>
    getLengthUnitNodeAsync()
    Asynchronous implementation of getLengthUnitNode().
    org.eclipse.milo.opcua.stack.core.types.structured.EUInformation
    readLengthUnit()
    Read the value of the LengthUnit Node from the server and update the local value if the operation succeeds.
    CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.EUInformation>
    readLengthUnitAsync()
    An asynchronous implementation of readLengthUnit().
    void
    setLengthUnit(org.eclipse.milo.opcua.stack.core.types.structured.EUInformation value)
    Set the local value of the LengthUnit Node.
    void
    writeLengthUnit(org.eclipse.milo.opcua.stack.core.types.structured.EUInformation value)
    Write a new value for the LengthUnit Node to the server and update the local value if the operation succeeds.
    CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>
    writeLengthUnitAsync(org.eclipse.milo.opcua.stack.core.types.structured.EUInformation value)
    An asynchronous implementation of writeLengthUnit(org.eclipse.milo.opcua.stack.core.types.structured.EUInformation).

    Methods inherited from interface org.eclipse.milo.opcua.sdk.core.nodes.Node

    getAccessRestrictions, getBrowseName, getDescription, getDisplayName, getNodeClass, getNodeId, getRolePermissions, getUserRolePermissions, getUserWriteMask, getWriteMask, setAccessRestrictions, setBrowseName, setDescription, setDisplayName, setNodeClass, setNodeId, setRolePermissions, setUserRolePermissions, setUserWriteMask, setWriteMask

    Methods inherited from interface org.eclipse.milo.opcua.sdk.core.nodes.VariableNode

    getAccessLevel, getAccessLevelEx, getArrayDimensions, getDataType, getHistorizing, getMinimumSamplingInterval, getUserAccessLevel, getValue, getValueRank, setAccessLevel, setAccessLevelEx, setArrayDimensions, setDataType, setHistorizing, setMinimumSamplingInterval, setUserAccessLevel, setValue, setValueRank

  • Field Details

    • LENGTH_UNIT

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.structured.EUInformation> LENGTH_UNIT

  • Method Details

    • getLengthUnit

      org.eclipse.milo.opcua.stack.core.types.structured.EUInformation getLengthUnit() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the LengthUnit Node.

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

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

    • setLengthUnit

      void setLengthUnit(org.eclipse.milo.opcua.stack.core.types.structured.EUInformation value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the LengthUnit Node.

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

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

    • readLengthUnit

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

    • writeLengthUnit

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

    • readLengthUnitAsync

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

    • writeLengthUnitAsync

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

    • getLengthUnitNode

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

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

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

    • getLengthUnitNodeAsync

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