WsfCommandChain.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 WSFCOMMANDCHAIN_HPP
#define WSFCOMMANDCHAIN_HPP
 
#include "wsf_export.h"
 
#include <memory>
#include <string>
#include <vector>
 
class UtInput;
class UtScriptClass;
class UtScriptTypes;
class WsfPlatform;
class WsfScenario;
#include "WsfSimpleComponent.hpp"
#include "WsfStringId.hpp"

class WSF_EXPORT WsfCommandChain : public WsfSimplePlatformComponent
{
public:
   typedef std::vector<WsfPlatform*>           PlatformList;
   typedef std::vector<WsfPlatform*>::iterator PlatformListIter;
 
   static void RegisterComponentFactory(WsfScenario& aScenario);
 
   static std::unique_ptr<UtScriptClass> CreateScriptClass(const std::string& aClassName, UtScriptTypes* aScriptTypesPtr);
 
   static std::string GetDefaultName();
   static WsfStringId GetDefaultNameId();
 
   WsfCommandChain();
   WsfCommandChain(WsfStringId aCommandChainName, WsfStringId aCommanderName);
   ~WsfCommandChain() override = default;


   WsfComponent* CloneComponent() const override { return new WsfCommandChain(*this); }
   void*         QueryInterface(int aRole) override { return (aRole == mRoles[0]) ? this : nullptr; }
   int           GetComponentInitializationOrder() const override { return cWSF_INITIALIZE_ORDER_COMMAND_CHAIN; }
   void          ComponentParentChanged(WsfPlatform* aPlatformPtr) override { mPlatformPtr = aPlatformPtr; }

   WsfPlatform* GetPlatform() const { return mPlatformPtr; }



   WsfPlatform* GetCommander() const { return mCommanderPtr; }
 
   void SetCommander(WsfPlatform* aPlatformPtr);

   std::string GetCommanderName() const;

   WsfStringId GetCommanderNameId() const { return mCommanderName; }



   PlatformList& GetPeers() { return mPeers; }
 
   void AddPeer(WsfPlatform* aPlatformPtr);
   void RemovePeer(WsfPlatform* aPlatformPtr);



   PlatformList& GetSubordinates() { return mSubordinates; }
 
   void AddSubordinate(WsfPlatform* aPlatformPtr);
   void RemoveSubordinate(WsfPlatform* aPlatformPtr);

   //@(
   bool Initialize(double aSimTime) override;
 
   static bool LoadInstance(UtInput& aInput, WsfCommandChain*& aInstancePtr);
 
   void PlatformAdded(WsfPlatform* aPlatformPtr);
   void PlatformDeleted(WsfPlatform* aPlatformPtr);
 
protected:
   WsfCommandChain(const WsfCommandChain& aSrc);
   WsfCommandChain& operator=(const WsfCommandChain& aRhs);
 
private:
   std::string PrintHeader() const;
 
   WsfPlatform* mPlatformPtr;
 
   // This flag indicates that a commander was not specified for this command chain and it assumed to be SELF
   // This should only happen for the default command chain due to AFSIM's input restrictions.
   bool                      mCommanderIsSelfImplicitly{false};
   WsfStringId               mCommanderName;
   WsfPlatform*              mCommanderPtr;
   std::vector<WsfPlatform*> mPeers;
   std::vector<WsfPlatform*> mSubordinates;
 
   UtScriptClass* mPlatformClassPtr;
};
 
WSF_DECLARE_COMPONENT_ROLE_TYPE(WsfCommandChain, cWSF_COMPONENT_COMMAND_CHAIN)
 
#endif