SEElectricalCompartmentLink Class Reference

#include <SEElectricalCompartmentLink.h>

Inherits SECompartmentLink.

Public Member Functions
virtual	~SEElectricalCompartmentLink ()
void	Clear () override
const SEScalar *	GetScalar (const std::string &name) override
virtual bool	HasCurrent () const
virtual SEScalarElectricCurrent &	GetCurrent ()
virtual double	GetCurrent (const ElectricCurrentUnit &unit) const
virtual SEElectricalCompartment &	GetSourceCompartment ()
virtual SEElectricalCompartment &	GetTargetCompartment ()
virtual bool	HasPath ()
virtual SEElectricalCircuitPath *	GetPath ()
virtual void	RemovePath ()
virtual void	MapPath (SEElectricalCircuitPath &path)
Public Member Functions inherited from SECompartmentLink
virtual	~SECompartmentLink ()
virtual void	Clear ()
virtual std::string	GetName () const
virtual const SEScalar *	GetScalar (const std::string &name)=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
	SEElectricalCompartmentLink (SEElectricalCompartment &src, SEElectricalCompartment &tgt, const std::string &name)
Protected Member Functions inherited from SECompartmentLink
	SECompartmentLink (const std::string &nam, Logger *logger)

Protected Attributes
SEScalarElectricCurrent *	m_Current
SEElectricalCompartment &	m_SourceCmpt
SEElectricalCompartment &	m_TargetCmpt
SEElectricalCircuitPath *	m_Path
Protected Attributes inherited from SECompartmentLink
std::string	m_Name
Protected Attributes inherited from Loggable
bool	myLogger
Logger *	m_Logger

Friends
class	PBCompartment
class	SECompartmentManager

Constructor & Destructor Documentation

SEElectricalCompartmentLink()

SEElectricalCompartmentLink::SEElectricalCompartmentLink ( SEElectricalCompartment &  src, SEElectricalCompartment &  tgt, const std::string &  name  )

protected

~SEElectricalCompartmentLink()

SEElectricalCompartmentLink::~SEElectricalCompartmentLink ( )

virtual

Member Function Documentation

Clear()

void SEElectricalCompartmentLink::Clear ( )

overridevirtual

Reimplemented from SECompartmentLink.

GetCurrent() [1/2]

SEScalarElectricCurrent & SEElectricalCompartmentLink::GetCurrent ( )

virtual

GetCurrent() [2/2]

double SEElectricalCompartmentLink::GetCurrent ( const ElectricCurrentUnit &  unit ) const

virtual

GetPath()

virtual SEElectricalCircuitPath * SEElectricalCompartmentLink::GetPath ( )

inlinevirtual

GetScalar()

const SEScalar * SEElectricalCompartmentLink::GetScalar ( const std::string &  name )

overridevirtual

Implements SECompartmentLink.

GetSourceCompartment()

virtual SEElectricalCompartment & SEElectricalCompartmentLink::GetSourceCompartment ( )

inlinevirtual

GetTargetCompartment()

virtual SEElectricalCompartment & SEElectricalCompartmentLink::GetTargetCompartment ( )

inlinevirtual

HasCurrent()

bool SEElectricalCompartmentLink::HasCurrent ( ) const

virtual

HasPath()

virtual bool SEElectricalCompartmentLink::HasPath ( )

inlinevirtual

MapPath()

virtual void SEElectricalCompartmentLink::MapPath ( SEElectricalCircuitPath &  path )

inlinevirtual

RemovePath()

virtual void SEElectricalCompartmentLink::RemovePath ( )

inlinevirtual

Friends And Related Function Documentation

PBCompartment

friend class PBCompartment

friend

SECompartmentManager

friend class SECompartmentManager

friend

Member Data Documentation

m_Current

SEScalarElectricCurrent* SEElectricalCompartmentLink::m_Current

protected

m_Path

SEElectricalCircuitPath* SEElectricalCompartmentLink::m_Path

protected

m_SourceCmpt

SEElectricalCompartment& SEElectricalCompartmentLink::m_SourceCmpt

protected

m_TargetCmpt

SEElectricalCompartment& SEElectricalCompartmentLink::m_TargetCmpt

protected