gnssDataMap Struct Reference
[GPSTk data structures]

#include <DataStructures.hpp>

List of all members.

---

Detailed Description

GNSS data structure consisting in a map with DayTime as keys, and sourceDataMap as elements.

Definition at line 1181 of file DataStructures.hpp.

Public Member Functions
	gnssDataMap ()
	Default constructor.
	gnssDataMap (double tol)
	Common constructor.
gnssDataMap &	addGnssSatTypeValue (const gnssSatTypeValue &gds)
	Adds 'gnssSatTypeValue' object data to this structure.
gnssDataMap &	addGnssRinex (const gnssRinex &gds)
	Adds 'gnssRinex' object data to this structure.
gnssRinex	getGnssRinex (const SourceID &source) const
	Returns a 'gnssRinex' object corresponding to given SourceID.
gnssDataMap &	addGnssDataMap (const gnssDataMap &gds)
	Adds 'gnssDataMap' object data to this structure.
gnssDataMap	front (void) const
	Returns a copy of the first element in the map.
void	pop_front (void)
	Removes the first element in the map.
gnssDataMap	frontEpoch (void) const
	Returns the data corresponding to the first epoch in the map, taking into account the 'tolerance' value.
void	pop_front_epoch (void)
	Removes the first epoch in the map.
gnssDataMap	back (void) const
	Returns a copy of the last element in the map.
void	pop_back (void)
	Removes the last element in the map.
gnssDataMap	backEpoch (void) const
	Returns the data corresponding to the last epoch in the map, taking into account the 'tolerance' value.
void	pop_back_epoch (void)
	Removes the last epoch in the map.
gnssDataMap	getDataFromEpoch (const DayTime &epoch) const throw ( DayTimeNotFound )
	Returns a 'gnssDataMap' with the data corresponding to provided DayTime, taking into account 'tolerance'.
double	getValue (const DayTime &epoch, const SourceID &source, const SatID &satellite, const TypeID &type) const throw ( DayTimeNotFound, ValueNotFound )
	Returns the data value (double) corresponding to provided DayTime, SourceID, SatID and TypeID.
double	getValue (const SourceID &source, const SatID &satellite, const TypeID &type) const throw ( ValueNotFound )
	Returns the data value (double) corresponding to the first epoch in the data structure, given SourceID, SatID and TypeID.
gnssDataMap &	insertValue (const DayTime &epoch, const SourceID &source, const SatID &satellite, const TypeID &type, double value) throw ( DayTimeNotFound, ValueNotFound )
	Inserts a data value (double) at the provided DayTime, SourceID, SatID and TypeID, taking into account 'tolerance'.
gnssDataMap &	insertValue (const SourceID &source, const SatID &satellite, const TypeID &type, double value) throw ( ValueNotFound )
	Inserts a data value (double) in the first epoch of the data structure with the given SourceID, SatID and TypeID.
SourceIDSet	getSourceIDSet (void) const
	Get a set with all the SourceID's in this data structure.
SatIDSet	getSatIDSet (void) const
	Get a set with all the SatID's in this data structure.
double	getTolerance (void) const
	Get tolerance.
gnssDataMap &	setTolerance (double tol)
	Set tolerance.
virtual std::ostream &	dump (std::ostream &s, int mode=0) const
	Convenience output method.
gnssDataMap	extractSourceID (const SourceID &source)
	Returns a gnssDataMap with only this source.
gnssDataMap	extractSourceID (const SourceIDSet &sourceSet)
	Returns a gnssDataMap with only these sources.
gnssDataMap &	keepOnlySourceID (const SourceID &source)
	Modifies this object, keeping only this source.
gnssDataMap &	keepOnlySourceID (const SourceIDSet &sourceSet)
	Modifies this object, keeping only these sources.
gnssDataMap &	removeSourceID (const SourceID &source)
	Modifies this object, removing this source.
gnssDataMap &	removeSourceID (const SourceIDSet &sourceSet)
	Modifies this object, keeping only these sources.
gnssDataMap	extractSatID (const SatID &sat)
	Returns a gnssDataMap with only this satellite.
gnssDataMap	extractSatID (const SatIDSet &satSet)
	Returns a gnssDataMap with only these satellites.
gnssDataMap &	keepOnlySatID (const SatID &sat)
	Modifies this object, keeping only this satellite.
gnssDataMap &	keepOnlySatID (const SatIDSet &satSet)
	Modifies this object, keeping only these satellites.
gnssDataMap &	removeSatID (const SatID &sat)
	Modifies this object, removing this satellite.
gnssDataMap &	removeSatID (const SatIDSet &satSet)
	Modifies this object, keeping only these satellites.
gnssDataMap	extractTypeID (const TypeID &type)
	Returns a gnssDataMap with only this type.
gnssDataMap	extractTypeID (const TypeIDSet &typeSet)
	Returns a gnssDataMap with only these satellites.
gnssDataMap &	keepOnlyTypeID (const TypeID &type)
	Modifies this object, keeping only this type.
gnssDataMap &	keepOnlyTypeID (const TypeIDSet &typeSet)
	Modifies this object, keeping only these types.
gnssDataMap &	removeTypeID (const TypeID &type)
	Modifies this object, removing this type.
gnssDataMap &	removeTypeID (const TypeIDSet &typeSet)
	Modifies this object, keeping only these types.
virtual gnssDataMap &	edit (DayTime tmin, DayTime tmax=DayTime(DayTime::END_OF_TIME))
	Edit the dataset, removing data outside the indicated time interval.
void	loadObsFile (std::string obsFile)
	Load data from a rinex observation file.
virtual	~gnssDataMap ()
	Destructor.
Public Attributes
double	tolerance
	Tolerance set to get data from a given epoch.

---

Constructor & Destructor Documentation

gnssDataMap (   )  [inline]

Default constructor. Definition at line 1185 of file DataStructures.hpp. References gpstk::SatIDSet, and gpstk::SourceIDSet.

gnssDataMap (  double  tol  )  [inline]

Common constructor. Parameters: tol  Tolerance to be applied to epochs (in seconds). Definition at line 1193 of file DataStructures.hpp.

virtual ~gnssDataMap (   )  [inline, virtual]

Destructor. Definition at line 1492 of file DataStructures.hpp.

---

Member Function Documentation

gnssDataMap & addGnssDataMap (  const gnssDataMap &  gds  )

Adds 'gnssDataMap' object data to this structure. Parameters: gds  gnssDataMap object containing data to be added. Definition at line 1715 of file DataStructures.cpp. References gnssDataMap::addGnssSatTypeValue(), gnssData::body, sourceEpochHeader::epoch, gnssData::header, and sourceHeader::source. Referenced by gnssDataMap::edit().

gnssDataMap & addGnssRinex (  const gnssRinex &  gds  )

Adds 'gnssRinex' object data to this structure. Parameters: gds  gnssRinex object containing data to be added. Definition at line 1647 of file DataStructures.cpp. References gnssData::body, sourceEpochHeader::epoch, gnssRinex::header, and sourceHeader::source. Referenced by GeneralConstraint::constraint(), GeneralEquations::getConstraintSystem(), gnssDataMap::loadObsFile(), EquationSystem::Prepare(), SolverGeneral::Process(), and gpstk::testSave().

gnssDataMap & addGnssSatTypeValue (  const gnssSatTypeValue &  gds  )

Adds 'gnssSatTypeValue' object data to this structure. Parameters: gds  gnssSatTypeValue object containing data to be added. Definition at line 1624 of file DataStructures.cpp. References gnssData::body, sourceEpochHeader::epoch, gnssData::header, and sourceHeader::source. Referenced by gnssDataMap::addGnssDataMap(), gpstk::extractSatID(), gnssDataMap::extractSatID(), gpstk::extractSourceID(), gnssDataMap::extractSourceID(), gpstk::extractTypeID(), gnssDataMap::extractTypeID(), gpstk::mergeGnssDataMap(), gpstk::removeSatID(), gnssDataMap::removeSatID(), gpstk::removeSourceID(), gnssDataMap::removeSourceID(), gpstk::removeTypeID(), and gnssDataMap::removeTypeID().

gnssDataMap back (  void   )  const

Returns a copy of the last element in the map. Definition at line 1864 of file DataStructures.cpp.

gnssDataMap backEpoch (  void   )  const

Returns the data corresponding to the last epoch in the map, taking into account the 'tolerance' value. Definition at line 1912 of file DataStructures.cpp. References gnssDataMap::tolerance.

std::ostream & dump (  std::ostream &  s, int  mode = 0 )  const [virtual]

Convenience output method. Definition at line 2379 of file DataStructures.cpp.

gnssDataMap & edit (  DayTime  tmin, DayTime  tmax = DayTime(DayTime::END_OF_TIME) )  [virtual]

Edit the dataset, removing data outside the indicated time interval. Parameters: [in]  tmin  defines the beginning of the time interval [in]  tmax  defines the end of the time interval Definition at line 2803 of file DataStructures.cpp. References gnssDataMap::addGnssDataMap(), gnssDataMap::frontEpoch(), and gnssDataMap::pop_front_epoch().

gnssDataMap extractSatID (  const SatIDSet &  satSet  )

Returns a gnssDataMap with only these satellites. Parameters: satSet  Set(SatIDSet) containing the satellite to be extracted. Definition at line 2578 of file DataStructures.cpp. References gnssDataMap::addGnssSatTypeValue(), gnssData::body, sourceEpochHeader::epoch, gnssData::header, satTypeValueMap::keepOnlySatID(), and sourceHeader::source.

gnssDataMap extractSatID (  const SatID &  sat  )

Returns a gnssDataMap with only this satellite. Parameters: sat  Satellite to be extracted. Definition at line 2566 of file DataStructures.cpp. References gpstk::SatIDSet. Referenced by gnssDataMap::keepOnlySatID().

gnssDataMap extractSourceID (  const SourceIDSet &  sourceSet  )

Returns a gnssDataMap with only these sources. Parameters: sourceSet  Set(SourceIDSet) containing the sources to be extracted. Definition at line 2457 of file DataStructures.cpp. References gnssDataMap::addGnssSatTypeValue(), gnssData::body, sourceEpochHeader::epoch, gnssData::header, and sourceHeader::source.

gnssDataMap extractSourceID (  const SourceID &  source  )

Returns a gnssDataMap with only this source. Parameters: source  Source to be extracted. Definition at line 2443 of file DataStructures.cpp. References gpstk::SourceIDSet. Referenced by gnssDataMap::keepOnlySourceID().

gnssDataMap extractTypeID (  const TypeIDSet &  typeSet  )

Returns a gnssDataMap with only these satellites. Parameters: typeSet  Set(TypeIDSet) containing the types to be extracted. Definition at line 2695 of file DataStructures.cpp. References gnssDataMap::addGnssSatTypeValue(), gnssData::body, sourceEpochHeader::epoch, gnssData::header, satTypeValueMap::keepOnlyTypeID(), and sourceHeader::source.

gnssDataMap extractTypeID (  const TypeID &  type  )

Returns a gnssDataMap with only this type. Parameters: type  Type to be extracted. Definition at line 2683 of file DataStructures.cpp. References gpstk::TypeIDSet. Referenced by gnssDataMap::keepOnlyTypeID().

gnssDataMap front (  void   )  const

Returns a copy of the first element in the map. Definition at line 1745 of file DataStructures.cpp.

gnssDataMap frontEpoch (  void   )  const

Returns the data corresponding to the first epoch in the map, taking into account the 'tolerance' value. Definition at line 1793 of file DataStructures.cpp. References gnssDataMap::tolerance. Referenced by gpstk::dumpGnssDataMap(), and gnssDataMap::edit().

gnssDataMap getDataFromEpoch (  const DayTime &  epoch  )  const throw ( DayTimeNotFound )

Returns a 'gnssDataMap' with the data corresponding to provided DayTime, taking into account 'tolerance'. Parameters: epoch  Epoch to be looked for. Definition at line 1987 of file DataStructures.cpp. References GPSTK_THROW.

gnssRinex getGnssRinex (  const SourceID &  source  )  const

Returns a 'gnssRinex' object corresponding to given SourceID. Parameters: source  SourceID object. Warning: Returned data will correspond to first matching SourceID, if it exists. Definition at line 1673 of file DataStructures.cpp. References gnssData::body, sourceEpochHeader::epoch, sourceEpochRinexHeader::epochFlag, gnssRinex::header, and sourceHeader::source. Referenced by SolverGeneral::Process().

SatIDSet getSatIDSet (  void   )  const

Get a set with all the SatID's in this data structure. Warning: If current 'gnssDataMap' is big, this could be a very costly operation. Definition at line 2338 of file DataStructures.cpp. References gpstk::SatIDSet.

SourceIDSet getSourceIDSet (  void   )  const

Get a set with all the SourceID's in this data structure. Warning: If current 'gnssDataMap' is big, this could be a very costly operation. Definition at line 2302 of file DataStructures.cpp. References gpstk::SourceIDSet.

double getTolerance (  void   )  const [inline]

Get tolerance. Definition at line 1358 of file DataStructures.hpp.

double getValue (  const SourceID &  source, const SatID &  satellite, const TypeID &  type )  const throw ( ValueNotFound )

Returns the data value (double) corresponding to the first epoch in the data structure, given SourceID, SatID and TypeID. Parameters: source  Source to be looked for. satellite  Satellite to be looked for. type  Type to be looked for. Warning: If within first epoch (epoch +/- tolerance) more than one match exists, then only the first one is returned. Definition at line 2101 of file DataStructures.cpp. References gnssDataMap::getValue(), and GPSTK_THROW.

double getValue (  const DayTime &  epoch, const SourceID &  source, const SatID &  satellite, const TypeID &  type )  const throw ( DayTimeNotFound, ValueNotFound )

Returns the data value (double) corresponding to provided DayTime, SourceID, SatID and TypeID. Parameters: epoch  Epoch to be looked for. source  Source to be looked for. satellite  Satellite to be looked for. type  Type to be looked for. Warning: If within (epoch +/- tolerance) more than one match exists, then only the first one is returned. Definition at line 2045 of file DataStructures.cpp. References GPSTK_THROW. Referenced by gnssDataMap::getValue(), and sourceDataMap::getValue().

gnssDataMap & insertValue (  const SourceID &  source, const SatID &  satellite, const TypeID &  type, double  value )  throw ( ValueNotFound )

Inserts a data value (double) in the first epoch of the data structure with the given SourceID, SatID and TypeID. Parameters: source  Source to be looked for. satellite  Satellite to be looked for. type  Type of the new data. value  Value to be inserted. Definition at line 2245 of file DataStructures.cpp. References GPSTK_THROW.

gnssDataMap & insertValue (  const DayTime &  epoch, const SourceID &  source, const SatID &  satellite, const TypeID &  type, double  value )  throw ( DayTimeNotFound, ValueNotFound )

Inserts a data value (double) at the provided DayTime, SourceID, SatID and TypeID, taking into account 'tolerance'. Parameters: epoch  Epoch to be looked for. source  Source to be looked for. satellite  Satellite to be looked for. type  Type of the new data. value  Value to be inserted. Definition at line 2155 of file DataStructures.cpp. References GPSTK_THROW.

gnssDataMap & keepOnlySatID (  const SatIDSet &  satSet  )

Modifies this object, keeping only these satellites. Parameters: satSet  Set(SatIDSet) containing the satellite to be extracted. Definition at line 2624 of file DataStructures.cpp. References gnssDataMap::extractSatID().

gnssDataMap & keepOnlySatID (  const SatID &  sat  )

Modifies this object, keeping only this satellite. Parameters: sat  Satellite to be extracted. Definition at line 2614 of file DataStructures.cpp. References gnssDataMap::extractSatID(). Referenced by gpstk::testLoad().

gnssDataMap & keepOnlySourceID (  const SourceIDSet &  sourceSet  )

Modifies this object, keeping only these sources. Parameters: sourceSet  Set(SourceIDSet) containing the sources to be extracted. Definition at line 2505 of file DataStructures.cpp. References gnssDataMap::extractSourceID().

gnssDataMap & keepOnlySourceID (  const SourceID &  source  )

Modifies this object, keeping only this source. Parameters: source  Source to be extracted. Definition at line 2495 of file DataStructures.cpp. References gnssDataMap::extractSourceID(). Referenced by gpstk::testLoad().

gnssDataMap & keepOnlyTypeID (  const TypeIDSet &  typeSet  )

Modifies this object, keeping only these types. Parameters: typeSet  Set(TypeIDSet) containing the type to be extracted. Definition at line 2740 of file DataStructures.cpp. References gnssDataMap::extractTypeID().

gnssDataMap & keepOnlyTypeID (  const TypeID &  type  )

Modifies this object, keeping only this type. Parameters: type  Type to be extracted. Definition at line 2730 of file DataStructures.cpp. References gnssDataMap::extractTypeID(). Referenced by gpstk::testLoad().

void loadObsFile (  std::string  obsFile  )

Load data from a rinex observation file. Definition at line 2823 of file DataStructures.cpp. References gnssDataMap::addGnssRinex(), and GPSTK_THROW.

void pop_back (  void   )

Removes the last element in the map. Definition at line 1889 of file DataStructures.cpp.

void pop_back_epoch (  void   )

Removes the last epoch in the map. Be aware that this method takes into account 'tolerance', so more than just one epoch may be removed if they are within 'tolerance' margin. Definition at line 1949 of file DataStructures.cpp. References gnssDataMap::tolerance.

void pop_front (  void   )

Removes the first element in the map. Definition at line 1770 of file DataStructures.cpp.

void pop_front_epoch (  void   )

Removes the first epoch in the map. Be aware that this method takes into account 'tolerance', so more than just one epoch may be removed if they are within 'tolerance' margin. Definition at line 1830 of file DataStructures.cpp. References gnssDataMap::tolerance. Referenced by gpstk::dumpGnssDataMap(), and gnssDataMap::edit().

gnssDataMap & removeSatID (  const SatIDSet &  satSet  )

Modifies this object, keeping only these satellites. Parameters: satSet  Set(SatIDSet) containing the satellites to be removed. Definition at line 2644 of file DataStructures.cpp. References gnssDataMap::addGnssSatTypeValue(), gnssData::body, sourceEpochHeader::epoch, gnssData::header, satTypeValueMap::removeSatID(), and sourceHeader::source.

gnssDataMap & removeSatID (  const SatID &  sat  )

Modifies this object, removing this satellite. Parameters: sat  Satellite to be removed. Definition at line 2632 of file DataStructures.cpp. References gpstk::SatIDSet. Referenced by gnssRinex::keepOnlySatSystem().

gnssDataMap & removeSourceID (  const SourceIDSet &  sourceSet  )

Modifies this object, keeping only these sources. Parameters: sourceSet  Set(SourceIDSet) containing the sources to be removed. Definition at line 2526 of file DataStructures.cpp. References gnssDataMap::addGnssSatTypeValue(), gnssData::body, sourceEpochHeader::epoch, gnssData::header, and sourceHeader::source.

gnssDataMap & removeSourceID (  const SourceID &  source  )

Modifies this object, removing this source. Parameters: source  Source to be removed. Definition at line 2514 of file DataStructures.cpp. References gpstk::SourceIDSet.

gnssDataMap & removeTypeID (  const TypeIDSet &  typeSet  )

Modifies this object, keeping only these types. Parameters: typeSet  Set(TypeIDSet) containing the types to be removed. Definition at line 2761 of file DataStructures.cpp. References gnssDataMap::addGnssSatTypeValue(), gnssData::body, sourceEpochHeader::epoch, gnssData::header, satTypeValueMap::removeTypeID(), and sourceHeader::source.

gnssDataMap & removeTypeID (  const TypeID &  type  )

Modifies this object, removing this type. Parameters: type  Type to be removed. Definition at line 2749 of file DataStructures.cpp. References gpstk::TypeIDSet. Referenced by gnssSatTypeValue::removeTypeID(), and satTypeValueMap::removeTypeID().

gnssDataMap& setTolerance (  double  tol  )  [inline]

Set tolerance. Parameters: tol  Tolerance, in seconds. Definition at line 1366 of file DataStructures.hpp.

---

Member Data Documentation

double tolerance

Tolerance set to get data from a given epoch. Definition at line 1488 of file DataStructures.hpp. Referenced by gnssDataMap::backEpoch(), gnssDataMap::frontEpoch(), gnssDataMap::pop_back_epoch(), and gnssDataMap::pop_front_epoch().

---

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

• DataStructures.hpp
• DataStructures.cpp

---