Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
biogears::PhysiologyEngineDynamicStabilizationCriteria Class Reference

#include <PhysiologyEngineDynamicStabilization.h>

Inheritance diagram for biogears::PhysiologyEngineDynamicStabilizationCriteria:
Inheritance graph
[legend]

Public Member Functions

 PhysiologyEngineDynamicStabilizationCriteria (Logger *logger)
 
virtual ~PhysiologyEngineDynamicStabilizationCriteria ()
 
virtual void Clear ()
 
virtual bool Load (const CDM::PhysiologyEngineDynamicStabilizationCriteriaData &in)
 
virtual CDM::PhysiologyEngineDynamicStabilizationCriteriaData * 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 bool HasConvergenceTime () const
 
virtual SEScalarTime & GetConvergenceTime ()
 
virtual double GetConvergenceTime (const TimeUnit &unit) const
 
virtual bool HasMinimumReactionTime () const
 
virtual SEScalarTime & GetMinimumReactionTime ()
 
virtual double GetMinimumReactionTime (const TimeUnit &unit) const
 
virtual bool HasMaximumAllowedStabilizationTime () const
 
virtual SEScalarTime & GetMaximumAllowedStabilizationTime ()
 
virtual double GetMaximumAllowedStabilizationTime (const TimeUnit &unit) const
 
virtual const std::vector< PropertyConvergence * > & GetPropertyConvergence () const
 
virtual PropertyConvergence & CreateSystemPropertyConvergence (double percentError, const char *name)
 Sets convergence critera for a specific properter. More...
 
virtual PropertyConvergence & CreateSystemPropertyConvergence (double percentError, const std::string &name)
 
virtual PropertyConvergence & CreateGasCompartmentPropertyConvergence (double percentError, const char *cmpt, const char *name)
 Sets convergence critera for a specific properter. More...
 
virtual PropertyConvergence & CreateGasCompartmentPropertyConvergence (double percentError, const std::string &cmpt, const std::string &name)
 
virtual PropertyConvergence & CreateGasCompartmentPropertyConvergence (double percentError, const char *cmpt, SESubstance &substance, const char *name)
 
virtual PropertyConvergence & CreateGasCompartmentPropertyConvergence (double percentError, const std::string &cmpt, SESubstance &substance, const std::string &name)
 
virtual PropertyConvergence & CreateLiquidCompartmentPropertyConvergence (double percentError, const char *cmpt, const char *name)
 
virtual PropertyConvergence & CreateLiquidCompartmentPropertyConvergence (double percentError, const std::string &cmpt, const std::string &name)
 
virtual PropertyConvergence & CreateLiquidCompartmentPropertyConvergence (double percentError, const char *cmpt, SESubstance &substance, const char *name)
 
virtual PropertyConvergence & CreateLiquidCompartmentPropertyConvergence (double percentError, const std::string &cmpt, SESubstance &substance, const std::string &name)
 
virtual PropertyConvergence & CreateThermalCompartmentPropertyConvergence (double percentError, const char *cmpt, const char *name)
 
virtual PropertyConvergence & CreateThermalCompartmentPropertyConvergence (double percentError, const std::string &cmpt, const std::string &name)
 
virtual PropertyConvergence & CreateTissueCompartmentPropertyConvergence (double percentError, const char *cmpt, const char *name)
 
virtual PropertyConvergence & CreateTissueCompartmentPropertyConvergence (double percentError, const std::string &cmpt, const std::string &name)
 
- Public Member Functions inherited from biogears::Loggable
 Loggable ()
 
 Loggable (Logger *log)
 
virtual ~Loggable ()
 
virtual Logger * GetLogger () const
 

Protected Member Functions

virtual void Unload (CDM::PhysiologyEngineDynamicStabilizationCriteriaData &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
 
SEScalarTime * m_ConvergenceTime
 
SEScalarTime * m_MinimumReactionTime
 
SEScalarTime * m_MaximumAllowedStabilizationTime
 
SEDataRequestManager m_DataRequestMgr
 
std::vector< PropertyConvergence * > m_PropertyConvergence
 
- Protected Attributes inherited from biogears::Loggable
Logger * m_Logger
 

Private Attributes

friend PhysiologyEngineDynamicStabilization
 

Additional Inherited Members

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

Constructor & Destructor Documentation

biogears::PhysiologyEngineDynamicStabilizationCriteria::PhysiologyEngineDynamicStabilizationCriteria ( Logger *  logger)
biogears::PhysiologyEngineDynamicStabilizationCriteria::~PhysiologyEngineDynamicStabilizationCriteria ( )
virtual

Member Function Documentation

void biogears::PhysiologyEngineDynamicStabilizationCriteria::Clear ( )
virtual
PropertyConvergence & biogears::PhysiologyEngineDynamicStabilizationCriteria::CreateGasCompartmentPropertyConvergence ( double  percentError,
const char *  cmpt,
const char *  name 
)
virtual

Sets convergence critera for a specific properter.

Parameters
percentError- The acceptable percent difference window that the specified property must stay within for a specified amount of time for convergence to happen
cmpt- The name of the compartment

Mulitple convergence property criteria can be specified. All properties must converge for the

PropertyConvergence & biogears::PhysiologyEngineDynamicStabilizationCriteria::CreateGasCompartmentPropertyConvergence ( double  percentError,
const std::string &  cmpt,
const std::string &  name 
)
virtual
PropertyConvergence & biogears::PhysiologyEngineDynamicStabilizationCriteria::CreateGasCompartmentPropertyConvergence ( double  percentError,
const char *  cmpt,
SESubstance &  substance,
const char *  name 
)
virtual
PropertyConvergence & biogears::PhysiologyEngineDynamicStabilizationCriteria::CreateGasCompartmentPropertyConvergence ( double  percentError,
const std::string &  cmpt,
SESubstance &  substance,
const std::string &  name 
)
virtual
PropertyConvergence & biogears::PhysiologyEngineDynamicStabilizationCriteria::CreateLiquidCompartmentPropertyConvergence ( double  percentError,
const char *  cmpt,
const char *  name 
)
virtual
PropertyConvergence & biogears::PhysiologyEngineDynamicStabilizationCriteria::CreateLiquidCompartmentPropertyConvergence ( double  percentError,
const std::string &  cmpt,
const std::string &  name 
)
virtual
PropertyConvergence & biogears::PhysiologyEngineDynamicStabilizationCriteria::CreateLiquidCompartmentPropertyConvergence ( double  percentError,
const char *  cmpt,
SESubstance &  substance,
const char *  name 
)
virtual
PropertyConvergence & biogears::PhysiologyEngineDynamicStabilizationCriteria::CreateLiquidCompartmentPropertyConvergence ( double  percentError,
const std::string &  cmpt,
SESubstance &  substance,
const std::string &  name 
)
virtual
PropertyConvergence & biogears::PhysiologyEngineDynamicStabilizationCriteria::CreateSystemPropertyConvergence ( double  percentError,
const char *  name 
)
virtual

Sets convergence critera for a specific properter.

Parameters
percentError- The acceptable percent difference window that the specified property must stay within for a specified amount of time for convergence to happen
name- The name of the property to converge

Mulitple convergence property criteria can be specified. All properties must converge for the

PropertyConvergence & biogears::PhysiologyEngineDynamicStabilizationCriteria::CreateSystemPropertyConvergence ( double  percentError,
const std::string &  name 
)
virtual
PropertyConvergence & biogears::PhysiologyEngineDynamicStabilizationCriteria::CreateThermalCompartmentPropertyConvergence ( double  percentError,
const char *  cmpt,
const char *  name 
)
virtual
PropertyConvergence & biogears::PhysiologyEngineDynamicStabilizationCriteria::CreateThermalCompartmentPropertyConvergence ( double  percentError,
const std::string &  cmpt,
const std::string &  name 
)
virtual
PropertyConvergence & biogears::PhysiologyEngineDynamicStabilizationCriteria::CreateTissueCompartmentPropertyConvergence ( double  percentError,
const char *  cmpt,
const char *  name 
)
virtual
PropertyConvergence & biogears::PhysiologyEngineDynamicStabilizationCriteria::CreateTissueCompartmentPropertyConvergence ( double  percentError,
const std::string &  cmpt,
const std::string &  name 
)
virtual
SEScalarTime & biogears::PhysiologyEngineDynamicStabilizationCriteria::GetConvergenceTime ( )
virtual
double biogears::PhysiologyEngineDynamicStabilizationCriteria::GetConvergenceTime ( const TimeUnit &  unit) const
virtual
SEScalarTime & biogears::PhysiologyEngineDynamicStabilizationCriteria::GetMaximumAllowedStabilizationTime ( )
virtual
double biogears::PhysiologyEngineDynamicStabilizationCriteria::GetMaximumAllowedStabilizationTime ( const TimeUnit &  unit) const
virtual
SEScalarTime & biogears::PhysiologyEngineDynamicStabilizationCriteria::GetMinimumReactionTime ( )
virtual
double biogears::PhysiologyEngineDynamicStabilizationCriteria::GetMinimumReactionTime ( const TimeUnit &  unit) const
virtual
std::string biogears::PhysiologyEngineDynamicStabilizationCriteria::GetName ( ) const
virtual
const char * biogears::PhysiologyEngineDynamicStabilizationCriteria::GetName_cStr ( ) const
virtual
const std::vector< PropertyConvergence * > & biogears::PhysiologyEngineDynamicStabilizationCriteria::GetPropertyConvergence ( ) const
virtual
bool biogears::PhysiologyEngineDynamicStabilizationCriteria::HasConvergenceTime ( ) const
virtual
bool biogears::PhysiologyEngineDynamicStabilizationCriteria::HasMaximumAllowedStabilizationTime ( ) const
virtual
bool biogears::PhysiologyEngineDynamicStabilizationCriteria::HasMinimumReactionTime ( ) const
virtual
bool biogears::PhysiologyEngineDynamicStabilizationCriteria::HasName ( ) const
virtual
void biogears::PhysiologyEngineDynamicStabilizationCriteria::InvalidateName ( )
virtual
bool biogears::PhysiologyEngineDynamicStabilizationCriteria::Load ( const CDM::PhysiologyEngineDynamicStabilizationCriteriaData &  in)
virtual
void biogears::PhysiologyEngineDynamicStabilizationCriteria::SetName ( const char *  name)
virtual
void biogears::PhysiologyEngineDynamicStabilizationCriteria::SetName ( const std::string &  name)
virtual
CDM::PhysiologyEngineDynamicStabilizationCriteriaData * biogears::PhysiologyEngineDynamicStabilizationCriteria::Unload ( ) const
virtual
void biogears::PhysiologyEngineDynamicStabilizationCriteria::Unload ( CDM::PhysiologyEngineDynamicStabilizationCriteriaData &  data) const
protectedvirtual

Member Data Documentation

SEScalarTime* biogears::PhysiologyEngineDynamicStabilizationCriteria::m_ConvergenceTime
protected
SEDataRequestManager biogears::PhysiologyEngineDynamicStabilizationCriteria::m_DataRequestMgr
protected
SEScalarTime* biogears::PhysiologyEngineDynamicStabilizationCriteria::m_MaximumAllowedStabilizationTime
protected
SEScalarTime* biogears::PhysiologyEngineDynamicStabilizationCriteria::m_MinimumReactionTime
protected
std::string biogears::PhysiologyEngineDynamicStabilizationCriteria::m_Name
protected
std::vector<PropertyConvergence*> biogears::PhysiologyEngineDynamicStabilizationCriteria::m_PropertyConvergence
protected
friend biogears::PhysiologyEngineDynamicStabilizationCriteria::PhysiologyEngineDynamicStabilization
private