ComputePI Class Reference
[GPSTk data structures]

#include <ComputePI.hpp>

Inheritance diagram for ComputePI:

[legend]Collaboration diagram for ComputePI:

[legend]List of all members.

---

Detailed Description

This class eases computing PI combination for GNSS data structures.

This class is meant to be used with the GNSS data structures objects found in "DataStructures" class.

A typical way to use this class follows:

   RinexObsStream rin("ebre0300.02o");

   gnssRinex gRin;
   ComputePI getPI;

   while(rin >> gRin)
   {
      gRin >> getPI;
   }

The "ComputePI" object will visit every satellite in the GNSS data structure that is "gRin" and will try to compute its PI combination.

When used with the ">>" operator, this class returns the same incoming data structure with the PI inserted along their corresponding satellites. Be warned that if a given satellite does not have the observations required, it will be summarily deleted from the data structure.

Sometimes, the Rinex observations file does not have P1, but provides C1 instead. In such cases, you must use the useC1() method.

All observations are in meters.

See also:

ComputeLinear.hpp and LinearCombinations.hpp for a different approach to the same task.

Definition at line 81 of file ComputePI.hpp.

Public Member Functions
	ComputePI ()
	Default constructor.
virtual satTypeValueMap &	Process (satTypeValueMap &gData) throw (ProcessingException)
	Returns a satTypeValueMap object, adding the new data generated when calling this object.
virtual ComputePI &	useC1 (void)
	Some Rinex data files provide C1 instead of P1.
virtual int	getIndex (void) const
	Returns an index identifying this object.
virtual std::string	getClassName (void) const
	Returns a string identifying this object.
virtual	~ComputePI ()
	Destructor.
Protected Member Functions
virtual double	getCombination (const double &obs1, const double &obs2)
	Compute the combination of observables.

---

Constructor & Destructor Documentation

ComputePI (   )

Default constructor. Definition at line 52 of file ComputePI.cpp.

virtual ~ComputePI (   )  [inline, virtual]

Destructor. Definition at line 115 of file ComputePI.hpp.

---

Member Function Documentation

std::string getClassName (  void   )  const [virtual]

Returns a string identifying this object. Reimplemented from ComputeCombination. Definition at line 47 of file ComputePI.cpp.

virtual double getCombination (  const double &  obs1, const double &  obs2 )  [inline, protected, virtual]

Compute the combination of observables. Implements ComputeCombination. Definition at line 122 of file ComputePI.hpp.

int getIndex (  void   )  const [virtual]

Returns an index identifying this object. Reimplemented from ComputeCombination. Definition at line 42 of file ComputePI.cpp.

virtual satTypeValueMap& Process (  satTypeValueMap &  gData  )  throw (ProcessingException) [inline, virtual]

Returns a satTypeValueMap object, adding the new data generated when calling this object. Parameters: gData  Data object holding the data. Reimplemented from ComputeCombination. Definition at line 95 of file ComputePI.hpp.

virtual ComputePI& useC1 (  void   )  [inline, virtual]

Some Rinex data files provide C1 instead of P1. Use this method in those cases. Definition at line 102 of file ComputePI.hpp.

---

The documentation for this class was generated from the following files:

• ComputePI.hpp
• ComputePI.cpp

---