./toolbox/io
flags_section_one_zero__define.pro

INDEX_FILE_SECTION
|
+-FLAG_FILE_FLAGS_SECTION
  |
  +-flags_section_one_zero

All known superclasses:

FLAG_FILE_FLAGS_SECTION, INDEX_FILE_SECTION

Last modification date:

Wed Sep 28 13:27:11 2016

Routine Summary  8 routines

procedure flags_section_one_zero__define
FLAGS_SECTION_ONE_ZERO is a child class of FLAG_FILE_FLAGS_SECTION and extends that abstract class in order to impliment the flagging file format 1.

function FLAGS_SECTION_ONE_ZERO::init(filename)
Class Constructor: here the actual format of the flag section is spelled out.

function FLAGS_SECTION_ONE_ZERO::get_row_info_strct()
Here the actual structure that represents a line in the flag file is spelled out.

function FLAGS_SECTION_ONE_ZERO::convert_lines_to_strcts(lines)
Spells out how a line in a flag file is converted from a string to a structure

function FLAGS_SECTION_ONE_ZERO::create_flag_rec_string(recnum, _EXTRA=_EXTRA)
Spells out how to convert the set_flag_rec command options into an acutal string to be written to the flag file.

function FLAGS_SECTION_ONE_ZERO::create_flag_scan_string(scan, _EXTRA=_EXTRA)
Spells out how to convert the set_flag command options into an acutal string to be written to the flag file.

function FLAGS_SECTION_ONE_ZERO::get_flag_scan_options_string([intnum=long], [plnum=long], [fdnum=long], [ifnum=long], [bchan=long], [echan=long], [chans=long], [chanwidth=long], [idstring=string])
Spells out the actuall keywords ultimately accepted by the set_flag command.

function FLAGS_SECTION_ONE_ZERO::get_flag_rec_options_string([bchan=long], [echan=long], [chans=long], [chanwidth=long], [idstring=string])
Spells out the actuall keywords ultimately accepted by the set_flag_rec command.

Routine Details

flags_section_one_zero__define

procedure flags_section_one_zero__define

FLAGS_SECTION_ONE_ZERO is a child class of FLAG_FILE_FLAGS_SECTION and extends that abstract class in order to impliment the flagging file format 1.0. Here can be found the actual values for the columns in the flag file, and how the lines for the flag files are converted to structures and vice versa.

FLAGS_SECTION_ONE_ZERO::init

function FLAGS_SECTION_ONE_ZERO::init(filename)

Class Constructor: here the actual format of the flag section is spelled out.

Parameters
filename	.

FLAGS_SECTION_ONE_ZERO::get_row_info_strct

function FLAGS_SECTION_ONE_ZERO::get_row_info_strct()

Here the actual structure that represents a line in the flag file is spelled out.

Returns

a structure representing a line in the flag section

FLAGS_SECTION_ONE_ZERO::convert_lines_to_strcts

function FLAGS_SECTION_ONE_ZERO::convert_lines_to_strcts(lines)

Spells out how a line in a flag file is converted from a string to a structure

Returns

array of flag structures

FLAGS_SECTION_ONE_ZERO::create_flag_rec_string

function FLAGS_SECTION_ONE_ZERO::create_flag_rec_string(recnum, _EXTRA=_EXTRA)

Spells out how to convert the set_flag_rec command options into an acutal string to be written to the flag file.

Returns

string to be written to flag file

FLAGS_SECTION_ONE_ZERO::create_flag_scan_string

function FLAGS_SECTION_ONE_ZERO::create_flag_scan_string(scan, _EXTRA=_EXTRA)

Spells out how to convert the set_flag command options into an acutal string to be written to the flag file.

Returns

string to be written to flag file

FLAGS_SECTION_ONE_ZERO::get_flag_scan_options_string

function FLAGS_SECTION_ONE_ZERO::get_flag_scan_options_string([intnum=long], [plnum=long], [fdnum=long], [ifnum=long], [bchan=long], [echan=long], [chans=long], [chanwidth=long], [idstring=string])

Spells out the actuall keywords ultimately accepted by the set_flag command. Here each keyword is converted to its string equivalent, and concated togethor with the deliminator character to create a bulk of the line representing the flagging rule found in the flag file. CHANS and CHANWIDTH are mutually exclusive to BCHAN and ECHAN, but all these keywords should have validated higher up the chain.

Returns

a string representing the bulk of this flagging rule, to be put in flag file.

FLAGS_SECTION_ONE_ZERO::get_flag_rec_options_string

function FLAGS_SECTION_ONE_ZERO::get_flag_rec_options_string([bchan=long], [echan=long], [chans=long], [chanwidth=long], [idstring=string])

Spells out the actuall keywords ultimately accepted by the set_flag_rec command. Here each keyword is converted to its string equivalent, and concated togethor with the deliminator character to create a bulk of the line representing the flagging rule found in the flag file. CHANS and CHANWIDTH are mutually exclusive to BCHAN and ECHAN, but all these keywords should have validated higher up the chain.

Returns

a string representing the bulk of this flagging rule, to be put in flag file.