WsfProcessor.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 WSFPROCESSOR_HPP
#define WSFPROCESSOR_HPP
 
#include "wsf_export.h"
 
class UtInput;
class WsfCallback;
#include "WsfComponentList.hpp"
class WsfMessage;
class WsfPlatform;
#include "WsfPlatformPart.hpp"
class WsfProcessor;
#include "WsfProcessorComponent.hpp"
#include "WsfVariable.hpp"

class WSF_EXPORT WsfProcessor : public WsfPlatformPart
{
public:
   WsfProcessor(const WsfScenario& aScenario);
   ~WsfProcessor() override = default;


   using ComponentList = WsfComponentListT<WsfProcessorComponent>;
   ComponentList&       GetComponents() { return mComponents; }
   const ComponentList& GetComponents() const { return mComponents; }


   WsfComponent* CloneComponent() const override { return Clone(); }
   const int*    GetComponentRoles() const override;
   void*         QueryInterface(int aRole) override;
   int           GetComponentInitializationOrder() const override { return cWSF_INITIALIZE_ORDER_PROCESSOR; }


   const char* GetScriptClassName() const override;
   WsfProcessor* Clone() const override = 0;
   bool          PreInitialize(double aSimTime) override;
   bool          Initialize(double aSimTime) override;
   bool          Initialize2(double aSimTime) override;
   void          PreInput() override;
   bool          ProcessInput(UtInput& aInput) override;
   void          Update(double aSimTime) override;


   void TurnOff(double aSimTime) override;
   void TurnOn(double aSimTime) override;
   void SetNonOperational(double aSimTime) override;
   void SetOperational(double aSimTime) override;
   void PartBroken(double aSimTime) override;


   double GetUpdateInterval() const override;
   void   SetUpdateInterval(double aUpdateInterval) override;

   virtual void ProcessCallback(double aSimTime, const WsfCallback& aCallback);
 
protected:
   WsfProcessor(const WsfProcessor& aSrc);
   WsfProcessor& operator=(const WsfProcessor& aRhs) = delete;
 
private:
   ComponentList mComponents;

   WsfVariable<double> mUpdateInterval;
};
 
WSF_DECLARE_COMPONENT_ROLE_TYPE(WsfProcessor, cWSF_COMPONENT_PROCESSOR)
 
#endif