GDCconfiguration Class Reference
[Rinex Utilities]

#include <DiscCorr.hpp>

Inheritance diagram for GDCconfiguration:

[legend]List of all members.

---

Detailed Description

class GDCconfiguration encapsulates the configuration for input to the GPSTK Discontinuity Corrector.

Definition at line 57 of file DiscCorr.hpp.

Public Member Functions
	GDCconfiguration (void)
	constructor; this sets a full default set of parameters.
	~GDCconfiguration (void)
void	setParameter (std::string cmd) throw (gpstk::Exception)
	Set a parameter in the configuration; the input string 'cmd' is of the form '[--DC]<id><s><value>' where the separator s is one of (:=,) and leading '-','--', or '--DC' are optional.
void	setParameter (std::string label, double value) throw (gpstk::Exception)
	Set a parameter in the configuration using the label and the value, for booleans use (T,F)=(non-zero,zero).
double	getParameter (std::string label) throw ()
	Get the parameter in the configuration corresponding to label.
void	setDebugStream (std::ostream &os)
	Tell GDCconfiguration to which stream to send debugging output.
void	DisplayParameterUsage (std::ostream &os, bool advanced=false) throw (gpstk::Exception)
	Print help page, including descriptions and current values of all the parameters, to the ostream.
std::string	Version () throw ()
	Return version string.
Protected Member Functions
void	initialize (void)
Protected Attributes
std::map< std::string, double >	CFG
	map containing configuration labels and their values
std::map< std::string, std::string >	CFGdescription
	map containing configuration labels and their descriptions
std::ostream *	p_oflog
	Stream on which to write debug output.
Static Protected Attributes
std::string	GDCVersion = string("5.3 7/14/2008")

---

Constructor & Destructor Documentation

GDCconfiguration (  void   )  [inline]

constructor; this sets a full default set of parameters. Definition at line 60 of file DiscCorr.hpp.

~GDCconfiguration (  void   )  [inline]

Definition at line 62 of file DiscCorr.hpp.

---

Member Function Documentation

void DisplayParameterUsage (  std::ostream &  os, bool  advanced = false )  throw (gpstk::Exception)

Print help page, including descriptions and current values of all the parameters, to the ostream. If 'advanced' is true, also print advanced parameters. Definition at line 114 of file DiscCorr.cpp. References GPSTK_RETHROW, GPSTK_THROW, and gpstk::StringUtils::leftJustify().

double getParameter (  std::string  label  )  throw () [inline]

Get the parameter in the configuration corresponding to label. Definition at line 74 of file DiscCorr.hpp.

void initialize (  void   )  [protected]

Definition at line 158 of file DiscCorr.cpp. References GPSTK_RETHROW, GPSTK_THROW, GDCconfiguration::p_oflog, and setcfg.

void setDebugStream (  std::ostream &  os  )  [inline]

Tell GDCconfiguration to which stream to send debugging output. Definition at line 77 of file DiscCorr.hpp.

void setParameter (  std::string  label, double  value )  throw (gpstk::Exception)

Set a parameter in the configuration using the label and the value, for booleans use (T,F)=(non-zero,zero). Definition at line 94 of file DiscCorr.cpp. References GPSTK_RETHROW, and GPSTK_THROW.

void setParameter (  std::string  cmd  )  throw (gpstk::Exception)

Set a parameter in the configuration; the input string 'cmd' is of the form '[--DC]<id><s><value>' where the separator s is one of (:=,) and leading '-','--', or '--DC' are optional. Definition at line 65 of file DiscCorr.cpp. References gpstk::StringUtils::asDouble(), GPSTK_RETHROW, and GPSTK_THROW.

std::string Version (   )  throw () [inline]

Return version string. Definition at line 86 of file DiscCorr.hpp.

---

Member Data Documentation

std::map<std::string,double> CFG [protected]

map containing configuration labels and their values Definition at line 91 of file DiscCorr.hpp.

std::map<std::string,std::string> CFGdescription [protected]

map containing configuration labels and their descriptions Definition at line 94 of file DiscCorr.hpp.

string GDCVersion = string("5.3 7/14/2008") [static, protected]

Definition at line 59 of file DiscCorr.cpp.

std::ostream* p_oflog [protected]

Stream on which to write debug output. Definition at line 97 of file DiscCorr.hpp. Referenced by GDCconfiguration::initialize().

---

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

• DiscCorr.hpp
• DiscCorr.cpp

---