PhysiologyEngine.h

/**************************************************************************************
Copyright 2015 Applied Research Associates, Inc.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use
this file except in compliance with the License. You may obtain a copy of the License
at:
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under
the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
CONDITIONS OF ANY KIND, either express or implied. See the License for the
specific language governing permissions and limitations under the License.
**************************************************************************************/

#pragma once

#include <biogears/cdm/CommonDataModel.h>
#include <biogears/cdm/properties/SEScalarTime.h>
#include <biogears/exports.h>
#include <biogears/schema/cdm/EngineState.hxx>
#include <biogears/container/Tree.h>

namespace biogears {
class SEEventHandler;
class SEPatient;
class SEPatientAssessment;
class SECondition;
class SEAction;
class TimeUnit;
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 SEInhaler;
class SEElectroCardioGram;
class SECompartmentManager;
class PhysiologyEngineTrack;
class PhysiologyEngineConfiguration;

struct PhysiologyEngineException : public CommonDataModelException {
  PhysiologyEngineException()
    : CommonDataModelException("Physiology Engine Error")
  {
  }
  PhysiologyEngineException(const char* _Message)
    : CommonDataModelException(_Message)
  {
    
  }
  PhysiologyEngineException(const std::string& _Message)
    : CommonDataModelException(_Message)
  {
  }
};

class BIOGEARS_API PhysiologyEngine {
public:
  virtual ~PhysiologyEngine() {}

  virtual bool LoadState(const char* file, const SEScalarTime* simTime = nullptr) = 0;
  virtual bool LoadState(const std::string& file, const SEScalarTime* simTime = nullptr) = 0;

  virtual bool LoadState(const CDM::PhysiologyEngineStateData& state, const SEScalarTime* simTime = nullptr) = 0;

  virtual std::unique_ptr<CDM::PhysiologyEngineStateData> SaveState(const char* file = "") = 0;
  virtual std::unique_ptr<CDM::PhysiologyEngineStateData> SaveState(const std::string& file = "") = 0;

  virtual bool InitializeEngine(const char* patientFile, const std::vector<const SECondition*>* conditions = nullptr, const PhysiologyEngineConfiguration* config = nullptr) = 0;
  virtual bool InitializeEngine(const std::string& patientFile, const std::vector<const SECondition*>* conditions = nullptr, const PhysiologyEngineConfiguration* config = nullptr) = 0;

  virtual bool InitializeEngine(const SEPatient& patient, const std::vector<const SECondition*>* conditions = nullptr, const PhysiologyEngineConfiguration* config = nullptr) = 0;

  virtual Logger* GetLogger() = 0;

  virtual PhysiologyEngineTrack* GetEngineTrack() = 0;

  virtual const PhysiologyEngineConfiguration* GetConfiguration() = 0;

  virtual double GetTimeStep(const TimeUnit& unit) = 0;

  virtual double GetSimulationTime(const TimeUnit& unit) = 0;

  virtual void AdvanceModelTime(bool appendDataTrack = false) = 0;

  virtual void AdvanceModelTime(double time, const TimeUnit& unit  = TimeUnit::s, bool appendDataTrack = false) = 0;

  virtual bool ProcessAction(const SEAction& action) = 0;

  virtual SESubstanceManager& GetSubstanceManager() = 0;

  virtual void SetEventHandler(SEEventHandler* handler) = 0;

  virtual const SEPatient& GetPatient() = 0;

  virtual bool GetPatientAssessment(SEPatientAssessment& assessment) = 0;

  virtual const SEEnvironment* GetEnvironment() = 0;

  virtual const SEBloodChemistrySystem* GetBloodChemistrySystem() = 0;

  virtual const SECardiovascularSystem* GetCardiovascularSystem() = 0;

  virtual const SEDrugSystem* GetDrugSystem() = 0;

  virtual const SEEndocrineSystem* GetEndocrineSystem() = 0;

  virtual const SEEnergySystem* GetEnergySystem() = 0;

  virtual const SEGastrointestinalSystem* GetGastrointestinalSystem() = 0;

  virtual const SEHepaticSystem* GetHepaticSystem() = 0;

  virtual const SENervousSystem* GetNervousSystem() = 0;

  virtual const SERenalSystem* GetRenalSystem() = 0;

  virtual const SERespiratorySystem* GetRespiratorySystem() = 0;

  virtual const SETissueSystem* GetTissueSystem() = 0;

  virtual const SEAnesthesiaMachine* GetAnesthesiaMachine() = 0;

  virtual const SEElectroCardioGram* GetElectroCardioGram() = 0;

  virtual const SEInhaler* GetInhaler() = 0;

  virtual const SECompartmentManager& GetCompartments() = 0;
  virtual Tree<const char*> GetDataRequestGraph() const = 0;

  virtual bool IsAutoTracking() const = 0;
  virtual void SetAutoTrackFlag(bool flag) = 0;
  virtual bool IsTrackingStabilization() const = 0;
  virtual void SetTrackStabilizationFlag(bool flag) = 0;
};
}