WsfComponent.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 WSFCOMPONENT_HPP
#define WSFCOMPONENT_HPP
 
#include <cassert>
#include <vector>
 
#include "UtException.hpp"
class UtInput;
#include "wsf_export.h"
 
#include "WsfComponentRoles.hpp"
class WsfPlatform;
#include "WsfStringId.hpp"
 
// *************************************************************************************************
// PROGRAMMING NOTE:
//
// Most of the methods within WsfComponent and WsfComponentList include the word 'Component' in the
// name to avoid name conflicts if this class is derived from by another class (e.g.: WsfPlatform).
// Also, some classes derive from both WsfComponent and WsfComponentList (i.e. they are a component,
// but they also support sub-components). Thus, there may be no name conflicts between them.
// *************************************************************************************************

class WSF_EXPORT WsfComponent
{
public:
   virtual ~WsfComponent() = default;



   virtual WsfComponent* CloneComponent() const = 0;

   virtual WsfStringId GetComponentName() const = 0;

   virtual const int* GetComponentRoles() const = 0;

   virtual void* QueryInterface(int aRole) = 0;

   virtual int GetComponentInitializationOrder() const { return 0; }

   template<typename T>
   bool QueryInterfaceT(T*& aRolePtr)
   {
      aRolePtr = static_cast<T*>(QueryInterface(cCOMPONENT_ROLE<T>()));
      return aRolePtr != nullptr;
   }

   bool ComponentHasRole(int aRole) { return QueryInterface(aRole) != nullptr; }


   virtual bool PreInitialize(double aSimTime);
   virtual bool Initialize(double aSimTime);
   virtual bool Initialize2(double aSimTime);
   virtual void PreInput();
   virtual bool ProcessInput(UtInput& aInput);
};

template<typename PARENT_TYPE>
class WsfComponentT : public WsfComponent
{
public:
   typedef PARENT_TYPE ParentType;
 
   WsfComponentT()
      : mParentPtr(nullptr)
   {
   }
 
   WsfComponentT(const WsfComponentT& /* aSrc */) noexcept
      : mParentPtr(nullptr)
   {
   }
 
   WsfComponentT& operator=(const WsfComponentT& /* aSrc */) noexcept
   {
      mParentPtr = nullptr;
      return *this;
   }
 
   ~WsfComponentT() override = default;



   virtual void ComponentParentChanged(ParentType* aParentPtr) {}

   ParentType* GetComponentParent() const { return mParentPtr; }

   void SetComponentParent(ParentType* aParentPtr)
   {
      mParentPtr = aParentPtr;
      ComponentParentChanged(aParentPtr); // Inform of change of parent
   }

 
private:
   ParentType* mParentPtr;
};

using WsfPlatformComponent = WsfComponentT<WsfPlatform>;
 
#endif