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

Interface StateVariableType

All Superinterfaces:
BaseDataVariableType, BaseVariableType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.VariableNode
All Known Subinterfaces:
FiniteStateVariableType, TwoStateVariableType
All Known Implementing Classes:
FiniteStateVariableTypeNode, StateVariableTypeNode, TwoStateVariableTypeNode
public interface StateVariableType extends BaseDataVariableType
See Also:

  • Field Details

    • ID

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<Object> ID

    • NAME

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName> NAME

    • NUMBER

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> NUMBER

    • EFFECTIVE_DISPLAY_NAME

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText> EFFECTIVE_DISPLAY_NAME

  • Method Details

    • getId

      Object getId() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the Id Node.

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

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

    • setId

      void setId(Object value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the Id Node.

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

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

    • readId

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

    • writeId

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

    • readIdAsync

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

    • writeIdAsync

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

    • getIdNode

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

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

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

    • getIdNodeAsync

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

    • getName

      org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName getName() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the Name Node.

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

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

    • setName

      void setName(org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the Name Node.

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

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

    • readName

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

    • writeName

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

    • readNameAsync

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

    • writeNameAsync

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

    • getNameNode

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

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

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

    • getNameNodeAsync

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

    • getNumber

      org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger getNumber() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the Number Node.

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

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

    • setNumber

      void setNumber(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the Number Node.

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

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

    • readNumber

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

    • writeNumber

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

    • readNumberAsync

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

    • writeNumberAsync

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

    • getNumberNode

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

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

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

    • getNumberNodeAsync

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

    • getEffectiveDisplayName

      org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText getEffectiveDisplayName() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the EffectiveDisplayName Node.

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

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

    • setEffectiveDisplayName

      void setEffectiveDisplayName(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the EffectiveDisplayName Node.

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

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

    • readEffectiveDisplayName

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

    • writeEffectiveDisplayName

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

    • readEffectiveDisplayNameAsync

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

    • writeEffectiveDisplayNameAsync

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

    • getEffectiveDisplayNameNode

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

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

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

    • getEffectiveDisplayNameNodeAsync

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