biogears::SESubstance Class Reference

#include <SESubstance.h>

Inheritance diagram for biogears::SESubstance:

Public Member Functions
	SESubstance (Logger *logger)
virtual	~SESubstance ()
virtual void	Clear ()
virtual const SEScalar *	GetScalar (const char *name)
virtual const SEScalar *	GetScalar (const std::string &name)
virtual bool	Load (const CDM::SubstanceData &in)
virtual CDM::SubstanceData *	Unload () const
virtual std::string	GetName () const
virtual const char *	GetName_cStr () const
virtual void	SetName (const char *name)
virtual void	SetName (const std::string &name)
virtual bool	HasName () const
virtual void	InvalidateName ()
virtual CDM::enumSubstanceState::value	GetState () const
virtual void	SetState (CDM::enumSubstanceState::value state)
virtual bool	HasState () const
virtual void	InvalidateState ()
virtual CDM::enumSubstanceClass::value	GetClassification () const
virtual void	SetClassification (CDM::enumSubstanceClass::value subClass)
virtual bool	HasClassification () const
virtual void	InvalidateClassification ()
virtual bool	HasDensity () const
virtual SEScalarMassPerVolume &	GetDensity ()
virtual double	GetDensity (const MassPerVolumeUnit &unit) const
virtual bool	HasMolarMass () const
virtual SEScalarMassPerAmount &	GetMolarMass ()
virtual double	GetMolarMass (const MassPerAmountUnit &unit) const
virtual bool	HasMaximumDiffusionFlux () const
virtual SEScalarMassPerAreaTime &	GetMaximumDiffusionFlux ()
virtual double	GetMaximumDiffusionFlux (const MassPerAreaTimeUnit &unit) const
virtual bool	HasMichaelisCoefficient () const
virtual SEScalar &	GetMichaelisCoefficient ()
virtual double	GetMichaelisCoefficient () const
virtual bool	HasMembraneResistance () const
virtual SEScalarElectricResistance &	GetMembraneResistance ()
virtual double	GetMembraneResistance (const ElectricResistanceUnit &unit) const
virtual bool	HasAerosolization () const
virtual SESubstanceAerosolization &	GetAerosolization ()
virtual const SESubstanceAerosolization *	GetAerosolization () const
virtual void	RemoveAerosolization ()
virtual bool	HasAreaUnderCurve () const
virtual SEScalarTimeMassPerVolume &	GetAreaUnderCurve ()
virtual double	GetAreaUnderCurve (const TimeMassPerVolumeUnit &unit) const
virtual bool	HasBloodConcentration () const
virtual SEScalarMassPerVolume &	GetBloodConcentration ()
virtual double	GetBloodConcentration (const MassPerVolumeUnit &unit) const
virtual bool	HasEffectSiteConcentration () const
virtual SEScalarMassPerVolume &	GetEffectSiteConcentration ()
virtual double	GetEffectSiteConcentration (const MassPerVolumeUnit &unit) const
virtual bool	HasMassInBody () const
virtual SEScalarMass &	GetMassInBody ()
virtual double	GetMassInBody (const MassUnit &unit) const
virtual bool	HasMassInBlood () const
virtual SEScalarMass &	GetMassInBlood ()
virtual double	GetMassInBlood (const MassUnit &unit) const
virtual bool	HasMassInTissue () const
virtual SEScalarMass &	GetMassInTissue ()
virtual double	GetMassInTissue (const MassUnit &unit) const
virtual bool	HasPlasmaConcentration () const
virtual SEScalarMassPerVolume &	GetPlasmaConcentration ()
virtual double	GetPlasmaConcentration (const MassPerVolumeUnit &unit) const
virtual bool	HasSystemicMassCleared () const
virtual SEScalarMass &	GetSystemicMassCleared ()
virtual double	GetSystemicMassCleared (const MassUnit &unit) const
virtual bool	HasTissueConcentration () const
virtual SEScalarMassPerVolume &	GetTissueConcentration ()
virtual double	GetTissueConcentration (const MassPerVolumeUnit &unit) const
virtual bool	HasAlveolarTransfer () const
virtual SEScalarVolumePerTime &	GetAlveolarTransfer ()
virtual double	GetAlveolarTransfer (const VolumePerTimeUnit &unit) const
virtual bool	HasDiffusingCapacity () const
virtual SEScalarVolumePerTimePressure &	GetDiffusingCapacity ()
virtual double	GetDiffusingCapacity (const VolumePerTimePressureUnit &unit) const
virtual bool	HasEndTidalFraction () const
virtual SEScalarFraction &	GetEndTidalFraction ()
virtual double	GetEndTidalFraction () const
virtual bool	HasEndTidalPressure () const
virtual SEScalarPressure &	GetEndTidalPressure ()
virtual double	GetEndTidalPressure (const PressureUnit &unit) const
virtual bool	HasRelativeDiffusionCoefficient () const
virtual SEScalar &	GetRelativeDiffusionCoefficient ()
virtual double	GetRelativeDiffusionCoefficient () const
virtual bool	HasSolubilityCoefficient () const
virtual SEScalarInversePressure &	GetSolubilityCoefficient ()
virtual double	GetSolubilityCoefficient (const InversePressureUnit &unit) const
virtual bool	HasClearance () const
virtual SESubstanceClearance &	GetClearance ()
virtual const SESubstanceClearance *	GetClearance () const
virtual void	RemoveClearance ()
virtual bool	HasPK () const
virtual SESubstancePharmacokinetics &	GetPK ()
virtual const SESubstancePharmacokinetics *	GetPK () const
virtual void	RemovePK ()
virtual bool	HasPD () const
virtual SESubstancePharmacodynamics &	GetPD ()
virtual const SESubstancePharmacodynamics *	GetPD () const
virtual void	RemovePD ()
Public Member Functions inherited from biogears::Loggable
	Loggable ()
	Loggable (Logger *log)
virtual	~Loggable ()
virtual Logger *	GetLogger () const

Protected Member Functions
virtual void	Unload (CDM::SubstanceData &data) const
Protected Member Functions inherited from biogears::Loggable
virtual void	Debug (const char *msg, const char *origin="") const
virtual void	Debug (const std::string &msg, const std::string &origin=empty) const
virtual void	Debug (std::ostream &msg, const std::string &origin=empty) const
virtual void	Info (const char *msg, const char *origin="") const
virtual void	Info (const std::string &msg, const std::string &origin=empty) const
virtual void	Info (std::ostream &msg, const std::string &origin=empty) const
virtual void	Warning (const char *msg, const char *origin="") const
virtual void	Warning (const std::string &msg, const std::string &origin=empty) const
virtual void	Warning (std::ostream &msg, const std::string &origin=empty) const
virtual void	Error (const char *msg, const char *origin="") const
virtual void	Error (const std::string msg, const std::string origin=empty) const
virtual void	Error (std::ostream &msg, const std::string &origin=empty) const
virtual void	Fatal (const char *msg, const char *origin="") const
virtual void	Fatal (const std::string &msg, const std::string &origin=empty) const
virtual void	Fatal (std::ostream &msg, const std::string &origin=empty) const

Protected Attributes
std::string	m_Name
CDM::enumSubstanceClass::value	m_Classification
CDM::enumSubstanceState::value	m_State
SEScalarMassPerVolume *	m_Density
SEScalarMassPerAmount *	m_MolarMass
SEScalarMassPerAreaTime *	m_MaximumDiffusionFlux
SEScalar *	m_MichaelisCoefficient
SEScalarElectricResistance *	m_MembraneResistance
SESubstanceAerosolization *	m_Aerosolization
SEScalarTimeMassPerVolume *	m_AreaUnderCurve
SEScalarMassPerVolume *	m_BloodConcentration
SEScalarMassPerVolume *	m_EffectSiteConcentration
SEScalarMass *	m_MassInBody
SEScalarMass *	m_MassInBlood
SEScalarMass *	m_MassInTissue
SEScalarMassPerVolume *	m_PlasmaConcentration
SEScalarMass *	m_SystemicMassCleared
SEScalarMassPerVolume *	m_TissueConcentration
SEScalarVolumePerTime *	m_AlveolarTransfer
SEScalarVolumePerTimePressure *	m_DiffusingCapacity
SEScalarFraction *	m_EndTidalFraction
SEScalarPressure *	m_EndTidalPressure
SEScalar *	m_RelativeDiffusionCoefficient
SEScalarInversePressure *	m_SolubilityCoefficient
SESubstanceClearance *	m_Clearance
SESubstancePharmacokinetics *	m_PK
SESubstancePharmacodynamics *	m_PD
Protected Attributes inherited from biogears::Loggable
Logger *	m_Logger

Additional Inherited Members
Static Public Attributes inherited from biogears::Loggable
static const std::string	empty
static const char *	empty_cStr

Constructor & Destructor Documentation

biogears::SESubstance::SESubstance

(

Logger *

logger

)

biogears::SESubstance::~SESubstance ( )

virtual

Member Function Documentation

void biogears::SESubstance::Clear ( )

virtual

SESubstanceAerosolization & biogears::SESubstance::GetAerosolization ( )

virtual

const SESubstanceAerosolization * biogears::SESubstance::GetAerosolization ( ) const

virtual

SEScalarVolumePerTime & biogears::SESubstance::GetAlveolarTransfer ( )

virtual

double biogears::SESubstance::GetAlveolarTransfer ( const VolumePerTimeUnit &  unit ) const

virtual

SEScalarTimeMassPerVolume & biogears::SESubstance::GetAreaUnderCurve ( )

virtual

double biogears::SESubstance::GetAreaUnderCurve ( const TimeMassPerVolumeUnit &  unit ) const

virtual

SEScalarMassPerVolume & biogears::SESubstance::GetBloodConcentration ( )

virtual

double biogears::SESubstance::GetBloodConcentration ( const MassPerVolumeUnit &  unit ) const

virtual

CDM::enumSubstanceClass::value biogears::SESubstance::GetClassification ( ) const

virtual

SESubstanceClearance & biogears::SESubstance::GetClearance ( )

virtual

const SESubstanceClearance * biogears::SESubstance::GetClearance ( ) const

virtual

SEScalarMassPerVolume & biogears::SESubstance::GetDensity ( )

virtual

double biogears::SESubstance::GetDensity ( const MassPerVolumeUnit &  unit ) const

virtual

SEScalarVolumePerTimePressure & biogears::SESubstance::GetDiffusingCapacity ( )

virtual

double biogears::SESubstance::GetDiffusingCapacity ( const VolumePerTimePressureUnit &  unit ) const

virtual

SEScalarMassPerVolume & biogears::SESubstance::GetEffectSiteConcentration ( )

virtual

double biogears::SESubstance::GetEffectSiteConcentration ( const MassPerVolumeUnit &  unit ) const

virtual

SEScalarFraction & biogears::SESubstance::GetEndTidalFraction ( )

virtual

double biogears::SESubstance::GetEndTidalFraction ( ) const

virtual

SEScalarPressure & biogears::SESubstance::GetEndTidalPressure ( )

virtual

double biogears::SESubstance::GetEndTidalPressure ( const PressureUnit &  unit ) const

virtual

SEScalarMass & biogears::SESubstance::GetMassInBlood ( )

virtual

double biogears::SESubstance::GetMassInBlood ( const MassUnit &  unit ) const

virtual

SEScalarMass & biogears::SESubstance::GetMassInBody ( )

virtual

double biogears::SESubstance::GetMassInBody ( const MassUnit &  unit ) const

virtual

SEScalarMass & biogears::SESubstance::GetMassInTissue ( )

virtual

double biogears::SESubstance::GetMassInTissue ( const MassUnit &  unit ) const

virtual

SEScalarMassPerAreaTime & biogears::SESubstance::GetMaximumDiffusionFlux ( )

virtual

double biogears::SESubstance::GetMaximumDiffusionFlux ( const MassPerAreaTimeUnit &  unit ) const

virtual

SEScalarElectricResistance & biogears::SESubstance::GetMembraneResistance ( )

virtual

double biogears::SESubstance::GetMembraneResistance ( const ElectricResistanceUnit &  unit ) const

virtual

SEScalar & biogears::SESubstance::GetMichaelisCoefficient ( )

virtual

double biogears::SESubstance::GetMichaelisCoefficient ( ) const

virtual

SEScalarMassPerAmount & biogears::SESubstance::GetMolarMass ( )

virtual

double biogears::SESubstance::GetMolarMass ( const MassPerAmountUnit &  unit ) const

virtual

std::string biogears::SESubstance::GetName ( ) const

virtual

const char * biogears::SESubstance::GetName_cStr ( ) const

virtual

SESubstancePharmacodynamics & biogears::SESubstance::GetPD ( )

virtual

const SESubstancePharmacodynamics * biogears::SESubstance::GetPD ( ) const

virtual

SESubstancePharmacokinetics & biogears::SESubstance::GetPK ( )

virtual

const SESubstancePharmacokinetics * biogears::SESubstance::GetPK ( ) const

virtual

SEScalarMassPerVolume & biogears::SESubstance::GetPlasmaConcentration ( )

virtual

double biogears::SESubstance::GetPlasmaConcentration ( const MassPerVolumeUnit &  unit ) const

virtual

SEScalar & biogears::SESubstance::GetRelativeDiffusionCoefficient ( )

virtual

double biogears::SESubstance::GetRelativeDiffusionCoefficient ( ) const

virtual

const SEScalar * biogears::SESubstance::GetScalar ( const char *  name )

virtual

const SEScalar * biogears::SESubstance::GetScalar ( const std::string &  name )

virtual

SEScalarInversePressure & biogears::SESubstance::GetSolubilityCoefficient ( )

virtual

double biogears::SESubstance::GetSolubilityCoefficient ( const InversePressureUnit &  unit ) const

virtual

CDM::enumSubstanceState::value biogears::SESubstance::GetState ( ) const

virtual

SEScalarMass & biogears::SESubstance::GetSystemicMassCleared ( )

virtual

double biogears::SESubstance::GetSystemicMassCleared ( const MassUnit &  unit ) const

virtual

SEScalarMassPerVolume & biogears::SESubstance::GetTissueConcentration ( )

virtual

double biogears::SESubstance::GetTissueConcentration ( const MassPerVolumeUnit &  unit ) const

virtual

bool biogears::SESubstance::HasAerosolization ( ) const

virtual

bool biogears::SESubstance::HasAlveolarTransfer ( ) const

virtual

bool biogears::SESubstance::HasAreaUnderCurve ( ) const

virtual

bool biogears::SESubstance::HasBloodConcentration ( ) const

virtual

bool biogears::SESubstance::HasClassification ( ) const

virtual

bool biogears::SESubstance::HasClearance ( ) const

virtual

bool biogears::SESubstance::HasDensity ( ) const

virtual

bool biogears::SESubstance::HasDiffusingCapacity ( ) const

virtual

bool biogears::SESubstance::HasEffectSiteConcentration ( ) const

virtual

bool biogears::SESubstance::HasEndTidalFraction ( ) const

virtual

bool biogears::SESubstance::HasEndTidalPressure ( ) const

virtual

bool biogears::SESubstance::HasMassInBlood ( ) const

virtual

bool biogears::SESubstance::HasMassInBody ( ) const

virtual

bool biogears::SESubstance::HasMassInTissue ( ) const

virtual

bool biogears::SESubstance::HasMaximumDiffusionFlux ( ) const

virtual

bool biogears::SESubstance::HasMembraneResistance ( ) const

virtual

bool biogears::SESubstance::HasMichaelisCoefficient ( ) const

virtual

bool biogears::SESubstance::HasMolarMass ( ) const

virtual

bool biogears::SESubstance::HasName ( ) const

virtual

bool biogears::SESubstance::HasPD ( ) const

virtual

bool biogears::SESubstance::HasPK ( ) const

virtual

bool biogears::SESubstance::HasPlasmaConcentration ( ) const

virtual

bool biogears::SESubstance::HasRelativeDiffusionCoefficient ( ) const

virtual

bool biogears::SESubstance::HasSolubilityCoefficient ( ) const

virtual

bool biogears::SESubstance::HasState ( ) const

virtual

bool biogears::SESubstance::HasSystemicMassCleared ( ) const

virtual

bool biogears::SESubstance::HasTissueConcentration ( ) const

virtual

void biogears::SESubstance::InvalidateClassification ( )

virtual

void biogears::SESubstance::InvalidateName ( )

virtual

void biogears::SESubstance::InvalidateState ( )

virtual

bool biogears::SESubstance::Load ( const CDM::SubstanceData &  in )

virtual

void biogears::SESubstance::RemoveAerosolization ( )

virtual

void biogears::SESubstance::RemoveClearance ( )

virtual

void biogears::SESubstance::RemovePD ( )

virtual

void biogears::SESubstance::RemovePK ( )

virtual

void biogears::SESubstance::SetClassification ( CDM::enumSubstanceClass::value  subClass )

virtual

void biogears::SESubstance::SetName ( const char *  name )

virtual

void biogears::SESubstance::SetName ( const std::string &  name )

virtual

void biogears::SESubstance::SetState ( CDM::enumSubstanceState::value  state )

virtual

CDM::SubstanceData * biogears::SESubstance::Unload ( ) const

virtual

void biogears::SESubstance::Unload ( CDM::SubstanceData &  data ) const

protectedvirtual

Member Data Documentation

SESubstanceAerosolization* biogears::SESubstance::m_Aerosolization

protected

SEScalarVolumePerTime* biogears::SESubstance::m_AlveolarTransfer

protected

SEScalarTimeMassPerVolume* biogears::SESubstance::m_AreaUnderCurve

protected

SEScalarMassPerVolume* biogears::SESubstance::m_BloodConcentration

protected

CDM::enumSubstanceClass::value biogears::SESubstance::m_Classification

protected

SESubstanceClearance* biogears::SESubstance::m_Clearance

protected

SEScalarMassPerVolume* biogears::SESubstance::m_Density

protected

SEScalarVolumePerTimePressure* biogears::SESubstance::m_DiffusingCapacity

protected

SEScalarMassPerVolume* biogears::SESubstance::m_EffectSiteConcentration

protected

SEScalarFraction* biogears::SESubstance::m_EndTidalFraction

protected

SEScalarPressure* biogears::SESubstance::m_EndTidalPressure

protected

SEScalarMass* biogears::SESubstance::m_MassInBlood

protected

SEScalarMass* biogears::SESubstance::m_MassInBody

protected

SEScalarMass* biogears::SESubstance::m_MassInTissue

protected

SEScalarMassPerAreaTime* biogears::SESubstance::m_MaximumDiffusionFlux

protected

SEScalarElectricResistance* biogears::SESubstance::m_MembraneResistance

protected

SEScalar* biogears::SESubstance::m_MichaelisCoefficient

protected

SEScalarMassPerAmount* biogears::SESubstance::m_MolarMass

protected

std::string biogears::SESubstance::m_Name

protected

SESubstancePharmacodynamics* biogears::SESubstance::m_PD

protected

SESubstancePharmacokinetics* biogears::SESubstance::m_PK

protected

SEScalarMassPerVolume* biogears::SESubstance::m_PlasmaConcentration

protected

SEScalar* biogears::SESubstance::m_RelativeDiffusionCoefficient

protected

SEScalarInversePressure* biogears::SESubstance::m_SolubilityCoefficient

protected

CDM::enumSubstanceState::value biogears::SESubstance::m_State

protected

SEScalarMass* biogears::SESubstance::m_SystemicMassCleared

protected

SEScalarMassPerVolume* biogears::SESubstance::m_TissueConcentration

protected