baseprimitives.gcl File Reference

General hodge podge of useful/essential procedures for running the base GENIE. More...

Functions

 ABORT_EXECUTION (String MESSAGE, Qualifier CTRLC)
 Return control to the command line calling any abort handlers registered with the SET_ABORT_HANDLER command.
 ADD_PARAMETER (String PROC, String PARAM)
 ALIAS (String ALIAS_NAME, String FULL_NAME, Qualifier VAR)
 AS_INTEGER (Real VAR)
 AS_REAL (Generic VAR)
 AS_STRING (Generic VAR, String FORMAT)
 Convert a variable into a String.
 AS_VARIABLE (Generic AVARIABLE)
 BIT_AND (Integer VALUE1, Integer VALUE2)
 BIT_ISSET (Integer VALUE, Integer BIT_NUMBER)
 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.
 CALL_PROCEDURE (String NAME, Generic PP1, Generic PP2, Generic PP3, Generic PP4, Generic PP5, Generic EXTRAPARAMS)
 CALLED_AS_FUNCTION ()
 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.
 CALLOUT (String FACILITY, Integer FUNCTION)
 CENTRE_BINS (Realarray ARRAY)
 COMMENT (String PROC_NAME, String COMMENT_STRING)
 CONVERT (String INPUT_FILE, String OUTPUT_FILE, Qualifier FILE)
 COPYING ()
 CPUTIME (Generic OFFSET)
 CUT (Realarray ARRAY, Integer DIMENSION, Real INDEX)
 DEBUG (Qualifier ON, Qualifier OFF)
 DEFINE_VARIABLE (String VAR, Generic VALUE)
 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.
 EXISTS (String VAR, Qualifier PROC)
 Check if a global variable of a given name exists.
 EXIT ()
 EXTENSION (String NAME)
 Lookup a Rutherford telephone number on the web.
 FIELD_PRESENT (Workspace W, String NAME)
 FIELD_SETVALUE (Workspace W, String NAME, Generic VALUE, Qualifier PRESENT, Qualifier ABSENT)
 FIELD_VALUE (Workspace W, String NAME)
 FIELDS (Integer NUMFIELDS)
 Create a Workspace object of the default or specified size.
 FIELDS_PRESENT (Workspace W, String CLASS, Qualifier ARRAY)
 FILL (Array ARRAY, Generic VALUE, Generic STEP, Qualifier GEOMETRIC)
 Fill a Array with items of one type.
 FIX (Array ARRAY, Generic VALUE)
 FLOAT_AS_STRING (Real VAR, Integer DP)
 Convert a Real variable into a String with a given precision.
 FREE (Generic VARIABLE, String SUBVARIABLE, Qualifier PROC, Qualifier TYPE)
 GCTORTURE (Integer FACILITY, Qualifier ON, Qualifier OFF)
 GETFILELIST (String NAME)
 HOSTINFO ()
 INSPECT (Generic P1)
 INTERACTIVE ()
 IS_A (Generic VAR, String TYPESTRING)
 Test if a variable is of a given type.
 LENGTH (Generic ITEM, Qualifier DIMS)
 LOAD (String FILENAME)
 Load files containing GENIE comamnds into memory.
 LOCATE (Generic ASTRING, Generic SUBSTRING, Integer COUNT)
 LOWERCASE (String S)
 MAX (Array ARRAY, Qualifier SKIPNILS)
 MERGE_WORKSPACES (Workspace W1, Workspace W2, Qualifier REPLACE, Qualifier APPEND, Qualifier ALIAS, Qualifier UPDATE)
 MIN (Array ARRAY, Qualifier SKIPNILS)
 NOW (Qualifier SEC, Qualifier SYSTEM, Qualifier MILLISEC, Qualifier ISO, Qualifier ISOBASIC)
 Print current time.
 OS ()
 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.
 PRINTD (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 LOCATE)
 PRINTDN (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 LOCATE)
 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.
 RANDOM (Integer N)
 READ_TERMINAL (String APROMPT, String ANSWERS)
 READ_VARIABLE (String VAR, Qualifier GLOB)
 REAL_TO_STRING (Real VAL, String FORMAT)
 REDIM (Array ARRAY, Integer I, Integer J, Integer K, Integer L, Qualifier FORCE)
 RENAME (String OLD, String NEW)
 SAVE (String FILENAME)
 Save a snapshot of a session.
 SEARCH (String START, Qualifier PROC, Qualifier VAR, Qualifier CONST, Qualifier SYS, Qualifier CONST2, Qualifier TYPE2, Qualifier TYPE)
 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.
 SET_ABORT_HANDLER (String PROC, Qualifier DEFAULT)
 Define a procedure to be called in the event of a Control-C being received.
 SLEEP (Integer TIME, Qualifier MILLISEC)
 Wait a specified amount of real time before continuing.
 SUBSTRING (String ASTRING, Integer START, Integer LENGTH)
 SUM (Array ARRAY, Integer DIM)
 SYSTEM (String COMMAND)
 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.
 TMPFILE (String PREFIX, String SUFFIX, String DIRECTORY)
 TRANSLATE_PATH (String PATH, Qualifier WRITE, Qualifier VERBOSE, Qualifier NOMESSAGE)
 Translate a path containing logical names.
 UNCENTRE_BINS (Realarray ARRAY, Generic HALFWIDTH, Qualifier HW1)
 UNFIX (Array ARRAY, Generic VALUE)
 UNLINK (String FILE)
 UPPERCASE (String S)
 VERSION ()
 VMSTIME (Integer OFFSET)
 WARRANTY ()
 WIN32 ()

Detailed Description

General hodge podge of useful/essential procedures for running the base GENIE.

Generally these mix Smalltalk with GCL to get the job done!

Careful when editing this as the are some subtle dependencies between these very basic procedures. Undefined variables after a complete load are often the result of getting somthing wrong here!

 All Files Functions Typedefs

Generated on 9 May 2010 for Open GENIE GCL by  doxygen 1.6.1