INET Framework for OMNeT++/OMNEST
inet::visualizer::QueueCanvasVisualizer Class Reference

#include <QueueCanvasVisualizer.h>

Inheritance diagram for inet::visualizer::QueueCanvasVisualizer:
inet::visualizer::QueueVisualizerBase inet::visualizer::VisualizerBase

Classes

class  QueueCanvasVisualization
 

Protected Member Functions

virtual void initialize (int stage) override
 
virtual QueueVisualizationcreateQueueVisualization (queueing::IPacketQueue *queue) const override
 
virtual void addQueueVisualization (const QueueVisualization *queueVisualization) override
 
virtual void removeQueueVisualization (const QueueVisualization *queueVisualization) override
 
virtual void refreshQueueVisualization (const QueueVisualization *queueVisualization) const override
 
- Protected Member Functions inherited from inet::visualizer::QueueVisualizerBase
virtual void handleParameterChange (const char *name) override
 
virtual void refreshDisplay () const override
 
virtual void preDelete (cComponent *root) override
 
virtual void addQueueVisualizations ()
 
virtual void removeAllQueueVisualizations ()
 
- 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< NetworkNodeCanvasVisualizernetworkNodeVisualizer
 
- Protected Attributes inherited from inet::visualizer::QueueVisualizerBase
bool displayQueues = false
 
QueueFilter queueFilter
 
cFigure::Color color
 
double width
 
double height
 
double spacing
 
Placement placementHint
 
double placementPriority
 
std::vector< const QueueVisualization * > queueVisualizations
 
- Protected Attributes inherited from inet::visualizer::VisualizerBase
cModule * visualizationTargetModule = nullptr
 
cModule * visualizationSubjectModule = nullptr
 
const char * tags = nullptr
 

Member Function Documentation

◆ addQueueVisualization()

void inet::visualizer::QueueCanvasVisualizer::addQueueVisualization ( const QueueVisualization queueVisualization)
overrideprotectedvirtual

Reimplemented from inet::visualizer::QueueVisualizerBase.

60 {
62  auto queueCanvasVisualization = static_cast<const QueueCanvasVisualization *>(queueVisualization);
63  auto figure = queueCanvasVisualization->figure;
64  queueCanvasVisualization->networkNodeVisualization->addAnnotation(figure, figure->getBounds().getSize(), placementHint, placementPriority);
65 }

◆ createQueueVisualization()

QueueVisualizerBase::QueueVisualization * inet::visualizer::QueueCanvasVisualizer::createQueueVisualization ( queueing::IPacketQueue queue) const
overrideprotectedvirtual

Implements inet::visualizer::QueueVisualizerBase.

42 {
43  auto ownedObject = check_and_cast<cOwnedObject *>(queue);
44  auto module = check_and_cast<cModule *>(ownedObject->getOwner());
45  auto figure = new QueueFigure("queue");
46  figure->setTags((std::string("queue ") + tags).c_str());
47  figure->setTooltip("This figure represents a queue");
48  figure->setAssociatedObject(ownedObject);
49  figure->setColor(color);
50  figure->setSpacing(spacing);
51  figure->setBounds(cFigure::Rectangle(0, 0, width, height));
52  if (auto packetQueue = dynamic_cast<queueing::PacketQueue *>(queue))
53  figure->setMaxElementCount(packetQueue->getMaxNumPackets());
54  auto networkNode = getContainingNode(module);
55  auto networkNodeVisualization = networkNodeVisualizer->getNetworkNodeVisualization(networkNode);
56  return new QueueCanvasVisualization(networkNodeVisualization, figure, queue);
57 }

◆ initialize()

void inet::visualizer::QueueCanvasVisualizer::initialize ( int  stage)
overrideprotectedvirtual

Reimplemented from inet::visualizer::QueueVisualizerBase.

32 {
34  if (!hasGUI()) return;
35  if (stage == INITSTAGE_LOCAL) {
36  zIndex = par("zIndex");
37  networkNodeVisualizer.reference(this, "networkNodeVisualizerModule", true);
38  }
39 }

◆ refreshQueueVisualization()

void inet::visualizer::QueueCanvasVisualizer::refreshQueueVisualization ( const QueueVisualization queueVisualization) const
overrideprotectedvirtual

Implements inet::visualizer::QueueVisualizerBase.

77 {
78  auto queueCanvasVisualization = static_cast<const QueueCanvasVisualization *>(queueVisualization);
79  auto queue = queueVisualization->queue;
80  auto figure = queueCanvasVisualization->figure;
81  figure->setElementCount(queue->getNumPackets());
82 }

◆ removeQueueVisualization()

void inet::visualizer::QueueCanvasVisualizer::removeQueueVisualization ( const QueueVisualization queueVisualization)
overrideprotectedvirtual

Reimplemented from inet::visualizer::QueueVisualizerBase.

68 {
70  auto queueCanvasVisualization = static_cast<const QueueCanvasVisualization *>(queueVisualization);
71  auto figure = queueCanvasVisualization->figure;
72  if (networkNodeVisualizer != nullptr)
73  queueCanvasVisualization->networkNodeVisualization->removeAnnotation(figure);
74 }

Member Data Documentation

◆ networkNodeVisualizer

ModuleRefByPar<NetworkNodeCanvasVisualizer> inet::visualizer::QueueCanvasVisualizer::networkNodeVisualizer
protected

◆ zIndex

double inet::visualizer::QueueCanvasVisualizer::zIndex = NaN
protected

Referenced by initialize().


The documentation for this class was generated from the following files:
inet::visualizer::QueueVisualizerBase::placementPriority
double placementPriority
Definition: QueueVisualizerBase.h:51
inet::visualizer::QueueVisualizerBase::placementHint
Placement placementHint
Definition: QueueVisualizerBase.h:50
inet::getContainingNode
cModule * getContainingNode(const cModule *from)
Find the node containing the given module.
Definition: ModuleAccess.cc:40
inet::visualizer::QueueVisualizerBase::spacing
double spacing
Definition: QueueVisualizerBase.h:49
inet::visualizer::QueueVisualizerBase::height
double height
Definition: QueueVisualizerBase.h:48
inet::visualizer::QueueVisualizerBase::color
cFigure::Color color
Definition: QueueVisualizerBase.h:46
inet::visualizer::QueueCanvasVisualizer::networkNodeVisualizer
ModuleRefByPar< NetworkNodeCanvasVisualizer > networkNodeVisualizer
Definition: QueueCanvasVisualizer.h:36
inet::INITSTAGE_LOCAL
INET_API InitStage INITSTAGE_LOCAL
Initialization of local state that don't use or affect other modules includes:
inet::visualizer::QueueVisualizerBase::initialize
virtual void initialize(int stage) override
Definition: QueueVisualizerBase.cc:36
inet::visualizer::QueueVisualizerBase::addQueueVisualization
virtual void addQueueVisualization(const QueueVisualization *queueVisualization)
Definition: QueueVisualizerBase.cc:71
inet::visualizer::QueueVisualizerBase::width
double width
Definition: QueueVisualizerBase.h:47
inet::visualizer::QueueCanvasVisualizer::zIndex
double zIndex
Definition: QueueCanvasVisualizer.h:35
inet::visualizer::VisualizerBase::tags
const char * tags
Definition: VisualizerBase.h:27
inet::visualizer::QueueVisualizerBase::removeQueueVisualization
virtual void removeQueueVisualization(const QueueVisualization *queueVisualization)
Definition: QueueVisualizerBase.cc:76