WsfScriptProcessor.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 WSFSCRIPTPROCESSOR_HPP
#define WSFSCRIPTPROCESSOR_HPP
 
#include "UtCloneablePtr.hpp"
class UtInput;
class UtScript;
#include "UtScriptData.hpp"
class WsfAdvancedBehaviorTree;
class WsfBehaviorTree;
#include "wsf_export.h"
 
#include "WsfExternalLinks.hpp"
#include "WsfProcessor.hpp"
class WsfScriptContext;
class WsfScriptMessageHandler;
class WsfScriptStateMachine;

 
class WSF_EXPORT WsfScriptProcessor : public WsfProcessor
{
public:
   WsfScriptProcessor(const WsfScenario& aScenario);
 
   WsfScriptProcessor(const WsfScenario& aScenario, WsfStringId aPartClass, const std::string& aPartVarName);
 
   ~WsfScriptProcessor() override;
 
   WsfProcessor* Clone() const override;
 
   bool Initialize(double aSimTime) override;
 
   bool Initialize2(double aSimTime) override;
 
   bool ProcessInput(UtInput& aInput) override;
 
   void Update(double aSimTime) override;
 
   bool ProcessMessage(double aSimTime, const WsfMessage& aMessage) override;
#undef SendMessage
   void SendMessage(double aSimTime, const WsfMessage& aMessage) override;
 
   virtual void ExecuteOnMessageCreate(double aSimTime, WsfMessage& aMessage);
 
   virtual bool ExecuteScript(double aSimTime, const std::string& aScriptName);
 
   virtual bool ExecuteScript(double                  aSimTime,
                              WsfStringId             aScriptName,
                              UtScriptData&           aScriptRetVal,
                              const UtScriptDataList& aScriptArgs = UtScriptDataList());
 
   void ExecuteScriptAtTime(double aTime, WsfStringId aScriptName, const UtScriptDataList& aScriptArgs);
 
   virtual void SuppressMessage(bool aSuppressMessage);
 
   WsfScriptMessageHandler* GetMessageHandler() { return mMessageHandlerPtr; }
 
   WsfScriptContext& GetScriptContext() { return *mContextPtr; }
   UtScriptContext*  GetScriptAccessibleContext() const override;
   void              SetPlatform(WsfPlatform* aPlatformPtr) override;
 
   const WsfBehaviorTree* BehaviorTree() const { return mBehaviorTreePtr; }
 
   WsfAdvancedBehaviorTree* AdvancedBehaviorTree() const;
 
   virtual const WsfScriptStateMachine* GetStateMachine() const { return mStateMachinePtr.get(); }
 
   wsf::ExternalLinks& GetExternalLinks() { return mExternalLinks; }
 
   std::string State();
   std::string StateAll();
   void        SetState(std::string& stateName);
   void        SetStateAll(std::string& stateNameAll);
 
protected:
   WsfScriptProcessor(const WsfScriptProcessor& aSrc);

   WsfScriptContext* mContextPtr;

   WsfScriptMessageHandler* mMessageHandlerPtr;

   UtScript* mOnMessageCreateScriptPtr;
 
   UtScriptClass* mMessageClassPtr; // = mContextPtr->GetClass("WsfMessage");

   wsf::ExternalLinks mExternalLinks;
 
   WsfBehaviorTree* mBehaviorTreePtr;
 
   ut::CloneablePtr<WsfAdvancedBehaviorTree> mAdvancedBehaviorTreePtr;
 
   std::unique_ptr<WsfScriptStateMachine> mStateMachinePtr;
   int                                    mStateIndex;

   bool mSuppressMessage;
};
 
#endif