WsfSpaceOrbitalMissionContext.hpp

Go to the documentation of this file.

// ****************************************************************************
// CUI
//
// The Advanced Framework for Simulation, Integration, and Modeling (AFSIM)
//
// Copyright 2021 Infoscitex, a DCS Company. All rights reserved.
//
// The use, dissemination or disclosure of data in this file is subject to
// limitation or restriction. See accompanying README and LICENSE for details.
// ****************************************************************************
 
#ifndef WSFSPACEORBITALMISSIONCONTEXT_HPP
#define WSFSPACEORBITALMISSIONCONTEXT_HPP
 
#include <string>
 
class UtCalendar;
class UtOrbitalPropagatorBase;
#include "UtVec3.hpp"
 
class WsfOrbitalEvent;
class WsfOrbitalManeuver;
class WsfSimulation;
class WsfSpaceMoverBase;
 
namespace wsf
{
namespace space
{

class OrbitalMissionContext
{
public:
   OrbitalMissionContext()          = default;
   virtual ~OrbitalMissionContext() = default;

   virtual void Update(const UtCalendar& aEpoch) = 0;

   virtual bool Initialize(const UtCalendar& aEpoch) = 0;

   virtual const UtOrbitalPropagatorBase& GetPropagator() const = 0;

   virtual WsfSimulation* GetSimulation() const { return nullptr; }

   virtual WsfSpaceMoverBase* GetSpaceMover() const { return nullptr; }

   virtual void InitiateMissionEvent(const UtCalendar& aEpoch, const WsfOrbitalEvent& aMissionEvent) const {}

   virtual void UpdateMissionEvent(const UtCalendar& aEpoch, const WsfOrbitalEvent& aMissionEvent) const {}

   virtual void CompleteMissionEvent(const UtCalendar& aEpoch, const WsfOrbitalEvent& aMissionEvent) const {}

   virtual void CancelMissionEvent(const UtCalendar& aEpoch, const WsfOrbitalEvent& aMissionEvent) const {}

   virtual bool Maneuver(const UtCalendar& aEpoch, const UtVec3d& aCommandedDeltaV, UtVec3d& aActualDeltaV) const
   {
      return false;
   }

   virtual double GetAvailableDeltaV() const { return -1.0; }

   virtual double GetRequiredDeltaV(double aDuration) const { return -1.0; }

   virtual bool PerformStagingOperation() const { return false; }

   virtual std::string GetName() const { return std::string{}; }

   virtual double GetManeuverDuration(const UtCalendar& aEpoch, const WsfOrbitalManeuver& aManeuver, double aDeltaV) const
   {
      return -1.0;
   }
};
 
} // namespace space
} // namespace wsf
 
#endif // WSFSPACEORBITALMISSIONCONTEXT_HPP