DocumentModel Class Reference

The DocumentModel class is a model with GUI settings related to the opened project. More...

Inheritance diagram for DocumentModel:

Collaboration diagram for DocumentModel:

Signals
void	modelLoaded ()

Public Member Functions
	DocumentModel (QObject *parent=nullptr)
QVector< QString >	acceptableDefaultItemTypes (const QModelIndex &parent) const
virtual bool	canDropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) const
virtual void	clear ()
virtual int	columnCount (const QModelIndex &parent) const
template<typename T >
T *	copyItem (const T *item_to_copy, SessionItem *new_parent=0, const QString &tag="")
virtual SessionModel *	createCopy (SessionItem *parent=0)
void	createRootItem ()
virtual QVariant	data (const QModelIndex &index, int role) const
virtual bool	dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent)
virtual Qt::ItemFlags	flags (const QModelIndex &index) const
QString	getModelName () const
QString	getModelTag () const
virtual QVariant	headerData (int section, Qt::Orientation orientation, int role) const
virtual QModelIndex	index (int row, int column, const QModelIndex &parent) const
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
void	load (const QString &filename="")
virtual QMimeData *	mimeData (const QModelIndexList &indexes) const
virtual QStringList	mimeTypes () const
SessionItem *	moveItem (SessionItem *item, SessionItem *new_parent=0, int row=-1, const QString &tag="")
	Move given parameterized item to the new_parent at given row. More...
virtual QVector< SessionItem * >	nonXMLItems () const
virtual QModelIndex	parent (const QModelIndex &child) const
virtual void	readFrom (QXmlStreamReader *reader, MessageService *messageService=0)
void	removeItem (SessionItem *item)
virtual bool	removeRows (int row, int count, const QModelIndex &parent)
SessionItem *	rootItem () const
virtual int	rowCount (const QModelIndex &parent) const
void	save (const QString &filename="")
virtual bool	setData (const QModelIndex &index, const QVariant &value, int role)
void	setDraggedItemType (const QString &type)
virtual bool	setHeaderData (int, Qt::Orientation, const QVariant &, int=Qt::EditRole)
SimulationOptionsItem *	simulationOptionsItem ()
virtual Qt::DropActions	supportedDragActions () const
virtual Qt::DropActions	supportedDropActions () const
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, SessionItem *parent=0)

Protected Member Functions
void	setRootItem (SessionItem *root)

Private Member Functions
SessionItem *	copy (const SessionItem *item_to_copy, SessionItem *new_parent=0, const QString &tag="")
	Copy given item to the new_parent at given row. More...

Private Attributes
QString	m_dragged_item_type
QString	m_model_tag
	model tag (SampleModel, InstrumentModel) More...
QString	m_name
	model name More...
SessionItem *	m_root_item

Detailed Description

The DocumentModel class is a model with GUI settings related to the opened project.

Can be the place to store splitter position, etc.

Definition at line 25 of file DocumentModel.h.

Constructor & Destructor Documentation

DocumentModel()

DocumentModel::DocumentModel ( QObject *  parent = nullptr )

explicit

Definition at line 18 of file DocumentModel.cpp.

                                            : SessionModel(SessionXML::DocumentModelTag, parent)
{
    setObjectName(SessionXML::DocumentModelTag);
}

References SessionXML::DocumentModelTag().

Here is the call graph for this function:

Member Function Documentation

acceptableDefaultItemTypes()

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

inherited

Definition at line 299 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(), SessionModel::flags(), and SampleTreeWidget::showContextMenu().

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

virtualinherited

Definition at line 199 of file SessionModel.cpp.

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

References SessionModel::acceptableDefaultItemTypes(), SessionModel::data(), SessionXML::ItemMimeType, SessionXML::ItemTag(), SessionXML::ModelTypeAttribute(), and SessionModel::parent().

Referenced by SessionModel::dropMimeData().

Here is the call graph for this function:

clear()

void SessionModel::clear ( )

virtualinherited

Reimplemented in JobModel.

Definition at line 308 of file SessionModel.cpp.

{
    beginResetModel();
    delete m_root_item;
    createRootItem();
    endResetModel();
}

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

Referenced by JobModel::clear(), DetectorMaskDelegate::createIntensityDataItem(), SessionModel::load(), MaterialEditorDialog::onOKButton(), SessionModel::readFrom(), and ApplicationModels::resetModels().

Here is the call graph for this function:

columnCount()

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

virtualinherited

Definition at line 119 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 = 0, const QString &  tag = ""  )

privateinherited

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 419 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);
    SessionXML::writeItemAndChildItems(&writer, item_to_copy);
 
    QXmlStreamReader reader(xml_data);
    SessionXML::readItems(&reader, new_parent, tagName);
 
    return new_parent->getItems(tagName).back();
}

References SessionItem::defaultTag(), SessionItem::getItems(), SessionModel::m_root_item, SessionXML::readItems(), and SessionXML::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 = 0, const QString &  tag = ""  )

inherited

Definition at line 136 of file SessionModel.h.

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

References SessionModel::copy().

Referenced by JobModel::addJob(), MaterialModel::cloneMaterial(), JobModelFunctions::copyRealDataItem(), DetectorItem::importMasks(), MaterialItemContainer::insertCopy(), InstrumentViewActions::onCloneInstrument(), JobModelFunctions::setupJobItemInstrument(), and JobModelFunctions::setupJobItemSampleData().

Here is the call graph for this function:

createCopy()

SessionModel * SessionModel::createCopy ( SessionItem *  parent = 0 )

virtualinherited

Reimplemented in InstrumentModel, SampleModel, and MaterialModel.

Definition at line 437 of file SessionModel.cpp.

{
    Q_UNUSED(parent);
    throw GUIHelpers::Error("SessionModel::createCopy() -> Error. Not implemented.");
}

References SessionModel::parent().

Here is the call graph for this function:

createRootItem()

void SessionModel::createRootItem ( )

inherited

Definition at line 36 of file SessionModel.cpp.

{
    m_root_item = ItemFactory::CreateEmptyItem();
    m_root_item->setModel(this);
    m_root_item->registerTag("rootTag");
    m_root_item->setDefaultTag("rootTag");
}

References ItemFactory::CreateEmptyItem(), SessionModel::m_root_item, SessionItem::registerTag(), SessionItem::setDefaultTag(), 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

virtualinherited

Definition at line 70 of file SessionModel.cpp.

{
    if (!m_root_item || !index.isValid() || index.column() < 0
        || index.column() >= columnCount(QModelIndex())) {
        return QVariant();
    }
    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 SessionItemUtils::ToolTipRole(*item, index.column());
 
        } else if (role == Qt::ForegroundRole) {
            return SessionItemUtils::ForegroundRole(*item);
        } else if (role == Qt::DecorationRole && index.column() == SessionFlags::ITEM_VALUE) {
            return SessionItemUtils::DecorationRole(*item);
        } else if (role == Qt::CheckStateRole && index.column() == SessionFlags::ITEM_VALUE) {
            return SessionItemUtils::CheckStateRole(*item);
        } else {
            return item->roleProperty(role);
        }
    }
    return QVariant();
}

References SessionModel::columnCount(), SessionModel::index(), SessionFlags::ITEM_NAME, SessionFlags::ITEM_VALUE, SessionModel::itemForIndex(), SessionModel::m_root_item, and SessionItemUtils::ToolTipRole().

Referenced by SessionModel::canDropMimeData(), RealDataTreeModel::data(), SessionModel::dropMimeData(), gui2::JobModel::updateSLDProfile(), and gui2::JobModel::updateSpecularData().

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  )

virtualinherited

Definition at line 227 of file SessionModel.cpp.

{
    if (action == Qt::IgnoreAction)
        return true;
    if (action != Qt::MoveAction || column > 0 || !data
        || !data->hasFormat(SessionXML::ItemMimeType))
        return false;
    if (!canDropMimeData(data, action, row, column, parent))
        return false;
    if (SessionItem* item = itemForIndex(parent)) {
        QByteArray xml_data = qUncompress(data->data(SessionXML::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(), SessionXML::ItemMimeType, and SessionModel::parent().

Here is the call graph for this function:

flags()

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

virtualinherited

Definition at line 51 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().

Referenced by RealDataTreeModel::flags().

Here is the call graph for this function:

getModelName()

QString SessionModel::getModelName ( ) const

inlineinherited

Definition at line 196 of file SessionModel.h.

{
    return m_name;
}

References SessionModel::m_name.

Referenced by SessionXML::writeTo().

getModelTag()

QString SessionModel::getModelTag ( ) const

inlineinherited

Definition at line 191 of file SessionModel.h.

{
    return m_model_tag;
}

References SessionModel::m_model_tag.

Referenced by ModelTreeView::ModelTreeView(), SessionXML::readItems(), and SessionXML::writeTo().

headerData()

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

virtualinherited

Definition at line 98 of file SessionModel.cpp.

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

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

index()

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

virtualinherited

Definition at line 126 of file SessionModel.cpp.

{
    if (!m_root_item || 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 SampleViewAligner::alignSample(), JobModel::cancelJob(), MaterialModel::cloneMaterial(), MaskResultsPresenter::createMaskPresentation(), SessionModel::data(), MaskGraphicsScene::deleteViews(), DesignerScene::deleteViews(), SessionModel::flags(), JobModel::generateJobName(), SampleTreeWidget::getIndexAtColumnZero(), JobModel::getJobItemForIdentifier(), JobModel::getJobItemForIndex(), MaterialEditor::init_views(), ModelPath::isValidItem(), SessionModel::itemForIndex(), MaterialModel::materialFromIndex(), ModelMapper::onBeginRemoveRows(), MaterialPropertyController::onMaterialRowsAboutToBeRemoved(), ModelMapper::onRowRemoved(), MaskGraphicsScene::onRowsAboutToBeRemoved(), RealSpaceCanvas::onRowsAboutToBeRemoved(), DesignerScene::onRowsAboutToBeRemoved(), ItemStackWidget::onRowsAboutToBeRemoved(), ModelMapper::onRowsInserted(), SessionModel::removeItem(), JobModel::removeJob(), JobModel::runJob(), ItemSelectorWidget::selectLast(), SessionModel::setData(), MaskGraphicsScene::setItemName(), MaskGraphicsScene::setZValues(), ItemSelectorWidget::showEvent(), SessionModel::topItems(), JobQueueData::updateGlobalProgress(), InstrumentViewActions::updateSelection(), SampleViewAligner::updateViews(), MaskGraphicsScene::updateViews(), and DesignerScene::updateViews().

Here is the call graph for this function:

indexOfItem()

QModelIndex SessionModel::indexOfItem ( SessionItem *  item ) const

inherited

Definition at line 251 of file SessionModel.cpp.

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

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

Referenced by SampleTreeWidget::addItem(), SampleViewAligner::alignSample(), MaskGraphicsScene::cancelCurrentDrawing(), MaskEditorActions::changeMaskStackingOrder(), RealDataTreeModel::data(), SessionItem::emitDataChanged(), RealDataTreeModel::flags(), SessionItem::index(), DetectorMaskDelegate::initMaskEditorContext(), MaskGraphicsScene::onSceneSelectionChanged(), DesignerScene::onSceneSelectionChanged(), MaskGraphicsScene::onSessionSelectionChanged(), DesignerScene::onSessionSelectionChanged(), MaskGraphicsScene::processLineItem(), MaskGraphicsScene::processPolygonItem(), SessionModel::removeItem(), and MaterialEditor::setInitialMaterialProperty().

Here is the call graph for this function:

initFrom()

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

virtualinherited

Definition at line 443 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);
    }
    modelLoaded();
}

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

Referenced by MaterialModel::createCopy(), SampleModel::createCopy(), InstrumentModel::createCopy(), and MaterialEditorDialog::onOKButton().

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 130 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 125 of file SessionModel.h.

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

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

Referenced by IntensityDataFFTPresenter::IntensityDataFFTPresenter(), FitComparison1DViewController::createDiffViewItem(), FitParameterHelper::createFitParameter(), DetectorMaskDelegate::createIntensityDataItem(), DetectorItem::createMaskContainer(), ParameterTreeUtils::createParameterTree(), DesignerScene::dropEvent(), TestComponentView::init_source(), InstrumentViewActions::initAddInstrumentMenu(), RealDataItem::initDataItem(), JobModelFunctions::initDataView(), TestComponentView::onAddItemRequest(), ProjectionsEditorCanvas::onEnteringColorMap(), ParameterTreeUtils::parameterDictionary(), ParameterTreeUtils::parameterNameToLinkedItem(), GUIObjectBuilder::populateDocumentModel(), ParameterTreeUtils::populateParameterContainer(), MaskGraphicsScene::processHorizontalLineItem(), MaskGraphicsScene::processMaskAllItem(), MaskGraphicsScene::processPolygonItem(), MaskGraphicsScene::processVerticalLineItem(), ApplicationModels::resetModels(), JobModelFunctions::setupJobItemOutput(), JobModelFunctions::setupJobItemSampleData(), TestView::test_MinimizerSettings(), TestView::test_specular_data_widget(), and GUIDomainSampleVisitor::visit().

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 286 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 260 of file SessionModel.cpp.

{
    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 = ItemFactory::CreateItem(model_type);
 
    if (!new_item)
        throw GUIHelpers::Error("SessionModel::insertNewItem() -> Wrong model type " + model_type);
 
    if (!parent_item->insertItem(row, new_item, tag))
        throw GUIHelpers::Error("SessionModel::insertNewItem -> Error. Can't insert item");
 
    return new_item;
}

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

Referenced by SampleTreeWidget::addItem(), FitParameterHelper::addToFitParameter(), DesignerScene::dropEvent(), MultiLayerView::dropEvent(), GUIDomainSampleVisitor::InsertIParticle(), SessionModel::insertItem(), SessionModel::insertNewItem(), RealDataMaskWidget::maskContainer(), InstrumentViewActions::onCloneInstrument(), MaskGraphicsScene::processRectangleShapeItem(), and IntensityDataProjectionsWidget::projectionContainer().

Here is the call graph for this function:

itemForIndex()

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

inherited

Definition at line 347 of file SessionModel.cpp.

{
    if (index.isValid())
        if (SessionItem* 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(), SessionDecorationModel::createIcon(), MaskResultsPresenter::createMaskPresentation(), SessionModel::data(), DataProperties::dataItem(), DesignerScene::deleteSelectedItems(), MaskGraphicsScene::deleteViews(), DesignerScene::deleteViews(), SessionModel::dropMimeData(), SessionModel::flags(), JobModel::generateJobName(), ModelPath::getItemFromPath(), JobModel::getJobItemForIndex(), ParameterTuningModel::getParameterItem(), SampleViewAligner::getViewForIndex(), SessionModel::index(), SessionModel::insertItem(), SessionModel::insertNewItem(), MaskEditorActions::isSendToBackPossible(), ModelPath::isValidItem(), ParameterItem::linkedItem(), MaterialModel::materialFromIndex(), SessionModel::mimeData(), ModelMapper::onBeginRemoveRows(), InstrumentViewActions::onCloneInstrument(), PySampleWidget::onDataChanged(), RealSpaceCanvas::onDataChanged(), ComponentFlatView::onDataChanged(), ModelMapper::onDataChanged(), MaterialPropertyController::onMaterialDataChanged(), MaterialPropertyController::onMaterialRowsAboutToBeRemoved(), ModelMapper::onRowRemoved(), ItemStackWidget::onRowsAboutToBeRemoved(), ModelMapper::onRowsInserted(), ItemSelectorWidget::onSelectionChanged(), MaskEditorPropertyPanel::onSelectionChanged(), MaterialEditor::onSelectionChanged(), TestComponentView::onSelectionChanged(), FitParameterProxyModel::onSourceDataChanged(), MaskEditorActions::onToggleMaskValueAction(), SessionModel::parent(), ComponentProxyStrategy::processSourceIndex(), MaterialPropertyController::relatedSampleItems(), SessionModel::removeRows(), SessionModel::rowCount(), SessionModel::setData(), MaskGraphicsScene::setItemName(), MaskEditor::setMaskContext(), MaskGraphicsScene::setMaskContext(), MaskEditorPropertyPanel::setPanelHidden(), MaskGraphicsScene::setZValues(), ComponentProxyModel::sourceDataChanged(), SessionDecorationModel::textColor(), SessionModel::topItems(), MaskGraphicsScene::updateScene(), RealSpaceCanvas::updateScene(), MaskGraphicsScene::updateViews(), and DesignerScene::updateViews().

Here is the call graph for this function:

load()

void SessionModel::load ( const QString &  filename = "" )

inherited

Definition at line 316 of file SessionModel.cpp.

{
    beginResetModel();
    QFile file(filename);
    if (!file.open(QIODevice::ReadOnly))
        throw GUIHelpers::Error(file.errorString());
    clear();
    m_root_item = ItemFactory::CreateEmptyItem();
    QXmlStreamReader reader(&file);
    SessionXML::readItems(&reader, m_root_item);
    if (reader.hasError())
        throw GUIHelpers::Error(reader.errorString());
    endResetModel();
}

References SessionModel::clear(), ItemFactory::CreateEmptyItem(), FileSystemUtils::filename(), SessionModel::m_root_item, and SessionXML::readItems().

Here is the call graph for this function:

mimeData()

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

virtualinherited

Definition at line 183 of file SessionModel.cpp.

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

References SessionModel::itemForIndex(), SessionXML::ItemMimeType, and SessionXML::writeItemAndChildItems().

Here is the call graph for this function:

mimeTypes()

QStringList SessionModel::mimeTypes ( ) const

virtualinherited

Definition at line 178 of file SessionModel.cpp.

{
    return QStringList() << SessionXML::ItemMimeType;
}

References SessionXML::ItemMimeType.

modelLoaded

void SessionModel::modelLoaded ( )

signalinherited

Referenced by SessionModel::initFrom(), and MaterialPropertyController::setModels().

moveItem()

SessionItem * SessionModel::moveItem ( SessionItem *  item, SessionItem *  new_parent = 0, 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 384 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 0;
 
    if (item->parent() == new_parent) {
        // take care of indexes when moving item within same parent
        int previousIndex = item->parent()->getItems(tagName).indexOf(item);
        if (row == previousIndex)
            return item;
        else if (previousIndex >= 0 && row > previousIndex)
            row--;
    }
 
    if (new_parent->sessionItemTags()->maximumReached(tagName)) {
        SessionItem* prev = new_parent->takeItem(0, tagName);
        m_root_item->insertItem(-1, prev);
    }
 
    // removing item from previous parent and inserting to the new one
    item->parent()->takeRow(item->parent()->rowOfChild(item));
    new_parent->insertItem(row, item, tagName);
 
    return item;
}

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

Referenced by MaskEditorActions::changeMaskStackingOrder(), ILayerView::mouseReleaseEvent(), DesignerScene::onEstablishedConnection(), and DesignerScene::removeConnection().

Here is the call graph for this function:

nonXMLItems()

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

virtualinherited

Reimplemented in RealDataModel, JobModel, and InstrumentModel.

Definition at line 466 of file SessionModel.cpp.

{
    return QVector<SessionItem*>();
}

parent()

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

virtualinherited

Definition at line 139 of file SessionModel.cpp.

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

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

Referenced by SessionModel::acceptableDefaultItemTypes(), SessionModel::canDropMimeData(), SessionModel::columnCount(), SessionModel::createCopy(), MaterialModel::createCopy(), SampleModel::createCopy(), InstrumentModel::createCopy(), SampleTreeWidget::deleteItem(), SessionModel::dropMimeData(), SampleTreeWidget::getIndexAtColumnZero(), SessionModel::index(), SessionModel::insertItem(), InstrumentModel::onRowsChange(), RealDataModel::onRowsChange(), SessionModel::removeRows(), SessionModel::rowCount(), and SessionModel::writeTo().

Here is the call graph for this function:

readFrom()

void SessionModel::readFrom ( QXmlStreamReader *  reader, MessageService *  messageService = 0  )

virtualinherited

Reimplemented in RealDataModel, JobModel, and InstrumentModel.

Definition at line 356 of file SessionModel.cpp.

{
    ASSERT(reader);
 
    if (reader->name() != m_model_tag)
        throw GUIHelpers::Error("SessionModel::readFrom() -> Format error in p1");
 
    beginResetModel();
    clear();
 
    m_name = reader->attributes().value(SessionXML::ModelNameAttribute).toString();
 
    SessionXML::readItems(reader, m_root_item, QString(), messageService);
    if (reader->hasError())
        throw GUIHelpers::Error(reader->errorString());
    endResetModel();
}

References ASSERT, SessionModel::clear(), SessionModel::m_model_tag, SessionModel::m_name, SessionModel::m_root_item, SessionXML::ModelNameAttribute(), and SessionXML::readItems().

Referenced by SessionModel::initFrom(), InstrumentModel::readFrom(), JobModel::readFrom(), and RealDataModel::readFrom().

Here is the call graph for this function:

removeItem()

void SessionModel::removeItem ( SessionItem *  item )

inherited

Definition at line 292 of file SessionModel.cpp.

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

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

Referenced by RealDataTreeModel::removeItem().

Here is the call graph for this function:

removeRows()

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

virtualinherited

Definition at line 168 of file SessionModel.cpp.

{
    if (!m_root_item)
        return false;
    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(), SampleTreeWidget::deleteItem(), DesignerScene::deleteSelectedItems(), ProjectionsEditorActions::onDeleteAction(), MaskEditorActions::onDeleteMaskAction(), InstrumentViewActions::onRemoveInstrument(), MaterialEditorToolBar::onRemoveMaterialAction(), SessionModel::removeItem(), and JobModel::removeJob().

Here is the call graph for this function:

rootItem()

SessionItem * SessionModel::rootItem ( ) const

inherited

Definition at line 461 of file SessionModel.cpp.

{
    return m_root_item;
}

References SessionModel::m_root_item.

Referenced by ModelPath::getIndexFromPath(), and ModelMapper::nestlingDepth().

rowCount()

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

virtualinherited

Definition at line 111 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 SampleViewAligner::alignSample(), MaskResultsPresenter::createMaskPresentation(), MaskGraphicsScene::deleteViews(), DesignerScene::deleteViews(), JobModel::generateJobName(), JobModel::getJobItemForIdentifier(), ModelPath::isValidItem(), ItemSelectorWidget::selectLast(), MaskGraphicsScene::setItemName(), MaskGraphicsScene::setZValues(), ItemSelectorWidget::showEvent(), SessionModel::topItems(), JobQueueData::updateGlobalProgress(), InstrumentViewActions::updateSelection(), SampleViewAligner::updateViews(), MaskGraphicsScene::updateViews(), and DesignerScene::updateViews().

Here is the call graph for this function:

save()

void SessionModel::save ( const QString &  filename = "" )

inherited

Definition at line 331 of file SessionModel.cpp.

{
    QFile file(filename);
    if (!file.open(QIODevice::WriteOnly | QIODevice::Text))
        throw GUIHelpers::Error(file.errorString());
 
    QXmlStreamWriter writer(&file);
    writer.setAutoFormatting(true);
    writer.writeStartDocument();
    writer.writeStartElement("BornAgain");
    writer.writeAttribute("Version", GUIHelpers::getBornAgainVersionString());
    SessionXML::writeItemAndChildItems(&writer, m_root_item);
    writer.writeEndElement(); // BornAgain
    writer.writeEndDocument();
}

References FileSystemUtils::filename(), GUIHelpers::getBornAgainVersionString(), SessionModel::m_root_item, and SessionXML::writeItemAndChildItems().

Here is the call graph for this function:

setData()

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

virtualinherited

Definition at line 155 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(), and SessionModel::itemForIndex().

Here is the call graph for this function:

setDraggedItemType()

void SessionModel::setDraggedItemType ( const QString &  type )

inlineinherited

Definition at line 201 of file SessionModel.h.

{
    m_dragged_item_type = type;
}

References SessionModel::m_dragged_item_type.

Referenced by ItemTreeView::dragMoveEvent().

setHeaderData()

bool SessionModel::setHeaderData ( int  , Qt::Orientation  , const QVariant &  , int  = Qt::EditRole  )

inlinevirtualinherited

Definition at line 176 of file SessionModel.h.

{
    return false;
}

setRootItem()

void SessionModel::setRootItem ( SessionItem *  root )

inlineprotectedinherited

Definition at line 112 of file SessionModel.h.

{ m_root_item = root; }

References SessionModel::m_root_item.

simulationOptionsItem()

SimulationOptionsItem * DocumentModel::simulationOptionsItem

(

)

Definition at line 23 of file DocumentModel.cpp.

{
    return topItem<SimulationOptionsItem>();
}

Referenced by SimulationSetupWidget::onExportToPythonScript(), SimulationSetupWidget::onRunSimulation(), and SimulationSetupWidget::updateViewElements().

supportedDragActions()

Qt::DropActions SessionModel::supportedDragActions ( ) const

inlinevirtualinherited

Definition at line 181 of file SessionModel.h.

{
    return Qt::MoveAction;
}

supportedDropActions()

Qt::DropActions SessionModel::supportedDropActions ( ) const

inlinevirtualinherited

Definition at line 186 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 141 of file SessionModel.h.

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

topItems() [1/2]

template<typename T >

QVector< T * > SessionModel::topItems

inherited

Definition at line 147 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().

Referenced by JobModel::clear(), MaterialItemUtils::defaultMaterialProperty(), PySampleWidget::generateCodeSnippet(), SimulationDataSelectorWidget::selectedInstrumentItem(), SimulationDataSelectorWidget::selectedMultiLayerItem(), and ModelUtils::topItemNames().

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 161 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, SessionItem *  parent = 0  )

virtualinherited

Definition at line 374 of file SessionModel.cpp.

{
    if (!parent)
        parent = m_root_item;
    SessionXML::writeTo(writer, parent);
}

References SessionModel::m_root_item, SessionModel::parent(), and SessionXML::writeTo().

Referenced by SessionModel::initFrom().

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 120 of file SessionModel.h.

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

m_model_tag

QString SessionModel::m_model_tag

privateinherited

model tag (SampleModel, InstrumentModel)

Definition at line 122 of file SessionModel.h.

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

m_name

QString SessionModel::m_name

privateinherited

model name

Definition at line 121 of file SessionModel.h.

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

m_root_item

SessionItem* SessionModel::m_root_item

privateinherited

Definition at line 119 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::load(), SessionModel::moveItem(), SessionModel::parent(), SessionModel::readFrom(), SessionModel::removeRows(), SessionModel::rootItem(), SessionModel::save(), SessionModel::setRootItem(), and SessionModel::writeTo().

---

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

• /home/www/ba/GUI/coregui/Models/DocumentModel.h
• /home/www/ba/GUI/coregui/Models/DocumentModel.cpp