gnsstk::IonoModelStore Class Reference

Detailed Description

This class defines an interface to hide how we determine the ionospheric delay as determined from GPS navigation message based models at some point in time

Definition at line 62 of file IonoModelStore.hpp.

#include <IonoModelStore.hpp>

Public Member Functions
bool	addIonoModel (const CommonTime &mt, const IonoModel &im) noexcept
void	clear ()
virtual void	dump (std::ostream &s=std::cout) const
void	edit (const CommonTime &tmin, const CommonTime &tmax=CommonTime::END_OF_TIME)
virtual bool	empty () const
virtual double	getCorrection (const CommonTime &time, const Position &rxgeo, double svel, double svaz, CarrierBand band=CarrierBand::L1) const
virtual CommonTime	getFinalTime () const
virtual CommonTime	getInitialTime () const
	IonoModelStore ()
	Constructor. More...
	NEW_EXCEPTION_CLASS (NoIonoModelFound, gnsstk::Exception)
virtual unsigned	size () const
virtual	~IonoModelStore ()
	Destructor. More...

Private Types
typedef std::map< CommonTime, IonoModel >	IonoModelMap

Private Attributes
IonoModelMap	ims

Member Typedef Documentation

IonoModelMap

typedef std::map<CommonTime, IonoModel> gnsstk::IonoModelStore::IonoModelMap

private

Definition at line 148 of file IonoModelStore.hpp.

Constructor & Destructor Documentation

IonoModelStore()

gnsstk::IonoModelStore::IonoModelStore ( )

inline

Constructor.

Definition at line 73 of file IonoModelStore.hpp.

~IonoModelStore()

virtual gnsstk::IonoModelStore::~IonoModelStore ( )

inlinevirtual

Destructor.

Definition at line 76 of file IonoModelStore.hpp.

Member Function Documentation

addIonoModel()

bool gnsstk::IonoModelStore::addIonoModel ( const CommonTime &  mt, const IonoModel &  im  )

noexcept

Add an IonoModel to this collection

Parameters

[in]	mt	Time the model is valid from
[in]	im	IonoModel to add

Returns

true if the model was added, false otherwise

Definition at line 88 of file IonoModelStore.cpp.

clear()

void gnsstk::IonoModelStore::clear ( )

inline

Remove all data from the store

Definition at line 113 of file IonoModelStore.hpp.

dump()

void gnsstk::IonoModelStore::dump ( std::ostream &  s = std::cout ) const

virtual

Dump to contents of the store in human-readable form.

Parameters

[in,out]

s

Stream to receive the output; defaults to cout

Definition at line 157 of file IonoModelStore.cpp.

edit()

void gnsstk::IonoModelStore::edit	(	const CommonTime &	tmin,
		const CommonTime &	tmax = CommonTime::END_OF_TIME
	)

Edit the dataset, removing data outside the indicated time interval

Parameters

[in]	tmin	Defines the beginning of the time interval (inclusive)
[in]	tmax	Defines the end of the time interval (inclusive)

Edit the dataset, removing data outside the indicated time interval

Parameters

tmin	defines the beginning of the time interval
tmax	defines the end of the time interval

Definition at line 117 of file IonoModelStore.cpp.

empty()

virtual bool gnsstk::IonoModelStore::empty ( ) const

inlinevirtual

Return whether the store is empty.

Returns

Whether to store is empty

Definition at line 137 of file IonoModelStore.hpp.

getCorrection()

double gnsstk::IonoModelStore::getCorrection ( const CommonTime &  time, const Position &  rxgeo, double  svel, double  svaz, CarrierBand  band = CarrierBand::L1  ) const

virtual

Get the ionospheric correction value.

Parameters

[in]	time	Time of the observation
[in]	rxgeo	WGS84 geodetic position of the receiver
[in]	svel	Elevation angle between the rx and SV (degrees)
[in]	svaz	Azimuth angle between the rx and SV (degrees)
[in]	freq	GPS band the observation was made from

Returns

the ionospheric correction (meters)

Exceptions

NoIonoModelFound

Definition at line 61 of file IonoModelStore.cpp.

getFinalTime()

gnsstk::CommonTime gnsstk::IonoModelStore::getFinalTime ( ) const

virtual

Return the latest time in the store, or return CommonTime::BEGINNING_OF_TIME if the store is empty.

Returns

The store final time

Definition at line 151 of file IonoModelStore.cpp.

getInitialTime()

gnsstk::CommonTime gnsstk::IonoModelStore::getInitialTime ( ) const

virtual

Return the earliest time in the store, or return CommonTime::END_OF_TIME if the store is empty.

Returns

The store initial time

Definition at line 145 of file IonoModelStore.cpp.

size()

virtual unsigned gnsstk::IonoModelStore::size ( ) const

inlinevirtual

Return the number of models in the store.

Returns

Store size

Definition at line 131 of file IonoModelStore.hpp.

Member Data Documentation

ims

IonoModelMap gnsstk::IonoModelStore::ims

private

Definition at line 150 of file IonoModelStore.hpp.

---

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

• IonoModelStore.hpp
• IonoModelStore.cpp