ForceModelList Class Reference
[GeoDynamics]

#include <ForceModelList.hpp>

Inheritance diagram for ForceModelList:

[legend]Collaboration diagram for ForceModelList:

[legend]List of all members.

---

Detailed Description

ForceModelList is a countainer for force models.

It allows the simulation to encapsulate a number of different force models and obtain their combined effect on a spacecraft.

Definition at line 49 of file ForceModelList.hpp.

Public Member Functions
	ForceModelList ()
	Default constructor.
virtual	~ForceModelList ()
	Default destructor.
void	clear ()
	Clear the force model list.
void	addForce (ForceModel *pForce)
	Adds a generic force to the list.
void	removeForce (ForceModel *pForce)
	Remove a generic force to the list.
virtual Vector< double >	getDerivatives (UTCTime utc, EarthBody &bref, Spacecraft &sc)
	interface implementation for the 'ForceModel'
void	setForceModelType (std::set< ForceModel::ForceModelType > fmt)
virtual std::string	modelName () const
	return the force model name
virtual int	forceIndex () const
	return the force model index
void	printForceModel (std::ostream &s)
	Show the exist force model.
Protected Attributes
list< ForceModel * >	forceList
	List of forces.
std::set< ForceModel::ForceModelType >	setFMT

---

Constructor & Destructor Documentation

ForceModelList (   )

Default constructor. Definition at line 37 of file ForceModelList.cpp. References ForceModelList::clear(), and ForceModelList::setFMT.

virtual ~ForceModelList (   )  [inline, virtual]

Default destructor. Definition at line 57 of file ForceModelList.hpp.

---

Member Function Documentation

void addForce (  ForceModel *  pForce  )  [inline]

Adds a generic force to the list. Parameters: f  Object which implements the ForceModel interface Definition at line 68 of file ForceModelList.hpp. Referenced by SatOrbit::createFMObjects().

void clear (   )  [inline]

Clear the force model list. Definition at line 61 of file ForceModelList.hpp. Referenced by SatOrbit::createFMObjects(), and ForceModelList::ForceModelList().

virtual int forceIndex (   )  const [inline, virtual]

return the force model index Reimplemented from ForceModel. Definition at line 92 of file ForceModelList.hpp.

Vector< double > getDerivatives (  UTCTime  utc, EarthBody &  bref, Spacecraft &  sc )  [virtual]

interface implementation for the 'ForceModel' Definition at line 46 of file ForceModelList.cpp. References ForceModel::a, ForceModel::da_dcd, ForceModel::da_dcr, ForceModel::da_dp, Matrix::end(), ForceModelList::forceList, ForceModel::getAMatrix(), Spacecraft::getTransitionMatrix(), GPSTK_THROW, Spacecraft::R(), Matrix::resize(), Vector::resize(), ForceModelList::setFMT, and Spacecraft::V(). Referenced by SatOrbit::getDerivatives().

virtual std::string modelName (   )  const [inline, virtual]

return the force model name Reimplemented from ForceModel. Definition at line 87 of file ForceModelList.hpp.

void printForceModel (  std::ostream &  s  )

Show the exist force model. Definition at line 177 of file ForceModelList.cpp. References Vector::end(), and ForceModelList::forceList.

void removeForce (  ForceModel *  pForce  )  [inline]

Remove a generic force to the list. Parameters: f  Object which implements the ForceModel interface Definition at line 76 of file ForceModelList.hpp.

void setForceModelType (  std::set< ForceModel::ForceModelType >  fmt  )

Definition at line 195 of file ForceModelList.cpp. References Vector::end(), and ForceModelList::setFMT.

---

Member Data Documentation

list<ForceModel*> forceList [protected]

List of forces. Definition at line 101 of file ForceModelList.hpp. Referenced by ForceModelList::getDerivatives(), and ForceModelList::printForceModel().

std::set<ForceModel::ForceModelType> setFMT [protected]

Definition at line 103 of file ForceModelList.hpp. Referenced by ForceModelList::ForceModelList(), ForceModelList::getDerivatives(), and ForceModelList::setForceModelType().

---

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

• ForceModelList.hpp
• ForceModelList.cpp

---