JS8Submode.h

#ifndef JS8_SUBMODE_HPP_
#define JS8_SUBMODE_HPP_
 
#include "JS8_Mode/JS8.h"
 
#include <QString>
 
#include <stdexcept>
 
namespace JS8::Submode {
// Exception thrown on unexpected errors, principally, handing
// us a submode that we don't understand, which seems like your
// problem, not ours.
 
struct error : public std::runtime_error {
    explicit error(QString const &what)
        : std::runtime_error(what.toStdString()) {}
};
 
// Functions that, when provided with a valid submode, return
// constant data specific to the submode. Each of those functions
// will throw if provided with an invalid JS8 submode.
 
// Be careful when doing arithmetic with values that are unsigned.
// Something seemingly harmless such as 3 - samplesForOneSymbol
// might end up as 4,294,965,379.
 
// One way to see the actual values of the various modes:
// Running JS8Call with the environment variable
// QT_LOGGING_RULES set to the value js8submode.js8=true
// will output a list of them to STDERR.

QString name(int);
unsigned int bandwidth(int);
Costas::Type costas(int);

unsigned int period(int);

unsigned int samplesForOneSymbol(int);

unsigned int samplesForSymbols(int);

unsigned int samplesNeeded(int);

unsigned int samplesPerPeriod(int);
int rxSNRThreshold(int);
int rxThreshold(int);

unsigned int startDelayMS(int);
double toneSpacing(int);

double dataDuration(int);

double txDuration(int);
 
// Functions that, when provided with a valid submode and additional
// parametric data, compute and return results specific to the submode.
// Each of these functions will throw if provided with an invalid JS8
// submode.
 
int computeCycleForDecode(int, int);
int computeAltCycleForDecode(int, int, int);
double computeRatio(int, double);
} // namespace JS8::Submode
 
#endif // JS8_SUBMODE_HPP_