OpenCPN Partial API docs
Loading...
Searching...
No Matches
Public Attributes | List of all members
IDX_entry Class Reference

Represents an index entry for tidal and current data. More...

#include <IDX_entry.h>

Public Attributes

source_data_t source_data_type
 Format of the source data (ASCII or binary)
 
TCDataSource * pDataSource
 Pointer to the associated data source.
 
char source_ident [MAXNAMELEN]
 Identifier of the source (typically file name)
 
int IDX_rec_num
 Record number for multiple entries with same name.
 
char IDX_type
 Entry type identifier "TCtcIUu".
 
char IDX_zone [40]
 Geographic zone identifier.
 
char IDX_station_name [MAXNAMELEN]
 Name of the tidal or current station.
 
double IDX_lon
 Longitude of the station (in degrees, +East)
 
double IDX_lat
 Latitude of the station (in degrees, +North)
 
int IDX_ht_time_off
 High tide time offset (in minutes)
 
float IDX_ht_mpy
 High tide height multiplier.
 
float IDX_ht_off
 High tide height offset.
 
int IDX_lt_time_off
 Low tide time offset (in minutes)
 
float IDX_lt_mpy
 Low tide height multiplier.
 
float IDX_lt_off
 Low tide height offset.
 
int IDX_sta_num
 Subordinate station number (UNUSED)
 
int IDX_flood_dir
 Flood current direction (in degrees)
 
int IDX_ebb_dir
 Ebb current direction (in degrees)
 
int IDX_Useable
 Flag indicating if the entry is usable.
 
int Valid15
 Validity flag for 15-minute interval data.
 
float Value15
 Value for 15-minute interval data.
 
float Dir15
 Direction for 15-minute interval data.
 
bool Ret15
 Return flag for 15-minute interval data.
 
char * IDX_tzname
 Timezone name (dynamically allocated)
 
int IDX_ref_file_num
 Reference file number.
 
char IDX_reference_name [MAXNAMELEN]
 Name of the reference station.
 
int IDX_ref_dbIndex
 Database index of the reference station.
 
double max_amplitude
 Maximum tidal amplitude.
 
int have_offsets
 Flag indicating presence of time/height offsets.
 
int station_tz_offset
 Offset in seconds to convert from harmonic data (epochs) to the station time zone.
 
int IDX_time_zone
 Station timezone offset from UTC (in minutes)
 
Station_Data * pref_sta_data
 Pointer to the reference station data.
 
int num_nodes
 Number of nodes in harmonic analysis.
 
int num_csts
 Number of harmonic constituents.
 
int num_epochs
 Number of epochs in harmonic data.
 
double * m_cst_speeds
 Array of constituent speeds.
 
double ** m_cst_nodes
 2D array of constituent nodes
 
double ** m_cst_epochs
 2D array of constituent epochs
 
double * m_work_buffer
 Work buffer for calculations.
 
int first_year
 First year of valid data.
 
time_t epoch
 Epoch time for the station.
 
int epoch_year
 Year of the epoch.
 
int current_depth
 Depth for current stations.
 
bool b_skipTooDeep
 Flag to skip processing if depth exceeds limit.
 
time_t recent_highlow_calc_time
 Timestamp of the most recent high/low calculation.
 
float recent_high_level
 Most recently calculated high tide level.
 
time_t recent_high_time
 Time of the most recent high tide.
 
float recent_low_level
 Most recently calculated low tide level.
 
time_t recent_low_time
 Time of the most recent low tide.
 

Detailed Description

Represents an index entry for tidal and current data.

Stores various attributes and data related to tidal and current stations, including location, offsets, and harmonic constituents.

Definition at line 49 of file IDX_entry.h.

Constructor & Destructor Documentation

◆ IDX_entry()

IDX_entry::IDX_entry ( )

Definition at line 32 of file IDX_entry.cpp.

◆ ~IDX_entry()

IDX_entry::~IDX_entry ( )

Definition at line 34 of file IDX_entry.cpp.

Member Data Documentation

◆ b_skipTooDeep

bool IDX_entry::b_skipTooDeep

Flag to skip processing if depth exceeds limit.

Definition at line 110 of file IDX_entry.h.

◆ current_depth

int IDX_entry::current_depth

Depth for current stations.

Definition at line 109 of file IDX_entry.h.

◆ Dir15

float IDX_entry::Dir15

Direction for 15-minute interval data.

Definition at line 78 of file IDX_entry.h.

◆ epoch

time_t IDX_entry::epoch

Epoch time for the station.

Definition at line 107 of file IDX_entry.h.

◆ epoch_year

int IDX_entry::epoch_year

Year of the epoch.

Definition at line 108 of file IDX_entry.h.

◆ first_year

int IDX_entry::first_year

First year of valid data.

Definition at line 106 of file IDX_entry.h.

◆ have_offsets

int IDX_entry::have_offsets

Flag indicating presence of time/height offsets.

Definition at line 85 of file IDX_entry.h.

◆ IDX_ebb_dir

int IDX_entry::IDX_ebb_dir

Ebb current direction (in degrees)

Definition at line 74 of file IDX_entry.h.

◆ IDX_flood_dir

int IDX_entry::IDX_flood_dir

Flood current direction (in degrees)

Definition at line 73 of file IDX_entry.h.

◆ IDX_ht_mpy

float IDX_entry::IDX_ht_mpy

High tide height multiplier.

Definition at line 67 of file IDX_entry.h.

◆ IDX_ht_off

float IDX_entry::IDX_ht_off

High tide height offset.

Definition at line 68 of file IDX_entry.h.

◆ IDX_ht_time_off

int IDX_entry::IDX_ht_time_off

High tide time offset (in minutes)

Definition at line 66 of file IDX_entry.h.

◆ IDX_lat

double IDX_entry::IDX_lat

Latitude of the station (in degrees, +North)

Definition at line 65 of file IDX_entry.h.

◆ IDX_lon

double IDX_entry::IDX_lon

Longitude of the station (in degrees, +East)

Definition at line 64 of file IDX_entry.h.

◆ IDX_lt_mpy

float IDX_entry::IDX_lt_mpy

Low tide height multiplier.

Definition at line 70 of file IDX_entry.h.

◆ IDX_lt_off

float IDX_entry::IDX_lt_off

Low tide height offset.

Definition at line 71 of file IDX_entry.h.

◆ IDX_lt_time_off

int IDX_entry::IDX_lt_time_off

Low tide time offset (in minutes)

Definition at line 69 of file IDX_entry.h.

◆ IDX_rec_num

int IDX_entry::IDX_rec_num

Record number for multiple entries with same name.

Definition at line 60 of file IDX_entry.h.

◆ IDX_ref_dbIndex

int IDX_entry::IDX_ref_dbIndex

Database index of the reference station.

Definition at line 83 of file IDX_entry.h.

◆ IDX_ref_file_num

int IDX_entry::IDX_ref_file_num

Reference file number.

Definition at line 81 of file IDX_entry.h.

◆ IDX_reference_name

char IDX_entry::IDX_reference_name[MAXNAMELEN]

Name of the reference station.

Definition at line 82 of file IDX_entry.h.

◆ IDX_sta_num

int IDX_entry::IDX_sta_num

Subordinate station number (UNUSED)

Definition at line 72 of file IDX_entry.h.

◆ IDX_station_name

char IDX_entry::IDX_station_name[MAXNAMELEN]

Name of the tidal or current station.

Definition at line 63 of file IDX_entry.h.

◆ IDX_time_zone

int IDX_entry::IDX_time_zone

Station timezone offset from UTC (in minutes)

Definition at line 95 of file IDX_entry.h.

◆ IDX_type

char IDX_entry::IDX_type

Entry type identifier "TCtcIUu".

Definition at line 61 of file IDX_entry.h.

◆ IDX_tzname

char* IDX_entry::IDX_tzname

Timezone name (dynamically allocated)

Definition at line 80 of file IDX_entry.h.

◆ IDX_Useable

int IDX_entry::IDX_Useable

Flag indicating if the entry is usable.

Definition at line 75 of file IDX_entry.h.

◆ IDX_zone

char IDX_entry::IDX_zone[40]

Geographic zone identifier.

Definition at line 62 of file IDX_entry.h.

◆ m_cst_epochs

double** IDX_entry::m_cst_epochs

2D array of constituent epochs

Definition at line 104 of file IDX_entry.h.

◆ m_cst_nodes

double** IDX_entry::m_cst_nodes

2D array of constituent nodes

Definition at line 103 of file IDX_entry.h.

◆ m_cst_speeds

double* IDX_entry::m_cst_speeds

Array of constituent speeds.

Definition at line 102 of file IDX_entry.h.

◆ m_work_buffer

double* IDX_entry::m_work_buffer

Work buffer for calculations.

Definition at line 105 of file IDX_entry.h.

◆ max_amplitude

double IDX_entry::max_amplitude

Maximum tidal amplitude.

Definition at line 84 of file IDX_entry.h.

◆ num_csts

int IDX_entry::num_csts

Number of harmonic constituents.

Definition at line 100 of file IDX_entry.h.

◆ num_epochs

int IDX_entry::num_epochs

Number of epochs in harmonic data.

Definition at line 101 of file IDX_entry.h.

◆ num_nodes

int IDX_entry::num_nodes

Number of nodes in harmonic analysis.

Definition at line 99 of file IDX_entry.h.

◆ pDataSource

TCDataSource* IDX_entry::pDataSource

Pointer to the associated data source.

Definition at line 56 of file IDX_entry.h.

◆ pref_sta_data

Station_Data* IDX_entry::pref_sta_data

Pointer to the reference station data.

Definition at line 97 of file IDX_entry.h.

◆ recent_high_level

float IDX_entry::recent_high_level

Most recently calculated high tide level.

Definition at line 115 of file IDX_entry.h.

◆ recent_high_time

time_t IDX_entry::recent_high_time

Time of the most recent high tide.

Definition at line 116 of file IDX_entry.h.

◆ recent_highlow_calc_time

time_t IDX_entry::recent_highlow_calc_time

Timestamp of the most recent high/low calculation.

Definition at line 113 of file IDX_entry.h.

◆ recent_low_level

float IDX_entry::recent_low_level

Most recently calculated low tide level.

Definition at line 117 of file IDX_entry.h.

◆ recent_low_time

time_t IDX_entry::recent_low_time

Time of the most recent low tide.

Definition at line 118 of file IDX_entry.h.

◆ Ret15

bool IDX_entry::Ret15

Return flag for 15-minute interval data.

Definition at line 79 of file IDX_entry.h.

◆ source_data_type

source_data_t IDX_entry::source_data_type

Format of the source data (ASCII or binary)

Definition at line 55 of file IDX_entry.h.

◆ source_ident

char IDX_entry::source_ident[MAXNAMELEN]

Identifier of the source (typically file name)

Definition at line 57 of file IDX_entry.h.

◆ station_tz_offset

int IDX_entry::station_tz_offset

Offset in seconds to convert from harmonic data (epochs) to the station time zone.

This offset depends on the Master Station reference only. For ASCII data, it's typically 0. For Binary data, it's probably calculated as: -(IDX_time_zone * 60) - (tiderec->zone_offset * 3600)

Definition at line 94 of file IDX_entry.h.

◆ Valid15

int IDX_entry::Valid15

Validity flag for 15-minute interval data.

Definition at line 76 of file IDX_entry.h.

◆ Value15

float IDX_entry::Value15

Value for 15-minute interval data.

Definition at line 77 of file IDX_entry.h.

The documentation for this class was generated from the following files: