SESupplementalOxygen Class Reference

#include <SESupplementalOxygen.h>

Inherits SEPatientAction.

Public Member Functions

 SESupplementalOxygen (Logger *logger=nullptr)
 
virtual ~SESupplementalOxygen ()
 
virtual void Clear ()
 
virtual void Copy (const SESupplementalOxygen &src, bool=false)
 
virtual bool IsValid () const
 
virtual bool IsActive () const
 
virtual void Deactivate ()
 
virtual eSupplementalOxygen_Device GetDevice () const
 
virtual void SetDevice (eSupplementalOxygen_Device name)
 
virtual bool HasFlow () const
 
virtual SEScalarVolumePerTimeGetFlow ()
 
virtual double GetFlow (const VolumePerTimeUnit &unit) const
 
virtual bool HasVolume () const
 
virtual SEScalarVolumeGetVolume ()
 
virtual double GetVolume (const VolumeUnit &unit) const
 
virtual void ToString (std::ostream &str) const
 
virtual const SEScalarGetScalar (const std::string &name)
 
- Public Member Functions inherited from SEPatientAction
 SEPatientAction (Logger *logger=nullptr)
 
virtual ~SEPatientAction ()
 
- Public Member Functions inherited from SEAction
 SEAction (Logger *logger)
 
virtual ~SEAction ()
 
 SEAction (const SEAction &)=delete
 
SEActionoperator= (const SEAction &)=delete
 
virtual void Activate ()
 
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, std::string const &origin=empty) const
 
virtual void Debug (std::stringstream &msg, std::string const &origin=empty) const
 
virtual void Debug (std::ostream &msg, std::string const &origin=empty) const
 
virtual void Info (std::string const &msg, std::string const &origin=empty) const
 
virtual void Info (std::stringstream &msg, std::string const &origin=empty) const
 
virtual void Info (const std::stringstream &msg, std::string const &origin=empty) const
 
virtual void Info (std::ostream &msg, std::string const &origin=empty) const
 
virtual void Warning (std::string const &msg, std::string const &origin=empty) const
 
virtual void Warning (std::stringstream &msg, std::string const &origin=empty) const
 
virtual void Warning (std::ostream &msg, std::string const &origin=empty) const
 
virtual void Error (std::string const &msg, std::string const &origin=empty) const
 
virtual void Error (std::stringstream &msg, std::string const &origin=empty) const
 
virtual void Error (std::ostream &msg, std::string const &origin=empty) const
 
virtual void Fatal (std::string const &msg, std::string const &origin=empty) const
 
virtual void Fatal (std::stringstream &msg, std::string const &origin=empty) const
 
virtual void Fatal (std::ostream &msg, std::string const &origin=empty) const
 

Protected Attributes

eSupplementalOxygen_Device m_Device
 
SEScalarVolumePerTimem_Flow
 
SEScalarVolumem_Volume
 
- Protected Attributes inherited from SEAction
bool m_Active = true
 
std::string m_Comment
 
- Protected Attributes inherited from Loggable
bool myLogger
 
Loggerm_Logger
 

Friends

class PBPatientAction
 

Additional Inherited Members

- Static Public Member Functions inherited from SEAction
static SEActionCopy (const SEAction &, const SESubstanceManager &)
 
- Static Public Attributes inherited from Loggable
static const std::string empty
 

Constructor & Destructor Documentation

◆ SESupplementalOxygen()

SESupplementalOxygen::SESupplementalOxygen ( Logger logger = nullptr)

◆ ~SESupplementalOxygen()

SESupplementalOxygen::~SESupplementalOxygen ( )
virtual

Member Function Documentation

◆ Clear()

void SESupplementalOxygen::Clear ( )
virtual

Reimplemented from SEPatientAction.

◆ Copy()

void SESupplementalOxygen::Copy ( const SESupplementalOxygen src,
bool  = false 
)
virtual

◆ Deactivate()

void SESupplementalOxygen::Deactivate ( )
virtual

Reimplemented from SEAction.

◆ GetDevice()

eSupplementalOxygen_Device SESupplementalOxygen::GetDevice ( ) const
virtual

◆ GetFlow() [1/2]

SEScalarVolumePerTime & SESupplementalOxygen::GetFlow ( )
virtual

◆ GetFlow() [2/2]

double SESupplementalOxygen::GetFlow ( const VolumePerTimeUnit unit) const
virtual

◆ GetScalar()

const SEScalar * SESupplementalOxygen::GetScalar ( const std::string &  name)
virtual

Implements SEAction.

◆ GetVolume() [1/2]

SEScalarVolume & SESupplementalOxygen::GetVolume ( )
virtual

◆ GetVolume() [2/2]

double SESupplementalOxygen::GetVolume ( const VolumeUnit unit) const
virtual

◆ HasFlow()

bool SESupplementalOxygen::HasFlow ( ) const
virtual

◆ HasVolume()

bool SESupplementalOxygen::HasVolume ( ) const
virtual

◆ IsActive()

bool SESupplementalOxygen::IsActive ( ) const
virtual

Actions can be turned off or on with various data combinations This method will encapsulate that logic in a single function

Reimplemented from SEAction.

◆ IsValid()

bool SESupplementalOxygen::IsValid ( ) const
virtual

Test if the action has all data it needs

Reimplemented from SEPatientAction.

◆ SetDevice()

void SESupplementalOxygen::SetDevice ( eSupplementalOxygen_Device  name)
virtual

◆ ToString()

void SESupplementalOxygen::ToString ( std::ostream &  str) const
virtual

Implements SEPatientAction.

Friends And Related Function Documentation

◆ PBPatientAction

friend class PBPatientAction
friend

Member Data Documentation

◆ m_Device

eSupplementalOxygen_Device SESupplementalOxygen::m_Device
protected

◆ m_Flow

SEScalarVolumePerTime* SESupplementalOxygen::m_Flow
protected

◆ m_Volume

SEScalarVolume* SESupplementalOxygen::m_Volume
protected

Distributed under the Apache License, Version 2.0.

See accompanying NOTICE file for details.