./toolbox/io
z_index_section__define.pro

INDEX_FILE_SECTION
|
+-ROWS_INDEX_SECTION
  |
  +-z_index_section

All known superclasses:

ROWS_INDEX_SECTION, INDEX_FILE_SECTION

Last modification date:

Wed Sep 28 13:27:15 2016

This class extends the rows_index_section class to properly manage the rows section for a zpectrometer index file; that is, an index file where each row line represents one row of the raw data fromt he zpectrometer

Fields Summary
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  6 routines

function Z_INDEX_SECTION::init(filename)
This class extends the rows_index_section class to properly manage the rows section for a zpectrometer index file; that is, an index file where each row line represents one row of the raw data from the zpectrometer.

function Z_INDEX_SECTION::get_row_info_strct()	private
Returns the special structure needed for zpectrometer data

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

procedure z_index_section__define	private
Defines class structure

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

Z_INDEX_SECTION::init

function Z_INDEX_SECTION::init(filename)

This class extends the rows_index_section class to properly manage the rows section for a zpectrometer index file; that is, an index file where each row line represents one row of the raw data from the zpectrometer.

Inherits

rows_index_section

Z_INDEX_SECTION::get_row_info_strct

private

function Z_INDEX_SECTION::get_row_info_strct()

Returns the special structure needed for zpectrometer data

Returns

z_row_info_strct structure

Z_INDEX_SECTION::trim_row_whitespace

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

z_index_section__define

private

procedure z_index_section__define

Defines class structure

Z_INDEX_SECTION::get_id_start

private

function Z_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 z_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.

Z_INDEX_SECTION::get_id_len

private

function Z_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 z_index it is the TIMESTAMP field. This function returns the length of that field.

Returns

integer specifying the length of the ID field.