SEExtracorporealMembraneOxygenationDeviceSettings.h

/* Distributed under the Apache License, Version 2.0.
   See accompanying NOTICE file for details.*/
 
#pragma once
#include "cdm/CommonDefs.h"
#include "cdm/substance/SESubstanceManager.h"
#include "cdm/properties/SEScalar.h"
#include "cdm/properties/SEScalarVolumePerTime.h"
#include "cdm/properties/SEScalarVolume.h"
#include "cdm/properties/SEScalarPressureTimePerVolume.h"
#include "cdm/properties/SEScalarVolumePerTimePressure.h"
#include "cdm/properties/SEScalar0To1.h"
#include "cdm/properties/SEScalarPressure.h"
#include "cdm/engine/SEAction.h"
 
class SEExtracorporealMembraneOxygenationDeviceConfiguration;
 
// Keep enums in sync with appropriate schema/cdm/ExtracorporealMembraneOxygenationDevice.proto file !!
enum class eExtracorporealMembraneOxygenationDevice_CannulationLocation { NullCannulationLocation=0,
                                                                          InternalJugular,
                                                                          RightFemoralVein,
                                                                          LeftFemoralVein,
                                                                          RightSubclavianVein,
                                                                          LeftSubclavianVein,
                                                                          RightFemoralArtery,
                                                                          LeftFemoralArtery,
                                                                          RightAxillaryArtery,
                                                                          LeftAxillaryArtery,
                                                                          CarotidArtery,
                                                                          RightAtrium,
                                                                          AscendingAorta,
                                                                          SuperiorVenaCava,
                                                                          InferiorVenaCava};
extern CDM_DECL const std::string& eExtracorporealMembraneOxygenationDevice_CannulationLocation_Name(eExtracorporealMembraneOxygenationDevice_CannulationLocation m);
 
class CDM_DECL SEExtracorporealMembraneOxygenationDeviceSettings : public Loggable
{
  friend class PBExtracorporealMembraneOxygenationDevice;//friend the serialization class
public:
 
  SEExtracorporealMembraneOxygenationDeviceSettings(Logger* logger);
  virtual ~SEExtracorporealMembraneOxygenationDeviceSettings();
 
  virtual void Clear();
 
  bool SerializeToString(std::string& output, eSerializationFormat m) const;
  bool SerializeToFile(const std::string& filename) const;
  bool SerializeFromString(const std::string& src, eSerializationFormat m, const SESubstanceManager& subMgr);
  bool SerializeFromFile(const std::string& filename, const SESubstanceManager& subMgr);
 
  virtual void Merge(const SEExtracorporealMembraneOxygenationDeviceSettings& from);
  virtual void ProcessConfiguration(SEExtracorporealMembraneOxygenationDeviceConfiguration& config, SESubstanceManager& subMgr);
 
  virtual const SEScalar* GetScalar(const std::string& name);
 
  virtual bool HasInletLocation() const;
  virtual eExtracorporealMembraneOxygenationDevice_CannulationLocation GetInletLocation() const;
  virtual void SetInletLocation(eExtracorporealMembraneOxygenationDevice_CannulationLocation c);
 
  virtual bool HasOutletLocation() const;
  virtual eExtracorporealMembraneOxygenationDevice_CannulationLocation GetOutletLocation() const;
  virtual void SetOutletLocation(eExtracorporealMembraneOxygenationDevice_CannulationLocation c);
 
  // Pump
  virtual bool HasPumpFlow() const;
  virtual SEScalarVolumePerTime& GetPumpFlow();
  virtual double GetPumpFlow(const VolumePerTimeUnit& unit) const;
 
  // Oxygenator
  virtual bool HasCarbonDioxideRate() const;
  virtual SEScalarVolumePerTime& GetCarbonDioxideRate();
  virtual double GetCarbonDioxideRate(const VolumePerTimeUnit& unit) const;
 
  virtual bool HasOxygenRate() const;
  virtual SEScalarVolumePerTime& GetOxygenRate();
  virtual double GetOxygenRate(const VolumePerTimeUnit& unit) const;
 
  // Oxygenator Diffusing Parameters
  virtual bool HasCarbonDioxideMembraneDiffusingCapacity() const;
  virtual SEScalarVolumePerTimePressure& GetCarbonDioxideMembraneDiffusingCapacity();
  virtual double GetCarbonDioxideMembraneDiffusingCapacity(const VolumePerTimePressureUnit& unit) const;
 
  virtual bool HasFractionOfSweepGasOxygen() const;
  virtual SEScalar0To1& GetFractionOfSweepGasOxygen();
  virtual double GetFractionOfSweepGasOxygen() const;
 
  virtual bool HasOxygenMembraneDiffusingCapacity() const;
  virtual SEScalarVolumePerTimePressure& GetOxygenMembraneDiffusingCapacity();
  virtual double GetOxygenMembraneDiffusingCapacity(const VolumePerTimePressureUnit& unit) const;
 
  virtual bool HasSweepGasPressure() const;
  virtual SEScalarPressure& GetSweepGasPressure();
  virtual double GetSweepGasPressure(const PressureUnit& unit) const;
 
  virtual bool HasSweepGasFlow() const;
  virtual SEScalarVolumePerTime& GetSweepGasFlow();
  virtual double GetSweepGasFlow(const VolumePerTimeUnit& unit) const;
 
  // Fluid Administration
  virtual bool HasBagCompound() const;
  virtual void SetBagCompound(const SESubstanceCompound& c);
  virtual const SESubstanceCompound* GetBagCompound() const;
  virtual void RemoveBagCompound();
 
  virtual bool HasBagVolume() const;
  virtual SEScalarVolume& GetBagVolume();
  virtual double GetBagVolume(const VolumeUnit& unit) const;
 
  virtual bool HasInfuserRate() const;
  virtual SEScalarVolumePerTime& GetInfuserRate();
  virtual double GetInfuserRate(const VolumePerTimeUnit& unit) const;
 
  // Volumes
  virtual bool HasDrainageCannulaVolume() const;
  virtual SEScalarVolume& GetDrainageCannulaVolume();
  virtual double GetDrainageCannulaVolume(const VolumeUnit& unit) const;
 
  virtual bool HasDrainageLimbVolume() const;
  virtual SEScalarVolume& GetDrainageLimbVolume();
  virtual double GetDrainageLimbVolume(const VolumeUnit& unit) const;
 
  virtual bool HasInfuserVolume() const;
  virtual SEScalarVolume& GetInfuserVolume();
  virtual double GetInfuserVolume(const VolumeUnit& unit) const;
 
  virtual bool HasInletProbeVolume() const;
  virtual SEScalarVolume& GetInletProbeVolume();
  virtual double GetInletProbeVolume(const VolumeUnit& unit) const;
 
  virtual bool HasOutletProbeVolume() const;
  virtual SEScalarVolume& GetOutletProbeVolume();
  virtual double GetOutletProbeVolume(const VolumeUnit& unit) const;
 
  virtual bool HasOxygenatorLiquidVolume() const;
  virtual SEScalarVolume& GetOxygenatorLiquidVolume();
  virtual double GetOxygenatorLiquidVolume(const VolumeUnit& unit) const;
 
  virtual bool HasPumpVolume() const;
  virtual SEScalarVolume& GetPumpVolume();
  virtual double GetPumpVolume(const VolumeUnit& unit) const;
 
  virtual bool HasReturnCannulaVolume() const;
  virtual SEScalarVolume& GetReturnCannulaVolume();
  virtual double GetReturnCannulaVolume(const VolumeUnit& unit) const;
 
  virtual bool HasReturnLimbVolume() const;
  virtual SEScalarVolume& GetReturnLimbVolume();
  virtual double GetReturnLimbVolume(const VolumeUnit& unit) const;
 
  // Gas Volumes
  virtual bool HasOxygenatorGasVolume() const;
  virtual SEScalarVolume& GetOxygenatorGasVolume();
  virtual double GetOxygenatorGasVolume(const VolumeUnit& unit) const;
 
  // Resistances
  virtual bool HasDrainageCannulaResistance() const;
  virtual SEScalarPressureTimePerVolume& GetDrainageCannulaResistance();
  virtual double GetDrainageCannulaResistance(const PressureTimePerVolumeUnit& unit) const;
 
  virtual bool HasDrainageLimbResistance() const;
  virtual SEScalarPressureTimePerVolume& GetDrainageLimbResistance();
  virtual double GetDrainageLimbResistance(const PressureTimePerVolumeUnit& unit) const;
 
  virtual bool HasOxygenatorResistance() const;
  virtual SEScalarPressureTimePerVolume& GetOxygenatorResistance();
  virtual double GetOxygenatorResistance(const PressureTimePerVolumeUnit& unit) const;
 
  virtual bool HasReturnCannulaResistance() const;
  virtual SEScalarPressureTimePerVolume& GetReturnCannulaResistance();
  virtual double GetReturnCannulaResistance(const PressureTimePerVolumeUnit& unit) const;
 
  virtual bool HasReturnLimbResistance() const;
  virtual SEScalarPressureTimePerVolume& GetReturnLimbResistance();
  virtual double GetReturnLimbResistance(const PressureTimePerVolumeUnit& unit) const;
 
protected:
  eExtracorporealMembraneOxygenationDevice_CannulationLocation m_InletLocation;
  eExtracorporealMembraneOxygenationDevice_CannulationLocation m_OutletLocation;
  
  // Pump
  SEScalarVolumePerTime* m_PumpFlow;
  
  // Oxygenator
  SEScalarVolumePerTime* m_CarbonDioxideRate;
  SEScalarVolumePerTime* m_OxygenRate;
  
  // Oxygenator Diffusing Parameters
  SEScalarVolumePerTimePressure* m_CarbonDioxideMembraneDiffusingCapacity;
  SEScalar0To1* m_FractionOfSweepGasOxygen;
  SEScalarVolumePerTimePressure* m_OxygenMembraneDiffusingCapacity;
  SEScalarPressure* m_SweepGasPressure;
  SEScalarVolumePerTime* m_SweepGasFlow;
  
  // Fluid Administration
  const SESubstanceCompound* m_BagCompound;
  SEScalarVolume* m_BagVolume;
  SEScalarVolumePerTime* m_InfuserRate;
  
  // Volumes
  SEScalarVolume* m_DrainageCannulaVolume;
  SEScalarVolume* m_DrainageLimbVolume;
  SEScalarVolume* m_InfuserVolume;
  SEScalarVolume* m_InletProbeVolume;
  SEScalarVolume* m_OutletProbeVolume;
  SEScalarVolume* m_OxygenatorLiquidVolume;
  SEScalarVolume* m_PumpVolume;
  SEScalarVolume* m_ReturnCannulaVolume;
  SEScalarVolume* m_ReturnLimbVolume;
  
  // Gas Volumes
  SEScalarVolume* m_OxygenatorGasVolume;
  
  // Resistances
  SEScalarPressureTimePerVolume* m_DrainageCannulaResistance;
  SEScalarPressureTimePerVolume* m_DrainageLimbResistance;
  SEScalarPressureTimePerVolume* m_OxygenatorResistance;
  SEScalarPressureTimePerVolume* m_ReturnCannulaResistance;
  SEScalarPressureTimePerVolume* m_ReturnLimbResistance;
};