inet::visualizer::InterfaceTableCanvasVisualizer Class Reference

#include <InterfaceTableCanvasVisualizer.h>

Inheritance diagram for inet::visualizer::InterfaceTableCanvasVisualizer:

Classes
class	InterfaceCanvasVisualization

Protected Member Functions
virtual void	initialize (int stage) override
virtual NetworkInterface *	getNetworkInterface (const InterfaceVisualization *interfaceVisualization)
virtual InterfaceVisualization *	createInterfaceVisualization (cModule *networkNode, NetworkInterface *networkInterface) override
virtual void	addInterfaceVisualization (const InterfaceVisualization *interfaceVisualization) override
virtual void	removeInterfaceVisualization (const InterfaceVisualization *interfaceVisualization) override
virtual void	refreshInterfaceVisualization (const InterfaceVisualization *interfaceVisualization, const NetworkInterface *networkInterface) override
Protected Member Functions inherited from inet::visualizer::InterfaceTableVisualizerBase
virtual void	handleParameterChange (const char *name) override
virtual void	preDelete (cComponent *root) override
virtual void	subscribe ()
virtual void	unsubscribe ()
virtual cModule *	getNetworkNode (const InterfaceVisualization *interfaceVisualization)
virtual cGate *	getOutputGate (cModule *networkNode, NetworkInterface *networkInterface)
virtual cGate *	getOutputGate (const InterfaceVisualization *interfaceVisualization)
virtual const InterfaceVisualization *	getInterfaceVisualization (cModule *networkNode, NetworkInterface *networkInterface)
virtual void	addAllInterfaceVisualizations ()
virtual void	removeAllInterfaceVisualizations ()
virtual void	updateAllInterfaceVisualizations ()
virtual std::string	getVisualizationText (const NetworkInterface *networkInterface)
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::InterfaceTableVisualizerBase
bool	displayInterfaceTables = false
bool	displayWiredInterfacesAtConnections = false
bool	displayBackground = false
NetworkNodeFilter	nodeFilter
InterfaceFilter	interfaceFilter
StringFormat	format
Placement	placementHint
double	placementPriority
cFigure::Font	font
cFigure::Color	textColor
cFigure::Color	backgroundColor
double	opacity = NaN
std::map< std::pair< int, int >, const InterfaceVisualization * >	interfaceVisualizations
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::InterfaceTableVisualizerBase
virtual void	receiveSignal (cComponent *source, simsignal_t signal, cObject *object, cObject *details) override

Member Function Documentation

addInterfaceVisualization()

void inet::visualizer::InterfaceTableCanvasVisualizer::addInterfaceVisualization ( const InterfaceVisualization *  interfaceVisualization )

overrideprotectedvirtual

Reimplemented from inet::visualizer::InterfaceTableVisualizerBase.

{
    InterfaceTableVisualizerBase::addInterfaceVisualization(interfaceVisualization);
    auto interfaceCanvasVisualization = static_cast<const InterfaceCanvasVisualization *>(interfaceVisualization);
    if (interfaceCanvasVisualization->figure == nullptr) {
        auto gate = getOutputGate(interfaceVisualization);
        if (gate != nullptr && gate->getChannel()) {
            cDisplayString& displayString = gate->getDisplayString();
            displayString.setTagArg("t", 0, getVisualizationText(getNetworkInterface(interfaceVisualization)).c_str());
            displayString.setTagArg("t", 1, "l");
        }
    }
    else
        interfaceCanvasVisualization->networkNodeVisualization->addAnnotation(interfaceCanvasVisualization->figure, interfaceCanvasVisualization->figure->getBounds().getSize(), placementHint, placementPriority);
}

createInterfaceVisualization()

InterfaceTableVisualizerBase::InterfaceVisualization * inet::visualizer::InterfaceTableCanvasVisualizer::createInterfaceVisualization ( cModule *  networkNode, NetworkInterface *  networkInterface  )

overrideprotectedvirtual

Implements inet::visualizer::InterfaceTableVisualizerBase.

{
    BoxedLabelFigure *figure = nullptr;
    auto gate = getOutputGate(networkNode, networkInterface);
    if (!displayWiredInterfacesAtConnections || gate == nullptr) {
        figure = new BoxedLabelFigure("networkInterface");
        figure->setTags((std::string("network_interface ") + tags).c_str());
        figure->setTooltip("This label represents a network interface in a network node");
        figure->setAssociatedObject(networkInterface);
        figure->setZIndex(zIndex);
        figure->setFont(font);
        figure->setText(getVisualizationText(networkInterface).c_str());
        figure->setLabelColor(textColor);
        figure->setBackgroundColor(backgroundColor);
        figure->setOpacity(opacity);
        if (!displayBackground) {
            figure->setInset(0);
            figure->getRectangleFigure()->setVisible(false);
        }
    }
    auto networkNodeVisualization = networkNodeVisualizer->getNetworkNodeVisualization(networkNode);
    return new InterfaceCanvasVisualization(networkNodeVisualization, figure, networkNode->getId(), gate == nullptr ? -1 : gate->getId(), networkInterface->getInterfaceId());
}

getNetworkInterface()

NetworkInterface * inet::visualizer::InterfaceTableCanvasVisualizer::getNetworkInterface ( const InterfaceVisualization *  interfaceVisualization )

protectedvirtual

{
    L3AddressResolver addressResolver;
    auto networkNode = getNetworkNode(interfaceVisualization);
    if (networkNode == nullptr)
        return nullptr;
    auto interfaceTable = addressResolver.findInterfaceTableOf(networkNode);
    if (interfaceTable == nullptr)
        return nullptr;
    return interfaceTable->getInterfaceById(interfaceVisualization->interfaceId);
}

Referenced by addInterfaceVisualization().

initialize()

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

overrideprotectedvirtual

Reimplemented from inet::visualizer::InterfaceTableVisualizerBase.

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

refreshInterfaceVisualization()

void inet::visualizer::InterfaceTableCanvasVisualizer::refreshInterfaceVisualization ( const InterfaceVisualization *  interfaceVisualization, const NetworkInterface *  networkInterface  )

overrideprotectedvirtual

Implements inet::visualizer::InterfaceTableVisualizerBase.

{
    auto interfaceCanvasVisualization = static_cast<const InterfaceCanvasVisualization *>(interfaceVisualization);
    auto figure = interfaceCanvasVisualization->figure;
    if (figure == nullptr) {
        auto gate = getOutputGate(interfaceVisualization);
        if (gate != nullptr && gate->getChannel()) {
            cDisplayString& displayString = gate->getDisplayString();
            displayString.setTagArg("t", 0, getVisualizationText(networkInterface).c_str());
            displayString.setTagArg("t", 1, "l");
        }
    }
    else {
        figure->setText(getVisualizationText(networkInterface).c_str());
        interfaceCanvasVisualization->networkNodeVisualization->setAnnotationSize(figure, figure->getBounds().getSize());
    }
}

removeInterfaceVisualization()

void inet::visualizer::InterfaceTableCanvasVisualizer::removeInterfaceVisualization ( const InterfaceVisualization *  interfaceVisualization )

overrideprotectedvirtual

Reimplemented from inet::visualizer::InterfaceTableVisualizerBase.

{
    InterfaceTableVisualizerBase::removeInterfaceVisualization(interfaceVisualization);
    auto interfaceCanvasVisualization = static_cast<const InterfaceCanvasVisualization *>(interfaceVisualization);
    if (interfaceCanvasVisualization->figure == nullptr) {
        auto gate = getOutputGate(interfaceVisualization);
        if (gate != nullptr && gate->getChannel())
            gate->getDisplayString().setTagArg("t", 0, "");
    }
    else if (networkNodeVisualizer != nullptr)
        interfaceCanvasVisualization->networkNodeVisualization->removeAnnotation(interfaceCanvasVisualization->figure);
}

Member Data Documentation

networkNodeVisualizer

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

protected

Referenced by createInterfaceVisualization(), initialize(), and removeInterfaceVisualization().

zIndex

double inet::visualizer::InterfaceTableCanvasVisualizer::zIndex = NaN

protected

Referenced by createInterfaceVisualization(), and initialize().

---

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

• InterfaceTableCanvasVisualizer.h
• InterfaceTableCanvasVisualizer.cc