Skip to content

Commit

Permalink
Develop igc options (#1180)
Browse files Browse the repository at this point in the history 
* Individual options for IGC extensions

* Remove unused var, address compiler complaint

* Minor cleanup

* Remove ALL and EVERY options, make defaults more obvious

* Simplify debug code, refactor maps, add test cases (<--tseven4 patch)

* Make QT5 happy

* capture serialization usage.txt file verbatim.

---------

Co-authored-by: tsteven4 <[email protected]>
  • Loading branch information
@PacketFiend @tsteven4
PacketFiend and tsteven4 authored Oct 28, 2023
1 parent ae4ac82 commit 9bc736a
Show file tree
Hide file tree
Showing 9 changed files with 14,351 additions and 37 deletions.
37 changes: 16 additions & 21 deletions igc.cc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,6 @@
#include <QTime> // for operator<, operator==, QTime
#include <Qt> // for UTC, SkipEmptyParts
#include <QtGlobal> // for foreach, qPrintable
#include <QDebug> // DELETEME for debugging

#include "defs.h"
#include "gbfile.h" // for gbfprintf, gbfclose, gbfopen, gbfputs, gbfgetstr, gbfile
Expand Down Expand Up @@ -425,7 +424,7 @@ void IgcFormat::read()
// Create a route for each post-flight declaration
task_record_reader.igc_task_rec(ibuf + 4);
break;
} else if (global_opts.debug_level >= 4) {
} else if (global_opts.debug_level >= 5) {
if (strcmp(tmp_str, "OOI") == 0) {
printf(MYNAME ": Observer Input> %s\n", ibuf + 4);
} else if (strcmp(tmp_str, "PLT") == 0) {
Expand All @@ -452,48 +451,44 @@ void IgcFormat::read()

QList<QString> unsupported_extensions; // For determining how often unspported extensions exist
QList<QString> supported_extensions; // For debug output, determining how often supported extensions exist
if (global_opts.debug_level >= 1) {
printf(MYNAME ": I record: %s\n" MYNAME ": ", qPrintable(ibuf_q));
}
QList<QString> present_extensions; // List of all extensions present in IGC file

for (int i=3; i < ibuf_q.length(); i+=7) {
QString ext_type = ibuf_q.mid(i+4, 3);
QString extension_definition = ibuf_q.mid(i,7);
if (global_opts.debug_level >= 1) {
printf(" %s;",qPrintable(ext_type));
}
present_extensions.append(ext_type);
// -1 because IGC records are one-initialized and QStrings are zero-initialized
int begin = extension_definition.mid(0,2).toInt() - 1;
int end = extension_definition.mid(2,2).toInt() - 1;
int len = end - begin + 1;
QString name = extension_definition.mid(4,3);
igc_ext_type_t ext = get_ext_type(ext_type);
if (ext != igc_ext_type_t::ext_rec_unknown) {
int factor = get_ext_factor(ext);
ext_types_list.append(std::make_tuple(name, ext, begin, len, factor));
supported_extensions.append(name);
bool enabled = **ext_option_map.value(ext) == '1';
if (enabled) {
int factor = get_ext_factor(ext);
ext_types_list.append(std::make_tuple(name, ext, begin, len, factor));
}
} else {
unsupported_extensions.append(name);
}
}
if (global_opts.debug_level >= 1) {
printf("\n");
printf(MYNAME ": I record: %s\n" MYNAME ": Extensions present: %s\n", qPrintable(ibuf_q),
qPrintable(present_extensions.join(' ')));
}
if (global_opts.debug_level >= 2) {
printf(MYNAME ": Extensions defined in I record:\n");
printf(MYNAME ": Non-excluded extensions defined in I record:\n");
printf(MYNAME ": (Note: IGC records are one-initialized. QStrings are zero-initialized.)\n");
for (const auto& [name, ext, begin, len, factor] : ext_types_list) {
printf(MYNAME ": Extension %s (%i): Begin: %i; Length: %i\n", qPrintable(name), int(ext), begin, len);
}
if (global_opts.debug_level >= 3) {
printf("\n" MYNAME "Supported extensions:");
foreach (QString ext, supported_extensions) {
printf(" %s", qPrintable(ext));
}
printf("\nUnsupported extensions:");
foreach (QString ext, unsupported_extensions) {
printf(" %s", qPrintable(ext));
}
printf("\n");
printf(MYNAME ": Unsupported extensions (I will not ingest these, they are unsupported):\t%s\n",
qPrintable(unsupported_extensions.join(' ')));
printf(MYNAME ": Supported extensions (These are present in the I record and supported):\t%s\n",
qPrintable(supported_extensions.join(' ')));
}
}
}
Expand Down
77 changes: 74 additions & 3 deletions igc.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,8 @@
#include <QHash> // for QHash

#include "defs.h"
#include "format.h"
#include "format.h" // for Format
#include "formspec.h" // for FormatSpecificData, kFsIGC
#include "gbfile.h" // for gbfprintf, gbfclose, gbfopen, gbfputs, gbfgetstr, gbfile
#include "src/core/datetime.h" // for DateTime
#include "kml.h" // for wp_field
Expand Down Expand Up @@ -78,9 +79,15 @@ class IgcFormat : public Format
ext_rec_gfo = 8, // G Force?
ext_rec_siu = 9, // Satellites In Use
ext_rec_acz = 10, // Z Acceleration

};

// Qt5 doesn't have a qHash function for scoped enumerations.
// Qt6 falls back to std::hash, but it may not use the seed.
friend qhash_result_t qHash(const igc_ext_type_t& key, qhash_result_t seed = 0) noexcept
{
return qHash(static_cast<std::underlying_type<igc_ext_type_t>::type>(key), seed);
}

QVector<arglist_t>* get_args() override
{
return &igc_args;
Expand Down Expand Up @@ -131,6 +138,30 @@ class IgcFormat : public Format
rec_bad = 1, // Bad record
};

char* opt_enl{nullptr};
char* opt_tas{nullptr};
char* opt_vat{nullptr};
char* opt_oat{nullptr};
char* opt_trt{nullptr};
char* opt_gsp{nullptr};
char* opt_fxa{nullptr};
char* opt_siu{nullptr};
char* opt_acz{nullptr};
char* opt_gfo{nullptr};

const QHash<igc_ext_type_t, char**> ext_option_map = {
{igc_ext_type_t::ext_rec_enl, &opt_enl},
{igc_ext_type_t::ext_rec_tas, &opt_tas},
{igc_ext_type_t::ext_rec_vat, &opt_vat},
{igc_ext_type_t::ext_rec_oat, &opt_oat},
{igc_ext_type_t::ext_rec_trt, &opt_trt},
{igc_ext_type_t::ext_rec_gsp, &opt_gsp},
{igc_ext_type_t::ext_rec_fxa, &opt_fxa},
{igc_ext_type_t::ext_rec_gfo, &opt_gfo},
{igc_ext_type_t::ext_rec_siu, &opt_siu},
{igc_ext_type_t::ext_rec_acz, &opt_acz},
};

const QHash<QString, igc_ext_type_t> igc_extension_map{
{"ENL", igc_ext_type_t::ext_rec_enl},
{"TAS", igc_ext_type_t::ext_rec_tas},
Expand Down Expand Up @@ -268,7 +299,47 @@ class IgcFormat : public Format
"timeadj", &timeadj,
"(integer sec or 'auto') Barograph to GPS time diff",
nullptr, ARGTYPE_STRING, ARG_NOMINMAX, nullptr
}
},
{
"ENL", &opt_enl, "Engine Noise (ENL; default=1)",
"1", ARGTYPE_BOOL, ARG_NOMINMAX, nullptr
},
{
"TAS", &opt_tas, "True Airspeed (TAS; default=1)",
"1", ARGTYPE_BOOL, ARG_NOMINMAX, nullptr
},
{
"VAT", &opt_vat, "Total Energy Vario (VAT; default=1)",
"1", ARGTYPE_BOOL, ARG_NOMINMAX, nullptr
},
{
"OAT", &opt_oat, "Outside Air Temperature (OAT; default=1)",
"1", ARGTYPE_BOOL, ARG_NOMINMAX, nullptr
},
{
"TRT", &opt_trt, "True Track (TRT; default=0)",
"0", ARGTYPE_BOOL, ARG_NOMINMAX, nullptr
},
{
"GSP", &opt_gsp, "Ground Speed (GSP; default=1)",
"1", ARGTYPE_BOOL, ARG_NOMINMAX, nullptr
},
{
"FXA", &opt_fxa, "Fix Accuracy (FXA; default=1)",
"1", ARGTYPE_BOOL, ARG_NOMINMAX, nullptr
},
{
"SIU", &opt_siu, "# Of Sats (SIU; default=0)",
"0", ARGTYPE_BOOL, ARG_NOMINMAX, nullptr
},
{
"ACZ", &opt_acz, "Z Acceleration (ACZ; default=1)",
"1", ARGTYPE_BOOL, ARG_NOMINMAX, nullptr
},
{
"GFO", &opt_gfo, "G Force? (GFO; default=0)",
"0", ARGTYPE_BOOL, ARG_NOMINMAX, nullptr
},
};
};
/*
Expand Down
12 changes: 4 additions & 8 deletions kml.cc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1635,15 +1635,11 @@ void KmlFormat::kml_accumulate_track_traits(const route_head* rte)
if (fs_igc->acz.has_value()) {
track_traits[static_cast<int>(wp_field::igc_acz)] = true;
}
if constexpr(kIncludeIGCSIU) {
if (fs_igc->siu.has_value()) {
track_traits[static_cast<int>(wp_field::igc_siu)] = true;
}
if (fs_igc->siu.has_value()) {
track_traits[static_cast<int>(wp_field::igc_siu)] = true;
}
if constexpr(kIncludeIGCTRT) {
if (fs_igc->trt.has_value()) {
track_traits[static_cast<int>(wp_field::igc_trt)] = true;
}
if (fs_igc->trt.has_value()) {
track_traits[static_cast<int>(wp_field::igc_trt)] = true;
}
}
}
Expand Down
6 changes: 1 addition & 5 deletions kml.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ class KmlFormat : public Format
igc_fxa, // Fix Accuracy
igc_gfo, // G Force
igc_siu, // Satellites In Use
igc_acz // Z Acceleration
igc_acz, // Z Acceleration
};
static constexpr int number_wp_fields = static_cast<int>(wp_field::igc_acz) + 1;

Expand Down Expand Up @@ -130,10 +130,6 @@ class KmlFormat : public Format
nullptr
};

// IGC option compile-time flags
static constexpr bool kIncludeIGCSIU = true;
static constexpr bool kIncludeIGCTRT = false;

/* Member Functions */

void kml_init_color_sequencer(unsigned int steps_per_rev);
Expand Down
20 changes: 20 additions & 0 deletions reference/format3.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,26 @@ file --rwrw igc FAI/IGC Flight Recorder Data Format igc
https://www.gpsbabel.org/WEB_DOC_DIR/fmt_igc.html
option igc timeadj (integer sec or 'auto') Barograph to GPS time diff string https://www.gpsbabel.org/WEB_DOC_DIR/fmt_igc.html#fmt_igc_o_timeadj

option igc ENL Engine Noise (ENL; default=1) boolean 1 https://www.gpsbabel.org/WEB_DOC_DIR/fmt_igc.html#fmt_igc_o_ENL

option igc TAS True Airspeed (TAS; default=1) boolean 1 https://www.gpsbabel.org/WEB_DOC_DIR/fmt_igc.html#fmt_igc_o_TAS

option igc VAT Total Energy Vario (VAT; default=1) boolean 1 https://www.gpsbabel.org/WEB_DOC_DIR/fmt_igc.html#fmt_igc_o_VAT

option igc OAT Outside Air Temperature (OAT; default=1) boolean 1 https://www.gpsbabel.org/WEB_DOC_DIR/fmt_igc.html#fmt_igc_o_OAT

option igc TRT True Track (TRT; default=0) boolean 0 https://www.gpsbabel.org/WEB_DOC_DIR/fmt_igc.html#fmt_igc_o_TRT

option igc GSP Ground Speed (GSP; default=1) boolean 1 https://www.gpsbabel.org/WEB_DOC_DIR/fmt_igc.html#fmt_igc_o_GSP

option igc FXA Fix Accuracy (FXA; default=1) boolean 1 https://www.gpsbabel.org/WEB_DOC_DIR/fmt_igc.html#fmt_igc_o_FXA

option igc SIU # Of Sats (SIU; default=0) boolean 0 https://www.gpsbabel.org/WEB_DOC_DIR/fmt_igc.html#fmt_igc_o_SIU

option igc ACZ Z Acceleration (ACZ; default=1) boolean 1 https://www.gpsbabel.org/WEB_DOC_DIR/fmt_igc.html#fmt_igc_o_ACZ

option igc GFO G Force? (GFO; default=0) boolean 0 https://www.gpsbabel.org/WEB_DOC_DIR/fmt_igc.html#fmt_igc_o_GFO

file -wrw-- garmin_fit fit Flexible and Interoperable Data Transfer (FIT) Activity file garmin_fit
https://www.gpsbabel.org/WEB_DOC_DIR/fmt_garmin_fit.html
option garmin_fit allpoints Read all points even if latitude or longitude is missing boolean https://www.gpsbabel.org/WEB_DOC_DIR/fmt_garmin_fit.html#fmt_garmin_fit_o_allpoints
Expand Down
10 changes: 10 additions & 0 deletions reference/help.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,16 @@ File Types (-i and -o options):
url Source for URL field in .dbf
igc FAI/IGC Flight Recorder Data Format
timeadj (integer sec or 'auto') Barograph to GPS time diff
ENL (0/1) Engine Noise (ENL; default=1)
TAS (0/1) True Airspeed (TAS; default=1)
VAT (0/1) Total Energy Vario (VAT; default=1)
OAT (0/1) Outside Air Temperature (OAT; default=1)
TRT (0/1) True Track (TRT; default=0)
GSP (0/1) Ground Speed (GSP; default=1)
FXA (0/1) Fix Accuracy (FXA; default=1)
SIU (0/1) # Of Sats (SIU; default=0)
ACZ (0/1) Z Acceleration (ACZ; default=1)
GFO (0/1) G Force? (GFO; default=0)
garmin_fit Flexible and Interoperable Data Transfer (FIT) Act
allpoints (0/1) Read all points even if latitude or longitude is m
recoverymode (0/1) Attempt to recovery data from corrupt file
Expand Down
Loading

0 comments on commit 9bc736a

Please sign in to comment.