Main Page | Modules | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages | Examples | Search for 

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 1175 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 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.
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 1179 of file DataStructures.hpp.

gnssDataMap (  double  tol  )  [inline]
 

Common constructor.

Parameters:
tol Tolerance to be applied to epochs (in seconds).

Definition at line 1187 of file DataStructures.hpp.

References gpstk::SatIDSet, and gpstk::SourceIDSet.

virtual ~gnssDataMap (   )  [inline, virtual]
 

Destructor.

Definition at line 1367 of file DataStructures.hpp.

Member Function Documentation

gnssDataMap & addGnssRinex (  const gnssRinex &  gds  ) 
 

Adds 'gnssRinex' object data to this structure.

Parameters:
gds gnssRinex object containing data to be added.

Definition at line 1626 of file DataStructures.cpp.

References gnssData::body, sourceEpochHeader::epoch, gnssRinex::header, and sourceHeader::source.

Referenced by EquationSystem::Prepare(), and SolverGeneral::Process().

gnssDataMap & addGnssSatTypeValue (  const gnssSatTypeValue &  gds  ) 
 

Adds 'gnssSatTypeValue' object data to this structure.

Parameters:
gds gnssSatTypeValue object containing data to be added.

Definition at line 1603 of file DataStructures.cpp.

References gnssData::body, sourceEpochHeader::epoch, gnssData::header, and sourceHeader::source.

gnssDataMap back (  void   )  const
 

Returns a copy of the last element in the map.

Definition at line 1809 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 1857 of file DataStructures.cpp.

References gnssDataMap::tolerance.

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

Convenience output method.

Definition at line 2324 of file DataStructures.cpp.

Referenced by gpstk::operator<<().

gnssDataMap front (  void   )  const
 

Returns a copy of the first element in the map.

Definition at line 1690 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 1738 of file DataStructures.cpp.

References gnssDataMap::tolerance.

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 1932 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 1652 of file DataStructures.cpp.

References gnssData::body, sourceEpochHeader::epoch, 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 2283 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 2247 of file DataStructures.cpp.

References gpstk::SourceIDSet.

double getTolerance (  void   )  const [inline]
 

Get tolerance.

Definition at line 1345 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 2046 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 1990 of file DataStructures.cpp.

References GPSTK_THROW.

Referenced by gnssDataMap::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 2190 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 2100 of file DataStructures.cpp.

References GPSTK_THROW.

void pop_back (  void   ) 
 

Removes the last element in the map.

Definition at line 1834 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 1894 of file DataStructures.cpp.

References gnssDataMap::tolerance.

void pop_front (  void   ) 
 

Removes the first element in the map.

Definition at line 1715 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 1775 of file DataStructures.cpp.

References gnssDataMap::tolerance.

gnssDataMap& setTolerance (  double  tol  )  [inline]
 

Set tolerance.

Parameters:
tol Tolerance, in seconds.

Definition at line 1353 of file DataStructures.hpp.

Member Data Documentation

double tolerance
 

Tolerance set to get data from a given epoch.

Definition at line 1363 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:
Generated on Wed Sep 8 03:31:34 2010 for GPS ToolKit Software Library by  doxygen 1.3.9.1