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

Interface ReferenceDescriptionVariableType

All Superinterfaces:
BaseDataVariableType, BaseVariableType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.VariableNode
All Known Implementing Classes:
ReferenceDescriptionVariableTypeNode
public interface ReferenceDescriptionVariableType extends BaseDataVariableType

  • 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.ReferenceListEntryDataType[]>
    REFERENCE_REFINEMENT
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.eclipse.milo.opcua.stack.core.types.structured.ReferenceListEntryDataType[]
    getReferenceRefinement()
    Get the local value of the ReferenceRefinement Node.
    PropertyType
    getReferenceRefinementNode()
    Get the ReferenceRefinement PropertyType Node, or null if it does not exist.
    CompletableFuture<? extends PropertyType>
    getReferenceRefinementNodeAsync()
    Asynchronous implementation of getReferenceRefinementNode().
    org.eclipse.milo.opcua.stack.core.types.structured.ReferenceListEntryDataType[]
    readReferenceRefinement()
    Read the value of the ReferenceRefinement Node from the server and update the local value if the operation succeeds.
    CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.ReferenceListEntryDataType[]>
    readReferenceRefinementAsync()
    An asynchronous implementation of readReferenceRefinement().
    void
    setReferenceRefinement(org.eclipse.milo.opcua.stack.core.types.structured.ReferenceListEntryDataType[] value)
    Set the local value of the ReferenceRefinement Node.
    void
    writeReferenceRefinement(org.eclipse.milo.opcua.stack.core.types.structured.ReferenceListEntryDataType[] value)
    Write a new value for the ReferenceRefinement Node to the server and update the local value if the operation succeeds.
    CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>
    writeReferenceRefinementAsync(org.eclipse.milo.opcua.stack.core.types.structured.ReferenceListEntryDataType[] value)
    An asynchronous implementation of writeReferenceRefinement(org.eclipse.milo.opcua.stack.core.types.structured.ReferenceListEntryDataType[]).

    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

    • REFERENCE_REFINEMENT

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

  • Method Details

    • getReferenceRefinement

      org.eclipse.milo.opcua.stack.core.types.structured.ReferenceListEntryDataType[] getReferenceRefinement() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the ReferenceRefinement Node.

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

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

    • setReferenceRefinement

      void setReferenceRefinement(org.eclipse.milo.opcua.stack.core.types.structured.ReferenceListEntryDataType[] value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the ReferenceRefinement Node.

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

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

    • readReferenceRefinement

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

    • writeReferenceRefinement

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

    • readReferenceRefinementAsync

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

    • writeReferenceRefinementAsync

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

    • getReferenceRefinementNode

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

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

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

    • getReferenceRefinementNodeAsync

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