SESubstanceCompoundInfusion Class Reference

#include <SESubstanceCompoundInfusion.h>

Inherits SEPatientAction.

Public Member Functions

 SESubstanceCompoundInfusion (const SESubstanceCompound &compound, Logger *logger=nullptr)
 
virtual ~SESubstanceCompoundInfusion ()
 
virtual void Clear ()
 
virtual void Copy (const SESubstanceCompoundInfusion &src, bool=false)
 
virtual bool IsValid () const
 
virtual bool IsActive () const
 
virtual void Deactivate ()
 
virtual bool HasBagVolume () const
 
virtual SEScalarVolumeGetBagVolume ()
 
virtual double GetBagVolume (const VolumeUnit &unit) const
 
virtual bool HasRate () const
 
virtual SEScalarVolumePerTimeGetRate ()
 
virtual double GetRate (const VolumePerTimeUnit &unit) const
 
virtual SESubstanceCompoundGetSubstanceCompound ()
 
virtual const SESubstanceCompoundGetSubstanceCompound () 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

SEScalarVolumem_BagVolume
 
SEScalarVolumePerTimem_Rate
 
const SESubstanceCompoundm_Compound
 
- 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

◆ SESubstanceCompoundInfusion()

SESubstanceCompoundInfusion::SESubstanceCompoundInfusion ( const SESubstanceCompound compound,
Logger logger = nullptr 
)

◆ ~SESubstanceCompoundInfusion()

SESubstanceCompoundInfusion::~SESubstanceCompoundInfusion ( )
virtual

Member Function Documentation

◆ Clear()

void SESubstanceCompoundInfusion::Clear ( )
virtual

Reimplemented from SEPatientAction.

◆ Copy()

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

◆ Deactivate()

void SESubstanceCompoundInfusion::Deactivate ( )
virtual

Reimplemented from SEAction.

◆ GetBagVolume() [1/2]

SEScalarVolume & SESubstanceCompoundInfusion::GetBagVolume ( )
virtual

◆ GetBagVolume() [2/2]

double SESubstanceCompoundInfusion::GetBagVolume ( const VolumeUnit unit) const
virtual

◆ GetRate() [1/2]

SEScalarVolumePerTime & SESubstanceCompoundInfusion::GetRate ( )
virtual

◆ GetRate() [2/2]

double SESubstanceCompoundInfusion::GetRate ( const VolumePerTimeUnit unit) const
virtual

◆ GetScalar()

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

Implements SEAction.

◆ GetSubstanceCompound() [1/2]

SESubstanceCompound & SESubstanceCompoundInfusion::GetSubstanceCompound ( )
virtual

◆ GetSubstanceCompound() [2/2]

const SESubstanceCompound & SESubstanceCompoundInfusion::GetSubstanceCompound ( ) const
virtual

◆ HasBagVolume()

bool SESubstanceCompoundInfusion::HasBagVolume ( ) const
virtual

◆ HasRate()

bool SESubstanceCompoundInfusion::HasRate ( ) const
virtual

◆ IsActive()

bool SESubstanceCompoundInfusion::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 SESubstanceCompoundInfusion::IsValid ( ) const
virtual

Test if the action has all data it needs

Reimplemented from SEPatientAction.

◆ ToString()

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

Implements SEPatientAction.

Friends And Related Function Documentation

◆ PBPatientAction

friend class PBPatientAction
friend

Member Data Documentation

◆ m_BagVolume

SEScalarVolume* SESubstanceCompoundInfusion::m_BagVolume
protected

◆ m_Compound

const SESubstanceCompound& SESubstanceCompoundInfusion::m_Compound
protected

◆ m_Rate

SEScalarVolumePerTime* SESubstanceCompoundInfusion::m_Rate
protected

Distributed under the Apache License, Version 2.0.

See accompanying NOTICE file for details.