Building Medical Digital Twins with Pulse: Open Source Simulation Tools for Developers and Researchers
Webinar
×
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
SEElectricalCircuitPath Class Reference

#include <SEElectricalCircuitPath.h>

Inheritance diagram for SEElectricalCircuitPath:
SECircuitPath< ELECTRICAL_CIRCUIT_PATH > Loggable

Public Member Functions

virtual ~SEElectricalCircuitPath ()
 
void Clear () override
 
SEElectricalCircuitNode & GetSourceNode () const override
 
SEElectricalCircuitNode & GetTargetNode () const override
 
virtual bool HasCurrent () const
 
virtual SEScalarElectricCurrent & GetCurrent ()
 
virtual double GetCurrent (const ElectricCurrentUnit &unit) const
 
virtual bool HasNextCurrent () const
 
virtual SEScalarElectricCurrent & GetNextCurrent ()
 
virtual double GetNextCurrent (const ElectricCurrentUnit &unit) const
 
bool HasResistance () const override
 
SEScalarElectricResistance & GetResistance () override
 
virtual double GetResistance (const ElectricResistanceUnit &unit) const
 
bool HasNextResistance () const override
 
SEScalarElectricResistance & GetNextResistance () override
 
virtual double GetNextResistance (const ElectricResistanceUnit &unit) const
 
bool HasResistanceBaseline () const override
 
SEScalarElectricResistance & GetResistanceBaseline () override
 
virtual double GetResistanceBaseline (const ElectricResistanceUnit &unit) const
 
virtual void RemoveResistance () override
 
bool HasCapacitance () const override
 
SEScalarElectricCapacitance & GetCapacitance () override
 
virtual double GetCapacitance (const ElectricCapacitanceUnit &unit) const
 
bool HasNextCapacitance () const override
 
SEScalarElectricCapacitance & GetNextCapacitance () override
 
virtual double GetNextCapacitance (const ElectricCapacitanceUnit &unit) const
 
bool HasCapacitanceBaseline () const override
 
SEScalarElectricCapacitance & GetCapacitanceBaseline () override
 
virtual double GetCapacitanceBaseline (const ElectricCapacitanceUnit &unit) const
 
virtual void RemoveCapacitance () override
 
bool HasInductance () const override
 
SEScalarElectricInductance & GetInductance () override
 
virtual double GetInductance (const ElectricInductanceUnit &unit) const
 
bool HasNextInductance () const override
 
SEScalarElectricInductance & GetNextInductance () override
 
virtual double GetNextInductance (const ElectricInductanceUnit &unit) const
 
bool HasInductanceBaseline () const override
 
SEScalarElectricInductance & GetInductanceBaseline () override
 
virtual double GetInductanceBaseline (const ElectricInductanceUnit &unit) const
 
virtual void RemoveInductance () override
 
virtual bool HasCurrentSource () const
 
virtual SEScalarElectricCurrent & GetCurrentSource ()
 
virtual double GetCurrentSource (const ElectricCurrentUnit &unit) const
 
virtual bool HasNextCurrentSource () const
 
virtual SEScalarElectricCurrent & GetNextCurrentSource ()
 
virtual double GetNextCurrentSource (const ElectricCurrentUnit &unit) const
 
virtual bool HasCurrentSourceBaseline () const
 
virtual SEScalarElectricCurrent & GetCurrentSourceBaseline ()
 
virtual double GetCurrentSourceBaseline (const ElectricCurrentUnit &unit) const
 
virtual void RemoveCurrentSource ()
 
virtual bool HasVoltageSource () const
 
virtual SEScalarElectricPotential & GetVoltageSource ()
 
virtual double GetVoltageSource (const ElectricPotentialUnit &unit) const
 
virtual bool HasNextVoltageSource () const
 
virtual SEScalarElectricPotential & GetNextVoltageSource ()
 
virtual double GetNextVoltageSource (const ElectricPotentialUnit &unit) const
 
virtual bool HasVoltageSourceBaseline () const
 
virtual SEScalarElectricPotential & GetVoltageSourceBaseline ()
 
virtual double GetVoltageSourceBaseline (const ElectricPotentialUnit &unit) const
 
virtual void RemoveVoltageSource ()
 
virtual bool HasDiodeBreakdownVoltage () const
 
virtual SEScalarElectricPotential & GetDiodeBreakdownVoltage ()
 
virtual double GetDiodeBreakdownVoltage (const ElectricPotentialUnit &unit) const
 
virtual eGate GetDiode () const
 
virtual void SetDiode (eGate state)
 
virtual void FlipDiode ()
 
virtual bool HasDiode () const
 
virtual void InvalidateDiode ()
 
virtual eGate GetNextDiode () const
 
virtual void SetNextDiode (eGate state)
 
virtual void FlipNextDiode ()
 
virtual bool HasNextDiode () const
 
virtual void InvalidateNextDiode ()
 
virtual void RemoveDiode ()
 
- Public Member Functions inherited from SECircuitPath< ELECTRICAL_CIRCUIT_PATH >
virtual ~SECircuitPath ()
 
virtual std::string GetName () const
 
virtual bool IsPartOfBlackBox () const
 
virtual void SetPartOfBlackBox (bool b)
 
virtual bool HasFlux () const
 
virtual FluxScalar & GetFlux ()
 
virtual bool HasNextFlux () const
 
virtual FluxScalar & GetNextFlux ()
 
virtual bool HasFluxSource () const
 
virtual FluxScalar & GetFluxSource ()
 
virtual bool HasNextFluxSource () const
 
virtual FluxScalar & GetNextFluxSource ()
 
virtual bool HasFluxSourceBaseline () const
 
virtual FluxScalar & GetFluxSourceBaseline ()
 
virtual void RemoveFluxSource ()
 
virtual void RemoveImposedFlux ()
 
virtual bool IsFluxImposed () const
 
virtual void ImposeFlux (const FluxScalar &s)
 
virtual void ImposeFlux (double v, const FluxUnit &unit)
 
virtual bool HasPotentialSource () const
 
virtual PotentialScalar & GetPotentialSource ()
 
virtual bool HasNextPotentialSource () const
 
virtual PotentialScalar & GetNextPotentialSource ()
 
virtual bool HasPotentialSourceBaseline () const
 
virtual PotentialScalar & GetPotentialSourceBaseline ()
 
virtual void RemovePotentialSource ()
 
virtual bool HasValveBreakdownPotential () const
 
virtual PotentialScalar & GetValveBreakdownPotential ()
 
virtual eGate GetSwitch () const
 
virtual void SetSwitch (eGate state)
 
virtual void FlipSwitch ()
 
virtual bool HasSwitch () const
 
virtual void InvalidateSwitch ()
 
virtual eGate GetNextSwitch () const
 
virtual void SetNextSwitch (eGate state)
 
virtual void FlipNextSwitch ()
 
virtual bool HasNextSwitch () const
 
virtual void InvalidateNextSwitch ()
 
virtual void RemoveSwitch ()
 
virtual eGate GetValve () const
 
virtual void SetValve (eGate state)
 
virtual void FlipValve ()
 
virtual bool HasValve () const
 
virtual void InvalidateValve ()
 
virtual eGate GetNextValve () const
 
virtual void SetNextValve (eGate state)
 
virtual void FlipNextValve ()
 
virtual bool HasNextValve () const
 
virtual void InvalidateNextValve ()
 
virtual void RemoveValve ()
 
virtual eGate GetPolarizedState () const
 
virtual void SetPolarizedState (eGate state)
 
virtual void FlipPolarizedState ()
 
virtual bool HasPolarizedState () const
 
virtual void InvalidatePolarizedState ()
 
virtual eGate GetNextPolarizedState () const
 
virtual void SetNextPolarizedState (eGate state)
 
virtual void FlipNextPolarizedState ()
 
virtual bool HasNextPolarizedState () const
 
virtual void InvalidateNextPolarizedState ()
 
virtual bool HasValidElements () const
 
virtual unsigned short NumberOfElements () const
 
virtual unsigned short NumberOfNextElements () const
 
- 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

 SEElectricalCircuitPath (SEElectricalCircuitNode &src, SEElectricalCircuitNode &tgt, const std::string &name)
 
- Protected Member Functions inherited from SECircuitPath< ELECTRICAL_CIRCUIT_PATH >
 SECircuitPath (SECircuitNode< CIRCUIT_NODE_TYPES > &src, SECircuitNode< CIRCUIT_NODE_TYPES > &tgt, const std::string &name)
 

Protected Attributes

SEElectricalCircuitNode & m_ElectricalSourceNode
 
SEElectricalCircuitNode & m_ElectricalTargetNode
 
- Protected Attributes inherited from SECircuitPath< ELECTRICAL_CIRCUIT_PATH >
std::string m_Name
 
SECircuitNode< CIRCUIT_NODE_TYPES > & m_SourceNode
 
SECircuitNode< CIRCUIT_NODE_TYPES > & m_TargetNode
 
unsigned short m_NumElements
 
unsigned short m_NumNextElements
 
bool m_IsPartOfBlackBox
 
eGate m_Switch
 
eGate m_NextSwitch
 
eGate m_Valve
 
eGate m_NextValve
 
eGate m_PolarizedState
 
eGate m_NextPolarizedState
 
ResistanceScalar * m_Resistance
 
ResistanceScalar * m_NextResistance
 
ResistanceScalar * m_ResistanceBaseline
 
CapacitanceScalar * m_Capacitance
 
CapacitanceScalar * m_NextCapacitance
 
CapacitanceScalar * m_CapacitanceBaseline
 
InductanceScalar * m_Inductance
 
InductanceScalar * m_NextInductance
 
InductanceScalar * m_InductanceBaseline
 
FluxScalar * m_Flux
 
FluxScalar * m_NextFlux
 
FluxScalar * m_FluxSource
 
FluxScalar * m_NextFluxSource
 
FluxScalar * m_FluxSourceBaseline
 
eBlackBox_Property_Type m_FluxType
 
PotentialScalar * m_PotentialSource
 
PotentialScalar * m_NextPotentialSource
 
PotentialScalar * m_PotentialSourceBaseline
 
PotentialScalar * m_ValveBreakdownPotential
 
- Protected Attributes inherited from Loggable
bool myLogger
 
Logger * m_Logger
 

Friends

class PBCircuit
 
class SECircuitManager
 

Constructor & Destructor Documentation

◆ SEElectricalCircuitPath()

SEElectricalCircuitPath::SEElectricalCircuitPath ( SEElectricalCircuitNode &  src,
SEElectricalCircuitNode &  tgt,
const std::string &  name 
)
protected

◆ ~SEElectricalCircuitPath()

SEElectricalCircuitPath::~SEElectricalCircuitPath ( )
virtual

Member Function Documentation

◆ Clear()

void SEElectricalCircuitPath::Clear ( )
overridevirtual

Reimplemented from SECircuitPath< ELECTRICAL_CIRCUIT_PATH >.

◆ FlipDiode()

void SEElectricalCircuitPath::FlipDiode ( )
virtual

◆ FlipNextDiode()

void SEElectricalCircuitPath::FlipNextDiode ( )
virtual

◆ GetCapacitance() [1/2]

SEScalarElectricCapacitance & SEElectricalCircuitPath::GetCapacitance ( )
overridevirtual

Reimplemented from SECircuitPath< ELECTRICAL_CIRCUIT_PATH >.

◆ GetCapacitance() [2/2]

double SEElectricalCircuitPath::GetCapacitance ( const ElectricCapacitanceUnit &  unit) const
virtual

◆ GetCapacitanceBaseline() [1/2]

SEScalarElectricCapacitance & SEElectricalCircuitPath::GetCapacitanceBaseline ( )
overridevirtual

Reimplemented from SECircuitPath< ELECTRICAL_CIRCUIT_PATH >.

◆ GetCapacitanceBaseline() [2/2]

double SEElectricalCircuitPath::GetCapacitanceBaseline ( const ElectricCapacitanceUnit &  unit) const
virtual

◆ GetCurrent() [1/2]

SEScalarElectricCurrent & SEElectricalCircuitPath::GetCurrent ( )
virtual

◆ GetCurrent() [2/2]

double SEElectricalCircuitPath::GetCurrent ( const ElectricCurrentUnit &  unit) const
virtual

◆ GetCurrentSource() [1/2]

SEScalarElectricCurrent & SEElectricalCircuitPath::GetCurrentSource ( )
virtual

◆ GetCurrentSource() [2/2]

double SEElectricalCircuitPath::GetCurrentSource ( const ElectricCurrentUnit &  unit) const
virtual

◆ GetCurrentSourceBaseline() [1/2]

SEScalarElectricCurrent & SEElectricalCircuitPath::GetCurrentSourceBaseline ( )
virtual

◆ GetCurrentSourceBaseline() [2/2]

double SEElectricalCircuitPath::GetCurrentSourceBaseline ( const ElectricCurrentUnit &  unit) const
virtual

◆ GetDiode()

virtual eGate SEElectricalCircuitPath::GetDiode ( ) const
virtual

◆ GetDiodeBreakdownVoltage() [1/2]

SEScalarElectricPotential & SEElectricalCircuitPath::GetDiodeBreakdownVoltage ( )
virtual

◆ GetDiodeBreakdownVoltage() [2/2]

double SEElectricalCircuitPath::GetDiodeBreakdownVoltage ( const ElectricPotentialUnit &  unit) const
virtual

◆ GetInductance() [1/2]

SEScalarElectricInductance & SEElectricalCircuitPath::GetInductance ( )
overridevirtual

Reimplemented from SECircuitPath< ELECTRICAL_CIRCUIT_PATH >.

◆ GetInductance() [2/2]

double SEElectricalCircuitPath::GetInductance ( const ElectricInductanceUnit &  unit) const
virtual

◆ GetInductanceBaseline() [1/2]

SEScalarElectricInductance & SEElectricalCircuitPath::GetInductanceBaseline ( )
overridevirtual

Reimplemented from SECircuitPath< ELECTRICAL_CIRCUIT_PATH >.

◆ GetInductanceBaseline() [2/2]

double SEElectricalCircuitPath::GetInductanceBaseline ( const ElectricInductanceUnit &  unit) const
virtual

◆ GetNextCapacitance() [1/2]

SEScalarElectricCapacitance & SEElectricalCircuitPath::GetNextCapacitance ( )
overridevirtual

Reimplemented from SECircuitPath< ELECTRICAL_CIRCUIT_PATH >.

◆ GetNextCapacitance() [2/2]

double SEElectricalCircuitPath::GetNextCapacitance ( const ElectricCapacitanceUnit &  unit) const
virtual

◆ GetNextCurrent() [1/2]

SEScalarElectricCurrent & SEElectricalCircuitPath::GetNextCurrent ( )
virtual

◆ GetNextCurrent() [2/2]

double SEElectricalCircuitPath::GetNextCurrent ( const ElectricCurrentUnit &  unit) const
virtual

◆ GetNextCurrentSource() [1/2]

SEScalarElectricCurrent & SEElectricalCircuitPath::GetNextCurrentSource ( )
virtual

◆ GetNextCurrentSource() [2/2]

double SEElectricalCircuitPath::GetNextCurrentSource ( const ElectricCurrentUnit &  unit) const
virtual

◆ GetNextDiode()

eGate SEElectricalCircuitPath::GetNextDiode ( ) const
virtual

◆ GetNextInductance() [1/2]

SEScalarElectricInductance & SEElectricalCircuitPath::GetNextInductance ( )
overridevirtual

Reimplemented from SECircuitPath< ELECTRICAL_CIRCUIT_PATH >.

◆ GetNextInductance() [2/2]

double SEElectricalCircuitPath::GetNextInductance ( const ElectricInductanceUnit &  unit) const
virtual

◆ GetNextResistance() [1/2]

SEScalarElectricResistance & SEElectricalCircuitPath::GetNextResistance ( )
overridevirtual

Reimplemented from SECircuitPath< ELECTRICAL_CIRCUIT_PATH >.

◆ GetNextResistance() [2/2]

double SEElectricalCircuitPath::GetNextResistance ( const ElectricResistanceUnit &  unit) const
virtual

◆ GetNextVoltageSource() [1/2]

SEScalarElectricPotential & SEElectricalCircuitPath::GetNextVoltageSource ( )
virtual

◆ GetNextVoltageSource() [2/2]

double SEElectricalCircuitPath::GetNextVoltageSource ( const ElectricPotentialUnit &  unit) const
virtual

◆ GetResistance() [1/2]

SEScalarElectricResistance & SEElectricalCircuitPath::GetResistance ( )
overridevirtual

Reimplemented from SECircuitPath< ELECTRICAL_CIRCUIT_PATH >.

◆ GetResistance() [2/2]

double SEElectricalCircuitPath::GetResistance ( const ElectricResistanceUnit &  unit) const
virtual

◆ GetResistanceBaseline() [1/2]

SEScalarElectricResistance & SEElectricalCircuitPath::GetResistanceBaseline ( )
overridevirtual

Reimplemented from SECircuitPath< ELECTRICAL_CIRCUIT_PATH >.

◆ GetResistanceBaseline() [2/2]

double SEElectricalCircuitPath::GetResistanceBaseline ( const ElectricResistanceUnit &  unit) const
virtual

◆ GetSourceNode()

SEElectricalCircuitNode& SEElectricalCircuitPath::GetSourceNode ( ) const
inlineoverridevirtual

Reimplemented from SECircuitPath< ELECTRICAL_CIRCUIT_PATH >.

◆ GetTargetNode()

SEElectricalCircuitNode& SEElectricalCircuitPath::GetTargetNode ( ) const
inlineoverridevirtual

Reimplemented from SECircuitPath< ELECTRICAL_CIRCUIT_PATH >.

◆ GetVoltageSource() [1/2]

SEScalarElectricPotential & SEElectricalCircuitPath::GetVoltageSource ( )
virtual

◆ GetVoltageSource() [2/2]

double SEElectricalCircuitPath::GetVoltageSource ( const ElectricPotentialUnit &  unit) const
virtual

◆ GetVoltageSourceBaseline() [1/2]

SEScalarElectricPotential & SEElectricalCircuitPath::GetVoltageSourceBaseline ( )
virtual

◆ GetVoltageSourceBaseline() [2/2]

double SEElectricalCircuitPath::GetVoltageSourceBaseline ( const ElectricPotentialUnit &  unit) const
virtual

◆ HasCapacitance()

bool SEElectricalCircuitPath::HasCapacitance ( ) const
overridevirtual

Reimplemented from SECircuitPath< ELECTRICAL_CIRCUIT_PATH >.

◆ HasCapacitanceBaseline()

bool SEElectricalCircuitPath::HasCapacitanceBaseline ( ) const
overridevirtual

Reimplemented from SECircuitPath< ELECTRICAL_CIRCUIT_PATH >.

◆ HasCurrent()

bool SEElectricalCircuitPath::HasCurrent ( ) const
virtual

◆ HasCurrentSource()

bool SEElectricalCircuitPath::HasCurrentSource ( ) const
virtual

◆ HasCurrentSourceBaseline()

bool SEElectricalCircuitPath::HasCurrentSourceBaseline ( ) const
virtual

◆ HasDiode()

bool SEElectricalCircuitPath::HasDiode ( ) const
virtual

◆ HasDiodeBreakdownVoltage()

bool SEElectricalCircuitPath::HasDiodeBreakdownVoltage ( ) const
virtual

◆ HasInductance()

bool SEElectricalCircuitPath::HasInductance ( ) const
overridevirtual

Reimplemented from SECircuitPath< ELECTRICAL_CIRCUIT_PATH >.

◆ HasInductanceBaseline()

bool SEElectricalCircuitPath::HasInductanceBaseline ( ) const
overridevirtual

Reimplemented from SECircuitPath< ELECTRICAL_CIRCUIT_PATH >.

◆ HasNextCapacitance()

bool SEElectricalCircuitPath::HasNextCapacitance ( ) const
overridevirtual

Reimplemented from SECircuitPath< ELECTRICAL_CIRCUIT_PATH >.

◆ HasNextCurrent()

bool SEElectricalCircuitPath::HasNextCurrent ( ) const
virtual

◆ HasNextCurrentSource()

bool SEElectricalCircuitPath::HasNextCurrentSource ( ) const
virtual

◆ HasNextDiode()

bool SEElectricalCircuitPath::HasNextDiode ( ) const
virtual

◆ HasNextInductance()

bool SEElectricalCircuitPath::HasNextInductance ( ) const
overridevirtual

Reimplemented from SECircuitPath< ELECTRICAL_CIRCUIT_PATH >.

◆ HasNextResistance()

bool SEElectricalCircuitPath::HasNextResistance ( ) const
overridevirtual

Reimplemented from SECircuitPath< ELECTRICAL_CIRCUIT_PATH >.

◆ HasNextVoltageSource()

bool SEElectricalCircuitPath::HasNextVoltageSource ( ) const
virtual

◆ HasResistance()

bool SEElectricalCircuitPath::HasResistance ( ) const
overridevirtual

Reimplemented from SECircuitPath< ELECTRICAL_CIRCUIT_PATH >.

◆ HasResistanceBaseline()

bool SEElectricalCircuitPath::HasResistanceBaseline ( ) const
overridevirtual

Reimplemented from SECircuitPath< ELECTRICAL_CIRCUIT_PATH >.

◆ HasVoltageSource()

bool SEElectricalCircuitPath::HasVoltageSource ( ) const
virtual

◆ HasVoltageSourceBaseline()

bool SEElectricalCircuitPath::HasVoltageSourceBaseline ( ) const
virtual

◆ InvalidateDiode()

void SEElectricalCircuitPath::InvalidateDiode ( )
virtual

◆ InvalidateNextDiode()

void SEElectricalCircuitPath::InvalidateNextDiode ( )
virtual

◆ RemoveCapacitance()

void SEElectricalCircuitPath::RemoveCapacitance ( )
overridevirtual

Reimplemented from SECircuitPath< ELECTRICAL_CIRCUIT_PATH >.

◆ RemoveCurrentSource()

void SEElectricalCircuitPath::RemoveCurrentSource ( )
virtual

◆ RemoveDiode()

void SEElectricalCircuitPath::RemoveDiode ( )
virtual

◆ RemoveInductance()

void SEElectricalCircuitPath::RemoveInductance ( )
overridevirtual

Reimplemented from SECircuitPath< ELECTRICAL_CIRCUIT_PATH >.

◆ RemoveResistance()

void SEElectricalCircuitPath::RemoveResistance ( )
overridevirtual

Reimplemented from SECircuitPath< ELECTRICAL_CIRCUIT_PATH >.

◆ RemoveVoltageSource()

void SEElectricalCircuitPath::RemoveVoltageSource ( )
virtual

◆ SetDiode()

void SEElectricalCircuitPath::SetDiode ( eGate  state)
virtual

◆ SetNextDiode()

void SEElectricalCircuitPath::SetNextDiode ( eGate  state)
virtual

Friends And Related Function Documentation

◆ PBCircuit

friend class PBCircuit
friend

◆ SECircuitManager

friend class SECircuitManager
friend

Member Data Documentation

◆ m_ElectricalSourceNode

SEElectricalCircuitNode& SEElectricalCircuitPath::m_ElectricalSourceNode
protected

◆ m_ElectricalTargetNode

SEElectricalCircuitNode& SEElectricalCircuitPath::m_ElectricalTargetNode
protected

Distributed under the Apache License, Version 2.0.

See accompanying NOTICE file for details.