WsfSimulationObserver.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 WSFSIMULATIONOBSERVER_HPP
#define WSFSIMULATIONOBSERVER_HPP
 
#include "wsf_export.h"
 
#include <string>
 
#include "UtCallback.hpp"
class WsfMessage;
class WsfPlatform;
class WsfSimulation;
 
// Note: The following only exists in this file to prevent redundancy
//    in the compiled DOxygen code documentation.
namespace WsfObserver
{
class InitializeCallback : public UtCallbackListN<bool()>
{
public:
   bool Callback()
   {
      bool ok = true;
      for (auto it = mCallbackList.begin(); it != mCallbackList.end();)
      {
         if (!static_cast<CallbackType*>(*(it++))->operator()())
         {
            ok = false;
         }
      }
      return ok;
   }
   void Clear() { mCallbackList.clear(); }
};
 
using AdvanceTimeCallback               = UtCallbackListN<void(double)>;
using ApplicationExitCallback           = UtCallbackListN<void()>;
using ApplicationInitializeCallback     = UtCallbackListN<void()>;
using FrameCompleteCallback             = UtCallbackListN<void(double)>;
using FramePlatformsUpdatedCallback     = UtCallbackListN<void(double)>;
using FrameStartingCallback             = UtCallbackListN<void(double)>;
using RequestTimeAdvanceCallback        = UtCallbackListN<void(double, double, double)>;
using SimulationClockRateChangeCallback = UtCallbackListN<void(double)>;
using SimulationInitializingCallback    = UtCallbackListN<void()>;
using SimulationPendingStartCallback    = UtCallbackListN<void()>;
using SimulationStartingCallback        = UtCallbackListN<void()>;
using SimulationPausingCallback         = UtCallbackListN<void()>;
using SimulationResumingCallback        = UtCallbackListN<void()>;
using SimulationCompleteCallback        = UtCallbackListN<void(double)>;
using SimulationTimeBehindCallback      = UtCallbackListN<void(double)>;
 
WSF_EXPORT AdvanceTimeCallback&               AdvanceTime(const WsfSimulation* aSimulationPtr);
WSF_EXPORT ApplicationExitCallback&           ApplicationExit(const WsfSimulation* aSimulationPtr);
WSF_EXPORT ApplicationInitializeCallback&     ApplicationInitialize(const WsfSimulation* aSimulationPtr);
WSF_EXPORT FrameCompleteCallback&             FrameComplete(const WsfSimulation* aSimulationPtr);
WSF_EXPORT FramePlatformsUpdatedCallback&     FramePlatformsUpdated(const WsfSimulation* aSimulationPtr);
WSF_EXPORT FrameStartingCallback&             FrameStarting(const WsfSimulation* aSimulationPtr);
WSF_EXPORT InitializeCallback&                Initialize(const WsfSimulation* aSimulationPtr);
WSF_EXPORT RequestTimeAdvanceCallback&        RequestTimeAdvance(const WsfSimulation* aSimulationPtr);
WSF_EXPORT SimulationClockRateChangeCallback& SimulationClockRateChange(const WsfSimulation* aSimulationPtr);
WSF_EXPORT SimulationInitializingCallback&    SimulationInitializing(const WsfSimulation* aSimulationPtr);
WSF_EXPORT SimulationPendingStartCallback&    SimulationPendingStart(const WsfSimulation* aSimulationPtr);
WSF_EXPORT SimulationStartingCallback&        SimulationStarting(const WsfSimulation* aSimulationPtr);
WSF_EXPORT SimulationPausingCallback&         SimulationPausing(const WsfSimulation* aSimulationPtr);
WSF_EXPORT SimulationResumingCallback&        SimulationResuming(const WsfSimulation* aSimulationPtr);
WSF_EXPORT SimulationCompleteCallback&        SimulationComplete(const WsfSimulation* aSimulationPtr);
WSF_EXPORT SimulationTimeBehindCallback&      SimulationTimeBehind(const WsfSimulation* aSimulationPtr);
} // namespace WsfObserver

struct WSF_EXPORT WsfSimulationObserver
{
   WsfObserver::AdvanceTimeCallback AdvanceTime;

   WsfObserver::ApplicationExitCallback ApplicationExit;

   WsfObserver::ApplicationInitializeCallback ApplicationInitialize;

   WsfObserver::FrameCompleteCallback FrameComplete;

   WsfObserver::FramePlatformsUpdatedCallback FramePlatformsUpdated;

   WsfObserver::FrameStartingCallback FrameStarting;

   WsfObserver::InitializeCallback Initialize;

   WsfObserver::RequestTimeAdvanceCallback RequestTimeAdvance;

   WsfObserver::SimulationClockRateChangeCallback SimulationClockRateChange;

   WsfObserver::SimulationInitializingCallback SimulationInitializing;

   WsfObserver::SimulationPendingStartCallback SimulationPendingStart;

   WsfObserver::SimulationStartingCallback SimulationStarting;

   WsfObserver::SimulationPausingCallback SimulationPausing;

   WsfObserver::SimulationResumingCallback SimulationResuming;

   WsfObserver::SimulationCompleteCallback SimulationComplete;

   WsfObserver::SimulationTimeBehindCallback SimulationTimeBehind;
};
 
#endif