SetPeriod¶
-
virtual void IProcessingBlock::SetPeriod(double period) = 0¶
Sets the period between each execution of the processing block.
- Parameters
period – Period in seconds.
- Throws
CInvalidArgumentException
– Value passed is non-positive, infinite or NaN.CUnsupportedException
– Period is not supported for built-in processing blocks.CInvalidOperationException
– Top-controller state is not “Config”.CCommunicationErrorException
– Protocol error.CConnectionLostException
– Connection to controller lost.CRebootedException
– Controller has been rebooted since this object reference was retrieved, invalidating this reference.CIncompatibleException
– Incompatible firmware version loaded.CObjectDestroyedException
– Object is destroyed.
- Remarks
The period is quantized using the sample period of the axiscontrol/controller on which the processing block is created. The resulting period in samples is rounded to the nearest integer multiple greater than or equal to the requested period. The period is used only when the execution type is Asynchronous.