SEElectricalBlackBox Class Reference

#include <SEElectricalBlackBox.h>

Inherits SEBlackBox< ELECTRICAL_BLACK_BOX >.

Public Member Functions
virtual	~SEElectricalBlackBox ()
Public Member Functions inherited from SEBlackBox< ELECTRICAL_BLACK_BOX >
virtual	~SEBlackBox ()
virtual void	Clear ()
virtual std::string	GetName () const
virtual void	RemoveImposedPotential ()
virtual bool	IsPotentialImposed () const
virtual void	ImposePotential (double v, const PotentialUnit &unit)
virtual void	ImposePotential (const PotentialScalar &s)
virtual double	GetPotential (const PotentialUnit &unit) const
virtual void	RemoveImposedSourcePotential ()
virtual bool	IsSourcePotentialImposed () const
virtual void	ImposeSourcePotential (double v, const PotentialUnit &unit)
virtual void	ImposeSourcePotential (const PotentialScalar &s)
virtual double	GetSourcePotential (const PotentialUnit &unit) const
virtual void	RemoveImposedTargetPotential ()
virtual bool	IsTargetPotentialImposed () const
virtual void	ImposeTargetPotential (double v, const PotentialUnit &unit)
virtual void	ImposeTargetPotential (const PotentialScalar &s)
virtual double	GetTargetPotential (const PotentialUnit &unit) const
virtual void	RemoveImposedSourceFlux ()
virtual bool	IsSourceFluxImposed () const
virtual void	ImposeSourceFlux (double v, const FluxUnit &unit)
virtual void	ImposeSourceFlux (const FluxScalar &s)
virtual double	GetSourceFlux (const FluxUnit &unit) const
virtual void	RemoveImposedTargetFlux ()
virtual bool	IsTargetFluxImposed () const
virtual void	ImposeTargetFlux (double v, const FluxUnit &unit)
virtual void	ImposeTargetFlux (const FluxScalar &s)
virtual double	GetTargetFlux (const FluxUnit &unit) const
virtual void	RemoveImposedQuantity ()
virtual bool	IsQuantityImposed () const
virtual void	ImposeQuantity (double v, const QuantityUnit &unit)
virtual void	ImposeQuantity (const QuantityScalar &s)
virtual double	GetQuantity (const QuantityUnit &unit) const
virtual bool	HasMiddleNode () const
virtual NodeType *	GetMiddleNode () const
virtual bool	HasSourceNode () const
virtual NodeType *	GetSourceNode () const
virtual bool	HasTargetNode () const
virtual NodeType *	GetTargetNode () const
virtual bool	HasSourcePath () const
virtual PathType *	GetSourcePath () const
virtual bool	HasTargetPath () const
virtual PathType *	GetTargetPath () 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
	SEElectricalBlackBox (const std::string &name, Logger *logger)
virtual bool	HasCompartment () const
virtual SEElectricalCompartment *	GetCompartment () const
virtual void	SetCompartment (SEElectricalCompartment *c)
virtual bool	HasSourceCompartment () const
virtual SEElectricalCompartment *	GetSourceCompartment () const
virtual void	SetSourceCompartment (SEElectricalCompartment *c)
virtual bool	HasTargetCompartment () const
virtual SEElectricalCompartment *	GetTargetCompartment () const
virtual void	SetTargetCompartment (SEElectricalCompartment *c)
virtual bool	HasSourceLink () const
virtual SEElectricalCompartmentLink *	GetSourceLink () const
virtual void	SetSourceLink (SEElectricalCompartmentLink *l)
virtual bool	HasTargetLink () const
virtual SEElectricalCompartmentLink *	GetTargetLink () const
virtual void	SetTargetLink (SEElectricalCompartmentLink *l)
Protected Member Functions inherited from SEBlackBox< ELECTRICAL_BLACK_BOX >
	SEBlackBox (const std::string &name, Logger *logger)
virtual void	SetMiddleNode (NodeType *n)
virtual void	SetSourceNode (NodeType *n)
virtual void	SetTargetNode (NodeType *n)
virtual void	SetSourcePath (PathType *p)
virtual void	SetTargetPath (PathType *p)

Protected Attributes
SEElectricalCompartment *	m_Compartment = nullptr
SEElectricalCompartment *	m_srcCompartment = nullptr
SEElectricalCompartment *	m_tgtCompartment = nullptr
SEElectricalCompartmentLink *	m_srcLink = nullptr
SEElectricalCompartmentLink *	m_tgtLink = nullptr
Protected Attributes inherited from SEBlackBox< ELECTRICAL_BLACK_BOX >
std::string	m_Name
NodeType *	m_MiddleNode
NodeType *	m_SourceNode
NodeType *	m_TargetNode
PathType *	m_SourcePath
PathType *	m_TargetPath
Protected Attributes inherited from Loggable
bool	myLogger
Logger *	m_Logger

Friends
class	SEBlackBoxManager
class	CommonDataModelTest

Constructor & Destructor Documentation

SEElectricalBlackBox()

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

protected

~SEElectricalBlackBox()

SEElectricalBlackBox::~SEElectricalBlackBox ( )

virtual

Member Function Documentation

GetCompartment()

virtual SEElectricalCompartment * SEElectricalBlackBox::GetCompartment ( ) const

inlineprotectedvirtual

GetSourceCompartment()

virtual SEElectricalCompartment * SEElectricalBlackBox::GetSourceCompartment ( ) const

inlineprotectedvirtual

GetSourceLink()

virtual SEElectricalCompartmentLink * SEElectricalBlackBox::GetSourceLink ( ) const

inlineprotectedvirtual

GetTargetCompartment()

virtual SEElectricalCompartment * SEElectricalBlackBox::GetTargetCompartment ( ) const

inlineprotectedvirtual

GetTargetLink()

virtual SEElectricalCompartmentLink * SEElectricalBlackBox::GetTargetLink ( ) const

inlineprotectedvirtual

HasCompartment()

virtual bool SEElectricalBlackBox::HasCompartment ( ) const

inlineprotectedvirtual

HasSourceCompartment()

virtual bool SEElectricalBlackBox::HasSourceCompartment ( ) const

inlineprotectedvirtual

HasSourceLink()

virtual bool SEElectricalBlackBox::HasSourceLink ( ) const

inlineprotectedvirtual

HasTargetCompartment()

virtual bool SEElectricalBlackBox::HasTargetCompartment ( ) const

inlineprotectedvirtual

HasTargetLink()

virtual bool SEElectricalBlackBox::HasTargetLink ( ) const

inlineprotectedvirtual

SetCompartment()

virtual void SEElectricalBlackBox::SetCompartment ( SEElectricalCompartment *  c )

inlineprotectedvirtual

SetSourceCompartment()

virtual void SEElectricalBlackBox::SetSourceCompartment ( SEElectricalCompartment *  c )

inlineprotectedvirtual

SetSourceLink()

virtual void SEElectricalBlackBox::SetSourceLink ( SEElectricalCompartmentLink *  l )

inlineprotectedvirtual

SetTargetCompartment()

virtual void SEElectricalBlackBox::SetTargetCompartment ( SEElectricalCompartment *  c )

inlineprotectedvirtual

SetTargetLink()

virtual void SEElectricalBlackBox::SetTargetLink ( SEElectricalCompartmentLink *  l )

inlineprotectedvirtual

Friends And Related Function Documentation

CommonDataModelTest

friend class CommonDataModelTest

friend

SEBlackBoxManager

friend class SEBlackBoxManager

friend

Member Data Documentation

m_Compartment

SEElectricalCompartment* SEElectricalBlackBox::m_Compartment = nullptr

protected

m_srcCompartment

SEElectricalCompartment* SEElectricalBlackBox::m_srcCompartment = nullptr

protected

m_srcLink

SEElectricalCompartmentLink* SEElectricalBlackBox::m_srcLink = nullptr

protected

m_tgtCompartment

SEElectricalCompartment* SEElectricalBlackBox::m_tgtCompartment = nullptr

protected

m_tgtLink

SEElectricalCompartmentLink* SEElectricalBlackBox::m_tgtLink = nullptr

protected