Click or drag to resize

CommandListAppendWaitForInput Method

Waits for a condition on a given IO-Port.


Namespace: RAYLASE.SPICE3.ClientLib
Assembly: RAYLASE.SPICE3.ClientLib (in RAYLASE.SPICE3.ClientLib.dll) Version: 3.6.0
Syntax
C#
public void AppendWaitForInput(
	uint cond,
	IOPort port,
	bool compareCondAsMask,
	bool ifNotTrue = false,
	uint mask = 4294967295,
	int timeout = -1
)

Parameters

cond  UInt32
The condition value. Note that the interpretation of this value, and the way it is used to test the I/O port value, depends on the combination of compareCondAsMask, ifNotTrue, and mask.
port  IOPort

The port whose input value is to be tested.

compareCondAsMask  Boolean
false
cond value (cv) must exactly match the I/O port value (pv) read back from port at the time of execution.
Only the bits set in mask are compared.
The condition evaluates to true if (cv & mask) == (pv & mask).
true
cond value (cv) itself is applied as a bit mask to the I/O port value (pv) read back from port at the time of execution.

The condition evaluates to true if (cv & pv) != 0.

ifNotTrue  Boolean  (Optional)
false (default)
Waiting ends when the condition is true.
true
Waiting ends when the condition is false.
mask  UInt32  (Optional)
This is only used when compareCondAsMask is set to false.
Only the bits set to 1 in mask are compared.
All bits set to 0 are ignored.
timeout  Int32  (Optional)
Maximum time to wait for input (Default: -1 (Infinity)).
Remarks

Appends a WAIT_INPUT command to the list.

Caution note  Caution

This command does NOT automatically de-activate the laser.

If necessary, you must explicitly use AppendLaserOff before AppendWaitForInput.

See Also