INET Framework for OMNeT++/OMNEST
inet::visualizer::QueueVisualizerBase Class Referenceabstract

#include <QueueVisualizerBase.h>

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

Classes

class  QueueVisitor
 
class  QueueVisualization
 

Parameters

bool displayQueues = false
 
QueueFilter queueFilter
 
cFigure::Color color
 
double width
 
double height
 
double spacing
 
Placement placementHint
 
double placementPriority
 
std::vector< const QueueVisualization * > queueVisualizations
 
virtual void initialize (int stage) override
 
virtual void handleParameterChange (const char *name) override
 
virtual void refreshDisplay () const override
 
virtual void preDelete (cComponent *root) override
 
virtual QueueVisualizationcreateQueueVisualization (queueing::IPacketQueue *queue) const =0
 
virtual void addQueueVisualization (const QueueVisualization *queueVisualization)
 
virtual void addQueueVisualizations ()
 
virtual void removeQueueVisualization (const QueueVisualization *queueVisualization)
 
virtual void refreshQueueVisualization (const QueueVisualization *queueVisualization) const =0
 
virtual void removeAllQueueVisualizations ()
 

Additional Inherited Members

- 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 inherited from inet::visualizer::VisualizerBase
cModule * visualizationTargetModule = nullptr
 
cModule * visualizationSubjectModule = nullptr
 
const char * tags = nullptr
 

Member Function Documentation

◆ addQueueVisualization()

void inet::visualizer::QueueVisualizerBase::addQueueVisualization ( const QueueVisualization queueVisualization)
protectedvirtual

◆ addQueueVisualizations()

void inet::visualizer::QueueVisualizerBase::addQueueVisualizations ( )
protectedvirtual
82 {
83  QueueVisitor queueVisitor;
84  visualizationSubjectModule->forEachChild(&queueVisitor);
85  for (auto queue : queueVisitor.queues) {
86  if (queueFilter.matches(queue))
88  }
89 }

Referenced by handleParameterChange(), and initialize().

◆ createQueueVisualization()

virtual QueueVisualization* inet::visualizer::QueueVisualizerBase::createQueueVisualization ( queueing::IPacketQueue queue) const
protectedpure virtual

◆ handleParameterChange()

void inet::visualizer::QueueVisualizerBase::handleParameterChange ( const char *  name)
overrideprotectedvirtual
57 {
58  if (!hasGUI()) return;
59  if (name != nullptr) {
62  }
63 }

◆ initialize()

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

Reimplemented from inet::visualizer::VisualizerBase.

Reimplemented in inet::visualizer::QueueCanvasVisualizer, and inet::visualizer::QueueOsgVisualizer.

37 {
39  if (!hasGUI()) return;
40  if (stage == INITSTAGE_LOCAL) {
41  displayQueues = par("displayQueues");
42  queueFilter.setPattern(par("queueFilter"));
43  color = cFigure::parseColor(par("color"));
44  width = par("width");
45  height = par("height");
46  spacing = par("spacing");
47  placementHint = parsePlacement(par("placementHint"));
48  placementPriority = par("placementPriority");
49  }
50  else if (stage == INITSTAGE_LAST) {
51  if (displayQueues)
53  }
54 }

Referenced by inet::visualizer::QueueOsgVisualizer::initialize(), and inet::visualizer::QueueCanvasVisualizer::initialize().

◆ preDelete()

void inet::visualizer::QueueVisualizerBase::preDelete ( cComponent *  root)
overrideprotectedvirtual
31 {
32  if (displayQueues)
34 }

◆ refreshDisplay()

void inet::visualizer::QueueVisualizerBase::refreshDisplay ( ) const
overrideprotectedvirtual
66 {
67  for (auto queueVisualization : queueVisualizations)
68  refreshQueueVisualization(queueVisualization);
69 }

◆ refreshQueueVisualization()

virtual void inet::visualizer::QueueVisualizerBase::refreshQueueVisualization ( const QueueVisualization queueVisualization) const
protectedpure virtual

◆ removeAllQueueVisualizations()

void inet::visualizer::QueueVisualizerBase::removeAllQueueVisualizations ( )
protectedvirtual
92 {
93  for (auto queueVisualization : std::vector<const QueueVisualization *>(queueVisualizations)) {
94  removeQueueVisualization(queueVisualization);
95  delete queueVisualization;
96  }
97 }

Referenced by handleParameterChange(), and preDelete().

◆ removeQueueVisualization()

void inet::visualizer::QueueVisualizerBase::removeQueueVisualization ( const QueueVisualization queueVisualization)
protectedvirtual

Member Data Documentation

◆ color

cFigure::Color inet::visualizer::QueueVisualizerBase::color
protected

◆ displayQueues

bool inet::visualizer::QueueVisualizerBase::displayQueues = false
protected

Referenced by initialize(), and preDelete().

◆ height

double inet::visualizer::QueueVisualizerBase::height
protected

◆ placementHint

Placement inet::visualizer::QueueVisualizerBase::placementHint
protected

◆ placementPriority

double inet::visualizer::QueueVisualizerBase::placementPriority
protected

◆ queueFilter

QueueFilter inet::visualizer::QueueVisualizerBase::queueFilter
protected

◆ queueVisualizations

std::vector<const QueueVisualization *> inet::visualizer::QueueVisualizerBase::queueVisualizations
protected

◆ spacing

double inet::visualizer::QueueVisualizerBase::spacing
protected

◆ width

double inet::visualizer::QueueVisualizerBase::width
protected

The documentation for this class was generated from the following files:
inet::visualizer::QueueVisualizerBase::placementPriority
double placementPriority
Definition: QueueVisualizerBase.h:51
inet::visualizer::QueueVisualizerBase::refreshQueueVisualization
virtual void refreshQueueVisualization(const QueueVisualization *queueVisualization) const =0
inet::INITSTAGE_LAST
INET_API InitStage INITSTAGE_LAST
Operations that no other initializations can depend on, e.g.
inet::visualizer::QueueVisualizerBase::addQueueVisualizations
virtual void addQueueVisualizations()
Definition: QueueVisualizerBase.cc:81
inet::visualizer::QueueVisualizerBase::placementHint
Placement placementHint
Definition: QueueVisualizerBase.h:50
inet::remove
void remove(std::vector< T > &v, const Tk &a)
Definition: stlutils.h:107
inet::visualizer::QueueVisualizerBase::createQueueVisualization
virtual QueueVisualization * createQueueVisualization(queueing::IPacketQueue *queue) const =0
inet::visualizer::QueueVisualizerBase::removeAllQueueVisualizations
virtual void removeAllQueueVisualizations()
Definition: QueueVisualizerBase.cc:91
inet::visualizer::parsePlacement
Placement parsePlacement(const char *s)
Definition: Placement.cc:14
inet::visualizer::QueueVisualizerBase::spacing
double spacing
Definition: QueueVisualizerBase.h:49
inet::visualizer::QueueVisualizerBase::queueVisualizations
std::vector< const QueueVisualization * > queueVisualizations
Definition: QueueVisualizerBase.h:54
inet::visualizer::QueueFilter::matches
bool matches(const queueing::IPacketQueue *queue) const
Definition: QueueFilter.cc:19
inet::visualizer::QueueVisualizerBase::height
double height
Definition: QueueVisualizerBase.h:48
inet::visualizer::QueueVisualizerBase::displayQueues
bool displayQueues
Definition: QueueVisualizerBase.h:44
inet::visualizer::QueueVisualizerBase::color
cFigure::Color color
Definition: QueueVisualizerBase.h:46
inet::INITSTAGE_LOCAL
INET_API InitStage INITSTAGE_LOCAL
Initialization of local state that don't use or affect other modules includes:
inet::visualizer::QueueVisualizerBase::addQueueVisualization
virtual void addQueueVisualization(const QueueVisualization *queueVisualization)
Definition: QueueVisualizerBase.cc:71
inet::visualizer::QueueFilter::setPattern
void setPattern(const char *pattern)
Definition: QueueFilter.cc:14
inet::visualizer::QueueVisualizerBase::width
double width
Definition: QueueVisualizerBase.h:47
inet::visualizer::QueueVisualizerBase::queueFilter
QueueFilter queueFilter
Definition: QueueVisualizerBase.h:45
inet::visualizer::VisualizerBase::visualizationSubjectModule
cModule * visualizationSubjectModule
Definition: VisualizerBase.h:26
inet::visualizer::VisualizerBase::initialize
virtual void initialize(int stage) override
Definition: VisualizerBase.cc:23
inet::visualizer::QueueVisualizerBase::removeQueueVisualization
virtual void removeQueueVisualization(const QueueVisualization *queueVisualization)
Definition: QueueVisualizerBase.cc:76