Variable Class Reference
[GPSTk data structures]

#include <Variable.hpp>

Collaboration diagram for Variable:

[legend]List of all members.

---

Detailed Description

Class to define and handle 'descriptions' of GNSS variables.

Definition at line 48 of file Variable.hpp.

Public Member Functions
	Variable ()
	Default constructor for Variable.
	Variable (const TypeID &type, StochasticModel *pModel=&Variable::defaultModel, bool sourceIndexed=true, bool satIndexed=false, double variance=4.0e14, double coef=1.0, bool forceCoef=false)
	Common constructor for Variable.
TypeID	getType () const
	Get variable type.
Variable &	setType (const TypeID &type)
	Set variable type.
StochasticModel *	getModel () const
	Get variable model pointer.
Variable &	setModel (StochasticModel *pModel)
	Set variable model.
bool	getSourceIndexed () const
	Get if this variable is SourceID-indexed.
Variable &	setSourceIndexed (bool sourceIndexed)
	Set if this variable is SourceID-indexed.
bool	getSatIndexed () const
	Get if this variable is SatID-indexed.
Variable &	setSatIndexed (bool satIndexed)
	Set if this variable is SatID-indexed.
bool	getTypeIndexed () const
	Get if this variable is Type-indexed.
Variable &	setTypeIndexed (bool typeIndexed)
	Set if this variable is Type-indexed.
double	getInitialVariance () const
	Get value of initial variance assigned to this variable.
Variable &	setInitialVariance (double variance)
	Set value of initial variance assigned to this variable.
double	getDefaultCoefficient () const
	Get value of default coefficient assigned to this variable.
Variable &	setDefaultCoefficient (double coef)
	Set value of default coefficient assigned to this variable.
bool	isDefaultForced () const
	Ask if default coefficient will always be used.
Variable &	setDefaultForced (bool forceCoef)
	Set if default coefficient will always be used.
SourceID	getSource () const
	Get internal source this variable is assigned to (if any).
Variable &	setSource (const SourceID &source)
	Set internal source this variable is assigned to.
SatID	getSatellite () const
	Get internal satellite this variable is assigned to (if any).
Variable &	setSatellite (const SatID &satellite)
	Set internal satellite this variable is assigned to.
virtual bool	operator== (const Variable &right) const
	Equality operator.
virtual bool	operator< (const Variable &right) const
	This ordering is somewhat arbitrary, but is required to be able to use a Variable as an index to a std::map, or as part of a std::set.
bool	operator!= (const Variable &right) const
	Inequality operator.
virtual Variable &	operator= (const Variable &right)
	Assignment operator.
virtual	~Variable ()
	Destructor.
Static Public Attributes
SourceID	allSources
	SourceID object representing all sources : type(Unknown), sourceName("").
SourceID	someSources
	SourceID object representing "some" sources : type(Mixed), sourceName("").
SatID	noSats
	SatID object representing no satellites: system(systemUnknown), id(-1).
SatID	allSats
	SatID object representing all satellites: system(systemMixed), id(-1).
SatID	allGPSSats
	SatID object representing all satellites of GPS System: system(systemGPS), id(-1).
SatID	allGalileoSats
	SatID object representing all satellites of Galileo System: system(systemGalileo), id(-1).
SatID	allGlonassSats
	SatID object representing all satellites of Glonass System: system(systemGlonass), id(-1).
WhiteNoiseModel	defaultModel
	Default stochastic model to be assigned to variables.

---

Constructor & Destructor Documentation

Variable (   )

Default constructor for Variable. Definition at line 79 of file Variable.cpp.

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

Common constructor for Variable. By default, it is indexed by SourceID. 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. forceCoef  Always use default coefficient. Definition at line 106 of file Variable.cpp.

virtual ~Variable (   )  [inline, virtual]

Destructor. Definition at line 275 of file Variable.hpp.

---

Member Function Documentation

double getDefaultCoefficient (   )  const [inline]

Get value of default coefficient assigned to this variable. Definition at line 164 of file Variable.hpp. Referenced by Variable::operator<(), Variable::operator=(), and Variable::operator==().

double getInitialVariance (   )  const [inline]

Get value of initial variance assigned to this variable. Definition at line 151 of file Variable.hpp. Referenced by Variable::operator<(), Variable::operator=(), and Variable::operator==().

StochasticModel* getModel (   )  const [inline]

Get variable model pointer. Definition at line 94 of file Variable.hpp. Referenced by Variable::operator<(), Variable::operator=(), and Variable::operator==().

SatID getSatellite (   )  const [inline]

Get internal satellite this variable is assigned to (if any). Definition at line 204 of file Variable.hpp. Referenced by gpstk::StringUtils::asString(), Variable::operator<(), Variable::operator=(), and Variable::operator==().

bool getSatIndexed (   )  const [inline]

Get if this variable is SatID-indexed. Definition at line 123 of file Variable.hpp. Referenced by gpstk::StringUtils::asString(), Variable::operator<(), Variable::operator=(), and Variable::operator==().

SourceID getSource (   )  const [inline]

Get internal source this variable is assigned to (if any). Definition at line 190 of file Variable.hpp. Referenced by gpstk::StringUtils::asString(), Variable::operator<(), Variable::operator=(), and Variable::operator==().

bool getSourceIndexed (   )  const [inline]

Get if this variable is SourceID-indexed. Definition at line 109 of file Variable.hpp. Referenced by gpstk::StringUtils::asString(), Variable::operator<(), Variable::operator=(), and Variable::operator==().

TypeID getType (   )  const [inline]

Get variable type. Definition at line 81 of file Variable.hpp. Referenced by gpstk::StringUtils::asString(), Variable::operator<(), Variable::operator=(), and Variable::operator==().

bool getTypeIndexed (   )  const [inline]

Get if this variable is Type-indexed. Definition at line 137 of file Variable.hpp. Referenced by gpstk::StringUtils::asString(), Variable::operator<(), Variable::operator=(), and Variable::operator==().

bool isDefaultForced (   )  const [inline]

Ask if default coefficient will always be used. Definition at line 177 of file Variable.hpp. Referenced by Variable::operator<(), Variable::operator=(), and Variable::operator==().

bool operator!= (  const Variable &  right  )  const [inline]

Inequality operator. Definition at line 227 of file Variable.hpp. References gpstk::operator==().

bool operator< (  const Variable &  right  )  const [virtual]

This ordering is somewhat arbitrary, but is required to be able to use a Variable as an index to a std::map, or as part of a std::set. Definition at line 204 of file Variable.cpp. References Variable::getDefaultCoefficient(), Variable::getInitialVariance(), Variable::getModel(), Variable::getSatellite(), Variable::getSatIndexed(), Variable::getSource(), Variable::getSourceIndexed(), Variable::getType(), Variable::getTypeIndexed(), and Variable::isDefaultForced().

Variable & operator= (  const Variable &  right  )  [virtual]

Assignment operator. Definition at line 294 of file Variable.cpp. References Variable::getDefaultCoefficient(), Variable::getInitialVariance(), Variable::getModel(), Variable::getSatellite(), Variable::getSatIndexed(), Variable::getSource(), Variable::getSourceIndexed(), Variable::getType(), Variable::getTypeIndexed(), Variable::isDefaultForced(), Variable::setDefaultCoefficient(), Variable::setDefaultForced(), Variable::setInitialVariance(), Variable::setModel(), Variable::setSatellite(), Variable::setSatIndexed(), Variable::setSource(), Variable::setSourceIndexed(), Variable::setType(), and Variable::setTypeIndexed().

bool operator== (  const Variable &  right  )  const [virtual]

Equality operator. Definition at line 182 of file Variable.cpp. References Variable::getDefaultCoefficient(), Variable::getInitialVariance(), Variable::getModel(), Variable::getSatellite(), Variable::getSatIndexed(), Variable::getSource(), Variable::getSourceIndexed(), Variable::getType(), Variable::getTypeIndexed(), and Variable::isDefaultForced().

Variable& setDefaultCoefficient (  double  coef  )  [inline]

Set value of default coefficient assigned to this variable. Parameters: coef  Default coefficient assigned to this variable. Definition at line 172 of file Variable.hpp. Referenced by Variable::operator=().

Variable& setDefaultForced (  bool  forceCoef  )  [inline]

Set if default coefficient will always be used. Parameters: forceCoef  Always use default coefficient. Definition at line 185 of file Variable.hpp. Referenced by Variable::operator=().

Variable& setInitialVariance (  double  variance  )  [inline]

Set value of initial variance assigned to this variable. Parameters: variance  Initial variance assigned to this variable. Definition at line 159 of file Variable.hpp. Referenced by Variable::operator=().

Variable& setModel (  StochasticModel *  pModel  )  [inline]

Set variable model. Parameters: pModel  Pointer to StochasticModel associated with this variable. By default, it is a white noise model. Definition at line 104 of file Variable.hpp. Referenced by Variable::operator=().

Variable& setSatellite (  const SatID &  satellite  )  [inline]

Set internal satellite this variable is assigned to. Parameters: satellite  Internal, specific SatID of variable. Definition at line 212 of file Variable.hpp. Referenced by Variable::operator=().

Variable& setSatIndexed (  bool  satIndexed  )  [inline]

Set if this variable is SatID-indexed. Parameters: satIndexed  Whether this variable is SatID-indexed or not. By default, it is NOT. Definition at line 132 of file Variable.hpp. Referenced by Variable::operator=().

Variable& setSource (  const SourceID &  source  )  [inline]

Set internal source this variable is assigned to. Parameters: source  Internal, specific SourceID of variable. Definition at line 198 of file Variable.hpp. Referenced by Variable::operator=().

Variable& setSourceIndexed (  bool  sourceIndexed  )  [inline]

Set if this variable is SourceID-indexed. Parameters: sourceIndexed  Whether this variable is SourceID-indexed or not. By default, it IS SourceID-indexed. Definition at line 118 of file Variable.hpp. Referenced by Variable::operator=().

Variable& setType (  const TypeID &  type  )  [inline]

Set variable type. Parameters: type  New TypeID of variable. Definition at line 89 of file Variable.hpp. Referenced by Equation::Equation(), and Variable::operator=().

Variable& setTypeIndexed (  bool  typeIndexed  )  [inline]

Set if this variable is Type-indexed. Parameters: typeIndexed  Whether this variable is Type-indexed or not. By default, it is. Definition at line 146 of file Variable.hpp. Referenced by Variable::operator=().

---

Member Data Documentation

SatID allGalileoSats [static]

SatID object representing all satellites of Galileo System: system(systemGalileo), id(-1).

SatID allGlonassSats [static]

SatID object representing all satellites of Glonass System: system(systemGlonass), id(-1).

SatID allGPSSats [static]

SatID object representing all satellites of GPS System: system(systemGPS), id(-1). Definition at line 60 of file Variable.cpp.

SatID allSats [static]

SatID object representing all satellites: system(systemMixed), id(-1).

SourceID allSources [static]

SourceID object representing all sources : type(Unknown), sourceName(""). Definition at line 40 of file Variable.cpp.

WhiteNoiseModel defaultModel [static]

Default stochastic model to be assigned to variables. Definition at line 74 of file Variable.cpp.

SatID noSats [static]

SatID object representing no satellites: system(systemUnknown), id(-1).

SourceID someSources [static]

SourceID object representing "some" sources : type(Mixed), sourceName("").

---

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

• Variable.hpp
• Variable.cpp

---