Timeout¶
-
double IAlignment.Timeout { get; set; }¶
Gets or sets the timeout used for this alignment method.
- Value
double – Timeout in seconds. Negative value means infinite. The default timeout value is -1.0 (infinite).
- Throws
InvalidArgumentException
– Invalid timeout value (NaN).ResourceBusyException
– An alignment method is currently being executed.CommunicationErrorException
– Protocol error.ConnectionLostException
– Connection to controller lost.RebootedException
– Controller has been rebooted since this object reference was retrieved, invalidating this reference.
- Remarks
Failure to meet the specified method within the timeout specified leads to failure of alignment, i.e. alignment state will transit to AlignmentState.Error.