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

SatArcMarker Class Reference
[GPS solution algorithms and Tropospheric]

#include <SatArcMarker.hpp>

Inheritance diagram for SatArcMarker:

Inheritance graph
[legend]
Collaboration diagram for SatArcMarker:

Collaboration graph
[legend]
List of all members.

Detailed Description

This class keeps track of satellite arcs caused by cycle slips.

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;
   LICSDetector markCSLI;
   SatArcMarker markArc;

   while(rin >> gRin)
   {
      gRin >> markCSLI >> markArc;
   }

The "SatArcMarker" object will visit every satellite in the GNSS data structure that is "gRin" and, if a cycle slip has happened (indicated by the corresponding CS flag), it will increase the value of the corresponding "TypeID::satArc" type.

By default, the "SatArcMarker" objects will only watch the "TypeID::CSL1" cycle slip flag. This may be changed, although it is rarely necessary because CS detectors raise all flags when a cycle slip happens.

An important feature of "SatArcMarker" objects is that you can set a period after arc change when the affected satellite will be considered "unstable". By default, unstable period is set to 31 s, but it may be changed using the appropriate constructor or using the "setUnstablePeriod()" method.

Likewise, SatArcMarker" objects are also able to delete unstable satellites from GDS. This feature is disabled by default, but may be activated using the appropriate constructor or using the "setDeleteUnstableSats()".

Warning:
Be aware that this class DOES NOT apply cycle slip detection algorithms, so you MUST invoke CS detection objects BEFORE calling SatArcMarker objects.

Objects in this class store their internal state, so you MUST NOT use the SAME object to process DIFFERENT data streams.

See also:
LICSDetector.hpp and MWCSDetector.hpp for CS detection classes.

Definition at line 97 of file SatArcMarker.hpp.

Public Member Functions

 SatArcMarker ()
 Default constructor. It will only watch "TypeID::CSL1" flag.
 SatArcMarker (const TypeID &watchFlag, const bool delUnstableSats, const double unstableTime)
 Common constructor.
virtual TypeID getCSFlag () const
 Method to get the default CS flag type being used.
virtual SatArcMarker & setCSFlag (const TypeID &watchFlag)
 Method to set the default CS flag type to be used.
virtual bool getDeleteUnstableSat () const
 Method to known if unstable satellites will be deleted.
virtual SatArcMarker & setDeleteUnstableSats (const bool delUnstableSats)
 Method to set if unstable satellites will be deleted.
virtual double getUnstablePeriod () const
 Method to get the number of seconds since last arc change that a satellite will be considered as unstable.
virtual SatArcMarker & setUnstablePeriod (const double unstableTime)
 Method to set the number of seconds since last arc change that a satellite will be considered as unstable.
virtual DayTime getArcChangedEpoch (const SatID &sat)
 Method to get the arc changed epoch.
virtual satTypeValueMap & Process (const DayTime &epoch, 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 int getIndex (void) const
 Returns an index identifying this object.
virtual std::string getClassName (void) const
 Returns a string identifying this object.
virtual ~SatArcMarker ()
 Destructor.

Constructor & Destructor Documentation

SatArcMarker (   )  [inline]
 

Default constructor. It will only watch "TypeID::CSL1" flag.

Definition at line 102 of file SatArcMarker.hpp.

SatArcMarker (  const TypeID &  watchFlag,
const bool  delUnstableSats,
const double  unstableTime
) 
 

Common constructor.

Parameters:
watchFlag Cycle slip flag to be watched.
delUnstableSats Whether unstable satellites will be deleted.
unstableTime Number of seconds since last arc change that a satellite will be considered as unstable.

Definition at line 61 of file SatArcMarker.cpp.

References SatArcMarker::setUnstablePeriod().

virtual ~SatArcMarker (   )  [inline, virtual]
 

Destructor.

Definition at line 206 of file SatArcMarker.hpp.

Member Function Documentation

DayTime getArcChangedEpoch (  const SatID &  sat  )  [virtual]
 

Method to get the arc changed epoch.

Parameters:
sat Interested SatID.

Definition at line 105 of file SatArcMarker.cpp.

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

Returns a string identifying this object.

Implements ProcessingClass.

Definition at line 48 of file SatArcMarker.cpp.

virtual TypeID getCSFlag (   )  const [inline, virtual]
 

Method to get the default CS flag type being used.

Definition at line 122 of file SatArcMarker.hpp.

virtual bool getDeleteUnstableSat (   )  const [inline, virtual]
 

Method to known if unstable satellites will be deleted.

Definition at line 135 of file SatArcMarker.hpp.

int getIndex (  void   )  const [virtual]
 

Returns an index identifying this object.

Implements ProcessingClass.

Definition at line 42 of file SatArcMarker.cpp.

virtual double getUnstablePeriod (   )  const [inline, virtual]
 

Method to get the number of seconds since last arc change that a satellite will be considered as unstable.

Definition at line 149 of file SatArcMarker.hpp.

gnssRinex & Process (  gnssRinex &  gData  )  throw (ProcessingException) [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 275 of file SatArcMarker.cpp.

References GPSTK_THROW.

gnssSatTypeValue & Process (  gnssSatTypeValue &  gData  )  throw (ProcessingException) [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 243 of file SatArcMarker.cpp.

References GPSTK_THROW.

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

Returns a satTypeValueMap object, adding the new data generated when calling this object.

Parameters:
epoch Time of observations.
gData Data object holding the data.

Definition at line 126 of file SatArcMarker.cpp.

References GPSTK_THROW, and gpstk::SatIDSet.

virtual SatArcMarker& setCSFlag (  const TypeID &  watchFlag  )  [inline, virtual]
 

Method to set the default CS flag type to be used.

Parameters:
watchFlag Cycle slip flag to be watched.

Definition at line 130 of file SatArcMarker.hpp.

virtual SatArcMarker& setDeleteUnstableSats (  const bool  delUnstableSats  )  [inline, virtual]
 

Method to set if unstable satellites will be deleted.

Parameters:
delUnstableSats Whether unstable satellites will be deleted.

Definition at line 143 of file SatArcMarker.hpp.

SatArcMarker & setUnstablePeriod (  const double  unstableTime  )  [virtual]
 

Method to set the number of seconds since last arc change that a satellite will be considered as unstable.

Parameters:
unstableTime Number of seconds since last arc change that a satellite will be considered as unstable.

Definition at line 83 of file SatArcMarker.cpp.

Referenced by SatArcMarker::SatArcMarker().

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