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

gnssSatTypeValue Struct Reference
[GPSTk data structures]

#include <DataStructures.hpp>

Inheritance diagram for gnssSatTypeValue:

Inheritance graph
[legend]
Collaboration diagram for gnssSatTypeValue:

Collaboration graph
[legend]
List of all members.

Detailed Description

GNSS data structure with source and epoch as header (common indexes) and satTypeValueMap as body.

Definition at line 836 of file DataStructures.hpp.

Public Member Functions

size_t numSats () const
 Returns the number of satellites available in the body, which is a satTypeValueMap.
TypeIDSet getTypeID () const
 Returns a TypeIDSet with all the data types present in this object.
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.
size_t numElements () const
 Returns the total number of data elements in the body.
gnssSatTypeValue extractSatID (const SatID &satellite) const
 Returns a gnssSatTypeValue with only this satellite.
gnssSatTypeValue extractSatID (const int &p, const SatID::SatelliteSystem &s) const
 Returns a gnssSatTypeValue with only one satellite, identified by the given parameters.
gnssSatTypeValue extractSatID (const SatIDSet &satSet) const
 Returns a gnssSatTypeValue with only these satellites.
gnssSatTypeValue & keepOnlySatID (const SatID &satellite)
 Modifies this object, keeping only this satellite.
gnssSatTypeValue & keepOnlySatID (const int &p, const SatID::SatelliteSystem &s)
 Modifies this object, keeping only this satellite.
gnssSatTypeValue & keepOnlySatID (const SatIDSet &satSet)
 Modifies this object, keeping only these satellites.
gnssSatTypeValue extractTypeID (const TypeID &type) const
 Returns a gnssSatTypeValue with only this type of data.
gnssSatTypeValue extractTypeID (const TypeIDSet &typeSet) const
 Returns a gnssSatTypeValue with only these types of data.
gnssSatTypeValue & keepOnlyTypeID (const TypeID &type)
 Modifies this object, keeping only this type of data.
gnssSatTypeValue & keepOnlyTypeID (const TypeIDSet &typeSet)
 Modifies this object, keeping only these types of data.
gnssSatTypeValue & removeSatID (const SatID &satellite)
 Modifies this object, removing this satellite.
gnssSatTypeValue & removeSatID (const SatIDSet &satSet)
 Modifies this object, removing these satellites.
gnssSatTypeValue & removeTypeID (const TypeID &type)
 Modifies this object, removing this type of data.
gnssSatTypeValue & removeTypeID (const TypeIDSet &typeSet)
 Modifies this object, removing these types of data.
Vector< double > getVectorOfTypeID (const TypeID &type) const
 Returns a GPSTk::Vector containing the data values with this type.
gnssSatTypeValue & insertTypeIDVector (const TypeID &type, const Vector< double > dataVector) throw (NumberOfSatsMismatch)
 Modifies this object, adding one vector of data with this type, one value per satellite.
gnssSatTypeValue & insertMatrix (const TypeIDSet &typeSet, const Matrix< double > dataMatrix) throw (NumberOfSatsMismatch, NumberOfTypesMismatch)
 Modifies this object, adding a matrix of data, one vector per satellite.
double getValue (const SatID &satellite, const TypeID &type) const throw ( SatIDNotFound, TypeIDNotFound )
 Returns the data value (double) corresponding to provided SatID and TypeID.
typeValueMap & operator() (const SatID &satellite) throw (SatIDNotFound)
 Returns a reference to the typeValueMap with corresponding satellite.
virtual ~gnssSatTypeValue ()
 Destructor.

Constructor & Destructor Documentation

virtual ~gnssSatTypeValue (   )  [inline, virtual]
 

Destructor.

Definition at line 1068 of file DataStructures.hpp.

Member Function Documentation

gnssSatTypeValue extractSatID (  const SatIDSet &  satSet  )  const
 

Returns a gnssSatTypeValue with only these satellites.

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

Reimplemented in gnssRinex.

Definition at line 1191 of file DataStructures.cpp.

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

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

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

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

Reimplemented in gnssRinex.

Definition at line 1176 of file DataStructures.cpp.

References gnssSatTypeValue::extractSatID().

gnssSatTypeValue extractSatID (  const SatID &  satellite  )  const
 

Returns a gnssSatTypeValue with only this satellite.

Parameters:
satellite Satellite to be extracted.

Reimplemented in gnssRinex.

Definition at line 1158 of file DataStructures.cpp.

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

Referenced by gnssSatTypeValue::extractSatID().

gnssSatTypeValue extractTypeID (  const TypeIDSet &  typeSet  )  const
 

Returns a gnssSatTypeValue with only these types of data.

Parameters:
typeSet Set (TypeIDSet) containing the types of data to be extracted.

Reimplemented in gnssRinex.

Definition at line 1265 of file DataStructures.cpp.

References gnssData::body, satTypeValueMap::extractTypeID(), and gnssData::header.

gnssSatTypeValue extractTypeID (  const TypeID &  type  )  const
 

Returns a gnssSatTypeValue with only this type of data.

Parameters:
type Type of value to be extracted.

Reimplemented in gnssRinex.

Definition at line 1249 of file DataStructures.cpp.

References gnssData::body, satTypeValueMap::extractTypeID(), and gnssData::header.

SatIDSet getSatID (   )  const [inline]
 

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

Definition at line 852 of file DataStructures.hpp.

TypeIDSet getTypeID (   )  const [inline]
 

Returns a TypeIDSet with all the data types present in this object.

Definition at line 847 of file DataStructures.hpp.

double getValue (  const SatID &  satellite,
const TypeID &  type
)  const throw ( SatIDNotFound, TypeIDNotFound ) [inline]
 

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

Parameters:
satellite Satellite to be looked for.
type Type to be looked for.

Definition at line 1009 of file DataStructures.hpp.

Vector<SatID> getVectorOfSatID (   )  const [inline]
 

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

Definition at line 857 of file DataStructures.hpp.

Vector<double> getVectorOfTypeID (  const TypeID &  type  )  const [inline]
 

Returns a GPSTk::Vector containing the data values with this type.

Parameters:
type Type of value to be returned.

Definition at line 953 of file DataStructures.hpp.

gnssSatTypeValue& insertMatrix (  const TypeIDSet &  typeSet,
const Matrix< double >  dataMatrix
)  throw (NumberOfSatsMismatch, NumberOfTypesMismatch) [inline]
 

Modifies this object, adding a matrix of data, one vector per satellite.

If types already exists, data is overwritten. If the number of rows in matrix does not match with the number of satellites, a NumberOfSatsMismatch exception is thrown. If the number of columns in matrix does not match with the number of types in typeSet, a NumberOfTypesMismatch exception is thrown.

Given that dataMatrix does not store information about the satellites and types the values correspond to, the user is held responsible for having those data values stored in dataMatrix in the proper order regarding the SatIDs in this object and the provided typeSet.

Parameters:
typeSet Set (TypeIDSet) containing the types of data to be added.
dataMatrix GPSTk Matrix containing the data to be added.

Definition at line 997 of file DataStructures.hpp.

gnssSatTypeValue& insertTypeIDVector (  const TypeID &  type,
const Vector< double >  dataVector
)  throw (NumberOfSatsMismatch) [inline]
 

Modifies this object, adding one vector of data with this type, one value per satellite.

If type already exists, data is overwritten. If the number of values does not match with the number of satellites, a NumberOfSatsMismatch exception is thrown.

Given that dataVector does not store information about the satellites the values correspond to, the user is held responsible for having the data values stored in dataVector in the proper order regarding the SatIDs in this object.

Parameters:
type Type of data to be added.
dataVector GPSTk Vector containing the data to be added.

Definition at line 972 of file DataStructures.hpp.

gnssSatTypeValue & keepOnlySatID (  const SatIDSet &  satSet  ) 
 

Modifies this object, keeping only these satellites.

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

Reimplemented in gnssRinex.

Definition at line 1235 of file DataStructures.cpp.

gnssSatTypeValue & 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.

Reimplemented in gnssRinex.

Definition at line 1221 of file DataStructures.cpp.

References gnssSatTypeValue::keepOnlySatID().

gnssSatTypeValue & keepOnlySatID (  const SatID &  satellite  ) 
 

Modifies this object, keeping only this satellite.

Parameters:
satellite Satellite to be kept.

Reimplemented in gnssRinex.

Definition at line 1206 of file DataStructures.cpp.

References gpstk::SatIDSet.

Referenced by gnssSatTypeValue::keepOnlySatID().

gnssSatTypeValue & keepOnlyTypeID (  const TypeIDSet &  typeSet  ) 
 

Modifies this object, keeping only these types of data.

Parameters:
typeSet Set (TypeIDSet) containing the types of data to be kept.

Reimplemented in gnssRinex.

Definition at line 1296 of file DataStructures.cpp.

gnssSatTypeValue & keepOnlyTypeID (  const TypeID &  type  ) 
 

Modifies this object, keeping only this type of data.

Parameters:
type Type of value to be kept.

Reimplemented in gnssRinex.

Definition at line 1281 of file DataStructures.cpp.

References gpstk::TypeIDSet.

size_t numElements (   )  const [inline]
 

Returns the total number of data elements in the body.

This method DOES NOT suppose that all the satellites have the same number of type values.

Definition at line 865 of file DataStructures.hpp.

size_t numSats (   )  const [inline]
 

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

Definition at line 841 of file DataStructures.hpp.

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

Returns a reference to the typeValueMap with corresponding satellite.

This operator allows direct access to data values when chained with the typeValueMap::operator(), like this:

gRin(sat21)(TypeID::C1).

Example:

   // Create the input file stream
   RinexObsStream rin("bahr1620.04o");

   // Declare a gnssRinex object
   gnssRinex gRin;

   // Create a satellite object
   SatID sat21(21,SatID::systemGPS);

   // Feed the gRin data structure
   while(rin >> gRin)
   {
      try
      {
          if (gRin(sat21)(TypeID::C1) == 0.0)
          {
             gRin(sat21)(TypeID::C1) = 123.456;
          }

          cout << "C1 value for satellite G21: "
               << gRin(sat21)(TypeID::C1) << endl;
      }
      catch (SatIDNotFound& e)
      {
          cout << endl << "Satellite G21 not found." << endl;
      };
   }

Parameters:
satellite Satellite to be looked for.
Warning:
Please be aware that this operator doesn't mantain the 'constness' of the data structure, allowing direct access to all data (including editing). If this is not what you want, use method 'getValue()' instead.

Definition at line 1062 of file DataStructures.hpp.

gnssSatTypeValue & removeSatID (  const SatIDSet &  satSet  ) 
 

Modifies this object, removing these satellites.

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

Definition at line 1311 of file DataStructures.cpp.

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

Modifies this object, removing this satellite.

Parameters:
satellite Satellite to be removed.

Definition at line 929 of file DataStructures.hpp.

gnssSatTypeValue & removeTypeID (  const TypeIDSet &  typeSet  ) 
 

Modifies this object, removing these types of data.

Parameters:
typeSet Set (TypeIDSet) containing the types of data to be kept.

Definition at line 1330 of file DataStructures.cpp.

References gnssDataMap::removeTypeID().

gnssSatTypeValue& removeTypeID (  const TypeID &  type  )  [inline]
 

Modifies this object, removing this type of data.

Parameters:
type Type of value to be kept.

Definition at line 941 of file DataStructures.hpp.

References gnssDataMap::getValue().

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