ComputeWindUp Class Reference
[GPSTk data structures]

#include <ComputeWindUp.hpp>

Inheritance diagram for ComputeWindUp:

[legend]Collaboration diagram for ComputeWindUp:

[legend]List of all members.

---

Detailed Description

This class computes the wind-up effect on the phase observables, in radians.

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:

      // Create the input obs file stream
   RinexObsStream rin("ebre0300.02o");

      // Loads precise ephemeris object with file data
   SP3EphemerisStore SP3EphList;
   SP3EphList.loadFile("igs11513.sp3");

      // Sets nominal position of receiver
   Position nominalPos(4833520.3800, 41536.8300, 4147461.2800);

   gnssRinex gRin;

   ComputeWindUp windup( SP3EphList,
                         nominalPos );

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

The "ComputeWindUp" object will visit every satellite in the GNSS data structure that is "gRin" and will compute the corresponding receiver-satellite wind-up effect, in radians.

When used with the ">>" operator, this class returns the same incoming data structure with the wind-up inserted in it. Be warned that if a given satellite does not have the observations required, it will be summarily deleted from the data structure.

Warning:

ComputeWindUp objects store their internal state, so you MUST NOT use the SAME object to process DIFFERENT data streams.

It is recommended that ComputeWindUp objects are used after calling a SatArcMarker object, because they work better when cycle slips are properly tracked.

Definition at line 100 of file ComputeWindUp.hpp.

Public Member Functions
	ComputeWindUp ()
	Default constructor.
	ComputeWindUp (XvtStore< SatID > &ephem, const Position &stapos, string filename="PRN_GPS")
	Common constructor.
virtual satTypeValueMap &	Process (const DayTime &time, satTypeValueMap &gData) throw (ProcessingException)
	Returns a satTypeValueMap object, adding the new data generated when calling this object.
virtual gnssSatTypeValue &	Process (gnssSatTypeValue &gData) throw (ProcessingException)
	Returns a gnnsSatTypeValue object, adding the new data generated when calling this object.
virtual gnssRinex &	Process (gnssRinex &gData) throw (ProcessingException)
	Returns a gnnsRinex object, adding the new data generated when calling this object.
virtual string	getFilename (void) const
	Returns name of "PRN_GPS"-like file containing satellite data.
virtual ComputeWindUp &	setFilename (const string &name)
	Sets name of "PRN_GPS"-like file containing satellite data.
virtual Position	getNominalPosition (void) const
	Returns nominal position of receiver station.
virtual ComputeWindUp &	setNominalPosition (const Position &stapos)
	Sets nominal position of receiver station.
virtual XvtStore< SatID > *	getEphemeris (void) const
	Returns a pointer to the satellite ephemeris object currently in use.
virtual ComputeWindUp &	setEphemeris (XvtStore< SatID > &ephem)
	Sets satellite ephemeris object to be used.
virtual int	getIndex (void) const
	Returns an index identifying this object.
virtual std::string	getClassName (void) const
	Returns a string identifying this object.
virtual	~ComputeWindUp ()
	Destructor.

---

Constructor & Destructor Documentation

ComputeWindUp (   )  [inline]

Default constructor. Definition at line 105 of file ComputeWindUp.hpp.

ComputeWindUp (  XvtStore< SatID > &  ephem, const Position &  stapos, string  filename = "PRN_GPS" )  [inline]

Common constructor. Parameters: ephem  Satellite ephemeris. stapos  Nominal position of receiver station. filename  Name of "PRN_GPS"-like file containing satellite data. Warning: If filename is not given, this class will look for a file named "PRN_GPS" in the current directory. Definition at line 121 of file ComputeWindUp.hpp.

virtual ~ComputeWindUp (   )  [inline, virtual]

Destructor. Definition at line 205 of file ComputeWindUp.hpp.

---

Member Function Documentation

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

Returns a string identifying this object. Implements ProcessingClass. Definition at line 47 of file ComputeWindUp.cpp.

virtual XvtStore<SatID>* getEphemeris (  void   )  const [inline, virtual]

Returns a pointer to the satellite ephemeris object currently in use. Definition at line 185 of file ComputeWindUp.hpp.

virtual string getFilename (  void   )  const [inline, virtual]

Returns name of "PRN_GPS"-like file containing satellite data. Definition at line 161 of file ComputeWindUp.hpp.

int getIndex (  void   )  const [virtual]

Returns an index identifying this object. Implements ProcessingClass. Definition at line 42 of file ComputeWindUp.cpp.

virtual Position getNominalPosition (  void   )  const [inline, virtual]

Returns nominal position of receiver station. Definition at line 172 of file ComputeWindUp.hpp.

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

Returns a gnnsRinex object, adding the new data generated when calling this object. Parameters: gData  Data object holding the data. Implements ProcessingClass. Definition at line 155 of file ComputeWindUp.hpp.

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

Returns a gnnsSatTypeValue object, adding the new data generated when calling this object. Parameters: gData  Data object holding the data. Implements ProcessingClass. Definition at line 145 of file ComputeWindUp.hpp.

satTypeValueMap & Process (  const DayTime &  time, satTypeValueMap &  gData )  throw (ProcessingException) [virtual]

Returns a satTypeValueMap object, adding the new data generated when calling this object. Parameters: time  Epoch corresponding to the data. gData  Data object holding the data. Definition at line 58 of file ComputeWindUp.cpp. References SunPosition::getPosition(), GPSTK_THROW, gpstk::SatIDSet, and Triple::theArray.

virtual ComputeWindUp& setEphemeris (  XvtStore< SatID > &  ephem  )  [inline, virtual]

Sets satellite ephemeris object to be used. Parameters: ephem  Satellite ephemeris object. Definition at line 192 of file ComputeWindUp.hpp.

ComputeWindUp & setFilename (  const string &  name  )  [virtual]

Sets name of "PRN_GPS"-like file containing satellite data. Parameters: name  Name of satellite data file. Definition at line 192 of file ComputeWindUp.cpp. References SatDataReader::open().

virtual ComputeWindUp& setNominalPosition (  const Position &  stapos  )  [inline, virtual]

Sets nominal position of receiver station. Parameters: stapos  Nominal position of receiver station. Definition at line 179 of file ComputeWindUp.hpp.

---

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

• ComputeWindUp.hpp
• ComputeWindUp.cpp

---