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

satValueMap Struct Reference
[GPSTk data structures]

#include <DataStructures.hpp>

List of all members.

Detailed Description

Map holding SatID with corresponding numeric value.

Definition at line 317 of file DataStructures.hpp.

Public Member Functions

size_t numSats () const
 Returns the number of satellites available.
SatIDSet getSatID () const
 Returns a SatIDSet with all the satellites present in this object.
Vector< SatID > getVectorOfSatID () const
 Returns a Vector with all the satellites present in this object.
satValueMap extractSatID (const SatID &satellite) const
 Returns a satValueMap with only this satellite.
satValueMap extractSatID (const int &p, const SatID::SatelliteSystem &s) const
 Returns a satValueMap with only one satellite, identified by the given parameters.
satValueMap extractSatID (const SatIDSet &satSet) const
 Returns a satValueMap with only these satellites.
satValueMap & keepOnlySatID (const SatID &satellite)
 Modifies this object, keeping only this satellite.
satValueMap & keepOnlySatID (const int &p, const SatID::SatelliteSystem &s)
 Modifies this object, keeping only this satellite.
satValueMap & keepOnlySatID (const SatIDSet &satSet)
 Modifies this object, keeping only these satellites.
satValueMap & removeSatID (const SatID &satellite)
 Modifies this object, removing this satellite.
satValueMap & removeSatID (const SatIDSet &satSet)
 Modifies this object, removing the given satellites.
double getValue (const SatID &satellite) const throw (SatIDNotFound)
 Returns the data value (double) corresponding to provided SatID.
double & operator() (const SatID &satellite) throw (SatIDNotFound)
 Returns a reference to the data value (double) with corresponding SatID.
virtual ~satValueMap ()
 Destructor.

Constructor & Destructor Documentation

virtual ~satValueMap (   )  [inline, virtual]
 

Destructor.

Definition at line 397 of file DataStructures.hpp.

Member Function Documentation

satValueMap extractSatID (  const SatIDSet &  satSet  )  const
 

Returns a satValueMap with only these satellites.

Parameters:
satSet Set (SatIDSet) containing the satellites to be extracted.

Definition at line 273 of file DataStructures.cpp.

satValueMap extractSatID (  const int &  p,
const SatID::SatelliteSystem &  s
)  const
 

Returns a satValueMap with only one satellite, identified by the given parameters.

Parameters:
p Satellite PRN number.
p System the satellite belongs to.

Definition at line 258 of file DataStructures.cpp.

References satValueMap::extractSatID().

satValueMap extractSatID (  const SatID &  satellite  )  const
 

Returns a satValueMap with only this satellite.

Parameters:
satellite Satellite to be extracted.

Definition at line 242 of file DataStructures.cpp.

References gpstk::SatIDSet.

Referenced by gnssSatValue::extractSatID(), satValueMap::extractSatID(), and satValueMap::keepOnlySatID().

SatIDSet getSatID (   )  const
 

Returns a SatIDSet with all the satellites present in this object.

Definition at line 200 of file DataStructures.cpp.

References gpstk::SatIDSet.

double getValue (  const SatID &  satellite  )  const throw (SatIDNotFound)
 

Returns the data value (double) corresponding to provided SatID.

Parameters:
satellite Satellite to be looked for.

Definition at line 362 of file DataStructures.cpp.

References GPSTK_THROW.

Vector< SatID > getVectorOfSatID (   )  const
 

Returns a Vector with all the satellites present in this object.

Definition at line 219 of file DataStructures.cpp.

satValueMap & keepOnlySatID (  const SatIDSet &  satSet  ) 
 

Modifies this object, keeping only these satellites.

Parameters:
satSet Set (SatIDSet) containing the satellites to be kept.

Definition at line 327 of file DataStructures.cpp.

References satValueMap::extractSatID().

satValueMap & keepOnlySatID (  const int &  p,
const SatID::SatelliteSystem &  s
) 
 

Modifies this object, keeping only this satellite.

Parameters:
p Satellite PRN number.
p System the satellite belongs to.

Definition at line 313 of file DataStructures.cpp.

References satValueMap::keepOnlySatID().

satValueMap & keepOnlySatID (  const SatID &  satellite  ) 
 

Modifies this object, keeping only this satellite.

Parameters:
satellite Satellite to be kept.

Definition at line 298 of file DataStructures.cpp.

References gpstk::SatIDSet.

Referenced by satValueMap::keepOnlySatID().

size_t numSats (   )  const [inline]
 

Returns the number of satellites available.

Definition at line 321 of file DataStructures.hpp.

double & operator() (  const SatID &  satellite  )  throw (SatIDNotFound)
 

Returns a reference to the data value (double) with corresponding SatID.

Parameters:
satellite Satellite to be looked for.

Definition at line 383 of file DataStructures.cpp.

References GPSTK_THROW.

satValueMap & removeSatID (  const SatIDSet &  satSet  ) 
 

Modifies this object, removing the given satellites.

Parameters:
satSet Set (SatIDSet) containing the satellites to be removed.

Definition at line 342 of file DataStructures.cpp.

satValueMap& removeSatID (  const SatID &  satellite  )  [inline]
 

Modifies this object, removing this satellite.

Parameters:
satellite Satellite to be removed.

Definition at line 371 of file DataStructures.hpp.

The documentation for this struct was generated from the following files:
Generated on Wed May 22 03:31:47 2013 for GPS ToolKit Software Library by  doxygen 1.3.9.1