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

Interface VectorType

All Superinterfaces:
BaseDataVariableType, BaseVariableType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.VariableNode
All Known Subinterfaces:
ThreeDVectorType
All Known Implementing Classes:
ThreeDVectorTypeNode, VectorTypeNode
public interface VectorType 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>
    VECTOR_UNIT
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.eclipse.milo.opcua.stack.core.types.structured.EUInformation
    getVectorUnit()
    Get the local value of the VectorUnit Node.
    PropertyType
    getVectorUnitNode()
    Get the VectorUnit PropertyType Node, or null if it does not exist.
    CompletableFuture<? extends PropertyType>
    getVectorUnitNodeAsync()
    Asynchronous implementation of getVectorUnitNode().
    org.eclipse.milo.opcua.stack.core.types.structured.EUInformation
    readVectorUnit()
    Read the value of the VectorUnit Node from the server and update the local value if the operation succeeds.
    CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.EUInformation>
    readVectorUnitAsync()
    An asynchronous implementation of readVectorUnit().
    void
    setVectorUnit(org.eclipse.milo.opcua.stack.core.types.structured.EUInformation value)
    Set the local value of the VectorUnit Node.
    void
    writeVectorUnit(org.eclipse.milo.opcua.stack.core.types.structured.EUInformation value)
    Write a new value for the VectorUnit Node to the server and update the local value if the operation succeeds.
    CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>
    writeVectorUnitAsync(org.eclipse.milo.opcua.stack.core.types.structured.EUInformation value)
    An asynchronous implementation of writeVectorUnit(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

    • VECTOR_UNIT

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

  • Method Details

    • getVectorUnit

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

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

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

    • setVectorUnit

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

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

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

    • readVectorUnit

      org.eclipse.milo.opcua.stack.core.types.structured.EUInformation readVectorUnit() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the VectorUnit 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.

    • writeVectorUnit

      void writeVectorUnit(org.eclipse.milo.opcua.stack.core.types.structured.EUInformation value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the VectorUnit 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.

    • readVectorUnitAsync

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

    • writeVectorUnitAsync

      CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeVectorUnitAsync(org.eclipse.milo.opcua.stack.core.types.structured.EUInformation value)
      An asynchronous implementation of writeVectorUnit(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.

    • getVectorUnitNode

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

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

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

    • getVectorUnitNodeAsync

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