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

Interface TargetVariablesType

All Superinterfaces:
BaseObjectType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.ObjectNode, SubscribedDataSetType
All Known Implementing Classes:
TargetVariablesTypeNode
public interface TargetVariablesType extends SubscribedDataSetType
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.FieldTargetDataType[]>
    TARGET_VARIABLES
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.eclipse.milo.opcua.stack.core.types.structured.FieldTargetDataType[]
    getTargetVariables()
    Get the local value of the TargetVariables Node.
    PropertyType
    getTargetVariablesNode()
    Get the TargetVariables PropertyType Node, or null if it does not exist.
    CompletableFuture<? extends PropertyType>
    getTargetVariablesNodeAsync()
    Asynchronous implementation of getTargetVariablesNode().
    org.eclipse.milo.opcua.stack.core.types.structured.FieldTargetDataType[]
    readTargetVariables()
    Read the value of the TargetVariables Node from the server and update the local value if the operation succeeds.
    CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.FieldTargetDataType[]>
    readTargetVariablesAsync()
    An asynchronous implementation of readTargetVariables().
    void
    setTargetVariables(org.eclipse.milo.opcua.stack.core.types.structured.FieldTargetDataType[] value)
    Set the local value of the TargetVariables Node.
    void
    writeTargetVariables(org.eclipse.milo.opcua.stack.core.types.structured.FieldTargetDataType[] value)
    Write a new value for the TargetVariables Node to the server and update the local value if the operation succeeds.
    CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>
    writeTargetVariablesAsync(org.eclipse.milo.opcua.stack.core.types.structured.FieldTargetDataType[] value)
    An asynchronous implementation of writeTargetVariables(org.eclipse.milo.opcua.stack.core.types.structured.FieldTargetDataType[]).

    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.ObjectNode

    getEventNotifier, setEventNotifier

  • Field Details

    • TARGET_VARIABLES

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.structured.FieldTargetDataType[]> TARGET_VARIABLES

  • Method Details

    • getTargetVariables

      org.eclipse.milo.opcua.stack.core.types.structured.FieldTargetDataType[] getTargetVariables() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the TargetVariables Node.

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

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

    • setTargetVariables

      void setTargetVariables(org.eclipse.milo.opcua.stack.core.types.structured.FieldTargetDataType[] value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the TargetVariables Node.

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

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

    • readTargetVariables

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

    • writeTargetVariables

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

    • readTargetVariablesAsync

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

    • writeTargetVariablesAsync

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

    • getTargetVariablesNode

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

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

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

    • getTargetVariablesNodeAsync

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