InstrumentCollection Class Reference

Description

Definition at line 27 of file InstrumentCollection.h.

Public Member Functions
	~InstrumentCollection ()
template<typename T >
T *	addInstrument ()
void	clear ()
QVector< InstrumentItem * >	collectedItems () const
void	emplace_back (InstrumentItem *item)
InstrumentItem *	findInstrumentById (const QString &instrumentId) const
InstrumentItem *	insertCopy (const InstrumentItem &source)
	Inserts a deep copy (also of any non xml data in a pointwise axis) The id will not be copied, but a new unique one will be created Returns the newly created instrument. More...
QVector< Instrument2DItem * >	instrument2DItems () const
bool	instrumentExists (const QString &instrumentId) const
QVector< InstrumentItem * >	instrumentItems (const std::function< bool(const InstrumentItem *)> &accept) const
QStringList	instrumentNames () const
void	removeInstrument (InstrumentItem *instrument)
void	serialize (Streamer &s)
QString	suggestInstrumentName (const QString &baseName) const

Private Attributes
QVector< InstrumentItem * >	m_instruments

Constructor & Destructor Documentation

~InstrumentCollection()

InstrumentCollection::~InstrumentCollection

(

)

Definition at line 22 of file InstrumentCollection.cpp.

{
    qDeleteAll(m_instruments);
}

References m_instruments.

Member Function Documentation

addInstrument()

template<typename T >

T* InstrumentCollection::addInstrument ( )

inline

Definition at line 32 of file InstrumentCollection.h.

    {
        auto* t = new T();
        m_instruments << t;
        return t;
    }

References m_instruments.

Referenced by InstrumentsEditController::addInstrument().

clear()

void InstrumentCollection::clear

(

)

Definition at line 27 of file InstrumentCollection.cpp.

{
    qDeleteAll(m_instruments);
    m_instruments.clear();
}

References m_instruments.

Referenced by InstrumentLibrary::load().

collectedItems()

QVector< InstrumentItem * > InstrumentCollection::collectedItems

(

)

const

Definition at line 47 of file InstrumentCollection.cpp.

{
    return m_instruments;
}

References m_instruments.

Referenced by InstrumentListModel::addNewInstrument(), InstrumentLibrary::collectedItems(), SimulationView::collectedItems(), InstrumentListModel::copyInstrument(), InstrumentListModel::data(), findInstrumentById(), instrument2DItems(), InstrumentListModel::instrumentForIndex(), instrumentItems(), instrumentNames(), InstrumentLibrary::isEmpty(), InstrumentListModel::onInstrumentNameChanged(), ProjectSettingsView::onSingleInstrumentRadioToggled(), InstrumentListModel::rowCount(), and RealDataPropertiesWidget::updateInstrumentComboEntries().

emplace_back()

void InstrumentCollection::emplace_back ( InstrumentItem *  item )

inline

Definition at line 44 of file InstrumentCollection.h.

{ m_instruments.push_back(item); } // TODO Qt6 emplace

References m_instruments.

Referenced by GUI::Transform::FromCore::itemizeInstruments().

findInstrumentById()

InstrumentItem * InstrumentCollection::findInstrumentById

(

const QString &

instrumentId

)

const

Definition at line 86 of file InstrumentCollection.cpp.

{
    for (auto* instrument : collectedItems())
        if (instrument->id() == instrumentId)
            return instrument;
 
    return nullptr;
}

References collectedItems().

Referenced by LinkInstrumentManager::canLinkDataToInstrument(), instrumentExists(), and RealDataPropertiesWidget::onInstrumentComboIndexChanged().

Here is the call graph for this function:

insertCopy()

InstrumentItem * InstrumentCollection::insertCopy

(

const InstrumentItem &

source

)

Inserts a deep copy (also of any non xml data in a pointwise axis) The id will not be copied, but a new unique one will be created Returns the newly created instrument.

Definition at line 39 of file InstrumentCollection.cpp.

{
    auto* copy = source.createCopy();
    copy->setId(QUuid::createUuid().toString());
    m_instruments << copy;
    return copy;
}

References InstrumentItem::createCopy(), m_instruments, InstrumentItem::setId(), and GUI::View::PropertyEditorFactory::toString().

Referenced by InstrumentsEditController::addCopy().

Here is the call graph for this function:

instrument2DItems()

QVector< Instrument2DItem * > InstrumentCollection::instrument2DItems

(

)

const

Definition at line 76 of file InstrumentCollection.cpp.

{
    QVector<Instrument2DItem*> result;
    for (auto* p : collectedItems())
        if (auto* p2D = dynamic_cast<Instrument2DItem*>(p))
            result << p2D;
 
    return result;
}

References collectedItems().

Here is the call graph for this function:

instrumentExists()

bool InstrumentCollection::instrumentExists

(

const QString &

instrumentId

)

const

Definition at line 95 of file InstrumentCollection.cpp.

{
    return findInstrumentById(instrumentId) != nullptr;
}

References findInstrumentById().

Referenced by LinkInstrumentManager::onInstrumentAddedOrRemoved().

Here is the call graph for this function:

instrumentItems()

QVector< InstrumentItem * > InstrumentCollection::instrumentItems

(

const std::function< bool(const InstrumentItem *)> &

accept

)

const

Definition at line 65 of file InstrumentCollection.cpp.

{
    QVector<InstrumentItem*> result;
    for (auto* p : collectedItems())
        if (accept(p))
            result << p;
 
    return result;
}

References collectedItems().

Referenced by InstrumentsTreeModel::instruments().

Here is the call graph for this function:

instrumentNames()

QStringList InstrumentCollection::instrumentNames

(

)

const

Definition at line 52 of file InstrumentCollection.cpp.

{
    QStringList existingNames;
    for (const auto* item : collectedItems())
        existingNames << item->instrumentName();
    return existingNames;
}

References collectedItems().

Referenced by suggestInstrumentName(), and SimulationView::writeOptionsToUI().

Here is the call graph for this function:

removeInstrument()

void InstrumentCollection::removeInstrument

(

InstrumentItem *

instrument

)

Definition at line 100 of file InstrumentCollection.cpp.

{
    m_instruments.removeAll(instrument);
    delete instrument;
}

References m_instruments.

Referenced by InstrumentsEditController::removeInstrument(), and InstrumentsTreeModel::removeItem().

serialize()

void InstrumentCollection::serialize

(

Streamer &

s

)

Definition at line 33 of file InstrumentCollection.cpp.

{
    s.assertVersion(0);
    Serialize::rwCatalogized<InstrumentItemCatalog>(s, "InstrumentCollection", m_instruments);
}

References Streamer::assertVersion(), and m_instruments.

Referenced by InstrumentLibrary::load(), ProjectDocument::readProject(), InstrumentLibrary::saveIfModified(), and ProjectDocument::writeTo().

Here is the call graph for this function:

suggestInstrumentName()

QString InstrumentCollection::suggestInstrumentName

(

const QString &

baseName

)

const

Definition at line 60 of file InstrumentCollection.cpp.

{
    return GUI::Util::String::suggestName(instrumentNames(), baseName);
}

References GUI::Util::Path::baseName(), instrumentNames(), and GUI::Util::String::suggestName().

Referenced by InstrumentListModel::addNewInstrument(), InstrumentListModel::copyInstrument(), and InstrumentLibrary::suggestName().

Here is the call graph for this function:

Member Data Documentation

m_instruments

QVector<InstrumentItem*> InstrumentCollection::m_instruments

private

Definition at line 63 of file InstrumentCollection.h.

Referenced by ~InstrumentCollection(), addInstrument(), clear(), collectedItems(), emplace_back(), insertCopy(), removeInstrument(), and serialize().

---

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

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