Tool.hpp

Go to the documentation of this file.

// ****************************************************************************
// CUI
//
// The Advanced Framework for Simulation, Integration, and Modeling (AFSIM)
//
// Copyright 2003-2015 The Boeing 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 TOOL_HPP
#define TOOL_HPP
 
#include "WeaponToolsExport.hpp"
 
class UtInput;
#include "WsfExplicitWeapon.hpp"
class WsfGuidanceComputer;
class WsfPlatform;
#include "WeaponObserver.hpp"
#include "WsfObject.hpp"
#include "WsfStringId.hpp"
class ToolManager;

 
class WT_EXPORT Tool : public WsfObject
{
public:
   Tool(const Tool& aSrc);
   Tool& operator=(const Tool&) = delete;
   ~Tool() override;
   Tool*        Clone() const override = 0;
   virtual void Update(double aSimTime);
   virtual bool Initialize(WsfSimulation& aSimulation);
   bool         ProcessInput(UtInput& aInput) override;


   virtual void MoverBurnout(double aSimTime, WsfMover* aMoverPtr);
   virtual void GuidanceComputerPhaseChanged(double aSimTime, WsfGuidanceComputer* aComputerPtr);
   virtual void PlatformAdded(double aSimTime, WsfPlatform* aPlatformPtr);
 
   WsfStringId WeaponPlatformTypeId() const;
 
   double             FrameStep() const { return mFrameStep; }
   bool               IsInitialized() const { return mInitialized; }
   WsfPlatform*       GetLauncherPlatform() const { return mLaunchPlatPtr; }
   WsfExplicitWeapon* GetLauncherWeapon() const { return mLaunchWpnPtr; }
 
protected:
   WsfSimulation* GetSimulation() const { return mSimulationPtr; }
   WsfScenario&   GetScenario() const { return *mScenarioPtr; }
   ToolManager*   GetManager() const;
   Tool(WsfScenario& aScenario);
 
   void UnInitialize();

   bool IsDone() const { return mDone; }

   bool DebugEnabled() const { return mDebug; }

   virtual void ResolveNames();

   virtual bool FireNewWeapon(double aSimTime) = 0;
 
   virtual void ErrorBailout(){};
 
   WsfScenario*       mScenarioPtr;
   WsfSimulation*     mSimulationPtr;
   WeaponObserver     mObserver;
   WsfPlatform*       mLaunchPlatPtr;
   WsfExplicitWeapon* mLaunchWpnPtr;
 
   double mFrameStep;
   double mLastUpdate;
   double mLatDeg;
   double mLonDeg;
   double mAlt;
   double mHeadingRad;
 
   bool mDone;
   bool mNotifiedDone;
   bool mInitialized;
   bool mDebug;
   bool mTerminateOnLaunchFailure;
 
   std::string mToolProduces;
   std::string mFileExtension;
   WsfStringId mWeaponEffectTypeId;
   WsfStringId mLaunchPlatformTypeId;
   WsfStringId mTargetPlatformTypeId;
   WsfStringId mWeaponNameId;
   std::string mOutputFileName;
   std::string mOutputObjectName;
};
 
#endif