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

satTypeValueMap Struct Reference
[GPSTk data structures]

#include <DataStructures.hpp>

List of all members.

Detailed Description

Map holding SatID with corresponding typeValueMap.

Definition at line 404 of file DataStructures.hpp.

Public Member Functions

size_t numSats () const
 Returns the number of available satellites.
size_t numElements () const
 Returns the total number of data elements in the map.
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.
TypeIDSet getTypeID () const
 Returns a TypeIDSet with all the data types present in this object.
satTypeValueMap extractSatID (const SatID &satellite) const
 Returns a satTypeValueMap with only this satellite.
satTypeValueMap extractSatID (const int &p, const SatID::SatelliteSystem &s) const
 Returns a satTypeValueMap with only one satellite, identified by the given parameters.
satTypeValueMap extractSatID (const SatIDSet &satSet) const
 Returns a satTypeValueMap with only these satellites.
satTypeValueMap & keepOnlySatID (const SatID &satellite)
 Modifies this object, keeping only this satellite.
satTypeValueMap & keepOnlySatID (const int &p, const SatID::SatelliteSystem &s)
 Modifies this object, keeping only this satellite.
satTypeValueMap & keepOnlySatID (const SatIDSet &satSet)
 Modifies this object, keeping only these satellites.
satTypeValueMap extractTypeID (const TypeID &type) const
 Returns a satTypeValueMap with only this type of value.
satTypeValueMap extractTypeID (const TypeIDSet &typeSet) const
 Returns a satTypeValueMap with only these types of data.
satTypeValueMap & keepOnlyTypeID (const TypeID &type)
 Modifies this object, keeping only this type of data.
satTypeValueMap & keepOnlyTypeID (const TypeIDSet &typeSet)
 Modifies this object, keeping only these types of data.
satTypeValueMap & removeSatID (const SatID &satellite)
 Modifies this object, removing this satellite.
satTypeValueMap & removeSatID (const SatIDSet &satSet)
 Modifies this object, removing these satellites.
satTypeValueMap & removeTypeID (const TypeID &type)
 Modifies this object, removing this type of data.
satTypeValueMap & 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.
Matrix< double > getMatrixOfTypes (const TypeIDSet &typeSet) const
 Returns a GPSTk::Matrix containing the data values in this set.
satTypeValueMap & 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.
satTypeValueMap & 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 SatID.
virtual std::ostream & dump (std::ostream &s, int mode=0) const
 Convenience output method.
virtual ~satTypeValueMap ()
 Destructor.

Constructor & Destructor Documentation

virtual ~satTypeValueMap (   )  [inline, virtual]
 

Destructor.

Definition at line 593 of file DataStructures.hpp.

Member Function Documentation

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

Convenience output method.

Definition at line 2854 of file DataStructures.cpp.

satTypeValueMap extractSatID (  const SatIDSet &  satSet  )  const
 

Returns a satTypeValueMap with only these satellites.

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

Definition at line 528 of file DataStructures.cpp.

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

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

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

Definition at line 513 of file DataStructures.cpp.

References satTypeValueMap::extractSatID().

satTypeValueMap extractSatID (  const SatID &  satellite  )  const
 

Returns a satTypeValueMap with only this satellite.

Parameters:
satellite Satellite to be extracted.

Definition at line 497 of file DataStructures.cpp.

References gpstk::SatIDSet.

Referenced by gnssRinex::extractSatID(), gnssSatTypeValue::extractSatID(), satTypeValueMap::extractSatID(), and satTypeValueMap::keepOnlySatID().

satTypeValueMap extractTypeID (  const TypeIDSet &  typeSet  )  const
 

Returns a satTypeValueMap with only these types of data.

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

Definition at line 610 of file DataStructures.cpp.

satTypeValueMap extractTypeID (  const TypeID &  type  )  const
 

Returns a satTypeValueMap with only this type of value.

Parameters:
type Type of value to be extracted.

Definition at line 595 of file DataStructures.cpp.

References gpstk::TypeIDSet.

Referenced by gnssRinex::extractTypeID(), gnssSatTypeValue::extractTypeID(), and satTypeValueMap::keepOnlyTypeID().

Matrix< double > getMatrixOfTypes (  const TypeIDSet &  typeSet  )  const
 

Returns a GPSTk::Matrix containing the data values in this set.

Parameters:
typeSet TypeIDSet of values to be returned.

Definition at line 760 of file DataStructures.cpp.

References Vector::end().

SatIDSet getSatID (   )  const
 

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

Definition at line 428 of file DataStructures.cpp.

References gpstk::SatIDSet.

Referenced by gpstk::operator<<().

TypeIDSet getTypeID (   )  const
 

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

This does not imply that all satellites have these types.

Definition at line 470 of file DataStructures.cpp.

References Vector::end(), and gpstk::TypeIDSet.

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

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 917 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 447 of file DataStructures.cpp.

Referenced by ModelObs::Prepare(), and ModeledPR::Prepare().

Vector< double > getVectorOfTypeID (  const TypeID &  type  )  const
 

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

Parameters:
type Type of value to be returned. This method returns zero if a given satellite does not have this type.

Definition at line 723 of file DataStructures.cpp.

Referenced by ModelObs::Prepare(), ModeledPR::Prepare(), and CodeKalmanSolver::Process().

satTypeValueMap & insertMatrix (  const TypeIDSet &  typeSet,
const Matrix< double >  dataMatrix
)  throw (NumberOfSatsMismatch, NumberOfTypesMismatch)
 

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

References Vector::end(), and GPSTK_THROW.

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

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

References Vector::end(), and GPSTK_THROW.

satTypeValueMap & keepOnlySatID (  const SatIDSet &  satSet  ) 
 

Modifies this object, keeping only these satellites.

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

Definition at line 581 of file DataStructures.cpp.

References satTypeValueMap::extractSatID().

satTypeValueMap & 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 567 of file DataStructures.cpp.

References satTypeValueMap::keepOnlySatID().

satTypeValueMap & keepOnlySatID (  const SatID &  satellite  ) 
 

Modifies this object, keeping only this satellite.

Parameters:
satellite Satellite to be kept.

Definition at line 552 of file DataStructures.cpp.

References gpstk::SatIDSet.

Referenced by gpstk::extractSatID(), gnssDataMap::extractSatID(), and satTypeValueMap::keepOnlySatID().

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

Definition at line 652 of file DataStructures.cpp.

References satTypeValueMap::extractTypeID().

satTypeValueMap & keepOnlyTypeID (  const TypeID &  type  ) 
 

Modifies this object, keeping only this type of data.

Parameters:
type Type of value to be kept.

Definition at line 637 of file DataStructures.cpp.

References gpstk::TypeIDSet.

Referenced by gpstk::extractTypeID(), and gnssDataMap::extractTypeID().

size_t numElements (   )  const
 

Returns the total number of data elements in the map.

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

Definition at line 409 of file DataStructures.cpp.

size_t numSats (   )  const [inline]
 

Returns the number of available satellites.

Definition at line 408 of file DataStructures.hpp.

Referenced by gpstk::operator<<(), SolverPPPFB::Process(), and CodeKalmanSolver::Process().

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

Returns a reference to the typeValueMap with corresponding SatID.

Parameters:
type Type of value to be look for.

Definition at line 938 of file DataStructures.cpp.

References GPSTK_THROW.

satTypeValueMap & removeSatID (  const SatIDSet &  satSet  ) 
 

Modifies this object, removing these satellites.

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

Definition at line 667 of file DataStructures.cpp.

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

Modifies this object, removing this satellite.

Parameters:
satellite Satellite to be removed.

Definition at line 493 of file DataStructures.hpp.

Referenced by gpstk::removeSatID(), and gnssDataMap::removeSatID().

satTypeValueMap & 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 704 of file DataStructures.cpp.

References satTypeValueMap::removeTypeID().

satTypeValueMap & removeTypeID (  const TypeID &  type  ) 
 

Modifies this object, removing this type of data.

Parameters:
type Type of value to be removed.

Definition at line 685 of file DataStructures.cpp.

References gnssDataMap::removeTypeID().

Referenced by gpstk::removeTypeID(), gnssDataMap::removeTypeID(), and satTypeValueMap::removeTypeID().

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