RequireObservables Class Reference
[GPSTk data structures]

#include <RequireObservables.hpp>

Inheritance diagram for RequireObservables:

[legend]Collaboration diagram for RequireObservables:

[legend]List of all members.

---

Detailed Description

This class filters out satellites that don't have the required observations.

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;

   TypeIDSet requiredSet;
   requiredSet.insert(TypeID::P1);
   requiredSet.insert(TypeID::P2);

   RequireObservables requireTypes(requiredSet);

   while(rin >> gRin)
   {
         // Satellites without P1 and P2 observations will be deleted
      gRin >> requireTypes;
   }

The "RequireObservables" object will visit every satellite in the GNSS data structure that is "gRin" and will check that the previously given list of observation types is meet by each satellite.

Be warned that if a given satellite does not have ALL the observations required, the full satellite record will be summarily deleted from the data structure.

Definition at line 80 of file RequireObservables.hpp.

Public Member Functions
	RequireObservables ()
	Default constructor.
	RequireObservables (const TypeID &type)
	Explicit constructor.
	RequireObservables (const TypeIDSet &typeSet)
	Explicit constructor.
virtual satTypeValueMap &	Process (satTypeValueMap &gData) throw (ProcessingException)
	Returns a satTypeValueMap object, checking the required observables.
virtual RequireObservables &	addRequiredType (const TypeID &type)
	Method to add a TypeID to be required.
virtual RequireObservables &	addRequiredType (TypeIDSet &typeSet)
	Method to add a set of TypeID's to be required.
virtual RequireObservables &	setRequiredType (const TypeID &type)
	Method to set a TypeID to be required.
virtual RequireObservables &	setRequiredType (const TypeIDSet &typeSet)
	Method to set the TypeID's to be required.
virtual TypeIDSet	getRequiredType () const
	Method to get the set of TypeID's to be required.
virtual gnssSatTypeValue &	Process (gnssSatTypeValue &gData) throw (ProcessingException)
	Returns a gnnsSatTypeValue object, checking the required observables.
virtual gnssRinex &	Process (gnssRinex &gData) throw (ProcessingException)
	Returns a gnnsRinex object, checking the required observables.
virtual std::string	getClassName (void) const
	Returns a string identifying this object.
virtual	~RequireObservables ()
	Destructor.

---

Constructor & Destructor Documentation

RequireObservables (   )  [inline]

Default constructor. Definition at line 85 of file RequireObservables.hpp.

RequireObservables (  const TypeID &  type  )  [inline]

Explicit constructor. Parameters: type  TypeID to be required. Definition at line 93 of file RequireObservables.hpp.

RequireObservables (  const TypeIDSet &  typeSet  )  [inline]

Explicit constructor. Parameters: typeSet  Set of TypeID's to be required. Definition at line 101 of file RequireObservables.hpp.

virtual ~RequireObservables (   )  [inline, virtual]

Destructor. Definition at line 178 of file RequireObservables.hpp.

---

Member Function Documentation

RequireObservables & addRequiredType (  TypeIDSet &  typeSet  )  [virtual]

Method to add a set of TypeID's to be required. Parameters: typeSet  Set of TypeID's to be required. Definition at line 47 of file RequireObservables.cpp.

virtual RequireObservables& addRequiredType (  const TypeID &  type  )  [inline, virtual]

Method to add a TypeID to be required. Parameters: type  Extra TypeID to be required. Definition at line 119 of file RequireObservables.hpp.

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

Returns a string identifying this object. Implements ProcessingClass. Definition at line 38 of file RequireObservables.cpp.

virtual TypeIDSet getRequiredType (   )  const [inline, virtual]

Method to get the set of TypeID's to be required. Definition at line 149 of file RequireObservables.hpp. References gpstk::TypeIDSet.

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

Returns a gnnsRinex object, checking the required observables. Parameters: gData  Data object holding the data. Implements ProcessingClass. Definition at line 168 of file RequireObservables.hpp.

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

Returns a gnnsSatTypeValue object, checking the required observables. Parameters: gData  Data object holding the data. Implements ProcessingClass. Definition at line 158 of file RequireObservables.hpp.

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

Returns a satTypeValueMap object, checking the required observables. Parameters: gData  Data object holding the data. Definition at line 63 of file RequireObservables.cpp. References GPSTK_THROW, and gpstk::SatIDSet.

virtual RequireObservables& setRequiredType (  const TypeIDSet &  typeSet  )  [inline, virtual]

Method to set the TypeID's to be required. This method will erase previous types. Parameters: typeSet  Set of TypeID's to be required. Definition at line 144 of file RequireObservables.hpp.

virtual RequireObservables& setRequiredType (  const TypeID &  type  )  [inline, virtual]

Method to set a TypeID to be required. This method will erase previous required types. Parameters: type  TypeID to be required. Definition at line 135 of file RequireObservables.hpp.

---

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

• RequireObservables.hpp
• RequireObservables.cpp

---