WsfSA_GroupUtils.hpp

Go to the documentation of this file.

// ****************************************************************************
// CUI//REL TO USA ONLY
//
// The Advanced Framework for Simulation, Integration, and Modeling (AFSIM)
//
// Copyright 2022 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 WSFSA_GROUPUTILS_HPP
#define WSFSA_GROUPUTILS_HPP
 
#include "wsf_air_combat_export.h"
 
#include <functional>
#include <list>
 
#include "WsfSA_EntityPerception.hpp"
#include "WsfSA_Group.hpp"
 
class WsfPlatform;
 
/*This pure static class provides testable and prtable functions for manipulating groups.*/
class WSF_AIR_COMBAT_EXPORT WsfSA_GroupUtils
{
public:
   enum SplitCriteria
   {
      cMAX_THREAT             = 1,
      cMIN_THREAT             = 2,
      cMAX_TARGET             = 3,
      cMIN_TARGET             = 4,
      cMAX_ALTITUDE           = 5,
      cMIN_ALTITUDE           = 6,
      cMAX_DISTANCE           = 7,
      cMIN_DISTANCE           = 8,
      cRIGHTMOST_FROM_HEADING = 9,
      cLEFTMOST_FROM_HEADING  = 10
   };
 
   enum GroupSorting
   {
      cASCENDING_THREAT        = 1,
      cDESCENDING_THREAT       = 2,
      cASCENDING_TARGET        = 3,
      cDESCENDING_TARGET       = 4,
      cASCENDING_ALTITUDE      = 5,
      cDESCENDING_ALTITUDE     = 6,
      cASCENDING_DISTANCE      = 7,
      cDESCENDING_DISTANCE     = 8,
      cASCENDING_ENTITY_COUNT  = 9,
      cDESCENDING_ENTITY_COUNT = 10,
      cASCENDING_RADIUS        = 11,
      cDESCENDING_RADIUS       = 12
   };

   static int StringToSplitCriteria(const std::string& aEnumString);

   static int StringToGroupSorting(const std::string& aEnumString);

   static int CalculateNumPIs(const std::list<WsfSA_PerceivedItem*>& aItemList);

   static int CalculateNumPIs(const std::list<WsfSA_Group*>& aGroupList);

   static bool RenameGroup(const std::list<WsfSA_Group*>& aGroupList, WsfSA_Group* aGroup, const std::string& aName);

   static WsfSA_Group* CreateGroup(int                                       aPI_Limit,
                                   int                                       aPI_Current,
                                   std::list<WsfSA_Group*>&                  aGroupList,
                                   const WsfPlatform*                        aOwningPlatform,
                                   const std::list<WsfSA_EntityPerception*>& aElements,
                                   const std::string&                        aName,
                                   double                                    aMinGroupRadius_nm,
                                   bool                                      aProtect = false);

   static bool DisbandGroup(int                          aPI_Limit,
                            int                          aPI_Current,
                            std::list<WsfSA_Group*>&     aGroupList,
                            WsfSA_Group*                 aGroup,
                            std::function<std::string()> aNamingFunc,
                            double                       aMinGroupRadius_nm,
                            bool                         aProtect = false);

   static WsfSA_Group* MergeGroups(std::list<WsfSA_Group*>&       aGroupList,
                                   const std::list<WsfSA_Group*>& aGroups,
                                   const WsfPlatform*             aOwningPlatform,
                                   double                         aMinGroupRadius_nm,
                                   bool                           aProtect = false);

   static std::pair<WsfSA_Group*, WsfSA_Group*> SplitGroup(int                      aPI_Limit,
                                                           int                      aPI_Current,
                                                           std::list<WsfSA_Group*>& aGroupList,
                                                           WsfSA_Group*             aGroup,
                                                           int                      aNumElements,
                                                           int                      aCriterion,
                                                           WsfPlatform*             aPlatform,
                                                           const std::string&       aNewGroupName,
                                                           double                   aMinGroupRadius_nm,
                                                           bool                     aProtect = false);

   static bool TransferEntity(int                      aPI_Limit,
                              int                      aPI_Current,
                              std::list<WsfSA_Group*>& aGroupList,
                              WsfSA_EntityPerception*  aEntity,
                              WsfSA_Group*             aGroup,
                              double                   aMinGroupRadius_nm,
                              bool                     aProtect = false);

   static bool RemoveEntityFromGroup(int                      aPI_Limit,
                                     int                      aPI_Current,
                                     std::list<WsfSA_Group*>& aGroupList,
                                     WsfSA_EntityPerception*  aEntity,
                                     const std::string&       aDegenerateGroupName,
                                     double                   aMinGroupRadius_nm,
                                     bool                     aProtect = false);

   static bool SetFocus(int aPI_Limit, int aPI_Current, WsfSA_Group* aGroup, bool aFocus, bool aProtect = false);

   static void Prune(int aPI_Limit, std::list<WsfSA_PerceivedItem*>& aGroupList, std::list<WsfSA_PerceivedItem*>& aToRemove);

   static void PruneRecursive(int                              aPI_Limit,
                              WsfSA_PerceivedItem::Importance  aImportance,
                              bool                             aPreserve,
                              std::list<WsfSA_PerceivedItem*>& aGroupList,
                              std::list<WsfSA_PerceivedItem*>& aToRemove);

   static void SortedGroups(int                            aSortingEnum,
                            std::vector<WsfSA_Group*>&     aOutputGroups,
                            const std::list<WsfSA_Group*>& aGroupList,
                            const WsfPlatform*             aPlatform);
 
   // =======================
   // From WsfSA_GroupManager
   // =======================

   static void RecalculateGroupCentroid(WsfSA_Group* aGroup, double aMinGroupRadius_nm);

   static double CalcRadiusForGroup_nm(const WsfSA_Group* aGroup, double aMinGroupRadius_nm);

   static double DistanceFromCentroid(const WsfSA_Group* aGroup, const WsfSA_EntityPerception* aEntity);
};
 
#endif // WSFSA_GROUPUTILS_HPP