WsfLocalTrack.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 WSFLOCALTRACK_HPP
#define WSFLOCALTRACK_HPP
 
#include "wsf_export.h"
 
#include <memory>
#include <string>
 
#include "UtGenericMappedList.hpp"
class UtScriptClass;
class UtScriptTypes;
class UtInput;
class WsfFilter;
#include "WsfTrack.hpp"
class WsfTrackManager;

 
class WSF_EXPORT WsfLocalTrack : public WsfTrack
{
public:
   using RawTrackIdList = UtMappedList<WsfTrackId, WsfTrackId>;
 
   WsfLocalTrack();
   WsfLocalTrack(const WsfLocalTrack& aTrack);
   WsfLocalTrack(const WsfTrack& aTrack);
   ~WsfLocalTrack() override;

   WsfLocalTrack* Clone() const override;
 
   const char* GetScriptClassName() const override;
 
   void ReplacementUpdate(const WsfTrack& aSource) override;
 
   void UpdateFromMeasurement(double aSimTime, const WsfTrack& aMeasurement) override;

   WsfTrackManager* GetTrackManager() const { return mManagerPtr; }

   void SetTrackManager(WsfTrackManager* aManagerPtr) { mManagerPtr = aManagerPtr; }
 
   static std::unique_ptr<UtScriptClass> CreateScriptClass(const std::string& aClassName, UtScriptTypes* aScriptTypesPtr);


 
   virtual bool Correlate(const WsfTrackId& aFusedTrackId);
   virtual bool Decorrelate(const WsfTrackId& aFusedTrackId);
   virtual bool IsCorrelatedWith(const WsfTrackId& aTrackId) const;
 
   void DecorrelateAll();

   bool IsCorrelated() const { return (mFusedTrackIds.GetCount() > 0); }

   const RawTrackIdList& GetRawTrackIds() const { return mFusedTrackIds; }



 
   void SetPurgeable(bool aIsPurgeable) override;

   void IncrementUseCount() { ++mUseCount; }

   int GetUseCount() const { return mUseCount; }

   void DecrementUseCount()
   {
      --mUseCount;
      if (mUseCount < 0)
      {
         mUseCount = 0;
      }
   }

   void ResetUseCount() { mUseCount = 0; }



 
   // Return a pointer to the filter.  If no filter is present, the pointer will be zero.
   WsfFilter* GetFilter() override { return mFilterPtr; }

   const WsfFilter* GetFilter() const override { return mFilterPtr; }
 
   void SetFilter(WsfFilter* aFilterPtr);
 
   virtual bool UpdateFilter(double aSimTime, const WsfTrack& aMeasurement);
   //



   WsfTrack* GetRawTrack() { return static_cast<WsfTrack*>(this); }

   const WsfTrackId& GetHighestTrackQualityId() const { return mHighestQualityTrackId; }

   void SetHighestTrackQualityId(const WsfTrackId& aTrackId) { mHighestQualityTrackId = aTrackId; }
 
   bool IsMirrorTrack(const WsfTrack& aTrack) const;
   void SetMirrorTrack(const WsfTrack& aTrack);
   void ClearMirrorTrack();
 
   void UpdateSignalList();
 
   WsfLocalTrack& operator=(const WsfLocalTrack& aRhs);
 
   // ================================= WARNING: New member variables =================================
   //
   //    This class is transmitted over the network.  If you add a new member variable, it is
   //    YOUR RESPONSIBILITY to verify that the member is serialized correctly.
   //    Please see the implementation of WsfLocalTrack::SerializeP in xio/WsfXIO_SerializeTypes.cpp
   //
   // =================================================================================================

   template<typename T>
   void SerializeP(T& aBuff);
 
private:
   WsfLocalTrack& operator=(const WsfTrack& aRhs); // Not Allowed.

   WsfTrackManager* mManagerPtr;
 
   RawTrackIdList mFusedTrackIds;
   int            mUseCount;
   WsfFilter*     mFilterPtr;
   WsfTrackId     mHighestQualityTrackId;

   WsfTrackId mMirrorTrackId;
};
#endif