inet::visualizer::EnergyStorageCanvasVisualizer Class Reference

#include <EnergyStorageCanvasVisualizer.h>

Inheritance diagram for inet::visualizer::EnergyStorageCanvasVisualizer:

Classes
class	EnergyStorageCanvasVisualization

Protected Member Functions
virtual void	initialize (int stage) override
virtual EnergyStorageVisualization *	createEnergyStorageVisualization (const IEnergyStorage *energyStorage) const override
virtual void	addEnergyStorageVisualization (const EnergyStorageVisualization *energyStorageVisualization) override
virtual void	removeEnergyStorageVisualization (const EnergyStorageVisualization *energyStorageVisualization) override
virtual void	refreshEnergyStorageVisualization (const EnergyStorageVisualization *energyStorageVisualization) const override
Protected Member Functions inherited from inet::visualizer::EnergyStorageVisualizerBase
virtual void	handleParameterChange (const char *name) override
virtual void	refreshDisplay () const override
virtual double	getNominalCapacity (const IEnergyStorage *energyStorage) const
virtual double	getResidualCapacity (const IEnergyStorage *energyStorage) const
virtual void	addEnergyStorageVisualizations ()
virtual void	removeAllEnergyStorageVisualizations ()
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 InterfaceEntry *	getInterfaceEntry (cModule *networkNode, cModule *module) const

Protected Attributes
double	zIndex = NaN
NetworkNodeCanvasVisualizer *	networkNodeVisualizer = nullptr
Protected Attributes inherited from inet::visualizer::EnergyStorageVisualizerBase
std::vector< const EnergyStorageVisualization * >	energyStorageVisualizations
bool	displayEnergyStorages = false
ModuleFilter	energyStorageFilter
cFigure::Color	color
double	width
double	height
double	spacing
Displacement	displacementHint
double	displacementPriority
Protected Attributes inherited from inet::visualizer::VisualizerBase
cModule *	visualizerTargetModule = nullptr
const char *	tags = nullptr

Member Function Documentation

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

overrideprotectedvirtual

Reimplemented from inet::visualizer::EnergyStorageVisualizerBase.

{
    EnergyStorageVisualizerBase::addEnergyStorageVisualization(energyStorageVisualization);
    auto energyStorageCanvasVisualization = static_cast<const EnergyStorageCanvasVisualization *>(energyStorageVisualization);
    auto figure = energyStorageCanvasVisualization->figure;
    energyStorageCanvasVisualization->networkNodeVisualization->addAnnotation(figure, figure->getBounds().getSize(), displacementHint, displacementPriority);
}

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

overrideprotectedvirtual

Implements inet::visualizer::EnergyStorageVisualizerBase.

{
    auto module = check_and_cast<const cModule *>(energyStorage);
    auto figure = new BarFigure("energyStorage");
    figure->setTags((std::string("energyStorage ") + tags).c_str());
    figure->setTooltip("This figure represents an energy storage");
    figure->setAssociatedObject(const_cast<cModule *>(module));
    figure->setBounds(cFigure::Rectangle(0, 0, width, height));
    figure->setSpacing(spacing);
    figure->setColor(color);
    figure->setMinValue(0);
    figure->setMaxValue(getNominalCapacity(energyStorage));
    auto networkNode = getContainingNode(module);
    auto networkNodeVisualization = networkNodeVisualizer->getNetworkNodeVisualization(networkNode);
    return new EnergyStorageCanvasVisualization(networkNodeVisualization, figure, energyStorage);
}

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

overrideprotectedvirtual

Reimplemented from inet::visualizer::EnergyStorageVisualizerBase.

{
    EnergyStorageVisualizerBase::initialize(stage);
    if (!hasGUI()) return;
    if (stage == INITSTAGE_LOCAL) {
        zIndex = par("zIndex");
        networkNodeVisualizer = getModuleFromPar<NetworkNodeCanvasVisualizer>(par("networkNodeVisualizerModule"), this);
    }
}

void inet::visualizer::EnergyStorageCanvasVisualizer::refreshEnergyStorageVisualization ( const EnergyStorageVisualization *  energyStorageVisualization ) const

overrideprotectedvirtual

Implements inet::visualizer::EnergyStorageVisualizerBase.

{
    auto energyStorageCanvasVisualization = static_cast<const EnergyStorageCanvasVisualization *>(energyStorageVisualization);
    auto energyStorage = energyStorageVisualization->energyStorage;
    auto figure = energyStorageCanvasVisualization->figure;
    figure->setValue(getResidualCapacity(energyStorage));
}

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

overrideprotectedvirtual

Reimplemented from inet::visualizer::EnergyStorageVisualizerBase.

{
    EnergyStorageVisualizerBase::removeEnergyStorageVisualization(energyStorageVisualization);
    auto energyStorageCanvasVisualization = static_cast<const EnergyStorageCanvasVisualization *>(energyStorageVisualization);
    auto figure = energyStorageCanvasVisualization->figure;
    energyStorageCanvasVisualization->networkNodeVisualization->removeAnnotation(figure);
}

Member Data Documentation

NetworkNodeCanvasVisualizer* inet::visualizer::EnergyStorageCanvasVisualizer::networkNodeVisualizer = nullptr

protected

Referenced by createEnergyStorageVisualization(), and initialize().

double inet::visualizer::EnergyStorageCanvasVisualizer::zIndex = NaN

protected

Referenced by initialize().

---

The documentation for this class was generated from the following files:

• EnergyStorageCanvasVisualizer.h
• EnergyStorageCanvasVisualizer.cc