Detailed Description

Define an interface for loading nav data from a file.

Definition at line 51 of file NavDataFactoryWithStoreFile.hpp.

#include <NavDataFactoryWithStoreFile.hpp>

Inheritance diagram for gnsstk::NavDataFactoryWithStoreFile:

[legend]

Public Member Functions
bool	addDataSource (const std::string &source) override

virtual bool	loadIntoMap (const std::string &filename, NavMessageMap &navMap, NavNearMessageMap &navNearMap, OffsetCvtMap &ofsMap)=0

	NavDataFactoryWithStoreFile ()

virtual bool	process (const std::string &filename, NavDataFactoryCallback &cb)=0

virtual	~NavDataFactoryWithStoreFile ()
	Clean up. More...

Public Member Functions inherited from gnsstk::NavDataFactoryWithStore
bool	addNavData (const NavDataPtr &nd)

bool	addNavData (const NavDataPtr &nd, NavMessageMap &navMap, NavNearMessageMap &navNearMap, OffsetCvtMap &ofsMap)

void	clear () override
	Remove all data from the internal store. More...

virtual size_t	count (const NavMessageID &nmid) const

virtual size_t	count (const SatID &satID, NavMessageType nmt=NavMessageType::Unknown) const

virtual size_t	count (NavMessageType nmt) const

virtual size_t	count (SatelliteSystem sys, NavMessageType nmt=NavMessageType::Unknown) const

void	dump (std::ostream &s, DumpDetail dl) const override

void	edit (const CommonTime &fromTime, const CommonTime &toTime) override

void	edit (const CommonTime &fromTime, const CommonTime &toTime, const NavSatelliteID &satID) override

void	edit (const CommonTime &fromTime, const CommonTime &toTime, const NavSignalID &signal) override

bool	find (const NavMessageID &nmid, const CommonTime &when, NavDataPtr &navOut, SVHealth xmitHealth, NavValidityType valid, NavSearchOrder order) override

NavMessageIDSet	getAvailableMsgs (const CommonTime &fromTime, const CommonTime &toTime) const override

NavSatelliteIDSet	getAvailableSats (const CommonTime &fromTime, const CommonTime &toTime) const override

NavSatelliteIDSet	getAvailableSats (NavMessageType nmt, const CommonTime &fromTime, const CommonTime &toTime) const override

CommonTime	getFinalTime () const override

CommonTime	getFirstTime (const SatID &sat) const

std::set< SatID >	getIndexSet (const CommonTime &fromTime, const CommonTime &toTime) const

std::set< SatID >	getIndexSet (NavMessageType nmt, const CommonTime &fromTime, const CommonTime &toTime) const

CommonTime	getInitialTime () const override

CommonTime	getLastTime (const SatID &sat) const

const NavMap *	getNavMap (const NavMessageID &nmid) const

const NavMessageMap &	getNavMessageMap () const
	Get read-only access to the nav data map (User priority). More...

const NavNearMessageMap &	getNavNearMessageMap () const
	Get read-only access to the nav data map (Nearest priority). More...

bool	getOffset (TimeSystem fromSys, TimeSystem toSys, const CommonTime &when, NavDataPtr &offset, SVHealth xmitHealth=SVHealth::Any, NavValidityType valid=NavValidityType::ValidOnly) override

const OffsetCvtMap &	getTimeOffsetMap () const
	Get read-only access to the time offset map. More...

	NavDataFactoryWithStore ()
	Initialize internal data. More...

virtual size_t	numSatellites () const
	Return the number of distinct signals including PRN, in the data. More...

virtual size_t	numSignals () const
	Return the number of distinct signals (ignoring PRN) in the data. More...

virtual size_t	size () const
	Return the number of nav messages in data. More...

virtual	~NavDataFactoryWithStore ()
	Clean up. More...

Public Member Functions inherited from gnsstk::NavDataFactory
virtual void	addTypeFilter (NavMessageType nmt)

virtual void	clearTypeFilter ()

virtual std::string	getClassName () const
	Returns the fully-qualified class name. Used for debugging. More...

virtual std::string	getFactoryFormats () const =0
	Return a comma-separated list of formats supported by this factory. More...

std::set< SatID >	getIndexSet (const CommonTime &fromTime, const CommonTime &toTime) const

std::set< SatID >	getIndexSet (NavMessageType nmt, const CommonTime &fromTime, const CommonTime &toTime) const

NavMessageTypeSet	getTypeFilter () const

virtual bool	isPresent (const NavMessageID &nmid, const CommonTime &fromTime, const CommonTime &toTime)

virtual bool	isTypePresent (NavMessageType nmt, const NavSatelliteID &satID, const CommonTime &fromTime, const CommonTime &toTime)

	NavDataFactory ()

virtual void	setControl (const FactoryControl &ctrl)

virtual void	setTypeFilter (const NavMessageTypeSet &nmts)

virtual void	setValidityFilter (NavValidityType nvt)

virtual	~NavDataFactory ()
	Clean up. More...

Additional Inherited Members
Public Types inherited from gnsstk::NavDataFactoryWithStore
typedef std::map< TimeCvtKey, OffsetEpochMap >	OffsetCvtMap
	Map from the time system conversion pair to the conversion objects. More...

typedef std::map< CommonTime, OffsetMap >	OffsetEpochMap

typedef std::map< NavSatelliteID, NavDataPtr >	OffsetMap

Public Attributes inherited from gnsstk::NavDataFactory
NavSignalSet	supportedSignals

Protected Member Functions inherited from gnsstk::NavDataFactoryWithStore
virtual bool	findNearest (const NavMessageID &nmid, const CommonTime &when, NavDataPtr &navData, SVHealth xmitHealth, NavValidityType valid)

virtual bool	findUser (const NavMessageID &nmid, const CommonTime &when, NavDataPtr &navData, SVHealth xmitHealth, NavValidityType valid)

bool	matchHealth (NavData *ndp, SVHealth xmitHealth)

bool	updateInitialFinal (const CommonTime &begin, const CommonTime &end)

bool	validityCheck (const NavDataPtr &ndp, NavValidityType valid, SVHealth xmitHealth, const CommonTime &when)

bool	validityCheck (const NavMap::iterator &ti, NavMap &nm, NavValidityType valid, SVHealth xmitHealth, const CommonTime &when)

Protected Attributes inherited from gnsstk::NavDataFactoryWithStore
NavMessageMap	data
	Internal storage of navigation data for User searches. More...

CommonTime	finalTime
	Store the latest applicable orbit time here, by addNavData. More...

std::map< SatID, std::pair< CommonTime, CommonTime > >	firstLastMap
	Map subject satellite ID to time stamp pair (oldest,newest). More...

CommonTime	initialTime
	Store the earliest applicable orbit time here, by addNavData. More...

NavNearMessageMap	nearestData
	Internal storage of navigation data for Nearest searches. More...

OffsetCvtMap	offsetData

Protected Attributes inherited from gnsstk::NavDataFactory
FactoryControl	factControl
	Configuration for the behavior of this factory. More...

NavValidityType	navValidity

NavMessageTypeSet	procNavTypes

Constructor & Destructor Documentation

◆ NavDataFactoryWithStoreFile()

gnsstk::NavDataFactoryWithStoreFile::NavDataFactoryWithStoreFile ( )

inline

Definition at line 54 of file NavDataFactoryWithStoreFile.hpp.

◆ ~NavDataFactoryWithStoreFile()

virtual gnsstk::NavDataFactoryWithStoreFile::~NavDataFactoryWithStoreFile ( )

inlinevirtual

Clean up.

Definition at line 58 of file NavDataFactoryWithStoreFile.hpp.

Member Function Documentation

◆ addDataSource()

bool gnsstk::NavDataFactoryWithStoreFile::addDataSource ( const std::string & source )

inlineoverridevirtual

Load a file into the default map, NavDataFactoryWithStore::data.

Parameters

[in] source The path to the file to load.

Returns: true on success, false on failure.

Implements gnsstk::NavDataFactory.

Reimplemented in gnsstk::SP3NavDataFactory.

Definition at line 64 of file NavDataFactoryWithStoreFile.hpp.

◆ loadIntoMap()

virtual bool gnsstk::NavDataFactoryWithStoreFile::loadIntoMap	(	const std::string &	filename,
		NavMessageMap &	navMap,
		NavNearMessageMap &	navNearMap,
		OffsetCvtMap &	ofsMap
	)

pure virtual

Abstract method that should be overridden by specific file-reading factory classes in order to load the data into the map.

Note: When implementing this method, make sure to handle validity checks!

Parameters

[in]	filename	The path of the file to load.
[out]	navMap	The map to store the loaded data in.
[out]	navNearMap	The map to store the loaded data in for use by "Nearest" (as opposed to "User") searches.
[out]	ofsMap	The map to load TimeOffsetData into.

Returns: true on success, false on failure.

Implemented in gnsstk::SP3NavDataFactory, gnsstk::MultiFormatNavDataFactory, gnsstk::RinexNavDataFactory, gnsstk::SEMNavDataFactory, and gnsstk::YumaNavDataFactory.

◆ process()

virtual bool gnsstk::NavDataFactoryWithStoreFile::process	(	const std::string &	filename,
		NavDataFactoryCallback &	cb
	)

pure virtual

Process the data in the specified file using a custom callback. Each message decoded by the factory class will be run through NavDataFactoryCallback::process(). It is expected that the user will derive a class from NavDataFactoryCallback, implement the details of the process method to suit their use case, and apply it here.

Parameters

[in]	filename	The path of the file to process.
[in]	cb	The call back to use to process the data in the file.

Returns: true on success, false on failure.

Implemented in gnsstk::MultiFormatNavDataFactory, gnsstk::SP3NavDataFactory, gnsstk::RinexNavDataFactory, gnsstk::SEMNavDataFactory, and gnsstk::YumaNavDataFactory.

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

NavDataFactoryWithStoreFile.hpp

Detailed Description

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ NavDataFactoryWithStoreFile()

◆ ~NavDataFactoryWithStoreFile()

Member Function Documentation

◆ addDataSource()

◆ loadIntoMap()

◆ process()