Definitions for Instrument scriping commands. More...
Functions | |
| ABORT (Qualifier QUIET) | |
| Abort a run. | |
| ABORT_EXECUTION (String MESSAGE, Qualifier CTRLC) | |
| Return control to the command line calling any abort handlers registered with the SET_ABORT_HANDLER command. | |
| 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. | |
| ALTER (Generic P1, Generic P2, Generic P3, Generic P4, Real XMIN, Real XMAX, Real YMIN, Real YMAX, Qualifier BINNING, Qualifier MARKERS, Qualifier PLOT, Qualifier DEVICE, Qualifier HARDCOPY, Qualifier TEXTHEIGHT, Qualifier FONT, Qualifier LINETYPE, Qualifier TEXTCOLOUR, Qualifier LINECOLOUR, Qualifier PLOTCOLOUR, Qualifier SIZE, Qualifier LINEWIDTH, Qualifier MARKERSIZE, Qualifier STATUS, Qualifier BACKGROUND, Qualifier FOREGROUND, Qualifier CURSORFORMAT) | |
| Change defaults used by PLOT() and DISPLAY() commands. | |
| AS_STRING (Generic VAR, String FORMAT) | |
| Convert a variable into a String. | |
| ASCIIFILE (Generic P1, Generic P2, Generic P3, Generic P4, Generic P5, Generic P6, Generic P7, Generic P8, Generic P9, Generic P10, Generic P11, Generic P12, Generic P13, String FILE, Generic HANDLE, String COMMENT, String DELIMITER, Integer NLINES, String FORMAT, String SEPARATOR, Integer COUNT, String FIELDS, Generic GV1, Generic GV2, Generic GV3, Generic GV4, Generic GV5, Generic GV6, Generic GV7, Generic GV8, Generic GV9, Generic GV10, Generic GVARRAY, Qualifier OPEN, Qualifier CLOSE, Qualifier SKIP, Qualifier LINES, Qualifier READFREE, Qualifier READFIXED, Qualifier DATA, Qualifier RESET, Qualifier WRITEFREE, Qualifier WRITEFIXED, Qualifier REWIND, Qualifier OPENSTRING, Qualifier NEW, Qualifier SOCKET, Qualifier VALID, Qualifier READONLY, Qualifier EXISTS, Qualifier WRITEBINARY) | |
| write an ASCII file to disk | |
| ASSIGN (Generic P1, Generic DUMMY, Qualifier DAE) | |
| Construct a filename and make it the default input source. | |
| 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. | |
| BUILD_ARRAY (Generic V1, Generic V2, Generic V3, Generic V4, Generic V5, Generic V6, Generic V7, Generic V8, Qualifier DCOM) | |
| Build an array from parameter list. | |
| CALLING_PROCEDURE (Generic LEVEL) | |
| Return the name of the current executing procedure (level=0) or that which called the current executing procedure (level=1, the default) If the command is invoked directly from the command line, there is no parent procedure and so this return undefined. | |
| 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. | |
| CFN (Generic P1, Integer NUMBER, String NAME, Qualifier DISKDIR) | |
| Construct a full filename from various information. | |
| 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 | |
| DCOM (Generic P1, Generic P2, Generic P3, Generic P4, Generic P5, Generic P6, Generic P7, Generic P8, Generic P9, String PROGID, Integerarray CLSID, Cominterface PDISP, String NAME, Integer VALUE, String ARGOPTS, String HOST, String CLSID_STRING, String USER, String DOMAIN, String PASS, Generic ARG1, Generic ARG2, Generic ARG3, Generic ARG4, Generic ARG5, Generic ARG6, Qualifier CREATE, Qualifier REUSE, Qualifier ACTIVE, Qualifier CLEANUP, Qualifier CALL, Qualifier PROPGET, Qualifier PROPPUT, Qualifier DEFAULT, Qualifier ALL) | |
| Make a DCOM call. | |
| DEFINED (Generic VAR) | |
| Check if a variable is defined. | |
| DIMENSIONALITY (Generic ARRAY) | |
| Return dimensionality of an Array. | |
| DIMENSIONS (Integer DIM1, Integer DIM2, Integer DIM3, Integer DIM4, Integer DIM5, Integer DIM6, Integer DIM7, Integer DIM8, Integer DIM9, Integer DIM10) | |
| Create an Array of a given size, but unspecified type. | |
| DISPLAY (Generic P1, Generic P2, Generic P3, Generic P4, Generic P5, Generic P6, Generic P7, Generic P8, Generic P9, Workspace WKSP, Real XMIN, Real XMAX, Real YMIN, Real YMAX, Colour PLOTCOLOUR, Real LINEWIDTH, Colour TEXTCOLOUR, Real TEXTHEIGHT, Real MIN, Real MAX, String TWODLABEL, Colour LINECOLOUR, Qualifier MARKERS, Qualifier LINE, Qualifier ERRORS, Qualifier HISTOGRAM, Qualifier SQRT, Qualifier LOG, Qualifier LINEAR, Qualifier SMOOTH, Qualifier RAW) | |
| Display a Workspace on the screen. | |
| 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. | |
| EXISTS (String VAR, Qualifier PROC) | |
| Check if a global variable of a given name exists. | |
| EXTENSION (String NAME) | |
| Lookup a Rutherford telephone number on the web. | |
| FIELDS (Integer NUMFIELDS) | |
| Create a Workspace object of the default or specified size. | |
| FILETYPE (String FILE) | |
| Determine the type of a file. | |
| FILL (Array ARRAY, Generic VALUE, Generic STEP, Qualifier GEOMETRIC) | |
| Fill a Array with items of one type. | |
| FINDXVAL (Realarray XARRAY, Realarray YARRAY, Real YVAL) | |
| This routine will search YARRAY for YVAL and return a workspace W with W.I the left index of the range containing YVAL W.X the linearly interpolated XVAL corresponding to YVAL. | |
| FLOAT_AS_STRING (Real VAR, Integer DP) | |
| Convert a Real variable into a String with a given precision. | |
| GET (Generic ITEM, String FILE, Generic ITEM_ARGS, String HOST, Qualifier ARRAY, Qualifier REMOTE, Qualifier NEWICP) | |
| Read a spectrum from a data source. | |
| GETBLOCKS () | |
| Update GENIE session with sample environment block information on SECI. | |
| GETFRAMES (String HOST, Qualifier ALLPERIODS) | |
| return current good frames. | |
| 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. | |
| 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. | |
| HIDEVI (String VI, String HOST) | |
| Hide a LabVIEW VI front panel. | |
| INTERPOLATE (Realarray XFIT, Realarray YFIT, Realarray XINT, Qualifier CSPLINE) | |
| res.y interpolated Y res.yd first derivative res.ydd second derivative | |
| IS_A (Generic VAR, String TYPESTRING) | |
| Test if a variable is of a given type. | |
| ISC_SETUP (String INSTRUMENT, Integer MODE, Qualifier NEWDAE, Qualifier REMOTE, Qualifier SCRIPT, Qualifier DIRECT) | |
| Setup a GENIE session for instrument control operations. | |
| LOAD (String FILENAME) | |
| Load files containing GENIE comamnds into memory. | |
| LOADSCRIPT (String SCRIPT, String DIR) | |
| Load a script file into memory and name it. | |
| 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. | |
| NOW (Qualifier SEC, Qualifier SYSTEM, Qualifier MILLISEC, Qualifier ISO, Qualifier ISOBASIC) | |
| Print current time. | |
| 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. | |
| PLOT (Workspace WKSP, Integer BINNING, Qualifier HISTOGRAM, Qualifier LINE, Qualifier MARKERS, Qualifier ERRORS) | |
| Over Plot a Workspace on the screen. | |
| PRINT (Generic P1, Generic P2, Generic P3, Generic P4, Generic P5, Generic P6, Generic P7, Generic P8, Generic P9, Generic P10, Generic P11, Generic P12, Generic P13, Generic P14, Generic P15, Generic P16, Generic P17, Generic P18, Generic P19, Generic P20) | |
| The PRINT and PRINTN commands differ only in that PRINTN adds a trailing newline where PRINT does not. | |
| PRINTE (Generic P1, Generic P2, Generic P3, Generic P4, Generic P5, Generic P6, Generic P7, Generic P8, Generic P9, Generic P10, Generic P11, Generic P12, Generic P13, Generic P14, Generic P15, Generic P16, Generic P17, Generic P18, Generic P19, Generic P20, Qualifier NOLOCATE) | |
| Print an error (usually red) message to the screen. | |
| PRINTEN (Generic P1, Generic P2, Generic P3, Generic P4, Generic P5, Generic P6, Generic P7, Generic P8, Generic P9, Generic P10, Generic P11, Generic P12, Generic P13, Generic P14, Generic P15, Generic P16, Generic P17, Generic P18, Generic P19, Generic P20, Qualifier NOLOCATE) | |
| PRINTI (Generic P1, Generic P2, Generic P3, Generic P4, Generic P5, Generic P6, Generic P7, Generic P8, Generic P9, Generic P10, Generic P11, Generic P12, Generic P13, Generic P14, Generic P15, Generic P16, Generic P17, Generic P18, Generic P19, Generic P20) | |
| Print an informational (usually blue) message to the screen. | |
| PRINTIN (Generic P1, Generic P2, Generic P3, Generic P4, Generic P5, Generic P6, Generic P7, Generic P8, Generic P9, Generic P10, Generic P11, Generic P12, Generic P13, Generic P14, Generic P15, Generic P16, Generic P17, Generic P18, Generic P19, Generic P20) | |
| Print an informational (usually blue) message to the screen with a trailing newline. | |
| PRINTN (Generic P1, Generic P2, Generic P3, Generic P4, Generic P5, Generic P6, Generic P7, Generic P8, Generic P9, Generic P10, Generic P11, Generic P12, Generic P13, Generic P14, Generic P15, Generic P16, Generic P17, Generic P18, Generic P19, Generic P20) | |
| Print something to the screen with a trailing newline. | |
| 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. | |
| S (Generic SPECTRA, String FILE) | |
| Read a spectrum. Shorthand for GET. | |
| SAMPLE_PAR (String PAR, Workspace EXTRAPARAMS, Qualifier SET, Qualifier GET, Qualifier REMOVE, Qualifier LIST) | |
| Read or write a value on the Sample Parameters VI. | |
| SAVE (String FILENAME) | |
| Save a snapshot of a session. | |
| SEARCHPATH (String NAME, String PATH1, String PATH2, String PATH3, String PATH4, String PATH5, Stringarray PATHS, Qualifier APPEND, Qualifier PREPEND, Qualifier DEFAULT, Qualifier SHOWALL) | |
| Define a search path (like a VMS logical name). | |
| SEND_EMAIL (String ADDRESS, String SUBJECT, String MESSAGE) | |
| Send an email. | |
| SEND_SMS (String NUMBER, String MESSAGE) | |
| Send a text message. | |
| SEPLOT (String BLOCK, Integer RUN_NUMBER, String FILE, Qualifier PLOTAV) | |
| Plot a set of sample environment values from a log file. | |
| SET (Generic VALUE, Qualifier DISK, Qualifier DIRECTORY, Qualifier INSTRUMENT, Qualifier EXTENSION, Qualifier I, Qualifier DIR, Qualifier E, Qualifier SOURCE, Qualifier S, Qualifier INPUT, Qualifier OUTPUT, Qualifier FILE, Qualifier DAE, Qualifier CRPT, Qualifier INST, Qualifier EXT, Qualifier INSTITUTE, Qualifier PATH, Qualifier DIGITS) | |
| SET various defaults. | |
| SET_ABORT_HANDLER (String PROC, Qualifier DEFAULT) | |
| Define a procedure to be called in the event of a Control-C being received. | |
| 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. | |
| 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. | |
| SHOW (Workspace WKSP, Generic XMIN, Generic XMAX, Qualifier DISK, Qualifier DIRECTORY, Qualifier INSTRUMENT, Qualifier EXTENSION, Qualifier I, Qualifier DIR, Qualifier E, Qualifier FILE, Qualifier F, Qualifier IO, Qualifier EXT, Qualifier INST, Qualifier DEFAULTS, Qualifier DEF, Qualifier PROC, Qualifier PAR, Qualifier TITLE, Qualifier T, Qualifier DATA, Qualifier VAR, Qualifier SYS, Qualifier TYPE, Qualifier CONST, Qualifier PATH, Qualifier DIGITS) | |
| Display values of various parameters. | |
| SLEEP (Integer TIME, Qualifier MILLISEC) | |
| Wait a specified amount of real time before continuing. | |
| 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. | |
| TCPIPGET (String MESSAGE, String SERVER, Integer PORT) | |
| Connect to a TCP socket and return information. | |
| TESTMODE (Qualifier ENABLE, Qualifier DISABLE) | |
| Enable or disable script test mode. | |
| THIS_PROCEDURE () | |
| Return the name of the procedure that is currently executing. | |
| TIME_FROM_ISOTIME (Stringarray ISOTIME) | |
| Convert an array of ISO format time string into a plottable value. | |
| TOGGLE (Boolean VAL, Qualifier STATUS, Qualifier LOGX, Qualifier LOGY, Qualifier CLEAR, Qualifier MODE, Qualifier CHAR, Qualifier HEADER, Qualifier RX, Qualifier RY, Qualifier INFO, Qualifier GRATICULE, Qualifier ON, Qualifier OFF, Qualifier NOMESSAGE, Qualifier DEBUG) | |
| Change behaviour of various commands. | |
| TRANSLATE_PATH (String PATH, Qualifier WRITE, Qualifier VERBOSE, Qualifier NOMESSAGE) | |
| Translate a path containing logical names. | |
| 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. | |
| 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. | |
| WRITE (Generic P1, Generic P2, Generic P3, Generic P4, Generic P5, Generic P6, Generic P7, Generic P8, Generic P9, Generic P10, Generic P11, Generic P12, String FILE, String FORMAT, String COMMENT, Integer STREAM_ID, Generic GV1, Generic GV2, Generic GV3, Generic GV4, Generic GV5, Generic GV6, Generic GV7, Generic GV8, Generic GV9, Qualifier ASCII, Qualifier COLUMNS, Qualifier STREAM, Qualifier APPEND) | |
| Write a file to disk. | |
Definitions for Instrument scriping commands.
These are used to control data acquisition and sample environemnt equipment.
1.6.1
