Clear

virtual void ICommandQueue::Clear() = 0

Removes all command sequences and their commands from the queue and aborts the running command (if any).

Throws

• CResourceBusyException – Axis associated with queue is part of an axis control group.

• CResourceBusyException – Queue is in use by homing.

• CCommunicationErrorException – Protocol error.

• CConnectionLostException – Connection to controller lost.

• CRebootedException – Controller has been rebooted since this object reference was retrieved, invalidating this reference.

Remarks

The state of all command sequences and commands that were in the queue prior to clearing it will be ECommandState::Failed and the queue state will be ECommandQueueState::Idle. Calling this function while the queue is empty has no effect.