SECompartmentNodes< COMPARTMENT_NODE_TEMPLATE > Class Template Reference

#include <SECompartmentNodes.h>

Inherits Loggable.

Public Member Functions

 SECompartmentNodes (Logger *logger)
 
virtual ~SECompartmentNodes ()
 
virtual void Clear ()
 
virtual void StateChange ()
 
virtual bool HasMapping () const
 
virtual const std::vector< NodeType * > & GetNodes () const
 
virtual void RemoveNode (NodeType &node)
 
virtual void MapNode (NodeType &node)
 
virtual bool HasQuantity () const
 
virtual QuantityScalar & GetQuantity ()
 
virtual double GetQuantity (const QuantityUnit &unit) const
 
virtual bool HasPotential () const
 
virtual PotentialScalar & GetPotential ()
 
virtual double GetPotential (const PotentialUnit &unit) const
 
- Public Member Functions inherited from Loggable
 Loggable ()
 
 Loggable (Logger *log)
 
virtual ~Loggable ()
 
virtual LoggerGetLogger () const
 
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
 

Protected Member Functions

void SortNode (NodeType &node)
 
virtual const std::vector< NodeType * > & GetAllNodes () const
 
virtual const std::vector< NodeType * > & GetQuantityNodes () const
 

Protected Attributes

std::vector< NodeType * > m_QuantityNodes
 
std::vector< NodeType * > m_AllNodes
 
QuantityScalar * m_Quantity
 
PotentialScalar * m_Potential
 
- Protected Attributes inherited from Loggable
Loggerm_Logger
 

Friends

class PBCompartment
 

Additional Inherited Members

- Static Public Attributes inherited from Loggable
static const std::string empty
 

Constructor & Destructor Documentation

◆ SECompartmentNodes()

template<COMPARTMENT_NODE_TEMPLATE >
SECompartmentNodes< COMPARTMENT_NODE_TEMPLATE >::SECompartmentNodes ( Logger logger)

◆ ~SECompartmentNodes()

template<COMPARTMENT_NODE_TEMPLATE >
virtual SECompartmentNodes< COMPARTMENT_NODE_TEMPLATE >::~SECompartmentNodes ( )
virtual

Member Function Documentation

◆ Clear()

template<COMPARTMENT_NODE_TEMPLATE >
virtual void SECompartmentNodes< COMPARTMENT_NODE_TEMPLATE >::Clear ( )
virtual

◆ GetAllNodes()

template<COMPARTMENT_NODE_TEMPLATE >
virtual const std::vector<NodeType*>& SECompartmentNodes< COMPARTMENT_NODE_TEMPLATE >::GetAllNodes ( ) const
inlineprotectedvirtual

◆ GetNodes()

template<COMPARTMENT_NODE_TEMPLATE >
virtual const std::vector<NodeType*>& SECompartmentNodes< COMPARTMENT_NODE_TEMPLATE >::GetNodes ( ) const
inlinevirtual

◆ GetPotential() [1/2]

template<COMPARTMENT_NODE_TEMPLATE >
virtual PotentialScalar& SECompartmentNodes< COMPARTMENT_NODE_TEMPLATE >::GetPotential ( )
virtual

◆ GetPotential() [2/2]

template<COMPARTMENT_NODE_TEMPLATE >
virtual double SECompartmentNodes< COMPARTMENT_NODE_TEMPLATE >::GetPotential ( const PotentialUnit &  unit) const
virtual

◆ GetQuantity() [1/2]

template<COMPARTMENT_NODE_TEMPLATE >
virtual QuantityScalar& SECompartmentNodes< COMPARTMENT_NODE_TEMPLATE >::GetQuantity ( )
virtual

◆ GetQuantity() [2/2]

template<COMPARTMENT_NODE_TEMPLATE >
virtual double SECompartmentNodes< COMPARTMENT_NODE_TEMPLATE >::GetQuantity ( const QuantityUnit &  unit) const
virtual

◆ GetQuantityNodes()

template<COMPARTMENT_NODE_TEMPLATE >
virtual const std::vector<NodeType*>& SECompartmentNodes< COMPARTMENT_NODE_TEMPLATE >::GetQuantityNodes ( ) const
inlineprotectedvirtual

◆ HasMapping()

template<COMPARTMENT_NODE_TEMPLATE >
virtual bool SECompartmentNodes< COMPARTMENT_NODE_TEMPLATE >::HasMapping ( ) const
inlinevirtual

◆ HasPotential()

template<COMPARTMENT_NODE_TEMPLATE >
virtual bool SECompartmentNodes< COMPARTMENT_NODE_TEMPLATE >::HasPotential ( ) const
virtual

◆ HasQuantity()

template<COMPARTMENT_NODE_TEMPLATE >
virtual bool SECompartmentNodes< COMPARTMENT_NODE_TEMPLATE >::HasQuantity ( ) const
inlinevirtual

◆ MapNode()

template<COMPARTMENT_NODE_TEMPLATE >
virtual void SECompartmentNodes< COMPARTMENT_NODE_TEMPLATE >::MapNode ( NodeType &  node)
virtual

◆ RemoveNode()

template<COMPARTMENT_NODE_TEMPLATE >
virtual void SECompartmentNodes< COMPARTMENT_NODE_TEMPLATE >::RemoveNode ( NodeType &  node)
virtual

◆ SortNode()

template<COMPARTMENT_NODE_TEMPLATE >
void SECompartmentNodes< COMPARTMENT_NODE_TEMPLATE >::SortNode ( NodeType &  node)
protected

◆ StateChange()

template<COMPARTMENT_NODE_TEMPLATE >
virtual void SECompartmentNodes< COMPARTMENT_NODE_TEMPLATE >::StateChange ( )
virtual

Friends And Related Function Documentation

◆ PBCompartment

template<COMPARTMENT_NODE_TEMPLATE >
friend class PBCompartment
friend

Member Data Documentation

◆ m_AllNodes

template<COMPARTMENT_NODE_TEMPLATE >
std::vector<NodeType*> SECompartmentNodes< COMPARTMENT_NODE_TEMPLATE >::m_AllNodes
protected

◆ m_Potential

template<COMPARTMENT_NODE_TEMPLATE >
PotentialScalar* SECompartmentNodes< COMPARTMENT_NODE_TEMPLATE >::m_Potential
protected

◆ m_Quantity

template<COMPARTMENT_NODE_TEMPLATE >
QuantityScalar* SECompartmentNodes< COMPARTMENT_NODE_TEMPLATE >::m_Quantity
protected

◆ m_QuantityNodes

template<COMPARTMENT_NODE_TEMPLATE >
std::vector<NodeType*> SECompartmentNodes< COMPARTMENT_NODE_TEMPLATE >::m_QuantityNodes
protected