Keeper Class Reference
[GPSTk data structures]

#include <Keeper.hpp>

Inheritance diagram for Keeper:

[legend]Collaboration diagram for Keeper:

[legend]List of all members.

---

Detailed Description

This class examines a GNSS Data Structure (GDS) and keeps only specific values according to their TypeIDs.

A typical way to use this class follows:

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

   gnssRinex gRin;

   Keeper keeperObj;
   keeperObj.setType( TypeID::C1 );
   keeperObj.addType( TypeID::L1 );

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

The "Keeper" object "keeperObj" will visit every satellite in the GNSS Data Structure that is "gRin" and will keep only the information associated with a configured TypeID set, trimming the incoming GDS.

Warning:

If no TypeIDs are specified, then ALL TypeIDs present in the GDS will be kept, and this class would have been ineffective.

Definition at line 74 of file Keeper.hpp.

Public Member Functions
	Keeper ()
	Default constructor.
	Keeper (const TypeIDSet &keepSet)
	Common constructor.
virtual satTypeValueMap &	Process (satTypeValueMap &gData) throw (ProcessingException)
	Keeps data from a satTypeValueMap object.
virtual gnssSatTypeValue &	Process (gnssSatTypeValue &gData) throw (ProcessingException)
	Keeps data from a gnnsSatTypeValue object.
virtual gnssRinex &	Process (gnssRinex &gData) throw (ProcessingException)
	Keeps data from a gnnsRinex object.
virtual Keeper &	setType (const TypeID &type)
	Method to set the TypeID to be kept.
virtual Keeper &	addType (const TypeID &type)
	Method to add a TypeID to be kept.
virtual Keeper &	setTypeSet (const TypeIDSet &keepSet)
	Method to establish a set of TypeIDs to be kept.
virtual Keeper &	addTypeSet (const TypeIDSet &keepSet)
	Method to add a set of TypeIDs to be kept.
virtual Keeper &	clearTypeSet (void)
	Method to clear the set of TypeIDs to be kept.
virtual TypeIDSet	getTypeSet (void) const
	Method to get the set of TypeIDs to be kept.
virtual int	getIndex (void) const
	Returns an index identifying this object.
virtual std::string	getClassName (void) const
	Returns a string identifying this object.
virtual	~Keeper ()
	Destructor.

---

Constructor & Destructor Documentation

Keeper (   )  [inline]

Default constructor. Definition at line 79 of file Keeper.hpp.

Keeper (  const TypeIDSet &  keepSet  )  [inline]

Common constructor. Parameters: keepSet  TypeIDSet of data values to be kept. Definition at line 87 of file Keeper.hpp.

virtual ~Keeper (   )  [inline, virtual]

Destructor. Definition at line 182 of file Keeper.hpp.

---

Member Function Documentation

virtual Keeper& addType (  const TypeID &  type  )  [inline, virtual]

Method to add a TypeID to be kept. Parameters: type  TypeID of data values to be added to the ones being kept. Definition at line 137 of file Keeper.hpp.

Keeper & addTypeSet (  const TypeIDSet &  keepSet  )  [virtual]

Method to add a set of TypeIDs to be kept. Parameters: keepSet  TypeIDSet of data values to be added to the ones being kept. Definition at line 93 of file Keeper.cpp.

virtual Keeper& clearTypeSet (  void   )  [inline, virtual]

Method to clear the set of TypeIDs to be kept. If you do this, all TypeIDs that are present in GDS will be kept, and this class would have been ineffective. Definition at line 164 of file Keeper.hpp.

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

Returns a string identifying this object. Implements ProcessingClass. Definition at line 48 of file Keeper.cpp.

int getIndex (  void   )  const [virtual]

Returns an index identifying this object. Implements ProcessingClass. Definition at line 43 of file Keeper.cpp.

virtual TypeIDSet getTypeSet (  void   )  const [inline, virtual]

Method to get the set of TypeIDs to be kept. Definition at line 169 of file Keeper.hpp. References gpstk::TypeIDSet.

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

Keeps data from a gnnsRinex object. Parameters: gData  Data object holding the data. Implements ProcessingClass. Definition at line 113 of file Keeper.hpp.

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

Keeps data from a gnnsSatTypeValue object. Parameters: gData  Data object holding the data. Implements ProcessingClass. Definition at line 104 of file Keeper.hpp.

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

Keeps data from a satTypeValueMap object. Parameters: gData  Data object holding the data. Definition at line 57 of file Keeper.cpp. References GPSTK_THROW.

virtual Keeper& setType (  const TypeID &  type  )  [inline, virtual]

Method to set the TypeID to be kept. Parameters: type  TypeID of data values to be kept. Warning: The previously set type values will be deleted. If this is not what you want, see method addType. If no TypeIDs are specified, then ALL TypeIDs present in the GDS will be kept, and this class would have been ineffective. Definition at line 128 of file Keeper.hpp.

virtual Keeper& setTypeSet (  const TypeIDSet &  keepSet  )  [inline, virtual]

Method to establish a set of TypeIDs to be kept. Parameters: keepSet  TypeIDSet of data values to be kept. Warning: The previously set type values will be deleted. If this is not what you want, see method addTypeSet. Definition at line 148 of file Keeper.hpp.

---

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

• Keeper.hpp
• Keeper.cpp

---