Orbit.h

Go to the documentation of this file.

/* 
*
*/

#ifndef __SSF_ORBIT_H__
#define __SSF_ORBIT_H__

#include "Functor.h"
#include "Environment.h"
#include "Propagator.h"
#include "OrbitState.h"
#include "OrbitHistory.h"


namespace O_SESSAME {
class Propagator; // forward declaration

typedef void (*IntegratedOrbitStateConversionFunction)(const Matrix &_meshPoint, OrbitState &_convertedOrbitState);



class Orbit
{
public:
    Orbit();
    virtual ~Orbit();
    
public:
    void SetStateObject(const OrbitState& _currentOrbitPosition);
    
    OrbitState GetStateObject() const;
  
protected:
    OrbitState m_CurrentOrbitPosition;
    
    
// ***************************** 
// ******** PROPAGATION ******** 
// ***************************** 
public:
    void SetDynamicsEq(odeFunctor _orbitDynamicsEq);

    odeFunctor GetDynamicsEq();

    void SetStateConversion(IntegratedOrbitStateConversionFunction _ConversionFunction);

    IntegratedOrbitStateConversionFunction GetStateConversion() const;

    void SetPropagator(Propagator *_pPropagator);
    
    Propagator* GetPropagator();
    
    void Propagate(const Vector &_propTime);
        
    bool IsIntegrateable();
        
private:
    Propagator *m_pPropagator;
    
    IntegratedOrbitStateConversionFunction m_OrbitStateConversionFunction;
    
    odeFunctor m_OrbitDynamicsEq;

    bool m_Integrateable;
    
// ***************************** 
// ********* Physical ********** 
// ***************************** 
public:
    void SetParameters(const Matrix &_Parameters);
    
    Matrix GetParameters() const;
    
private:
    Matrix m_Parameters;

// ***************************** 
// ******** ENVIRONMENT ********
// *****************************  
public:
    void SetEnvironment(Environment *_pEnvironment);    
    
    Environment* GetEnvironment();
        
    
    void SetControlForces(const Vector &_controlForces);
    Vector GetControlForces();
    
    ObjectFunctor<Environment> GetEnvironmentForcesFunctor();
private:
    Environment *m_pEnvironment;
    Vector m_ControlForces;
    
    ObjectFunctor<Environment> m_EnvironmentForcesFunctor;
    
// *************************
// ******** HISTORY ******** 
// ************************* 
public:
    OrbitHistory& GetHistoryObject();
    
private:
    OrbitHistory m_OrbitHistory;

}; // End of OrbitToolkit Group

} // close namespace O_SESSAME
#endif

// Do not change the comments below - they will be added automatically by CVS
/*****************************************************************************
*       $Log: Orbit.h,v $
*       Revision 1.9  2003/06/10 14:52:05  nilspace
*       Changed GetHistory to GetHistoryObject
*       
*       Revision 1.8  2003/05/20 17:47:59  nilspace
*       Updated comments.
*       
*       Revision 1.7  2003/05/02 16:16:46  nilspace
*       Documented the API.
*       
*       Revision 1.6  2003/04/28 20:13:18  nilspace
*       GetHistory return by reference.
*       
*       Revision 1.5  2003/04/27 22:04:33  nilspace
*       Created the namespace O_SESSAME.
*       
*       Revision 1.4  2003/04/27 21:17:42  nilspace
*       Finished moving function declarations out of the class interface.
*       
*       Revision 1.3  2003/04/27 21:14:01  nilspace
*       Added to the namespace O_SESSAME.
*       Moved function definitions outside of the class interface definition.
*       
*       Revision 1.2  2003/04/25 13:36:28  nilspace
*       Updated to work with current History, Environment & Propagator objects.
*       
*       Revision 1.1  2003/04/08 22:48:59  nilspace
*       Initial Submission.
*
******************************************************************************/

---