#include <SEElectricalCompartmentLink.h>

Inherits SECompartmentLink.

Public Member Functions

virtual ~SEElectricalCompartmentLink ()
 
virtual void Clear ()
 
virtual const SEScalarGetScalar (const std::string &name)
 
virtual bool HasCurrent () const
 
virtual SEScalarElectricCurrentGetCurrent ()
 
virtual double GetCurrent (const ElectricCurrentUnit &unit) const
 
virtual SEElectricalCompartmentGetSourceCompartment ()
 
virtual SEElectricalCompartmentGetTargetCompartment ()
 
virtual bool HasPath ()
 
virtual SEElectricalCircuitPathGetPath ()
 
virtual void RemovePath ()
 
virtual void MapPath (SEElectricalCircuitPath &path)
 
virtual bool HasBlackBox () const
 
virtual SEElectricalBlackBoxGetBlackBox ()
 
virtual const SEElectricalBlackBoxGetBlackBox () const
 
virtual void SetBlackBox (SEElectricalBlackBox *bb)
 
- Public Member Functions inherited from Loggable
 Loggable (Logger *logger=nullptr)
 
 Loggable (std::string const &logfile)
 
virtual ~Loggable ()
 
virtual LoggerGetLogger () 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
 

Protected Member Functions

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

Protected Attributes

SEScalarElectricCurrentm_Current
 
SEElectricalCompartmentm_SourceCmpt
 
SEElectricalCompartmentm_TargetCmpt
 
SEElectricalCircuitPathm_Path
 
SEElectricalBlackBoxm_BlackBox = nullptr
 
- Protected Attributes inherited from Loggable
bool myLogger
 
Loggerm_Logger
 

Friends

class PBCompartment
 
class SECompartmentManager
 

Additional Inherited Members

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

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 ( )
virtual

Reimplemented from SECompartmentLink.

◆ GetBlackBox() [1/2]

virtual SEElectricalBlackBox* SEElectricalCompartmentLink::GetBlackBox ( )
inlinevirtual

◆ GetBlackBox() [2/2]

virtual const SEElectricalBlackBox* SEElectricalCompartmentLink::GetBlackBox ( ) const
inlinevirtual

◆ 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)
virtual

Implements SECompartmentLink.

◆ GetSourceCompartment()

virtual SEElectricalCompartment& SEElectricalCompartmentLink::GetSourceCompartment ( )
inlinevirtual

◆ GetTargetCompartment()

virtual SEElectricalCompartment& SEElectricalCompartmentLink::GetTargetCompartment ( )
inlinevirtual

◆ HasBlackBox()

virtual bool SEElectricalCompartmentLink::HasBlackBox ( ) const
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

◆ SetBlackBox()

virtual void SEElectricalCompartmentLink::SetBlackBox ( SEElectricalBlackBox bb)
inlinevirtual

Friends And Related Function Documentation

◆ PBCompartment

friend class PBCompartment
friend

◆ SECompartmentManager

friend class SECompartmentManager
friend

Member Data Documentation

◆ m_BlackBox

SEElectricalBlackBox* SEElectricalCompartmentLink::m_BlackBox = nullptr
protected

◆ 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

Distributed under the Apache License, Version 2.0.

See accompanying NOTICE file for details.