SEForcedInhale.h

/* Distributed under the Apache License, Version 2.0.
   See accompanying NOTICE file for details.*/
 
#pragma once
#include "cdm/patient/actions/SEConsciousRespirationCommand.h"
 
class CDM_DECL SEForcedInhale : public SEConsciousRespirationCommand
{
  friend class PBPatientAction;//friend the serialization class
  friend class SEConsciousRespiration;
  SEForcedInhale(Logger* logger);
public:
 
  virtual ~SEForcedInhale();
 
  static constexpr char const* Name = "Forced Inhale";
  virtual std::string GetName() const { return Name; }
 
  virtual void Clear(); //clear memory
  virtual void Copy(const SEForcedInhale& src);
 
  virtual bool IsValid() const;
  virtual bool IsActive() const;
 
  virtual bool HasInspiratoryCapacityFraction() const;
  virtual SEScalar0To1& GetInspiratoryCapacityFraction();
  virtual double GetInspiratoryCapacityFraction() const;
 
  virtual bool HasInhalePeriod() const;
  virtual SEScalarTime& GetInhalePeriod();
  virtual double GetInhalePeriod(const TimeUnit& unit) const;
 
  virtual bool HasHoldPeriod() const;
  virtual SEScalarTime& GetHoldPeriod();
  virtual double GetHoldPeriod(const TimeUnit& unit) const;
 
  virtual bool HasReleasePeriod() const;
  virtual SEScalarTime& GetReleasePeriod();
  virtual double GetReleasePeriod(const TimeUnit& unit) const;
 
protected:
  SEScalar0To1* m_InspiratoryCapacityFraction;
  SEScalarTime* m_InhalePeriod;
  SEScalarTime* m_HoldPeriod;
  SEScalarTime* m_ReleasePeriod;
};