InstrumentViewActions Class Reference

Collection of actions to add/remove/clone instrument. More...

Inheritance diagram for InstrumentViewActions:

Collaboration diagram for InstrumentViewActions:

Public Slots
void	onCloneInstrument ()
	Clones currently selected instrument. More...
void	onContextMenuRequest (const QPoint &point, const QModelIndex &indexAtPoint)
void	onRemoveInstrument ()
	Removes currently selected instrument. More...

Public Member Functions
	InstrumentViewActions (QWidget *parent=nullptr)
	~InstrumentViewActions ()
QMenu *	instrumentMenu ()
	Returns menu to create one of available instrument types. More...
void	setModel (SessionModel *model)
void	setSelectionModel (QItemSelectionModel *selectionModel)

Private Member Functions
void	initAddInstrumentMenu ()
	Constructs menu to add instruments of various types. More...
QMap< QString, int >	mapOfNames ()
void	setAllActionsEnabled (bool value)
QString	suggestInstrumentName (const QString &currentName)
void	updateSelection ()

Private Attributes
QMenu *	m_addInstrumentMenu
QAction *	m_cloneInstrumentAction
SessionModel *	m_model
QAction *	m_removeInstrumentAction
QItemSelectionModel *	m_selectionModel

Detailed Description

Collection of actions to add/remove/clone instrument.

Definition at line 29 of file InstrumentViewActions.h.

Constructor & Destructor Documentation

InstrumentViewActions()

InstrumentViewActions::InstrumentViewActions ( QWidget *  parent = nullptr )

explicit

Definition at line 29 of file InstrumentViewActions.cpp.

    : QObject(parent)
    , m_addInstrumentMenu(nullptr)
    , m_removeInstrumentAction(nullptr)
    , m_cloneInstrumentAction(nullptr)
    , m_model(nullptr)
    , m_selectionModel(nullptr)
{
    initAddInstrumentMenu();
 
    m_removeInstrumentAction =
        new QAction(QIcon(":/images/delete.svg"), "Remove this instrument", this);
 
    m_cloneInstrumentAction =
        new QAction(QIcon(":/images/content-copy.svg"), "Clone this instrument", this);
 
    connect(m_removeInstrumentAction, &QAction::triggered, this,
            &InstrumentViewActions::onRemoveInstrument);
    connect(m_cloneInstrumentAction, &QAction::triggered, this,
            &InstrumentViewActions::onCloneInstrument);
}

References initAddInstrumentMenu(), m_cloneInstrumentAction, m_removeInstrumentAction, onCloneInstrument(), and onRemoveInstrument().

Here is the call graph for this function:

~InstrumentViewActions()

InstrumentViewActions::~InstrumentViewActions

(

)

Definition at line 51 of file InstrumentViewActions.cpp.

{
    delete m_addInstrumentMenu;
}

References m_addInstrumentMenu.

Member Function Documentation

initAddInstrumentMenu()

void InstrumentViewActions::initAddInstrumentMenu ( )

private

Constructs menu to add instruments of various types.

The type of instrument is encoded in QAction internal data.

Definition at line 187 of file InstrumentViewActions.cpp.

{
    m_addInstrumentMenu = new QMenu("Add new instrument");
    m_addInstrumentMenu->setToolTipsVisible(true);
 
    const auto addAction = [this](const QString& menuEntry, const QString& tooltip,
                                  std::function<InstrumentItem*()> insertInstrument) {
        auto action = m_addInstrumentMenu->addAction(menuEntry);
        action->setToolTip(tooltip);
 
        connect(action, &QAction::triggered, [=]() {
            InstrumentItem* instrument = insertInstrument();
            instrument->setItemName(suggestInstrumentName(instrument->defaultName()));
            updateSelection();
 
            // set default action to the just triggered action
            m_addInstrumentMenu->setDefaultAction(action);
        });
    };
 
    addAction("GISAS", "Add GISAS instrument with default settings",
              [this]() { return m_model->insertItem<GISASInstrumentItem>(); });
 
    addAction("OffSpecular", "Add OffSpecular instrument with default settings",
              [this]() { return m_model->insertItem<OffSpecularInstrumentItem>(); });
 
    addAction("Specular", "Add Specular instrument with default settings",
              [this]() { return m_model->insertItem<SpecularInstrumentItem>(); });
 
    addAction("DepthProbe", "Add DepthProbe instrument with default settings",
              [this]() { return m_model->insertItem<DepthProbeInstrumentItem>(); });
 
    m_addInstrumentMenu->setDefaultAction(m_addInstrumentMenu->actions().front());
}

References InstrumentItem::defaultName(), SessionModel::insertItem(), m_addInstrumentMenu, m_model, SessionItem::setItemName(), suggestInstrumentName(), and updateSelection().

Referenced by InstrumentViewActions().

Here is the call graph for this function:

instrumentMenu()

QMenu * InstrumentViewActions::instrumentMenu

(

)

Returns menu to create one of available instrument types.

Definition at line 68 of file InstrumentViewActions.cpp.

{
    return m_addInstrumentMenu;
}

References m_addInstrumentMenu.

mapOfNames()

QMap< QString, int > InstrumentViewActions::mapOfNames ( )

private

Definition at line 167 of file InstrumentViewActions.cpp.

{
    QMap<QString, int> result;
 
    for (auto& name : ModelUtils::topItemNames(m_model)) {
        int ncopy(1);
        QRegExp regexp("\\((.*)\\)");
        if (regexp.indexIn(name) >= 0)
            ncopy = regexp.cap(1).toInt();
        name.replace(regexp.cap(0), "");
        name = name.trimmed();
        result[name] = ncopy;
    }
 
    return result;
}

References m_model, RealSpace::Particles::name(), and ModelUtils::topItemNames().

Referenced by suggestInstrumentName().

Here is the call graph for this function:

onCloneInstrument

void InstrumentViewActions::onCloneInstrument ( )

slot

Clones currently selected instrument.

Definition at line 87 of file InstrumentViewActions.cpp.

{
    QModelIndex currentIndex = m_selectionModel->currentIndex();
 
    if (currentIndex.isValid()) {
        SessionItem* item = m_model->itemForIndex(currentIndex);
        QString nameOfClone = suggestInstrumentName(item->itemName());
        InstrumentItem* clone =
            static_cast<InstrumentItem*>(m_model->insertNewItem(item->modelType()));
        const QString idBackup = clone->id(); // will be overwritten by the following
        for (auto child : item->children()) {
            auto tag = item->tagFromItem(child);
            m_model->copyItem(child, clone, tag);
        }
        clone->setId(idBackup);
        clone->setItemName(nameOfClone);
 
        // copying non-uniform axis data
        if (auto instrument = dynamic_cast<SpecularInstrumentItem*>(item)) {
            auto axis_group = instrument->beamItem()->inclinationAxisGroup();
 
            auto donor_axis =
                dynamic_cast<PointwiseAxisItem*>(axis_group->getItemOfType("PointwiseAxis"));
            if (!donor_axis->containsNonXMLData())
                return;
 
            auto acceptor_axis =
                dynamic_cast<PointwiseAxisItem*>(dynamic_cast<SpecularInstrumentItem*>(clone)
                                                     ->beamItem()
                                                     ->inclinationAxisGroup()
                                                     ->getItemOfType("PointwiseAxis"));
            acceptor_axis->init(*donor_axis->axis(), donor_axis->getUnitsLabel());
        }
    }
}

References SessionItem::children(), SessionModel::copyItem(), PointwiseAxisItem::init(), SessionModel::insertNewItem(), SessionModel::itemForIndex(), SessionItem::itemName(), m_model, m_selectionModel, SessionItem::modelType(), suggestInstrumentName(), and SessionItem::tagFromItem().

Referenced by InstrumentViewActions(), and InstrumentViewToolBar::InstrumentViewToolBar().

Here is the call graph for this function:

onContextMenuRequest

void InstrumentViewActions::onContextMenuRequest ( const QPoint &  point, const QModelIndex &  indexAtPoint  )

slot

Definition at line 123 of file InstrumentViewActions.cpp.

{
    QMenu menu;
 
    setAllActionsEnabled(indexAtPoint.isValid());
 
    menu.addAction(m_cloneInstrumentAction);
    menu.addAction(m_removeInstrumentAction);
    menu.addSeparator();
    menu.addMenu(m_addInstrumentMenu);
    menu.exec(point);
}

References m_addInstrumentMenu, m_cloneInstrumentAction, m_removeInstrumentAction, and setAllActionsEnabled().

Referenced by InstrumentView::InstrumentView().

Here is the call graph for this function:

onRemoveInstrument

void InstrumentViewActions::onRemoveInstrument ( )

slot

Removes currently selected instrument.

Definition at line 75 of file InstrumentViewActions.cpp.

{
    QModelIndex currentIndex = m_selectionModel->currentIndex();
 
    if (currentIndex.isValid())
        m_model->removeRows(currentIndex.row(), 1, QModelIndex());
 
    updateSelection();
}

References m_model, m_selectionModel, SessionModel::removeRows(), and updateSelection().

Referenced by InstrumentViewActions(), and InstrumentViewToolBar::InstrumentViewToolBar().

Here is the call graph for this function:

setAllActionsEnabled()

void InstrumentViewActions::setAllActionsEnabled ( bool  value )

private

Definition at line 137 of file InstrumentViewActions.cpp.

{
    m_removeInstrumentAction->setEnabled(value);
    m_cloneInstrumentAction->setEnabled(value);
}

References m_cloneInstrumentAction, and m_removeInstrumentAction.

Referenced by onContextMenuRequest().

setModel()

void InstrumentViewActions::setModel

(

SessionModel *

model

)

Definition at line 56 of file InstrumentViewActions.cpp.

{
    m_model = model;
}

References m_model.

Referenced by InstrumentView::InstrumentView().

setSelectionModel()

void InstrumentViewActions::setSelectionModel

(

QItemSelectionModel *

selectionModel

)

Definition at line 61 of file InstrumentViewActions.cpp.

{
    m_selectionModel = selectionModel;
}

References m_selectionModel.

Referenced by InstrumentView::InstrumentView().

suggestInstrumentName()

QString InstrumentViewActions::suggestInstrumentName ( const QString &  currentName )

private

Definition at line 153 of file InstrumentViewActions.cpp.

{
    auto map_of_names = mapOfNames();
 
    int ncopies = map_of_names[currentName];
    if (ncopies == 0) {
        map_of_names[currentName] = 1;
        return currentName;
    } else {
        map_of_names[currentName]++;
        return QString("%1 (%2)").arg(currentName).arg(map_of_names[currentName]);
    }
}

References mapOfNames().

Referenced by initAddInstrumentMenu(), and onCloneInstrument().

Here is the call graph for this function:

updateSelection()

void InstrumentViewActions::updateSelection ( )

private

Definition at line 143 of file InstrumentViewActions.cpp.

{
    if (!m_selectionModel->hasSelection()) {
        // select last item
        QModelIndex itemIndex =
            m_model->index(m_model->rowCount(QModelIndex()) - 1, 0, QModelIndex());
        m_selectionModel->select(itemIndex, QItemSelectionModel::ClearAndSelect);
    }
}

References SessionModel::index(), m_model, m_selectionModel, and SessionModel::rowCount().

Referenced by initAddInstrumentMenu(), and onRemoveInstrument().

Here is the call graph for this function:

Member Data Documentation

m_addInstrumentMenu

QMenu* InstrumentViewActions::m_addInstrumentMenu

private

Definition at line 53 of file InstrumentViewActions.h.

Referenced by ~InstrumentViewActions(), initAddInstrumentMenu(), instrumentMenu(), and onContextMenuRequest().

m_cloneInstrumentAction

QAction* InstrumentViewActions::m_cloneInstrumentAction

private

Definition at line 55 of file InstrumentViewActions.h.

Referenced by InstrumentViewActions(), onContextMenuRequest(), and setAllActionsEnabled().

m_model

SessionModel* InstrumentViewActions::m_model

private

Definition at line 56 of file InstrumentViewActions.h.

Referenced by initAddInstrumentMenu(), mapOfNames(), onCloneInstrument(), onRemoveInstrument(), setModel(), and updateSelection().

m_removeInstrumentAction

QAction* InstrumentViewActions::m_removeInstrumentAction

private

Definition at line 54 of file InstrumentViewActions.h.

Referenced by InstrumentViewActions(), onContextMenuRequest(), and setAllActionsEnabled().

m_selectionModel

QItemSelectionModel* InstrumentViewActions::m_selectionModel

private

Definition at line 57 of file InstrumentViewActions.h.

Referenced by onCloneInstrument(), onRemoveInstrument(), setSelectionModel(), and updateSelection().

---

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

• /home/www/ba/GUI/coregui/Views/InstrumentWidgets/InstrumentViewActions.h
• /home/www/ba/GUI/coregui/Views/InstrumentWidgets/InstrumentViewActions.cpp