inet::visualizer::LinkCanvasVisualizerBase Class Reference

#include <LinkCanvasVisualizerBase.h>

Inheritance diagram for inet::visualizer::LinkCanvasVisualizerBase:

Classes
class	LinkCanvasVisualization

Protected Member Functions
virtual void	initialize (int stage) override
virtual void	refreshDisplay () const override
virtual const LinkVisualization *	createLinkVisualization (cModule *source, cModule *destination, cPacket *packet) const override
virtual void	addLinkVisualization (std::pair< int, int > sourceAndDestination, const LinkVisualization *linkVisualization) override
virtual void	removeLinkVisualization (const LinkVisualization *linkVisualization) override
virtual void	setAlpha (const LinkVisualization *linkVisualization, double alpha) const override
virtual void	refreshLinkVisualization (const LinkVisualization *linkVisualization, cPacket *packet) override
Protected Member Functions inherited from inet::visualizer::LinkVisualizerBase
virtual void	handleParameterChange (const char *name) override
virtual void	preDelete (cComponent *root) override
virtual void	subscribe ()
virtual void	unsubscribe ()
virtual bool	isLinkStart (cModule *module) const =0
virtual bool	isLinkEnd (cModule *module) const =0
virtual const LinkVisualization *	getLinkVisualization (std::pair< int, int > linkVisualization)
virtual void	removeAllLinkVisualizations ()
virtual cModule *	getLastModule (int treeId)
virtual void	setLastModule (int treeId, cModule *lastModule)
virtual void	removeLastModule (int treeId)
virtual std::string	getLinkVisualizationText (cPacket *packet) const
virtual void	updateLinkVisualization (cModule *source, cModule *destination, cPacket *packet)
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
const CanvasProjection *	canvasProjection = nullptr
cGroupFigure *	linkGroup = nullptr
Protected Attributes inherited from inet::visualizer::LinkVisualizerBase
bool	displayLinks = false
ActivityLevel	activityLevel = static_cast<ActivityLevel>(-1)
NetworkNodeFilter	nodeFilter
InterfaceFilter	interfaceFilter
PacketFilter	packetFilter
cFigure::Color	lineColor
cFigure::LineStyle	lineStyle
double	lineWidth = NaN
double	lineShift = NaN
const char *	lineShiftMode = nullptr
double	lineContactSpacing = NaN
const char *	lineContactMode = nullptr
StringFormat	labelFormat
cFigure::Font	labelFont
cFigure::Color	labelColor
const char *	fadeOutMode = nullptr
double	fadeOutTime = NaN
double	fadeOutAnimationSpeed = NaN
double	holdAnimationTime = NaN
LineManager *	lineManager = nullptr
std::map< int, int >	lastModules
	Maps packet to last module. More...
std::map< std::pair< int, int >, const LinkVisualization * >	linkVisualizations
	Maps source/destination module ids to link visualizations. More...
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::LinkVisualizerBase
virtual void	receiveSignal (cComponent *source, simsignal_t signal, cObject *object, cObject *details) override
Protected Types inherited from inet::visualizer::LinkVisualizerBase
enum	ActivityLevel { ACTIVITY_LEVEL_SERVICE, ACTIVITY_LEVEL_PEER, ACTIVITY_LEVEL_PROTOCOL }

Member Function Documentation

addLinkVisualization()

void inet::visualizer::LinkCanvasVisualizerBase::addLinkVisualization ( std::pair< int, int >  sourceAndDestination, const LinkVisualization *  linkVisualization  )

overrideprotectedvirtual

Reimplemented from inet::visualizer::LinkVisualizerBase.

{
    LinkVisualizerBase::addLinkVisualization(sourceAndDestination, linkVisualization);
    auto linkCanvasVisualization = static_cast<const LinkCanvasVisualization *>(linkVisualization);
    auto figure = linkCanvasVisualization->figure;
    lineManager->addModuleLine(linkVisualization);
    linkGroup->addFigure(figure);
}

createLinkVisualization()

const LinkVisualizerBase::LinkVisualization * inet::visualizer::LinkCanvasVisualizerBase::createLinkVisualization ( cModule *  source, cModule *  destination, cPacket *  packet  ) const

overrideprotectedvirtual

Implements inet::visualizer::LinkVisualizerBase.

Reimplemented in inet::visualizer::DataLinkCanvasVisualizer, and inet::visualizer::PhysicalLinkCanvasVisualizer.

{
    auto figure = new LabeledLineFigure("link");
    auto lineFigure = figure->getLineFigure();
    lineFigure->setEndArrowhead(cFigure::ARROW_BARBED);
    lineFigure->setLineWidth(lineWidth);
    lineFigure->setLineColor(lineColor);
    lineFigure->setLineStyle(lineStyle);
    auto labelFigure = figure->getLabelFigure();
    labelFigure->setFont(labelFont);
    labelFigure->setColor(labelColor);
    auto text = getLinkVisualizationText(packet);
    labelFigure->setText(text.c_str());
    return new LinkCanvasVisualization(figure, source->getId(), destination->getId());
}

Referenced by inet::visualizer::DataLinkCanvasVisualizer::createLinkVisualization(), and inet::visualizer::PhysicalLinkCanvasVisualizer::createLinkVisualization().

initialize()

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

overrideprotectedvirtual

Reimplemented from inet::visualizer::LinkVisualizerBase.

{
    LinkVisualizerBase::initialize(stage);
    if (!hasGUI()) return;
    if (stage == INITSTAGE_LOCAL) {
        zIndex = par("zIndex");
        auto canvas = visualizationTargetModule->getCanvas();
        lineManager = LineManager::getCanvasLineManager(canvas);
        canvasProjection = CanvasProjection::getCanvasProjection(canvas);
        linkGroup = new cGroupFigure("links");
        linkGroup->setZIndex(zIndex);
        canvas->addFigure(linkGroup);
    }
}

refreshDisplay()

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

overrideprotectedvirtual

Reimplemented from inet::visualizer::LinkVisualizerBase.

{
    LinkVisualizerBase::refreshDisplay();
    auto simulation = getSimulation();
    for (auto it : linkVisualizations) {
        auto linkVisualization = it.second;
        auto linkCanvasVisualization = static_cast<const LinkCanvasVisualization *>(linkVisualization);
        auto figure = linkCanvasVisualization->figure;
        auto sourceModule = simulation->getModule(linkVisualization->sourceModuleId);
        auto destinationModule = simulation->getModule(linkVisualization->destinationModuleId);
        if (sourceModule != nullptr && destinationModule != nullptr) {
            auto sourcePosition = getContactPosition(sourceModule, getPosition(destinationModule), lineContactMode, lineContactSpacing);
            auto destinationPosition = getContactPosition(destinationModule, getPosition(sourceModule), lineContactMode, lineContactSpacing);
            auto shift = lineManager->getLineShift(linkVisualization->sourceModuleId, linkVisualization->destinationModuleId, sourcePosition, destinationPosition, lineShiftMode, linkVisualization->shiftOffset) * lineShift;
            figure->setStart(canvasProjection->computeCanvasPoint(sourcePosition + shift));
            figure->setEnd(canvasProjection->computeCanvasPoint(destinationPosition + shift));
        }
    }
    visualizationTargetModule->getCanvas()->setAnimationSpeed(linkVisualizations.empty() ? 0 : fadeOutAnimationSpeed, this);
}

refreshLinkVisualization()

void inet::visualizer::LinkCanvasVisualizerBase::refreshLinkVisualization ( const LinkVisualization *  linkVisualization, cPacket *  packet  )

overrideprotectedvirtual

Reimplemented from inet::visualizer::LinkVisualizerBase.

{
    LinkVisualizerBase::refreshLinkVisualization(linkVisualization, packet);
    auto linkCanvasVisualization = static_cast<const LinkCanvasVisualization *>(linkVisualization);
    auto text = getLinkVisualizationText(packet);
    linkCanvasVisualization->figure->getLabelFigure()->setText(text.c_str());
}

removeLinkVisualization()

void inet::visualizer::LinkCanvasVisualizerBase::removeLinkVisualization ( const LinkVisualization *  linkVisualization )

overrideprotectedvirtual

Reimplemented from inet::visualizer::LinkVisualizerBase.

{
    LinkVisualizerBase::removeLinkVisualization(linkVisualization);
    auto linkCanvasVisualization = static_cast<const LinkCanvasVisualization *>(linkVisualization);
    lineManager->removeModuleLine(linkVisualization);
    linkGroup->removeFigure(linkCanvasVisualization->figure);
}

setAlpha()

void inet::visualizer::LinkCanvasVisualizerBase::setAlpha ( const LinkVisualization *  linkVisualization, double  alpha  ) const

overrideprotectedvirtual

Implements inet::visualizer::LinkVisualizerBase.

{
    auto linkCanvasVisualization = static_cast<const LinkCanvasVisualization *>(linkVisualization);
    auto figure = linkCanvasVisualization->figure;
    figure->getLineFigure()->setLineOpacity(alpha);
}

Member Data Documentation

canvasProjection

const CanvasProjection* inet::visualizer::LinkCanvasVisualizerBase::canvasProjection = nullptr

protected

Referenced by initialize(), and refreshDisplay().

linkGroup

cGroupFigure* inet::visualizer::LinkCanvasVisualizerBase::linkGroup = nullptr

protected

Referenced by addLinkVisualization(), initialize(), and removeLinkVisualization().

zIndex

double inet::visualizer::LinkCanvasVisualizerBase::zIndex = NaN

protected

Referenced by initialize().

---

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

• LinkCanvasVisualizerBase.h
• LinkCanvasVisualizerBase.cc