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 cModule *	getNetworkNode (const InterfaceVisualization *interfaceVisualization)
virtual InterfaceEntry *	getInterfaceEntry (const InterfaceVisualization *interfaceVisualization)
virtual cGate *	getOutputGate (cModule *networkNode, InterfaceEntry *interfaceEntry)
virtual cGate *	getOutputGate (const InterfaceVisualization *interfaceVisualization)
virtual InterfaceVisualization *	createInterfaceVisualization (cModule *networkNode, InterfaceEntry *interfaceEntry) override
virtual void	addInterfaceVisualization (const InterfaceVisualization *interfaceVisualization) override
virtual void	removeInterfaceVisualization (const InterfaceVisualization *interfaceVisualization) override
virtual void	refreshInterfaceVisualization (const InterfaceVisualization *interfaceVisualization, const InterfaceEntry *interfaceEntry) override
Protected Member Functions inherited from inet::visualizer::InterfaceTableVisualizerBase
virtual void	handleParameterChange (const char *name) override
virtual void	subscribe ()
virtual void	unsubscribe ()
virtual const InterfaceVisualization *	getInterfaceVisualization (cModule *networkNode, InterfaceEntry *interfaceEntry)
virtual void	addAllInterfaceVisualizations ()
virtual void	removeAllInterfaceVisualizations ()
virtual void	updateAllInterfaceVisualizations ()
virtual std::string	getVisualizationText (const InterfaceEntry *interfaceEntry)
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
double	zIndex = NaN
NetworkNodeCanvasVisualizer *	networkNodeVisualizer = nullptr
Protected Attributes inherited from inet::visualizer::InterfaceTableVisualizerBase
std::map< std::pair< int, int >, const InterfaceVisualization * >	interfaceVisualizations
bool	displayInterfaceTables = false
bool	displayWiredInterfacesAtConnections = false
bool	displayBackground = false
NetworkNodeFilter	nodeFilter
InterfaceFilter	interfaceFilter
StringFormat	format
Displacement	displacementHint
double	displacementPriority
cFigure::Font	font
cFigure::Color	textColor
cFigure::Color	backgroundColor
double	opacity = NaN
Protected Attributes inherited from inet::visualizer::VisualizerBase
cModule *	visualizerTargetModule = nullptr
const char *	tags = nullptr

Additional Inherited Members
Public Member Functions inherited from inet::visualizer::InterfaceTableVisualizerBase
virtual	~InterfaceTableVisualizerBase ()
virtual void	receiveSignal (cComponent *source, simsignal_t signal, cObject *object, cObject *details) override

Member Function Documentation

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

overrideprotectedvirtual

Reimplemented from inet::visualizer::InterfaceTableVisualizerBase.

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

InterfaceTableVisualizerBase::InterfaceVisualization * inet::visualizer::InterfaceTableCanvasVisualizer::createInterfaceVisualization ( cModule *  networkNode, InterfaceEntry *  interfaceEntry  )

overrideprotectedvirtual

Implements inet::visualizer::InterfaceTableVisualizerBase.

{
    BoxedLabelFigure *figure = nullptr;
    auto gate = displayWiredInterfacesAtConnections ? getOutputGate(networkNode, interfaceEntry) : nullptr;
    if (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(interfaceEntry);
        figure->setZIndex(zIndex);
        figure->setFont(font);
        figure->setText(getVisualizationText(interfaceEntry).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(), interfaceEntry->getInterfaceId());
}

InterfaceEntry * inet::visualizer::InterfaceTableCanvasVisualizer::getInterfaceEntry ( const InterfaceVisualization *  interfaceVisualization )

protectedvirtual

Referenced by addInterfaceVisualization(), and getOutputGate().

{
    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);
}

cModule * inet::visualizer::InterfaceTableCanvasVisualizer::getNetworkNode ( const InterfaceVisualization *  interfaceVisualization )

protectedvirtual

Referenced by getInterfaceEntry(), and getOutputGate().

{
    L3AddressResolver addressResolver;
    return getSimulation()->getModule(interfaceVisualization->networkNodeId);
}

cGate * inet::visualizer::InterfaceTableCanvasVisualizer::getOutputGate ( cModule *  networkNode, InterfaceEntry *  interfaceEntry  )

protectedvirtual

Referenced by addInterfaceVisualization(), createInterfaceVisualization(), getOutputGate(), refreshInterfaceVisualization(), and removeInterfaceVisualization().

{
    if (interfaceEntry->getNodeOutputGateId() == -1)
        return nullptr;
    cGate *outputGate = networkNode->gate(interfaceEntry->getNodeOutputGateId());
    if (outputGate == nullptr || outputGate->getChannel() == nullptr)
        return nullptr;
    else
        return outputGate;
}

cGate * inet::visualizer::InterfaceTableCanvasVisualizer::getOutputGate ( const InterfaceVisualization *  interfaceVisualization )

protectedvirtual

{
    auto networkNode = getNetworkNode(interfaceVisualization);
    auto interfaceEntry = getInterfaceEntry(interfaceVisualization);
    if (interfaceEntry == nullptr)
        return nullptr;
    else
        return getOutputGate(networkNode, interfaceEntry);
}

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 = getModuleFromPar<NetworkNodeCanvasVisualizer>(par("networkNodeVisualizerModule"), this);
    }
}

void inet::visualizer::InterfaceTableCanvasVisualizer::refreshInterfaceVisualization ( const InterfaceVisualization *  interfaceVisualization, const InterfaceEntry *  interfaceEntry  )

overrideprotectedvirtual

Implements inet::visualizer::InterfaceTableVisualizerBase.

{
    auto interfaceCanvasVisualization = static_cast<const InterfaceCanvasVisualization *>(interfaceVisualization);
    auto gate = displayWiredInterfacesAtConnections ? getOutputGate(interfaceVisualization) : nullptr;
    if (gate != nullptr)
        gate->getDisplayString().setTagArg("t", 0, getVisualizationText(interfaceEntry).c_str());
    else {
        auto figure = interfaceCanvasVisualization->figure;
        figure->setText(getVisualizationText(interfaceEntry).c_str());
        interfaceCanvasVisualization->networkNodeVisualization->setAnnotationSize(figure, figure->getBounds().getSize());
    }
}

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

overrideprotectedvirtual

Reimplemented from inet::visualizer::InterfaceTableVisualizerBase.

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

Member Data Documentation

NetworkNodeCanvasVisualizer* inet::visualizer::InterfaceTableCanvasVisualizer::networkNodeVisualizer = nullptr

protected

Referenced by createInterfaceVisualization(), and initialize().

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