Special Functions

The section contains functions that are not of general interest:

get_first_active_scan()
Returns the name of the first active SCAN or “0”, if no active SCAN exists:
$name = Spectra::get_first_active_scan();

Spectra::Exp_init()
Initialises an Online session. This function is intended to be used by scripts that are not invoked during an Online session.

Spectra::get_free_line(), Spectra::get_free_slot()
$ret = Spectra::get_free_slot();

Spectra::Gra_init()
Initialises a Spectra session. This function is intended to be used in scripts that are not invoked during a Spectra session. Note that Spectra does not open a graphics terminal, if the environment variable SPECTRA_NOGRAPHIC has been set.

Spectra::Gra_input()
Calls the Spectra command line interface,

memory_free(), memory_total(), meminfo()

memstat()
Return the ratio used/total memory. $ratio = Spectra::memstat();

scan_number()
Returns the last scan number.

search_symbol(), search_scan(), search_gqe()
Return 1, if the specified GQE exists.

sigbus(), sigfpe(), sigint(), sigsegv()
Raise signals.

gra_errno( $code), gra_errno()
gra_errno() returns a reason code that has been set when an error occured. The code is cleared when the function returns. Table 6.2.30 displays the codes that are set by Online. Users may also set a reason code and make use of it.


Table 6.1: Gra_errno() Codes
Code Reason
1 Scan terminated due to beam loss condition (Min_C1)