Definitions for Instrument scriping commands. More...
Functions | |
| ABORT (Qualifier QUIET) | |
| Abort a run. | |
| ABORT_POSTCMD (Qualifier QUIET) | |
| Called by ABORT immedately after data collection is actually stopped. | |
| ABORT_PRECMD (Qualifier QUIET) | |
| Called by ABORT immedately before data collection is actually stopped. | |
| AUTOUPDATE (Real DUMP_INTERVAL) | |
| Start an autoupdate loop. | |
| BEAMLINE_PAR (String PAR, Workspace EXTRAPARAMS, Qualifier SET, Qualifier GET, Qualifier REMOVE, Qualifier LIST) | |
| Set a value on trhe Beamline Parameters VI. | |
| BEGIN (Integer PERIOD, String MEASUREMENT_ID, String MEASUREMENT_TYPE, String MEASUREMENT_SUBID, String SAMPLE_ID, Qualifier WAIT, Qualifier QUIET, Qualifier PAUSED) | |
| Start A RUN. | |
| BEGIN_POSTCMD (Integer RUN_NUMBER, Qualifier QUIET) | |
| Called by BEGIN immedately after data collection is actually started. | |
| BEGIN_PRECMD (Qualifier QUIET) | |
| Called by BEGIN immedately before data collection is actually started. | |
| BEGINSCRIPT () | |
| CALLLABVIEW (String VI, Stringarray NAMES, Array VALUES, String HOST, Qualifier NOREF, Qualifier REENTRANT) | |
| Call a LabVIEW VI as a Sub VI. | |
| CALLVIMETHOD (String VI, String METHOD, Generic P1, Generic P2, Generic P3, Generic P4, String HOST) | |
| Call a method on a LabVIEW VI. | |
| CHANGE (String TITLE, String USER, Integer PERIOD, Integer RBNO, Real AOI, Real PHI, Integer NPERIODS, Real THICKNESS, String SAMPLE_NAME) | |
| Change values on the instrument. | |
| CHANGE_FINISH () | |
| End a block change operation started by CHANGE_START. | |
| CHANGE_MONITOR (Integer SPEC, Real TLOW, Real THIGH) | |
| Change monitor as part of a block change operation. | |
| CHANGE_PERIODS (Integer NSOFT, Integer SEQUENCES, Integer OUTPUT_DELAY, String FILE, Integer FRAMES, Integer OUTPUT, String LABEL, Qualifier HARD_INT, Qualifier HARD_EXT, Qualifier SOFT, Qualifier PFILE, Qualifier PERIOD1, Qualifier PERIOD2, Qualifier PERIOD3, Qualifier PERIOD4, Qualifier PERIOD5, Qualifier PERIOD6, Qualifier PERIOD7, Qualifier PERIOD8, Qualifier ALLPERIODS, Qualifier DAQ, Qualifier DWELL, Qualifier UNUSED) | |
| Change period setup as part of a scripted block change operation. | |
| CHANGE_START () | |
| start a scripted block change operation. | |
| CHANGE_SYNC (Qualifier ISIS, Qualifier INTERNAL, Qualifier SMP) | |
| Change DAE timing (sync) source as part of a block change operation. | |
| CHANGE_TABLES (String WIRING, String DETECTOR, String SPECTRA) | |
| Change tables as part of a block change operation. | |
| CHANGE_TCB (Real TLOW, Real THIGH, Real TSTEP, String FILE, Qualifier LOG, Qualifier TCBFILE, Qualifier RANGE1, Qualifier RANGE2, Qualifier RANGE3, Qualifier RANGE4, Qualifier RANGE5, Qualifier REGIME1, Qualifier REGIME2) | |
| Change time channels as part of a scripted block change operation. | |
| CHANGE_VARS (Real AOI, Real PHI, Integer NPERIODS) | |
| Change other variables as part of a block change operation. | |
| CHANGE_VETOS (Qualifier CLEARALL, Qualifier SMP, Qualifier NOSMP, Qualifier TS2, Qualifier NOTS2, Qualifier HZ50, Qualifier NOHZ50, Qualifier EXT0, Qualifier NOEXT0, Qualifier EXT1, Qualifier NOEXT1, Qualifier EXT2, Qualifier NOEXT2, Qualifier EXT3, Qualifier NOEXT3) | |
| Change vetos as part of a block change operation. | |
| CHECKBLOCKNAME (String BLOCK, Qualifier NOPRINT) | |
| Check a string block name is valid. | |
| CLOSEVIFRONTPANEL (String VI, String HOST) | |
| Close a LabVIEW VI front panel. | |
| CSET (String BLOCK, Generic VALUE, Generic RANGE, Generic LOWLIMIT, Generic HIGHLIMIT, Real SPREAD, Real RETRY, Integer NRETRY, Generic EXTRAPARAMS, Qualifier WAIT, Qualifier CONTROL, Qualifier NOCONTROL) | |
| Set a sample environment variable value. | |
| CSHOW (String BLOCK, Qualifier ALL) | |
| show a sample environemtn variable value | |
| DAE_WRITE (Integer CARD_ID, Integer CARD_ADDRESS, Integer VALUE, Qualifier W16) | |
| write a value to a location on a DAE acquisition card | |
| DUMPTOLOG (String FILE, String ENTRY) | |
| END (Qualifier IMMEDIATE, Qualifier QUIET) | |
| End a run. | |
| END_POSTCMD (Integer RUN_NUMBER, Qualifier IMMEDIATE, Qualifier QUIET) | |
| Called by END immedately after data collection is actually stopped. | |
| END_PRECMD (Qualifier IMMEDIATE, Qualifier QUIET) | |
| Called by END immedately before data collection is actually stopped. | |
| ENDSCRIPT () | |
| GETBLOCKS () | |
| Update GENIE session with sample environment block information on SECI. | |
| GETDASHBOARD () | |
| GETDASHINFO (String VARNAME, String HOST) | |
| GETDASHTIME (String HOST) | |
| GETDASHVAR (String VARNAME, String HOST) | |
| GETFRAMES (String HOST, Qualifier ALLPERIODS) | |
| return current good frames. | |
| GETGENIEVAR (String VAR, String HOST) | |
| GETICPOUTPUT (String COMMAND, String HOST) | |
| GETISCMODE () | |
| GETLABVIEWVAR (String VI, String VARNAME, String HOST) | |
| Read a variable from a LabVIEW VI. | |
| GETMEVENTS (String HOST) | |
| return total counts for all detectors connected. | |
| GETPERIOD (String HOST) | |
| return current period number. | |
| GETRUNNUMBER () | |
| Returns what current run number of the instrument as an Integer value. | |
| GETRUNSTATE (Qualifier VI) | |
| Returns what status of the instrument as an Integer value. | |
| GETRUNSTATENEWDAE (Qualifier VI) | |
| GETSE (String BLOCK, Integer RUN_NUMBER, String FILE) | |
| Read a set of sample environment values from a log file into a Workspace. | |
| GETSECICONFIG () | |
| Retrieve current seci configuration name. | |
| GETTOTALCOUNTS (String HOST) | |
| return total counts for all detectors connected. | |
| GETUAMPS (String HOST, Qualifier TS1MIDNIGHT, Qualifier TS2MIDNIGHT, Qualifier ALLPERIODS) | |
| return good Microamp hours. | |
| HARDWARE_PERIODS (Qualifier ON, Qualifier OFF) | |
| HIDEVI (String VI, String HOST) | |
| Hide a LabVIEW VI front panel. | |
| ISC_SETUP (String INSTRUMENT, Integer MODE, Qualifier NEWDAE, Qualifier REMOTE, Qualifier SCRIPT, Qualifier DIRECT) | |
| Setup a GENIE session for instrument control operations. | |
| LOADCRPT (String FILE) | |
| LOADSCRIPT (String SCRIPT, String DIR) | |
| Load a script file into memory and name it. | |
| LOG_ICP (Generic P1, Generic P2, Generic P3, Generic P4, Generic P5, Generic P6, Qualifier USER, Qualifier LABVIEWSET, Qualifier LABVIEWSETSIGNAL, Qualifier LABVIEWCALLVI, Qualifier CSET, Qualifier LVERROR, Qualifier WAITFOR, Qualifier DAE) | |
| MEASUREMENT (Generic P1, Generic P2, Generic P3, Generic P4, Generic P5, String ID, String SUBID, String TYPE, String SAMPLE_ID, String LABEL, Qualifier NEW, Qualifier GETID, Qualifier GETSUBID, Qualifier GETTYPE, Qualifier GETLABEL, Qualifier GETSAMPLE_ID) | |
| A measurement is a collection of raw data files that are all related together by a measurement ID. | |
| PAUSE (Qualifier IMMEDIATE, Qualifier QUIET) | |
| PAUSE a run. | |
| PAUSE_POSTCMD (Qualifier QUIET) | |
| Called by PAUSE immedately after data collection is actually stopped. | |
| PAUSE_PRECMD (Qualifier QUIET) | |
| Called by PAUSE immedately before data collection is actually stopped. | |
| PRINTISC (String ISCTXT) | |
| PRINTISCN (String ISCTXT) | |
| PULSE_GENERATOR (Qualifier ON, Qualifier OFF) | |
| PUSHLABVIEWBUTTON (String VI, String BUTTONNAME, String HOST, Qualifier WAIT) | |
| Push a button on a LabVIEW VI. | |
| RECOVER () | |
| Recover from an unintentional ABORT command. | |
| RESUME (Qualifier QUIET) | |
| Restart data collection after a PAUSE. | |
| RESUME_POSTCMD (Qualifier QUIET) | |
| Called by RESUME immedately after data collection is actually started. | |
| RESUME_PRECMD (Qualifier QUIET) | |
| Called by RESUME immedately before data collection is actually started. | |
| RUNGENIECOMMAND (String COMMAND, String HOST) | |
| SAMPLE_PAR (String PAR, Workspace EXTRAPARAMS, Qualifier SET, Qualifier GET, Qualifier REMOVE, Qualifier LIST) | |
| Read or write a value on the Sample Parameters VI. | |
| SEPLOT (String BLOCK, Integer RUN_NUMBER, String FILE, Qualifier PLOTAV) | |
| Plot a set of sample environment values from a log file. | |
| SET_FERMI_VETO (Real DELAY, Real WIDTH, Qualifier ON, Qualifier OFF) | |
| set fermi chopper veto parameters. | |
| SET_FIFO_VETO (Qualifier ON, Qualifier OFF) | |
| Set FIFO veto on a running system. | |
| SET_ISC_GLOBALS () | |
| SETLABVIEWVAR (String VI, String VARNAME, Generic VALUE, String HOST, Qualifier NOSIGNAL) | |
| Set a variable on a LabVIEW VI front panel. | |
| SETLABVIEWVARSIGNAL (String VI, String VARNAME, Generic VALUE, String HOST, Qualifier NOREF) | |
| Set a variable on a LabVIEW VI front panel and trigger an event. | |
| SETSCRIPT (String SCRIPTFILENAME) | |
| Define the name of a script to be executed. | |
| SETSCRIPTDIR (String DIRNAME) | |
| Define a default search directory for LOADSCRIPT. | |
| SETSCRIPTNAME (String NAME) | |
| Display the name of a script on the dashboard. | |
| SNAPSHOT_CRPT (String FILE, Qualifier NOUPDATE, Qualifier NOPAUSE) | |
| Update CRPT and save to a named file. | |
| STARTVI (String VI, String HOST, Qualifier WAIT) | |
| Start a LabVIEW VI. | |
| STOPVI (String VI, String HOST) | |
| Stop a LabVIEW VI. | |
| STORE () | |
| Store the CRPT. | |
| SUM_ALL_DAE_MEMORY () | |
| Sum counts in all detector cards in the DAE. | |
| SUM_ALL_SPECTRA () | |
| Sum counts of all spectra defined in the control program. | |
| UNHIDEVI (String VI, String HOST) | |
| Unhide a LabVIEW VI front panel. | |
| UPDATE () | |
| Update CRPT. | |
| UPDATESTORE (Qualifier NOPAUSE) | |
| Perform an UPDATE and STORE in a combined operation. | |
| USER_DETAILS (String PAR, Integer RBNO, String NAME, String INSTITUTE, String ROLE, Qualifier SET, Qualifier GET, Qualifier REMOVE) | |
| Set a value on the User Details VI. | |
| WAITFOR (String BLOCK, Generic VALUE, Generic RANGE, Generic LOWLIMIT, Generic HIGHLIMIT, Generic EXTRAPARAMS, Qualifier ALL, Qualifier ANY) | |
| Wait for a specified condition before proceeding further. | |
| WAITFORALL () | |
| WAITFORANY () | |
| WAITFORBOOLEAN (String VI, String BOOL, String HOST, Qualifier FALSE, Qualifier TRUE) | |
| Wait for a Labview VI boolean variable to become either true or false. | |
| WAITFORBUTTON (String VI, String BUTTON, String HOST) | |
| Wait for a Labview VI button to pop back up. | |
| WAITFORDASHRUNSTATE (String STATE, Integer MAXWAIT, Qualifier FALSE, Qualifier TRUE) | |
| Wait for a particular instrument run state. | |
| WRITEISCOUTPUTFILE (String FILENAME) | |
Definitions for Instrument scriping commands.
These are used to control data acquisition and sample environemnt equipment.
1.6.1
