inet::DelegateSignalConfigurator Class Reference

This is a 3-in-1 class: More...

#include <DelegateSignalConfigurator.h>

Inheritance diagram for inet::DelegateSignalConfigurator:

Classes
class	DelegatingListener
class	FigureRecorder

Protected Member Functions
virtual void	initialize () override
virtual void	configure (cModule *module)
virtual void	configureDisplaySignal (cModule *module, cProperty *property)
virtual void	configureDelegateSignal (cModule *module, cProperty *property)
virtual void	parseSignalPath (const char *signalPath, cModule *context, cModule *&module, simsignal_t &signal)
virtual void	refreshDisplay () const override

Protected Attributes
std::vector< IIndicatorFigure * >	indicatorFigures

Detailed Description

This is a 3-in-1 class:

1. implements the properties
2. implements the properties (not used)
3. invokes refreshDisplay() methods on IMeterFigures

Probably none of the above will be needed in OMNeT++ 5.1, so this class can go away then.

Member Function Documentation

void inet::DelegateSignalConfigurator::configure ( cModule *  module )

protectedvirtual

Referenced by initialize().

{
    cProperties *properties = module->getProperties();
    for (int i = 0; i < properties->getNumProperties(); i++)
        if (!strcmp(properties->get(i)->getName(), "displaysignal"))
            configureDisplaySignal(module, properties->get(i));
        else if (!strcmp(properties->get(i)->getName(), "delegatesignal"))
            configureDelegateSignal(module, properties->get(i));


    for (cModule::SubmoduleIterator it(module); !it.end(); ++it)
        configure(*it);
}

void inet::DelegateSignalConfigurator::configureDelegateSignal ( cModule *  module, cProperty *  property  )

protectedvirtual

Referenced by configure().

{
    try {
        EV_DETAIL << "Processing @" << property->getFullName() << " on " << module->getFullPath() << endl;

        // parse signals
        cModule *sourceModule, *targetModule;
        simsignal_t sourceSignal, targetSignal;
        parseSignalPath(property->getValue("source"), module, sourceModule, sourceSignal);
        parseSignalPath(property->getValue("target"), module, targetModule, targetSignal);

        // add delegatingListener
        cIListener *listener = new DelegatingListener(targetModule, targetSignal);
        sourceModule->subscribe(sourceSignal, listener);
    }
    catch (std::exception& e) {
        throw cRuntimeError("While processing @%s on %s: %s", property->getFullName(), module->getFullPath().c_str(), e.what());
    }
}

void inet::DelegateSignalConfigurator::configureDisplaySignal ( cModule *  module, cProperty *  property  )

protectedvirtual

Referenced by configure().

{
    try {
        EV_DETAIL << "Processing @" << property->getFullName() << " on " << module->getFullPath() << endl;

        // find source signal
        cModule *sourceModule;
        simsignal_t signal;
        parseSignalPath(property->getValue("source"), module, sourceModule, signal);

        // instantiate filter
        cResultFilter *filter = nullptr;
        if (const char *filterName = property->getValue("filter")) {
            filter = cResultFilterType::get(filterName)->create();
        }

        // find figure
        const char *figurePath = property->getValue("figure");
        if (!figurePath)
            figurePath = property->getIndex();
        cFigure *figure = module->getCanvas()->getFigureByPath(figurePath);
        if (!figure)
            throw cRuntimeError("Figure '%s' not found", figurePath);
        IIndicatorFigure *meterFigure = check_and_cast<IIndicatorFigure *>(figure);
        indicatorFigures.push_back(meterFigure);

        // instantiate figure recorder
        const char *seriesAttr = property->getValue("series");
        int series = seriesAttr ? utils::atoul(seriesAttr) : 0;
        if (series > meterFigure->getNumSeries())
            throw cRuntimeError("series=%d is out of bounds, figure supports %d series", series, meterFigure->getNumSeries());
        FigureRecorder *figureRecorder = new FigureRecorder(meterFigure, series);
        figureRecorder->init(module, nullptr, nullptr, property);

        // hook it up on the signal
        cResultListener *listener = figureRecorder;
        if (filter) {
            filter->addDelegate(figureRecorder);
            listener = filter;
        }
        sourceModule->subscribe(signal, listener);
    }
    catch (std::exception& e) {
        throw cRuntimeError("While processing @%s on %s: %s", property->getFullName(), module->getFullPath().c_str(), e.what());
    }
}

void inet::DelegateSignalConfigurator::initialize ( )

overrideprotectedvirtual

{
    configure(getSystemModule());
}

void inet::DelegateSignalConfigurator::parseSignalPath ( const char *  signalPath, cModule *  context, cModule *&  module, simsignal_t &  signal  )

protectedvirtual

Referenced by configureDelegateSignal(), and configureDisplaySignal().

{
    const char *signalName;
    if (strchr(signalPath, '.') == nullptr) {
        module = context;
        signalName = signalPath;
    }
    else {
        const char *lastDot = strrchr(signalPath, '.');
        std::string modulePath = std::string(".") + std::string(signalPath, lastDot - signalPath);
        module = context->getModuleByPath(modulePath.c_str());
        if (!module)
            throw cRuntimeError("Module '%s' not found", modulePath.c_str());
        signalName = lastDot + 1;
    }
    signal = registerSignal(signalName);
}

void inet::DelegateSignalConfigurator::refreshDisplay ( ) const

overrideprotectedvirtual

{
    for (IIndicatorFigure *figure : indicatorFigures)
        figure->refreshDisplay();
}

Member Data Documentation

std::vector<IIndicatorFigure *> inet::DelegateSignalConfigurator::indicatorFigures

protected

Referenced by configureDisplaySignal(), and refreshDisplay().

---

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

• DelegateSignalConfigurator.h
• DelegateSignalConfigurator.cc