Environment.h

Go to the documentation of this file.

/* \todo Add name strings and outputting of "turned-on" disturbances
* \todo Add reference counter to ensure deletion when not used anymore.
* \todo Add CreateIterator() function
*/

#ifndef __ENVIRONMENT_H__
#define __ENVIRONMENT_H__

#include "Rotation.h"
#include "Integrator.h"
#include "Matrix.h"
#include "Time.h"
#include <set>
#include <vector>

using namespace std;

namespace O_SESSAME {
class CentralBody;


typedef vector<void*> EnvFuncParamaterType;
typedef Vector(*pt2EnvFunc)(const ssfTime &_currentTime, const OrbitState &_currentOrbitState, const AttitudeState &_currentAttitudeState, const EnvFuncParamaterType &_parameterList);

class EnvFunction
{
public:
    EnvFunction(pt2EnvFunc _EnvFuncPtr);

    EnvFunction(pt2EnvFunc _EnvFuncPtr, const int & _numParameters);

    Vector Evaluate(const ssfTime &_currentTime, const OrbitState &_currentOrbitState, const AttitudeState &_currentAttitudeState);

    void AddParameter(void* _parameter, int _paramNumber = -1);
    
    void RemoveParameter(int _paramNumber = -1);

    void ChangeParameter(void* _parameter, int _paramNumber = -1);
private:
    pt2EnvFunc m_EnvFuncPtr;
    int m_NumParameters;
    EnvFuncParamaterType m_EnvFuncParameters;

};




class Environment
{
public:
    Environment();

    virtual ~Environment();

    Vector GetTorques(const ssfTime& _currentTime, const OrbitState& _currentOrbitState, const AttitudeState& _currentAttitudeState);

    Vector GetForces(const ssfTime& _currentTime, const OrbitState& _currentOrbitState, const AttitudeState& _currentAttitudeState);

    void AddForceFunction(const EnvFunction &_forceFunc);

    void AddTorqueFunction(const EnvFunction &_torqueFunc);

    const Functor& GetForceFunction() const;

    const Functor& GetTorqueFunction() const;
    
    void SetCentralBody(CentralBody *_pCB);

    const CentralBody* GetCentralBody() const;
    
private:
    vector<EnvFunction> m_ForceFunctions;
    vector<EnvFunction> m_TorqueFunctions;
    vector<EnvFunction>::iterator m_funcIterator;
    CentralBody *m_pCB;
    
    Vector m_CalculatedForces;
    Vector m_CalculatedTorques;
    ObjectFunctor<Environment> m_ForcesFunctor;
    ObjectFunctor<Environment> m_TorquesFunctor;


};
} // close namespace O_SESSAME
#endif
// Do not change the comments below - they will be added automatically by CVS
/*****************************************************************************
*       $Log: Environment.h,v $
*       Revision 1.12  2003/06/12 18:06:35  nilspace
*       .
*       
*       Revision 1.11  2003/06/10 14:48:03  nilspace
*       Changed include CentralBody.h to look in CentralBody directory.
*       
*       Revision 1.10  2003/06/06 17:35:52  nilspace
*       Moved to CentralBody directory.
*       
*       Revision 1.9  2003/05/22 21:04:16  nilspace
*       Updated comments.
*       
*       Revision 1.8  2003/05/22 03:42:32  nilspace
*       Moved documentation to the implementation file.
*       
*       Revision 1.7  2003/05/20 17:51:12  nilspace
*       Updated comments.
*       
*       Revision 1.6  2003/05/13 18:59:16  nilspace
*       Fixed some comments.
*       
*       Revision 1.5  2003/05/05 20:45:46  nilspace
*       Changed the pass-by-address parameters to pass-by-reference.
*       
*       Revision 1.4  2003/05/02 16:16:28  nilspace
*       Documented the API.
*       
*       Revision 1.3  2003/05/02 02:16:29  nilspace
*       Documented the API.
*       Added a GetTorquesFunction().
*       
*       Revision 1.2  2003/04/27 22:04:33  nilspace
*       Created the namespace O_SESSAME.
*       
*       Revision 1.1  2003/04/08 22:37:22  nilspace
*       Initial Submission.
*       
*
******************************************************************************/

---