AutomaticDataLoader1DResultModel Class Reference

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

Inheritance diagram for AutomaticDataLoader1DResultModel:

Collaboration diagram for AutomaticDataLoader1DResultModel:

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

Public Member Functions
	AutomaticDataLoader1DResultModel (RealDataItem *item)
virtual int	columnCount (const QModelIndex &parent=QModelIndex()) const override
virtual QVariant	data (const QModelIndex &index, int role=Qt::DisplayRole) const override
virtual QVariant	headerData (int section, Qt::Orientation orientation, int role=Qt::DisplayRole) const override
virtual int	rowCount (const QModelIndex &parent) const override
QVector< int >	sectionsOfColumnType (ColumnType type) const
	The table header sections which belong to the given column type. More...

Protected Member Functions
virtual QString	cellText (ColumnType type, int row, int col) const override
	The text of the given cell. More...
virtual int	columnCount (ColumnType type) const override
	The number of existing columns related to the given column type. More...
virtual QString	headerTextOfCalculatedColumn (int column) const override
	Return the table header text for the given column. More...
virtual int	rowCount () const override
	The row count of the result table. More...
virtual bool	rowHasError (const QModelIndex &index) const
	Returns whether the row given in the index contains errors. More...
virtual bool	rowHasError (int row) const override
	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. More...
virtual bool	rowIsSkipped (int row) const override
	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. More...
int	lastSectionOfColumnType (ColumnType type) const
	Calculates the last real header view section of the given column type. More...

Private Attributes
RealDataItem *	m_item
QIcon	m_warningIcon

Detailed Description

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

Definition at line 23 of file AutomaticDataLoader1DResultModel.h.

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

AutomaticDataLoader1DResultModel()

AutomaticDataLoader1DResultModel::AutomaticDataLoader1DResultModel

(

RealDataItem *

item

)

Definition at line 19 of file AutomaticDataLoader1DResultModel.cpp.

    : m_item(item)
{
}

Member Function Documentation

cellText()

QString AutomaticDataLoader1DResultModel::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 59 of file AutomaticDataLoader1DResultModel.cpp.

{
    if (col < 0 || row < 0 || row >= rowCount() || type != ColumnType::processed)
        return QString();
 
    auto data = m_item->specularDataItem()->getOutputData();
 
    if (col == 0)
        return QString::number(data->getAxisValue(row, 0));
 
    if (col == 1)
        return QString::number(data->operator[](row));
 
    return QString();
}

References AbstractDataLoaderResultModel::data(), DataItem::getOutputData(), m_item, AbstractDataLoaderResultModel::processed, rowCount(), and RealDataItem::specularDataItem().

Here is the call graph for this function:

columnCount() [1/2]

int AutomaticDataLoader1DResultModel::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 54 of file AutomaticDataLoader1DResultModel.cpp.

{
    return (type == ColumnType::processed) ? 2 : 0;
}

References AbstractDataLoaderResultModel::processed.

columnCount() [2/2]

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

overridevirtualinherited

Definition at line 42 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;
}

References AbstractDataLoaderResultModel::error, AbstractDataLoaderResultModel::fileContent, AbstractDataLoaderResultModel::line, AbstractDataLoaderResultModel::processed, and AbstractDataLoaderResultModel::raw.

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

columnType() [1/2]

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

privateinherited

Calculates the column type of the given index.

Definition at line 193 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 175 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

overridevirtualinherited

Definition at line 62 of file AbstractDataLoaderResultModel.cpp.

{
    if (!index.isValid())
        return QVariant();
 
    const auto colType = columnType(index);
 
    if (role == Qt::BackgroundRole) {
        switch (colType) {
        case ColumnType::line:
            return Palette::backgroundColorFileContent;
        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));
        }
 
        case ColumnType::processed: {
            if (!rowIsSkipped(index) && !rowHasError(index))
                return cellText(colType, index.row(),
                                index.column() - firstSectionOfColumnType(colType));
        }
        }
 
        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(), SessionItemUtils::DecorationRole(), AbstractDataLoaderResultModel::error, AbstractDataLoaderResultModel::fileContent, AbstractDataLoaderResultModel::firstSectionOfColumnType(), SessionItemUtils::ForegroundRole(), AbstractDataLoaderResultModel::line, AbstractDataLoaderResultModel::m_warningIcon, AbstractDataLoaderResultModel::processed, AbstractDataLoaderResultModel::raw, AbstractDataLoaderResultModel::rowHasError(), AbstractDataLoaderResultModel::rowIsSkipped(), and SessionItemUtils::ToolTipRole().

Referenced by cellText(), and 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 198 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

overridevirtualinherited

Definition at line 138 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 AutomaticDataLoader1DResultModel::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 43 of file AutomaticDataLoader1DResultModel.cpp.

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

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 232 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/2]

int AutomaticDataLoader1DResultModel::rowCount ( ) const

overrideprotectedvirtual

The row count of the result table.

Implements AbstractDataLoaderResultModel.

Definition at line 29 of file AutomaticDataLoader1DResultModel.cpp.

{
    auto data = m_item->specularDataItem()->getOutputData();
    if (!data)
        return 0;
 
    return int(data->getAllocatedSize());
}

References AbstractDataLoaderResultModel::data(), DataItem::getOutputData(), m_item, and RealDataItem::specularDataItem().

Referenced by cellText().

Here is the call graph for this function:

rowCount() [2/2]

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

overridevirtualinherited

Definition at line 57 of file AbstractDataLoaderResultModel.cpp.

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

References AbstractDataLoaderResultModel::rowCount().

Here is the call graph for this function:

rowHasError() [1/2]

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 246 of file AbstractDataLoaderResultModel.cpp.

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

Referenced by AbstractDataLoaderResultModel::data().

rowHasError() [2/2]

bool AutomaticDataLoader1DResultModel::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 24 of file AutomaticDataLoader1DResultModel.cpp.

{
    return false;
}

rowIsSkipped() [1/2]

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 241 of file AbstractDataLoaderResultModel.cpp.

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

Referenced by AbstractDataLoaderResultModel::data().

rowIsSkipped() [2/2]

bool AutomaticDataLoader1DResultModel::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 38 of file AutomaticDataLoader1DResultModel.cpp.

{
    return false;
}

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 163 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_item

RealDataItem* AutomaticDataLoader1DResultModel::m_item

private

Definition at line 36 of file AutomaticDataLoader1DResultModel.h.

Referenced by cellText(), and rowCount().

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/www/ba/GUI/coregui/DataLoaders/AutomaticDataLoader1DResultModel.h
• /home/www/ba/GUI/coregui/DataLoaders/AutomaticDataLoader1DResultModel.cpp