Public Member Functions |
Protected Member Functions |
Protected Attributes |
Friends |
List of all members
SEElectricalCompartment Class Reference
#include <SEElectricalCompartment.h>
Inherits SECompartment.
Public Member Functions | |
virtual | ~SEElectricalCompartment () |
void | Clear () override |
const SEScalar * | GetScalar (const std::string &name) override |
virtual bool | HasChildren () const override |
virtual const std::vector< SEElectricalCompartment * > & | GetChildren () |
virtual const std::vector< SEElectricalCompartment * > & | GetLeaves () |
virtual bool | HasNodeMapping () const |
virtual SECompartmentNodes< ELECTRICAL_COMPARTMENT_NODE > & | GetNodeMapping () |
virtual void | MapNode (SEElectricalCircuitNode &node) |
void | StateChange () override |
virtual bool | HasCurrentIn () const |
virtual const SEScalarElectricCurrent & | GetCurrentIn () const |
virtual double | GetCurrentIn (const ElectricCurrentUnit &unit) const |
virtual bool | HasCurrentOut () const |
virtual const SEScalarElectricCurrent & | GetCurrentOut () const |
virtual double | GetCurrentOut (const ElectricCurrentUnit &unit) const |
virtual bool | HasCharge () const |
virtual SEScalarElectricCharge & | GetCharge () |
virtual double | GetCharge (const ElectricChargeUnit &unit) const |
virtual bool | HasVoltage () const |
virtual SEScalarElectricPotential & | GetVoltage () |
virtual double | GetVoltage (const ElectricPotentialUnit &unit) const |
virtual void | AddLink (SEElectricalCompartmentLink &link) |
virtual void | RemoveLink (SEElectricalCompartmentLink &link) |
virtual void | RemoveLinks () |
virtual const std::vector< SEElectricalCompartmentLink * > & | GetLinks () |
virtual bool | HasChild (const SEElectricalCompartment &cmpt) |
virtual void | AddChild (SEElectricalCompartment &child) |
Public Member Functions inherited from SECompartment | |
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) const |
virtual void | Debug (std::stringstream &msg) const |
virtual void | Debug (std::ostream &msg) const |
virtual void | Info (std::string const &msg) const |
virtual void | Info (std::stringstream &msg) const |
virtual void | Info (const std::stringstream &msg) const |
virtual void | Info (std::ostream &msg) const |
virtual void | Warning (std::string const &msg) const |
virtual void | Warning (std::stringstream &msg) const |
virtual void | Warning (std::ostream &msg) const |
virtual void | Error (std::string const &msg) const |
virtual void | Error (std::stringstream &msg) const |
virtual void | Error (std::ostream &msg) const |
virtual void | Fatal (std::string const &msg) const |
virtual void | Fatal (std::stringstream &msg) const |
virtual void | Fatal (std::ostream &msg) const |
Protected Member Functions | |
SEElectricalCompartment (const std::string &name, Logger *logger) | |
virtual double | CalculateInFlow_A () const |
virtual double | CalculateOutFlow_A () const |
Protected Member Functions inherited from SECompartment | |
SECompartment (const std::string &name, Logger *logger) | |
Protected Attributes | |
SEScalarElectricCurrent * | m_CurrentIn |
SEScalarElectricCurrent * | m_CurrentOut |
SEScalarElectricCharge * | m_Charge |
SEScalarElectricPotential * | m_Voltage |
std::vector< SEElectricalCompartmentLink * > | m_Links |
std::vector< SEElectricalCompartmentLink * > | m_IncomingLinks |
std::vector< SEElectricalCompartmentLink * > | m_OutgoingLinks |
std::vector< SEElectricalCompartment * > | m_Children |
std::vector< SEElectricalCompartment * > | m_Leaves |
SECompartmentNodes< ELECTRICAL_COMPARTMENT_NODE > | m_Nodes |
Protected Attributes inherited from SECompartment | |
std::string | m_Name |
Protected Attributes inherited from Loggable | |
bool | myLogger |
Logger * | m_Logger |
Friends | |
class | PBCompartment |
class | SECompartmentManager |
template<typename CompartmentType , typename CompartmentLinkType > | |
class | SECompartmentGraph |
Additional Inherited Members | |
Static Public Member Functions inherited from SECompartment | |
template<typename CompartmentType > | |
static void | FindLeaves (CompartmentType &cmpt, std::vector< CompartmentType * > &leaves) |
Constructor & Destructor Documentation
◆ SEElectricalCompartment()
|
protected |
◆ ~SEElectricalCompartment()
|
virtual |
Member Function Documentation
◆ AddChild()
|
virtual |
◆ AddLink()
|
virtual |
◆ CalculateInFlow_A()
|
protectedvirtual |
◆ CalculateOutFlow_A()
|
protectedvirtual |
◆ Clear()
|
overridevirtual |
Reimplemented from SECompartment.
◆ GetCharge() [1/2]
|
virtual |
◆ GetCharge() [2/2]
|
virtual |
◆ GetChildren()
|
inlinevirtual |
◆ GetCurrentIn() [1/2]
|
virtual |
◆ GetCurrentIn() [2/2]
|
virtual |
◆ GetCurrentOut() [1/2]
|
virtual |
◆ GetCurrentOut() [2/2]
|
virtual |
◆ GetLeaves()
|
inlinevirtual |
◆ GetLinks()
|
virtual |
◆ GetNodeMapping()
|
inlinevirtual |
◆ GetScalar()
|
overridevirtual |
Implements SECompartment.
◆ GetVoltage() [1/2]
|
virtual |
◆ GetVoltage() [2/2]
|
virtual |
◆ HasCharge()
|
virtual |
◆ HasChild()
|
virtual |
◆ HasChildren()
|
inlineoverridevirtual |
Implements SECompartment.
◆ HasCurrentIn()
|
virtual |
◆ HasCurrentOut()
|
virtual |
◆ HasNodeMapping()
|
inlinevirtual |
◆ HasVoltage()
|
virtual |
◆ MapNode()
|
virtual |
◆ RemoveLink()
|
virtual |
◆ RemoveLinks()
|
virtual |
◆ StateChange()
|
overridevirtual |
Implements SECompartment.
Friends And Related Function Documentation
◆ PBCompartment
|
friend |
◆ SECompartmentGraph
template<typename CompartmentType , typename CompartmentLinkType >
|
friend |
◆ SECompartmentManager
|
friend |
Member Data Documentation
◆ m_Charge
|
protected |
◆ m_Children
|
protected |
◆ m_CurrentIn
|
mutableprotected |
◆ m_CurrentOut
|
mutableprotected |
◆ m_IncomingLinks
|
protected |
◆ m_Leaves
|
protected |
◆ m_Links
|
protected |
◆ m_Nodes
|
protected |
◆ m_OutgoingLinks
|
protected |
◆ m_Voltage
|
protected |