ProgressMeterFigure Class Reference

#include <ProgressMeterFigure.h>

Inheritance diagram for ProgressMeterFigure:

Public Member Functions
	ProgressMeterFigure (const char *name=nullptr)
virtual	~ProgressMeterFigure ()
virtual void	setValue (int series, simtime_t timestamp, double value) override
const Color &	getBackgroundColor () const
void	setBackgroundColor (const Color &color)
const Color &	getStripColor () const
void	setStripColor (const Color &color)
double	getCornerRadius () const
void	setCornerRadius (double radius)
double	getBorderWidth () const
void	setBorderWidth (double width)
const char *	getText () const
void	setText (const char *text)
const Font &	getTextFont () const
void	setTextFont (const Font &font)
const Color &	getTextColor () const
void	setTextColor (const Color &color)
const char *	getLabel () const
void	setLabel (const char *text)
const int	getLabelOffset () const
void	setLabelOffset (int)
const Font &	getLabelFont () const
void	setLabelFont (const Font &font)
const Color &	getLabelColor () const
void	setLabelColor (const Color &color)
const Rectangle &	getBounds () const
void	setBounds (const Rectangle &bounds)
double	getMinValue () const
void	setMinValue (double value)
double	getMaxValue () const
void	setMaxValue (double value)
Public Member Functions inherited from inet::IIndicatorFigure
virtual	~IIndicatorFigure ()
virtual int	getNumSeries () const
virtual void	refreshDisplay ()

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

Private Attributes
cRectangleFigure *	borderFigure
cRectangleFigure *	stripFigure
cRectangleFigure *	backgroundFigure
cTextFigure *	valueFigure
cTextFigure *	labelFigure
double	min = 0
double	max = 100
double	value = NaN
int	labelOffset = 10
std::string	textFormat = "%g"

Constructor & Destructor Documentation

ProgressMeterFigure::ProgressMeterFigure

(

const char *

name = nullptr

)

                                                         : cGroupFigure(name)
{
    addChildren();
}

virtual ProgressMeterFigure::~ProgressMeterFigure ( )

inlinevirtual

{};

Member Function Documentation

void ProgressMeterFigure::addChildren ( )

protected

Referenced by ProgressMeterFigure().

{
    borderFigure = new cRectangleFigure("border");
    stripFigure = new cRectangleFigure("strip");
    backgroundFigure = new cRectangleFigure("background");
    valueFigure = new cTextFigure("value");
    labelFigure = new cTextFigure("label");

    backgroundFigure->setOutlined(false);
    backgroundFigure->setFilled(true);
    backgroundFigure->setFillColor(Color("#b8afa6"));

    stripFigure->setOutlined(false);
    stripFigure->setFilled(true);
    stripFigure->setFillColor(Color("lightblue"));

    borderFigure->setOutlined(true);
    borderFigure->setFilled(false);
    borderFigure->setLineWidth(2);

    valueFigure->setAnchor(ANCHOR_CENTER);
    labelFigure->setAnchor(ANCHOR_N);

    addFigure(backgroundFigure);
    addFigure(stripFigure);
    addFigure(borderFigure);
    addFigure(valueFigure);
    addFigure(labelFigure);
}

const char ** ProgressMeterFigure::getAllowedPropertyKeys ( ) const

overrideprotectedvirtual

{
    static const char *keys[32];
    if (!keys[0]) {
        const char *localKeys[] = {
            PKEY_BACKGROUND_COLOR, PKEY_STRIP_COLOR, PKEY_CORNER_RADIUS, PKEY_BORDER_WIDTH,
            PKEY_MIN_VALUE, PKEY_MAX_VALUE, PKEY_TEXT, PKEY_TEXT_FONT, PKEY_TEXT_COLOR, PKEY_LABEL,
            PKEY_LABELOFFSET, PKEY_LABEL_FONT, PKEY_LABEL_COLOR, PKEY_INITIAL_VALUE, PKEY_POS,
            PKEY_SIZE, PKEY_ANCHOR,
            PKEY_BOUNDS, nullptr
        };
        concatArrays(keys, cGroupFigure::getAllowedPropertyKeys(), localKeys);
    }
    return keys;
}

const cFigure::Color & ProgressMeterFigure::getBackgroundColor

(

)

const

{
    return backgroundFigure->getFillColor();
}

double ProgressMeterFigure::getBorderWidth

(

)

const

{
    return borderFigure->getLineWidth();
}

const cFigure::Rectangle & ProgressMeterFigure::getBounds

(

)

const

Referenced by parse(), and setLabelOffset().

{
    return borderFigure->getBounds();
}

double ProgressMeterFigure::getCornerRadius

(

)

const

{
    return backgroundFigure->getCornerRx();
}

const char * ProgressMeterFigure::getLabel

(

)

const

{
    return labelFigure->getText();
}

const cFigure::Color & ProgressMeterFigure::getLabelColor

(

)

const

{
    return labelFigure->getColor();
}

const cFigure::Font & ProgressMeterFigure::getLabelFont

(

)

const

{
    return labelFigure->getFont();
}

const int ProgressMeterFigure::getLabelOffset

(

)

const

{
    return labelOffset;
}

double ProgressMeterFigure::getMaxValue

(

)

const

{
    return max;
}

double ProgressMeterFigure::getMinValue

(

)

const

{
    return min;
}

const cFigure::Color & ProgressMeterFigure::getStripColor

(

)

const

{
    return stripFigure->getFillColor();
}

const char * ProgressMeterFigure::getText

(

)

const

Referenced by refresh().

{
    return textFormat.c_str();
}

const cFigure::Color & ProgressMeterFigure::getTextColor

(

)

const

{
    return valueFigure->getColor();
}

const cFigure::Font & ProgressMeterFigure::getTextFont

(

)

const

{
    return valueFigure->getFont();
}

void ProgressMeterFigure::layout ( )

protected

Referenced by setBounds().

{
    Rectangle bounds = borderFigure->getBounds();
    stripFigure->setBounds(bounds);
    backgroundFigure->setBounds(bounds);

    valueFigure->setPosition(Point(bounds.x + bounds.width / 2, bounds.y + bounds.height / 2));
    labelFigure->setPosition(Point(bounds.x + bounds.width / 2, bounds.y + bounds.height + labelOffset));
}

void ProgressMeterFigure::parse ( cProperty *  property )

overrideprotectedvirtual

{
    cGroupFigure::parse(property);


    setBounds(parseBounds(property, getBounds()));

    const char *s;
    if ((s = property->getValue(PKEY_BACKGROUND_COLOR)) != nullptr)
        setBackgroundColor(parseColor(s));
    if ((s = property->getValue(PKEY_STRIP_COLOR)) != nullptr)
        setStripColor(parseColor(s));
    if ((s = property->getValue(PKEY_CORNER_RADIUS)) != nullptr)
        setCornerRadius(utils::atod(s));
    if ((s = property->getValue(PKEY_BORDER_WIDTH)) != nullptr)
        setBorderWidth(utils::atod(s));
    if ((s = property->getValue(PKEY_MIN_VALUE)) != nullptr)
        setMinValue(utils::atod(s));
    if ((s = property->getValue(PKEY_MAX_VALUE)) != nullptr)
        setMaxValue(utils::atod(s));
    if ((s = property->getValue(PKEY_TEXT)) != nullptr)
        setText(s);
    if ((s = property->getValue(PKEY_TEXT_FONT)) != nullptr)
        setTextFont(parseFont(s));
    if ((s = property->getValue(PKEY_TEXT_COLOR)) != nullptr)
        setTextColor(parseColor(s));
    if ((s = property->getValue(PKEY_LABEL)) != nullptr)
        setLabel(s);
    if ((s = property->getValue(PKEY_LABELOFFSET)) != nullptr)
        setLabelOffset(atoi(s));
    if ((s = property->getValue(PKEY_LABEL_FONT)) != nullptr)
        setLabelFont(parseFont(s));
    if ((s = property->getValue(PKEY_LABEL_COLOR)) != nullptr)
        setLabelColor(parseColor(s));
    if ((s = property->getValue(PKEY_INITIAL_VALUE)) != nullptr)
        setValue(0, simTime(), utils::atod(s));
}

void ProgressMeterFigure::refresh ( )

protected

Referenced by setBounds(), setMaxValue(), setMinValue(), setText(), and setValue().

{
    // adjust strip
    double stripValue = std::isnan(value) ? min : std::max(min, std::min(max, value));
    cFigure::Rectangle bounds = borderFigure->getBounds();
    bounds.width = bounds.width * (stripValue - min) / (max - min);
    stripFigure->setBounds(bounds);

    // update displayed number
    if (std::isnan(value))
        valueFigure->setText("");
    else {
        char buf[32];
        double percent = (value - min) / (max - min) * 100;
        sprintf(buf, getText(), value, percent);
        if (value < min || value > max)
            strcat(buf, "*");
        valueFigure->setText(buf);
    }
}

void ProgressMeterFigure::setBackgroundColor

(

const Color &

color

)

Referenced by parse().

{
    backgroundFigure->setFillColor(color);
}

void ProgressMeterFigure::setBorderWidth

(

double

width

)

Referenced by parse().

{
    borderFigure->setLineWidth(width);
}

void ProgressMeterFigure::setBounds

(

const Rectangle &

bounds

)

Referenced by parse().

{
    borderFigure->setBounds(bounds);
    layout();
    refresh();
}

void ProgressMeterFigure::setCornerRadius

(

double

radius

)

Referenced by parse().

{
    backgroundFigure->setCornerRadius(radius);
    stripFigure->setCornerRadius(radius);
    borderFigure->setCornerRadius(radius);
}

void ProgressMeterFigure::setLabel

(

const char *

text

)

Referenced by parse().

{
    labelFigure->setText(text);
}

void ProgressMeterFigure::setLabelColor

(

const Color &

color

)

Referenced by parse().

{
    labelFigure->setColor(color);
}

void ProgressMeterFigure::setLabelFont

(

const Font &

font

)

Referenced by parse().

{
    labelFigure->setFont(font);
}

void ProgressMeterFigure::setLabelOffset

(

int

offset

)

Referenced by parse().

{
    if(labelOffset != offset)   {
    labelOffset = offset;
    labelFigure->setPosition(Point(getBounds().x + getBounds().width / 2, getBounds().y + getBounds().height + labelOffset));
    };
}

void ProgressMeterFigure::setMaxValue

(

double

value

)

Referenced by parse().

{
    max = value;
    refresh();
}

void ProgressMeterFigure::setMinValue

(

double

value

)

Referenced by parse().

{
    min = value;
    refresh();
}

void ProgressMeterFigure::setStripColor

(

const Color &

color

)

Referenced by parse().

{
    stripFigure->setFillColor(color);
}

void ProgressMeterFigure::setText

(

const char *

text

)

Referenced by parse().

{
    textFormat = text;
    refresh();
}

void ProgressMeterFigure::setTextColor

(

const Color &

color

)

Referenced by parse().

{
    valueFigure->setColor(color);
}

void ProgressMeterFigure::setTextFont

(

const Font &

font

)

Referenced by parse().

{
    valueFigure->setFont(font);
}

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

overridevirtual

Implements inet::IIndicatorFigure.

Referenced by parse().

{
    ASSERT(series == 0);
    // Note: we currently ignore timestamp
    if (value != newValue) {
        value = newValue;
        refresh();
    }
}

Member Data Documentation

cRectangleFigure* ProgressMeterFigure::backgroundFigure

private

Referenced by addChildren(), getBackgroundColor(), getCornerRadius(), layout(), setBackgroundColor(), and setCornerRadius().

cRectangleFigure* ProgressMeterFigure::borderFigure

private

Referenced by addChildren(), getBorderWidth(), getBounds(), layout(), refresh(), setBorderWidth(), setBounds(), and setCornerRadius().

cTextFigure* ProgressMeterFigure::labelFigure

private

Referenced by addChildren(), getLabel(), getLabelColor(), getLabelFont(), layout(), setLabel(), setLabelColor(), setLabelFont(), and setLabelOffset().

int ProgressMeterFigure::labelOffset = 10

private

Referenced by getLabelOffset(), layout(), and setLabelOffset().

double ProgressMeterFigure::max = 100

private

Referenced by getMaxValue(), refresh(), and setMaxValue().

double ProgressMeterFigure::min = 0

private

Referenced by getMinValue(), refresh(), and setMinValue().

cRectangleFigure* ProgressMeterFigure::stripFigure

private

Referenced by addChildren(), getStripColor(), layout(), refresh(), setCornerRadius(), and setStripColor().

std::string ProgressMeterFigure::textFormat = "%g"

private

Referenced by getText(), and setText().

double ProgressMeterFigure::value = NaN

private

Referenced by refresh(), setMaxValue(), setMinValue(), and setValue().

cTextFigure* ProgressMeterFigure::valueFigure

private

Referenced by addChildren(), getTextColor(), getTextFont(), layout(), refresh(), setTextColor(), and setTextFont().

---

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

• ProgressMeterFigure.h
• ProgressMeterFigure.cc