./toolbox/io
rows_index_section__define.pro

INDEX_FILE_SECTION
|
+-rows_index_section

All known superclasses:

INDEX_FILE_SECTION

Last modification date:

Thu Jun 2 23:56:08 2005

This virtual class extends the index_file_section class, but is extended by the line_index_section and cntm_index_section to manage the rows section of spectral line index files and continuum index files, respectively.

Fields Summary
ROWS pointer	pointer to array of structures mirroring index rows section
FRMT pointer	pointer to 3xN array of formats for printing rows section
FRMT_QUIET pointer	pointer to array of integers determining which columns are used for 'quiet' listing
FRMT_USER pointer	.
FLOAT_FORMAT string	string representing how all floats are to be printed
FORMAT_STRING string	string used for reading index lines into row structures. determined by frmt array
FORMAT_HEADER string	top row to be printed in listings
FORMAT_STRING_QUIET string	less verbose equivalient of format_string
FORMAT_HEADER_QUIET string	less verbose equivalent of format_header
FORMAT_STRING_USER string	.
FORMAT_HEADER_USER string	.
MORE_FORMAT integer	.

Fields inherited from INDEX_FILE_SECTION:

longword integer   LINES_INCR longword integer   MAX_LINE_WIDTH longword integer   NUM_LINES string   FILENAME longword integer   LUN string   SECTION_MARKER pointer   LINE_NUMS pointer   LINES longword integer   SECTION_READ longword integer   ALLOW_APPEND longword integer   PAD_WIDTH longword integer   DEBUG

Routine Summary  30 routines

procedure rows_index_section__define
This virtual class extends the index_file_section class, but is extended by the line_index_section and cntm_index_section to manage the rows section of spectral line index files and continuum index files, respectively.

function ROWS_INDEX_SECTION::init(lun, filename)	private
Class Constructor

procedure ROWS_INDEX_SECTION::cleanup	private
Class Destructor

procedure ROWS_INDEX_SECTION::create
Creates rows section, but writes no actual rows to it, just the section marker, and the format_header ("#INDX FILES etc.

function ROWS_INDEX_SECTION::get_rows()
Retrieves the arrays of structures that mirror the lines in the row section

function ROWS_INDEX_SECTION::get_num_rows()
Retrieves the number of rows in the rows section, not counting the marker and the format header

function ROWS_INDEX_SECTION::read_file()
Reads the rows section into memory, then converts all lines (array of strings) into row structures

procedure ROWS_INDEX_SECTION::create_formats	private
Uses format array to create format strings for printing index file and listings.

procedure ROWS_INDEX_SECTION::create_user_formats	private
Uses format array to create the user specified format strings for printing index file and listings.

procedure ROWS_INDEX_SECTION::list, rows=rows, verbose=verbose, columns=columns, _EXTRA=_EXTRA
Prints the rows section of the index file for those rows specified

procedure ROWS_INDEX_SECTION::list_given_columns, columns, rows=rows

procedure ROWS_INDEX_SECTION::list_user, rows=rows

function ROWS_INDEX_SECTION::get_frmt_index(frmt_header)	private
Returns index of format specification according to header name

function ROWS_INDEX_SECTION::get_frmt_header_keyword(frmt_header)	private
Uses the objects format array to build a string for one formated header word

function ROWS_INDEX_SECTION::get_frmt_row_value(frmt_header, row)	private
Uses the objects format array to build a formated string of a value from the index file

procedure ROWS_INDEX_SECTION::write_rows, row_strcts

function ROWS_INDEX_SECTION::get_line_number(index_num[, row_index])
Retrieves the line number in the file of a row with the given index number

procedure ROWS_INDEX_SECTION::overwrite_row, index_num, row
Overwrites a row in the index with a new one

procedure ROWS_INDEX_SECTION::overwrite_row_column, index_num, column_name, value
Overwirtes a specific value in a row within the index file

procedure ROWS_INDEX_SECTION::set_more_format_on
Sets the object to print rows using the interactive 'more' format

procedure ROWS_INDEX_SECTION::set_more_format_off
Sets the object NOT to print rows using the interactive 'more' format

procedure ROWS_INDEX_SECTION::print_line, line, lun, _EXTRA=_EXTRA
Prints a line either to stdout, or using the interactive 'more' format

procedure ROWS_INDEX_SECTION::list_available_columns
Prints the available columns for list; these are also the valid search keywords

procedure ROWS_INDEX_SECTION::list_user_columns
Prints the columns currently selected for the user specified listing

function ROWS_INDEX_SECTION::get_format_keywords()
Extracts just the keywords from the format array

function ROWS_INDEX_SECTION::get_format_index(keyword)
Find the index for a keyword in the format array @ returns the index for the given keyword; -1 if not found

procedure ROWS_INDEX_SECTION::add_user_column, column
Adds a column to the list of user columns

procedure ROWS_INDEX_SECTION::set_user_columns, columns
Sets what columns should be used for user listing

function ROWS_INDEX_SECTION::get_available_columns()
Returns the available columns for list; these are also the valid search keywords

procedure ROWS_INDEX_SECTION::read_new_rows[, num_new_lines]
For reading into memory the new rows that may have been written to the index file ( by hand, or by an online process ).

Routine Details

rows_index_section__define

procedure rows_index_section__define

This virtual class extends the index_file_section class, but is extended by the line_index_section and cntm_index_section to manage the rows section of spectral line index files and continuum index files, respectively.

Inherits

index_file_section

ROWS_INDEX_SECTION::init

private

function ROWS_INDEX_SECTION::init(lun, filename)

Class Constructor

Parameters
lun	.
filename	.

ROWS_INDEX_SECTION::cleanup

private

procedure ROWS_INDEX_SECTION::cleanup

Class Destructor

ROWS_INDEX_SECTION::create

procedure ROWS_INDEX_SECTION::create

Creates rows section, but writes no actual rows to it, just the section marker, and the format_header ("#INDX FILES etc..").

ROWS_INDEX_SECTION::get_rows

function ROWS_INDEX_SECTION::get_rows()

Retrieves the arrays of structures that mirror the lines in the row section

Returns

arrays of structures that mirror the lines in the row section

ROWS_INDEX_SECTION::get_num_rows

function ROWS_INDEX_SECTION::get_num_rows()

Retrieves the number of rows in the rows section, not counting the marker and the format header

Returns

number of rows in the rows section

ROWS_INDEX_SECTION::read_file

function ROWS_INDEX_SECTION::read_file()

Reads the rows section into memory, then converts all lines (array of strings) into row structures

Uses

INDEX_FILE_SECTION::read_file()

ROWS_INDEX_SECTION::create_formats

private

procedure ROWS_INDEX_SECTION::create_formats

Uses format array to create format strings for printing index file and listings. Results get stored in object fields: format_string, format_header, format_string_quiet, and format_header_quiet

ROWS_INDEX_SECTION::create_user_formats

private

procedure ROWS_INDEX_SECTION::create_user_formats

Uses format array to create the user specified format strings for printing index file and listings. Results get stored in object fields: format_string_user, and format_header_user

ROWS_INDEX_SECTION::list

procedure ROWS_INDEX_SECTION::list, rows=rows, verbose=verbose, columns=columns, _EXTRA=_EXTRA

Prints the rows section of the index file for those rows specified

Keywords
rows	the row numbers which are to be printed
verbose	set to true and ALL info on each row is printed, otherwise just select columns printed
columns	.
_EXTRA	.

ROWS_INDEX_SECTION::list_given_columns

procedure ROWS_INDEX_SECTION::list_given_columns, columns, rows=rows

Parameters
columns	.

Keywords
rows	.

ROWS_INDEX_SECTION::list_user

procedure ROWS_INDEX_SECTION::list_user, rows=rows

Keywords
rows	.

ROWS_INDEX_SECTION::get_frmt_index

private

function ROWS_INDEX_SECTION::get_frmt_index(frmt_header)

Returns index of format specification according to header name

Parameters
frmt_header in, required string	header keyword: must match exactly with what list prints.

ROWS_INDEX_SECTION::get_frmt_header_keyword

private

function ROWS_INDEX_SECTION::get_frmt_header_keyword(frmt_header)

Uses the objects format array to build a string for one formated header word

Parameters
frmt_header in, required string	header keyword: must match exactly with what list prints.

ROWS_INDEX_SECTION::get_frmt_row_value

private

function ROWS_INDEX_SECTION::get_frmt_row_value(frmt_header, row)

Uses the objects format array to build a formated string of a value from the index file

Parameters
frmt_header in, required string	header keyword: must match exactly with what list prints.
row in, required struct	structure reflecting one row from the index file

ROWS_INDEX_SECTION::write_rows

procedure ROWS_INDEX_SECTION::write_rows, row_strcts

Parameters
row_strcts	.

ROWS_INDEX_SECTION::get_line_number

function ROWS_INDEX_SECTION::get_line_number(index_num[, row_index])

Retrieves the line number in the file of a row with the given index number

Returns

the line number (zero based) in the file where this index number is located

ROWS_INDEX_SECTION::overwrite_row

procedure ROWS_INDEX_SECTION::overwrite_row, index_num, row

Overwrites a row in the index with a new one

Uses

get_line_number

ROWS_INDEX_SECTION::overwrite_row_column

procedure ROWS_INDEX_SECTION::overwrite_row_column, index_num, column_name, value

Overwirtes a specific value in a row within the index file

Uses

overwrite_row

ROWS_INDEX_SECTION::set_more_format_on

procedure ROWS_INDEX_SECTION::set_more_format_on

Sets the object to print rows using the interactive 'more' format

ROWS_INDEX_SECTION::set_more_format_off

procedure ROWS_INDEX_SECTION::set_more_format_off

Sets the object NOT to print rows using the interactive 'more' format

ROWS_INDEX_SECTION::print_line

procedure ROWS_INDEX_SECTION::print_line, line, lun, _EXTRA=_EXTRA

Prints a line either to stdout, or using the interactive 'more' format

Parameters
line	.
lun	.

Keywords
_EXTRA	.

ROWS_INDEX_SECTION::list_available_columns

procedure ROWS_INDEX_SECTION::list_available_columns

Prints the available columns for list; these are also the valid search keywords

ROWS_INDEX_SECTION::list_user_columns

procedure ROWS_INDEX_SECTION::list_user_columns

Prints the columns currently selected for the user specified listing

ROWS_INDEX_SECTION::get_format_keywords

function ROWS_INDEX_SECTION::get_format_keywords()

Extracts just the keywords from the format array

Returns

keywords from the format array

ROWS_INDEX_SECTION::get_format_index

function ROWS_INDEX_SECTION::get_format_index(keyword)

Find the index for a keyword in the format array @ returns the index for the given keyword; -1 if not found

Parameters
keyword	.

ROWS_INDEX_SECTION::add_user_column

procedure ROWS_INDEX_SECTION::add_user_column, column

Adds a column to the list of user columns

Parameters
column	.

ROWS_INDEX_SECTION::set_user_columns

procedure ROWS_INDEX_SECTION::set_user_columns, columns

Sets what columns should be used for user listing

Parameters
columns in, required string array	array of columns to print on list command

ROWS_INDEX_SECTION::get_available_columns

function ROWS_INDEX_SECTION::get_available_columns()

Returns the available columns for list; these are also the valid search keywords

ROWS_INDEX_SECTION::read_new_rows

procedure ROWS_INDEX_SECTION::read_new_rows[, num_new_lines]

For reading into memory the new rows that may have been written to the index file ( by hand, or by an online process ). Jumps to previous last line, and reads new rows.

Parameters
num_new_lines out, optional variable	number of new lines found in file