WsfMultiresolutionWrapperMetaModel.hpp

Go to the documentation of this file.

// ****************************************************************************
// CUI
//
// The Advanced Framework for Simulation, Integration, and Modeling (AFSIM)
//
// Copyright (C) 2021 Stellar Science; U.S. Government has Unlimited Rights.
//
// The use, dissemination or disclosure of data in this file is subject to
// limitation or restriction. See accompanying README and LICENSE for details.
// ****************************************************************************
 
#ifndef WSF_MULTIRESOLUTION_WRAPPER_META_MODEL_HPP
#define WSF_MULTIRESOLUTION_WRAPPER_META_MODEL_HPP
 
#include <memory>
#include <vector>
 
#include "FidelityRange.hpp"
#include "UtCloneablePtr.hpp"
#include "UtOptional.hpp"
#include "WsfComponent.hpp"
#include "WsfObjectTypeList.hpp"
#include "WsfStringId.hpp"
 
class WsfScenario;
class UtInputBlock;

template<typename DerivedComponent>
class WsfMultiresolutionWrapperMetaModel final : public WsfMultiresolutionPlatformComponent<DerivedComponent>
{
public:
   WsfMultiresolutionWrapperMetaModel()                    = default;
   ~WsfMultiresolutionWrapperMetaModel() noexcept override = default;
   WsfMultiresolutionWrapperMetaModel& operator=(const WsfMultiresolutionWrapperMetaModel& aSrc) = delete;
   WsfMultiresolutionWrapperMetaModel(WsfMultiresolutionWrapperMetaModel&&)                      = delete;
   WsfMultiresolutionWrapperMetaModel& operator=(WsfMultiresolutionWrapperMetaModel&& aSrc) = delete;


   WsfComponent* CloneComponent() const override;
   WsfObject*    Clone() const override;
   bool          ProcessInput(UtInput& aInput) override;
 
private:
   struct ModelWithFidelity
   {
      WsfStringId                         mName;
      wsf::multiresolution::FidelityRange mFidelityRange;
      ut::CloneablePtr<DerivedComponent>  mComponent;
   };
   using Index = typename std::vector<ModelWithFidelity>::size_type;

   WsfMultiresolutionWrapperMetaModel(const WsfMultiresolutionWrapperMetaModel&) = default;
 
   std::unique_ptr<DerivedComponent> GetModel() const override;



   bool ProcessModel(UtInputBlock& aInputBlock, Index aModelIndex);
   std::unique_ptr<DerivedComponent> ProcessComponent(UtInput&                          aInput,
                                                      std::unique_ptr<DerivedComponent> aExistingComponent);
   Index ProcessModelName(UtInputBlock& aInputBlock, ut::optional<bool> aExpectExists = ut::nullopt);
   std::unique_ptr<DerivedComponent> ProcessComponentType(UtInput& aInput);
   bool ProcessCommonParameters(UtInput& aInput);
   void FinalizeModelProcessing(UtInput& aInput, const ModelWithFidelity& aModelWithFidelity);
   void AffirmDisjointWithFidelityRanges(UtInput& aInput, const ModelWithFidelity& aModelWithFidelity) const;

   ut::optional<Index> ModelIndexForFidelity(double aFidelity) const;
   ut::optional<Index> ModelIndexWithName(const std::string& aTypeName) const;
 
   std::vector<ModelWithFidelity> mComponentModels;
   ut::optional<Index> mDefaultComponentIndex;
};
 
#include "WsfMultiresolutionWrapperMetaModelImpl.hpp"
 
#endif