WsfFormationFlyer.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 WSFFORMATIONFLYER_HPP
#define WSFFORMATIONFLYER_HPP
 
#include "wsf_mil_export.h"
 
#include "WsfFollower.hpp"
 

 
class WSF_MIL_EXPORT WsfFormationFlyer : public WsfFollower
{
public:
   WsfFormationFlyer(WsfScenario& aScenario);
   ~WsfFormationFlyer() override = default;


   WsfMover*   Clone() const override;
   bool        Initialize(double aSimTime) override;
   bool        ProcessInput(UtInput& aInput) override;
   void        Update(double aSimTime) override;
   const char* GetScriptClassName() const override;
 
   WsfSpatialDomain GetSpatialDomain() const override { return WSF_SPATIAL_DOMAIN_AIR; }


   // void SetLeadAircraft(int aLeadNameId);
   void         SetLeadAircraft(WsfPlatform* aPlatformPtr);
   WsfPlatform* GetLeadAircraft() const { return mLeadPlatPtr; }
 
   void SetOffsetFromLeadECS(const double aOffsetFromLeadECS[3]); // ECS frame [meters]
   void GetOffsetFromLeadECS(double aOffsetFromLeadECS[3]) const; // ECS frame [meters]
 
   void SetFormationRollsWithLead(bool aValue) { mFormationRolls = aValue; }
   bool GetFormationRollsWithLead() const { return mFormationRolls; }

   void SwitchSides() { mNegateLateralOffset = !mNegateLateralOffset; }
 
protected:
   // Declare default copy constructor (for Clone())
   WsfFormationFlyer(const WsfFormationFlyer& aSrc);
   WsfFormationFlyer& operator=(const WsfFormationFlyer&) = delete;
 
   void UpdateLeadInfo(double aSimTime);
   void UpdateLeadPosAndVel(double aSimTime);
 
private:
   void OutputDiagnostic(double aSimTime, WsfPlatform* aLeadPlatPtr);
   void PlatformDiagnostic(WsfPlatform* aPlatformPtr);
 

   WsfStringId mLeadNameId;

   size_t mLeadIndex;

   WsfPlatform* mLeadPlatPtr;

   double mOffsetFromLeadECS[3];

   bool mFormationRolls;

   bool mNegateLateralOffset;

   bool mInitializeAtOffset;
};
 
#endif