#include <EnergyStorageVisualizerBase.h>

Inheritance diagram for inet::visualizer::EnergyStorageVisualizerBase:

Classes
class	EnergyStorageVisualization

Parameters
bool	displayEnergyStorages = false

ModuleFilter	energyStorageFilter

cFigure::Color	color

double	width

double	height

double	spacing

Placement	placementHint

double	placementPriority

std::vector< const EnergyStorageVisualization * >	energyStorageVisualizations

virtual void	initialize (int stage) override

virtual void	handleParameterChange (const char *name) override

virtual void	refreshDisplay () const override

virtual void	preDelete (cComponent *root) override

virtual double	getNominalCapacity (const power::IEnergyStorage *energyStorage) const

virtual double	getResidualCapacity (const power::IEnergyStorage *energyStorage) const

virtual EnergyStorageVisualization *	createEnergyStorageVisualization (const power::IEnergyStorage *energyStorage) const =0

virtual void	addEnergyStorageVisualization (const EnergyStorageVisualization *energyStorageVisualization)

virtual void	addEnergyStorageVisualizations ()

virtual void	removeEnergyStorageVisualization (const EnergyStorageVisualization *energyStorageVisualization)

virtual void	refreshEnergyStorageVisualization (const EnergyStorageVisualization *energyStorageVisualization) const =0

virtual void	removeAllEnergyStorageVisualizations ()

Additional Inherited Members
Protected Member Functions inherited from inet::visualizer::VisualizerBase
virtual int	numInitStages () const override

virtual Coord	getPosition (const cModule *networkNode) const

virtual Coord	getContactPosition (const cModule networkNode, const Coord &fromPosition, const char contactMode, double contactSpacing) const

virtual Quaternion	getOrientation (const cModule *networkNode) const

virtual void	mapChunks (const Ptr< const Chunk > &chunk, const std::function< void(const Ptr< const Chunk > &, int)> &thunk) const

Protected Attributes inherited from inet::visualizer::VisualizerBase
cModule *	visualizationTargetModule = nullptr

cModule *	visualizationSubjectModule = nullptr

const char *	tags = nullptr

Member Function Documentation

◆ addEnergyStorageVisualization()

void inet::visualizer::EnergyStorageVisualizerBase::addEnergyStorageVisualization ( const EnergyStorageVisualization * energyStorageVisualization )

protectedvirtual

Reimplemented in inet::visualizer::EnergyStorageCanvasVisualizer.

 {
     energyStorageVisualizations.push_back(energyStorageVisualization);
 }

Referenced by inet::visualizer::EnergyStorageCanvasVisualizer::addEnergyStorageVisualization(), and addEnergyStorageVisualizations().

◆ addEnergyStorageVisualizations()

void inet::visualizer::EnergyStorageVisualizerBase::addEnergyStorageVisualizations ( )

protectedvirtual

 {
     auto simulation = getSimulation();
     for (int id = 0; id < simulation->getLastComponentId(); id++) {
         auto component = simulation->getComponent(id);
         auto module = dynamic_cast<cModule *>(component);
         auto energyStorage = dynamic_cast<IEnergyStorage *>(module);
         if (energyStorage != nullptr && energyStorageFilter.matches(module))
             addEnergyStorageVisualization(createEnergyStorageVisualization(energyStorage));
     }
 }

Referenced by handleParameterChange(), and initialize().

◆ createEnergyStorageVisualization()

virtual EnergyStorageVisualization* inet::visualizer::EnergyStorageVisualizerBase::createEnergyStorageVisualization ( const power::IEnergyStorage * energyStorage ) const

protectedpure virtual

Implemented in inet::visualizer::EnergyStorageCanvasVisualizer, and inet::visualizer::EnergyStorageOsgVisualizer.

Referenced by addEnergyStorageVisualizations().

◆ getNominalCapacity()

double inet::visualizer::EnergyStorageVisualizerBase::getNominalCapacity ( const power::IEnergyStorage * energyStorage ) const

protectedvirtual

 {
     if (auto epEnergyStorage = dynamic_cast<const IEpEnergyStorage *>(energyStorage))
         return epEnergyStorage->getNominalEnergyCapacity().get();
     else if (auto ccEnergyStorage = dynamic_cast<const ICcEnergyStorage *>(energyStorage))
         return ccEnergyStorage->getNominalChargeCapacity().get();
     else
         throw cRuntimeError("Unknown energy storage");
 }

Referenced by inet::visualizer::EnergyStorageCanvasVisualizer::createEnergyStorageVisualization().

◆ getResidualCapacity()

double inet::visualizer::EnergyStorageVisualizerBase::getResidualCapacity ( const power::IEnergyStorage * energyStorage ) const

protectedvirtual

 {
     if (auto epEnergyStorage = dynamic_cast<const IEpEnergyStorage *>(energyStorage))
         return epEnergyStorage->getResidualEnergyCapacity().get();
     else if (auto ccEnergyStorage = dynamic_cast<const ICcEnergyStorage *>(energyStorage))
         return ccEnergyStorage->getResidualChargeCapacity().get();
     else
         throw cRuntimeError("Unknown energy storage");
 }

Referenced by inet::visualizer::EnergyStorageCanvasVisualizer::refreshEnergyStorageVisualization().

◆ handleParameterChange()

void inet::visualizer::EnergyStorageVisualizerBase::handleParameterChange ( const char * name )

overrideprotectedvirtual

 {
     if (!hasGUI()) return;
     if (name != nullptr) {
         removeAllEnergyStorageVisualizations();
         addEnergyStorageVisualizations();
     }
 }

◆ initialize()

void inet::visualizer::EnergyStorageVisualizerBase::initialize ( int stage )

overrideprotectedvirtual

Reimplemented from inet::visualizer::VisualizerBase.

Reimplemented in inet::visualizer::EnergyStorageCanvasVisualizer, and inet::visualizer::EnergyStorageOsgVisualizer.

 {
     VisualizerBase::initialize(stage);
     if (!hasGUI()) return;
     if (stage == INITSTAGE_LOCAL) {
         displayEnergyStorages = par("displayEnergyStorages");
         energyStorageFilter.setPattern(par("energyStorageFilter"));
         color = cFigure::parseColor(par("color"));
         width = par("width");
         height = par("height");
         spacing = par("spacing");
         placementHint = parsePlacement(par("placementHint"));
         placementPriority = par("placementPriority");
     }
     else if (stage == INITSTAGE_LAST) {
         if (displayEnergyStorages)
             addEnergyStorageVisualizations();
     }
 }

Referenced by inet::visualizer::EnergyStorageOsgVisualizer::initialize(), and inet::visualizer::EnergyStorageCanvasVisualizer::initialize().

◆ preDelete()

void inet::visualizer::EnergyStorageVisualizerBase::preDelete ( cComponent * root )

overrideprotectedvirtual

 {
     if (displayEnergyStorages)
         removeAllEnergyStorageVisualizations();
 }

◆ refreshDisplay()

void inet::visualizer::EnergyStorageVisualizerBase::refreshDisplay ( ) const

overrideprotectedvirtual

 {
     for (auto energyStorageVisualization : energyStorageVisualizations)
         refreshEnergyStorageVisualization(energyStorageVisualization);
 }

◆ refreshEnergyStorageVisualization()

virtual void inet::visualizer::EnergyStorageVisualizerBase::refreshEnergyStorageVisualization ( const EnergyStorageVisualization * energyStorageVisualization ) const

protectedpure virtual

Implemented in inet::visualizer::EnergyStorageCanvasVisualizer, and inet::visualizer::EnergyStorageOsgVisualizer.

Referenced by refreshDisplay().

◆ removeAllEnergyStorageVisualizations()

void inet::visualizer::EnergyStorageVisualizerBase::removeAllEnergyStorageVisualizations ( )

protectedvirtual

 {
     for (auto energyStorageVisualization : std::vector<const EnergyStorageVisualization *>(energyStorageVisualizations)) {
         removeEnergyStorageVisualization(energyStorageVisualization);
         delete energyStorageVisualization;
     }
 }

Referenced by handleParameterChange(), and preDelete().

◆ removeEnergyStorageVisualization()

void inet::visualizer::EnergyStorageVisualizerBase::removeEnergyStorageVisualization ( const EnergyStorageVisualization * energyStorageVisualization )

protectedvirtual

Reimplemented in inet::visualizer::EnergyStorageCanvasVisualizer.

 {
     energyStorageVisualizations.erase(std::remove(energyStorageVisualizations.begin(), energyStorageVisualizations.end(), energyStorageVisualization), energyStorageVisualizations.end());
 }