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