SECircuitNode< CIRCUIT_NODE_TEMPLATE > Class Template Reference

#include <SECircuitNode.h>

Inherits Loggable.

Public Member Functions

virtual ~SECircuitNode ()
 
virtual void Clear ()
 
virtual std::string GetName () const
 
virtual bool HasPotential () const
 
virtual PotentialScalar & GetPotential ()
 
virtual bool HasNextPotential () const
 
virtual PotentialScalar & GetNextPotential ()
 
virtual bool HasQuantity () const
 
virtual QuantityScalar & GetQuantity ()
 
virtual bool HasNextQuantity () const
 
virtual QuantityScalar & GetNextQuantity ()
 
virtual bool HasQuantityBaseline () const
 
virtual QuantityScalar & GetQuantityBaseline ()
 
void SetCalculatorIndex (const size_t index)
 
size_t GetCalculatorIndex () const
 
bool IsReferenceNode () const
 
void SetAsReferenceNode ()
 
void RemoveAsReferenceNode ()
 
- Public Member Functions inherited from Loggable
 Loggable ()
 
 Loggable (Logger *log)
 
virtual ~Loggable ()
 
virtual LoggerGetLogger () const
 
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

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

Protected Attributes

std::string m_Name
 
PotentialScalar * m_Potential
 
PotentialScalar * m_NextPotential
 
QuantityScalar * m_Quantity
 
QuantityScalar * m_NextQuantity
 
QuantityScalar * m_QuantityBaseline
 
- Protected Attributes inherited from Loggable
Loggerm_Logger
 

Private Attributes

size_t m_CalculatorIndex
 
bool m_IsReferenceNode = false
 

Friends

class PBCircuit
 
template<typename NodeType , typename PathType >
class SECircuit
 

Additional Inherited Members

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

Constructor & Destructor Documentation

◆ SECircuitNode()

template<CIRCUIT_NODE_TEMPLATE >
SECircuitNode< CIRCUIT_NODE_TEMPLATE >::SECircuitNode ( const std::string &  name,
Logger logger 
)
protected

◆ ~SECircuitNode()

template<CIRCUIT_NODE_TEMPLATE >
virtual SECircuitNode< CIRCUIT_NODE_TEMPLATE >::~SECircuitNode ( )
virtual

Member Function Documentation

◆ Clear()

template<CIRCUIT_NODE_TEMPLATE >
virtual void SECircuitNode< CIRCUIT_NODE_TEMPLATE >::Clear ( )
virtual

◆ GetCalculatorIndex()

template<CIRCUIT_NODE_TEMPLATE >
size_t SECircuitNode< CIRCUIT_NODE_TEMPLATE >::GetCalculatorIndex ( ) const

◆ GetName()

template<CIRCUIT_NODE_TEMPLATE >
virtual std::string SECircuitNode< CIRCUIT_NODE_TEMPLATE >::GetName ( ) const
virtual

◆ GetNextPotential()

template<CIRCUIT_NODE_TEMPLATE >
virtual PotentialScalar& SECircuitNode< CIRCUIT_NODE_TEMPLATE >::GetNextPotential ( )
virtual

◆ GetNextQuantity()

template<CIRCUIT_NODE_TEMPLATE >
virtual QuantityScalar& SECircuitNode< CIRCUIT_NODE_TEMPLATE >::GetNextQuantity ( )
virtual

◆ GetPotential()

template<CIRCUIT_NODE_TEMPLATE >
virtual PotentialScalar& SECircuitNode< CIRCUIT_NODE_TEMPLATE >::GetPotential ( )
virtual

◆ GetQuantity()

template<CIRCUIT_NODE_TEMPLATE >
virtual QuantityScalar& SECircuitNode< CIRCUIT_NODE_TEMPLATE >::GetQuantity ( )
virtual

◆ GetQuantityBaseline()

template<CIRCUIT_NODE_TEMPLATE >
virtual QuantityScalar& SECircuitNode< CIRCUIT_NODE_TEMPLATE >::GetQuantityBaseline ( )
virtual

◆ HasNextPotential()

template<CIRCUIT_NODE_TEMPLATE >
virtual bool SECircuitNode< CIRCUIT_NODE_TEMPLATE >::HasNextPotential ( ) const
virtual

◆ HasNextQuantity()

template<CIRCUIT_NODE_TEMPLATE >
virtual bool SECircuitNode< CIRCUIT_NODE_TEMPLATE >::HasNextQuantity ( ) const
virtual

◆ HasPotential()

template<CIRCUIT_NODE_TEMPLATE >
virtual bool SECircuitNode< CIRCUIT_NODE_TEMPLATE >::HasPotential ( ) const
virtual

◆ HasQuantity()

template<CIRCUIT_NODE_TEMPLATE >
virtual bool SECircuitNode< CIRCUIT_NODE_TEMPLATE >::HasQuantity ( ) const
virtual

◆ HasQuantityBaseline()

template<CIRCUIT_NODE_TEMPLATE >
virtual bool SECircuitNode< CIRCUIT_NODE_TEMPLATE >::HasQuantityBaseline ( ) const
virtual

◆ IsReferenceNode()

template<CIRCUIT_NODE_TEMPLATE >
bool SECircuitNode< CIRCUIT_NODE_TEMPLATE >::IsReferenceNode ( ) const

◆ RemoveAsReferenceNode()

template<CIRCUIT_NODE_TEMPLATE >
void SECircuitNode< CIRCUIT_NODE_TEMPLATE >::RemoveAsReferenceNode ( )

◆ SetAsReferenceNode()

template<CIRCUIT_NODE_TEMPLATE >
void SECircuitNode< CIRCUIT_NODE_TEMPLATE >::SetAsReferenceNode ( )

◆ SetCalculatorIndex()

template<CIRCUIT_NODE_TEMPLATE >
void SECircuitNode< CIRCUIT_NODE_TEMPLATE >::SetCalculatorIndex ( const size_t  index)

Friends And Related Function Documentation

◆ PBCircuit

template<CIRCUIT_NODE_TEMPLATE >
friend class PBCircuit
friend

◆ SECircuit

template<CIRCUIT_NODE_TEMPLATE >
template<typename NodeType , typename PathType >
friend class SECircuit
friend

Member Data Documentation

◆ m_CalculatorIndex

template<CIRCUIT_NODE_TEMPLATE >
size_t SECircuitNode< CIRCUIT_NODE_TEMPLATE >::m_CalculatorIndex
private

◆ m_IsReferenceNode

template<CIRCUIT_NODE_TEMPLATE >
bool SECircuitNode< CIRCUIT_NODE_TEMPLATE >::m_IsReferenceNode = false
private

◆ m_Name

template<CIRCUIT_NODE_TEMPLATE >
std::string SECircuitNode< CIRCUIT_NODE_TEMPLATE >::m_Name
protected

◆ m_NextPotential

template<CIRCUIT_NODE_TEMPLATE >
PotentialScalar* SECircuitNode< CIRCUIT_NODE_TEMPLATE >::m_NextPotential
protected

◆ m_NextQuantity

template<CIRCUIT_NODE_TEMPLATE >
QuantityScalar* SECircuitNode< CIRCUIT_NODE_TEMPLATE >::m_NextQuantity
protected

◆ m_Potential

template<CIRCUIT_NODE_TEMPLATE >
PotentialScalar* SECircuitNode< CIRCUIT_NODE_TEMPLATE >::m_Potential
protected

◆ m_Quantity

template<CIRCUIT_NODE_TEMPLATE >
QuantityScalar* SECircuitNode< CIRCUIT_NODE_TEMPLATE >::m_Quantity
protected

◆ m_QuantityBaseline

template<CIRCUIT_NODE_TEMPLATE >
QuantityScalar* SECircuitNode< CIRCUIT_NODE_TEMPLATE >::m_QuantityBaseline
protected