inet::visualizer::GateScheduleCanvasVisualizer Class Reference

#include <GateScheduleCanvasVisualizer.h>

Inheritance diagram for inet::visualizer::GateScheduleCanvasVisualizer:

Classes
class	GateCanvasVisualization

Protected Member Functions
virtual void	initialize (int stage) override
virtual GateVisualization *	createGateVisualization (queueing::IPacketGate *gate) const override
virtual void	addGateVisualization (const GateVisualization *gateVisualization) override
virtual void	removeGateVisualization (const GateVisualization *gateVisualization) override
virtual void	refreshGateVisualization (const GateVisualization *gateVisualization) const override
Protected Member Functions inherited from inet::visualizer::GateScheduleVisualizerBase
virtual void	handleParameterChange (const char *name) override
virtual void	refreshDisplay () const override
virtual void	preDelete (cComponent *root) override
virtual void	addGateVisualizations ()
virtual void	removeAllGateVisualizations ()
virtual const char *	getGateScheduleVisualizationText (cModule *module) const
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::GateScheduleVisualizerBase
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
Protected Attributes inherited from inet::visualizer::VisualizerBase
cModule *	visualizationTargetModule = nullptr
cModule *	visualizationSubjectModule = nullptr
const char *	tags = nullptr

Member Function Documentation

addGateVisualization()

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

overrideprotectedvirtual

Reimplemented from inet::visualizer::GateScheduleVisualizerBase.

{
    GateScheduleVisualizerBase::addGateVisualization(gateVisualization);
    auto gateCanvasVisualization = static_cast<const GateCanvasVisualization *>(gateVisualization);
    auto figure = gateCanvasVisualization->figure;
    gateCanvasVisualization->networkNodeVisualization->addAnnotation(figure, figure->getBounds().getSize(), placementHint, placementPriority);
}

createGateVisualization()

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

overrideprotectedvirtual

Implements inet::visualizer::GateScheduleVisualizerBase.

{
    auto module = check_and_cast<cModule *>(gate);
    auto figure = new GateFigure("gate");
    figure->setTags((std::string("gate ") + tags).c_str());
    figure->setTooltip("This figure represents a gate");
    figure->setAssociatedObject(module);
    figure->setSpacing(spacing);
    figure->setBounds(cFigure::Rectangle(0, 0, width, height));
    figure->setPosition(currentTimePosition);
    figure->setLabel(getGateScheduleVisualizationText(module));
    auto networkNode = getContainingNode(module);
    auto networkNodeVisualization = networkNodeVisualizer->getNetworkNodeVisualization(networkNode);
    return new GateCanvasVisualization(networkNodeVisualization, figure, gate);
}

initialize()

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

overrideprotectedvirtual

Reimplemented from inet::visualizer::GateScheduleVisualizerBase.

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

refreshGateVisualization()

void inet::visualizer::GateScheduleCanvasVisualizer::refreshGateVisualization ( const GateVisualization *  gateVisualization ) const

overrideprotectedvirtual

Implements inet::visualizer::GateScheduleVisualizerBase.

{
    auto gateCanvasVisualization = static_cast<const GateCanvasVisualization *>(gateVisualization);
    auto gate = check_and_cast<queueing::PeriodicGate *>(gateVisualization->gate);
    auto figure = gateCanvasVisualization->figure;
    auto durations = gate->getDurations();
    bool open = gate->getInitiallyOpen();
    clocktime_t scheduleDuration = 0;
    for (int i = 0; i < durations->size(); i++)
        scheduleDuration += durations->get(i).doubleValueInUnit("s");
    if (scheduleDuration == 0)
        figure->addSchedule(0, width, open);
    else {
        auto displayDuration = this->displayDuration != 0 ? this->displayDuration : scheduleDuration;
        auto currentTime = gate->getClockTime();
        clocktime_t schedulePosition = std::fmod((currentTime + gate->getInitialOffset()).dbl(), scheduleDuration.dbl());
        auto scheduleDisplayStart = schedulePosition - (currentTimePosition / width) * displayDuration;
        auto scheduleDisplayEnd = scheduleDisplayStart + displayDuration;
        auto indexStart = (int)std::floor(scheduleDisplayStart.dbl() / scheduleDuration.dbl()) * durations->size();
        auto indexEnd = (int)std::ceil(scheduleDisplayEnd.dbl() / scheduleDuration.dbl()) * durations->size();
        clocktime_t displayTime = currentTime - schedulePosition + indexStart / durations->size() * scheduleDuration;
        figure->clearSchedule();
        for (int i = indexStart; i <= indexEnd; i++) {
            auto duration = durations->get((i + durations->size()) % durations->size()).doubleValueInUnit("s");
            clocktime_t startTime = displayTime - currentTime;
            clocktime_t endTime = displayTime + duration - currentTime;
            double factor = width / displayDuration.dbl();
            double start = std::max(0.0, std::min(width, currentTimePosition + startTime.dbl() * factor));
            double end = std::max(0.0, std::min(width, currentTimePosition + endTime.dbl() * factor));
            if (start != end)
                figure->addSchedule(start, end, open);
            displayTime += duration;
            open = !open;
        }
    }
}

removeGateVisualization()

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

overrideprotectedvirtual

Reimplemented from inet::visualizer::GateScheduleVisualizerBase.

{
    GateScheduleVisualizerBase::removeGateVisualization(gateVisualization);
    auto gateCanvasVisualization = static_cast<const GateCanvasVisualization *>(gateVisualization);
    auto figure = gateCanvasVisualization->figure;
    if (networkNodeVisualizer != nullptr)
        gateCanvasVisualization->networkNodeVisualization->removeAnnotation(figure);
}

Member Data Documentation

networkNodeVisualizer

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

protected

Referenced by createGateVisualization(), initialize(), and removeGateVisualization().

zIndex

double inet::visualizer::GateScheduleCanvasVisualizer::zIndex = NaN

protected

Referenced by initialize().

---

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

• GateScheduleCanvasVisualizer.h
• GateScheduleCanvasVisualizer.cc