biogears::SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE > Class Template Referenceabstract

#include <SEFluidCompartment.h>

Inheritance diagram for biogears::SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >:

Public Member Functions

virtual ~SEFluidCompartmentLink ()
 
virtual void Clear () override
 
virtual bool Load (const CDM::FluidCompartmentLinkData &in, SECircuitManager *circuits=nullptr)
 
virtual CDM::FluidCompartmentLinkDataUnload () override=0
 
virtual const SEScalarGetScalar (const char *name) override
 
virtual const SEScalarGetScalar (const std::string &name) override
 
virtual std::string GetName () const override
 
virtual const char * GetName_cStr () const override
 
virtual bool HasFlow () const
 
virtual SEScalarVolumePerTimeGetFlow ()
 
virtual double GetFlow (const VolumePerTimeUnit &unit) const
 
virtual CompartmentType & GetSourceCompartment ()
 
virtual CompartmentType & GetTargetCompartment ()
 
virtual bool HasPath ()
 
virtual SEFluidCircuitPathGetPath ()
 
virtual void RemovePath ()
 
virtual void MapPath (SEFluidCircuitPath &path)
 
- Public Member Functions inherited from biogears::Loggable
 Loggable ()
 
 Loggable (Logger *log)
 
virtual ~Loggable ()
 
virtual LoggerGetLogger () const
 

Protected Member Functions

 SEFluidCompartmentLink (CompartmentType &src, CompartmentType &tgt, const char *name)
 
 SEFluidCompartmentLink (CompartmentType &src, CompartmentType &tgt, const std::string &name)
 
virtual void Unload (CDM::FluidCompartmentLinkData &data)
 
virtual bool HasFlux () const override
 
virtual SEScalarVolumePerTimeGetFlux () override
 
virtual double GetFlux (const VolumePerTimeUnit &unit) const
 
virtual VertexType & GetSourceVertex () override
 
virtual VertexType & GetTargetVertex () override
 
- 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

SEScalarVolumePerTimem_Flow
 
CompartmentType & m_SourceCmpt
 
CompartmentType & m_TargetCmpt
 
VertexType & m_SourceVertex
 
VertexType & m_TargetVertex
 
SEFluidCircuitPathm_Path
 
- Protected Attributes inherited from biogears::Loggable
Loggerm_Logger
 

Additional Inherited Members

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

Constructor & Destructor Documentation

template<FLUID_COMPARTMENT_LINK_TEMPLATE >
biogears::SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::SEFluidCompartmentLink ( CompartmentType &  src,
CompartmentType &  tgt,
const char *  name 
)
protected
template<FLUID_COMPARTMENT_LINK_TEMPLATE >
biogears::SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::SEFluidCompartmentLink ( CompartmentType &  src,
CompartmentType &  tgt,
const std::string &  name 
)
protected
template<FLUID_COMPARTMENT_LINK_TEMPLATE >
virtual biogears::SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::~SEFluidCompartmentLink ( )
virtual

Member Function Documentation

template<FLUID_COMPARTMENT_LINK_TEMPLATE >
virtual void biogears::SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::Clear ( )
overridevirtual

Reimplemented from biogears::SECompartmentLink.

template<FLUID_COMPARTMENT_LINK_TEMPLATE >
virtual SEScalarVolumePerTime& biogears::SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::GetFlow ( )
virtual
template<FLUID_COMPARTMENT_LINK_TEMPLATE >
virtual double biogears::SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::GetFlow ( const VolumePerTimeUnit unit) const
virtual
template<FLUID_COMPARTMENT_LINK_TEMPLATE >
virtual SEScalarVolumePerTime& biogears::SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::GetFlux ( )
inlineoverrideprotectedvirtual
template<FLUID_COMPARTMENT_LINK_TEMPLATE >
virtual double biogears::SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::GetFlux ( const VolumePerTimeUnit unit) const
inlineprotectedvirtual
template<FLUID_COMPARTMENT_LINK_TEMPLATE >
virtual std::string biogears::SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::GetName ( ) const
overridevirtual

Reimplemented from biogears::SECompartmentLink.

template<FLUID_COMPARTMENT_LINK_TEMPLATE >
virtual const char* biogears::SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::GetName_cStr ( ) const
overridevirtual

Reimplemented from biogears::SECompartmentLink.

template<FLUID_COMPARTMENT_LINK_TEMPLATE >
virtual SEFluidCircuitPath* biogears::SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::GetPath ( )
inlinevirtual
template<FLUID_COMPARTMENT_LINK_TEMPLATE >
virtual const SEScalar* biogears::SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::GetScalar ( const char *  name)
overridevirtual
template<FLUID_COMPARTMENT_LINK_TEMPLATE >
virtual const SEScalar* biogears::SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::GetScalar ( const std::string &  name)
overridevirtual
template<FLUID_COMPARTMENT_LINK_TEMPLATE >
virtual CompartmentType& biogears::SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::GetSourceCompartment ( )
inlinevirtual
template<FLUID_COMPARTMENT_LINK_TEMPLATE >
virtual VertexType& biogears::SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::GetSourceVertex ( )
inlineoverrideprotectedvirtual
template<FLUID_COMPARTMENT_LINK_TEMPLATE >
virtual CompartmentType& biogears::SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::GetTargetCompartment ( )
inlinevirtual
template<FLUID_COMPARTMENT_LINK_TEMPLATE >
virtual VertexType& biogears::SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::GetTargetVertex ( )
inlineoverrideprotectedvirtual
template<FLUID_COMPARTMENT_LINK_TEMPLATE >
virtual bool biogears::SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::HasFlow ( ) const
virtual
template<FLUID_COMPARTMENT_LINK_TEMPLATE >
virtual bool biogears::SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::HasFlux ( ) const
inlineoverrideprotectedvirtual
template<FLUID_COMPARTMENT_LINK_TEMPLATE >
virtual bool biogears::SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::HasPath ( )
inlinevirtual
template<FLUID_COMPARTMENT_LINK_TEMPLATE >
virtual bool biogears::SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::Load ( const CDM::FluidCompartmentLinkData in,
SECircuitManager circuits = nullptr 
)
virtual
template<FLUID_COMPARTMENT_LINK_TEMPLATE >
virtual void biogears::SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::MapPath ( SEFluidCircuitPath path)
inlinevirtual
template<FLUID_COMPARTMENT_LINK_TEMPLATE >
virtual void biogears::SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::RemovePath ( )
inlinevirtual
template<FLUID_COMPARTMENT_LINK_TEMPLATE >
virtual CDM::FluidCompartmentLinkData* biogears::SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::Unload ( )
overridepure virtual
template<FLUID_COMPARTMENT_LINK_TEMPLATE >
virtual void biogears::SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::Unload ( CDM::FluidCompartmentLinkData data)
protectedvirtual

Member Data Documentation

template<FLUID_COMPARTMENT_LINK_TEMPLATE >
SEScalarVolumePerTime* biogears::SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::m_Flow
protected
template<FLUID_COMPARTMENT_LINK_TEMPLATE >
SEFluidCircuitPath* biogears::SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::m_Path
protected
template<FLUID_COMPARTMENT_LINK_TEMPLATE >
CompartmentType& biogears::SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::m_SourceCmpt
protected
template<FLUID_COMPARTMENT_LINK_TEMPLATE >
VertexType& biogears::SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::m_SourceVertex
protected
template<FLUID_COMPARTMENT_LINK_TEMPLATE >
CompartmentType& biogears::SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::m_TargetCmpt
protected
template<FLUID_COMPARTMENT_LINK_TEMPLATE >
VertexType& biogears::SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::m_TargetVertex
protected