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

ComputeSatPCenter Class Reference
[GPSTk data structures]

#include <ComputeSatPCenter.hpp>

Inheritance diagram for ComputeSatPCenter:

Inheritance graph
[legend]
Collaboration diagram for ComputeSatPCenter:

Collaboration graph
[legend]
List of all members.

Detailed Description

This class computes the satellite antenna phase correction, in meters.

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;

   ComputeSatPCenter svPcenter( SP3EphList,
                                nominalPos );

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

The "ComputeSatPCenter" object will visit every satellite in the GNSS data structure that is "gRin" and will compute the corresponding satellite antenna phase correction, in meters.

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

Warning:
The ComputeSatPCenter objects generate corrections that are interpreted as an "advance" in the signal, instead of a delay. Therefore, those corrections always hava a negative sign.

Definition at line 100 of file ComputeSatPCenter.hpp.

Public Member Functions

 ComputeSatPCenter ()
 Default constructor.
 ComputeSatPCenter (XvtStore< SatID > &ephem, const Position &stapos, string filename="PRN_GPS")
 Common constructor.
 ComputeSatPCenter (const Position &stapos, string filename="PRN_GPS")
 Common constructor.
 ComputeSatPCenter (XvtStore< SatID > &ephem, const Position &stapos, AntexReader &antexObj)
 Common constructor.
 ComputeSatPCenter (const Position &stapos, AntexReader &antexObj)
 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 ComputeSatPCenter & 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 ComputeSatPCenter & 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 ComputeSatPCenter & setEphemeris (XvtStore< SatID > &ephem)
 Sets satellite ephemeris object to be used.
virtual AntexReader * getAntexReader (void) const
 Returns a pointer to the AntexReader object currently in use.
virtual ComputeSatPCenter & setAntexReader (AntexReader &antexObj)
 Sets AntexReader 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 ~ComputeSatPCenter ()
 Destructor.

Constructor & Destructor Documentation

ComputeSatPCenter (   )  [inline]
 

Default constructor.

Definition at line 105 of file ComputeSatPCenter.hpp.

ComputeSatPCenter (  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 ComputeSatPCenter.hpp.

ComputeSatPCenter (  const Position &  stapos,
string  filename = "PRN_GPS"
)  [inline]
 

Common constructor.

Parameters:
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 138 of file ComputeSatPCenter.hpp.

ComputeSatPCenter (  XvtStore< SatID > &  ephem,
const Position &  stapos,
AntexReader &  antexObj
)  [inline]
 

Common constructor.

Uses satellite antenna data from an Antex file.

Parameters:
ephem Satellite ephemeris.
stapos Nominal position of receiver station.
antexObj AntexReader object containing satellite antenna data.
Warning:
If 'AntexReader' object holds an Antex file with relative antenna data, a simple satellite phase center model will be used.

Definition at line 155 of file ComputeSatPCenter.hpp.

ComputeSatPCenter (  const Position &  stapos,
AntexReader &  antexObj
)  [inline]
 

Common constructor.

Uses satellite antenna data from an Antex file.

Parameters:
stapos Nominal position of receiver station.
antexObj AntexReader object containing satellite antenna data.
Warning:
If 'AntexReader' object holds an Antex file with relative antenna data, a simple satellite phase center model will be used.

Definition at line 171 of file ComputeSatPCenter.hpp.

virtual ~ComputeSatPCenter (   )  [inline, virtual]
 

Destructor.

Definition at line 268 of file ComputeSatPCenter.hpp.

Member Function Documentation

virtual AntexReader* getAntexReader (  void   )  const [inline, virtual]
 

Returns a pointer to the AntexReader object currently in use.

Definition at line 246 of file ComputeSatPCenter.hpp.

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

Returns a string identifying this object.

Implements ProcessingClass.

Definition at line 47 of file ComputeSatPCenter.cpp.

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

Returns a pointer to the satellite ephemeris object currently in use.

Definition at line 233 of file ComputeSatPCenter.hpp.

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

Returns name of "PRN_GPS"-like file containing satellite data.

Definition at line 209 of file ComputeSatPCenter.hpp.

int getIndex (  void   )  const [virtual]
 

Returns an index identifying this object.

Implements ProcessingClass.

Definition at line 42 of file ComputeSatPCenter.cpp.

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

Returns nominal position of receiver station.

Definition at line 220 of file ComputeSatPCenter.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 203 of file ComputeSatPCenter.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 193 of file ComputeSatPCenter.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 57 of file ComputeSatPCenter.cpp.

References SunPosition::getPosition(), GPSTK_THROW, gpstk::SatIDSet, and Triple::theArray.

virtual ComputeSatPCenter& setAntexReader (  AntexReader &  antexObj  )  [inline, virtual]
 

Sets AntexReader object to be used.

Parameters:
antexObj AntexReader object containing satellite antenna data.

Definition at line 255 of file ComputeSatPCenter.hpp.

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

Sets satellite ephemeris object to be used.

Parameters:
ephem Satellite ephemeris object.

Definition at line 241 of file ComputeSatPCenter.hpp.

ComputeSatPCenter & 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 166 of file ComputeSatPCenter.cpp.

References SatDataReader::open().

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

Sets nominal position of receiver station.

Parameters:
stapos Nominal position of receiver station.

Definition at line 227 of file ComputeSatPCenter.hpp.

The documentation for this class was generated from the following files:
Generated on Thu Feb 9 03:31:27 2012 for GPS ToolKit Software Library by  doxygen 1.3.9.1