WsfCorrelationStrategy.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 WSFCORRELATIONSTRATEGY_HPP
#define WSFCORRELATIONSTRATEGY_HPP
 
#include "wsf_export.h"
 
#include <map>
 
class UtInput;
#include "UtScriptBasicTypes.hpp"
#include "WsfException.hpp"
#include "WsfObject.hpp"
#include "WsfObjectTypeList.hpp"
#include "script/WsfScriptObjectClass.hpp"
class WsfTrack;
#include "WsfTrackId.hpp"
#include "WsfTrackListFwd.hpp"
class WsfPlatform;
class WsfSimulation;
#include "WsfStringId.hpp"
class WsfTrack;
class WsfTrackManager;

class WSF_EXPORT WsfCorrelationStrategy : public WsfObject
{
public:
   ~WsfCorrelationStrategy() override = default;

   WsfCorrelationStrategy* Clone() const override = 0; // pure virtual

   bool ProcessInput(UtInput& aInput) override { return false; }

   virtual bool Initialize(WsfTrackManager* aTrackManagerPtr)
   {
      mTrackManagerPtr = aTrackManagerPtr;
      return true;
   };
 
   void NewTrackCorrelation(const WsfTrack& aRawTrack, const WsfLocalTrack& aLocalTrack);

   WsfLocalTrack* Correlate(double aSimTime, const WsfTrack& aNonLocalTrack, WsfLocalTrackList& aTrackList);
 
   const WsfTrackId& GetCorrelatedTrackId(const WsfTrackId& aRawTrackId) const;
 
   virtual void Decorrelate(const WsfTrackId& aRawTrackId);
 
   void NotifyOfLocalTrackCorrelation(double aSimTime, const WsfLocalTrack& aLocalTrack, const WsfTrackId& aRawTrackId);
 
   typedef WsfObjectTypeList<WsfCorrelationStrategy> CorrelationStrategyTypes;

   WsfTrackManager& GetTrackManager() { return *mTrackManagerPtr; }
 
   void           SetTrackManager(WsfTrackManager* aTrackManagerPtr) { mTrackManagerPtr = aTrackManagerPtr; }
   WsfSimulation* GetSimulation() const;
 
   bool TestCorrelation(const WsfTrack& aTrack1, const WsfTrack& aTrack2);
 
protected:
   WsfCorrelationStrategy();
   WsfCorrelationStrategy(const WsfCorrelationStrategy& aSrc);
   WsfCorrelationStrategy& operator=(const WsfCorrelationStrategy& aRhs);

   virtual WsfLocalTrack* CorrelateImpl(double aSimTime, const WsfTrack& aNonLocalTrack, WsfLocalTrackList& aTrackList) = 0;
 
   std::map<WsfTrackId, WsfTrackId> mCorrelationMap;
 
private:
   WsfTrackManager* mTrackManagerPtr;
};

class WsfScriptCorrelationClass : public WsfScriptObjectClass
{
public:
   WsfScriptCorrelationClass(const std::string& aClassName, UtScriptTypes* aScriptTypesPtr);
 
   UT_DECLARE_SCRIPT_METHOD(TestCorrelation); // NO_DOC | FOR_TEST_ONLY
   UT_DECLARE_SCRIPT_METHOD(Correlate);       // NO_DOC | FOR_TEST_ONLY
};
 
#endif