InstrumentListModel Class Reference

Description

List model for instruments.

Used e.g. to present the instrument list in the instrument view.

Definition at line 28 of file InstrumentListModel.h.

Inheritance diagram for InstrumentListModel:

Collaboration diagram for InstrumentListModel:

Public Member Functions
	InstrumentListModel (QObject *parent, InstrumentsEditController *ec)
QModelIndex	addNewDepthProbeInstrument ()
QModelIndex	addNewGISASInstrument ()
QModelIndex	addNewOffspecInstrument ()
QModelIndex	addNewSpecularInstrument ()
QModelIndex	copyInstrument (const InstrumentItem *source)
QModelIndex	copyInstrument (const QModelIndex &source)
QVariant	data (const QModelIndex &index, int role=Qt::DisplayRole) const override
InstrumentItem *	instrumentForIndex (const QModelIndex &index) const
void	removeInstrument (const QModelIndex &index)
int	rowCount (const QModelIndex &parent=QModelIndex()) const override

Private Member Functions
template<class Instrument >
QModelIndex	addNewInstrument ()
void	onInstrumentNameChanged (const InstrumentItem *instrument)

Private Attributes
QIcon	m_depthProbeIcon
InstrumentsEditController *	m_ec
QIcon	m_gisasIcon
QIcon	m_offspecIcon
QIcon	m_specularIcon

Constructor & Destructor Documentation

InstrumentListModel()

InstrumentListModel::InstrumentListModel	(	QObject *	parent,
		InstrumentsEditController *	ec
	)

Definition at line 55 of file InstrumentListModel.cpp.

    : QAbstractListModel(parent)
    , m_ec(ec)
{
    m_gisasIcon.addPixmap(QPixmap(":/images/gisas_instrument.svg"), QIcon::Selected);
    m_gisasIcon.addPixmap(QPixmap(":/images/gisas_instrument_shaded.svg"), QIcon::Normal);
    m_offspecIcon.addPixmap(QPixmap(":/images/offspec_instrument.svg"), QIcon::Selected);
    m_offspecIcon.addPixmap(QPixmap(":/images/offspec_instrument_shaded.svg"), QIcon::Normal);
    m_specularIcon.addPixmap(QPixmap(":/images/specular_instrument.svg"), QIcon::Selected);
    m_specularIcon.addPixmap(QPixmap(":/images/specular_instrument_shaded.svg"), QIcon::Normal);
    m_depthProbeIcon.addPixmap(QPixmap(":/images/depth_instrument.svg"), QIcon::Selected);
    m_depthProbeIcon.addPixmap(QPixmap(":/images/depth_instrument_shaded.svg"), QIcon::Normal);
 
    connect(ec, &InstrumentsEditController::instrumentNameChanged, this,
            &InstrumentListModel::onInstrumentNameChanged);
}

References InstrumentsEditController::instrumentNameChanged(), m_depthProbeIcon, m_gisasIcon, m_offspecIcon, m_specularIcon, and onInstrumentNameChanged().

Here is the call graph for this function:

Member Function Documentation

addNewDepthProbeInstrument()

QModelIndex InstrumentListModel::addNewDepthProbeInstrument

(

)

Definition at line 128 of file InstrumentListModel.cpp.

{
    return addNewInstrument<DepthProbeInstrumentItem>();
}

Referenced by InstrumentListView::onNewDepthProbe().

addNewGISASInstrument()

QModelIndex InstrumentListModel::addNewGISASInstrument

(

)

Definition at line 113 of file InstrumentListModel.cpp.

{
    return addNewInstrument<GISASInstrumentItem>();
}

Referenced by InstrumentListView::onNewGisas().

addNewInstrument()

template<class Instrument >

QModelIndex InstrumentListModel::addNewInstrument

private

Definition at line 163 of file InstrumentListModel.cpp.

{
    const QString name =
        m_ec->collectedItems()->suggestInstrumentName(defaultInstrumentName<Instrument>());
    const int row = m_ec->collectedItems()->collectedItems().size();
 
    beginInsertRows(QModelIndex(), row, row);
    auto* instrument = m_ec->addInstrument<Instrument>();
    m_ec->setInstrumentName(instrument, name);
    endInsertRows();
 
    return createIndex(row, 0);
}

References InstrumentsEditController::addInstrument(), InstrumentsEditController::collectedItems(), InstrumentCollection::collectedItems(), m_ec, GUI::RealSpace::Particles::name(), InstrumentsEditController::setInstrumentName(), and InstrumentCollection::suggestInstrumentName().

Here is the call graph for this function:

addNewOffspecInstrument()

QModelIndex InstrumentListModel::addNewOffspecInstrument

(

)

Definition at line 118 of file InstrumentListModel.cpp.

{
    return addNewInstrument<OffspecInstrumentItem>();
}

Referenced by InstrumentListView::onNewOffspec().

addNewSpecularInstrument()

QModelIndex InstrumentListModel::addNewSpecularInstrument

(

)

Definition at line 123 of file InstrumentListModel.cpp.

{
    return addNewInstrument<SpecularInstrumentItem>();
}

Referenced by InstrumentListView::onNewSpecular().

copyInstrument() [1/2]

QModelIndex InstrumentListModel::copyInstrument

(

const InstrumentItem *

source

)

Definition at line 149 of file InstrumentListModel.cpp.

{
    const QString copyName =
        m_ec->collectedItems()->suggestInstrumentName(source->instrumentName());
    const int row = m_ec->collectedItems()->collectedItems().size();
 
    beginInsertRows(QModelIndex(), row, row);
    m_ec->addCopy(source, copyName);
    endInsertRows();
 
    return createIndex(row, 0);
}

References InstrumentsEditController::addCopy(), InstrumentsEditController::collectedItems(), InstrumentCollection::collectedItems(), InstrumentItem::instrumentName(), m_ec, and InstrumentCollection::suggestInstrumentName().

Here is the call graph for this function:

copyInstrument() [2/2]

QModelIndex InstrumentListModel::copyInstrument

(

const QModelIndex &

source

)

Definition at line 141 of file InstrumentListModel.cpp.

{
    const InstrumentItem* srcInstr = instrumentForIndex(source);
    ASSERT(srcInstr);
 
    return copyInstrument(srcInstr);
}

References instrumentForIndex().

Referenced by InstrumentListView::onCopy(), and InstrumentListView::onLoadFromLibrary().

Here is the call graph for this function:

data()

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

override

Definition at line 77 of file InstrumentListModel.cpp.

{
    QVector<InstrumentItem*> instruments = m_ec->collectedItems()->collectedItems();
    if (!index.isValid() || index.row() >= instruments.size() || index.row() < 0)
        return {};
 
    const InstrumentItem* item = instruments[index.row()];
    if (role == Qt::DecorationRole) {
        if (dynamic_cast<const GISASInstrumentItem*>(item))
            return m_gisasIcon;
        if (dynamic_cast<const OffspecInstrumentItem*>(item))
            return m_offspecIcon;
        if (dynamic_cast<const SpecularInstrumentItem*>(item))
            return m_specularIcon;
        if (dynamic_cast<const DepthProbeInstrumentItem*>(item))
            return m_depthProbeIcon;
        return {};
    }
 
    if (role == Qt::DisplayRole)
        return item->instrumentName();
 
    return {};
}

References InstrumentsEditController::collectedItems(), InstrumentCollection::collectedItems(), InstrumentItem::instrumentName(), m_depthProbeIcon, m_ec, m_gisasIcon, m_offspecIcon, and m_specularIcon.

Here is the call graph for this function:

instrumentForIndex()

InstrumentItem * InstrumentListModel::instrumentForIndex

(

const QModelIndex &

index

)

const

Definition at line 102 of file InstrumentListModel.cpp.

{
    if (!index.isValid())
        return nullptr;
 
    QVector<InstrumentItem*> instruments = m_ec->collectedItems()->collectedItems();
    if (index.row() >= 0 && index.row() < instruments.size())
        return instruments[index.row()];
    return nullptr;
}

References InstrumentsEditController::collectedItems(), InstrumentCollection::collectedItems(), and m_ec.

Referenced by copyInstrument(), InstrumentListView::currentInstrument(), InstrumentListView::onItemSelectionChanged(), InstrumentListView::onStoreInLibrary(), and removeInstrument().

Here is the call graph for this function:

onInstrumentNameChanged()

void InstrumentListModel::onInstrumentNameChanged ( const InstrumentItem *  instrument )

private

Definition at line 177 of file InstrumentListModel.cpp.

{
    const auto instruments = m_ec->collectedItems()->collectedItems();
    if (const auto row = instruments.indexOf(const_cast<InstrumentItem*>(instrument)); row != -1)
        emit dataChanged(index(row, 0), index(row, 0));
}

References InstrumentsEditController::collectedItems(), InstrumentCollection::collectedItems(), and m_ec.

Referenced by InstrumentListModel().

Here is the call graph for this function:

removeInstrument()

void InstrumentListModel::removeInstrument

(

const QModelIndex &

index

)

Definition at line 133 of file InstrumentListModel.cpp.

{
    beginRemoveRows(QModelIndex(), index.row(), index.row());
    InstrumentItem* instrument = instrumentForIndex(index);
    m_ec->removeInstrument(instrument);
    endRemoveRows();
}

References instrumentForIndex(), m_ec, and InstrumentsEditController::removeInstrument().

Referenced by InstrumentListView::onRemove().

Here is the call graph for this function:

rowCount()

int InstrumentListModel::rowCount ( const QModelIndex &  parent = QModelIndex() ) const

override

Definition at line 72 of file InstrumentListModel.cpp.

{
    return m_ec->collectedItems()->collectedItems().size();
}

References InstrumentsEditController::collectedItems(), InstrumentCollection::collectedItems(), and m_ec.

Referenced by InstrumentListView::ensureItemSelected().

Here is the call graph for this function:

Member Data Documentation

m_depthProbeIcon

QIcon InstrumentListModel::m_depthProbeIcon

private

Definition at line 60 of file InstrumentListModel.h.

Referenced by InstrumentListModel(), and data().

m_ec

InstrumentsEditController* InstrumentListModel::m_ec

private

Definition at line 56 of file InstrumentListModel.h.

Referenced by addNewInstrument(), copyInstrument(), data(), instrumentForIndex(), onInstrumentNameChanged(), removeInstrument(), and rowCount().

m_gisasIcon

QIcon InstrumentListModel::m_gisasIcon

private

Definition at line 57 of file InstrumentListModel.h.

Referenced by InstrumentListModel(), and data().

m_offspecIcon

QIcon InstrumentListModel::m_offspecIcon

private

Definition at line 58 of file InstrumentListModel.h.

Referenced by InstrumentListModel(), and data().

m_specularIcon

QIcon InstrumentListModel::m_specularIcon

private

Definition at line 59 of file InstrumentListModel.h.

Referenced by InstrumentListModel(), and data().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/Instrument/InstrumentListModel.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/Instrument/InstrumentListModel.cpp