WsfEventManager.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.
// ****************************************************************************
// ****************************************************************************
// Updated by Infoscitex, a DCS Company.
// ****************************************************************************
 
#ifndef WSFEVENTMANAGER_HPP
#define WSFEVENTMANAGER_HPP
 
#include "wsf_export.h"
 
#include <memory>
#include <mutex>
#include <queue>
#include <tuple>
 
#include "WsfEvent.hpp"
class WsfSimulation;

class WSF_EXPORT WsfEventManager
{
public:
   WsfEventManager(WsfSimulation& aSimulation);
   WsfEventManager(const WsfEventManager& aSrc) = delete;
   WsfEventManager& operator=(const WsfEventManager& aRhs) = delete;
   WsfEventManager(WsfEventManager&&)                      = default;
   WsfEventManager& operator=(WsfEventManager&&) = default;
   virtual ~WsfEventManager()                    = default;

   virtual void AddEvent(std::unique_ptr<WsfEvent> aEventPtr);

   virtual WsfEvent* PeekEvent() const;

   virtual std::unique_ptr<WsfEvent> PopEvent();
 
   virtual void Reset();

   struct Event
   {
      using Key = std::tuple<double, int, unsigned int>;
      Event(const Key& aKey, std::unique_ptr<WsfEvent> aEventPtr)
         : mKey(aKey)
         , mEventPtr(std::move(aEventPtr))
      {
      }
 
      bool operator>(const Event& rhs) const { return mKey > rhs.mKey; }
 
      Key                               mKey;
      mutable std::unique_ptr<WsfEvent> mEventPtr; // Need mutable access through top() (which returns const reference)
                                                   // in order to move
   };
 
protected:
   mutable std::recursive_mutex mMutex{};
 
private:
   using EventQueue = std::priority_queue<Event, std::vector<Event>, std::greater<Event>>; // Smallest element at the top
   WsfSimulation& mSimulation;
   EventQueue     mEvents{};
   unsigned int   mCounter{0U};
};
 
#endif