InstrumentLibrary Class Reference

Description

Definition at line 21 of file InstrumentLibrary.h.

Collaboration diagram for InstrumentLibrary:

Public Member Functions
	InstrumentLibrary ()
InstrumentItem *	add (const QString &name, const InstrumentItem &itemToCopy)
	Returns the new element. More...
InstrumentCollection *	collectedItems ()
QList< InstrumentItem * >	collectedItems () const
InstrumentsEditController *	editController ()
bool	isEmpty () const
bool	load ()
bool	saveIfModified ()
QString	suggestName (const QString &name) const

Private Attributes
InstrumentsEditController	m_ec
InstrumentCollection	m_instrumentItems
bool	m_modified

Constructor & Destructor Documentation

InstrumentLibrary()

InstrumentLibrary::InstrumentLibrary

(

)

Definition at line 36 of file InstrumentLibrary.cpp.

    : m_ec(&m_instrumentItems)
    , m_modified(false)
{
    QObject::connect(&m_ec, &InstrumentsEditController::instrumentChanged,
                     [&]() { m_modified = true; });
    QObject::connect(&m_ec, &InstrumentsEditController::instrumentAddedOrRemoved,
                     [&]() { m_modified = true; });
}

References InstrumentsEditController::instrumentAddedOrRemoved(), InstrumentsEditController::instrumentChanged(), m_ec, and m_modified.

Member Function Documentation

add()

InstrumentItem * InstrumentLibrary::add	(	const QString &	name,
		const InstrumentItem &	itemToCopy
	)

Returns the new element.

Definition at line 51 of file InstrumentLibrary.cpp.

{
    return m_ec.addCopy(&itemToCopy, name);
}

References InstrumentsEditController::addCopy(), m_ec, and GUI::RealSpace::Particles::name().

Referenced by InstrumentLibraryEditor::execAdd().

Here is the call graph for this function:

collectedItems() [1/2]

InstrumentCollection * InstrumentLibrary::collectedItems

(

)

Definition at line 140 of file InstrumentLibrary.cpp.

{
    return &m_instrumentItems;
}

References m_instrumentItems.

collectedItems() [2/2]

QList< InstrumentItem * > InstrumentLibrary::collectedItems

(

)

const

Definition at line 61 of file InstrumentLibrary.cpp.

{
    return m_instrumentItems.collectedItems().toList();
}

References InstrumentCollection::collectedItems(), and m_instrumentItems.

Here is the call graph for this function:

editController()

InstrumentsEditController * InstrumentLibrary::editController

(

)

Definition at line 66 of file InstrumentLibrary.cpp.

{
    return &m_ec;
}

References m_ec.

Referenced by InstrumentLibraryEditor::createWidgetsForCurrentInstrument(), and InstrumentLibraryEditor::onInstrumentChangedByEditor().

isEmpty()

bool InstrumentLibrary::isEmpty

(

)

const

Definition at line 56 of file InstrumentLibrary.cpp.

{
    return m_instrumentItems.collectedItems().isEmpty();
}

References InstrumentCollection::collectedItems(), and m_instrumentItems.

Referenced by InstrumentListView::onLoadFromLibrary().

Here is the call graph for this function:

load()

bool InstrumentLibrary::load

(

)

Definition at line 97 of file InstrumentLibrary.cpp.

{
    m_modified = false;
    m_instrumentItems.clear();
 
    QFile file(instrumentLibraryFilePath());
    if (!file.open(QIODevice::ReadOnly | QIODevice::Text))
        return false;
 
    try {
        QXmlStreamReader reader(&file);
 
        while (!reader.atEnd()) {
            reader.readNext();
            if (reader.isStartElement()) {
                if (reader.name() == XML_ROOT_TAG) {
                    const int foundVersion =
                        reader.attributes().value(XML_VERSION_TAG).toString().toInt();
                    if (foundVersion != 2)
                        return false;
 
                    Streamer sInstruments(&reader);
                    m_instrumentItems.serialize(sInstruments);
                }
            }
        }
 
        if (reader.hasError()) {
            m_instrumentItems.clear();
            return false;
        }
 
        file.close();
        return true;
    } catch (const std::exception&) {
        m_instrumentItems.clear();
        return false;
    } catch (const DeserializationException&) {
        m_instrumentItems.clear();
        return false;
    }
}

References InstrumentCollection::clear(), m_instrumentItems, m_modified, and InstrumentCollection::serialize().

Referenced by main().

Here is the call graph for this function:

saveIfModified()

bool InstrumentLibrary::saveIfModified

(

)

Definition at line 71 of file InstrumentLibrary.cpp.

{
    if (!m_modified)
        return true;
 
    QFile file(instrumentLibraryFilePath());
    if (!file.open(QFile::ReadWrite | QIODevice::Truncate | QFile::Text))
        return false;
 
    QXmlStreamWriter writer(&file);
    writer.setAutoFormatting(true);
    writer.writeStartDocument();
    writer.writeStartElement(XML_ROOT_TAG);
    writer.writeAttribute(XML_VERSION_TAG, "2");
 
    Streamer sInstruments(&writer);
    m_instrumentItems.serialize(sInstruments);
 
    writer.writeEndElement();
    writer.writeEndDocument();
 
    file.close();
    m_modified = false;
    return true;
}

References m_instrumentItems, m_modified, and InstrumentCollection::serialize().

Referenced by main().

Here is the call graph for this function:

suggestName()

QString InstrumentLibrary::suggestName

(

const QString &

name

)

const

Definition at line 46 of file InstrumentLibrary.cpp.

{
    return m_instrumentItems.suggestInstrumentName(name);
}

References m_instrumentItems, GUI::RealSpace::Particles::name(), and InstrumentCollection::suggestInstrumentName().

Referenced by InstrumentLibraryEditor::execAdd().

Here is the call graph for this function:

Member Data Documentation

m_ec

InstrumentsEditController InstrumentLibrary::m_ec

private

Definition at line 41 of file InstrumentLibrary.h.

Referenced by InstrumentLibrary(), add(), and editController().

m_instrumentItems

InstrumentCollection InstrumentLibrary::m_instrumentItems

private

Definition at line 40 of file InstrumentLibrary.h.

Referenced by collectedItems(), isEmpty(), load(), saveIfModified(), and suggestName().

m_modified

bool InstrumentLibrary::m_modified

private

Definition at line 42 of file InstrumentLibrary.h.

Referenced by InstrumentLibrary(), load(), and saveIfModified().

---

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

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