inet::visualizer::StatisticCanvasVisualizer Class Reference

#include <StatisticCanvasVisualizer.h>

Inheritance diagram for inet::visualizer::StatisticCanvasVisualizer:

Classes
class	StatisticCanvasVisualization

Protected Member Functions
virtual void	initialize (int stage) override
virtual StatisticVisualization *	createStatisticVisualization (cComponent *source, simsignal_t signal) override
virtual void	addStatisticVisualization (const StatisticVisualization *statisticVisualization) override
virtual void	removeStatisticVisualization (const StatisticVisualization *statisticVisualization) override
virtual void	refreshStatisticVisualization (const StatisticVisualization *statisticVisualization) override
Protected Member Functions inherited from inet::visualizer::StatisticVisualizerBase
virtual void	handleParameterChange (const char *name) override
virtual void	preDelete (cComponent *root) override
virtual void	subscribe ()
virtual void	unsubscribe ()
virtual void	addResultRecorder (cComponent *source, simsignal_t signal)
virtual LastValueRecorder *	getResultRecorder (cComponent *source, simsignal_t signal)
virtual LastValueRecorder *	findResultRecorder (cResultListener *resultListener)
virtual std::string	getText (const StatisticVisualization *statisticVisualization)
virtual const char *	getUnit (cComponent *source)
virtual std::string	getRecordingMode ()
virtual const StatisticVisualization *	getStatisticVisualization (cComponent *source, simsignal_t signal)
virtual void	removeAllStatisticVisualizations ()
virtual void	processSignal (cComponent *source, simsignal_t signal, std::function< void(cIListener *)> receiveSignal)
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
double	zIndex = NaN
ModuleRefByPar< NetworkNodeCanvasVisualizer >	networkNodeVisualizer
Protected Attributes inherited from inet::visualizer::StatisticVisualizerBase
bool	displayStatistics = false
ModuleFilter	sourceFilter
const char *	signalName = nullptr
const char *	statisticName = nullptr
const char *	statisticUnit = nullptr
const char *	statisticExpression = nullptr
StringFormat	format
std::vector< std::string >	units
cFigure::Font	font
cFigure::Color	textColor
cFigure::Color	backgroundColor
double	opacity = NaN
Placement	placementHint
double	placementPriority
std::map< std::pair< int, simsignal_t >, const StatisticVisualization * >	statisticVisualizations
Protected Attributes inherited from inet::visualizer::VisualizerBase
cModule *	visualizationTargetModule = nullptr
cModule *	visualizationSubjectModule = nullptr
const char *	tags = nullptr

Additional Inherited Members
Public Member Functions inherited from inet::visualizer::StatisticVisualizerBase
virtual void	receiveSignal (cComponent *source, simsignal_t signal, bool b, cObject *details) override
virtual void	receiveSignal (cComponent *source, simsignal_t signal, intval_t l, cObject *details) override
virtual void	receiveSignal (cComponent *source, simsignal_t signal, uintval_t 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

Member Function Documentation

addStatisticVisualization()

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

overrideprotectedvirtual

Reimplemented from inet::visualizer::StatisticVisualizerBase.

{
    StatisticVisualizerBase::addStatisticVisualization(statisticVisualization);
    auto statisticCanvasVisualization = static_cast<const StatisticCanvasVisualization *>(statisticVisualization);
    auto figure = statisticCanvasVisualization->figure;
    if (auto indicatorFigure = dynamic_cast<IIndicatorFigure *>(figure))
        statisticCanvasVisualization->networkNodeVisualization->addAnnotation(statisticCanvasVisualization->figure, indicatorFigure->getSize(), placementHint, placementPriority);
    else if (auto boxedLabelFigure = check_and_cast<BoxedLabelFigure *>(figure))
        statisticCanvasVisualization->networkNodeVisualization->addAnnotation(statisticCanvasVisualization->figure, boxedLabelFigure->getBounds().getSize(), placementHint, placementPriority);
}

createStatisticVisualization()

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

overrideprotectedvirtual

Implements inet::visualizer::StatisticVisualizerBase.

{
    cFigure *figure = nullptr;
    const char *propertyName = par("propertyName");
    const char *propertyIndex = par("propertyIndex");
    if (!strcmp(propertyName, "")) {
        auto boxedLabelFigure = new BoxedLabelFigure("statistic");
        boxedLabelFigure->setFont(font);
        boxedLabelFigure->setText("");
        boxedLabelFigure->setLabelColor(textColor);
        boxedLabelFigure->setBackgroundColor(backgroundColor);
        boxedLabelFigure->setOpacity(opacity);
        figure = boxedLabelFigure;
        figure->setTooltip("This label represents the current value of a statistic");
    }
    else {
        cProperty *property = nullptr;
        cModule *current = this;
        while (current != nullptr) {
            property = current->getProperties()->get(propertyName, strcmp(propertyIndex, "") ? propertyIndex : nullptr);
            if (property != nullptr)
                break;
            current = current->getParentModule();
        }
        if (property == nullptr)
            throw cRuntimeError("Cannot find property: @%s[%s] on the module path: %s", propertyName, propertyIndex, getFullPath().c_str());
        std::string classname = property->getValue("type");
        classname[0] = toupper(classname[0]);
        classname = "inet::" + classname + "Figure";
        figure = check_and_cast<cFigure *>(createOneIfClassIsKnown(classname.c_str()));
        if (figure == nullptr)
            throw cRuntimeError("Cannot create figure with type: %s", property->getValue("type"));
        figure->parse(property);
        figure->setName("statistic");
        figure->setTooltip("This figure represents the value of a statistic");
    }
    figure->setTags((std::string("statistic ") + tags).c_str());
    figure->setAssociatedObject(source);
    figure->setZIndex(zIndex);
    auto networkNode = getContainingNode(check_and_cast<cModule *>(source));
    auto networkNodeVisualization = networkNodeVisualizer->getNetworkNodeVisualization(networkNode);
    return new StatisticCanvasVisualization(networkNodeVisualization, figure, source->getId(), signal, getUnit(source));
}

initialize()

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

overrideprotectedvirtual

Reimplemented from inet::visualizer::StatisticVisualizerBase.

{
    StatisticVisualizerBase::initialize(stage);
    if (!hasGUI()) return;
    if (stage == INITSTAGE_LOCAL) {
        zIndex = par("zIndex");
        networkNodeVisualizer.reference(this, "networkNodeVisualizerModule", true);
    }
}

refreshStatisticVisualization()

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

overrideprotectedvirtual

Reimplemented from inet::visualizer::StatisticVisualizerBase.

{
    StatisticVisualizerBase::refreshStatisticVisualization(statisticVisualization);
    auto statisticCanvasVisualization = static_cast<const StatisticCanvasVisualization *>(statisticVisualization);
    auto figure = statisticCanvasVisualization->figure;
    if (auto indicatorFigure = dynamic_cast<IIndicatorFigure *>(figure))
        indicatorFigure->setValue(0, simTime(), statisticVisualization->recorder->getLastValue());
    else {
        auto boxedLabelFigure = check_and_cast<BoxedLabelFigure *>(figure);
        boxedLabelFigure->setText(getText(statisticVisualization).c_str());
        statisticCanvasVisualization->networkNodeVisualization->setAnnotationSize(figure, boxedLabelFigure->getBounds().getSize());
    }
}

removeStatisticVisualization()

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

overrideprotectedvirtual

Reimplemented from inet::visualizer::StatisticVisualizerBase.

{
    StatisticVisualizerBase::removeStatisticVisualization(statisticVisualization);
    auto statisticCanvasVisualization = static_cast<const StatisticCanvasVisualization *>(statisticVisualization);
    if (networkNodeVisualizer != nullptr)
        statisticCanvasVisualization->networkNodeVisualization->removeAnnotation(statisticCanvasVisualization->figure);
}

Member Data Documentation

networkNodeVisualizer

ModuleRefByPar<NetworkNodeCanvasVisualizer> inet::visualizer::StatisticCanvasVisualizer::networkNodeVisualizer

protected

Referenced by createStatisticVisualization(), initialize(), and removeStatisticVisualization().

zIndex

double inet::visualizer::StatisticCanvasVisualizer::zIndex = NaN

protected

Referenced by createStatisticVisualization(), and initialize().

---

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

• StatisticCanvasVisualizer.h
• StatisticCanvasVisualizer.cc