./toolbox/io
line_index_section__define.pro

INDEX_FILE_SECTION
|
+-ROWS_INDEX_SECTION
  |
  +-line_index_section

All known superclasses:

ROWS_INDEX_SECTION, INDEX_FILE_SECTION

Last modification date:

Wed Sep 28 13:27:14 2016

This class extends the rows_index_section class to properly manage the rows section for a spectral line index file; that is, an index file where each row line represents a spectrum.

Fields Summary
OLD_FORMAT_STRING string	.
LONG_INDEX_FORMAT_STRING string	.
LONG_ROW_FORMAT_STRING string	.
TSSTART integer	.
TSLEN integer	.

Fields inherited from ROWS_INDEX_SECTION:

pointer   ROWS pointer   FRMT pointer   FRMT_QUIET pointer   FRMT_USER pointer   PARAM_TYPES string   FLOAT_FORMAT string   FORMAT_STRING string   FORMAT_HEADER integer   INDEX_HEADER integer   LIST_HEADER integer   COLUMN_NAME integer   INDEX_VALUE integer   LIST_VALUE integer   COLUMN_TYPE integer   MORE_FORMAT pointer   TMP_ROW pointer   TMP_LINES longword integer   NUM_TMP_LINES longword integer   MAX_TMP_LINES

Fields inherited from INDEX_FILE_SECTION:

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

Routine Summary  10 routines

procedure line_index_section__define
This class extends the rows_index_section class to properly manage the rows section for a spectral line index file; that is, an index file where each row line represents a spectrum.

function LINE_INDEX_SECTION::init(filename)	private
Class Constructor Here the formats for the rows are determined: how to list them verbosly and quietly.

procedure LINE_INDEX_SECTION::create_formats	private
Uses format array to create format strings for printing/reading index file.

function LINE_INDEX_SECTION::get_row_info_strct()	private
Returns the specail structure needed for spectal line data

procedure LINE_INDEX_SECTION::trim_row_whitespace, rows
Trims whitespace from structure string fields that represent columns in an index file

function LINE_INDEX_SECTION::get_format(row_struct)	private
Given a row structure, return the appropriate format for it based on the index and row value.

procedure LINE_INDEX_SECTION::write_rows, row_strcts	private
Writes the information in rows_structs to the index file using the current self.

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

function LINE_INDEX_SECTION::get_id_start()	private
The ID is the index field used by index_iterator for this type of index to know how many rows to group in at each next call.

function LINE_INDEX_SECTION::get_id_len()	private
The ID is the index field used by index_iterator for this type of index to know how many rows to group in at each next call.

Routine Details

line_index_section__define

procedure line_index_section__define

This class extends the rows_index_section class to properly manage the rows section for a spectral line index file; that is, an index file where each row line represents a spectrum.

Inherits

rows_index_section

LINE_INDEX_SECTION::init

private

function LINE_INDEX_SECTION::init(filename)

Class Constructor Here the formats for the rows are determined: how to list them verbosly and quietly.

Parameters
filename	.

LINE_INDEX_SECTION::create_formats

private

procedure LINE_INDEX_SECTION::create_formats

Uses format array to create format strings for printing/reading index file. Results get stored in object fields: format_string, format_header

LINE_INDEX_SECTION::get_row_info_strct

private

function LINE_INDEX_SECTION::get_row_info_strct()

Returns the specail structure needed for spectal line data

Returns

line_row_info_strct structure

LINE_INDEX_SECTION::trim_row_whitespace

procedure LINE_INDEX_SECTION::trim_row_whitespace, rows

Trims whitespace from structure string fields that represent columns in an index file

Parameters
rows in, required array	string array of index column values

LINE_INDEX_SECTION::get_format

private

function LINE_INDEX_SECTION::get_format(row_struct)

Given a row structure, return the appropriate format for it based on the index and row value. This is necessary only until the next version change to make sure the patch/hack necessary to read long index and long row values is backwards compatible with this release of GBTIDL and this index version.

Returns

format string

LINE_INDEX_SECTION::write_rows

private

procedure LINE_INDEX_SECTION::write_rows, row_strcts

Writes the information in rows_structs to the index file using the current self.format_string. Only needed here until next index version number change.

Parameters
row_strcts in, required struct array	the index values to write, in the same order as expected by the format string, one row_strcts element for each line to be written.

LINE_INDEX_SECTION::overwrite_row

procedure LINE_INDEX_SECTION::overwrite_row, index_num, row

Overwrites a row in the index with a new one. Only needed here until next index version number change.

Uses

get_line_number

LINE_INDEX_SECTION::get_id_start

private

function LINE_INDEX_SECTION::get_id_start()

The ID is the index field used by index_iterator for this type of index to know how many rows to group in at each next call. For line_index it is the TIMESTAMP field. This function returns the starting location, in each index line, of that field.

Returns

integer specifying the start of the ID field.

LINE_INDEX_SECTION::get_id_len

private

function LINE_INDEX_SECTION::get_id_len()

The ID is the index field used by index_iterator for this type of index to know how many rows to group in at each next call. For line_index it is the TIMESTAMP field. This function returns the length of that field.

Returns

integer specifying the length of the ID field.