SEElectricalCircuitNode Class Reference

#include <SEElectricalCircuitNode.h>

Inherits SECircuitNode< ELECTRICAL_CIRCUIT_NODE >.

Public Member Functions
virtual	~SEElectricalCircuitNode ()
void	Clear () override
virtual bool	HasVoltage () const
virtual SEScalarElectricPotential &	GetVoltage ()
virtual double	GetVoltage (const ElectricPotentialUnit &unit) const
virtual bool	HasNextVoltage () const
virtual SEScalarElectricPotential &	GetNextVoltage ()
virtual double	GetNextVoltage (const ElectricPotentialUnit &unit) const
virtual bool	HasCharge () const
virtual SEScalarElectricCharge &	GetCharge ()
virtual double	GetCharge (const ElectricChargeUnit &unit) const
virtual bool	HasNextCharge () const
virtual SEScalarElectricCharge &	GetNextCharge ()
virtual double	GetNextCharge (const ElectricChargeUnit &unit) const
virtual bool	HasChargeBaseline () const
virtual SEScalarElectricCharge &	GetChargeBaseline ()
virtual double	GetChargeBaseline (const ElectricChargeUnit &unit) const
SEElectricalCircuitNode *	GetBlackBoxSourceNode () const
SEElectricalCircuitNode *	GetBlackBoxTargetNode () const
void	SetBlackBoxSourceTargetNodes (SEElectricalCircuitNode &src, SEElectricalCircuitNode &tgt)
SEElectricalCircuitPath *	GetBlackBoxSourcePath () const
SEElectricalCircuitPath *	GetBlackBoxTargetPath () const
void	SetBlackBoxSourceTargetPaths (SEElectricalCircuitPath &src, SEElectricalCircuitPath &tgt)
Public Member Functions inherited from SECircuitNode< ELECTRICAL_CIRCUIT_NODE >
virtual	~SECircuitNode ()
virtual void	Clear ()
virtual std::string	GetName () const
virtual bool	IsPartOfBlackBox () const
virtual void	SetPartOfBlackBox (bool b)
virtual bool	IsBlackBoxMiddle () const
virtual bool	HasPotential () const
virtual PotentialScalar &	GetPotential ()
virtual bool	HasNextPotential () const
virtual PotentialScalar &	GetNextPotential ()
virtual void	RemoveImposedPotential ()
virtual bool	IsPotentialImposed () const
virtual void	ImposePotential (const PotentialScalar &s)
virtual void	ImposePotential (double v, const PotentialUnit &unit)
virtual bool	HasQuantity () const
virtual QuantityScalar &	GetQuantity ()
virtual bool	HasNextQuantity () const
virtual QuantityScalar &	GetNextQuantity ()
virtual bool	HasQuantityBaseline () const
virtual QuantityScalar &	GetQuantityBaseline ()
virtual void	RemoveImposedQuantity ()
virtual bool	IsQuantityImposed () const
virtual void	ImposeQuantity (const QuantityScalar &s)
virtual void	ImposeQuantity (double v, const QuantityUnit &unit)
void	SetCalculatorIndex (const int index)
int	GetCalculatorIndex () const
bool	IsReferenceNode () const
void	SetAsReferenceNode ()
void	RemoveAsReferenceNode ()
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
	SEElectricalCircuitNode (const std::string &name, Logger *logger)
Protected Member Functions inherited from SECircuitNode< ELECTRICAL_CIRCUIT_NODE >
	SECircuitNode (const std::string &name, Logger *logger)

Protected Attributes
SEElectricalCircuitNode *	m_BlackBoxSourceNode =nullptr
SEElectricalCircuitNode *	m_BlackBoxTargetNode =nullptr
SEElectricalCircuitPath *	m_BlackBoxSourcePath = nullptr
SEElectricalCircuitPath *	m_BlackBoxTargetPath = nullptr
Protected Attributes inherited from SECircuitNode< ELECTRICAL_CIRCUIT_NODE >
std::string	m_Name
bool	m_IsPartOfBlackBox
bool	m_IsBlackBoxMiddle
PotentialScalar *	m_Potential
PotentialScalar *	m_NextPotential
eBlackBox_Property_Type	m_PotentialType
QuantityScalar *	m_Quantity
QuantityScalar *	m_NextQuantity
QuantityScalar *	m_QuantityBaseline
eBlackBox_Property_Type	m_QuantityType
Protected Attributes inherited from Loggable
bool	myLogger
Logger *	m_Logger

Friends
class	PBCircuit
class	SECircuitManager

Constructor & Destructor Documentation

SEElectricalCircuitNode()

SEElectricalCircuitNode::SEElectricalCircuitNode ( const std::string &  name, Logger *  logger  )

protected

~SEElectricalCircuitNode()

SEElectricalCircuitNode::~SEElectricalCircuitNode ( )

virtual

Member Function Documentation

Clear()

void SEElectricalCircuitNode::Clear ( )

overridevirtual

Reimplemented from SECircuitNode< ELECTRICAL_CIRCUIT_NODE >.

GetBlackBoxSourceNode()

SEElectricalCircuitNode * SEElectricalCircuitNode::GetBlackBoxSourceNode

(

)

const

GetBlackBoxSourcePath()

SEElectricalCircuitPath * SEElectricalCircuitNode::GetBlackBoxSourcePath

(

)

const

GetBlackBoxTargetNode()

SEElectricalCircuitNode * SEElectricalCircuitNode::GetBlackBoxTargetNode

(

)

const

GetBlackBoxTargetPath()

SEElectricalCircuitPath * SEElectricalCircuitNode::GetBlackBoxTargetPath

(

)

const

GetCharge() [1/2]

SEScalarElectricCharge & SEElectricalCircuitNode::GetCharge ( )

virtual

GetCharge() [2/2]

double SEElectricalCircuitNode::GetCharge ( const ElectricChargeUnit &  unit ) const

virtual

GetChargeBaseline() [1/2]

SEScalarElectricCharge & SEElectricalCircuitNode::GetChargeBaseline ( )

virtual

GetChargeBaseline() [2/2]

double SEElectricalCircuitNode::GetChargeBaseline ( const ElectricChargeUnit &  unit ) const

virtual

GetNextCharge() [1/2]

SEScalarElectricCharge & SEElectricalCircuitNode::GetNextCharge ( )

virtual

GetNextCharge() [2/2]

double SEElectricalCircuitNode::GetNextCharge ( const ElectricChargeUnit &  unit ) const

virtual

GetNextVoltage() [1/2]

SEScalarElectricPotential & SEElectricalCircuitNode::GetNextVoltage ( )

virtual

GetNextVoltage() [2/2]

double SEElectricalCircuitNode::GetNextVoltage ( const ElectricPotentialUnit &  unit ) const

virtual

GetVoltage() [1/2]

SEScalarElectricPotential & SEElectricalCircuitNode::GetVoltage ( )

virtual

GetVoltage() [2/2]

double SEElectricalCircuitNode::GetVoltage ( const ElectricPotentialUnit &  unit ) const

virtual

HasCharge()

bool SEElectricalCircuitNode::HasCharge ( ) const

virtual

HasChargeBaseline()

bool SEElectricalCircuitNode::HasChargeBaseline ( ) const

virtual

HasNextCharge()

bool SEElectricalCircuitNode::HasNextCharge ( ) const

virtual

HasNextVoltage()

bool SEElectricalCircuitNode::HasNextVoltage ( ) const

virtual

HasVoltage()

bool SEElectricalCircuitNode::HasVoltage ( ) const

virtual

SetBlackBoxSourceTargetNodes()

void SEElectricalCircuitNode::SetBlackBoxSourceTargetNodes	(	SEElectricalCircuitNode &	src,
		SEElectricalCircuitNode &	tgt
	)

SetBlackBoxSourceTargetPaths()

void SEElectricalCircuitNode::SetBlackBoxSourceTargetPaths	(	SEElectricalCircuitPath &	src,
		SEElectricalCircuitPath &	tgt
	)

Friends And Related Function Documentation

PBCircuit

friend class PBCircuit

friend

SECircuitManager

friend class SECircuitManager

friend

Member Data Documentation

m_BlackBoxSourceNode

SEElectricalCircuitNode* SEElectricalCircuitNode::m_BlackBoxSourceNode =nullptr

protected

m_BlackBoxSourcePath

SEElectricalCircuitPath* SEElectricalCircuitNode::m_BlackBoxSourcePath = nullptr

protected

m_BlackBoxTargetNode

SEElectricalCircuitNode* SEElectricalCircuitNode::m_BlackBoxTargetNode =nullptr

protected

m_BlackBoxTargetPath

SEElectricalCircuitPath* SEElectricalCircuitNode::m_BlackBoxTargetPath = nullptr

protected