inet::IndicatorTextFigure Class Reference

#include <IndicatorTextFigure.h>

Inheritance diagram for inet::IndicatorTextFigure:

Public Member Functions
	IndicatorTextFigure (const char *name=nullptr)
virtual const Point	getSize () const override
virtual void	setValue (int series, simtime_t timestamp, double value) override
virtual const char *	getTextFormat () const
virtual void	setTextFormat (const char *textFormat)
Public Member Functions inherited from inet::IIndicatorFigure
virtual	~IIndicatorFigure ()
virtual int	getNumSeries () const
virtual void	refreshDisplay ()

Protected Member Functions
virtual const char **	getAllowedPropertyKeys () const override
virtual void	parse (cProperty *property) override
virtual void	refresh ()

Protected Attributes
std::string	textFormat = "%g"
double	value = NaN

Constructor & Destructor Documentation

IndicatorTextFigure()

inet::IndicatorTextFigure::IndicatorTextFigure ( const char *  name = nullptr )

inlineexplicit

: cTextFigure(name) {}

Member Function Documentation

getAllowedPropertyKeys()

const char ** inet::IndicatorTextFigure::getAllowedPropertyKeys ( ) const

overrideprotectedvirtual

{
    static const char *keys[32];
    if (!keys[0]) {
        const char *localKeys[] = {
            PKEY_TEXT_FORMAT, PKEY_INITIAL_VALUE, nullptr
        };
        concatArrays(keys, cTextFigure::getAllowedPropertyKeys(), localKeys);
    }
    return keys;
}

getSize()

virtual const Point inet::IndicatorTextFigure::getSize ( ) const

inlineoverridevirtual

Implements inet::IIndicatorFigure.

{ return Point(0, 0); } // TODO

getTextFormat()

virtual const char* inet::IndicatorTextFigure::getTextFormat ( ) const

inlinevirtual

{ return textFormat.c_str(); }

parse()

void inet::IndicatorTextFigure::parse ( cProperty *  property )

overrideprotectedvirtual

{
    cTextFigure::parse(property);
 
    const char *s;
    if ((s = property->getValue(PKEY_TEXT_FORMAT)) != nullptr)
        setTextFormat(s);
    if ((s = property->getValue(PKEY_INITIAL_VALUE)) != nullptr)
        setValue(0, simTime(), utils::atod(s));
}

refresh()

void inet::IndicatorTextFigure::refresh ( )

protectedvirtual

{
    if (std::isnan(value)) {
        setText("");
    }
    else {
        char buf[64];
        sprintf(buf, textFormat.c_str(), value);
        setText(buf);
    }
}

Referenced by setValue().

setTextFormat()

virtual void inet::IndicatorTextFigure::setTextFormat ( const char *  textFormat )

inlinevirtual

{ this->textFormat = textFormat; refresh(); }

Referenced by parse().

setValue()

void inet::IndicatorTextFigure::setValue ( int  series, simtime_t  timestamp, double  value  )

overridevirtual

Implements inet::IIndicatorFigure.

{
    // Note: we currently ignore timestamp
    ASSERT(series == 0);
    this->value = value;
    refresh();
}

Referenced by parse().

Member Data Documentation

textFormat

std::string inet::IndicatorTextFigure::textFormat = "%g"

protected

Referenced by refresh().

value

double inet::IndicatorTextFigure::value = NaN

protected

Referenced by refresh(), and setValue().

---

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

• IndicatorTextFigure.h
• IndicatorTextFigure.cc