WsfModeList.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 WSFMODELIST_HPP
#define WSFMODELIST_HPP
 
#include "wsf_export.h"
 
#include <cassert>
#include <vector>
 
class UtInput;
#include "WsfStringId.hpp"
class WsfMode;

 
class WSF_EXPORT WsfModeList
{
public:
   using ModeList = std::vector<WsfMode*>;
 
   WsfModeList(WsfMode* aTemplatePtr);
   WsfModeList(const WsfModeList& aSrc);
   WsfModeList& operator=(const WsfModeList&) = delete;
   virtual ~WsfModeList();
 
   static WsfStringId GetDefaultModeNameId();
 
   virtual void AddMode(WsfMode* aModePtr);

   bool CanMultiSelect() const { return mCanMultiSelect; }

   size_t GetCurrentMode() const { return mCurrentModeIndex; }

   size_t GetModeCount() const { return mModeList.size(); }

   WsfMode* GetModeEntry(size_t aModeIndex) const { return mModeList[aModeIndex]; }
 
   size_t GetModeByName(WsfStringId aModeNameId) const;
 
   WsfStringId GetModeNameId(size_t aModeIndex) const;

   WsfMode* GetModeTemplate() const { return mTemplatePtr; }
 
   virtual bool Initialize();
 
   virtual bool ProcessInput(UtInput& aInput);
 
   virtual void Deselect(double aSimTime, WsfStringId aModeNameId);
 
   virtual void Select(double aSimTime, WsfStringId aModeNameId);
 
   virtual void TurnOff(double aSimTime);
 
   virtual void TurnOn(double aSimTime);

   virtual double GetModeSelectDelay() { return mModeSelectDelay; }

   virtual bool IsModeChangeScheduled() const { return mModeChangeScheduled; }

   virtual void SetModeChangeScheduled(bool aModeChangeScheduled) { mModeChangeScheduled = aModeChangeScheduled; }

   template<class T>
   void GetDerivedModeList(std::vector<T>& aModeList) const
   {
      aModeList.resize(mModeList.size());
      for (typename std::vector<WsfMode*>::size_type i = 0; i < mModeList.size(); ++i)
      {
         T modePtr = dynamic_cast<T>(mModeList[i]);
         assert(modePtr != nullptr);
         aModeList[i] = modePtr;
      }
   }
 
protected:
   void DeselectP(double aSimTime, size_t aModeIndex);
   void SelectP(double aSimTime, size_t aModeIndex);

   std::vector<WsfMode*> mModeList;
   WsfMode* mTemplatePtr;
   bool mExplicitModeUsed;
   bool mImplicitModeUsed;
   bool mCanMultiSelect;
   WsfStringId mInitialModeNameId;
   bool mIsInitialized;
   bool mIsTurnedOn;
   size_t mCurrentModeIndex;
   double mModeSelectDelay;
   bool mModeChangeScheduled;
};
 
#endif