inet::visualizer::GateScheduleVisualizerBase Class Reference

#include <GateScheduleVisualizerBase.h>

Inheritance diagram for inet::visualizer::GateScheduleVisualizerBase:

Classes
class	DirectiveResolver
class	GateVisitor
class	GateVisualization

Parameters
bool	displayGateSchedules = false
StringFormat	stringFormat
GateFilter	gateFilter
double	width
double	height
double	spacing
Placement	placementHint
double	placementPriority
clocktime_t	displayDuration
double	currentTimePosition
simtime_t	lastRefreshTime = -1
std::vector< const GateVisualization * >	gateVisualizations
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 GateVisualization *	createGateVisualization (queueing::IPacketGate *gate) const =0
virtual void	addGateVisualization (const GateVisualization *gateVisualization)
virtual void	addGateVisualizations ()
virtual void	removeGateVisualization (const GateVisualization *gateVisualization)
virtual void	refreshGateVisualization (const GateVisualization *gateVisualization) const =0
virtual void	removeAllGateVisualizations ()
virtual const char *	getGateScheduleVisualizationText (cModule *module) const

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

addGateVisualization()

void inet::visualizer::GateScheduleVisualizerBase::addGateVisualization ( const GateVisualization *  gateVisualization )

protectedvirtual

Reimplemented in inet::visualizer::GateScheduleCanvasVisualizer.

{
    gateVisualizations.push_back(gateVisualization);
}

Referenced by inet::visualizer::GateScheduleCanvasVisualizer::addGateVisualization(), and addGateVisualizations().

addGateVisualizations()

void inet::visualizer::GateScheduleVisualizerBase::addGateVisualizations ( )

protectedvirtual

{
    GateVisitor gateVisitor;
    visualizationSubjectModule->forEachChild(&gateVisitor);
    for (auto gate : gateVisitor.gates) {
        if (gateFilter.matches(gate))
            addGateVisualization(createGateVisualization(gate));
    }
}

Referenced by handleParameterChange(), and initialize().

createGateVisualization()

virtual GateVisualization* inet::visualizer::GateScheduleVisualizerBase::createGateVisualization ( queueing::IPacketGate *  gate ) const

protectedpure virtual

Implemented in inet::visualizer::GateScheduleCanvasVisualizer, and inet::visualizer::GateScheduleOsgVisualizer.

Referenced by addGateVisualizations().

getGateScheduleVisualizationText()

const char * inet::visualizer::GateScheduleVisualizerBase::getGateScheduleVisualizationText ( cModule *  module ) const

protectedvirtual

{
    DirectiveResolver directiveResolver(module);
    return stringFormat.formatString(&directiveResolver);
}

Referenced by inet::visualizer::GateScheduleCanvasVisualizer::createGateVisualization().

handleParameterChange()

void inet::visualizer::GateScheduleVisualizerBase::handleParameterChange ( const char *  name )

overrideprotectedvirtual

{
    if (!hasGUI()) return;
    if (name != nullptr) {
        if (!strcmp(name, "displayDuration"))
            displayDuration = par("displayDuration");
        removeAllGateVisualizations();
        addGateVisualizations();
    }
}

initialize()

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

overrideprotectedvirtual

Reimplemented from inet::visualizer::VisualizerBase.

Reimplemented in inet::visualizer::GateScheduleCanvasVisualizer, and inet::visualizer::GateScheduleOsgVisualizer.

{
    VisualizerBase::initialize(stage);
    if (!hasGUI()) return;
    if (stage == INITSTAGE_LOCAL) {
        displayGateSchedules = par("displayGateSchedules");
        gateFilter.setPattern(par("gateFilter"));
        width = par("width");
        height = par("height");
        spacing = par("spacing");
        placementHint = parsePlacement(par("placementHint"));
        placementPriority = par("placementPriority");
        displayDuration = par("displayDuration");
        currentTimePosition = par("currentTimePosition");
    }
    else if (stage == INITSTAGE_LAST) {
        if (displayGateSchedules)
            addGateVisualizations();
    }
}

Referenced by inet::visualizer::GateScheduleOsgVisualizer::initialize(), and inet::visualizer::GateScheduleCanvasVisualizer::initialize().

preDelete()

void inet::visualizer::GateScheduleVisualizerBase::preDelete ( cComponent *  root )

overrideprotectedvirtual

{
    if (displayGateSchedules)
        removeAllGateVisualizations();
}

refreshDisplay()

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

overrideprotectedvirtual

{
    if (simTime() - lastRefreshTime > CLOCKTIME_AS_SIMTIME(displayDuration) / width) {
        for (auto gateVisualization : gateVisualizations)
            refreshGateVisualization(gateVisualization);
        lastRefreshTime = simTime();
    }
}

refreshGateVisualization()

virtual void inet::visualizer::GateScheduleVisualizerBase::refreshGateVisualization ( const GateVisualization *  gateVisualization ) const

protectedpure virtual

Implemented in inet::visualizer::GateScheduleCanvasVisualizer, and inet::visualizer::GateScheduleOsgVisualizer.

Referenced by refreshDisplay().

removeAllGateVisualizations()

void inet::visualizer::GateScheduleVisualizerBase::removeAllGateVisualizations ( )

protectedvirtual

{
    for (auto gateVisualization : std::vector<const GateVisualization *>(gateVisualizations)) {
        removeGateVisualization(gateVisualization);
        delete gateVisualization;
    }
}

Referenced by handleParameterChange(), and preDelete().

removeGateVisualization()

void inet::visualizer::GateScheduleVisualizerBase::removeGateVisualization ( const GateVisualization *  gateVisualization )

protectedvirtual

Reimplemented in inet::visualizer::GateScheduleCanvasVisualizer.

{
    gateVisualizations.erase(std::remove(gateVisualizations.begin(), gateVisualizations.end(), gateVisualization), gateVisualizations.end());
}

Referenced by removeAllGateVisualizations(), and inet::visualizer::GateScheduleCanvasVisualizer::removeGateVisualization().

Member Data Documentation

currentTimePosition

double inet::visualizer::GateScheduleVisualizerBase::currentTimePosition

protected

Referenced by inet::visualizer::GateScheduleCanvasVisualizer::createGateVisualization(), initialize(), and inet::visualizer::GateScheduleCanvasVisualizer::refreshGateVisualization().

displayDuration

clocktime_t inet::visualizer::GateScheduleVisualizerBase::displayDuration

protected

Referenced by handleParameterChange(), initialize(), refreshDisplay(), and inet::visualizer::GateScheduleCanvasVisualizer::refreshGateVisualization().

displayGateSchedules

bool inet::visualizer::GateScheduleVisualizerBase::displayGateSchedules = false

protected

Referenced by initialize(), and preDelete().

gateFilter

GateFilter inet::visualizer::GateScheduleVisualizerBase::gateFilter

protected

Referenced by addGateVisualizations(), and initialize().

gateVisualizations

std::vector<const GateVisualization *> inet::visualizer::GateScheduleVisualizerBase::gateVisualizations

protected

Referenced by addGateVisualization(), inet::visualizer::GateScheduleOsgVisualizer::initialize(), refreshDisplay(), removeAllGateVisualizations(), and removeGateVisualization().

height

double inet::visualizer::GateScheduleVisualizerBase::height

protected

Referenced by inet::visualizer::GateScheduleCanvasVisualizer::createGateVisualization(), and initialize().

lastRefreshTime

simtime_t inet::visualizer::GateScheduleVisualizerBase::lastRefreshTime = -1

mutableprotected

Referenced by refreshDisplay().

placementHint

Placement inet::visualizer::GateScheduleVisualizerBase::placementHint

protected

Referenced by inet::visualizer::GateScheduleCanvasVisualizer::addGateVisualization(), and initialize().

placementPriority

double inet::visualizer::GateScheduleVisualizerBase::placementPriority

protected

Referenced by inet::visualizer::GateScheduleCanvasVisualizer::addGateVisualization(), and initialize().

spacing

double inet::visualizer::GateScheduleVisualizerBase::spacing

protected

Referenced by inet::visualizer::GateScheduleCanvasVisualizer::createGateVisualization(), and initialize().

stringFormat

StringFormat inet::visualizer::GateScheduleVisualizerBase::stringFormat

protected

Referenced by getGateScheduleVisualizationText(), and inet::visualizer::GateScheduleCanvasVisualizer::initialize().

width

double inet::visualizer::GateScheduleVisualizerBase::width

protected

Referenced by inet::visualizer::GateScheduleCanvasVisualizer::createGateVisualization(), initialize(), refreshDisplay(), and inet::visualizer::GateScheduleCanvasVisualizer::refreshGateVisualization().

---

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

• GateScheduleVisualizerBase.h
• GateScheduleVisualizerBase.cc