Pruner Class Reference
[GPSTk data structures]

#include <Pruner.hpp>

Inheritance diagram for Pruner:

[legend]Collaboration diagram for Pruner:

[legend]List of all members.

---

Detailed Description

This class examines a GNSS Data Structure (GDS) and prunes 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;

   Pruner prunerObj;
   prunerObj.setType( TypeID::C1 );
   prunerObj.addType( TypeID::L1 );

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

The "Pruner" object "prunerObj" will visit every satellite in the GNSS Data Structure that is "gRin" and will delete 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 Pruner.hpp.

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

---

Constructor & Destructor Documentation

Pruner (   )  [inline]

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

Pruner (  const TypeIDSet &  deleteSet  )  [inline]

Common constructor. Parameters: deleteSet  TypeIDSet of data values to be deleted. Definition at line 87 of file Pruner.hpp.

virtual ~Pruner (   )  [inline, virtual]

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

---

Member Function Documentation

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

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

Pruner & addTypeSet (  const TypeIDSet &  deletepSet  )  [virtual]

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

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

Method to clear the set of TypeIDs to be deleted. 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 Pruner.hpp.

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

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

int getIndex (  void   )  const [virtual]

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

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

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

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

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

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

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

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

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

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

Method to set the TypeID to be deleted. Parameters: type  TypeID of data values to be deleted. 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 Pruner.hpp.

virtual Pruner& setTypeSet (  const TypeIDSet &  deleteSet  )  [inline, virtual]

Method to specify a set of TypeIDs to be deleted. Parameters: deleteSet  TypeIDSet of data values to be deleted. 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 Pruner.hpp.

---

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

• Pruner.hpp
• Pruner.cpp

---