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

gnssSatValue Struct Reference
[GPSTk data structures]

#include <DataStructures.hpp>

Inheritance diagram for gnssSatValue:

Inheritance graph
[legend]
Collaboration diagram for gnssSatValue:

Collaboration graph
[legend]
List of all members.

Detailed Description

GNSS data structure with source, epoch and data type as header (common indexes) and satValueMap as body.

Definition at line 665 of file DataStructures.hpp.

Public Member Functions

size_t numSats () const
 Returns the number of satellites available in the body, which is a satValueMap.
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.
gnssSatValue extractSatID (const SatID &satellite) const
 Returns a gnssSatValue with only this satellite.
gnssSatValue extractSatID (const int &p, const SatID::SatelliteSystem &s) const
 Returns a gnssSatValue with only one satellite, identified by the given parameters.
gnssSatValue extractSatID (const SatIDSet &satSet) const
 Returns a gnssSatValue with only these satellites.
gnssSatValue & keepOnlySatID (const SatID &satellite)
 Modifies this object, keeping only this satellite.
gnssSatValue & keepOnlySatID (const int &p, const SatID::SatelliteSystem &s)
 Modifies this object, keeping only this satellite.
gnssSatValue & keepOnlySatID (const SatIDSet &satSet)
 Modifies this object, keeping only these satellites.
gnssSatValue & removeSatID (const SatID &satellite)
 Modifies this object, removing this satellite.
gnssSatValue & removeSatID (const SatIDSet &satSet)
 Modifies this object, removing these 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 value (double) with corresponding satellite.
virtual ~gnssSatValue ()
 Destructor.

Constructor & Destructor Documentation

virtual ~gnssSatValue (   )  [inline, virtual]
 

Destructor.

Definition at line 751 of file DataStructures.hpp.

Member Function Documentation

gnssSatValue extractSatID (  const SatIDSet &  satSet  )  const
 

Returns a gnssSatValue with only these satellites.

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

Definition at line 994 of file DataStructures.cpp.

References gnssData::body, satValueMap::extractSatID(), and gnssData::header.

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

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

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

Definition at line 979 of file DataStructures.cpp.

References gnssSatValue::extractSatID().

gnssSatValue extractSatID (  const SatID &  satellite  )  const
 

Returns a gnssSatValue with only this satellite.

Parameters:
satellite Satellite to be extracted.

Definition at line 962 of file DataStructures.cpp.

References gnssData::body, satValueMap::extractSatID(), and gnssData::header.

Referenced by gnssSatValue::extractSatID().

SatIDSet getSatID (   )  const [inline]
 

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

Definition at line 676 of file DataStructures.hpp.

double getValue (  const SatID &  satellite  )  const throw (SatIDNotFound) [inline]
 

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

Parameters:
satellite Satellite to be looked for.

Definition at line 737 of file DataStructures.hpp.

Vector<SatID> getVectorOfSatID (   )  const [inline]
 

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

Definition at line 681 of file DataStructures.hpp.

gnssSatValue & keepOnlySatID (  const SatIDSet &  satSet  ) 
 

Modifies this object, keeping only these satellites.

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

Definition at line 1038 of file DataStructures.cpp.

gnssSatValue & 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 1024 of file DataStructures.cpp.

References gnssSatValue::keepOnlySatID().

gnssSatValue & keepOnlySatID (  const SatID &  satellite  ) 
 

Modifies this object, keeping only this satellite.

Parameters:
satellite Satellite to be kept.

Definition at line 1009 of file DataStructures.cpp.

References gpstk::SatIDSet.

Referenced by gnssSatValue::keepOnlySatID().

size_t numSats (   )  const [inline]
 

Returns the number of satellites available in the body, which is a satValueMap.

Definition at line 671 of file DataStructures.hpp.

double& operator() (  const SatID &  satellite  )  throw (SatIDNotFound) [inline]
 

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

Parameters:
satellite Satellite to be looked for.

Definition at line 745 of file DataStructures.hpp.

References gnssDataMap::getValue().

gnssSatValue & removeSatID (  const SatIDSet &  satSet  ) 
 

Modifies this object, removing these satellites.

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

Definition at line 1053 of file DataStructures.cpp.

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

Modifies this object, removing this satellite.

Parameters:
satellite Satellite to be removed.

Definition at line 723 of file DataStructures.hpp.

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