WaitState¶
-
void ITopController.WaitState(TopControllerState state, double timeout)¶
Waits until the state of the state machine changes to the specified state, or the timeout interval is exceeded.
- Parameters
state – State to wait for.
timeout – Interval in seconds to wait for the specified state. Negative value means infinite.
- Throws
InvalidArgumentException– Unknown state specified.InvalidArgumentException– Invalid timeout (NaN).TimeoutException– Timeout interval exceeded while waiting for state.CommunicationErrorException– Protocol error.ConnectionLostException– Connection to controller lost.RebootedException– Controller has been rebooted since this object reference was retrieved, invalidating this reference.IncompatibleException– Incompatible firmware version loaded.System.ObjectDisposedException– Object is disposed.
- Remarks
If the state already matches the specified state, this method returns immediately. Execution does not requires a subscription resource.