Produced by IDL 7.1.1
Developer Documentation

./toolbox/io
cntm_index_section__define.pro

INDEX_FILE_SECTION
|
+-ROWS_INDEX_SECTION
  |
  +-cntm_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 continuum index file; that is, an index file where each row line represents a continuum.

Fields Summary
SCANSTART
integer
.
SCANLEN
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  6 routines

procedure cntm_index_section__define

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

function CNTM_INDEX_SECTION::init(filename)

private

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

function CNTM_INDEX_SECTION::get_row_info_strct()

private

Returns the specail structure needed for spectral cntm data

procedure CNTM_INDEX_SECTION::trim_row_whitespace, rows

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

function CNTM_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 CNTM_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

cntm_index_section__define

procedure cntm_index_section__define

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

Inherits
rows_index_section

CNTM_INDEX_SECTION::init private

function CNTM_INDEX_SECTION::init(filename)

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

Parameters
filename
.

CNTM_INDEX_SECTION::get_row_info_strct private

function CNTM_INDEX_SECTION::get_row_info_strct()

Returns the specail structure needed for spectral cntm data

Returns
cntm_row_info_strct structure

CNTM_INDEX_SECTION::trim_row_whitespace

procedure CNTM_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

CNTM_INDEX_SECTION::get_id_start private

function CNTM_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 cntm_index it is the SCAN field. This function returns the starting location, in each index line, of that field.

Returns
integer specifying the start of the ID field.

CNTM_INDEX_SECTION::get_id_len private

function CNTM_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 cntm_index it is the SCAN field. This function returns the length of that field.

Returns
integer specifying the length of the ID field.


Produced by IDLdoc 1.6 on Wed Sep 28 13:27:24 2016