biogears::SEElectricalCircuitPath Class Reference

#include <SEElectricalCircuitPath.h>

Inheritance diagram for biogears::SEElectricalCircuitPath:

Public Member Functions

virtual ~SEElectricalCircuitPath ()
 
virtual void Clear ()
 
bool Load (const CDM::ElectricalCircuitPathData &in)
 
CDM::ElectricalCircuitPathDataUnload () const
 
virtual SEElectricalCircuitNodeGetSourceNode () const
 
virtual SEElectricalCircuitNodeGetTargetNode () const
 
virtual bool HasResistance () const
 
virtual SEScalarElectricResistanceGetResistance ()
 
virtual double GetResistance (const ElectricResistanceUnit &unit) const
 
virtual bool HasNextResistance () const
 
virtual SEScalarElectricResistanceGetNextResistance ()
 
virtual double GetNextResistance (const ElectricResistanceUnit &unit) const
 
virtual bool HasResistanceBaseline () const
 
virtual SEScalarElectricResistanceGetResistanceBaseline ()
 
virtual double GetResistanceBaseline (const ElectricResistanceUnit &unit) const
 
virtual bool HasCapacitance () const
 
virtual SEScalarElectricCapacitanceGetCapacitance ()
 
virtual double GetCapacitance (const ElectricCapacitanceUnit &unit) const
 
virtual bool HasNextCapacitance () const
 
virtual SEScalarElectricCapacitanceGetNextCapacitance ()
 
virtual double GetNextCapacitance (const ElectricCapacitanceUnit &unit) const
 
virtual bool HasCapacitanceBaseline () const
 
virtual SEScalarElectricCapacitanceGetCapacitanceBaseline ()
 
virtual double GetCapacitanceBaseline (const ElectricCapacitanceUnit &unit) const
 
virtual bool HasInductance () const
 
virtual SEScalarElectricInductanceGetInductance ()
 
virtual double GetInductance (const ElectricInductanceUnit &unit) const
 
virtual bool HasNextInductance () const
 
virtual SEScalarElectricInductanceGetNextInductance ()
 
virtual double GetNextInductance (const ElectricInductanceUnit &unit) const
 
virtual bool HasInductanceBaseline () const
 
virtual SEScalarElectricInductanceGetInductanceBaseline ()
 
virtual double GetInductanceBaseline (const ElectricInductanceUnit &unit) const
 
virtual bool HasCurrent () const
 
virtual SEScalarElectricCurrentGetCurrent ()
 
virtual double GetCurrent (const ElectricCurrentUnit &unit) const
 
virtual bool HasNextCurrent () const
 
virtual SEScalarElectricCurrentGetNextCurrent ()
 
virtual double GetNextCurrent (const ElectricCurrentUnit &unit) const
 
virtual bool HasCurrentSource () const
 
virtual SEScalarElectricCurrentGetCurrentSource ()
 
virtual double GetCurrentSource (const ElectricCurrentUnit &unit) const
 
virtual bool HasNextCurrentSource () const
 
virtual SEScalarElectricCurrentGetNextCurrentSource ()
 
virtual double GetNextCurrentSource (const ElectricCurrentUnit &unit) const
 
virtual bool HasCurrentSourceBaseline () const
 
virtual SEScalarElectricCurrentGetCurrentSourceBaseline ()
 
virtual double GetCurrentSourceBaseline (const ElectricCurrentUnit &unit) const
 
virtual bool HasVoltageSource () const
 
virtual SEScalarElectricPotentialGetVoltageSource ()
 
virtual double GetVoltageSource (const ElectricPotentialUnit &unit) const
 
virtual bool HasNextVoltageSource () const
 
virtual SEScalarElectricPotentialGetNextVoltageSource ()
 
virtual double GetNextVoltageSource (const ElectricPotentialUnit &unit) const
 
virtual bool HasVoltageSourceBaseline () const
 
virtual SEScalarElectricPotentialGetVoltageSourceBaseline ()
 
virtual double GetVoltageSourceBaseline (const ElectricPotentialUnit &unit) const
 
virtual bool HasValveBreakdownVoltage () const
 
virtual SEScalarElectricPotentialGetValveBreakdownVoltage ()
 
virtual double GetValveBreakdownVoltage (const ElectricPotentialUnit &unit) const
 
- Public Member Functions inherited from biogears::SECircuitPath< SEScalarElectricCurrent, SEScalarElectricResistance, SEScalarElectricCapacitance, SEScalarElectricInductance, SEScalarElectricPotential, SEScalarElectricCharge >
virtual ~SECircuitPath ()
 
virtual bool Load (const CDM::CircuitPathData &in)
 
virtual std::string GetName () const
 
virtual const char * GetName_cStr () const
 
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 bool HasPotentialSource () const
 
virtual PotentialScalar & GetPotentialSource ()
 
virtual bool HasNextPotentialSource () const
 
virtual PotentialScalar & GetNextPotentialSource ()
 
virtual bool HasPotentialSourceBaseline () const
 
virtual PotentialScalar & GetPotentialSourceBaseline ()
 
virtual bool HasValveBreakdownPotential () const
 
virtual PotentialScalar & GetValveBreakdownPotential ()
 
virtual bool HasValidElements () const
 
virtual unsigned short NumberOfElements () const
 
virtual unsigned short NumberOfNextElements () const
 
virtual CDM::enumOpenClosed::value GetSwitch () const
 
virtual void SetSwitch (CDM::enumOpenClosed::value state)
 
virtual void FlipSwitch ()
 
virtual bool HasSwitch () const
 
virtual void InvalidateSwitch ()
 
virtual CDM::enumOpenClosed::value GetNextSwitch () const
 
virtual void SetNextSwitch (CDM::enumOpenClosed::value state)
 
virtual void FlipNextSwitch ()
 
virtual bool HasNextSwitch () const
 
virtual void InvalidateNextSwitch ()
 
virtual CDM::enumOpenClosed::value GetValve () const
 
virtual void SetValve (CDM::enumOpenClosed::value state)
 
virtual void FlipValve ()
 
virtual bool HasValve () const
 
virtual void InvalidateValve ()
 
virtual CDM::enumOpenClosed::value GetNextValve () const
 
virtual void SetNextValve (CDM::enumOpenClosed::value state)
 
virtual void FlipNextValve ()
 
virtual bool HasNextValve () const
 
virtual void InvalidateNextValve ()
 
virtual CDM::enumOpenClosed::value GetPolarizedState () const
 
virtual void SetPolarizedState (CDM::enumOpenClosed::value state)
 
virtual void FlipPolarizedState ()
 
virtual bool HasPolarizedState () const
 
virtual void InvalidatePolarizedState ()
 
virtual CDM::enumOpenClosed::value GetNextPolarizedState () const
 
virtual void SetNextPolarizedState (CDM::enumOpenClosed::value state)
 
virtual void FlipNextPolarizedState ()
 
virtual bool HasNextPolarizedState () const
 
virtual void InvalidateNextPolarizedState ()
 
- Public Member Functions inherited from biogears::Loggable
 Loggable ()
 
 Loggable (Logger *log)
 
virtual ~Loggable ()
 
virtual LoggerGetLogger () const
 

Protected Member Functions

 SEElectricalCircuitPath (SEElectricalCircuitNode &src, SEElectricalCircuitNode &tgt, const std::string &name)
 
 SEElectricalCircuitPath (SEElectricalCircuitNode &src, SEElectricalCircuitNode &tgt, const char *name)
 
void Unload (CDM::ElectricalCircuitPathData &data) const
 
- Protected Member Functions inherited from biogears::SECircuitPath< SEScalarElectricCurrent, SEScalarElectricResistance, SEScalarElectricCapacitance, SEScalarElectricInductance, SEScalarElectricPotential, SEScalarElectricCharge >
 SECircuitPath (SECircuitNode< PotentialScalar, QuantityScalar > &src, SECircuitNode< PotentialScalar, QuantityScalar > &tgt, const char *name)
 
 SECircuitPath (SECircuitNode< PotentialScalar, QuantityScalar > &src, SECircuitNode< PotentialScalar, QuantityScalar > &tgt, const std::string &name)
 
virtual void Unload (CDM::CircuitPathData &data) const
 
- Protected Member Functions inherited from biogears::Loggable
virtual void Debug (const char *msg, const char *origin="") const
 
virtual void Debug (const std::string &msg, const std::string &origin=empty) const
 
virtual void Debug (std::ostream &msg, const std::string &origin=empty) const
 
virtual void Info (const char *msg, const char *origin="") const
 
virtual void Info (const std::string &msg, const std::string &origin=empty) const
 
virtual void Info (std::ostream &msg, const std::string &origin=empty) const
 
virtual void Warning (const char *msg, const char *origin="") const
 
virtual void Warning (const std::string &msg, const std::string &origin=empty) const
 
virtual void Warning (std::ostream &msg, const std::string &origin=empty) const
 
virtual void Error (const char *msg, const char *origin="") const
 
virtual void Error (const std::string msg, const std::string origin=empty) const
 
virtual void Error (std::ostream &msg, const std::string &origin=empty) const
 
virtual void Fatal (const char *msg, const char *origin="") const
 
virtual void Fatal (const std::string &msg, const std::string &origin=empty) const
 
virtual void Fatal (std::ostream &msg, const std::string &origin=empty) const
 

Protected Attributes

SEElectricalCircuitNodem_ElectricalSourceNode
 
SEElectricalCircuitNodem_ElectricalTargetNode
 
- Protected Attributes inherited from biogears::SECircuitPath< SEScalarElectricCurrent, SEScalarElectricResistance, SEScalarElectricCapacitance, SEScalarElectricInductance, SEScalarElectricPotential, SEScalarElectricCharge >
std::string m_Name
 
SECircuitNode< CIRCUIT_NODE_TYPES > & m_SourceNode
 
SECircuitNode< CIRCUIT_NODE_TYPES > & m_TargetNode
 
unsigned short m_NumElements
 
unsigned short m_NumNextElements
 
CDM::enumOpenClosed::value m_Switch
 
CDM::enumOpenClosed::value m_NextSwitch
 
CDM::enumOpenClosed::value m_Valve
 
CDM::enumOpenClosed::value m_NextValve
 
CDM::enumOpenClosed::value m_PolarizedState
 
CDM::enumOpenClosed::value 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
 
PotentialScalar * m_PotentialSource
 
PotentialScalar * m_NextPotentialSource
 
PotentialScalar * m_PotentialSourceBaseline
 
PotentialScalar * m_ValveBreakdownPotential
 
- Protected Attributes inherited from biogears::Loggable
Loggerm_Logger
 

Friends

class SECircuitManager
 

Additional Inherited Members

- Static Public Attributes inherited from biogears::Loggable
static const std::string empty
 
static const char * empty_cStr
 

Constructor & Destructor Documentation

biogears::SEElectricalCircuitPath::SEElectricalCircuitPath ( SEElectricalCircuitNode src,
SEElectricalCircuitNode tgt,
const std::string &  name 
)
protected
biogears::SEElectricalCircuitPath::SEElectricalCircuitPath ( SEElectricalCircuitNode src,
SEElectricalCircuitNode tgt,
const char *  name 
)
protected
biogears::SEElectricalCircuitPath::~SEElectricalCircuitPath ( )
virtual

Member Function Documentation

double biogears::SEElectricalCircuitPath::GetCapacitance ( const ElectricCapacitanceUnit unit) const
virtual
double biogears::SEElectricalCircuitPath::GetCapacitanceBaseline ( const ElectricCapacitanceUnit unit) const
virtual
SEScalarElectricCurrent & biogears::SEElectricalCircuitPath::GetCurrent ( )
virtual
double biogears::SEElectricalCircuitPath::GetCurrent ( const ElectricCurrentUnit unit) const
virtual
SEScalarElectricCurrent & biogears::SEElectricalCircuitPath::GetCurrentSource ( )
virtual
double biogears::SEElectricalCircuitPath::GetCurrentSource ( const ElectricCurrentUnit unit) const
virtual
SEScalarElectricCurrent & biogears::SEElectricalCircuitPath::GetCurrentSourceBaseline ( )
virtual
double biogears::SEElectricalCircuitPath::GetCurrentSourceBaseline ( const ElectricCurrentUnit unit) const
virtual
double biogears::SEElectricalCircuitPath::GetInductance ( const ElectricInductanceUnit unit) const
virtual
double biogears::SEElectricalCircuitPath::GetInductanceBaseline ( const ElectricInductanceUnit unit) const
virtual
double biogears::SEElectricalCircuitPath::GetNextCapacitance ( const ElectricCapacitanceUnit unit) const
virtual
SEScalarElectricCurrent & biogears::SEElectricalCircuitPath::GetNextCurrent ( )
virtual
double biogears::SEElectricalCircuitPath::GetNextCurrent ( const ElectricCurrentUnit unit) const
virtual
SEScalarElectricCurrent & biogears::SEElectricalCircuitPath::GetNextCurrentSource ( )
virtual
double biogears::SEElectricalCircuitPath::GetNextCurrentSource ( const ElectricCurrentUnit unit) const
virtual
double biogears::SEElectricalCircuitPath::GetNextInductance ( const ElectricInductanceUnit unit) const
virtual
double biogears::SEElectricalCircuitPath::GetNextResistance ( const ElectricResistanceUnit unit) const
virtual
SEScalarElectricPotential & biogears::SEElectricalCircuitPath::GetNextVoltageSource ( )
virtual
double biogears::SEElectricalCircuitPath::GetNextVoltageSource ( const ElectricPotentialUnit unit) const
virtual
double biogears::SEElectricalCircuitPath::GetResistance ( const ElectricResistanceUnit unit) const
virtual
double biogears::SEElectricalCircuitPath::GetResistanceBaseline ( const ElectricResistanceUnit unit) const
virtual
SEScalarElectricPotential & biogears::SEElectricalCircuitPath::GetValveBreakdownVoltage ( )
virtual
double biogears::SEElectricalCircuitPath::GetValveBreakdownVoltage ( const ElectricPotentialUnit unit) const
virtual
SEScalarElectricPotential & biogears::SEElectricalCircuitPath::GetVoltageSource ( )
virtual
double biogears::SEElectricalCircuitPath::GetVoltageSource ( const ElectricPotentialUnit unit) const
virtual
SEScalarElectricPotential & biogears::SEElectricalCircuitPath::GetVoltageSourceBaseline ( )
virtual
double biogears::SEElectricalCircuitPath::GetVoltageSourceBaseline ( const ElectricPotentialUnit unit) const
virtual
bool biogears::SEElectricalCircuitPath::HasCurrent ( ) const
virtual
bool biogears::SEElectricalCircuitPath::HasCurrentSource ( ) const
virtual
bool biogears::SEElectricalCircuitPath::HasCurrentSourceBaseline ( ) const
virtual
bool biogears::SEElectricalCircuitPath::HasNextCurrent ( ) const
virtual
bool biogears::SEElectricalCircuitPath::HasNextCurrentSource ( ) const
virtual
bool biogears::SEElectricalCircuitPath::HasNextVoltageSource ( ) const
virtual
bool biogears::SEElectricalCircuitPath::HasValveBreakdownVoltage ( ) const
virtual
bool biogears::SEElectricalCircuitPath::HasVoltageSource ( ) const
virtual
bool biogears::SEElectricalCircuitPath::HasVoltageSourceBaseline ( ) const
virtual
bool biogears::SEElectricalCircuitPath::Load ( const CDM::ElectricalCircuitPathData in)
void biogears::SEElectricalCircuitPath::Unload ( CDM::ElectricalCircuitPathData data) const
protected

Friends And Related Function Documentation

friend class SECircuitManager
friend

Member Data Documentation

SEElectricalCircuitNode& biogears::SEElectricalCircuitPath::m_ElectricalSourceNode
protected
SEElectricalCircuitNode& biogears::SEElectricalCircuitPath::m_ElectricalTargetNode
protected