QREDataLoaderResultModel Class Reference

Description

The result model of a QREDataLoader (for showing the import results in a table view).

Definition at line 22 of file QREDataLoaderResultModel.h.

Inheritance diagram for QREDataLoaderResultModel:

Collaboration diagram for QREDataLoaderResultModel:

Public Types
enum class	ColumnType {   none , line , fileContent , raw ,   processed , error }

Public Member Functions
	QREDataLoaderResultModel (QREDataLoader::ImportResult *importResult)
int	columnCount (const QModelIndex &parent=QModelIndex()) const override
QVariant	data (const QModelIndex &index, int role=Qt::DisplayRole) const override
QVariant	headerData (int section, Qt::Orientation orientation, int role=Qt::DisplayRole) const override
int	rowCount (const QModelIndex &parent) const override
QVector< int >	sectionsOfColumnType (ColumnType type) const
	The table header sections which belong to the given column type. Empty if this column type is not present at all. More...

Protected Member Functions
QString	cellText (ColumnType type, int row, int col) const override
	The text of the given cell. For convenience, column starts at 0 for the given column type, therefore it is not the same as the "real" section in the table header. This method will not be called for every row/column present in the table. Instead, optimizations will be done before calling it. E.g. the calculated values for lines which contain errors will never be called. Also raw or calculated contents will not be queried if a line is skipped. More...
int	columnCount (ColumnType type) const override
	The number of existing columns related to the given column type. 0 if the type is not present at all. More...
virtual int	columnCount (ColumnType type) const=0
	The number of existing columns related to the given column type. 0 if the type is not present at all. More...
int	columnCount (const QModelIndex &parent=QModelIndex()) const override
QString	headerTextOfCalculatedColumn (int column) const override
	Return the table header text for the given column. For convenience, column starts at 0 for first calculated column, therefore it is not the same as the "real" section in the table header. More...
int	rowCount () const override
	The row count of the result table. More...
virtual int	rowCount () const=0
	The row count of the result table. More...
int	rowCount (const QModelIndex &parent) const override
virtual bool	rowHasError (const QModelIndex &index) const
	Returns whether the row given in the index contains errors. Only override this for performance reasons. More...
virtual bool	rowHasError (const QModelIndex &index) const
	Returns whether the row given in the index contains errors. Only override this for performance reasons. More...
bool	rowHasError (int row) const override
	Returns whether the row given in the index contains errors. Row counting starts with 0. More...
virtual bool	rowHasError (int row) const=0
	Returns whether the row given in the index contains errors. Row counting starts with 0. More...
virtual bool	rowIsSkipped (const QModelIndex &index) const
	Returns whether the row given in the index is a skipped row. Only override this for performance reasons. More...
virtual bool	rowIsSkipped (const QModelIndex &index) const
	Returns whether the row given in the index is a skipped row. Only override this for performance reasons. More...
bool	rowIsSkipped (int row) const override
	Returns whether the row given in the index is a skipped row. Row counting starts with 0. More...
virtual bool	rowIsSkipped (int row) const=0
	Returns whether the row given in the index is a skipped row. Row counting starts with 0. More...

Private Member Functions
ColumnType	columnType (const QModelIndex &index) const
	Calculates the column type of the given index. More...
ColumnType	columnType (int section) const
	Calculates the column type of the real header view section. More...
int	firstSectionOfColumnType (ColumnType type) const
	Calculates the first real header view section of the given column type. Returns -1 if the column type does not exist. More...
int	lastSectionOfColumnType (ColumnType type) const
	Calculates the last real header view section of the given column type. Returns -1 if the column type does not exist. More...

Private Attributes
QREDataLoader::ImportResult *	m_importResult
QIcon	m_warningIcon

Member Enumeration Documentation

ColumnType

enum AbstractDataLoaderResultModel::ColumnType

stronginherited

Enumerator
none
line
fileContent
raw
processed
error

Definition at line 26 of file AbstractDataLoaderResultModel.h.

{ none, line, fileContent, raw, processed, error };

Constructor & Destructor Documentation

QREDataLoaderResultModel()

QREDataLoaderResultModel::QREDataLoaderResultModel

(

QREDataLoader::ImportResult *

importResult

)

Definition at line 17 of file QREDataLoaderResultModel.cpp.

    : m_importResult(importResult)
{
}

Member Function Documentation

cellText()

QString QREDataLoaderResultModel::cellText ( ColumnType  type, int  row, int  column  ) const

overrideprotectedvirtual

The text of the given cell. For convenience, column starts at 0 for the given column type, therefore it is not the same as the "real" section in the table header. This method will not be called for every row/column present in the table. Instead, optimizations will be done before calling it. E.g. the calculated values for lines which contain errors will never be called. Also raw or calculated contents will not be queried if a line is skipped.

Implements AbstractDataLoaderResultModel.

Definition at line 73 of file QREDataLoaderResultModel.cpp.

{
    if (col < 0 || row < 0 || row >= m_importResult->lines.size())
        return "";
 
    if (type == ColumnType::fileContent)
        return (col == 0) ? m_importResult->lines[row].second : QString();
 
    const bool isSkippedLine = m_importResult->lines[row].first;
    if (isSkippedLine)
        return "";
 
    switch (type) {
    case ColumnType::raw: {
        if (row >= m_importResult->rawValues.size())
            return "";
        const auto& d = m_importResult->rawValues[row];
        return (col < d.size()) ? QString::number(d[col]) : QString();
    }
 
    case ColumnType::processed:
        if (col == 0)
            return (row < m_importResult->qValues.size())
                       ? QString::number(m_importResult->qValues[row])
                       : QString();
        if (col == 1)
            return (row < m_importResult->rValues.size())
                       ? QString::number(m_importResult->rValues[row])
                       : QString();
        if (col == 2)
            return (row < m_importResult->eValues.size())
                       ? QString::number(m_importResult->eValues[row])
                       : QString();
        return "";
 
    case ColumnType::error:
        return (col == 0) ? m_importResult->errorText(row) : QString();
 
    default:
        return "";
    }
}

References AbstractDataLoaderResultModel::error, QREDataLoader::ImportResult::errorText(), QREDataLoader::ImportResult::eValues, AbstractDataLoaderResultModel::fileContent, QREDataLoader::ImportResult::lines, m_importResult, AbstractDataLoaderResultModel::processed, QREDataLoader::ImportResult::qValues, AbstractDataLoaderResultModel::raw, QREDataLoader::ImportResult::rawValues, and QREDataLoader::ImportResult::rValues.

Here is the call graph for this function:

columnCount() [1/4]

int QREDataLoaderResultModel::columnCount ( ColumnType  type ) const

overrideprotectedvirtual

The number of existing columns related to the given column type. 0 if the type is not present at all.

Implements AbstractDataLoaderResultModel.

Definition at line 53 of file QREDataLoaderResultModel.cpp.

{
    switch (type) {
    case ColumnType::line:
    case ColumnType::fileContent:
        return 1;
    case ColumnType::raw:
        return m_importResult->maxColumnCount;
    case ColumnType::processed: {
        const bool showErrorColumn =
            m_importResult->importSettings.columnDefinitions[QREDataLoader::DataType::dR].enabled;
        return showErrorColumn ? 3 : 2;
    }
    case ColumnType::error:
        return m_importResult->calculationErrors.isEmpty() ? 0 : 1;
    default:
        return 0;
    }
}

References QREDataLoader::ImportResult::calculationErrors, QREDataLoader::ImportSettings::columnDefinitions, QREDataLoader::dR, AbstractDataLoaderResultModel::error, AbstractDataLoaderResultModel::fileContent, QREDataLoader::ImportResult::importSettings, AbstractDataLoaderResultModel::line, m_importResult, QREDataLoader::ImportResult::maxColumnCount, AbstractDataLoaderResultModel::processed, and AbstractDataLoaderResultModel::raw.

columnCount() [2/4]

virtual int AbstractDataLoaderResultModel::columnCount

protected

The number of existing columns related to the given column type. 0 if the type is not present at all.

columnCount() [3/4]

int AbstractDataLoaderResultModel::columnCount ( const QModelIndex &  parent = QModelIndex() ) const

overrideinherited

Definition at line 43 of file AbstractDataLoaderResultModel.cpp.

{
    if (parent.isValid())
        return 0;
 
    const auto colTypes = {ColumnType::line, ColumnType::fileContent, ColumnType::raw,
                           ColumnType::processed, ColumnType::error};
 
    int cols = 0;
    for (ColumnType type : colTypes)
        cols += columnCount(type);
 
    return cols;
}

Referenced by AbstractDataLoaderResultModel::firstSectionOfColumnType(), and AbstractDataLoaderResultModel::lastSectionOfColumnType().

columnCount() [4/4]

int AbstractDataLoaderResultModel::columnCount

overrideprotected

Definition at line 32 of file AbstractDataLoaderResultModel.cpp.

{
    if (parent.isValid())
        return 0;
 
    const auto colTypes = {ColumnType::line, ColumnType::fileContent, ColumnType::raw,
                           ColumnType::processed, ColumnType::error};
 
    int cols = 0;
    for (ColumnType type : colTypes)
        cols += columnCount(type);
 
    return cols;
}

columnType() [1/2]

AbstractDataLoaderResultModel::ColumnType AbstractDataLoaderResultModel::columnType ( const QModelIndex &  index ) const

privateinherited

Calculates the column type of the given index.

Definition at line 195 of file AbstractDataLoaderResultModel.cpp.

{
    return columnType(index.column());
}

Referenced by AbstractDataLoaderResultModel::data(), and AbstractDataLoaderResultModel::headerData().

columnType() [2/2]

AbstractDataLoaderResultModel::ColumnType AbstractDataLoaderResultModel::columnType ( int  section ) const

privateinherited

Calculates the column type of the real header view section.

Definition at line 177 of file AbstractDataLoaderResultModel.cpp.

{
    const auto colTypes = {ColumnType::line, ColumnType::fileContent, ColumnType::raw,
                           ColumnType::processed, ColumnType::error};
 
    for (ColumnType type : colTypes) {
        const int firstSection = firstSectionOfColumnType(type);
        if (firstSection < 0)
            continue;
 
        if (section >= firstSection && section <= lastSectionOfColumnType(type))
            return type;
    }
 
    return ColumnType::none;
}

References AbstractDataLoaderResultModel::error, AbstractDataLoaderResultModel::fileContent, AbstractDataLoaderResultModel::firstSectionOfColumnType(), AbstractDataLoaderResultModel::lastSectionOfColumnType(), AbstractDataLoaderResultModel::line, AbstractDataLoaderResultModel::none, AbstractDataLoaderResultModel::processed, and AbstractDataLoaderResultModel::raw.

Here is the call graph for this function:

data()

QVariant AbstractDataLoaderResultModel::data ( const QModelIndex &  index, int  role = Qt::DisplayRole  ) const

overrideinherited

Definition at line 63 of file AbstractDataLoaderResultModel.cpp.

{
    if (!index.isValid())
        return QVariant();
 
    const auto colType = columnType(index);
 
    if (role == Qt::BackgroundRole) {
        switch (colType) {
        case ColumnType::line:
        case ColumnType::fileContent:
            return Palette::backgroundColorFileContent;
        case ColumnType::raw:
            return rowIsSkipped(index) ? QVariant() : Palette::backgroundColorRawContent;
        case ColumnType::processed:
            return rowIsSkipped(index) || rowHasError(index)
                       ? QVariant()
                       : Palette::backgroundColorProcessedContent;
        case ColumnType::error:
            return rowIsSkipped(index) || !rowHasError(index) ? QVariant()
                                                              : Palette::backgroundColorErrors;
        default:
            return QVariant();
        }
    }
 
    if (role == Qt::ForegroundRole) {
        if (colType == ColumnType::fileContent && rowIsSkipped(index))
            return Palette::skippedLineTextColor;
        return QVariant();
    }
 
    if (role == Qt::DisplayRole) {
        switch (colType) {
        case ColumnType::line:
            return QString::number(index.row() + 1);
 
        case ColumnType::fileContent: {
            QString lineContent =
                cellText(colType, index.row(), index.column() - firstSectionOfColumnType(colType));
            lineContent.replace("\t", " --> ");
            return lineContent;
        }
 
        case ColumnType::raw:
        case ColumnType::error: {
            if (!rowIsSkipped(index))
                return cellText(colType, index.row(),
                                index.column() - firstSectionOfColumnType(colType));
        } break;
 
        case ColumnType::processed: {
            if (!rowIsSkipped(index) && !rowHasError(index))
                return cellText(colType, index.row(),
                                index.column() - firstSectionOfColumnType(colType));
        } break;
        default:
            break;
        }
 
        return QVariant();
    }
 
    if (role == Qt::DecorationRole && (colType == ColumnType::line || colType == ColumnType::error)
        && rowHasError(index))
        return m_warningIcon;
 
    if (role == Qt::TextAlignmentRole && colType == ColumnType::line)
        return QVariant(Qt::AlignRight | Qt::AlignVCenter);
 
    if (role == Qt::ToolTipRole && colType == ColumnType::line && rowHasError(index))
        return cellText(ColumnType::error, index.row(), 0);
 
    return QVariant();
}

References AbstractDataLoaderResultModel::cellText(), AbstractDataLoaderResultModel::columnType(), AbstractDataLoaderResultModel::error, AbstractDataLoaderResultModel::fileContent, AbstractDataLoaderResultModel::firstSectionOfColumnType(), AbstractDataLoaderResultModel::line, AbstractDataLoaderResultModel::m_warningIcon, AbstractDataLoaderResultModel::processed, AbstractDataLoaderResultModel::raw, AbstractDataLoaderResultModel::rowHasError(), and AbstractDataLoaderResultModel::rowIsSkipped().

Referenced by AutomaticDataLoader1DResultModel::cellText(), and AutomaticDataLoader1DResultModel::rowCount().

Here is the call graph for this function:

firstSectionOfColumnType()

int AbstractDataLoaderResultModel::firstSectionOfColumnType ( ColumnType  type ) const

privateinherited

Calculates the first real header view section of the given column type. Returns -1 if the column type does not exist.

Definition at line 200 of file AbstractDataLoaderResultModel.cpp.

{
    const int lineColumnCount = columnCount(ColumnType::line);
    const int fileContentColumnCount = columnCount(ColumnType::fileContent);
 
    if (type == ColumnType::line)
        return lineColumnCount > 0 ? 0 : -1;
 
    if (type == ColumnType::fileContent)
        return columnCount(ColumnType::fileContent) > 0 ? lineColumnCount : -1;
 
    if (type == ColumnType::raw) {
        const bool hasRawContent = columnCount(ColumnType::raw) > 0;
        return hasRawContent ? lineColumnCount + fileContentColumnCount : -1;
    }
 
    if (type == ColumnType::processed) {
        const bool hasProcessedContent = columnCount(ColumnType::processed) > 0;
        return hasProcessedContent
                   ? (lineColumnCount + fileContentColumnCount + columnCount(ColumnType::raw))
                   : -1;
    }
 
    if (type == ColumnType::error) {
        const bool hasParsingErrors = columnCount(ColumnType::error) > 0;
        return hasParsingErrors
                   ? (lineColumnCount + fileContentColumnCount + columnCount(ColumnType::raw)
                      + columnCount(ColumnType::processed))
                   : -1;
    }
 
    return -1;
}

References AbstractDataLoaderResultModel::columnCount(), AbstractDataLoaderResultModel::error, AbstractDataLoaderResultModel::fileContent, AbstractDataLoaderResultModel::line, AbstractDataLoaderResultModel::processed, and AbstractDataLoaderResultModel::raw.

Referenced by AbstractDataLoaderResultModel::columnType(), AbstractDataLoaderResultModel::data(), AbstractDataLoaderResultModel::headerData(), AbstractDataLoaderResultModel::lastSectionOfColumnType(), and AbstractDataLoaderResultModel::sectionsOfColumnType().

Here is the call graph for this function:

headerData()

QVariant AbstractDataLoaderResultModel::headerData ( int  section, Qt::Orientation  orientation, int  role = Qt::DisplayRole  ) const

overrideinherited

Definition at line 140 of file AbstractDataLoaderResultModel.cpp.

{
    if (role == Qt::DisplayRole && orientation == Qt::Horizontal) {
        switch (columnType(section)) {
        case ColumnType::line:
            return "Line";
        case ColumnType::fileContent:
            return "File content (text)";
        case ColumnType::raw:
            return QString("Column %1 raw")
                .arg(section - firstSectionOfColumnType(ColumnType::raw) + 1);
        case ColumnType::processed:
            return headerTextOfCalculatedColumn(section
                                                - firstSectionOfColumnType(ColumnType::processed));
        case ColumnType::error:
            return "Parser warnings";
        default:
            return QVariant();
        }
    }
 
    return QAbstractTableModel::headerData(section, orientation, role);
}

References AbstractDataLoaderResultModel::columnType(), AbstractDataLoaderResultModel::error, AbstractDataLoaderResultModel::fileContent, AbstractDataLoaderResultModel::firstSectionOfColumnType(), AbstractDataLoaderResultModel::headerTextOfCalculatedColumn(), AbstractDataLoaderResultModel::line, AbstractDataLoaderResultModel::processed, and AbstractDataLoaderResultModel::raw.

Here is the call graph for this function:

headerTextOfCalculatedColumn()

QString QREDataLoaderResultModel::headerTextOfCalculatedColumn ( int  column ) const

overrideprotectedvirtual

Return the table header text for the given column. For convenience, column starts at 0 for first calculated column, therefore it is not the same as the "real" section in the table header.

Implements AbstractDataLoaderResultModel.

Definition at line 39 of file QREDataLoaderResultModel.cpp.

{
    switch (column) {
    case 0:
        return "Q [1/nm]";
    case 1:
        return "R";
    case 2:
        return "sigma_R";
    default:
        return "";
    }
}

lastSectionOfColumnType()

int AbstractDataLoaderResultModel::lastSectionOfColumnType ( ColumnType  type ) const

privateinherited

Calculates the last real header view section of the given column type. Returns -1 if the column type does not exist.

Definition at line 234 of file AbstractDataLoaderResultModel.cpp.

{
    const int firstSection = firstSectionOfColumnType(type);
    if (firstSection == -1)
        return -1;
 
    return firstSection + columnCount(type) - 1;
}

References AbstractDataLoaderResultModel::columnCount(), and AbstractDataLoaderResultModel::firstSectionOfColumnType().

Referenced by AbstractDataLoaderResultModel::columnType(), and AbstractDataLoaderResultModel::sectionsOfColumnType().

Here is the call graph for this function:

rowCount() [1/4]

int QREDataLoaderResultModel::rowCount ( ) const

overrideprotectedvirtual

The row count of the result table.

Implements AbstractDataLoaderResultModel.

Definition at line 27 of file QREDataLoaderResultModel.cpp.

{
    return m_importResult->lines.size();
}

References QREDataLoader::ImportResult::lines, and m_importResult.

rowCount() [2/4]

virtual int AbstractDataLoaderResultModel::rowCount

protected

The row count of the result table.

rowCount() [3/4]

int AbstractDataLoaderResultModel::rowCount ( const QModelIndex &  parent ) const

overrideinherited

Definition at line 58 of file AbstractDataLoaderResultModel.cpp.

{
    return parent.isValid() ? 0 : rowCount();
}

References AbstractDataLoaderResultModel::rowCount().

Here is the call graph for this function:

rowCount() [4/4]

int AbstractDataLoaderResultModel::rowCount

overrideprotected

Definition at line 33 of file AbstractDataLoaderResultModel.cpp.

{
    return parent.isValid() ? 0 : rowCount();
}

rowHasError() [1/4]

bool AbstractDataLoaderResultModel::rowHasError ( const QModelIndex &  index ) const

protectedvirtualinherited

Returns whether the row given in the index contains errors. Only override this for performance reasons.

Definition at line 248 of file AbstractDataLoaderResultModel.cpp.

{
    return rowHasError(index.row());
}

Referenced by AbstractDataLoaderResultModel::data().

rowHasError() [2/4]

bool AbstractDataLoaderResultModel::rowHasError

protected

Returns whether the row given in the index contains errors. Only override this for performance reasons.

Definition at line 50 of file AbstractDataLoaderResultModel.cpp.

{
    return rowHasError(index.row());
}

rowHasError() [3/4]

bool QREDataLoaderResultModel::rowHasError ( int  row ) const

overrideprotectedvirtual

Returns whether the row given in the index contains errors. Row counting starts with 0.

Implements AbstractDataLoaderResultModel.

Definition at line 22 of file QREDataLoaderResultModel.cpp.

{
    return m_importResult->calculationErrors.contains(row);
}

References QREDataLoader::ImportResult::calculationErrors, and m_importResult.

rowHasError() [4/4]

virtual bool AbstractDataLoaderResultModel::rowHasError

protected

Returns whether the row given in the index contains errors. Row counting starts with 0.

rowIsSkipped() [1/4]

bool AbstractDataLoaderResultModel::rowIsSkipped ( const QModelIndex &  index ) const

protectedvirtualinherited

Returns whether the row given in the index is a skipped row. Only override this for performance reasons.

Definition at line 243 of file AbstractDataLoaderResultModel.cpp.

{
    return rowIsSkipped(index.row());
}

Referenced by AbstractDataLoaderResultModel::data().

rowIsSkipped() [2/4]

bool AbstractDataLoaderResultModel::rowIsSkipped

protected

Returns whether the row given in the index is a skipped row. Only override this for performance reasons.

Definition at line 46 of file AbstractDataLoaderResultModel.cpp.

{
    return rowIsSkipped(index.row());
}

rowIsSkipped() [3/4]

bool QREDataLoaderResultModel::rowIsSkipped ( int  row ) const

overrideprotectedvirtual

Returns whether the row given in the index is a skipped row. Row counting starts with 0.

Implements AbstractDataLoaderResultModel.

Definition at line 32 of file QREDataLoaderResultModel.cpp.

{
    if (row >= 0 && row < m_importResult->lines.size())
        return m_importResult->lines[row].first;
    return false;
}

References QREDataLoader::ImportResult::lines, and m_importResult.

rowIsSkipped() [4/4]

virtual bool AbstractDataLoaderResultModel::rowIsSkipped

protected

Returns whether the row given in the index is a skipped row. Row counting starts with 0.

sectionsOfColumnType()

QVector< int > AbstractDataLoaderResultModel::sectionsOfColumnType ( ColumnType  type ) const

inherited

The table header sections which belong to the given column type. Empty if this column type is not present at all.

Definition at line 165 of file AbstractDataLoaderResultModel.cpp.

{
    QVector<int> sections;
    for (int section = firstSectionOfColumnType(type); section <= lastSectionOfColumnType(type);
         section++)
        if (section >= 0)
            sections << section;
 
    return sections;
}

References AbstractDataLoaderResultModel::firstSectionOfColumnType(), and AbstractDataLoaderResultModel::lastSectionOfColumnType().

Referenced by SpecularDataImportWidget::updatePreview().

Here is the call graph for this function:

Member Data Documentation

m_importResult

QREDataLoader::ImportResult* QREDataLoaderResultModel::m_importResult

private

Definition at line 39 of file QREDataLoaderResultModel.h.

Referenced by cellText(), columnCount(), rowCount(), rowHasError(), and rowIsSkipped().

m_warningIcon

QIcon AbstractDataLoaderResultModel::m_warningIcon

privateinherited

Definition at line 93 of file AbstractDataLoaderResultModel.h.

Referenced by AbstractDataLoaderResultModel::AbstractDataLoaderResultModel(), and AbstractDataLoaderResultModel::data().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/Loaders/QREDataLoaderResultModel.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/Loaders/QREDataLoaderResultModel.cpp