OpenCPN Partial API docs
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
GribOverlaySettings Struct Reference

Classes

struct  OverlayDataSettings
 

Public Types

enum  SettingsType {
  WIND , WIND_GUST , PRESSURE , WAVE ,
  CURRENT , PRECIPITATION , CLOUD , AIR_TEMPERATURE ,
  SEA_TEMPERATURE , CAPE , COMP_REFL , GEO_ALTITUDE ,
  REL_HUMIDITY , SETTINGS_COUNT
}
 
enum  Units0 {
  KNOTS , M_S , MPH , KPH ,
  BFS
}
 
enum  Units1 { MILLIBARS , MMHG , INHG }
 
enum  Units2 { METERS , FEET }
 
enum  Units3 { CELCIUS , FAHRENHEIT }
 
enum  Units4 { MILLIMETERS , INCHES }
 
enum  Units5 { PERCENTAGE }
 
enum  Units6 { JPKG }
 
enum  Units7 { DBZ }
 

Public Member Functions

void Read ()
 
void Write ()
 
void SaveSettingGroups (wxFileConfig *pConf, int settings, int group)
 
wxString SettingsToJSON (wxString json)
 
bool JSONToSettings (wxString json)
 
bool UpdateJSONval (wxJSONValue &v, int settings, int group)
 
double CalibrationOffset (int settings)
 
double CalibrationFactor (int settings, double input, bool reverse=false)
 
double CalibrateValue (int settings, double input)
 
int GetMinFromIndex (int index)
 
wxString GetAltitudeFromIndex (int index, int unit)
 
double GetmstobfFactor (double input)
 
double GetbftomsFactor (double input)
 
wxString GetUnitSymbol (int settings)
 
double GetMin (int settings)
 
double GetMax (int settings)
 

Static Public Member Functions

static wxString NameFromIndex (int index)
 

Public Attributes

bool m_bInterpolate
 
bool m_bLoopMode
 
int m_LoopStartPoint
 
int m_SlicesPerUpdate
 
int m_UpdatesPerSecond
 
int m_iOverlayTransparency
 
int m_iCtrlandDataStyle
 
wxString m_iCtrlBarCtrlVisible [2]
 
struct GribOverlaySettings::OverlayDataSettings Settings [SETTINGS_COUNT]
 

Detailed Description

Definition at line 54 of file GribSettingsDialog.h.

Member Enumeration Documentation

◆ SettingsType

enum GribOverlaySettings::SettingsType

Definition at line 90 of file GribSettingsDialog.h.

◆ Units0

enum GribOverlaySettings::Units0

Definition at line 106 of file GribSettingsDialog.h.

◆ Units1

enum GribOverlaySettings::Units1

Definition at line 107 of file GribSettingsDialog.h.

◆ Units2

enum GribOverlaySettings::Units2

Definition at line 108 of file GribSettingsDialog.h.

◆ Units3

enum GribOverlaySettings::Units3

Definition at line 109 of file GribSettingsDialog.h.

◆ Units4

enum GribOverlaySettings::Units4

Definition at line 110 of file GribSettingsDialog.h.

◆ Units5

enum GribOverlaySettings::Units5

Definition at line 111 of file GribSettingsDialog.h.

◆ Units6

enum GribOverlaySettings::Units6

Definition at line 112 of file GribSettingsDialog.h.

◆ Units7

enum GribOverlaySettings::Units7

Definition at line 113 of file GribSettingsDialog.h.

Member Function Documentation

◆ CalibrateValue()

double GribOverlaySettings::CalibrateValue ( int  settings,
double  input 
)
inline

Definition at line 67 of file GribSettingsDialog.h.

◆ CalibrationFactor()

double GribOverlaySettings::CalibrationFactor ( int  settings,
double  input,
bool  reverse = false 
)

Definition at line 378 of file GribSettingsDialog.cpp.

◆ CalibrationOffset()

double GribOverlaySettings::CalibrationOffset ( int  settings)

Definition at line 362 of file GribSettingsDialog.cpp.

◆ GetAltitudeFromIndex()

wxString GribOverlaySettings::GetAltitudeFromIndex ( int  index,
int  unit 
)

Definition at line 150 of file GribSettingsDialog.cpp.

◆ GetbftomsFactor()

double GribOverlaySettings::GetbftomsFactor ( double  input)

Definition at line 475 of file GribSettingsDialog.cpp.

◆ GetMax()

double GribOverlaySettings::GetMax ( int  settings)

Definition at line 607 of file GribSettingsDialog.cpp.

◆ GetMin()

double GribOverlaySettings::GetMin ( int  settings)

Definition at line 591 of file GribSettingsDialog.cpp.

◆ GetMinFromIndex()

int GribOverlaySettings::GetMinFromIndex ( int  index)

Definition at line 154 of file GribSettingsDialog.cpp.

◆ GetmstobfFactor()

double GribOverlaySettings::GetmstobfFactor ( double  input)

Definition at line 457 of file GribSettingsDialog.cpp.

◆ GetUnitSymbol()

wxString GribOverlaySettings::GetUnitSymbol ( int  settings)

Definition at line 507 of file GribSettingsDialog.cpp.

◆ JSONToSettings()

bool GribOverlaySettings::JSONToSettings ( wxString  json)

Definition at line 1289 of file GribSettingsDialog.cpp.

◆ NameFromIndex()

wxString GribOverlaySettings::NameFromIndex ( int  index)
static

Definition at line 158 of file GribSettingsDialog.cpp.

◆ Read()

void GribOverlaySettings::Read ( )

Definition at line 162 of file GribSettingsDialog.cpp.

◆ SaveSettingGroups()

void GribOverlaySettings::SaveSettingGroups ( wxFileConfig *  pConf,
int  settings,
int  group 
)

Definition at line 300 of file GribSettingsDialog.cpp.

◆ SettingsToJSON()

wxString GribOverlaySettings::SettingsToJSON ( wxString  json)

Definition at line 1188 of file GribSettingsDialog.cpp.

◆ UpdateJSONval()

bool GribOverlaySettings::UpdateJSONval ( wxJSONValue &  v,
int  settings,
int  group 
)

Definition at line 1228 of file GribSettingsDialog.cpp.

◆ Write()

void GribOverlaySettings::Write ( )

Definition at line 249 of file GribSettingsDialog.cpp.

Member Data Documentation

◆ m_bInterpolate

bool GribOverlaySettings::m_bInterpolate

Definition at line 79 of file GribSettingsDialog.h.

◆ m_bLoopMode

bool GribOverlaySettings::m_bLoopMode

Definition at line 80 of file GribSettingsDialog.h.

◆ m_iCtrlandDataStyle

int GribOverlaySettings::m_iCtrlandDataStyle

Definition at line 87 of file GribSettingsDialog.h.

◆ m_iCtrlBarCtrlVisible

wxString GribOverlaySettings::m_iCtrlBarCtrlVisible[2]

Definition at line 88 of file GribSettingsDialog.h.

◆ m_iOverlayTransparency

int GribOverlaySettings::m_iOverlayTransparency

Definition at line 85 of file GribSettingsDialog.h.

◆ m_LoopStartPoint

int GribOverlaySettings::m_LoopStartPoint

Definition at line 81 of file GribSettingsDialog.h.

◆ m_SlicesPerUpdate

int GribOverlaySettings::m_SlicesPerUpdate

Definition at line 82 of file GribSettingsDialog.h.

◆ m_UpdatesPerSecond

int GribOverlaySettings::m_UpdatesPerSecond

Definition at line 83 of file GribSettingsDialog.h.

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