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

Equation Struct Reference
[GPSTk data structures]

#include <Equation.hpp>

Inheritance diagram for Equation:

Inheritance graph
[legend]
Collaboration diagram for Equation:

Collaboration graph
[legend]
List of all members.

Detailed Description

GNSS Data Structure to define and handle 'descriptions' of GNSS equations.

Definition at line 136 of file Equation.hpp.

Public Member Functions

 Equation ()
 Default constructor.
 Equation (const equationHeader &head)
 Common constructor.
 Equation (const Variable &indep)
 Common constructor.
 Equation (const TypeID &type)
 Common constructor.
 Equation (const gnssEquationDefinition &gnssEq)
 Common constructor.
virtual Variable getIndependentTerm () const
 Return the independent term of this equation.
virtual Equation & setIndependentTerm (const Variable &var)
 Set the independent term of this Equation.
virtual double getWeight () const
 Get the value of the constant weight associated to this equation.
virtual Equation & setWeight (const double &cweight)
 Set the value of the constant weight associated to this equation.
virtual Equation & addVariable (const Variable &var)
 Add a variable (unknown) to this Equation.
virtual Equation & addVariable (const TypeID &type, StochasticModel *pModel=&Variable::defaultModel, bool sourceIndexed=true, bool satIndexed=false, double variance=4.0e14, double coef=1.0)
 Add a variable (unknown) to this Equation.
virtual Equation & removeVariable (const Variable &var)
 Remove a variable (unknown) from this Equation.
virtual Equation & clear ()
 Remove ALL variables (unknowns) from this Equation.
SourceID getEquationSource () const
 Get equation SourceID.
SatID getEquationSat () const
 Get equation SatID.
std::set< SourceID > getSourceSet () const
 Get SourceID set.
std::set< SatID > getSatSet () const
 Get SatID set.
Equation & addSource2Set (const SourceID &source)
 Add a source to SourceID set.
Equation & addSat2Set (const SatID &sat)
 Add a sat to SatID set.
Equation & clearSourceSet ()
 Clear SourceID set.
Equation & clearSatSet ()
 Clear SatID set.
virtual bool operator< (const Equation &right) const
 This ordering is somewhat arbitrary, but is required to be able to use an Equation as an index to a std::map, or as part of a std::set.
virtual ~Equation ()
 Destructor.

Constructor & Destructor Documentation

Equation (   ) 
 

Default constructor.

Definition at line 61 of file Equation.cpp.

References equationHeader::constWeight, equationHeader::equationSat, and equationHeader::equationSource.

Equation (  const equationHeader &  head  )  [inline]
 

Common constructor.

It defines an Equation from its header. You must later use other methods to input the variables.

Parameters:
head Data structure describing the Equation header.

Definition at line 148 of file Equation.hpp.

Equation (  const Variable &  indep  ) 
 

Common constructor.

It defines an Equation from its independent term. You must later use other methods to input the variables.

Parameters:
indep Variable object describing the independent term.

Definition at line 77 of file Equation.cpp.

References equationHeader::constWeight, equationHeader::equationSat, equationHeader::equationSource, and equationHeader::indTerm.

Equation (  const TypeID &  type  ) 
 

Common constructor.

It defines an Equation from its independent term. You must later use other methods to input the variables.

Parameters:
var TypeID object describing the independent term.

Definition at line 94 of file Equation.cpp.

References equationHeader::constWeight, equationHeader::equationSat, equationHeader::equationSource, equationHeader::indTerm, and Variable::setType().

Equation (  const gnssEquationDefinition &  gnssEq  ) 
 

Common constructor.

It takes a simple gnssEquationDefinition object and creates a more complex Equation object.

Parameters:
gnssEq gnssEquationDefinition object.
A gnssEquationDefinition object defines equations as a simple list of TypeID's: The independent term (usually the prefit residual) type in the header, and the variables' types in the body (or 'unknowns').

The resulting Equation object will honor this simple structure, assigning white noise models to all variables, as well as declaring them source-specific and satellite-independent (or 'UN-specific').

The former is suitable for simple GNSS data processing strategies like the SPS C1-based positioning, where the variables are TypeID::dx, TypeID::dy, TypeID::dz and TypeID::cdt.

Definition at line 112 of file Equation.cpp.

References gnssData::body, equationHeader::constWeight, equationHeader::equationSat, equationHeader::equationSource, gnssData::header, equationHeader::indTerm, and Variable::setType().

virtual ~Equation (   )  [inline, virtual]
 

Destructor.

Definition at line 322 of file Equation.hpp.

Member Function Documentation

Equation& addSat2Set (  const SatID &  sat  )  [inline]
 

Add a sat to SatID set.

Definition at line 296 of file Equation.hpp.

Equation& addSource2Set (  const SourceID &  source  )  [inline]
 

Add a source to SourceID set.

This is only meaningful if "equationSource" in header is set to "Variable::someSources".

Definition at line 290 of file Equation.hpp.

Equation & addVariable (  const TypeID &  type,
StochasticModel *  pModel = &Variable::defaultModel,
bool  sourceIndexed = true,
bool  satIndexed = false,
double  variance = 4.0e14,
double  coef = 1.0
)  [virtual]
 

Add a variable (unknown) to this Equation.

Parameters:
type TypeID of variable.
pModel Pointer to StochasticModel associated with this variable. By default, it is a white noise model.
sourceIndexed Whether this variable is SourceID-indexed or not. By default, it IS SourceID-indexed.
satIndexed Whether this variable is SatID-indexed or not. By default, it is NOT.
variance Initial variance assigned to this variable.
coef Default coefficient assigned.

Definition at line 154 of file Equation.cpp.

References Equation::addVariable().

virtual Equation& addVariable (  const Variable &  var  )  [inline, virtual]
 

Add a variable (unknown) to this Equation.

Parameters:
var Variable object to be added to the unknowns.

Definition at line 220 of file Equation.hpp.

Referenced by Equation::addVariable(), and GeneralEquations::getPPPEquations().

virtual Equation& clear (  void   )  [inline, virtual]
 

Remove ALL variables (unknowns) from this Equation.

Warning:
This method does NOT clear the Equation's independent term. You MUST take care of it yourself (use method 'setIndependentTerm', for instance).

Definition at line 260 of file Equation.hpp.

Equation& clearSatSet (   )  [inline]
 

Clear SatID set.

This is only meaningful if "equationSource" in header is set to "Variable::someSources".

Definition at line 310 of file Equation.hpp.

Equation& clearSourceSet (   )  [inline]
 

Clear SourceID set.

This is only meaningful if "equationSource" in header is set to "Variable::someSources".

Definition at line 303 of file Equation.hpp.

SatID getEquationSat (   )  const [inline]
 

Get equation SatID.

Definition at line 269 of file Equation.hpp.

SourceID getEquationSource (   )  const [inline]
 

Get equation SourceID.

Definition at line 265 of file Equation.hpp.

virtual Variable getIndependentTerm (   )  const [inline, virtual]
 

Return the independent term of this equation.

Definition at line 191 of file Equation.hpp.

References equationHeader::indTerm.

std::set<SatID> getSatSet (   )  const [inline]
 

Get SatID set.

This is only meaningful if size of 'equationSatSet' is not zero

Definition at line 283 of file Equation.hpp.

std::set<SourceID> getSourceSet (   )  const [inline]
 

Get SourceID set.

This is only meaningful if "equationSource" in header is set to "Variable::someSources".

Definition at line 276 of file Equation.hpp.

virtual double getWeight (   )  const [inline, virtual]
 

Get the value of the constant weight associated to this equation.

Definition at line 204 of file Equation.hpp.

virtual bool operator< (  const Equation &  right  )  const [inline, virtual]
 

This ordering is somewhat arbitrary, but is required to be able to use an Equation as an index to a std::map, or as part of a std::set.

Definition at line 317 of file Equation.hpp.

References gnssData::header, and equationHeader::indTerm.

virtual Equation& removeVariable (  const Variable &  var  )  [inline, virtual]
 

Remove a variable (unknown) from this Equation.

Parameters:
var Variable object to be romoved from the unknowns.

Definition at line 250 of file Equation.hpp.

virtual Equation& setIndependentTerm (  const Variable &  var  )  [inline, virtual]
 

Set the independent term of this Equation.

Parameters:
var Variable object describing the independent term.

Definition at line 199 of file Equation.hpp.

virtual Equation& setWeight (  const double &  cweight  )  [inline, virtual]
 

Set the value of the constant weight associated to this equation.

Parameters:
cweight Value of constant weight.

Definition at line 212 of file Equation.hpp.

Referenced by GeneralEquations::getPPPEquations().

The documentation for this struct was generated from the following files:
Generated on Tue Jun 18 03:31:43 2013 for GPS ToolKit Software Library by  doxygen 1.3.9.1