#include <InfoVisualizerBase.h>

Inheritance diagram for inet::visualizer::InfoVisualizerBase:

Classes
class	DirectiveResolver

class	InfoVisualization

Protected Member Functions
virtual void	initialize (int stage) override

virtual void	handleParameterChange (const char *name) override

virtual void	refreshDisplay () const override

virtual InfoVisualization *	createInfoVisualization (cModule *module) const =0

virtual void	addInfoVisualization (const InfoVisualization *infoVisualization)

virtual void	addInfoVisualizations ()

virtual void	removeInfoVisualization (const InfoVisualization *infoVisualization)

virtual void	refreshInfoVisualization (const InfoVisualization infoVisualization, const char info) const =0

virtual void	removeAllInfoVisualizations ()

virtual const char *	getInfoVisualizationText (cModule *module) const

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
std::vector< const InfoVisualization * >	infoVisualizations

Parameters
bool	displayInfos = false

ModuleFilter	modules

StringFormat	format

cFigure::Font	font

cFigure::Color	textColor

cFigure::Color	backgroundColor

double	opacity = NaN

Displacement	displacementHint

double	displacementPriority

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

const char *	tags = nullptr

Member Function Documentation

void inet::visualizer::InfoVisualizerBase::addInfoVisualization ( const InfoVisualization * infoVisualization )

protectedvirtual

Reimplemented in inet::visualizer::InfoCanvasVisualizer.

Referenced by inet::visualizer::InfoCanvasVisualizer::addInfoVisualization(), and addInfoVisualizations().

 {
     infoVisualizations.push_back(infoVisualization);
 }

void inet::visualizer::InfoVisualizerBase::addInfoVisualizations ( )

protectedvirtual

Referenced by handleParameterChange(), and initialize().

 {
     auto simulation = getSimulation();
     for (int id = 0; id < simulation->getLastComponentId(); id++) {
         auto component = simulation->getComponent(id);
         if (component != nullptr && component->isModule() && modules.matches(static_cast<cModule*>(component))) {
             auto infoVisualization = createInfoVisualization(static_cast<cModule*>(component));
             addInfoVisualization(infoVisualization);
         }
     }
 }

virtual InfoVisualization* inet::visualizer::InfoVisualizerBase::createInfoVisualization ( cModule * module ) const

protectedpure virtual

Implemented in inet::visualizer::InfoOsgVisualizer, and inet::visualizer::InfoCanvasVisualizer.

Referenced by addInfoVisualizations().

const char * inet::visualizer::InfoVisualizerBase::getInfoVisualizationText ( cModule * module ) const

protectedvirtual

Referenced by inet::visualizer::InfoCanvasVisualizer::createInfoVisualization(), and refreshDisplay().

 {
     DirectiveResolver directiveResolver(module);
     return format.formatString(&directiveResolver);
 }

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

overrideprotectedvirtual

 {
     if (name != nullptr) {
         if (!strcmp(name, "modules"))
             modules.setPattern(par("modules"));
         else if (!strcmp(name, "format"))
             format.parseFormat(par("format"));
         removeAllInfoVisualizations();
         addInfoVisualizations();
     }
 }

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

overrideprotectedvirtual

Reimplemented from inet::visualizer::VisualizerBase.

Reimplemented in inet::visualizer::InfoOsgVisualizer, and inet::visualizer::InfoCanvasVisualizer.

Referenced by inet::visualizer::InfoCanvasVisualizer::initialize().

 {
     VisualizerBase::initialize(stage);
     if (!hasGUI()) return;
     if (stage == INITSTAGE_LOCAL) {
         displayInfos = par("displayInfos");
         modules.setPattern(par("modules"));
         format.parseFormat(par("format"));
         font = cFigure::parseFont(par("font"));
         textColor = cFigure::Color(par("textColor"));
         backgroundColor = cFigure::Color(par("backgroundColor"));
         opacity = par("opacity");
         displacementHint = parseDisplacement(par("displacementHint"));
         displacementPriority = par("displacementPriority");
     }
     else if (stage == INITSTAGE_LAST) {
         if (displayInfos)
             addInfoVisualizations();
     }
 }

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

overrideprotectedvirtual

 {
     auto simulation = getSimulation();
     for (auto infoVisualization : infoVisualizations) {
         auto module = simulation->getModule(infoVisualization->moduleId);
         if (module != nullptr)
             refreshInfoVisualization(infoVisualization, getInfoVisualizationText(module));
     }
 }

virtual void inet::visualizer::InfoVisualizerBase::refreshInfoVisualization	(	const InfoVisualization *	infoVisualization,
		const char *	info
	)		const

protectedpure virtual

Implemented in inet::visualizer::InfoOsgVisualizer, and inet::visualizer::InfoCanvasVisualizer.

Referenced by refreshDisplay().

void inet::visualizer::InfoVisualizerBase::removeAllInfoVisualizations ( )

protectedvirtual

Referenced by handleParameterChange().

 {
     for (auto infoVisualization : infoVisualizations) {
         removeInfoVisualization(infoVisualization);
         delete infoVisualization;
     }
 }

void inet::visualizer::InfoVisualizerBase::removeInfoVisualization ( const InfoVisualization * infoVisualization )

protectedvirtual

Reimplemented in inet::visualizer::InfoCanvasVisualizer.

Referenced by removeAllInfoVisualizations(), and inet::visualizer::InfoCanvasVisualizer::removeInfoVisualization().

 {
     infoVisualizations.erase(std::remove(infoVisualizations.begin(), infoVisualizations.end(), infoVisualization), infoVisualizations.end());
 }

Member Data Documentation

cFigure::Color inet::visualizer::InfoVisualizerBase::backgroundColor

protected

Referenced by inet::visualizer::InfoCanvasVisualizer::createInfoVisualization(), and initialize().

Displacement inet::visualizer::InfoVisualizerBase::displacementHint

protected

Referenced by inet::visualizer::InfoCanvasVisualizer::addInfoVisualization(), and initialize().

double inet::visualizer::InfoVisualizerBase::displacementPriority

protected

Referenced by inet::visualizer::InfoCanvasVisualizer::addInfoVisualization(), and initialize().

bool inet::visualizer::InfoVisualizerBase::displayInfos = false

protected

Referenced by initialize().

cFigure::Font inet::visualizer::InfoVisualizerBase::font

protected

Referenced by inet::visualizer::InfoCanvasVisualizer::createInfoVisualization(), and initialize().

StringFormat inet::visualizer::InfoVisualizerBase::format

protected

Referenced by getInfoVisualizationText(), handleParameterChange(), and initialize().

std::vector<const InfoVisualization *> inet::visualizer::InfoVisualizerBase::infoVisualizations

protected

Referenced by addInfoVisualization(), refreshDisplay(), removeAllInfoVisualizations(), and removeInfoVisualization().

ModuleFilter inet::visualizer::InfoVisualizerBase::modules

protected

Referenced by addInfoVisualizations(), handleParameterChange(), and initialize().

double inet::visualizer::InfoVisualizerBase::opacity = NaN

protected

Referenced by inet::visualizer::InfoCanvasVisualizer::createInfoVisualization(), and initialize().

cFigure::Color inet::visualizer::InfoVisualizerBase::textColor

protected

Referenced by inet::visualizer::InfoCanvasVisualizer::createInfoVisualization(), and initialize().

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

Classes

Protected Member Functions

Protected Attributes

Member Function Documentation

Member Data Documentation