#include <SESubstanceBolus.h>

Inherits SEPatientAction.

Public Member Functions

 SESubstanceBolus (const SESubstance &substance, Logger *logger=nullptr)
 
virtual ~SESubstanceBolus ()
 
virtual void Clear ()
 
virtual void Copy (const SESubstanceBolus &src, bool=false)
 
virtual bool IsValid () const
 
virtual bool IsActive () const
 
virtual void Activate ()
 
virtual void Deactivate ()
 
virtual eSubstanceAdministration_Route GetAdminRoute () const
 
virtual void SetAdminRoute (eSubstanceAdministration_Route name)
 
virtual bool HasAdminDuration () const
 
virtual SEScalarTimeGetAdminDuration ()
 
virtual double GetAdminDuration (const TimeUnit &unit) const
 
virtual bool HasConcentration () const
 
virtual SEScalarMassPerVolumeGetConcentration ()
 
virtual double GetConcentration (const MassPerVolumeUnit &unit) const
 
virtual bool HasDose () const
 
virtual SEScalarVolumeGetDose ()
 
virtual double GetDose (const VolumeUnit &unit) const
 
virtual SESubstanceGetSubstance ()
 
virtual const SESubstanceGetSubstance () const
 
virtual void ToString (std::ostream &str) const
 
virtual const SEScalarGetScalar (const std::string &name)
 
virtual bool HasTotalInfusedDose () const
 
virtual SEScalarVolumeGetTotalInfusedDose ()
 
virtual double GetTotalInfusedDose (const VolumeUnit &unit) const
 
- 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 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

const SESubstancem_Substance
 
eSubstanceAdministration_Route m_AdminRoute
 
SEScalarTimem_AdminDuration
 
SEScalarMassPerVolumem_Concentration
 
SEScalarVolumem_Dose
 
SEScalarVolumem_TotalInfusedDose
 
- 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

◆ SESubstanceBolus()

SESubstanceBolus::SESubstanceBolus ( const SESubstance substance,
Logger logger = nullptr 
)

◆ ~SESubstanceBolus()

SESubstanceBolus::~SESubstanceBolus ( )
virtual

Member Function Documentation

◆ Activate()

void SESubstanceBolus::Activate ( )
virtual

Reimplemented from SEAction.

◆ Clear()

void SESubstanceBolus::Clear ( )
virtual

Reimplemented from SEPatientAction.

◆ Copy()

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

◆ Deactivate()

void SESubstanceBolus::Deactivate ( )
virtual

Reimplemented from SEAction.

◆ GetAdminDuration() [1/2]

SEScalarTime & SESubstanceBolus::GetAdminDuration ( )
virtual

◆ GetAdminDuration() [2/2]

double SESubstanceBolus::GetAdminDuration ( const TimeUnit unit) const
virtual

◆ GetAdminRoute()

eSubstanceAdministration_Route SESubstanceBolus::GetAdminRoute ( ) const
virtual

◆ GetConcentration() [1/2]

SEScalarMassPerVolume & SESubstanceBolus::GetConcentration ( )
virtual

◆ GetConcentration() [2/2]

double SESubstanceBolus::GetConcentration ( const MassPerVolumeUnit unit) const
virtual

◆ GetDose() [1/2]

SEScalarVolume & SESubstanceBolus::GetDose ( )
virtual

◆ GetDose() [2/2]

double SESubstanceBolus::GetDose ( const VolumeUnit unit) const
virtual

◆ GetScalar()

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

Implements SEAction.

◆ GetSubstance() [1/2]

SESubstance & SESubstanceBolus::GetSubstance ( )
virtual

◆ GetSubstance() [2/2]

const SESubstance & SESubstanceBolus::GetSubstance ( ) const
virtual

◆ GetTotalInfusedDose() [1/2]

SEScalarVolume & SESubstanceBolus::GetTotalInfusedDose ( )
virtual

◆ GetTotalInfusedDose() [2/2]

double SESubstanceBolus::GetTotalInfusedDose ( const VolumeUnit unit) const
virtual

◆ HasAdminDuration()

bool SESubstanceBolus::HasAdminDuration ( ) const
virtual

◆ HasConcentration()

bool SESubstanceBolus::HasConcentration ( ) const
virtual

◆ HasDose()

bool SESubstanceBolus::HasDose ( ) const
virtual

◆ HasTotalInfusedDose()

bool SESubstanceBolus::HasTotalInfusedDose ( ) const
virtual

◆ IsActive()

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

Test if the action has all data it needs

Reimplemented from SEPatientAction.

◆ SetAdminRoute()

void SESubstanceBolus::SetAdminRoute ( eSubstanceAdministration_Route  name)
virtual

◆ ToString()

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

Implements SEPatientAction.

Friends And Related Function Documentation

◆ PBPatientAction

friend class PBPatientAction
friend

Member Data Documentation

◆ m_AdminDuration

SEScalarTime* SESubstanceBolus::m_AdminDuration
protected

◆ m_AdminRoute

eSubstanceAdministration_Route SESubstanceBolus::m_AdminRoute
protected

◆ m_Concentration

SEScalarMassPerVolume* SESubstanceBolus::m_Concentration
protected

◆ m_Dose

SEScalarVolume* SESubstanceBolus::m_Dose
protected

◆ m_Substance

const SESubstance& SESubstanceBolus::m_Substance
protected

◆ m_TotalInfusedDose

SEScalarVolume* SESubstanceBolus::m_TotalInfusedDose
protected

Distributed under the Apache License, Version 2.0.

See accompanying NOTICE file for details.