SECompartment Class Reference

#include <SECompartment.h>

Inherits Loggable.

Inherited by SEElectricalCompartment, SEFluidCompartment< FLUID_COMPARTMENT_TEMPLATE >, SEFluidCompartment< SEGasCompartmentLink, SEGasTransportVertex, SEGasTransportSubstance, SEGasSubstanceQuantity >, SEFluidCompartment< SELiquidCompartmentLink, SELiquidTransportVertex, SELiquidTransportSubstance, SELiquidSubstanceQuantity >, SEThermalCompartment, and SETissueCompartment.

Public Member Functions
virtual	~SECompartment ()
virtual void	Clear ()
virtual std::string	GetName () const
virtual const SEScalar *	GetScalar (const std::string &name)=0
virtual bool	HasChildren () const =0
virtual void	StateChange ()=0
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, std::string const &origin=empty) const
virtual void	Debug (std::stringstream &msg, std::string const &origin=empty) const
virtual void	Debug (std::ostream &msg, std::string const &origin=empty) const
virtual void	Info (std::string const &msg, std::string const &origin=empty) const
virtual void	Info (std::stringstream &msg, std::string const &origin=empty) const
virtual void	Info (const std::stringstream &msg, std::string const &origin=empty) const
virtual void	Info (std::ostream &msg, std::string const &origin=empty) const
virtual void	Warning (std::string const &msg, std::string const &origin=empty) const
virtual void	Warning (std::stringstream &msg, std::string const &origin=empty) const
virtual void	Warning (std::ostream &msg, std::string const &origin=empty) const
virtual void	Error (std::string const &msg, std::string const &origin=empty) const
virtual void	Error (std::stringstream &msg, std::string const &origin=empty) const
virtual void	Error (std::ostream &msg, std::string const &origin=empty) const
virtual void	Fatal (std::string const &msg, std::string const &origin=empty) const
virtual void	Fatal (std::stringstream &msg, std::string const &origin=empty) const
virtual void	Fatal (std::ostream &msg, std::string const &origin=empty) const

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

Protected Member Functions
	SECompartment (const std::string &name, Logger *logger)

Protected Attributes
std::string	m_Name
Protected Attributes inherited from Loggable
bool	myLogger
Logger *	m_Logger

Friends
class	PBCompartment

Additional Inherited Members
Static Public Attributes inherited from Loggable
static const std::string	empty

Constructor & Destructor Documentation

SECompartment()

SECompartment::SECompartment ( const std::string &  name, Logger *  logger  )

protected

~SECompartment()

SECompartment::~SECompartment ( )

virtual

Member Function Documentation

Clear()

void SECompartment::Clear ( )

virtual

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

FindLeaves()

template<typename CompartmentType >

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

inlinestatic

GetName()

std::string SECompartment::GetName ( ) const

virtual

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

GetScalar()

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

pure virtual

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

HasChildren()

virtual bool SECompartment::HasChildren ( ) const

pure virtual

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

StateChange()

virtual void SECompartment::StateChange ( )

pure virtual

Implemented in SEElectricalCompartment, SEThermalCompartment, SELiquidCompartment, SETissueCompartment, and SEGasCompartment.

Friends And Related Function Documentation

PBCompartment

friend class PBCompartment

friend

Member Data Documentation

m_Name

std::string SECompartment::m_Name

protected