./toolbox/io
online_status_file__define.pro

Last modification date:

Wed Sep 28 13:27:14 2016

ONLINE_STATUS_FILE is for internal use to support interactions with the status file produced by the online sdfits daemon in Green Bank.

Routine Summary  10 routines

procedure online_status_file__define
ONLINE_STATUS_FILE is for internal use to support interactions with the status file produced by the online sdfits daemon in Green Bank.

function ONLINE_STATUS_FILE::init(onlinedir)	private
Called at instantiation of this class.

procedure ONLINE_STATUS_FILE::init_info, strct, backend	private
Initialize an online_status_info_strct structure with the given backend name

function ONLINE_STATUS_FILE::read()	private
Read the status file and update in the info structures

function ONLINE_STATUS_FILE::get_status()
The current status of this object.

function ONLINE_STATUS_FILE::update()	private
Update the info.

procedure ONLINE_STATUS_FILE::set_age_field, strct	private
Sets the age field.

function ONLINE_STATUS_FILE::get_status_info(backend)	private
Returns the status info structure for the desired backend.

function ONLINE_STATUS_FILE::get_all_infos(acs, dcr, sp, zpec, vegas, status)	private
Get all the status records in one call.

function ONLINE_STATUS_FILE::get_filenames(acsf, dcrf, spf, zpecf, vegasf, status)	private
For use with old style inquiry.

Routine Details

online_status_file__define

procedure online_status_file__define

ONLINE_STATUS_FILE is for internal use to support interactions with the status file produced by the online sdfits daemon in Green Bank.

Uses

online_status_info which declares the structure used to hold the information - online_status_info_strct

Version

$Id$

ONLINE_STATUS_FILE::init

private

function ONLINE_STATUS_FILE::init(onlinedir)

Called at instantiation of this class.

Returns

1 on success, 0 on failure (missing or bad status file).

Uses

online_sdfits_file::read

ONLINE_STATUS_FILE::init_info

private

procedure ONLINE_STATUS_FILE::init_info, strct, backend

Initialize an online_status_info_strct structure with the given backend name

Parameters
strct	.
backend	.

ONLINE_STATUS_FILE::read

private

function ONLINE_STATUS_FILE::read()

Read the status file and update in the info structures

Returns

1 on success, 0 on failure (missing or bad status file).

ONLINE_STATUS_FILE::get_status

function ONLINE_STATUS_FILE::get_status()

The current status of this object. 1 is OK, 0 means there was a problem reading the status info file.

ONLINE_STATUS_FILE::update

private

function ONLINE_STATUS_FILE::update()

Update the info. Only invokes read when the file's mtime has changed.

ONLINE_STATUS_FILE::set_age_field

private

procedure ONLINE_STATUS_FILE::set_age_field, strct

Sets the age field.

Parameters
strct	.

ONLINE_STATUS_FILE::get_status_info

private

function ONLINE_STATUS_FILE::get_status_info(backend)

Returns the status info structure for the desired backend.

Parameters
backend	.

ONLINE_STATUS_FILE::get_all_infos

private

function ONLINE_STATUS_FILE::get_all_infos(acs, dcr, sp, zpec, vegas, status)

Get all the status records in one call.

Returns

the status of the most recent spectral line file (vegas, acs or sp)

ONLINE_STATUS_FILE::get_filenames

private

function ONLINE_STATUS_FILE::get_filenames(acsf, dcrf, spf, zpecf, vegasf, status)

For use with old style inquiry. Just return the file name for each backend. Also return the most recently modified spectral line (acs or sp) file as the return argument. Status is the status of this object. 1 is OK, 0 there is a problem reading the online status file.

Parameters
acsf	.
dcrf	.
spf	.
zpecf	.
vegasf	.
status	.