SESubstanceClearance Class Reference

#include <SESubstanceClearance.h>

Inherits Loggable.

Public Member Functions

 SESubstanceClearance (Logger *logger)
 
virtual ~SESubstanceClearance ()
 
virtual void Clear ()
 
virtual bool IsValid () const
 
virtual const SEScalarGetScalar (const std::string &name)
 
virtual bool HasSystemic () const
 
virtual void SetSystemic (bool b)
 
virtual eCharge GetChargeInBlood () const
 
virtual void SetChargeInBlood (eCharge type)
 
virtual bool HasChargeInBlood () const
 
virtual void InvalidateChargeInBlood ()
 
virtual bool HasFractionExcretedInFeces () const
 
virtual SEScalar0To1GetFractionExcretedInFeces ()
 
virtual double GetFractionExcretedInFeces () const
 
virtual bool HasFractionExcretedInUrine () const
 
virtual SEScalar0To1GetFractionExcretedInUrine ()
 
virtual double GetFractionExcretedInUrine () const
 
virtual bool HasFractionMetabolizedInGut () const
 
virtual SEScalar0To1GetFractionMetabolizedInGut ()
 
virtual double GetFractionMetabolizedInGut () const
 
virtual bool HasFractionUnboundInPlasma () const
 
virtual SEScalar0To1GetFractionUnboundInPlasma ()
 
virtual double GetFractionUnboundInPlasma () const
 
virtual bool HasGlomerularFilterability () const
 
virtual SEScalarGetGlomerularFilterability ()
 
virtual double GetGlomerularFilterability () const
 
virtual bool HasIntrinsicClearance () const
 
virtual SEScalarVolumePerTimeMassGetIntrinsicClearance ()
 
virtual double GetIntrinsicClearance (const VolumePerTimeMassUnit &unit) const
 
virtual RenalDynamic GetRenalDynamic () const
 
virtual void SetRenalDynamic (RenalDynamic d)
 
virtual bool HasRenalDynamic () const
 
virtual void InvalidateRenalDynamic ()
 
virtual bool HasRenalClearance () const
 
virtual SEScalarVolumePerTimeMassGetRenalClearance ()
 
virtual double GetRenalClearance (const VolumePerTimeMassUnit &unit) const
 
virtual bool HasRenalReabsorptionRatio () const
 
virtual SEScalarGetRenalReabsorptionRatio ()
 
virtual double GetRenalReabsorptionRatio () const
 
virtual bool HasRenalTransportMaximum () const
 
virtual SEScalarMassPerTimeGetRenalTransportMaximum ()
 
virtual double GetRenalTransportMaximum (const MassPerTimeUnit &unit) const
 
virtual bool HasRenalFiltrationRate () const
 
virtual SEScalarMassPerTimeGetRenalFiltrationRate ()
 
virtual double GetRenalFiltrationRate (const MassPerTimeUnit &unit) const
 
virtual bool HasRenalReabsorptionRate () const
 
virtual SEScalarMassPerTimeGetRenalReabsorptionRate ()
 
virtual double GetRenalReabsorptionRate (const MassPerTimeUnit &unit) const
 
virtual bool HasRenalExcretionRate () const
 
virtual SEScalarMassPerTimeGetRenalExcretionRate ()
 
virtual double GetRenalExcretionRate (const MassPerTimeUnit &unit) const
 
virtual bool HasSystemicClearance () const
 
virtual SEScalarVolumePerTimeMassGetSystemicClearance ()
 
virtual double GetSystemicClearance (const VolumePerTimeMassUnit &unit) const
 
- 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) 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
 

Protected Attributes

bool m_hasSystemic
 
eCharge m_ChargeInBlood
 
SEScalar0To1m_FractionExcretedInFeces
 
SEScalar0To1m_FractionExcretedInUrine
 
SEScalar0To1m_FractionMetabolizedInGut
 
SEScalar0To1m_FractionUnboundInPlasma
 
SEScalarVolumePerTimeMassm_IntrinsicClearance
 
RenalDynamic m_RenalDynamic
 
SEScalarVolumePerTimeMassm_RenalClearance
 
SEScalarm_RenalReabsorptionRatio
 
SEScalarMassPerTimem_RenalTransportMaximum
 
SEScalarMassPerTimem_RenalFiltrationRate
 
SEScalarMassPerTimem_RenalReabsorptionRate
 
SEScalarMassPerTimem_RenalExcretionRate
 
SEScalarm_GlomerularFilterability
 
SEScalarVolumePerTimeMassm_SystemicClearance
 
- Protected Attributes inherited from Loggable
bool myLogger
 
Loggerm_Logger
 

Friends

class PBSubstance
 

Constructor & Destructor Documentation

◆ SESubstanceClearance()

SESubstanceClearance::SESubstanceClearance ( Logger logger)

◆ ~SESubstanceClearance()

SESubstanceClearance::~SESubstanceClearance ( )
virtual

Member Function Documentation

◆ Clear()

void SESubstanceClearance::Clear ( )
virtual

◆ GetChargeInBlood()

eCharge SESubstanceClearance::GetChargeInBlood ( ) const
virtual

◆ GetFractionExcretedInFeces() [1/2]

SEScalar0To1 & SESubstanceClearance::GetFractionExcretedInFeces ( )
virtual

◆ GetFractionExcretedInFeces() [2/2]

double SESubstanceClearance::GetFractionExcretedInFeces ( ) const
virtual

◆ GetFractionExcretedInUrine() [1/2]

SEScalar0To1 & SESubstanceClearance::GetFractionExcretedInUrine ( )
virtual

◆ GetFractionExcretedInUrine() [2/2]

double SESubstanceClearance::GetFractionExcretedInUrine ( ) const
virtual

◆ GetFractionMetabolizedInGut() [1/2]

SEScalar0To1 & SESubstanceClearance::GetFractionMetabolizedInGut ( )
virtual

◆ GetFractionMetabolizedInGut() [2/2]

double SESubstanceClearance::GetFractionMetabolizedInGut ( ) const
virtual

◆ GetFractionUnboundInPlasma() [1/2]

SEScalar0To1 & SESubstanceClearance::GetFractionUnboundInPlasma ( )
virtual

◆ GetFractionUnboundInPlasma() [2/2]

double SESubstanceClearance::GetFractionUnboundInPlasma ( ) const
virtual

◆ GetGlomerularFilterability() [1/2]

SEScalar & SESubstanceClearance::GetGlomerularFilterability ( )
virtual

◆ GetGlomerularFilterability() [2/2]

double SESubstanceClearance::GetGlomerularFilterability ( ) const
virtual

◆ GetIntrinsicClearance() [1/2]

SEScalarVolumePerTimeMass & SESubstanceClearance::GetIntrinsicClearance ( )
virtual

◆ GetIntrinsicClearance() [2/2]

double SESubstanceClearance::GetIntrinsicClearance ( const VolumePerTimeMassUnit unit) const
virtual

◆ GetRenalClearance() [1/2]

SEScalarVolumePerTimeMass & SESubstanceClearance::GetRenalClearance ( )
virtual

◆ GetRenalClearance() [2/2]

double SESubstanceClearance::GetRenalClearance ( const VolumePerTimeMassUnit unit) const
virtual

◆ GetRenalDynamic()

RenalDynamic SESubstanceClearance::GetRenalDynamic ( ) const
virtual

◆ GetRenalExcretionRate() [1/2]

SEScalarMassPerTime & SESubstanceClearance::GetRenalExcretionRate ( )
virtual

◆ GetRenalExcretionRate() [2/2]

double SESubstanceClearance::GetRenalExcretionRate ( const MassPerTimeUnit unit) const
virtual

◆ GetRenalFiltrationRate() [1/2]

SEScalarMassPerTime & SESubstanceClearance::GetRenalFiltrationRate ( )
virtual

◆ GetRenalFiltrationRate() [2/2]

double SESubstanceClearance::GetRenalFiltrationRate ( const MassPerTimeUnit unit) const
virtual

◆ GetRenalReabsorptionRate() [1/2]

SEScalarMassPerTime & SESubstanceClearance::GetRenalReabsorptionRate ( )
virtual

◆ GetRenalReabsorptionRate() [2/2]

double SESubstanceClearance::GetRenalReabsorptionRate ( const MassPerTimeUnit unit) const
virtual

◆ GetRenalReabsorptionRatio() [1/2]

SEScalar & SESubstanceClearance::GetRenalReabsorptionRatio ( )
virtual

◆ GetRenalReabsorptionRatio() [2/2]

double SESubstanceClearance::GetRenalReabsorptionRatio ( ) const
virtual

◆ GetRenalTransportMaximum() [1/2]

SEScalarMassPerTime & SESubstanceClearance::GetRenalTransportMaximum ( )
virtual

◆ GetRenalTransportMaximum() [2/2]

double SESubstanceClearance::GetRenalTransportMaximum ( const MassPerTimeUnit unit) const
virtual

◆ GetScalar()

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

◆ GetSystemicClearance() [1/2]

SEScalarVolumePerTimeMass & SESubstanceClearance::GetSystemicClearance ( )
virtual

◆ GetSystemicClearance() [2/2]

double SESubstanceClearance::GetSystemicClearance ( const VolumePerTimeMassUnit unit) const
virtual

◆ HasChargeInBlood()

bool SESubstanceClearance::HasChargeInBlood ( ) const
virtual

◆ HasFractionExcretedInFeces()

bool SESubstanceClearance::HasFractionExcretedInFeces ( ) const
virtual

◆ HasFractionExcretedInUrine()

bool SESubstanceClearance::HasFractionExcretedInUrine ( ) const
virtual

◆ HasFractionMetabolizedInGut()

bool SESubstanceClearance::HasFractionMetabolizedInGut ( ) const
virtual

◆ HasFractionUnboundInPlasma()

bool SESubstanceClearance::HasFractionUnboundInPlasma ( ) const
virtual

◆ HasGlomerularFilterability()

bool SESubstanceClearance::HasGlomerularFilterability ( ) const
virtual

◆ HasIntrinsicClearance()

bool SESubstanceClearance::HasIntrinsicClearance ( ) const
virtual

◆ HasRenalClearance()

bool SESubstanceClearance::HasRenalClearance ( ) const
virtual

◆ HasRenalDynamic()

bool SESubstanceClearance::HasRenalDynamic ( ) const
virtual

◆ HasRenalExcretionRate()

bool SESubstanceClearance::HasRenalExcretionRate ( ) const
virtual

◆ HasRenalFiltrationRate()

bool SESubstanceClearance::HasRenalFiltrationRate ( ) const
virtual

◆ HasRenalReabsorptionRate()

bool SESubstanceClearance::HasRenalReabsorptionRate ( ) const
virtual

◆ HasRenalReabsorptionRatio()

bool SESubstanceClearance::HasRenalReabsorptionRatio ( ) const
virtual

◆ HasRenalTransportMaximum()

bool SESubstanceClearance::HasRenalTransportMaximum ( ) const
virtual

◆ HasSystemic()

virtual bool SESubstanceClearance::HasSystemic ( ) const
inlinevirtual

◆ HasSystemicClearance()

bool SESubstanceClearance::HasSystemicClearance ( ) const
virtual

◆ InvalidateChargeInBlood()

void SESubstanceClearance::InvalidateChargeInBlood ( )
virtual

◆ InvalidateRenalDynamic()

void SESubstanceClearance::InvalidateRenalDynamic ( )
virtual

◆ IsValid()

bool SESubstanceClearance::IsValid ( ) const
virtual

◆ SetChargeInBlood()

void SESubstanceClearance::SetChargeInBlood ( eCharge  type)
virtual

◆ SetRenalDynamic()

void SESubstanceClearance::SetRenalDynamic ( RenalDynamic  d)
virtual

◆ SetSystemic()

virtual void SESubstanceClearance::SetSystemic ( bool  b)
inlinevirtual

Friends And Related Function Documentation

◆ PBSubstance

friend class PBSubstance
friend

Member Data Documentation

◆ m_ChargeInBlood

eCharge SESubstanceClearance::m_ChargeInBlood
protected

◆ m_FractionExcretedInFeces

SEScalar0To1* SESubstanceClearance::m_FractionExcretedInFeces
protected

◆ m_FractionExcretedInUrine

SEScalar0To1* SESubstanceClearance::m_FractionExcretedInUrine
protected

◆ m_FractionMetabolizedInGut

SEScalar0To1* SESubstanceClearance::m_FractionMetabolizedInGut
protected

◆ m_FractionUnboundInPlasma

SEScalar0To1* SESubstanceClearance::m_FractionUnboundInPlasma
protected

◆ m_GlomerularFilterability

SEScalar* SESubstanceClearance::m_GlomerularFilterability
protected

◆ m_hasSystemic

bool SESubstanceClearance::m_hasSystemic
protected

◆ m_IntrinsicClearance

SEScalarVolumePerTimeMass* SESubstanceClearance::m_IntrinsicClearance
protected

◆ m_RenalClearance

SEScalarVolumePerTimeMass* SESubstanceClearance::m_RenalClearance
protected

◆ m_RenalDynamic

RenalDynamic SESubstanceClearance::m_RenalDynamic
protected

◆ m_RenalExcretionRate

SEScalarMassPerTime* SESubstanceClearance::m_RenalExcretionRate
protected

◆ m_RenalFiltrationRate

SEScalarMassPerTime* SESubstanceClearance::m_RenalFiltrationRate
protected

◆ m_RenalReabsorptionRate

SEScalarMassPerTime* SESubstanceClearance::m_RenalReabsorptionRate
protected

◆ m_RenalReabsorptionRatio

SEScalar* SESubstanceClearance::m_RenalReabsorptionRatio
protected

◆ m_RenalTransportMaximum

SEScalarMassPerTime* SESubstanceClearance::m_RenalTransportMaximum
protected

◆ m_SystemicClearance

SEScalarVolumePerTimeMass* SESubstanceClearance::m_SystemicClearance
protected

Distributed under the Apache License, Version 2.0.

See accompanying NOTICE file for details.