High level instrument control commands.
[Instrument Control and Scripting.]

These commands control data acquisition in a high level, general way and allow setting of Sample Environment parameters via configured SECI blocks. More...

Functions
	AUTOUPDATE (Real DUMP_INTERVAL)
	Start an autoupdate loop.
	BEGIN (Qualifier WAIT)
	Start A RUN.
	CHANGE_FINISH ()
	end a scripted block change operation.
	CHANGE_START ()
	start a scripted block change operation.
	CHANGE_TABLES (String WIRING, String DETECTOR, String SPECTRA)
	Change tables as part of a scripted block change operation.
	CHANGE_TCB (Qualifier LOG, Real TLOW, Real THIGH, Real TSTEP)
	Change time channels as part of a scripted block change operation.
	CSET (Qualifier WAIT, Qualifier CONTROL, Qualifier NOCONTROL, Var RANGE, Var LOWLIMIT, Var HIGHLIMIT, Var EXTRAPARAMS)
	Set a sample environment variable value.
	CSHOW (Qualifier ALL, String BLOCK)
	show a sample environemtn variable value
	END ()
	end a run
	GETRUNSTATE ()
	Returns what state the instrument is currently in as an integer.
	GETSE (String FILE)
	read SE values from a file intop a workspace.
	GETUAMPS ()
	return current Microamps.
	RESUME ()
	resume a run after a pause
	STORE ()
	store CRPT
	SUSPEND ()
	PAUSE a run.
	UPDATE ()
	update CRPT
	UPDATESTORE ()
	perform an UPDATE and STORE in a combined operation
	WAITFOR (Qualifier ALL, Qualifier ANY, Var RANGE, Var LOWLIMIT, Var HIGHLIMIT, Var EXTRAPARAMS)
	Wait for a specified condition before proceeding further.
	WAITFORDASHRUNSTATE (Qualifier FALSE, Qualifier TRUE, String STATE)
	Wait for a particular instrument run state.

---

Detailed Description

These commands control data acquisition in a high level, general way and allow setting of Sample Environment parameters via configured SECI blocks.

To access values on LabVIEW VIs directly you need to use the Low level commands instead

---

Function Documentation

AUTOUPDATE

(

Real

DUMP_INTERVAL

)

Start an autoupdate loop.

This command is usually ran in a second gene process and caused that propcess to wait until the specified number of uAmp.hour has been reached at which point an UPDATESTORE() is executed.

See also:

UPDATESTORE() GETUAMPS()

Parameters:

[in]

DUMP_INTERVAL

How man uAmp.hour to dump at

BEGIN

(

Qualifier

WAIT

)

Start A RUN.

Parameters:

[in]

WAIT

Wait 120 seconds, abort and then begin again

CHANGE_FINISH

(

)

end a scripted block change operation.

See also:

CHANGE_START()

CHANGE_START

(

)

start a scripted block change operation.

See also:

CHANGE_FINISH()

CHANGE_TABLES	(	String	WIRING,
		String	DETECTOR,
		String	SPECTRA
	)

Change tables as part of a scripted block change operation.

Parameters:

[in]	WIRING
[in]	DETECTOR
[in]	SPECTRA

CHANGE_TCB	(	Qualifier	LOG,
		Real	TLOW,
		Real	THIGH,
		Real	TSTEP
	)

Change time channels as part of a scripted block change operation.

Parameters:

[in]	TLOW
[in]	THIGH
[in]	TSTEP
[in]	LOG

See also:

CHANGE_START()

CSET	(	Qualifier	WAIT,
		Qualifier	CONTROL,
		Qualifier	NOCONTROL,
		Var	RANGE,
		Var	LOWLIMIT,
		Var	HIGHLIMIT,
		Var	EXTRAPARAMS
	)

Set a sample environment variable value.

The command is passed the name of a SECI defined sample environment parameter and its desired value in a NAME=VALUE style.

Parameters:

[in]	RANGE
[in]	LOWLIMIT
[in]	HIGHLIMIT
[in]	EXTRAPARAMS	Additional NAME=VALUE arguments
[in]	WAIT
[in]	CONTROL	Enable run control on this block
[in]	NOCONTROL	Disable run control on this block

See also:

CSHOW() GETBLOCKS()

Example:

CSET TEMP1=10.0 

CSHOW	(	Qualifier	ALL,
		String	BLOCK
	)

show a sample environemtn variable value

Parameters:

[in]	BLOCK	Name of SECI defined block to read
[in]	ALL	List all blocks and their values to the screen

Returns:

Value of block; undefined if /ALL is specified

END

(

)

end a run

GETRUNSTATE

(

)

Returns what state the instrument is currently in as an integer.

You can use RUN_STATUS(code) to get the string run states.

See also:

RUN_STATUS()

Returns:

Instrument status as an integer

Return values:

	-3	Waiting
	-2	Waiting
	-1	Paused
	0	Setup
	1	Running

GETSE

(

String

FILE

)

read SE values from a file intop a workspace.

The values can then be plotted using the display command.

Parameters:

[in]

FILE

Name of the log file to read

Returns:

Workspace with data values

GETUAMPS

(

)

return current Microamps.

Returns:

microamps

RESUME

(

)

resume a run after a pause

See also:

PAUSE()

STORE

(

)

store CRPT

SUSPEND

(

)

PAUSE a run.

See also:

RESUME()

UPDATE

(

)

update CRPT

UPDATESTORE

(

)

perform an UPDATE and STORE in a combined operation

WAITFOR	(	Qualifier	ALL,
		Qualifier	ANY,
		Var	RANGE,
		Var	LOWLIMIT,
		Var	HIGHLIMIT,
		Var	EXTRAPARAMS
	)

Wait for a specified condition before proceeding further.

The command allows script execution to be suspended until e.g. the specified number of uAmp.hour has been reached or some other condition. Multiple conditions can be specified on the command and then /ALL or /ANY will indicate if one of all of these needs to be met.

Parameters:

[in]	ALL	Wait for all conditions
[in]	ANY	Wait for any condition
[in]	Range	An Interval structure indicating the range of values to wait for
[in]	LowLimit	Low limit of range
[in]	HighLimit	High limit of range
[in]	ExtraParams	NAME=VALUE list of blocks to wait for

WAITFORDASHRUNSTATE	(	Qualifier	FALSE,
		Qualifier	TRUE,
		String	STATE
	)

Wait for a particular instrument run state.

Parameters:

[in]	TRUE	wait for the specified run state to be entered
[in]	FALSE	wait for any state other than the specified one

See also:

GETRUNSTATE()

---