All Implemented Interfaces:
BaseEventType, BaseObjectType, TransitionEventType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.ObjectNode
Direct Known Subclasses:
ProgramTransitionEventTypeNode

public class TransitionEventTypeNode extends BaseEventTypeNode implements TransitionEventType
  • Constructor Details

    • TransitionEventTypeNode

      public TransitionEventTypeNode(OpcUaClient client, org.eclipse.milo.opcua.stack.core.types.builtin.NodeId nodeId, org.eclipse.milo.opcua.stack.core.types.enumerated.NodeClass nodeClass, org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName browseName, org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText displayName, org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText description, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger writeMask, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger userWriteMask, org.eclipse.milo.opcua.stack.core.types.structured.RolePermissionType[] rolePermissions, org.eclipse.milo.opcua.stack.core.types.structured.RolePermissionType[] userRolePermissions, org.eclipse.milo.opcua.stack.core.types.structured.AccessRestrictionType accessRestrictions, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte eventNotifier)
  • Method Details

    • getTransition

      public org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText getTransition() throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: TransitionEventType
      Get the local value of the Transition Node.

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

      Specified by:
      getTransition in interface TransitionEventType
      Returns:
      the local value of the Transition Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Transition Node.
    • setTransition

      public void setTransition(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value) throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: TransitionEventType
      Set the local value of the Transition Node.

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

      Specified by:
      setTransition in interface TransitionEventType
      Parameters:
      value - the local value to set for the Transition Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Transition Node.
    • readTransition

      public org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText readTransition() throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: TransitionEventType
      Read the value of the Transition Node from the server and update the local value if the operation succeeds.
      Specified by:
      readTransition in interface TransitionEventType
      Returns:
      the LocalizedText value read from the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.
    • writeTransition

      public void writeTransition(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value) throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: TransitionEventType
      Write a new value for the Transition Node to the server and update the local value if the operation succeeds.
      Specified by:
      writeTransition in interface TransitionEventType
      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.
    • readTransitionAsync

      public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText> readTransitionAsync()
      Description copied from interface: TransitionEventType
      An asynchronous implementation of TransitionEventType.readTransition().
      Specified by:
      readTransitionAsync in interface TransitionEventType
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.
    • writeTransitionAsync

      public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeTransitionAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText transition)
      Description copied from interface: TransitionEventType
      Specified by:
      writeTransitionAsync in interface TransitionEventType
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.
    • getTransitionNode

      public TransitionVariableTypeNode getTransitionNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: TransitionEventType
      Get the Transition TransitionVariableType Node, or null if it does not exist.

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

      Specified by:
      getTransitionNode in interface TransitionEventType
      Returns:
      the Transition TransitionVariableType 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.
    • getTransitionNodeAsync

      public CompletableFuture<? extends TransitionVariableTypeNode> getTransitionNodeAsync()
      Description copied from interface: TransitionEventType
      Asynchronous implementation of TransitionEventType.getTransitionNode().
      Specified by:
      getTransitionNodeAsync in interface TransitionEventType
      Returns:
      a CompletableFuture that completes successfully with the TransitionVariableType Node or completes exceptionally if an error occurs creating or getting the Node.
    • getFromState

      public org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText getFromState() throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: TransitionEventType
      Get the local value of the FromState Node.

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

      Specified by:
      getFromState in interface TransitionEventType
      Returns:
      the local value of the FromState Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the FromState Node.
    • setFromState

      public void setFromState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value) throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: TransitionEventType
      Set the local value of the FromState Node.

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

      Specified by:
      setFromState in interface TransitionEventType
      Parameters:
      value - the local value to set for the FromState Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the FromState Node.
    • readFromState

      public org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText readFromState() throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: TransitionEventType
      Read the value of the FromState Node from the server and update the local value if the operation succeeds.
      Specified by:
      readFromState in interface TransitionEventType
      Returns:
      the LocalizedText value read from the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.
    • writeFromState

      public void writeFromState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value) throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: TransitionEventType
      Write a new value for the FromState Node to the server and update the local value if the operation succeeds.
      Specified by:
      writeFromState in interface TransitionEventType
      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.
    • readFromStateAsync

      public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText> readFromStateAsync()
      Description copied from interface: TransitionEventType
      An asynchronous implementation of TransitionEventType.readFromState().
      Specified by:
      readFromStateAsync in interface TransitionEventType
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.
    • writeFromStateAsync

      public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeFromStateAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText fromState)
      Description copied from interface: TransitionEventType
      Specified by:
      writeFromStateAsync in interface TransitionEventType
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.
    • getFromStateNode

      public StateVariableTypeNode getFromStateNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: TransitionEventType
      Get the FromState StateVariableType Node, or null if it does not exist.

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

      Specified by:
      getFromStateNode in interface TransitionEventType
      Returns:
      the FromState StateVariableType 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.
    • getFromStateNodeAsync

      public CompletableFuture<? extends StateVariableTypeNode> getFromStateNodeAsync()
      Description copied from interface: TransitionEventType
      Asynchronous implementation of TransitionEventType.getFromStateNode().
      Specified by:
      getFromStateNodeAsync in interface TransitionEventType
      Returns:
      a CompletableFuture that completes successfully with the StateVariableType Node or completes exceptionally if an error occurs creating or getting the Node.
    • getToState

      public org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText getToState() throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: TransitionEventType
      Get the local value of the ToState Node.

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

      Specified by:
      getToState in interface TransitionEventType
      Returns:
      the local value of the ToState Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the ToState Node.
    • setToState

      public void setToState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value) throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: TransitionEventType
      Set the local value of the ToState Node.

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

      Specified by:
      setToState in interface TransitionEventType
      Parameters:
      value - the local value to set for the ToState Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the ToState Node.
    • readToState

      public org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText readToState() throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: TransitionEventType
      Read the value of the ToState Node from the server and update the local value if the operation succeeds.
      Specified by:
      readToState in interface TransitionEventType
      Returns:
      the LocalizedText value read from the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.
    • writeToState

      public void writeToState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value) throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: TransitionEventType
      Write a new value for the ToState Node to the server and update the local value if the operation succeeds.
      Specified by:
      writeToState in interface TransitionEventType
      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.
    • readToStateAsync

      public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText> readToStateAsync()
      Description copied from interface: TransitionEventType
      An asynchronous implementation of TransitionEventType.readToState().
      Specified by:
      readToStateAsync in interface TransitionEventType
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.
    • writeToStateAsync

      public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeToStateAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText toState)
      Description copied from interface: TransitionEventType
      Specified by:
      writeToStateAsync in interface TransitionEventType
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.
    • getToStateNode

      public StateVariableTypeNode getToStateNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: TransitionEventType
      Get the ToState StateVariableType Node, or null if it does not exist.

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

      Specified by:
      getToStateNode in interface TransitionEventType
      Returns:
      the ToState StateVariableType 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.
    • getToStateNodeAsync

      public CompletableFuture<? extends StateVariableTypeNode> getToStateNodeAsync()
      Description copied from interface: TransitionEventType
      Asynchronous implementation of TransitionEventType.getToStateNode().
      Specified by:
      getToStateNodeAsync in interface TransitionEventType
      Returns:
      a CompletableFuture that completes successfully with the StateVariableType Node or completes exceptionally if an error occurs creating or getting the Node.