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

Interface ConditionType

All Superinterfaces:
BaseEventType, BaseObjectType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.ObjectNode
All Known Subinterfaces:
AcknowledgeableConditionType, AlarmConditionType, CertificateExpirationAlarmType, DialogConditionType, DiscrepancyAlarmType, DiscreteAlarmType, ExclusiveDeviationAlarmType, ExclusiveLevelAlarmType, ExclusiveLimitAlarmType, ExclusiveRateOfChangeAlarmType, InstrumentDiagnosticAlarmType, LimitAlarmType, NonExclusiveDeviationAlarmType, NonExclusiveLevelAlarmType, NonExclusiveLimitAlarmType, NonExclusiveRateOfChangeAlarmType, OffNormalAlarmType, SystemDiagnosticAlarmType, SystemOffNormalAlarmType, TripAlarmType, TrustListOutOfDateAlarmType
All Known Implementing Classes:
AcknowledgeableConditionTypeNode, AlarmConditionTypeNode, CertificateExpirationAlarmTypeNode, ConditionTypeNode, DialogConditionTypeNode, DiscrepancyAlarmTypeNode, DiscreteAlarmTypeNode, ExclusiveDeviationAlarmTypeNode, ExclusiveLevelAlarmTypeNode, ExclusiveLimitAlarmTypeNode, ExclusiveRateOfChangeAlarmTypeNode, InstrumentDiagnosticAlarmTypeNode, LimitAlarmTypeNode, NonExclusiveDeviationAlarmTypeNode, NonExclusiveLevelAlarmTypeNode, NonExclusiveLimitAlarmTypeNode, NonExclusiveRateOfChangeAlarmTypeNode, OffNormalAlarmTypeNode, SystemDiagnosticAlarmTypeNode, SystemOffNormalAlarmTypeNode, TripAlarmTypeNode, TrustListOutOfDateAlarmTypeNode
public interface ConditionType extends BaseEventType
See Also:

  • Field Details

    • CONDITION_CLASS_ID

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> CONDITION_CLASS_ID

    • CONDITION_CLASS_NAME

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

    • CONDITION_SUB_CLASS_ID

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId[]> CONDITION_SUB_CLASS_ID

    • CONDITION_SUB_CLASS_NAME

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

    • CONDITION_NAME

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<String> CONDITION_NAME

    • BRANCH_ID

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> BRANCH_ID

    • RETAIN

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<Boolean> RETAIN

    • SUPPORTS_FILTERED_RETAIN

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<Boolean> SUPPORTS_FILTERED_RETAIN

    • CLIENT_USER_ID

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<String> CLIENT_USER_ID

  • Method Details

    • getConditionClassId

      org.eclipse.milo.opcua.stack.core.types.builtin.NodeId getConditionClassId() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the ConditionClassId Node.

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

      Specified by:
      getConditionClassId in interface BaseEventType
      Returns:
      the local value of the ConditionClassId Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the ConditionClassId Node.

    • setConditionClassId

      void setConditionClassId(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the ConditionClassId Node.

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

      Specified by:
      setConditionClassId in interface BaseEventType
      Parameters:
      value - the local value to set for the ConditionClassId Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the ConditionClassId Node.

    • readConditionClassId

      org.eclipse.milo.opcua.stack.core.types.builtin.NodeId readConditionClassId() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the ConditionClassId Node from the server and update the local value if the operation succeeds.
      Specified by:
      readConditionClassId in interface BaseEventType
      Returns:
      the NodeId value read from the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • writeConditionClassId

      void writeConditionClassId(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the ConditionClassId Node to the server and update the local value if the operation succeeds.
      Specified by:
      writeConditionClassId in interface BaseEventType
      Parameters:
      value - the NodeId value to write to the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • readConditionClassIdAsync

      CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> readConditionClassIdAsync()
      An asynchronous implementation of readConditionClassId().
      Specified by:
      readConditionClassIdAsync in interface BaseEventType
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.

    • writeConditionClassIdAsync

      CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeConditionClassIdAsync(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId value)
      An asynchronous implementation of writeConditionClassId(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId).
      Specified by:
      writeConditionClassIdAsync in interface BaseEventType
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

    • getConditionClassIdNode

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

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

      Specified by:
      getConditionClassIdNode in interface BaseEventType
      Returns:
      the ConditionClassId 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.

    • getConditionClassIdNodeAsync

      CompletableFuture<? extends PropertyType> getConditionClassIdNodeAsync()
      Asynchronous implementation of getConditionClassIdNode().
      Specified by:
      getConditionClassIdNodeAsync in interface BaseEventType
      Returns:
      a CompletableFuture that completes successfully with the PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.

    • getConditionClassName

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

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

      Specified by:
      getConditionClassName in interface BaseEventType
      Returns:
      the local value of the ConditionClassName Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the ConditionClassName Node.

    • setConditionClassName

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

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

      Specified by:
      setConditionClassName in interface BaseEventType
      Parameters:
      value - the local value to set for the ConditionClassName Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the ConditionClassName Node.

    • readConditionClassName

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

    • writeConditionClassName

      void writeConditionClassName(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the ConditionClassName Node to the server and update the local value if the operation succeeds.
      Specified by:
      writeConditionClassName in interface BaseEventType
      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.

    • readConditionClassNameAsync

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

    • writeConditionClassNameAsync

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

    • getConditionClassNameNode

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

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

      Specified by:
      getConditionClassNameNode in interface BaseEventType
      Returns:
      the ConditionClassName 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.

    • getConditionClassNameNodeAsync

      CompletableFuture<? extends PropertyType> getConditionClassNameNodeAsync()
      Asynchronous implementation of getConditionClassNameNode().
      Specified by:
      getConditionClassNameNodeAsync in interface BaseEventType
      Returns:
      a CompletableFuture that completes successfully with the PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.

    • getConditionSubClassId

      org.eclipse.milo.opcua.stack.core.types.builtin.NodeId[] getConditionSubClassId() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the ConditionSubClassId Node.

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

      Specified by:
      getConditionSubClassId in interface BaseEventType
      Returns:
      the local value of the ConditionSubClassId Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the ConditionSubClassId Node.

    • setConditionSubClassId

      void setConditionSubClassId(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId[] value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the ConditionSubClassId Node.

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

      Specified by:
      setConditionSubClassId in interface BaseEventType
      Parameters:
      value - the local value to set for the ConditionSubClassId Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the ConditionSubClassId Node.

    • readConditionSubClassId

      org.eclipse.milo.opcua.stack.core.types.builtin.NodeId[] readConditionSubClassId() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the ConditionSubClassId Node from the server and update the local value if the operation succeeds.
      Specified by:
      readConditionSubClassId in interface BaseEventType
      Returns:
      the NodeId value read from the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • writeConditionSubClassId

      void writeConditionSubClassId(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId[] value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the ConditionSubClassId Node to the server and update the local value if the operation succeeds.
      Specified by:
      writeConditionSubClassId in interface BaseEventType
      Parameters:
      value - the NodeId value to write to the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • readConditionSubClassIdAsync

      CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.NodeId[]> readConditionSubClassIdAsync()
      An asynchronous implementation of readConditionSubClassId().
      Specified by:
      readConditionSubClassIdAsync in interface BaseEventType
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.

    • writeConditionSubClassIdAsync

      CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeConditionSubClassIdAsync(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId[] value)
      An asynchronous implementation of writeConditionSubClassId(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId[]).
      Specified by:
      writeConditionSubClassIdAsync in interface BaseEventType
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

    • getConditionSubClassIdNode

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

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

      Specified by:
      getConditionSubClassIdNode in interface BaseEventType
      Returns:
      the ConditionSubClassId 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.

    • getConditionSubClassIdNodeAsync

      CompletableFuture<? extends PropertyType> getConditionSubClassIdNodeAsync()
      Asynchronous implementation of getConditionSubClassIdNode().
      Specified by:
      getConditionSubClassIdNodeAsync in interface BaseEventType
      Returns:
      a CompletableFuture that completes successfully with the PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.

    • getConditionSubClassName

      org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[] getConditionSubClassName() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the ConditionSubClassName Node.

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

      Specified by:
      getConditionSubClassName in interface BaseEventType
      Returns:
      the local value of the ConditionSubClassName Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the ConditionSubClassName Node.

    • setConditionSubClassName

      void setConditionSubClassName(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[] value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the ConditionSubClassName Node.

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

      Specified by:
      setConditionSubClassName in interface BaseEventType
      Parameters:
      value - the local value to set for the ConditionSubClassName Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the ConditionSubClassName Node.

    • readConditionSubClassName

      org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[] readConditionSubClassName() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the ConditionSubClassName Node from the server and update the local value if the operation succeeds.
      Specified by:
      readConditionSubClassName in interface BaseEventType
      Returns:
      the LocalizedText value read from the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • writeConditionSubClassName

      void writeConditionSubClassName(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[] value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the ConditionSubClassName Node to the server and update the local value if the operation succeeds.
      Specified by:
      writeConditionSubClassName in interface BaseEventType
      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.

    • readConditionSubClassNameAsync

      CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[]> readConditionSubClassNameAsync()
      An asynchronous implementation of readConditionSubClassName().
      Specified by:
      readConditionSubClassNameAsync in interface BaseEventType
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.

    • writeConditionSubClassNameAsync

      CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeConditionSubClassNameAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[] value)
      An asynchronous implementation of writeConditionSubClassName(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[]).
      Specified by:
      writeConditionSubClassNameAsync in interface BaseEventType
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

    • getConditionSubClassNameNode

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

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

      Specified by:
      getConditionSubClassNameNode in interface BaseEventType
      Returns:
      the ConditionSubClassName 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.

    • getConditionSubClassNameNodeAsync

      CompletableFuture<? extends PropertyType> getConditionSubClassNameNodeAsync()
      Asynchronous implementation of getConditionSubClassNameNode().
      Specified by:
      getConditionSubClassNameNodeAsync in interface BaseEventType
      Returns:
      a CompletableFuture that completes successfully with the PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.

    • getConditionName

      String getConditionName() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the ConditionName Node.

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

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

    • setConditionName

      void setConditionName(String value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the ConditionName Node.

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

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

    • readConditionName

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

    • writeConditionName

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

    • readConditionNameAsync

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

    • writeConditionNameAsync

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

    • getConditionNameNode

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

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

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

    • getConditionNameNodeAsync

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

    • getBranchId

      org.eclipse.milo.opcua.stack.core.types.builtin.NodeId getBranchId() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the BranchId Node.

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

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

    • setBranchId

      void setBranchId(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the BranchId Node.

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

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

    • readBranchId

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

    • writeBranchId

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

    • readBranchIdAsync

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

    • writeBranchIdAsync

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

    • getBranchIdNode

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

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

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

    • getBranchIdNodeAsync

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

    • getRetain

      Boolean getRetain() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the Retain Node.

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

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

    • setRetain

      void setRetain(Boolean value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the Retain Node.

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

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

    • readRetain

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

    • writeRetain

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

    • readRetainAsync

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

    • writeRetainAsync

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

    • getRetainNode

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

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

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

    • getRetainNodeAsync

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

    • getSupportsFilteredRetain

      Boolean getSupportsFilteredRetain() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the SupportsFilteredRetain Node.

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

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

    • setSupportsFilteredRetain

      void setSupportsFilteredRetain(Boolean value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the SupportsFilteredRetain Node.

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

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

    • readSupportsFilteredRetain

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

    • writeSupportsFilteredRetain

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

    • readSupportsFilteredRetainAsync

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

    • writeSupportsFilteredRetainAsync

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

    • getSupportsFilteredRetainNode

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

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

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

    • getSupportsFilteredRetainNodeAsync

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

    • getClientUserId

      String getClientUserId() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the ClientUserId Node.

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

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

    • setClientUserId

      void setClientUserId(String value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the ClientUserId Node.

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

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

    • readClientUserId

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

    • writeClientUserId

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

    • readClientUserIdAsync

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

    • writeClientUserIdAsync

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

    • getClientUserIdNode

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

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

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

    • getClientUserIdNodeAsync

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

    • getEnabledState

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

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

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

    • setEnabledState

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

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

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

    • readEnabledState

      org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText readEnabledState() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the EnabledState 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.

    • writeEnabledState

      void writeEnabledState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the EnabledState 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.

    • readEnabledStateAsync

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

    • writeEnabledStateAsync

      CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeEnabledStateAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value)
      An asynchronous implementation of writeEnabledState(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.

    • getEnabledStateNode

      TwoStateVariableType getEnabledStateNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the EnabledState TwoStateVariableType Node, or null if it does not exist.

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

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

    • getEnabledStateNodeAsync

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

    • getQuality

      org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode getQuality() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the Quality Node.

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

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

    • setQuality

      void setQuality(org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the Quality Node.

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

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

    • readQuality

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

    • writeQuality

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

    • readQualityAsync

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

    • writeQualityAsync

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

    • getQualityNode

      ConditionVariableType getQualityNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the Quality ConditionVariableType Node, or null if it does not exist.

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

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

    • getQualityNodeAsync

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

    • getLastSeverity

      org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort getLastSeverity() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the LastSeverity Node.

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

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

    • setLastSeverity

      void setLastSeverity(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the LastSeverity Node.

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

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

    • readLastSeverity

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

    • writeLastSeverity

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

    • readLastSeverityAsync

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

    • writeLastSeverityAsync

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

    • getLastSeverityNode

      ConditionVariableType getLastSeverityNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the LastSeverity ConditionVariableType Node, or null if it does not exist.

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

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

    • getLastSeverityNodeAsync

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

    • getComment

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

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

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

    • setComment

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

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

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

    • readComment

      org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText readComment() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the Comment 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.

    • writeComment

      void writeComment(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the Comment 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.

    • readCommentAsync

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

    • writeCommentAsync

      CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeCommentAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value)
      An asynchronous implementation of writeComment(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.

    • getCommentNode

      ConditionVariableType getCommentNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the Comment ConditionVariableType Node, or null if it does not exist.

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

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

    • getCommentNodeAsync

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