SESubstanceBolus Class Reference

#include <SESubstanceBolus.h>

Inherits SEPatientAction.

Public Member Functions
	SESubstanceBolus (const SESubstance &substance, Logger *logger=nullptr)
virtual	~SESubstanceBolus ()
std::string	GetName () const override
void	Clear () override
void	Copy (const SESubstanceBolus &src, bool=false)
const SEScalar *	GetScalar (const std::string &name) override
bool	IsValid () const override
bool	IsActive () const override
void	Activate () override
void	Deactivate () override
virtual eSubstanceAdministration_Route	GetAdminRoute () const
virtual void	SetAdminRoute (eSubstanceAdministration_Route name)
virtual bool	HasAdminDuration () const
virtual SEScalarTime &	GetAdminDuration ()
virtual double	GetAdminDuration (const TimeUnit &unit) const
virtual bool	HasConcentration () const
virtual SEScalarMassPerVolume &	GetConcentration ()
virtual double	GetConcentration (const MassPerVolumeUnit &unit) const
virtual bool	HasDose () const
virtual SEScalarVolume &	GetDose ()
virtual double	GetDose (const VolumeUnit &unit) const
virtual SESubstance &	GetSubstance ()
virtual const SESubstance &	GetSubstance () const
virtual bool	HasTotalInfusedDose () const
virtual SEScalarVolume &	GetTotalInfusedDose ()
virtual double	GetTotalInfusedDose (const VolumeUnit &unit) const
Public Member Functions inherited from SEPatientAction
	SEPatientAction (Logger *logger=nullptr)
virtual	~SEPatientAction ()
std::string	GetActionType () const override
void	Clear () override
bool	IsValid () const override
void	Activate () override
bool	IsActive () const override
void	Deactivate () override
Public Member Functions inherited from SEAction
	SEAction (Logger *logger)
virtual	~SEAction ()
	SEAction (const SEAction &)=delete
SEAction &	operator= (const SEAction &)=delete
virtual std::string	GetName () const =0
virtual std::string	GetActionType () const
virtual void	Clear ()
virtual bool	SerializeToString (std::string &dst, eSerializationFormat fmt) const
virtual bool	IsValid () const
virtual void	Activate ()
virtual bool	IsActive () const
virtual void	Deactivate ()
virtual std::string	GetComment () const
virtual void	SetComment (const std::string &comment)
virtual bool	HasComment () const
virtual void	InvalidateComment ()
virtual const SEScalar *	GetScalar (const std::string &name)=0
virtual std::string	ToJSON () const
virtual std::string	ToString () const
Public Member Functions inherited from Loggable
	Loggable (Logger *logger=nullptr)
	Loggable (std::string const &logfile)
virtual	~Loggable ()
virtual Logger *	GetLogger () 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 = "Substance Bolus"
Static Public Attributes inherited from SEPatientAction
static constexpr char const *	ActionType = "Patient"
Static Public Attributes inherited from SEAction
static constexpr char const *	ActionType = "Action"

Protected Attributes
const SESubstance &	m_Substance
eSubstanceAdministration_Route	m_AdminRoute
SEScalarTime *	m_AdminDuration
SEScalarMassPerVolume *	m_Concentration
SEScalarVolume *	m_Dose
SEScalarVolume *	m_TotalInfusedDose
Protected Attributes inherited from SEAction
bool	m_Active = true
std::string	m_Comment
Protected Attributes inherited from Loggable
bool	myLogger
Logger *	m_Logger

Friends
class	PBPatientAction

Additional Inherited Members
Static Public Member Functions inherited from SEAction
static SEAction *	Copy (const SEAction &, const SESubstanceManager &)
static SEAction *	SerializeFromString (const std::string, eSerializationFormat fmt, const SESubstanceManager &)
static std::string	PrettyPrint (const std::string &str)

Constructor & Destructor Documentation

SESubstanceBolus()

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

~SESubstanceBolus()

SESubstanceBolus::~SESubstanceBolus ( )

virtual

Member Function Documentation

Activate()

void SESubstanceBolus::Activate ( )

overridevirtual

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

Reimplemented from SEPatientAction.

Clear()

void SESubstanceBolus::Clear ( )

overridevirtual

Reimplemented from SEPatientAction.

Copy()

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

Deactivate()

void SESubstanceBolus::Deactivate ( )

overridevirtual

Reimplemented from SEPatientAction.

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

GetName()

std::string SESubstanceBolus::GetName ( ) const

inlineoverridevirtual

Implements SEAction.

GetScalar()

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

overridevirtual

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

overridevirtual

Reimplemented from SEPatientAction.

IsValid()

bool SESubstanceBolus::IsValid ( ) const

overridevirtual

Test if the action has all data it needs

Reimplemented from SEPatientAction.

SetAdminRoute()

void SESubstanceBolus::SetAdminRoute ( eSubstanceAdministration_Route  name )

virtual

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

Name

constexpr char const* SESubstanceBolus::Name = "Substance Bolus"

staticconstexpr