DiagramPrefsDialog Class Reference

Detailed Description

A dialog that allows for setting preferences for a requested diagram.

A dialog that allows for setting preferences for a requested diagram. Note: In the current version this dialog only works when requesting data from a database. Visualisation of data from an ASCII-file is still possible using the "Load File"-button but setting the preferences will not work (i.e. it is only possible to visualise all the data in the file with default preferences.

Definition at line 38 of file DiagramPrefsDialog.h.

#include <DiagramPrefsDialog.h>

Inheritance diagram for DiagramPrefsDialog:

Collaboration diagram for DiagramPrefsDialog:

Public Member Functions
	DiagramPrefsDialog (const GeoLib::Station *stn, const QString &listName, QDialog *parent=nullptr)
	DiagramPrefsDialog (GeoLib::Station *stn, QDialog *parent=nullptr)
	DiagramPrefsDialog (const QString &filename, DetailWindow *window=nullptr, QDialog *parent=nullptr)
	~DiagramPrefsDialog () override

Private Slots
void	accept () override
void	reject () override
	Instructions if the Cancel-Button has been pressed.
void	on_loadFileButton_clicked ()
	Instructions if the "Load File"-Button has been pressed.

Private Member Functions
void	createVisibilityCheckboxes ()
int	loadFile (const QString &filename)
int	loadList (const std::vector< std::pair< QDateTime, float > > &coords)

Private Attributes
std::vector< DiagramList * >	_list
std::vector< QCheckBox * >	_visability
DetailWindow *	_window

Constructor & Destructor Documentation

DiagramPrefsDialog() [1/3]

DiagramPrefsDialog::DiagramPrefsDialog	(	const GeoLib::Station *	stn,
		const QString &	listName,
		QDialog *	parent = nullptr )

Opens a new dialog based on station and the list this station belongs to. If a database connection is available, the program will try to find data associated with the station, otherwise data can be loaded from a file.

Parameters

stn	The station object associated the diagram.
listName	The station list the station belongs to.
parent	The parent QDialog.

Definition at line 27 of file DiagramPrefsDialog.cpp.

    : QDialog(parent), _window(nullptr)
{
    setAttribute(Qt::WA_DeleteOnClose);
 
    setupUi(this);
    stationNameLabel->setText(QString::fromStdString(stn->getName()));
    stationTypeLabel->setText(listName);
}

References GeoLib::Station::getName().

DiagramPrefsDialog() [2/3]

DiagramPrefsDialog::DiagramPrefsDialog ( GeoLib::Station * stn, QDialog * parent = nullptr )

explicit

Opens a new dialog and automatically reads data from the associated station object.

Parameters

stn	The station object associated the diagram.
parent	The parent QDialog.

Definition at line 40 of file DiagramPrefsDialog.cpp.

    : QDialog(parent), _window(nullptr)
{
    setupUi(this);
    stationNameLabel->setText(QString::fromStdString(stn->getName()));
    stationTypeLabel->setText("");
    DiagramList::readList(stn->getSensorData(), _list);
 
    fromDateLine->setText(
        QString::number(stn->getSensorData()->getStartTime()));
    toDateLine->setText(QString::number(stn->getSensorData()->getEndTime()));
    this->createVisibilityCheckboxes();
}

References _list, createVisibilityCheckboxes(), SensorData::getEndTime(), GeoLib::Station::getName(), GeoLib::Station::getSensorData(), SensorData::getStartTime(), and DiagramList::readList().

DiagramPrefsDialog() [3/3]

DiagramPrefsDialog::DiagramPrefsDialog ( const QString & filename, DetailWindow * window = nullptr, QDialog * parent = nullptr )

explicit

Opens a new dialog and automatically reads data from the specified file. The diagram is not associated with any geometric object.

Parameters

	filename	File containing data for the diagram(s) to be visualised.
[out]	window	Returns the created DetailWindow.
	parent	The parent QDialog.

Definition at line 54 of file DiagramPrefsDialog.cpp.

    : QDialog(parent), _window(window)
{
    QFileInfo fi(filename);
    setupUi(this);
    stationNameLabel->setText(fi.baseName());
    stationTypeLabel->setText("");
    this->loadFile(filename);
}

References loadFile().

~DiagramPrefsDialog()

DiagramPrefsDialog::~DiagramPrefsDialog ( )

override

Definition at line 66 of file DiagramPrefsDialog.cpp.

{
    this->destroy();
}

Member Function Documentation

accept

void DiagramPrefsDialog::accept ( )

overrideprivateslot

Instructions if the OK-Button has been pressed. Note: Clicking the "Load from file"-button overrides the database input!

Definition at line 71 of file DiagramPrefsDialog.cpp.

{
    QDateTime start_date(getDateTime(fromDateLine->text()));
    QDateTime end_date(getDateTime(toDateLine->text()));
 
    if (start_date == QDateTime() || end_date == QDateTime() ||
        start_date > end_date || _list.empty())
    {
        OGSError::box("No data found...");
        return;
    }
 
    if (_list[0]->size() == 0)
    {
        OGSError::box("Invalid station data.");
        this->done(QDialog::Rejected);
    }
 
    // Data has been loaded.
    // If loading lists beyond the first one fails at least nothing terrible
    // will happen.
    bool window_is_empty(false);
    if (_window == nullptr)
    {
        _window = new DetailWindow();
        _window->setAttribute(Qt::WA_DeleteOnClose);
        window_is_empty = true;
    }
 
    for (std::size_t i = 0; i < _list.size(); i++)
    {
        if (_visability[i]->isChecked())
        {
            _list[i]->truncateToRange(start_date, end_date);
            _window->addList(_list[i]);
            window_is_empty = false;
        }
    }
 
    if (!window_is_empty)
    {
        _window->show();
        this->done(QDialog::Accepted);
    }
    else
    {
        delete _window;
        _window = nullptr;
        OGSError::box("No dataset selected.");
    }
}

References _list, _visability, _window, DetailWindow::addList(), OGSError::box(), and getDateTime().

createVisibilityCheckboxes()

void DiagramPrefsDialog::createVisibilityCheckboxes ( )

private

Creates checkboxes for every list of data values found. Per default all of these are checked, i.e. all diagrams will be visualised. Any checkbox the user unchecks will result in the associated data not being visualised.

Definition at line 186 of file DiagramPrefsDialog.cpp.

{
    for (auto& item : _list)
    {
        QCheckBox* box = new QCheckBox(item->getName());
        box->setChecked(true);
        this->CheckBoxLayout->addWidget(box);
        _visability.push_back(box);
    }
}

References _list, and _visability.

Referenced by DiagramPrefsDialog(), and loadFile().

loadFile()

int DiagramPrefsDialog::loadFile ( const QString & filename )

private

Loading data from a file

Parameters

filename

Name of the file containing the data

Returns

1 if everything is okay, 0 and an error message if there were errors

Definition at line 141 of file DiagramPrefsDialog.cpp.

{
    if (DiagramList::readList(filename, _list))
    {
        for (auto& item : _list)
        {
            // item->setName(stationTypeLabel->text() + ": " +
            // stationNameLabel->text());
            item->setXLabel("Time");
            // item->setYLabel("Water Level");
            item->setXUnit("day");
            // item->setYUnit("metres");
            item->setColor(QColor(Qt::red));
        }
        fromDateLine->setText(_list[0]->getStartDate().toString("dd.MM.yyyy"));
        QDateTime endDate = _list[0]->getStartDate().addSecs(
            static_cast<int>(_list[0]->maxXValue()));
        toDateLine->setText(endDate.toString("dd.MM.yyyy"));
        this->createVisibilityCheckboxes();
        return 1;
    }
 
    OGSError::box("Error reading file.");
    return 0;
}

References _list, OGSError::box(), createVisibilityCheckboxes(), and DiagramList::readList().

Referenced by DiagramPrefsDialog(), and on_loadFileButton_clicked().

loadList()

int DiagramPrefsDialog::loadList ( const std::vector< std::pair< QDateTime, float > > & coords )

private

Setting up the QDiagramList object were the time series data will be stored

Parameters

coords

List of coordinates.

Returns

1 if everything is okay, 0 and an error message if there were errors

Definition at line 167 of file DiagramPrefsDialog.cpp.

{
    if (!coords.empty())
    {
        auto* l = new DiagramList;
        l->setName(stationTypeLabel->text() + ": " + stationNameLabel->text());
        l->setXLabel("Time");
        // l->setYLabel("Water Level");
        l->setXUnit("day");
        // l->setYUnit("metres");
        l->setColor(QColor(Qt::red));
        l->setList(coords);
        _list.push_back(l);
        return 1;
    }
    return 0;
}

References _list, and DiagramList::setName().

on_loadFileButton_clicked

void DiagramPrefsDialog::on_loadFileButton_clicked ( )

privateslot

Instructions if the "Load File"-Button has been pressed.

Definition at line 128 of file DiagramPrefsDialog.cpp.

{
    QString fileName =
        QFileDialog::getOpenFileName(this,
                                     "Select time series file to open",
                                     "",
                                     "Time series files (*.stn *.txt)");
    if (!fileName.isEmpty())
    {
        loadFile(fileName);
    }
}

References loadFile().

reject

void DiagramPrefsDialog::reject ( )

overrideprivateslot

Instructions if the Cancel-Button has been pressed.

Definition at line 123 of file DiagramPrefsDialog.cpp.

{
    this->done(QDialog::Rejected);
}

Member Data Documentation

_list

std::vector<DiagramList*> DiagramPrefsDialog::_list

private

Definition at line 99 of file DiagramPrefsDialog.h.

Referenced by DiagramPrefsDialog(), accept(), createVisibilityCheckboxes(), loadFile(), and loadList().

_visability

std::vector<QCheckBox*> DiagramPrefsDialog::_visability

private

Definition at line 100 of file DiagramPrefsDialog.h.

Referenced by accept(), and createVisibilityCheckboxes().

_window

DetailWindow* DiagramPrefsDialog::_window

private

Definition at line 101 of file DiagramPrefsDialog.h.

Referenced by accept().

---

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

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