PhysiologyEngine.h

/* Distributed under the Apache License, Version 2.0.
   See accompanying NOTICE file for details.*/
 
#pragma once
#include "cdm/CommonDefs.h"
#include "cdm/utils/Logger.h"
 
class SEAdvanceHandler;
class SEPatient;
class SEPatientConfiguration;
class SEPatientAssessment;
 
class SECondition;
class SEAction;
 
class SESubstanceManager;
class SEBloodChemistrySystem;
class SECardiovascularSystem;
class SEDrugSystem;
class SEEndocrineSystem;
class SEEnergySystem;
class SEGastrointestinalSystem;
class SEHepaticSystem;
class SENervousSystem;
class SERenalSystem;
class SERespiratorySystem;
class SETissueSystem;
class SEEnvironment;
class SEAnesthesiaMachine;
class SEBagValveMask;
class SEExtracorporealMembraneOxygenationDevice;
class SEElectroCardioGram;
class SEInhaler;
class SEMechanicalVentilator;
class SECompartmentManager;
class SEBlackBoxManager;
class SEActionManager;
class SEConditionManager;
class SEEventManager;
 
class SEDataRequestManager;
class SEDataRequestTracker;
 
class SEEngineConfiguration;
 
enum class eEngineInitializationState
{
  Uninitialized = 0,
  FailedState = 1,
  FailedPatientSetup = 2,
  FailedStabilization = 3,
  Initialized = 4
};
extern CDM_DECL const std::string& eEngineInitializationState_Name(eEngineInitializationState s);
 
struct PhysiologyEngineException : public CommonDataModelException
{
  PhysiologyEngineException()
    : CommonDataModelException( "Physiology Engine Error" ) {}
 
  PhysiologyEngineException(const std::string& _Message)
    : CommonDataModelException(_Message) {}
};
 
class CDM_DECL PhysiologyEngine : public Loggable
{
public:
  PhysiologyEngine(Logger* logger = nullptr) : Loggable(logger) {}
  virtual ~PhysiologyEngine() = default;
 
  //--------------------------------------------------------------------------------------------------
  //--------------------------------------------------------------------------------------------------
  virtual std::string GetTypeName() const = 0;
 
  //--------------------------------------------------------------------------------------------------
  //--------------------------------------------------------------------------------------------------
  virtual bool SerializeFromFile(const std::string& file, const SEDataRequestManager* drMgr=nullptr) = 0;
 
  //--------------------------------------------------------------------------------------------------
  //--------------------------------------------------------------------------------------------------
  virtual bool SerializeToFile(const std::string& filename) const = 0;
 
  //--------------------------------------------------------------------------------------------------
  //--------------------------------------------------------------------------------------------------
  virtual bool SerializeFromString(const std::string& state, eSerializationFormat m, const SEDataRequestManager* drMgr=nullptr) = 0;
 
  //--------------------------------------------------------------------------------------------------
  //--------------------------------------------------------------------------------------------------
  virtual bool SerializeToString(std::string& state, eSerializationFormat m) const = 0;
 
  //--------------------------------------------------------------------------------------------------
  //--------------------------------------------------------------------------------------------------
  virtual bool InitializeEngine(const SEPatientConfiguration& patient_configuration, const SEDataRequestManager* drMgr=nullptr) = 0;
 
  //--------------------------------------------------------------------------------------------------
  //--------------------------------------------------------------------------------------------------
  virtual eEngineInitializationState GetInitializationState() const = 0;
 
  //--------------------------------------------------------------------------------------------------
  //--------------------------------------------------------------------------------------------------
  virtual void Clear() = 0;
 
  //--------------------------------------------------------------------------------------------------
  //--------------------------------------------------------------------------------------------------
  virtual const SEConditionManager& GetConditionManager() const = 0;
 
  //--------------------------------------------------------------------------------------------------
  //--------------------------------------------------------------------------------------------------
  virtual bool SetConfigurationOverride(const SEEngineConfiguration* config) = 0;
 
  //--------------------------------------------------------------------------------------------------
  //--------------------------------------------------------------------------------------------------
  virtual const SEEngineConfiguration* GetConfiguration() const = 0;
 
  //--------------------------------------------------------------------------------------------------
  //--------------------------------------------------------------------------------------------------
  virtual SEDataRequestTracker& GetDataRequestTracker() = 0;
 
  //--------------------------------------------------------------------------------------------------
  //--------------------------------------------------------------------------------------------------
  virtual double GetTimeStep(const TimeUnit& unit) const = 0;
 
  //--------------------------------------------------------------------------------------------------
  //--------------------------------------------------------------------------------------------------
  virtual double GetSimulationTime(const TimeUnit& unit) const = 0;
 
  //--------------------------------------------------------------------------------------------------
  //--------------------------------------------------------------------------------------------------
  virtual double GetStabilizationTime(const TimeUnit& unit) const = 0;
 
  //--------------------------------------------------------------------------------------------------
  //--------------------------------------------------------------------------------------------------
  virtual void SetSimulationTime(const SEScalarTime& time) = 0;
 
  //--------------------------------------------------------------------------------------------------
  //--------------------------------------------------------------------------------------------------
  virtual bool AdvanceModelTime() = 0;
 
  //--------------------------------------------------------------------------------------------------
  //--------------------------------------------------------------------------------------------------
  virtual bool AdvanceModelTime(double time, const TimeUnit& unit) = 0;
 
  //--------------------------------------------------------------------------------------------------
  //--------------------------------------------------------------------------------------------------
  virtual void SetAdvanceHandler(SEAdvanceHandler* handler) = 0;
 
  //--------------------------------------------------------------------------------------------------
  //--------------------------------------------------------------------------------------------------
  virtual bool ProcessAction(const SEAction& action) = 0;
 
  //--------------------------------------------------------------------------------------------------
  //--------------------------------------------------------------------------------------------------
  virtual const SEActionManager& GetActionManager() const = 0;
 
  //--------------------------------------------------------------------------------------------------
  //--------------------------------------------------------------------------------------------------
  virtual const SESubstanceManager& GetSubstanceManager() const = 0;
 
  //--------------------------------------------------------------------------------------------------
  //--------------------------------------------------------------------------------------------------
  virtual const SEEventManager& GetEventManager() const = 0;
 
  //--------------------------------------------------------------------------------------------------
  //--------------------------------------------------------------------------------------------------
  virtual const SEPatient& GetPatient() const = 0;
 
  //--------------------------------------------------------------------------------------------------
  //--------------------------------------------------------------------------------------------------
  virtual const SEPatient& GetInitialPatient() const = 0;
 
  //--------------------------------------------------------------------------------------------------
  //--------------------------------------------------------------------------------------------------
  virtual bool GetPatientAssessment(SEPatientAssessment& assessment) const = 0;
 
  //--------------------------------------------------------------------------------------------------
  //--------------------------------------------------------------------------------------------------
  virtual const SEEnvironment* GetEnvironment() const = 0;
 
  //--------------------------------------------------------------------------------------------------
  //--------------------------------------------------------------------------------------------------
  virtual const SEBloodChemistrySystem* GetBloodChemistrySystem() const = 0;
 
  //--------------------------------------------------------------------------------------------------
  //--------------------------------------------------------------------------------------------------
  virtual const SECardiovascularSystem* GetCardiovascularSystem() const = 0;
 
  //--------------------------------------------------------------------------------------------------
  //--------------------------------------------------------------------------------------------------
  virtual const SEDrugSystem* GetDrugSystem() const = 0;
 
  //--------------------------------------------------------------------------------------------------
  //--------------------------------------------------------------------------------------------------
  virtual const SEEndocrineSystem* GetEndocrineSystem() const = 0;
 
  //--------------------------------------------------------------------------------------------------
  //--------------------------------------------------------------------------------------------------
  virtual const SEEnergySystem* GetEnergySystem() const = 0;
 
  //--------------------------------------------------------------------------------------------------
  //--------------------------------------------------------------------------------------------------
  virtual const SEGastrointestinalSystem* GetGastrointestinalSystem() const = 0;
 
  //--------------------------------------------------------------------------------------------------
  //--------------------------------------------------------------------------------------------------
  virtual const SEHepaticSystem* GetHepaticSystem() const = 0;
 
  //--------------------------------------------------------------------------------------------------
  //--------------------------------------------------------------------------------------------------
  virtual const SENervousSystem* GetNervousSystem() const = 0;
 
  //--------------------------------------------------------------------------------------------------
  //--------------------------------------------------------------------------------------------------
  virtual const SERenalSystem* GetRenalSystem() const = 0;
 
  //--------------------------------------------------------------------------------------------------
  //--------------------------------------------------------------------------------------------------
  virtual const SERespiratorySystem* GetRespiratorySystem() const = 0;
 
  //--------------------------------------------------------------------------------------------------
  //--------------------------------------------------------------------------------------------------
  virtual const SETissueSystem* GetTissueSystem() const = 0;
 
  //--------------------------------------------------------------------------------------------------
  //--------------------------------------------------------------------------------------------------
  virtual const SEAnesthesiaMachine* GetAnesthesiaMachine() const = 0;
 
  //--------------------------------------------------------------------------------------------------
  //--------------------------------------------------------------------------------------------------
  virtual const SEBagValveMask* GetBagValveMask() const = 0;
 
  //--------------------------------------------------------------------------------------------------
 //--------------------------------------------------------------------------------------------------
  virtual const SEExtracorporealMembraneOxygenationDevice* GetExtracorporealMembraneOxygenationDevice() const = 0;
 
  //--------------------------------------------------------------------------------------------------
  //--------------------------------------------------------------------------------------------------
  virtual const SEElectroCardioGram* GetElectroCardioGram() const = 0;
 
  //--------------------------------------------------------------------------------------------------
  //--------------------------------------------------------------------------------------------------
  virtual const SEInhaler* GetInhaler() const = 0;
 
  //--------------------------------------------------------------------------------------------------
  //--------------------------------------------------------------------------------------------------
  virtual const SEMechanicalVentilator* GetMechanicalVentilator() const = 0;
 
  //--------------------------------------------------------------------------------------------------
  //--------------------------------------------------------------------------------------------------
  virtual const SECompartmentManager& GetCompartments() const = 0;
 
  //--------------------------------------------------------------------------------------------------
  //--------------------------------------------------------------------------------------------------
  virtual SEBlackBoxManager& GetBlackBoxes() const = 0;
};