gnsstk::GDCconfiguration Class Reference

Detailed Description

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

Definition at line 72 of file DiscCorr.hpp.

#include <DiscCorr.hpp>

Inheritance diagram for gnsstk::GDCconfiguration:

Public Member Functions
void	DisplayParameterUsage (std::ostream &os, bool advanced=false)
	GDCconfiguration ()
	constructor; this sets a full default set of parameters. More...
std::string	getDescription (const std::string &label)
	Get the description of a parameter. More...
double	getParameter (const std::string &label)
	Get the parameter in the configuration corresponding to label. More...
void	setDebugStream (std::ostream &os)
	Tell GDCconfiguration to which stream to send debugging output. More...
void	setParameter (const std::string &label, double value)
void	setParameter (std::string cmd)
std::string	Version ()
	Return version string. More...
	~GDCconfiguration ()
	destructor More...

Protected Member Functions
void	initialize ()

Protected Attributes
std::map< std::string, double >	CFG
	map containing configuration labels and their values More...
std::map< std::string, std::string >	CFGdescription
	map containing configuration labels and their descriptions More...
std::ostream *	p_oflog
	Stream on which to write debug output. More...

Static Protected Attributes
static const GNSSTK_EXPORT std::string	GDCVersion = string("6.3 12/15/2015")

Constructor & Destructor Documentation

GDCconfiguration()

gnsstk::GDCconfiguration::GDCconfiguration ( )

inline

constructor; this sets a full default set of parameters.

Definition at line 76 of file DiscCorr.hpp.

~GDCconfiguration()

gnsstk::GDCconfiguration::~GDCconfiguration ( )

inline

destructor

Definition at line 78 of file DiscCorr.hpp.

Member Function Documentation

DisplayParameterUsage()

void GDCconfiguration::DisplayParameterUsage	(	std::ostream &	os,
		bool	advanced = false
	)

Print help page, including descriptions and current values of all the parameters, to the ostream. If 'advanced' is true, also print advanced parameters.

Exceptions

Exception

Definition at line 171 of file DiscCorr.cpp.

getDescription()

std::string gnsstk::GDCconfiguration::getDescription ( const std::string &  label )

inline

Get the description of a parameter.

Definition at line 110 of file DiscCorr.hpp.

getParameter()

double gnsstk::GDCconfiguration::getParameter ( const std::string &  label )

inline

Get the parameter in the configuration corresponding to label.

Definition at line 100 of file DiscCorr.hpp.

initialize()

void GDCconfiguration::initialize ( )

protected

Definition at line 236 of file DiscCorr.cpp.

setDebugStream()

void gnsstk::GDCconfiguration::setDebugStream ( std::ostream &  os )

inline

Tell GDCconfiguration to which stream to send debugging output.

Definition at line 120 of file DiscCorr.hpp.

setParameter() [1/2]

void GDCconfiguration::setParameter	(	const std::string &	label,
		double	value
	)

Set a parameter in the configuration using the label and the value, for booleans use (T,F)=(non-zero,zero).

Exceptions

Exception

Definition at line 133 of file DiscCorr.cpp.

setParameter() [2/2]

void GDCconfiguration::setParameter

(

std::string

cmd

)

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.

Exceptions

Exception

Definition at line 80 of file DiscCorr.cpp.

Version()

std::string gnsstk::GDCconfiguration::Version ( )

inline

Return version string.

Definition at line 131 of file DiscCorr.hpp.

Member Data Documentation

CFG

std::map<std::string, double> gnsstk::GDCconfiguration::CFG

protected

map containing configuration labels and their values

Definition at line 135 of file DiscCorr.hpp.

CFGdescription

std::map<std::string, std::string> gnsstk::GDCconfiguration::CFGdescription

protected

map containing configuration labels and their descriptions

Definition at line 138 of file DiscCorr.hpp.

GDCVersion

const string GDCconfiguration::GDCVersion = string("6.3 12/15/2015")

staticprotected

Definition at line 146 of file DiscCorr.hpp.

p_oflog

std::ostream* gnsstk::GDCconfiguration::p_oflog

protected

Stream on which to write debug output.

Definition at line 141 of file DiscCorr.hpp.

---

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

• DiscCorr.hpp
• DiscCorr.cpp