Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
biogears::SECompartment Class Referenceabstract

#include <SECompartment.h>

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

Public Member Functions

virtual ~SECompartment () override
 
virtual void Clear ()
 
virtual bool Load (const CDM::CompartmentData &in, SECircuitManager *circuits=nullptr)
 
virtual CDM::CompartmentData * Unload ()=0
 
virtual std::string GetName () const
 
virtual const char * GetName_cStr () const
 
virtual const SEScalar * GetScalar (const char *name)=0
 
virtual const SEScalar * GetScalar (const std::string &name)=0
 
virtual bool HasChildren () const =0
 
virtual void StateChange ()=0
 
- Public Member Functions inherited from biogears::Loggable
 Loggable ()
 
 Loggable (Logger *log)
 
virtual ~Loggable ()
 
virtual Logger * GetLogger () const
 

Static Public Member Functions

template<typename CompartmentType >
static void FindLeaves (CompartmentType &cmpt, std::vector< CompartmentType * > &leaves)
 

Protected Member Functions

 SECompartment (const char *name, Logger *logger)
 
 SECompartment (const std::string &name, Logger *logger)
 
virtual void Unload (CDM::CompartmentData &data)
 
- 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
 
- 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::SECompartment::SECompartment ( const char *  name,
Logger *  logger 
)
protected
biogears::SECompartment::SECompartment ( const std::string &  name,
Logger *  logger 
)
protected
biogears::SECompartment::~SECompartment ( )
overridevirtual

Member Function Documentation

void biogears::SECompartment::Clear ( )
virtual

Reimplemented in biogears::SEFluidCompartment< FLUID_COMPARTMENT_TEMPLATE >, biogears::SEFluidCompartment< SELiquidCompartmentLink, SELiquidTransportVertex, SELiquidTransportSubstance, SELiquidSubstanceQuantity >, biogears::SEFluidCompartment< SEGasCompartmentLink, SEGasTransportVertex, SEGasTransportSubstance, SEGasSubstanceQuantity >, biogears::SETissueCompartment, biogears::SELiquidCompartment, and biogears::SEThermalCompartment.

template<typename CompartmentType >
static void biogears::SECompartment::FindLeaves ( CompartmentType &  cmpt,
std::vector< CompartmentType * > &  leaves 
)
inlinestatic
std::string biogears::SECompartment::GetName ( ) const
virtual

Reimplemented in biogears::SEFluidCompartment< FLUID_COMPARTMENT_TEMPLATE >, biogears::SEFluidCompartment< SELiquidCompartmentLink, SELiquidTransportVertex, SELiquidTransportSubstance, SELiquidSubstanceQuantity >, and biogears::SEFluidCompartment< SEGasCompartmentLink, SEGasTransportVertex, SEGasTransportSubstance, SEGasSubstanceQuantity >.

const char * biogears::SECompartment::GetName_cStr ( ) const
virtual

Reimplemented in biogears::SEFluidCompartment< FLUID_COMPARTMENT_TEMPLATE >, biogears::SEFluidCompartment< SELiquidCompartmentLink, SELiquidTransportVertex, SELiquidTransportSubstance, SELiquidSubstanceQuantity >, and biogears::SEFluidCompartment< SEGasCompartmentLink, SEGasTransportVertex, SEGasTransportSubstance, SEGasSubstanceQuantity >.

virtual const SEScalar* biogears::SECompartment::GetScalar ( const char *  name)
pure virtual

Implemented in biogears::SEFluidCompartment< FLUID_COMPARTMENT_TEMPLATE >, biogears::SEFluidCompartment< SELiquidCompartmentLink, SELiquidTransportVertex, SELiquidTransportSubstance, SELiquidSubstanceQuantity >, biogears::SEFluidCompartment< SEGasCompartmentLink, SEGasTransportVertex, SEGasTransportSubstance, SEGasSubstanceQuantity >, biogears::SETissueCompartment, biogears::SELiquidCompartment, and biogears::SEThermalCompartment.

virtual const SEScalar* biogears::SECompartment::GetScalar ( const std::string &  name)
pure virtual

Implemented in biogears::SEFluidCompartment< FLUID_COMPARTMENT_TEMPLATE >, biogears::SEFluidCompartment< SELiquidCompartmentLink, SELiquidTransportVertex, SELiquidTransportSubstance, SELiquidSubstanceQuantity >, biogears::SEFluidCompartment< SEGasCompartmentLink, SEGasTransportVertex, SEGasTransportSubstance, SEGasSubstanceQuantity >, biogears::SETissueCompartment, biogears::SELiquidCompartment, and biogears::SEThermalCompartment.

virtual bool biogears::SECompartment::HasChildren ( ) const
pure virtual

Implemented in biogears::SEFluidCompartment< FLUID_COMPARTMENT_TEMPLATE >, biogears::SEFluidCompartment< SELiquidCompartmentLink, SELiquidTransportVertex, SELiquidTransportSubstance, SELiquidSubstanceQuantity >, biogears::SEFluidCompartment< SEGasCompartmentLink, SEGasTransportVertex, SEGasTransportSubstance, SEGasSubstanceQuantity >, biogears::SETissueCompartment, and biogears::SEThermalCompartment.

bool biogears::SECompartment::Load ( const CDM::CompartmentData &  in,
SECircuitManager *  circuits = nullptr 
)
virtual
virtual void biogears::SECompartment::StateChange ( )
pure virtual

Implemented in biogears::SETissueCompartment, biogears::SEThermalCompartment, biogears::SELiquidCompartment, and biogears::SEGasCompartment.

virtual CDM::CompartmentData* biogears::SECompartment::Unload ( )
pure virtual

Implemented in biogears::SEFluidCompartment< FLUID_COMPARTMENT_TEMPLATE >, biogears::SEFluidCompartment< SELiquidCompartmentLink, SELiquidTransportVertex, SELiquidTransportSubstance, SELiquidSubstanceQuantity >, biogears::SEFluidCompartment< SEGasCompartmentLink, SEGasTransportVertex, SEGasTransportSubstance, SEGasSubstanceQuantity >, biogears::SETissueCompartment, biogears::SELiquidCompartment, biogears::SEThermalCompartment, and biogears::SEGasCompartment.

void biogears::SECompartment::Unload ( CDM::CompartmentData &  data)
protectedvirtual

Member Data Documentation

std::string biogears::SECompartment::m_Name
protected