inet::visualizer::StatisticVisualizerBase Class Reference

#include <StatisticVisualizerBase.h>

Inheritance diagram for inet::visualizer::StatisticVisualizerBase:

Classes
class	DirectiveResolver
class	LastValueRecorder
class	StatisticVisualization

Public Member Functions
virtual	~StatisticVisualizerBase ()
virtual void	receiveSignal (cComponent *source, simsignal_t signal, bool b, cObject *details) override
virtual void	receiveSignal (cComponent *source, simsignal_t signal, long l, cObject *details) override
virtual void	receiveSignal (cComponent *source, simsignal_t signal, unsigned long l, cObject *details) override
virtual void	receiveSignal (cComponent *source, simsignal_t signal, double d, cObject *details) override
virtual void	receiveSignal (cComponent *source, simsignal_t signal, const SimTime &t, cObject *details) override
virtual void	receiveSignal (cComponent *source, simsignal_t signal, const char *s, cObject *details) override
virtual void	receiveSignal (cComponent *source, simsignal_t signal, cObject *obj, cObject *details) override

Protected Member Functions
virtual void	initialize (int stage) override
virtual void	handleParameterChange (const char *name) override
virtual void	subscribe ()
virtual void	unsubscribe ()
virtual cResultFilter *	findResultFilter (cComponent *source, simsignal_t signal)
virtual cResultFilter *	findResultFilter (cResultFilter *parentResultFilter, cResultListener *resultListener)
virtual std::string	getText (const StatisticVisualization *statisticVisualization)
virtual const char *	getUnit (cComponent *source)
virtual StatisticVisualization *	createStatisticVisualization (cComponent *source, simsignal_t signal)=0
virtual const StatisticVisualization *	getStatisticVisualization (cComponent *source, simsignal_t signal)
virtual void	addStatisticVisualization (const StatisticVisualization *statisticVisualization)
virtual void	removeStatisticVisualization (const StatisticVisualization *statisticVisualization)
virtual void	removeAllStatisticVisualizations ()
virtual void	refreshStatisticVisualization (const StatisticVisualization *statisticVisualization)
virtual void	processSignal (cComponent *source, simsignal_t signal, double value)
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::map< std::pair< int, simsignal_t >, const StatisticVisualization * >	statisticVisualizations
Parameters
bool	displayStatistics = false
ModuleFilter	sourceFilter
const char *	signalName = nullptr
const char *	statisticName = nullptr
StringFormat	format
std::vector< std::string >	units
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

Constructor & Destructor Documentation

inet::visualizer::StatisticVisualizerBase::~StatisticVisualizerBase ( )

virtual

{
    if (displayStatistics)
        unsubscribe();
}

Member Function Documentation

void inet::visualizer::StatisticVisualizerBase::addStatisticVisualization ( const StatisticVisualization *  statisticVisualization )

protectedvirtual

Reimplemented in inet::visualizer::StatisticCanvasVisualizer.

Referenced by inet::visualizer::StatisticCanvasVisualizer::addStatisticVisualization(), and processSignal().

{
    auto key = std::pair<int, simsignal_t>(statisticVisualization->moduleId, statisticVisualization->signal);
    statisticVisualizations[key] = statisticVisualization;
}

virtual StatisticVisualization* inet::visualizer::StatisticVisualizerBase::createStatisticVisualization ( cComponent *  source, simsignal_t  signal  )

protectedpure virtual

Implemented in inet::visualizer::StatisticOsgVisualizer, and inet::visualizer::StatisticCanvasVisualizer.

Referenced by processSignal().

cResultFilter * inet::visualizer::StatisticVisualizerBase::findResultFilter ( cComponent *  source, simsignal_t  signal  )

protectedvirtual

Referenced by findResultFilter(), and processSignal().

{
    auto listeners = source->getLocalSignalListeners(signal);
    for (auto listener : listeners) {
        if (auto resultListener = dynamic_cast<cResultListener *>(listener)) {
            auto foundResultFilter = findResultFilter(nullptr, resultListener);
            if (foundResultFilter != nullptr)
                return foundResultFilter;
        }
    }
    return nullptr;
}

cResultFilter * inet::visualizer::StatisticVisualizerBase::findResultFilter ( cResultFilter *  parentResultFilter, cResultListener *  resultListener  )

protectedvirtual

{
    if (auto resultRecorder = dynamic_cast<cResultRecorder *>(resultListener)) {
        if (resultRecorder->getStatisticName() == nullptr || !strcmp(statisticName, resultRecorder->getStatisticName()))
            return parentResultFilter;
    }
    else if (auto resultFilter = dynamic_cast<cResultFilter *>(resultListener)) {
        auto delegates = resultFilter->getDelegates();
        for (auto delegate : delegates) {
            auto foundResultFilter = findResultFilter(resultFilter, delegate);
            if (foundResultFilter != nullptr)
                return foundResultFilter;
        }
    }
    return nullptr;
}

const StatisticVisualizerBase::StatisticVisualization * inet::visualizer::StatisticVisualizerBase::getStatisticVisualization ( cComponent *  source, simsignal_t  signal  )

protectedvirtual

Referenced by processSignal().

{
    auto key = std::pair<int, simsignal_t>(source->getId(), signal);
    auto it = statisticVisualizations.find(key);
    if (it == statisticVisualizations.end())
        return nullptr;
    else
        return it->second;
}

std::string inet::visualizer::StatisticVisualizerBase::getText ( const StatisticVisualization *  statisticVisualization )

protectedvirtual

Referenced by inet::visualizer::StatisticCanvasVisualizer::refreshStatisticVisualization().

{
    DirectiveResolver directiveResolver(this, statisticVisualization);
    return format.formatString(&directiveResolver);
}

const char * inet::visualizer::StatisticVisualizerBase::getUnit ( cComponent *  source )

protectedvirtual

Referenced by inet::visualizer::StatisticCanvasVisualizer::createStatisticVisualization().

{
    auto properties = source->getProperties();
    for (int i = 0; i < properties->getNumProperties(); i++) {
        auto property = properties->get(i);
        if (!strcmp(property->getName(), "statistic") && !strcmp(property->getIndex(), statisticName))
            return property->getValue("unit", 0);
    }
    return nullptr;
}

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

overrideprotectedvirtual

{
    if (name != nullptr) {
        if (!strcmp(name, "sourceFilter"))
            sourceFilter.setPattern(par("sourceFilter"));
        else if (!strcmp(name, "format"))
            format.parseFormat(par("format"));
        removeAllStatisticVisualizations();
    }
}

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

overrideprotectedvirtual

Reimplemented from inet::visualizer::VisualizerBase.

Reimplemented in inet::visualizer::StatisticOsgVisualizer, and inet::visualizer::StatisticCanvasVisualizer.

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

{
    VisualizerBase::initialize(stage);
    if (!hasGUI()) return;
    if (stage == INITSTAGE_LOCAL) {
        displayStatistics = par("displayStatistics");
        sourceFilter.setPattern(par("sourceFilter"));
        signalName = par("signalName");
        statisticName = par("statisticName");
        format.parseFormat(par("format"));
        cStringTokenizer tokenizer(par("unit"));
        while (tokenizer.hasMoreTokens())
            units.push_back(tokenizer.nextToken());
        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");
        if (displayStatistics)
            subscribe();
    }
}

void inet::visualizer::StatisticVisualizerBase::processSignal ( cComponent *  source, simsignal_t  signal, double  value  )

protectedvirtual

{
    auto statisticVisualization = getStatisticVisualization(source, signal);
    if (statisticVisualization != nullptr)
        refreshStatisticVisualization(statisticVisualization);
    else {
        if (sourceFilter.matches(check_and_cast<cModule *>(source))) {
            statisticVisualization = createStatisticVisualization(source, signal);
            auto resultFilter = findResultFilter(source, signal);
            statisticVisualization->recorder->setLastValue(value);
            if (resultFilter == nullptr)
                source->subscribe(registerSignal(signalName), statisticVisualization->recorder);
            else
                resultFilter->addDelegate(statisticVisualization->recorder);
            addStatisticVisualization(statisticVisualization);
            refreshStatisticVisualization(statisticVisualization);
        }
    }
}

virtual void inet::visualizer::StatisticVisualizerBase::receiveSignal ( cComponent *  source, simsignal_t  signal, bool  b, cObject *  details  )

inlineoverridevirtual

{ processSignal(source, signal, NaN); }

virtual void inet::visualizer::StatisticVisualizerBase::receiveSignal ( cComponent *  source, simsignal_t  signal, long  l, cObject *  details  )

inlineoverridevirtual

{ processSignal(source, signal, l); }

virtual void inet::visualizer::StatisticVisualizerBase::receiveSignal ( cComponent *  source, simsignal_t  signal, unsigned long  l, cObject *  details  )

inlineoverridevirtual

{ processSignal(source, signal, l); }

virtual void inet::visualizer::StatisticVisualizerBase::receiveSignal ( cComponent *  source, simsignal_t  signal, double  d, cObject *  details  )

inlineoverridevirtual

{ processSignal(source, signal, d); }

virtual void inet::visualizer::StatisticVisualizerBase::receiveSignal ( cComponent *  source, simsignal_t  signal, const SimTime &  t, cObject *  details  )

inlineoverridevirtual

{ processSignal(source, signal, t.dbl()); }

virtual void inet::visualizer::StatisticVisualizerBase::receiveSignal ( cComponent *  source, simsignal_t  signal, const char *  s, cObject *  details  )

inlineoverridevirtual

{ processSignal(source, signal, NaN); }

virtual void inet::visualizer::StatisticVisualizerBase::receiveSignal ( cComponent *  source, simsignal_t  signal, cObject *  obj, cObject *  details  )

inlineoverridevirtual

{ processSignal(source, signal, NaN); }

void inet::visualizer::StatisticVisualizerBase::refreshStatisticVisualization ( const StatisticVisualization *  statisticVisualization )

protectedvirtual

Reimplemented in inet::visualizer::StatisticOsgVisualizer, and inet::visualizer::StatisticCanvasVisualizer.

Referenced by processSignal(), and inet::visualizer::StatisticCanvasVisualizer::refreshStatisticVisualization().

{
    double value = statisticVisualization->recorder->getLastValue();
    if (std::isnan(value) || units.empty()) {
        statisticVisualization->printValue = value;
        statisticVisualization->printUnit = statisticVisualization->unit == nullptr ? "" : statisticVisualization->unit;
    }
    else {
        for (auto& unit : units) {
            statisticVisualization->printUnit = unit.c_str();
            statisticVisualization->printValue = cNEDValue::convertUnit(value, statisticVisualization->unit, statisticVisualization->printUnit);
            if (statisticVisualization->printValue > 1)
                break;
        }
    }
}

void inet::visualizer::StatisticVisualizerBase::removeAllStatisticVisualizations ( )

protectedvirtual

Referenced by handleParameterChange().

{
    std::vector<const StatisticVisualization *> removedStatisticVisualizations;
    for (auto it : statisticVisualizations)
        removedStatisticVisualizations.push_back(it.second);
    for (auto it : removedStatisticVisualizations) {
        removeStatisticVisualization(it);
        delete it;
    }
}

void inet::visualizer::StatisticVisualizerBase::removeStatisticVisualization ( const StatisticVisualization *  statisticVisualization )

protectedvirtual

Reimplemented in inet::visualizer::StatisticCanvasVisualizer.

Referenced by removeAllStatisticVisualizations(), and inet::visualizer::StatisticCanvasVisualizer::removeStatisticVisualization().

{
    auto key = std::pair<int, simsignal_t>(statisticVisualization->moduleId, statisticVisualization->signal);
    statisticVisualizations.erase(statisticVisualizations.find(key));
}

void inet::visualizer::StatisticVisualizerBase::subscribe ( )

protectedvirtual

Referenced by initialize().

{
    auto subscriptionModule = getModuleFromPar<cModule>(par("subscriptionModule"), this);
    if (*signalName != '\0')
        subscriptionModule->subscribe(registerSignal(signalName), this);
}

void inet::visualizer::StatisticVisualizerBase::unsubscribe ( )

protectedvirtual

Referenced by ~StatisticVisualizerBase().

{
    // NOTE: lookup the module again because it may have been deleted first
    auto subscriptionModule = getModuleFromPar<cModule>(par("subscriptionModule"), this, false);
    if (subscriptionModule != nullptr) {
        if (*signalName != '\0')
            subscriptionModule->unsubscribe(registerSignal(signalName), this);
    }
}

Member Data Documentation

cFigure::Color inet::visualizer::StatisticVisualizerBase::backgroundColor

protected

Referenced by inet::visualizer::StatisticCanvasVisualizer::createStatisticVisualization(), and initialize().

Displacement inet::visualizer::StatisticVisualizerBase::displacementHint

protected

Referenced by inet::visualizer::StatisticCanvasVisualizer::addStatisticVisualization(), and initialize().

double inet::visualizer::StatisticVisualizerBase::displacementPriority

protected

Referenced by inet::visualizer::StatisticCanvasVisualizer::addStatisticVisualization(), and initialize().

bool inet::visualizer::StatisticVisualizerBase::displayStatistics = false

protected

Referenced by initialize(), and ~StatisticVisualizerBase().

cFigure::Font inet::visualizer::StatisticVisualizerBase::font

protected

Referenced by inet::visualizer::StatisticCanvasVisualizer::createStatisticVisualization(), and initialize().

StringFormat inet::visualizer::StatisticVisualizerBase::format

protected

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

double inet::visualizer::StatisticVisualizerBase::opacity = NaN

protected

Referenced by inet::visualizer::StatisticCanvasVisualizer::createStatisticVisualization(), and initialize().

const char* inet::visualizer::StatisticVisualizerBase::signalName = nullptr

protected

Referenced by initialize(), processSignal(), subscribe(), and unsubscribe().

ModuleFilter inet::visualizer::StatisticVisualizerBase::sourceFilter

protected

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

const char* inet::visualizer::StatisticVisualizerBase::statisticName = nullptr

protected

Referenced by findResultFilter(), getUnit(), and initialize().

std::map<std::pair<int, simsignal_t>, const StatisticVisualization *> inet::visualizer::StatisticVisualizerBase::statisticVisualizations

protected

Referenced by addStatisticVisualization(), getStatisticVisualization(), removeAllStatisticVisualizations(), and removeStatisticVisualization().

cFigure::Color inet::visualizer::StatisticVisualizerBase::textColor

protected

Referenced by inet::visualizer::StatisticCanvasVisualizer::createStatisticVisualization(), and initialize().

std::vector<std::string> inet::visualizer::StatisticVisualizerBase::units

protected

Referenced by initialize(), and refreshStatisticVisualization().

---

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

• StatisticVisualizerBase.h
• StatisticVisualizerBase.cc