DiagramList Class Reference

Detailed Description

A List of data points and all the necessary meta-information to draw a graph.

Definition at line 28 of file DiagramList.h.

#include <DiagramList.h>

Public Member Functions
	DiagramList ()
	Constructor containing an empty list.
	~DiagramList ()
QColor	getColor () const
	Returns the colour of the graph.
float	height () const
	Returns the height of the bounding box of all data points within the list.
float	minXValue () const
	Returns the minimum x-value.
float	maxXValue () const
	Returns the maximum x-value.
float	minYValue () const
	Returns the minimum y-value.
float	maxYValue () const
	Returns the maximum y-value.
const QDateTime	getStartDate () const
	Returns the start date of this list.
QString	getName () const
	Returns the name of the diagram.
bool	getPath (QPainterPath &path, float scaleX, float scaleY)
bool	getPoint (QPointF &p, std::size_t i)
QString	getXLabel () const
	Returns the label associated with the x-axis.
QString	getYLabel () const
	Returns the label associated with the y-axis.
QString	getXUnit () const
	Returns the unit associated with the x-axis.
QString	getYUnit () const
	Returns the unit associated with the y-axis.
void	setColor (QColor c)
	Sets the colour of the graph.
void	setName (QString name)
	Sets the name of the graph to be displayed in the caption.
void	addNextPoint (float x, float y)
	Adds a point at (x,y) to the list.
void	truncateToRange (QDateTime const &start, QDateTime const &end)
	cut list entries not within the given range
void	setStartDate (QDateTime date)
	Sets the start date (i.e. the min-value of the x-axis).
void	setXLabel (QString label)
	Specifies the meaning of the x Axis.
void	setYLabel (QString label)
	Specifies the meaning of the y Axis.
void	setList (std::vector< std::pair< float, float > > const &coords)
void	setList (std::vector< std::pair< QDateTime, float > > const &coords)
void	setXUnit (QString unit)
	Specifies the unit of the x Axis.
void	setYUnit (QString unit)
	Specifies the unit of the y Axis.
std::size_t	size () const
	Returns the number of data points.
double	width () const
	Returns the width of the bounding box of all data points within the list.

Static Public Member Functions
static int	readList (const QString &path, std::vector< DiagramList * > &list)
static int	readList (const SensorData *data, std::vector< DiagramList * > &list)

Private Member Functions
float	calcMinXValue ()
	Returns the minimum x-value of all the data points.
float	calcMaxXValue ()
	Returns the maximum x-value of all the data points.
float	calcMinYValue ()
	Returns the minimum y-value of all the data points.
float	calcMaxYValue ()
	Returns the maximum y-value of all the data points.
int	readLine (std::ifstream inFile, QDateTime &cDate, float &cValue)
void	update ()
	Updates the bounds of the data points contained in the list.

Private Attributes
float	_maxX {0}
float	_maxY {0}
float	_minX {0}
float	_minY {0}
std::vector< std::pair< float, float > >	_coords
QString	_name
QString	_xLabel
QString	_yLabel
QString	_xUnit
QString	_yUnit
QColor	_colour
QDateTime	_startDate

Constructor & Destructor Documentation

DiagramList()

DiagramList::DiagramList

(

)

Constructor containing an empty list.

Definition at line 27 of file DiagramList.cpp.

: _xLabel(""), _yLabel(""), _xUnit(""), _yUnit("") {}

Referenced by readList(), and readList().

~DiagramList()

DiagramList::~DiagramList ( )

default

Member Function Documentation

addNextPoint()

void DiagramList::addNextPoint ( float x, float y )

inline

Adds a point at (x,y) to the list.

Definition at line 109 of file DiagramList.h.

{ _coords.emplace_back(x, y); }

References _coords.

calcMaxXValue()

float DiagramList::calcMaxXValue ( )

private

Returns the maximum x-value of all the data points.

Definition at line 43 of file DiagramList.cpp.

{
    float max = std::numeric_limits<float>::lowest();
    std::size_t nCoords = _coords.size();
    for (std::size_t i = 0; i < nCoords; i++)
    {
        if (_coords[i].first > max)
        {
            max = _coords[i].first;
        }
    }
    return max;
}

References _coords.

Referenced by update().

calcMaxYValue()

float DiagramList::calcMaxYValue ( )

private

Returns the maximum y-value of all the data points.

Definition at line 71 of file DiagramList.cpp.

{
    float max = std::numeric_limits<float>::lowest();
    std::size_t nCoords = _coords.size();
    for (std::size_t i = 0; i < nCoords; i++)
    {
        if (_coords[i].second > max)
        {
            max = _coords[i].second;
        }
    }
    return max;
}

References _coords.

Referenced by update().

calcMinXValue()

float DiagramList::calcMinXValue ( )

private

Returns the minimum x-value of all the data points.

Definition at line 31 of file DiagramList.cpp.

{
    auto min = std::min_element(_coords.begin(), _coords.end(),
                                [](auto const& c0, auto const& c1)
                                { return c0.first < c1.first; });
    if (min != _coords.end())
    {
        return min->first;
    }
    return std::numeric_limits<float>::max();
}

References _coords.

Referenced by update().

calcMinYValue()

float DiagramList::calcMinYValue ( )

private

Returns the minimum y-value of all the data points.

Definition at line 57 of file DiagramList.cpp.

{
    float min = std::numeric_limits<float>::max();
    std::size_t nCoords = _coords.size();
    for (std::size_t i = 0; i < nCoords; i++)
    {
        if (_coords[i].second < min)
        {
            min = _coords[i].second;
        }
    }
    return min;
}

References _coords.

Referenced by update().

getColor()

QColor DiagramList::getColor ( ) const

inline

Returns the colour of the graph.

Definition at line 36 of file DiagramList.h.

{   return _colour; }

References _colour.

Referenced by DiagramScene::drawGraph().

getName()

QString DiagramList::getName ( ) const

inline

Returns the name of the diagram.

Definition at line 57 of file DiagramList.h.

{ return _name; }

References _name.

Referenced by DiagramScene::drawGraph().

getPath()

bool DiagramList::getPath	(	QPainterPath &	path,
		float	scaleX,
		float	scaleY )

Returns all the data points in form of a QPainterPath in scene coordinates. The order of the points is the same as in the vector of coordinates.

Parameters

path	The path containing all data points.
scaleX	Scaling factor in x-direction.
scaleY	Scaling factor in y-direction.

Returns

true if everything is alright. false if the size of the coordinate arrays don't match.

Definition at line 85 of file DiagramList.cpp.

{
    QPointF p;
    if (getPoint(p, 0))
    {
        QPainterPath pp(QPointF(p.x() * scaleX, p.y() * scaleY));
        path = pp;
 
        std::size_t nCoords = _coords.size();
        for (std::size_t i = 1; i < nCoords; i++)
        {
            getPoint(p, i);
            path.lineTo(QPointF(p.x() * scaleX, p.y() * scaleY));
        }
        return true;
    }
 
    return false;
}

References _coords, and getPoint().

Referenced by DiagramScene::drawGraph().

getPoint()

bool DiagramList::getPoint	(	QPointF &	p,
		std::size_t	i )

Returns the position of one point in the vector of coordinates.

Parameters

p	The point-object that will be returned.
i	Number of the point to be returned.

Returns

true if everything is alright. false if the point does not exist.

Definition at line 105 of file DiagramList.cpp.

{
    if (i < _coords.size())
    {
        p.setX(_coords[i].first);
        p.setY(_coords[i].second);
        return true;
    }
 
    return false;
}

References _coords.

Referenced by getPath().

getStartDate()

const QDateTime DiagramList::getStartDate ( ) const

inline

Returns the start date of this list.

Definition at line 54 of file DiagramList.h.

{ return _startDate; }

References _startDate.

Referenced by DiagramScene::setDiagramBoundaries().

getXLabel()

QString DiagramList::getXLabel ( ) const

inline

Returns the label associated with the x-axis.

Definition at line 78 of file DiagramList.h.

{ return _xLabel; }

References _xLabel.

Referenced by DiagramScene::addGraph().

getXUnit()

QString DiagramList::getXUnit ( ) const

inline

Returns the unit associated with the x-axis.

Definition at line 84 of file DiagramList.h.

{ return _xUnit; }

References _xUnit.

Referenced by DiagramScene::addGraph().

getYLabel()

QString DiagramList::getYLabel ( ) const

inline

Returns the label associated with the y-axis.

Definition at line 81 of file DiagramList.h.

{ return _yLabel; }

References _yLabel.

Referenced by DiagramScene::addGraph().

getYUnit()

QString DiagramList::getYUnit ( ) const

inline

Returns the unit associated with the y-axis.

Definition at line 87 of file DiagramList.h.

{ return _yUnit; }

References _yUnit.

Referenced by DiagramScene::addGraph().

height()

float DiagramList::height ( ) const

inline

Returns the height of the bounding box of all data points within the list.

Definition at line 39 of file DiagramList.h.

{ return _maxY - _minY;  }

References _maxY, and _minY.

maxXValue()

float DiagramList::maxXValue ( ) const

inline

Returns the maximum x-value.

Definition at line 45 of file DiagramList.h.

{ return _maxX; }

References _maxX.

Referenced by DiagramScene::setDiagramBoundaries().

maxYValue()

float DiagramList::maxYValue ( ) const

inline

Returns the maximum y-value.

Definition at line 51 of file DiagramList.h.

{ return _maxY; }

References _maxY.

Referenced by DiagramScene::setDiagramBoundaries().

minXValue()

float DiagramList::minXValue ( ) const

inline

Returns the minimum x-value.

Definition at line 42 of file DiagramList.h.

{ return _minX; }

References _minX.

Referenced by DiagramScene::setDiagramBoundaries().

minYValue()

float DiagramList::minYValue ( ) const

inline

Returns the minimum y-value.

Definition at line 48 of file DiagramList.h.

{ return _minY; }

References _minY.

Referenced by DiagramScene::drawGraph(), and DiagramScene::setDiagramBoundaries().

readLine()

int DiagramList::readLine ( std::ifstream inFile, QDateTime & cDate, float & cValue )

private

Reads an ASCII file containing the coordinates in the following format: date (tab) value where 'date' is given as 'dd.mm.yyyy'. (Changes to that format are easily implemented using QTimeDate)

Returns

Returns 1 if everything is alright. Returns 0 and displays an error message if there was an error.

readList() [1/2]

int DiagramList::readList ( const QString & path, std::vector< DiagramList * > & list )

static

Reads information from a file. The reader assumes that values in the file are separated by tabstops. Also, the first row should contain identifiers for the values and the first column should contain timestamps. Currently accepted timestamps are of the following formats: "dd.mm.yyyy" "dd.mm.yyyy.hh.mm.ss" (this is the timestamp format used for the UFZ database) For each column after the timestamps a new diagram list is created.

Definition at line 157 of file DiagramList.cpp.

{
    QFile file(path);
    QTextStream in(&file);
 
    if (!file.open(QIODevice::ReadOnly))
    {
        qDebug("Could not open file...");
        return 0;
    }
 
    QString line = in.readLine();
    QStringList fields = line.split('\t');
    int nLists(fields.size() - 1);
 
    if (fields.size() >= 2)
    {
        fields.takeFirst();
        for (int i = 0; i < nLists; i++)
        {
            auto* l = new DiagramList;
            l->setName(fields.takeFirst());
            // value = strtod(BaseLib::replaceStringreplaceString(",", ".",
            // fields.takeFirst().toStdString()).c_str(),0);
            // l->setStartDate(startDate);
            // l->addNextPoint(0,value);
            lists.push_back(l);
        }
 
        bool first_loop(true);
        QDateTime startDate;
        QDateTime currentDate;
        unsigned line_count(1);
 
        while (!in.atEnd())
        {
            line = in.readLine();
            line_count++;
            fields = line.split('\t');
            if (fields.size() >= (nLists + 1))
            {
                QString const stringDate = fields.takeFirst();
                currentDate = getDateTime(stringDate);
                if (first_loop)
                {
                    startDate = currentDate;
                    for (int i = 0; i < nLists; i++)
                    {
                        lists[i]->setStartDate(startDate);
                    }
                    first_loop = false;
                }
 
                auto const numberOfSecs =
                    static_cast<float>(startDate.secsTo(currentDate));
                for (int i = 0; i < nLists; i++)
                {
                    float const value = static_cast<float>(
                        strtod(BaseLib::replaceString(
                                   ",", ".", fields.takeFirst().toStdString())
                                   .c_str(),
                               nullptr));
                    lists[i]->addNextPoint(numberOfSecs, value);
                }
            }
            else
            {
                WARN("DiagramList::readList(): Unexpected format in line {:d}.",
                     line_count);
                file.close();
                return 0;
            }
        }
    }
    else
    {
        qDebug("Unexpected file format...");
        file.close();
        return 0;
    }
 
    file.close();
 
    for (int i = 0; i < nLists; i++)
    {
        lists[i]->update();
    }
 
    return nLists;
}

References DiagramList(), getDateTime(), BaseLib::replaceString(), and WARN().

Referenced by DetailWindow::DetailWindow(), DiagramPrefsDialog::DiagramPrefsDialog(), and DiagramPrefsDialog::loadFile().

readList() [2/2]

int DiagramList::readList ( const SensorData * data, std::vector< DiagramList * > & list )

static

Definition at line 248 of file DiagramList.cpp.

{
    std::vector<SensorDataType> const& time_series_names(
        data->getTimeSeriesNames());
    int nLists(time_series_names.size());
 
    std::vector<std::size_t> time_steps;
    if (data->getStepSize() > 0)
    {
        const std::size_t start = data->getStartTime();
        const std::size_t end = data->getEndTime();
        const std::size_t stepsize = data->getStepSize();
        for (std::size_t i = start; i <= end; i += stepsize)
        {
            time_steps.push_back(i);
        }
    }
    else
    {
        time_steps = data->getTimeSteps();
    }
 
    bool is_date(false);
 
    if (!(BaseLib::int2date(time_steps[0])).empty())
    {
        is_date = true;
    }
 
    std::size_t nValues(time_steps.size());
 
    for (int i = 0; i < nLists; i++)
    {
        auto const* time_series = data->getTimeSeries(time_series_names[i]);
        if (!time_series)
        {
            continue;
        }
 
        auto* l = new DiagramList;
        l->setName(QString::fromStdString(
            SensorData::convertSensorDataType2String(time_series_names[i])));
        l->setXLabel("Time");
        lists.push_back(l);
 
        if (is_date)
        {
            l->setXUnit("day");
            QDateTime const startDate(
                getDateTime(BaseLib::int2date(time_steps[0])));
            lists[i]->setStartDate(startDate);
            for (std::size_t j = 0; j < nValues; j++)
            {
                QDateTime const currentDate(
                    getDateTime(BaseLib::int2date(time_steps[j])));
                auto numberOfSecs =
                    static_cast<float>(startDate.secsTo(currentDate));
                lists[i]->addNextPoint(numberOfSecs, (*time_series)[j]);
            }
        }
        else
        {
            l->setXUnit("time step");
            for (std::size_t j = 0; j < nValues; j++)
            {
                lists[i]->addNextPoint(static_cast<float>(time_steps[j]),
                                       (*time_series)[j]);
            }
        }
 
        lists[i]->update();
    }
 
    return nLists;
}

References DiagramList(), SensorData::convertSensorDataType2String(), getDateTime(), SensorData::getEndTime(), SensorData::getStartTime(), SensorData::getStepSize(), SensorData::getTimeSeries(), SensorData::getTimeSeriesNames(), SensorData::getTimeSteps(), and BaseLib::int2date().

setColor()

void DiagramList::setColor ( QColor c )

inline

Sets the colour of the graph.

Definition at line 103 of file DiagramList.h.

{ _colour = c; }

References _colour.

Referenced by DetailWindow::addList().

setList() [1/2]

void DiagramList::setList

(

std::vector< std::pair< float, float > > const &

coords

)

Sets the list of x/y-coordinates.

Parameters

coords

List of coordinates.

Definition at line 376 of file DiagramList.cpp.

{
    if (coords.empty())
    {
        return;
    }
 
    this->_startDate = QDateTime();
    std::copy(coords.begin(), coords.end(), std::back_inserter(_coords));
    update();
}

References _coords, _startDate, and update().

setList() [2/2]

void DiagramList::setList

(

std::vector< std::pair< QDateTime, float > > const &

coords

)

Sets the list of x/y-coordinates. Note: This function converts QDateTime values to float values of the number of days from the first date (which is set as day 0)

Parameters

coords

List of coordinates.

Definition at line 356 of file DiagramList.cpp.

{
    if (coords.empty())
    {
        return;
    }
 
    _startDate = coords[0].first;
    std::transform(coords.begin(), coords.end(), std::back_inserter(_coords),
                   [this](auto const& p)
                   {
                       return std::make_pair(
                           static_cast<float>(_startDate.daysTo(p.first)),
                           p.second);
                   });
 
    update();
}

References _coords, _startDate, and update().

setName()

void DiagramList::setName ( QString name )

inline

Sets the name of the graph to be displayed in the caption.

Definition at line 106 of file DiagramList.h.

{ _name = name; }

References _name.

Referenced by DiagramPrefsDialog::loadList().

setStartDate()

void DiagramList::setStartDate ( QDateTime date )

inline

Sets the start date (i.e. the min-value of the x-axis).

Definition at line 115 of file DiagramList.h.

{ _startDate = date; }

References _startDate.

setXLabel()

void DiagramList::setXLabel ( QString label )

inline

Specifies the meaning of the x Axis.

Definition at line 118 of file DiagramList.h.

{ _xLabel = label; }

References _xLabel.

setXUnit()

void DiagramList::setXUnit ( QString unit )

inline

Specifies the unit of the x Axis.

Definition at line 138 of file DiagramList.h.

{ _xUnit = unit; }

References _xUnit.

setYLabel()

void DiagramList::setYLabel ( QString label )

inline

Specifies the meaning of the y Axis.

Definition at line 121 of file DiagramList.h.

{ _yLabel = label; }

References _yLabel.

setYUnit()

void DiagramList::setYUnit ( QString unit )

inline

Specifies the unit of the y Axis.

Definition at line 141 of file DiagramList.h.

{ _yUnit = unit; }

References _yUnit.

size()

std::size_t DiagramList::size

(

)

const

Returns the number of data points.

Definition at line 388 of file DiagramList.cpp.

{
    return _coords.size();
}

References _coords.

truncateToRange()

void DiagramList::truncateToRange	(	QDateTime const &	start,
		QDateTime const &	end )

cut list entries not within the given range

Definition at line 325 of file DiagramList.cpp.

{
    auto start_secs = static_cast<float>(_startDate.secsTo(start));
    if (start_secs < 0)
    {
        start_secs = 0;
    }
    auto end_secs = static_cast<float>(_startDate.secsTo(end));
    if (end_secs < start_secs)
    {
        end_secs = _coords.back().first;
    }
 
    if (start_secs == 0 && end_secs == _coords.back().first)
    {
        return;
    }
 
    _coords.erase(std::remove_if(
                      _coords.begin(), _coords.end(),
                      [&](std::pair<float, float> const& c)
                      { return (c.first < start_secs || c.first > end_secs); }),
                  _coords.end());
    _startDate = start;
    for (auto& c : _coords)
    {
        c.first -= start_secs;
    }
    update();
}

References _coords, _startDate, and update().

update()

void DiagramList::update ( )

private

Updates the bounds of the data points contained in the list.

Definition at line 393 of file DiagramList.cpp.

{
    _minX = calcMinXValue();
    _maxX = calcMaxXValue();
    _minY = calcMinYValue();
    _maxY = calcMaxYValue();
}

References _maxX, _maxY, _minX, _minY, calcMaxXValue(), calcMaxYValue(), calcMinXValue(), and calcMinYValue().

Referenced by setList(), setList(), and truncateToRange().

width()

double DiagramList::width ( ) const

inline

Returns the width of the bounding box of all data points within the list.

Definition at line 147 of file DiagramList.h.

{ return _maxX - _minX; }

References _maxX, and _minX.

Member Data Documentation

_colour

QColor DiagramList::_colour

private

Definition at line 184 of file DiagramList.h.

Referenced by getColor(), and setColor().

_coords

std::vector< std::pair<float, float> > DiagramList::_coords

private

Definition at line 178 of file DiagramList.h.

Referenced by addNextPoint(), calcMaxXValue(), calcMaxYValue(), calcMinXValue(), calcMinYValue(), getPath(), getPoint(), setList(), setList(), size(), and truncateToRange().

_maxX

float DiagramList::_maxX {0}

private

Definition at line 174 of file DiagramList.h.

{0};

Referenced by maxXValue(), update(), and width().

_maxY

float DiagramList::_maxY {0}

private

Definition at line 175 of file DiagramList.h.

{0};

Referenced by height(), maxYValue(), and update().

_minX

float DiagramList::_minX {0}

private

Definition at line 176 of file DiagramList.h.

{0};

Referenced by minXValue(), update(), and width().

_minY

float DiagramList::_minY {0}

private

Definition at line 177 of file DiagramList.h.

{0};

Referenced by height(), minYValue(), and update().

_name

QString DiagramList::_name

private

Definition at line 179 of file DiagramList.h.

Referenced by getName(), and setName().

_startDate

QDateTime DiagramList::_startDate

private

Definition at line 185 of file DiagramList.h.

Referenced by getStartDate(), setList(), setList(), setStartDate(), and truncateToRange().

_xLabel

QString DiagramList::_xLabel

private

Definition at line 180 of file DiagramList.h.

Referenced by getXLabel(), and setXLabel().

_xUnit

QString DiagramList::_xUnit

private

Definition at line 182 of file DiagramList.h.

Referenced by getXUnit(), and setXUnit().

_yLabel

QString DiagramList::_yLabel

private

Definition at line 181 of file DiagramList.h.

Referenced by getYLabel(), and setYLabel().

_yUnit

QString DiagramList::_yUnit

private

Definition at line 183 of file DiagramList.h.

Referenced by getYUnit(), and setYUnit().

---

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

• Applications/DataExplorer/DataView/DiagramView/DiagramList.h
• Applications/DataExplorer/DataView/DiagramView/DiagramList.cpp