#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 ProvideSourceFlux ()
 
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 ProvideTargetFlux ()
 
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 ProvidePotential ()
 
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 ProvideSourcePotential ()
 
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 ProvideTargetPotential ()
 
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 ProvideQuantity ()
 
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
 
- Public Member Functions inherited from Loggable
 Loggable (Logger *logger=nullptr)
 
 Loggable (std::string const &logfile)
 
virtual ~Loggable ()
 
virtual LoggerGetLogger () const
 
virtual void SetLogger (Logger &logger)
 
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

 SEElectricalBlackBox (const std::string &name, Logger *logger)
 
virtual bool HasCompartment () const
 
virtual SEElectricalCompartmentGetCompartment () const
 
virtual void SetCompartment (SEElectricalCompartment *c)
 
virtual bool HasSourceCompartment () const
 
virtual SEElectricalCompartmentGetSourceCompartment () const
 
virtual void SetSourceCompartment (SEElectricalCompartment *c)
 
virtual bool HasTargetCompartment () const
 
virtual SEElectricalCompartmentGetTargetCompartment () const
 
virtual void SetTargetCompartment (SEElectricalCompartment *c)
 
virtual bool HasSourceLink () const
 
virtual SEElectricalCompartmentLinkGetSourceLink () const
 
virtual void SetSourceLink (SEElectricalCompartmentLink *l)
 
virtual bool HasTargetLink () const
 
virtual SEElectricalCompartmentLinkGetTargetLink () const
 
virtual void SetTargetLink (SEElectricalCompartmentLink *l)
 
- Protected Member Functions inherited from SEBlackBox< ELECTRICAL_BLACK_BOX >
 SEBlackBox (const std::string &name, Logger *logger)
 
virtual bool HasNode () const
 
virtual NodeType * GetNode () const
 
virtual void SetNode (NodeType *n)
 
virtual bool HasSourceNode () const
 
virtual NodeType * GetSourceNode () const
 
virtual void SetSourceNode (NodeType *n)
 
virtual bool HasTargetNode () const
 
virtual NodeType * GetTargetNode () const
 
virtual void SetTargetNode (NodeType *n)
 
virtual bool HasSourcePath () const
 
virtual PathType * GetSourcePath () const
 
virtual void SetSourcePath (PathType *p)
 
virtual bool HasTargetPath () const
 
virtual PathType * GetTargetPath () const
 
virtual void SetTargetPath (PathType *p)
 

Protected Attributes

SEElectricalCompartmentm_Compartment = nullptr
 
SEElectricalCompartmentm_srcCompartment = nullptr
 
SEElectricalCompartmentm_tgtCompartment = nullptr
 
SEElectricalCompartmentLinkm_srcLink = nullptr
 
SEElectricalCompartmentLinkm_tgtLink = nullptr
 
- Protected Attributes inherited from SEBlackBox< ELECTRICAL_BLACK_BOX >
std::string m_Name
 
NodeType * m_Node
 
NodeType * m_SourceNode
 
NodeType * m_TargetNode
 
PathType * m_SourcePath
 
PathType * m_TargetPath
 
eBlackBox_Property_Type m_SourceFlux
 
eBlackBox_Property_Type m_TargetFlux
 
eBlackBox_Property_Type m_SourcePotential
 
eBlackBox_Property_Type m_TargetPotential
 
eBlackBox_Property_Type m_Potential
 
eBlackBox_Property_Type m_Quantity
 
- Protected Attributes inherited from Loggable
bool myLogger
 
Loggerm_Logger
 

Friends

class SEBlackBoxManager
 
class CommonDataModelTest
 

Additional Inherited Members

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

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

Distributed under the Apache License, Version 2.0.

See accompanying NOTICE file for details.