JobModel Class Reference

Description

Definition at line 27 of file JobModel.h.

Inheritance diagram for JobModel:

Collaboration diagram for JobModel:

Signals
void	focusRequest (JobItem *item)
void	globalProgress (int)

Public Member Functions
	JobModel (QObject *parent=nullptr)
	~JobModel () override
QVector< QString >	acceptableDefaultItemTypes (const QModelIndex &parent) const
JobItem *	addJob (const MultiLayerItem *sampleItem, const InstrumentItem *instrumentItem, const RealDataItem *realDataItem, const SimulationOptionsItem &optionItem)
	Main method to add a job. More...
void	cancelJob (JobItem *jobItem)
bool	canDropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) const override
void	clear () override
int	columnCount (const QModelIndex &parent) const override
SessionItem *	copy (const SessionItem *item_to_copy, SessionItem *new_parent=nullptr, const QString &tag="")
	Copy given item to the new_parent at given row. Item intended for copying can belong to another model and it will remain intact. Returns pointer to the new child. More...
template<typename T >
T *	copyItem (const T *item_to_copy, SessionItem *new_parent=nullptr, const QString &tag="")
void	createRootItem ()
QVariant	data (const QModelIndex &index, int role) const override
bool	dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) override
Qt::ItemFlags	flags (const QModelIndex &index) const override
JobItem *	getJobItemForIdentifier (const QString &identifier)
QString	getModelTag () const
bool	hasUnfinishedJobs ()
QVariant	headerData (int section, Qt::Orientation orientation, int role) const override
QModelIndex	index (int row, int column, const QModelIndex &parent) const override
QModelIndex	indexOfItem (SessionItem *item) const
virtual void	initFrom (SessionModel *model, SessionItem *parent)
template<typename T >
T *	insertItem (const QModelIndex &parent, int row=-1, QString tag="")
template<typename T >
T *	insertItem (SessionItem *parent=nullptr, int row=-1, QString tag="")
SessionItem *	insertNewItem (QString model_type, const QModelIndex &parent_item, int row=-1, QString tag="")
SessionItem *	insertNewItem (QString model_type, SessionItem *parent_item=nullptr, int row=-1, QString tag="")
SessionItem *	itemForIndex (const QModelIndex &index) const
QVector< JobItem * >	jobItems () const
QMimeData *	mimeData (const QModelIndexList &indices) const override
QStringList	mimeTypes () const override
SessionItem *	moveItem (SessionItem *item, SessionItem *new_parent=nullptr, int row=-1, const QString &tag="")
	Move given parameterized item to the new_parent at given row. If new_parent is not defined, use root_item as a new parent. More...
QVector< SessionItem * >	nonXMLItems () const override
QModelIndex	parent (const QModelIndex &child) const override
void	readFrom (QXmlStreamReader *reader, MessageService *messageService=nullptr) override
void	removeItem (SessionItem *item)
void	removeJob (JobItem *jobItem)
bool	removeRows (int row, int count, const QModelIndex &parent) override
void	restore (JobItem *jobItem)
	restore instrument and sample model from backup for given JobItem More...
SessionItem *	rootItem () const
int	rowCount (const QModelIndex &parent) const override
void	runJob (JobItem *jobItem)
bool	setData (const QModelIndex &index, const QVariant &value, int role) override
void	setDraggedItemType (const QString &type)
Qt::DropActions	supportedDragActions () const override
Qt::DropActions	supportedDropActions () const override
template<typename T = SessionItem>
T *	topItem () const
	Returns first item in list of topItems. More...
template<typename T = SessionItem>
QVector< T * >	topItems () const
template<typename T = SessionItem>
QVector< T * >	topItems (std::function< bool(const T &)> accept) const
virtual void	writeTo (QXmlStreamWriter *writer)

Protected Member Functions
void	setRootItem (SessionItem *root)

Private Member Functions
QString	generateJobName ()
	generates numbered job name with new/unused number More...

Private Attributes
QString	m_dragged_item_type
QString	m_model_tag
JobQueueData *	m_queue_data
SessionItem *	m_root_item

Constructor & Destructor Documentation

JobModel()

JobModel::JobModel ( QObject *  parent = nullptr )

explicit

Definition at line 28 of file JobModel.cpp.

    : SessionModel(GUI::Session::XML::JobModelTag, parent)
    , m_queue_data(nullptr)
{
    m_queue_data = new JobQueueData(this);
    connect(m_queue_data, &JobQueueData::focusRequest, this, &JobModel::focusRequest);
    connect(m_queue_data, &JobQueueData::globalProgress, this, &JobModel::globalProgress);
    setObjectName(GUI::Session::XML::JobModelTag);
}

References focusRequest(), JobQueueData::focusRequest(), globalProgress(), JobQueueData::globalProgress(), GUI::Session::XML::JobModelTag(), and m_queue_data.

Here is the call graph for this function:

~JobModel()

JobModel::~JobModel ( )

override

Definition at line 37 of file JobModel.cpp.

{
    delete m_queue_data;
}

References m_queue_data.

Member Function Documentation

acceptableDefaultItemTypes()

QVector< QString > SessionModel::acceptableDefaultItemTypes ( const QModelIndex &  parent ) const

inherited

Definition at line 310 of file SessionModel.cpp.

{
    QVector<QString> result;
    if (SessionItem* parent_item = itemForIndex(parent))
        result = parent_item->acceptableDefaultItemTypes();
 
    return result;
}

References SessionModel::itemForIndex(), and SessionModel::parent().

Referenced by SessionModel::canDropMimeData(), and SessionModel::flags().

Here is the call graph for this function:

addJob()

JobItem * JobModel::addJob	(	const MultiLayerItem *	sampleItem,
		const InstrumentItem *	instrumentItem,
		const RealDataItem *	realDataItem,
		const SimulationOptionsItem &	optionItem
	)

Main method to add a job.

Definition at line 52 of file JobModel.cpp.

{
    ASSERT(sampleItem);
    ASSERT(instrumentItem);
 
    auto* jobItem = insertItem<JobItem>();
    jobItem->setItemName(generateJobName());
    jobItem->setIdentifier(QUuid::createUuid().toString());
 
    jobItem->copySampleIntoJob(sampleItem);
    GUI::Model::JobFunctions::setupJobItemInstrument(jobItem, instrumentItem);
 
    jobItem->copySimulationOptionsIntoJob(optionItem);
 
    ParameterTreeBuilder(jobItem, true).build();
 
    GUI::Model::JobFunctions::setupJobItemOutput(jobItem);
 
    if (realDataItem)
        GUI::Model::JobFunctions::setupJobItemForFit(jobItem, realDataItem);
 
    return jobItem;
}

References ParameterTreeBuilder::build(), generateJobName(), GUI::Model::JobFunctions::setupJobItemForFit(), GUI::Model::JobFunctions::setupJobItemInstrument(), GUI::Model::JobFunctions::setupJobItemOutput(), and GUI::View::PropertyEditorFactory::toString().

Referenced by SimulationView::simulate().

Here is the call graph for this function:

cancelJob()

void JobModel::cancelJob

(

JobItem *

jobItem

)

Definition at line 147 of file JobModel.cpp.

{
    m_queue_data->cancelJob(jobItem->getIdentifier());
}

References JobQueueData::cancelJob(), JobItem::getIdentifier(), and m_queue_data.

Referenced by JobListModel::cancelJob().

Here is the call graph for this function:

canDropMimeData()

bool SessionModel::canDropMimeData ( const QMimeData *  data, Qt::DropAction  action, int  row, int  column, const QModelIndex &  parent  ) const

overrideinherited

Definition at line 213 of file SessionModel.cpp.

{
    Q_UNUSED(row);
 
    if (action == Qt::IgnoreAction)
        return true;
    if (action != Qt::MoveAction || column > 0 || !data
        || !data->hasFormat(GUI::Session::XML::ItemMimeType))
        return false;
    if (!parent.isValid())
        return true;
    QVector<QString> acceptable_child_items = acceptableDefaultItemTypes(parent);
    QByteArray xml_data = qUncompress(data->data(GUI::Session::XML::ItemMimeType));
    QXmlStreamReader reader(xml_data);
    while (!reader.atEnd()) {
        reader.readNext();
        if (reader.isStartElement()) {
            if (reader.name() == GUI::Session::XML::ItemTag) {
                const QString model_type =
                    reader.attributes().value(GUI::Session::XML::ModelTypeAttribute).toString();
                return acceptable_child_items.contains(model_type);
            }
        }
    }
    return false;
}

References SessionModel::acceptableDefaultItemTypes(), SessionModel::data(), GUI::Session::XML::ItemMimeType, GUI::Session::XML::ItemTag(), GUI::Session::XML::ModelTypeAttribute(), and SessionModel::parent().

Referenced by SessionModel::dropMimeData().

Here is the call graph for this function:

clear()

void JobModel::clear ( )

overridevirtual

Reimplemented from SessionModel.

Definition at line 100 of file JobModel.cpp.

{
    for (auto* job : jobItems())
        removeJob(job);
 
    SessionModel::clear();
}

References SessionModel::clear(), jobItems(), and removeJob().

Referenced by ApplicationModels::readFrom().

Here is the call graph for this function:

columnCount()

int SessionModel::columnCount ( const QModelIndex &  parent ) const

overrideinherited

Definition at line 134 of file SessionModel.cpp.

{
    if (parent.isValid() && parent.column() != 0)
        return 0;
    return SessionFlags::MAX_COLUMNS;
}

References SessionFlags::MAX_COLUMNS, and SessionModel::parent().

Referenced by SessionModel::data(), and SessionModel::index().

Here is the call graph for this function:

copy()

SessionItem * SessionModel::copy ( const SessionItem *  item_to_copy, SessionItem *  new_parent = nullptr, const QString &  tag = ""  )

inherited

Copy given item to the new_parent at given row. Item intended for copying can belong to another model and it will remain intact. Returns pointer to the new child.

Definition at line 395 of file SessionModel.cpp.

{
    if (!new_parent)
        new_parent = m_root_item;
 
    const QString tagName = tag.isEmpty() ? new_parent->defaultTag() : tag;
 
    QByteArray xml_data;
    QXmlStreamWriter writer(&xml_data);
    GUI::Session::XML::writeItemAndChildItems(&writer, item_to_copy);
 
    QXmlStreamReader reader(xml_data);
    GUI::Session::XML::readItems(&reader, new_parent, tagName);
 
    return new_parent->getItems(tagName).back();
}

References SessionItem::defaultTag(), SessionItem::getItems(), SessionModel::m_root_item, GUI::Session::XML::readItems(), and GUI::Session::XML::writeItemAndChildItems().

Referenced by SessionModel::copyItem().

Here is the call graph for this function:

copyItem()

template<typename T >

T * SessionModel::copyItem ( const T *  item_to_copy, SessionItem *  new_parent = nullptr, const QString &  tag = ""  )

inherited

Definition at line 149 of file SessionModel.h.

{
    return static_cast<T*>(copy(item_to_copy, new_parent, tag));
}

References SessionModel::copy().

Referenced by MaskItems::copy(), and JobItem::copyRealDataIntoJob().

Here is the call graph for this function:

createRootItem()

void SessionModel::createRootItem ( )

inherited

Definition at line 56 of file SessionModel.cpp.

{
    m_root_item = new SessionItem("ROOT_ITEM");
    m_root_item->setModel(this);
    m_root_item->registerTag("rootTag");
    m_root_item->setDefaultTag("rootTag");
}

References SessionModel::m_root_item, SessionItem::registerTag(), SessionModel::SessionItem, and SessionItem::setModel().

Referenced by SessionModel::SessionModel(), and SessionModel::clear().

Here is the call graph for this function:

data()

QVariant SessionModel::data ( const QModelIndex &  index, int  role  ) const

overrideinherited

Definition at line 88 of file SessionModel.cpp.

{
    ASSERT(m_root_item);
    if (!index.isValid() || index.column() < 0 || index.column() >= columnCount(QModelIndex()))
        return {};
    if (SessionItem* item = itemForIndex(index)) {
        if (role == Qt::DisplayRole || role == Qt::EditRole) {
            if (index.column() == SessionFlags::ITEM_VALUE)
                return item->value();
            if (index.column() == SessionFlags::ITEM_NAME)
                return item->itemName();
        } else if (role == Qt::ToolTipRole)
            return toolTipRole(*item, index.column());
        else if (role == Qt::ForegroundRole)
            return item->isEnabled() ? QVariant() : QColor(Qt::gray);
        else if (role == Qt::CheckStateRole && index.column() == SessionFlags::ITEM_VALUE) {
            if (item->value().type() == QVariant::Bool)
                return item->value().toBool() ? Qt::Checked : Qt::Unchecked;
        } else
            return item->roleProperty(role);
    }
    return {};
}

References SessionModel::columnCount(), SessionModel::index(), SessionFlags::ITEM_NAME, SessionFlags::ITEM_VALUE, SessionModel::itemForIndex(), SessionItem::itemName(), SessionModel::m_root_item, and SessionItem::value().

Referenced by SessionModel::canDropMimeData(), and SessionModel::dropMimeData().

Here is the call graph for this function:

dropMimeData()

bool SessionModel::dropMimeData ( const QMimeData *  data, Qt::DropAction  action, int  row, int  column, const QModelIndex &  parent  )

overrideinherited

Definition at line 241 of file SessionModel.cpp.

{
    if (action == Qt::IgnoreAction)
        return true;
    if (action != Qt::MoveAction || column > 0 || !data
        || !data->hasFormat(GUI::Session::XML::ItemMimeType))
        return false;
    if (!canDropMimeData(data, action, row, column, parent))
        return false;
    if (SessionItem* item = itemForIndex(parent)) {
        QByteArray xml_data = qUncompress(data->data(GUI::Session::XML::ItemMimeType));
        QXmlStreamReader reader(xml_data);
        if (row == -1)
            row = item->numberOfChildren();
        beginInsertRows(parent, row, row);
        // this code block is currently not in use. The row parameter of the reader is removed
        // SessionReader::readItems(&reader, item, row);
        endInsertRows();
        return true;
    }
    return false;
}

References SessionModel::canDropMimeData(), SessionModel::data(), SessionModel::itemForIndex(), GUI::Session::XML::ItemMimeType, SessionItem::numberOfChildren(), and SessionModel::parent().

Here is the call graph for this function:

flags()

Qt::ItemFlags SessionModel::flags ( const QModelIndex &  index ) const

overrideinherited

Definition at line 71 of file SessionModel.cpp.

{
    Qt::ItemFlags result_flags = QAbstractItemModel::flags(index);
    if (index.isValid()) {
        result_flags |= Qt::ItemIsSelectable | Qt::ItemIsEnabled | Qt::ItemIsDragEnabled;
        SessionItem* item = itemForIndex(index);
        if (index.column() == SessionFlags::ITEM_VALUE && item->value().isValid()
            && item->isEditable() && item->isEnabled())
            result_flags |= Qt::ItemIsEditable;
        QVector<QString> acceptable_child_items = acceptableDefaultItemTypes(index);
        if (acceptable_child_items.contains(m_dragged_item_type))
            result_flags |= Qt::ItemIsDropEnabled;
    } else
        result_flags |= Qt::ItemIsDropEnabled;
    return result_flags;
}

References SessionModel::acceptableDefaultItemTypes(), SessionModel::index(), SessionItem::isEditable(), SessionItem::isEnabled(), SessionFlags::ITEM_VALUE, SessionModel::itemForIndex(), SessionModel::m_dragged_item_type, and SessionItem::value().

Here is the call graph for this function:

focusRequest

void JobModel::focusRequest ( JobItem *  item )

signal

Referenced by JobModel(), and JobView::connectJobRelated().

generateJobName()

QString JobModel::generateJobName ( )

private

generates numbered job name with new/unused number

Definition at line 160 of file JobModel.cpp.

{
    int maxJobIndex = 0;
    for (const auto* jobItem : jobItems()) {
        if (jobItem->itemName().startsWith("job"))
            maxJobIndex = std::max(maxJobIndex, jobItem->itemName().mid(3).toInt());
    }
    return QString("job%1").arg(maxJobIndex + 1);
}

References jobItems().

Referenced by addJob().

Here is the call graph for this function:

getJobItemForIdentifier()

JobItem * JobModel::getJobItemForIdentifier

(

const QString &

identifier

)

Definition at line 42 of file JobModel.cpp.

{
    for (auto* jobItem : jobItems())
        if (jobItem->getIdentifier() == identifier)
            return jobItem;
 
    return nullptr;
}

References jobItems().

Referenced by JobQueueData::onFinishedJob(), JobQueueData::onProgressUpdate(), and JobQueueData::onStartedJob().

Here is the call graph for this function:

getModelTag()

QString SessionModel::getModelTag ( ) const

inlineinherited

Definition at line 202 of file SessionModel.h.

{
    return m_model_tag;
}

References SessionModel::m_model_tag.

Referenced by ApplicationModels::readFrom(), GUI::Session::XML::readItems(), and GUI::Session::XML::writeModel().

globalProgress

void JobModel::globalProgress ( int  )

signal

Referenced by JobModel(), and JobProgressAssistant::JobProgressAssistant().

hasUnfinishedJobs()

bool JobModel::hasUnfinishedJobs

(

)

Definition at line 88 of file JobModel.cpp.

{
    if (m_queue_data->hasUnfinishedJobs())
        return true;
 
    for (auto* jobItem : jobItems())
        if (jobItem->getStatus() == JobStatus::Fitting)
            return true;
 
    return false;
}

References Fitting, JobQueueData::hasUnfinishedJobs(), jobItems(), and m_queue_data.

Here is the call graph for this function:

headerData()

QVariant SessionModel::headerData ( int  section, Qt::Orientation  orientation, int  role  ) const

overrideinherited

Definition at line 112 of file SessionModel.cpp.

{
    if (orientation != Qt::Horizontal || role != Qt::DisplayRole)
        return {};
    switch (section) {
    case SessionFlags::ITEM_NAME:
        return "Name";
    case SessionFlags::ITEM_VALUE:
        return "Value";
    default:
        return {};
    }
}

References SessionFlags::ITEM_NAME, and SessionFlags::ITEM_VALUE.

index()

QModelIndex SessionModel::index ( int  row, int  column, const QModelIndex &  parent  ) const

overrideinherited

Definition at line 141 of file SessionModel.cpp.

{
    ASSERT(m_root_item);
    if (row < 0 || column < 0 || column >= columnCount(QModelIndex())
        || (parent.isValid() && parent.column() != 0))
        return QModelIndex();
 
    SessionItem* parent_item = itemForIndex(parent);
 
    if (SessionItem* item = parent_item->childAt(row))
        return createIndex(row, column, item);
    return QModelIndex();
}

References SessionItem::childAt(), SessionModel::columnCount(), SessionModel::itemForIndex(), SessionModel::m_root_item, and SessionModel::parent().

Referenced by MaskResultsPresenter::createMaskPresentation(), SessionModel::data(), MaskGraphicsScene::deleteViews(), SessionModel::flags(), MaskItems::insertMask(), GUI::Model::Path::isValidItem(), SessionModel::itemForIndex(), ModelMapper::onBeginRemoveRows(), ModelMapper::onRowRemoved(), MaskGraphicsScene::onRowsAboutToBeRemoved(), ItemStackWidget::onRowsAboutToBeRemoved(), ModelMapper::onRowsInserted(), SessionModel::removeItem(), SessionModel::setData(), MaskGraphicsScene::setItemName(), MaskGraphicsScene::setZValues(), SessionModel::topItems(), and MaskGraphicsScene::updateViews().

Here is the call graph for this function:

indexOfItem()

QModelIndex SessionModel::indexOfItem ( SessionItem *  item ) const

inherited

Definition at line 265 of file SessionModel.cpp.

{
    if (!item || item == m_root_item || !item->parentItem())
        return QModelIndex();
    SessionItem* parent_item = item->parentItem();
    int row = parent_item->rowOfChild(item);
    return createIndex(row, 0, item);
}

References SessionModel::m_root_item, SessionItem::parentItem(), and SessionItem::rowOfChild().

Referenced by MaskGraphicsScene::cancelCurrentDrawing(), MaskEditorActions::changeMaskStackingOrder(), SessionItem::emitDataChanged(), SessionItem::index(), MaskGraphicsScene::onSceneSelectionChanged(), MaskGraphicsScene::onSessionSelectionChanged(), MaskGraphicsScene::processLineItem(), MaskGraphicsScene::processPolygonItem(), and SessionModel::removeItem().

Here is the call graph for this function:

initFrom()

void SessionModel::initFrom ( SessionModel *  model, SessionItem *  parent  )

virtualinherited

Definition at line 413 of file SessionModel.cpp.

{
    QByteArray byte_array;
    QXmlStreamWriter writer(&byte_array);
    writer.setAutoFormatting(true);
 
    model->writeTo(&writer);
 
    QXmlStreamReader reader(byte_array);
 
    while (!reader.atEnd()) {
        reader.readNext();
        if (reader.isStartElement())
            readFrom(&reader);
    }
}

References SessionModel::readFrom(), and SessionModel::writeTo().

Here is the call graph for this function:

insertItem() [1/2]

template<typename T >

T * SessionModel::insertItem ( const QModelIndex &  parent, int  row = -1, QString  tag = ""  )

inherited

Definition at line 143 of file SessionModel.h.

{
    return insertItem<T>(itemForIndex(parent), row, tag);
}

References SessionModel::itemForIndex(), and SessionModel::parent().

Here is the call graph for this function:

insertItem() [2/2]

template<typename T >

T * SessionModel::insertItem ( SessionItem *  parent = nullptr, int  row = -1, QString  tag = ""  )

inherited

Definition at line 137 of file SessionModel.h.

{
    return dynamic_cast<T*>(insertNewItem(T().modelType(), parent, row, tag));
}

References SessionModel::insertNewItem(), SessionItem::modelType(), and SessionModel::parent().

Referenced by IntensityDataFFTPresenter::IntensityDataFFTPresenter(), FitParameterItem::addLink(), JobItem::createDataViewItem(), FitComparison1DViewController::createDiffViewItem(), FitParameterContainerItem::createFitParameter(), FitSuiteItem::createFitParametersContainer(), JobItem::createFitSuiteItem(), FitSuiteItem::createMinimizerContainer(), Data1DViewItem::createPropertyContainerItem(), JobItem::createRealDataItem(), IntensityDataItem::getOrCreateMaskContainerItem(), IntensityDataItem::getOrCreateProjectionContainerItem(), RealDataItem::initDataItem(), ProjectionsEditorCanvas::onEnteringColorMap(), MaskGraphicsScene::processHorizontalLineItem(), MaskGraphicsScene::processMaskAllItem(), MaskGraphicsScene::processPolygonItem(), MaskGraphicsScene::processVerticalLineItem(), and JobItem::setDataType().

Here is the call graph for this function:

insertNewItem() [1/2]

SessionItem * SessionModel::insertNewItem ( QString  model_type, const QModelIndex &  parent_item, int  row = -1, QString  tag = ""  )

inherited

Definition at line 297 of file SessionModel.cpp.

{
    return insertNewItem(model_type, itemForIndex(parent_item), row, tag);
}

References SessionModel::insertNewItem(), and SessionModel::itemForIndex().

Here is the call graph for this function:

insertNewItem() [2/2]

SessionItem * SessionModel::insertNewItem ( QString  model_type, SessionItem *  parent_item = nullptr, int  row = -1, QString  tag = ""  )

inherited

Definition at line 274 of file SessionModel.cpp.

{
    ASSERT(m_root_item);
    if (!parent_item)
        parent_item = m_root_item;
    if (row > parent_item->numberOfChildren())
        return nullptr;
    if (parent_item != m_root_item) {
        if (tag.isEmpty())
            tag = parent_item->defaultTag();
        if (!parent_item->sessionItemTags()->isValid(tag, model_type))
            return nullptr;
    }
 
    SessionItem* new_item = GUI::Model::ItemFactory::CreateItem(model_type);
    ASSERT(new_item);
 
    parent_item->insertChild(row, new_item, tag);
 
    return new_item;
}

References GUI::Model::ItemFactory::CreateItem(), SessionItem::defaultTag(), SessionItem::insertChild(), SessionItemTags::isValid(), SessionModel::m_root_item, SessionItem::numberOfChildren(), and SessionItem::sessionItemTags().

Referenced by SessionModel::insertItem(), SessionModel::insertNewItem(), and MaskGraphicsScene::processRectangleShapeItem().

Here is the call graph for this function:

itemForIndex()

SessionItem * SessionModel::itemForIndex ( const QModelIndex &  index ) const

inherited

Definition at line 327 of file SessionModel.cpp.

{
    if (index.isValid())
        if (auto* item = static_cast<SessionItem*>(index.internalPointer()))
            return item;
 
    return m_root_item;
}

References SessionModel::index(), and SessionModel::m_root_item.

Referenced by SessionModel::acceptableDefaultItemTypes(), MaskEditorActions::changeMaskStackingOrder(), MaskResultsPresenter::createMaskPresentation(), SessionModel::data(), DataProperties::dataItem(), MaskGraphicsScene::deleteViews(), SessionModel::dropMimeData(), SessionModel::flags(), SessionModel::index(), SessionModel::insertItem(), SessionModel::insertNewItem(), MaskEditorActions::isSendToBackPossible(), GUI::Model::Path::isValidItem(), MaskEditorPropertyPanel::maskItemForIndex(), SessionModel::mimeData(), ModelMapper::onBeginRemoveRows(), ModelMapper::onDataChanged(), ModelMapper::onRowRemoved(), ItemStackWidget::onRowsAboutToBeRemoved(), ModelMapper::onRowsInserted(), FitParameterModel::onSourceDataChanged(), MaskEditorActions::onToggleMaskValueAction(), SessionModel::parent(), SessionModel::removeRows(), SessionModel::rowCount(), SessionModel::setData(), MaskGraphicsScene::setItemName(), MaskEditor::setMaskContext(), MaskGraphicsScene::setMaskContext(), MaskGraphicsScene::setZValues(), SessionDecorationModel::textColor(), SessionModel::topItems(), MaskGraphicsScene::updateScene(), and MaskGraphicsScene::updateViews().

Here is the call graph for this function:

jobItems()

QVector< JobItem * > JobModel::jobItems

(

)

const

Definition at line 77 of file JobModel.cpp.

{
    return topItems<JobItem>();
}

Referenced by JobListModel::JobListModel(), JobListModel::~JobListModel(), clear(), JobListModel::data(), JobListModel::emitJobListModelChanged(), generateJobName(), getJobItemForIdentifier(), hasUnfinishedJobs(), JobListModel::indexForJob(), JobListModel::jobForIndex(), JobListModel::onRowsInserted(), readFrom(), JobListModel::rowCount(), and JobQueueData::updateGlobalProgress().

mimeData()

QMimeData * SessionModel::mimeData ( const QModelIndexList &  indices ) const

overrideinherited

Definition at line 197 of file SessionModel.cpp.

{
    if (indices.count() != 2)
        return nullptr;
 
    if (SessionItem* item = itemForIndex(indices.at(0))) {
        auto* mime_data = new QMimeData;
        QByteArray xml_data;
        QXmlStreamWriter writer(&xml_data);
        GUI::Session::XML::writeItemAndChildItems(&writer, item);
        mime_data->setData(GUI::Session::XML::ItemMimeType, qCompress(xml_data, MaxCompression));
        return mime_data;
    }
    return nullptr;
}

References SessionModel::itemForIndex(), GUI::Session::XML::ItemMimeType, and GUI::Session::XML::writeItemAndChildItems().

Here is the call graph for this function:

mimeTypes()

QStringList SessionModel::mimeTypes ( ) const

overrideinherited

Definition at line 192 of file SessionModel.cpp.

{
    return QStringList() << GUI::Session::XML::ItemMimeType;
}

References GUI::Session::XML::ItemMimeType.

moveItem()

SessionItem * SessionModel::moveItem ( SessionItem *  item, SessionItem *  new_parent = nullptr, int  row = -1, const QString &  tag = ""  )

inherited

Move given parameterized item to the new_parent at given row. If new_parent is not defined, use root_item as a new parent.

Definition at line 360 of file SessionModel.cpp.

{
    if (!new_parent)
        new_parent = m_root_item;
 
    const QString tagName = tag.isEmpty() ? new_parent->defaultTag() : tag;
 
    if (!new_parent->sessionItemTags()->isValid(tagName, item->modelType()))
        return nullptr;
 
    if (item->parentItem() == new_parent) {
        // take care of indexes when moving item within same parent
        int previousIndex = item->parentItem()->getItems(tagName).indexOf(item);
        if (row == previousIndex)
            return item;
        if (previousIndex >= 0 && row > previousIndex)
            row--;
    }
 
    if (new_parent->sessionItemTags()->maximumReached(tagName)) {
        SessionItem* prev = new_parent->takeItem(0, tagName);
        m_root_item->insertChild(-1, prev);
    }
 
    // removing item from previous parent and inserting to the new one
    item->parentItem()->takeRow(item->parentItem()->rowOfChild(item));
    new_parent->insertChild(row, item, tagName);
 
    return item;
}

References SessionItem::defaultTag(), SessionItem::getItems(), SessionItem::insertChild(), SessionItemTags::isValid(), SessionModel::m_root_item, SessionItemTags::maximumReached(), SessionItem::modelType(), SessionItem::parentItem(), SessionItem::rowOfChild(), SessionItem::sessionItemTags(), SessionItem::takeItem(), and SessionItem::takeRow().

Referenced by MaskEditorActions::changeMaskStackingOrder().

Here is the call graph for this function:

nonXMLItems()

QVector< SessionItem * > JobModel::nonXMLItems ( ) const

overridevirtual

Reimplemented from SessionModel.

Definition at line 108 of file JobModel.cpp.

{
    QVector<SessionItem*> result;
 
    for (auto* jobItem : topItems<JobItem>()) {
        if (auto* intensityItem = jobItem->dataItem())
            result.push_back(intensityItem);
 
        if (auto* real_data = dynamic_cast<RealDataItem*>(jobItem->realDataItem())) {
            if (auto* data_item = real_data->dataItem())
                result.push_back(data_item);
            if (auto* native_data = real_data->nativeData())
                result.push_back(native_data);
        }
    }
 
    return result;
}

Referenced by ApplicationModels::nonXMLItems().

parent()

QModelIndex SessionModel::parent ( const QModelIndex &  child ) const

overrideinherited

Definition at line 155 of file SessionModel.cpp.

{
    if (!child.isValid())
        return QModelIndex();
 
    if (SessionItem* child_item = itemForIndex(child)) {
        if (SessionItem* parent_item = child_item->parentItem()) {
            if (parent_item == m_root_item)
                return QModelIndex();
            return createIndex(parent_item->parentRow(), 0, parent_item);
        }
    }
    return QModelIndex();
}

References SessionModel::itemForIndex(), SessionModel::m_root_item, and SessionItem::parentItem().

Referenced by SessionModel::acceptableDefaultItemTypes(), SessionModel::canDropMimeData(), SessionModel::columnCount(), SessionModel::dropMimeData(), SessionModel::index(), SessionModel::insertItem(), RealDataModel::onRowsChange(), SessionModel::removeRows(), and SessionModel::rowCount().

Here is the call graph for this function:

readFrom()

void JobModel::readFrom ( QXmlStreamReader *  reader, MessageService *  messageService = nullptr  )

overridevirtual

Reimplemented from SessionModel.

Definition at line 127 of file JobModel.cpp.

{
    SessionModel::readFrom(reader, messageService);
 
    // Set & check instrument links. JobItem and realDataItem have to reference the same instrument
    // (which is the one contained in this job item, not contained in the instrument model)
    for (auto* jobItem : jobItems()) {
        if (RealDataItem* refItem = jobItem->realDataItem())
            refItem->linkToInstrument(jobItem->instrumentItem());
 
        // Create the not stored parameter tuning tree
        ParameterTreeBuilder(jobItem, false).build();
    }
}

References ParameterTreeBuilder::build(), jobItems(), and SessionModel::readFrom().

Referenced by ApplicationModels::readFrom().

Here is the call graph for this function:

removeItem()

void SessionModel::removeItem ( SessionItem *  item )

inherited

Definition at line 303 of file SessionModel.cpp.

{
    QModelIndex index = indexOfItem(item);
    if (index.isValid())
        removeRows(index.row(), 1, index.parent());
}

References SessionModel::index(), SessionModel::indexOfItem(), and SessionModel::removeRows().

Here is the call graph for this function:

removeJob()

void JobModel::removeJob

(

JobItem *

jobItem

)

Definition at line 152 of file JobModel.cpp.

{
    ASSERT(jobItem);
    m_queue_data->removeJob(jobItem->getIdentifier());
 
    removeRows(jobItem->index().row(), 1, QModelIndex());
}

References JobItem::getIdentifier(), SessionItem::index(), m_queue_data, JobQueueData::removeJob(), and SessionModel::removeRows().

Referenced by clear(), and JobListModel::removeJob().

Here is the call graph for this function:

removeRows()

bool SessionModel::removeRows ( int  row, int  count, const QModelIndex &  parent  )

overrideinherited

Definition at line 183 of file SessionModel.cpp.

{
    ASSERT(m_root_item);
    SessionItem* item = parent.isValid() ? itemForIndex(parent) : m_root_item;
    for (int i = 0; i < count; ++i)
        delete item->takeRow(row);
    return true;
}

References SessionModel::itemForIndex(), SessionModel::m_root_item, SessionModel::parent(), and SessionItem::takeRow().

Referenced by MaskGraphicsScene::cancelCurrentDrawing(), MaskContainerItem::clear(), ProjectionsEditorActions::onDeleteAction(), MaskEditorActions::onDeleteMaskAction(), SessionModel::removeItem(), and removeJob().

Here is the call graph for this function:

restore()

void JobModel::restore

(

JobItem *

jobItem

)

restore instrument and sample model from backup for given JobItem

Definition at line 83 of file JobModel.cpp.

{
    jobItem->parameterContainerItem()->restoreBackupValues();
}

References JobItem::parameterContainerItem(), and ParameterContainerItem::restoreBackupValues().

Referenced by ParameterTuningWidget::restoreModelsOfCurrentJobItem().

Here is the call graph for this function:

rootItem()

SessionItem * SessionModel::rootItem ( ) const

inherited

Definition at line 430 of file SessionModel.cpp.

{
    ASSERT(m_root_item);
    return m_root_item;
}

References SessionModel::m_root_item.

Referenced by ModelMapper::nestlingDepth().

rowCount()

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

overrideinherited

Definition at line 126 of file SessionModel.cpp.

{
    if (parent.isValid() && parent.column() != 0)
        return 0;
    SessionItem* parent_item = itemForIndex(parent);
    return parent_item ? parent_item->numberOfChildren() : 0;
}

References SessionModel::itemForIndex(), SessionItem::numberOfChildren(), and SessionModel::parent().

Referenced by MaskResultsPresenter::createMaskPresentation(), MaskGraphicsScene::deleteViews(), GUI::Model::Path::isValidItem(), MaskGraphicsScene::setItemName(), MaskGraphicsScene::setZValues(), SessionModel::topItems(), and MaskGraphicsScene::updateViews().

Here is the call graph for this function:

runJob()

void JobModel::runJob

(

JobItem *

jobItem

)

Definition at line 142 of file JobModel.cpp.

{
    m_queue_data->runJob(jobItem);
}

References m_queue_data, and JobQueueData::runJob().

Referenced by ParameterTuningWidget::onCurrentLinkChanged(), ParameterTuningWidget::restoreModelsOfCurrentJobItem(), JobListModel::runJob(), and SimulationView::simulate().

Here is the call graph for this function:

setData()

bool SessionModel::setData ( const QModelIndex &  index, const QVariant &  value, int  role  )

overrideinherited

Definition at line 170 of file SessionModel.cpp.

{
    if (!index.isValid())
        return false;
 
    QModelIndex dataIndex = index;
    if (SessionItem* item = itemForIndex(dataIndex))
        if (item->setRoleProperty(role, value))
            return true;
 
    return false;
}

References SessionModel::index(), SessionModel::itemForIndex(), and SessionItem::setRoleProperty().

Here is the call graph for this function:

setDraggedItemType()

void SessionModel::setDraggedItemType ( const QString &  type )

inlineinherited

Definition at line 207 of file SessionModel.h.

{
    m_dragged_item_type = type;
}

References SessionModel::m_dragged_item_type.

setRootItem()

void SessionModel::setRootItem ( SessionItem *  root )

inlineprotectedinherited

Definition at line 128 of file SessionModel.h.

{ m_root_item = root; }

References SessionModel::m_root_item.

supportedDragActions()

Qt::DropActions SessionModel::supportedDragActions ( ) const

inlineoverrideinherited

Definition at line 192 of file SessionModel.h.

{
    return Qt::MoveAction;
}

supportedDropActions()

Qt::DropActions SessionModel::supportedDropActions ( ) const

inlineoverrideinherited

Definition at line 197 of file SessionModel.h.

{
    return Qt::MoveAction;
}

topItem()

template<typename T >

T * SessionModel::topItem

inherited

Returns first item in list of topItems.

Definition at line 155 of file SessionModel.h.

{
    auto items = topItems<T>();
    return items.isEmpty() ? nullptr : items.front();
}

References SessionItem::items().

Here is the call graph for this function:

topItems() [1/2]

template<typename T >

QVector< T * > SessionModel::topItems

inherited

Definition at line 162 of file SessionModel.h.

{
    QVector<T*> result;
 
    QModelIndex parentIndex;
    for (int i_row = 0; i_row < rowCount(parentIndex); ++i_row) {
        QModelIndex itemIndex = index(i_row, 0, parentIndex);
        if (auto item = dynamic_cast<T*>(itemForIndex(itemIndex)))
            result.push_back(item);
    }
 
    return result;
}

References SessionModel::index(), SessionItem::item(), SessionModel::itemForIndex(), and SessionModel::rowCount().

Here is the call graph for this function:

topItems() [2/2]

template<typename T >

QVector< T * > SessionModel::topItems ( std::function< bool(const T &)>  accept ) const

inherited

Definition at line 177 of file SessionModel.h.

{
    QVector<T*> result;
 
    QModelIndex parentIndex;
    for (int i_row = 0; i_row < rowCount(parentIndex); ++i_row) {
        QModelIndex itemIndex = index(i_row, 0, parentIndex);
        if (auto item = dynamic_cast<T*>(itemForIndex(itemIndex)))
            if (accept(*item))
                result.push_back(item);
    }
 
    return result;
}

References SessionModel::index(), SessionItem::item(), SessionModel::itemForIndex(), and SessionModel::rowCount().

Here is the call graph for this function:

writeTo()

void SessionModel::writeTo ( QXmlStreamWriter *  writer )

virtualinherited

Definition at line 352 of file SessionModel.cpp.

{
    GUI::Session::XML::writeModel(writer, m_root_item);
}

References SessionModel::m_root_item, and GUI::Session::XML::writeModel().

Referenced by SessionModel::initFrom(), and ApplicationModels::writeTo().

Here is the call graph for this function:

Member Data Documentation

m_dragged_item_type

QString SessionModel::m_dragged_item_type

privateinherited

Definition at line 132 of file SessionModel.h.

Referenced by SessionModel::flags(), and SessionModel::setDraggedItemType().

m_model_tag

QString SessionModel::m_model_tag

privateinherited

Definition at line 133 of file SessionModel.h.

Referenced by SessionModel::getModelTag(), and SessionModel::readFrom().

m_queue_data

JobQueueData* JobModel::m_queue_data

private

Definition at line 60 of file JobModel.h.

Referenced by JobModel(), ~JobModel(), cancelJob(), hasUnfinishedJobs(), removeJob(), and runJob().

m_root_item

SessionItem* SessionModel::m_root_item

privateinherited

Definition at line 131 of file SessionModel.h.

Referenced by SessionModel::~SessionModel(), SessionModel::clear(), SessionModel::copy(), SessionModel::createRootItem(), SessionModel::data(), SessionModel::index(), SessionModel::indexOfItem(), SessionModel::insertNewItem(), SessionModel::itemForIndex(), SessionModel::moveItem(), SessionModel::parent(), SessionModel::readFrom(), SessionModel::removeRows(), SessionModel::rootItem(), SessionModel::setRootItem(), and SessionModel::writeTo().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Model/Model/JobModel.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Model/Model/JobModel.cpp