#include <SEForcedInhale.h>

Inherits SEConsciousRespirationCommand.

Public Member Functions

virtual ~SEForcedInhale ()
 
std::string GetName () const override
 
void Clear () override
 
void Copy (const SEForcedInhale &src)
 
bool IsValid () const override
 
bool IsActive () const override
 
virtual bool HasInspiratoryCapacityFraction () const
 
virtual SEScalar0To1GetInspiratoryCapacityFraction ()
 
virtual double GetInspiratoryCapacityFraction () const
 
virtual bool HasInhalePeriod () const
 
virtual SEScalarTimeGetInhalePeriod ()
 
virtual double GetInhalePeriod (const TimeUnit &unit) const
 
virtual bool HasHoldPeriod () const
 
virtual SEScalarTimeGetHoldPeriod ()
 
virtual double GetHoldPeriod (const TimeUnit &unit) const
 
virtual bool HasReleasePeriod () const
 
virtual SEScalarTimeGetReleasePeriod ()
 
virtual double GetReleasePeriod (const TimeUnit &unit) const
 
- Public Member Functions inherited from SEConsciousRespirationCommand
 SEConsciousRespirationCommand (Logger *logger)
 
virtual ~SEConsciousRespirationCommand ()
 
virtual std::string GetActionType () const
 
virtual std::string GetName () const =0
 
virtual void Clear ()
 
virtual bool IsValid () const
 
virtual bool IsActive () const
 
virtual std::string GetComment () const
 
virtual void SetComment (const std::string &comment)
 
virtual bool HasComment () const
 
virtual void InvalidateComment ()
 
- Public Member Functions inherited from Loggable
 Loggable (Logger *logger=nullptr)
 
 Loggable (std::string const &logfile)
 
virtual ~Loggable ()
 
virtual LoggerGetLogger () const
 
virtual void SetLogger (Logger &logger)
 
virtual void Debug (std::string const &msg) const
 
virtual void Debug (std::stringstream &msg) const
 
virtual void Debug (std::ostream &msg) const
 
virtual void Info (std::string const &msg) const
 
virtual void Info (std::stringstream &msg) const
 
virtual void Info (const std::stringstream &msg) const
 
virtual void Info (std::ostream &msg) const
 
virtual void Warning (std::string const &msg) const
 
virtual void Warning (std::stringstream &msg) const
 
virtual void Warning (std::ostream &msg) const
 
virtual void Error (std::string const &msg) const
 
virtual void Error (std::stringstream &msg) const
 
virtual void Error (std::ostream &msg) const
 
virtual void Fatal (std::string const &msg) const
 
virtual void Fatal (std::stringstream &msg) const
 
virtual void Fatal (std::ostream &msg) const
 

Static Public Attributes

static constexpr char const * Name = "Forced Inhale"
 
- Static Public Attributes inherited from SEConsciousRespirationCommand
static constexpr char const * ActionType = "Conscious Respiration Command"
 

Protected Attributes

SEScalar0To1m_InspiratoryCapacityFraction
 
SEScalarTimem_InhalePeriod
 
SEScalarTimem_HoldPeriod
 
SEScalarTimem_ReleasePeriod
 
- Protected Attributes inherited from SEConsciousRespirationCommand
std::string m_Comment
 
- Protected Attributes inherited from Loggable
bool myLogger
 
Loggerm_Logger
 

Private Member Functions

 SEForcedInhale (Logger *logger)
 

Friends

class PBPatientAction
 
class SEConsciousRespiration
 

Constructor & Destructor Documentation

◆ SEForcedInhale()

SEForcedInhale::SEForcedInhale ( Logger logger)
private

◆ ~SEForcedInhale()

SEForcedInhale::~SEForcedInhale ( )
virtual

Member Function Documentation

◆ Clear()

void SEForcedInhale::Clear ( )
overridevirtual

Reimplemented from SEConsciousRespirationCommand.

◆ Copy()

void SEForcedInhale::Copy ( const SEForcedInhale src)

◆ GetHoldPeriod() [1/2]

SEScalarTime & SEForcedInhale::GetHoldPeriod ( )
virtual

◆ GetHoldPeriod() [2/2]

double SEForcedInhale::GetHoldPeriod ( const TimeUnit unit) const
virtual

◆ GetInhalePeriod() [1/2]

SEScalarTime & SEForcedInhale::GetInhalePeriod ( )
virtual

◆ GetInhalePeriod() [2/2]

double SEForcedInhale::GetInhalePeriod ( const TimeUnit unit) const
virtual

◆ GetInspiratoryCapacityFraction() [1/2]

SEScalar0To1 & SEForcedInhale::GetInspiratoryCapacityFraction ( )
virtual

◆ GetInspiratoryCapacityFraction() [2/2]

double SEForcedInhale::GetInspiratoryCapacityFraction ( ) const
virtual

◆ GetName()

std::string SEForcedInhale::GetName ( ) const
inlineoverridevirtual

◆ GetReleasePeriod() [1/2]

SEScalarTime & SEForcedInhale::GetReleasePeriod ( )
virtual

◆ GetReleasePeriod() [2/2]

double SEForcedInhale::GetReleasePeriod ( const TimeUnit unit) const
virtual

◆ HasHoldPeriod()

bool SEForcedInhale::HasHoldPeriod ( ) const
virtual

◆ HasInhalePeriod()

bool SEForcedInhale::HasInhalePeriod ( ) const
virtual

◆ HasInspiratoryCapacityFraction()

bool SEForcedInhale::HasInspiratoryCapacityFraction ( ) const
virtual

◆ HasReleasePeriod()

bool SEForcedInhale::HasReleasePeriod ( ) const
virtual

◆ IsActive()

bool SEForcedInhale::IsActive ( ) const
overridevirtual

Reimplemented from SEConsciousRespirationCommand.

◆ IsValid()

bool SEForcedInhale::IsValid ( ) const
overridevirtual

Reimplemented from SEConsciousRespirationCommand.

Friends And Related Function Documentation

◆ PBPatientAction

friend class PBPatientAction
friend

◆ SEConsciousRespiration

friend class SEConsciousRespiration
friend

Member Data Documentation

◆ m_HoldPeriod

SEScalarTime* SEForcedInhale::m_HoldPeriod
protected

◆ m_InhalePeriod

SEScalarTime* SEForcedInhale::m_InhalePeriod
protected

◆ m_InspiratoryCapacityFraction

SEScalar0To1* SEForcedInhale::m_InspiratoryCapacityFraction
protected

◆ m_ReleasePeriod

SEScalarTime* SEForcedInhale::m_ReleasePeriod
protected

◆ Name

constexpr char const* SEForcedInhale::Name = "Forced Inhale"
staticconstexpr

Distributed under the Apache License, Version 2.0.

See accompanying NOTICE file for details.