OpenCPN Partial API docs
Loading...
Searching...
No Matches
idx_entry.h
Go to the documentation of this file.
1/**************************************************************************
2 * Copyright (C) 2013 by David S. Register *
3 * *
4 * This program is free software; you can redistribute it and/or modify *
5 * it under the terms of the GNU General Public License as published by *
6 * the Free Software Foundation; either version 2 of the License, or *
7 * (at your option) any later version. *
8 * *
9 * This program is distributed in the hope that it will be useful, *
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
12 * GNU General Public License for more details. *
13 * *
14 * You should have received a copy of the GNU General Public License *
15 * along with this program; if not, see <https://www.gnu.org/licenses/>. *
16 ***************************************************************************/
17
24#ifndef __IDX_ENTRY_H__
25#define __IDX_ENTRY_H__
26
27#include <wx/dynarray.h>
28
29#define MAXNAMELEN 90
30
31class TCDataSource;
32class Station_Data;
33
42
119
120WX_DECLARE_OBJARRAY(IDX_entry, ArrayOfIDXEntry);
121
122#endif
Represents an index entry for tidal and current data.
Definition idx_entry.h:48
int have_offsets
Flag indicating presence of time/height offsets.
Definition idx_entry.h:84
time_t epoch
Epoch time for the station.
Definition idx_entry.h:106
int IDX_time_zone
Station timezone offset from UTC (in minutes)
Definition idx_entry.h:94
char IDX_type
Entry type identifier "TCtcIUu".
Definition idx_entry.h:60
int num_nodes
Number of nodes in harmonic analysis.
Definition idx_entry.h:98
float IDX_lt_off
Low tide height offset.
Definition idx_entry.h:70
char IDX_zone[40]
Geographic zone identifier.
Definition idx_entry.h:61
TCDataSource * pDataSource
Pointer to the associated data source.
Definition idx_entry.h:55
float IDX_lt_mpy
Low tide height multiplier.
Definition idx_entry.h:69
char IDX_reference_name[MAXNAMELEN]
Name of the reference station.
Definition idx_entry.h:81
int Valid15
Validity flag for 15-minute interval data.
Definition idx_entry.h:75
time_t recent_high_time
Time of the most recent high tide.
Definition idx_entry.h:115
int epoch_year
Year of the epoch.
Definition idx_entry.h:107
int IDX_flood_dir
Flood current direction (in degrees)
Definition idx_entry.h:72
int IDX_ref_dbIndex
Database index of the reference station.
Definition idx_entry.h:82
int IDX_Useable
Flag indicating if the entry is usable.
Definition idx_entry.h:74
char IDX_station_name[MAXNAMELEN]
Name of the tidal or current station.
Definition idx_entry.h:62
float recent_low_level
Most recently calculated low tide level.
Definition idx_entry.h:116
int station_tz_offset
Offset in seconds to convert from harmonic data (epochs) to the station time zone.
Definition idx_entry.h:93
double max_amplitude
Maximum tidal amplitude.
Definition idx_entry.h:83
char source_ident[MAXNAMELEN]
Identifier of the source (typically file name)
Definition idx_entry.h:56
int first_year
First year of valid data.
Definition idx_entry.h:105
double * m_work_buffer
Work buffer for calculations.
Definition idx_entry.h:104
int IDX_ht_time_off
High tide time offset (in minutes)
Definition idx_entry.h:65
source_data_t source_data_type
Format of the source data (ASCII or binary)
Definition idx_entry.h:54
float Dir15
Direction for 15-minute interval data.
Definition idx_entry.h:77
float recent_high_level
Most recently calculated high tide level.
Definition idx_entry.h:114
double ** m_cst_nodes
2D array of constituent nodes
Definition idx_entry.h:102
int IDX_ebb_dir
Ebb current direction (in degrees)
Definition idx_entry.h:73
double ** m_cst_epochs
2D array of constituent epochs
Definition idx_entry.h:103
float IDX_ht_mpy
High tide height multiplier.
Definition idx_entry.h:66
int current_depth
Depth for current stations.
Definition idx_entry.h:108
double IDX_lat
Latitude of the station (in degrees, +North)
Definition idx_entry.h:64
double IDX_lon
Longitude of the station (in degrees, +East)
Definition idx_entry.h:63
bool Ret15
Return flag for 15-minute interval data.
Definition idx_entry.h:78
bool b_skipTooDeep
Flag to skip processing if depth exceeds limit.
Definition idx_entry.h:109
int num_epochs
Number of epochs in harmonic data.
Definition idx_entry.h:100
double * m_cst_speeds
Array of constituent speeds.
Definition idx_entry.h:101
Station_Data * pref_sta_data
Pointer to the reference station data.
Definition idx_entry.h:96
int IDX_lt_time_off
Low tide time offset (in minutes)
Definition idx_entry.h:68
time_t recent_highlow_calc_time
Timestamp of the most recent high/low calculation.
Definition idx_entry.h:112
int IDX_ref_file_num
Reference file number.
Definition idx_entry.h:80
int num_csts
Number of harmonic constituents.
Definition idx_entry.h:99
time_t recent_low_time
Time of the most recent low tide.
Definition idx_entry.h:117
char * IDX_tzname
Timezone name (dynamically allocated)
Definition idx_entry.h:79
float IDX_ht_off
High tide height offset.
Definition idx_entry.h:67
int IDX_rec_num
Record number for multiple entries with same name.
Definition idx_entry.h:59
float Value15
Value for 15-minute interval data.
Definition idx_entry.h:76
int IDX_sta_num
Subordinate station number (UNUSED)
Definition idx_entry.h:71
source_data_t
Enumeration of source data types.
Definition idx_entry.h:37
@ SOURCE_TYPE_ASCII_HARMONIC
ASCII harmonic source type.
Definition idx_entry.h:39
@ SOURCE_TYPE_BINARY_HARMONIC
Binary harmonic source type.
Definition idx_entry.h:40
@ SOURCE_TYPE_UNKNOWN
Unknown source type.
Definition idx_entry.h:38