ParameterContainerItem Class Reference

Description

The ParameterContainerItem is a top item to hold all ParameterItem, represents an entry point to parameter tuning tree. Part of JobItem.

Definition at line 81 of file ParameterTreeItems.h.

Collaboration diagram for ParameterContainerItem:

Public Member Functions
	ParameterContainerItem ()
ParameterItem *	findParameterItem (const QString &link) const
QObject *	parameterTreeRoot ()
void	readContentFrom (QXmlStreamReader *reader)
void	restoreBackupValues ()
void	setBackupValue (const QString &link, double d)
void	writeContentTo (QXmlStreamWriter *writer) const

Private Member Functions
void	restoreBackupValue (QObject *item)

Private Attributes
QMap< QString, double >	m_backupValues
std::unique_ptr< QObject >	m_parameterTreeRoot

Constructor & Destructor Documentation

ParameterContainerItem()

ParameterContainerItem::ParameterContainerItem

(

)

Definition at line 148 of file ParameterTreeItems.cpp.

{
    m_parameterTreeRoot.reset(new QObject());
}

References m_parameterTreeRoot.

Member Function Documentation

findParameterItem()

ParameterItem * ParameterContainerItem::findParameterItem

(

const QString &

link

)

const

Definition at line 215 of file ParameterTreeItems.cpp.

{
    return ::findParameterItem(m_parameterTreeRoot.get(), link);
}

References m_parameterTreeRoot.

Referenced by FitParameterContainerItem::setValuesInParameterContainer().

parameterTreeRoot()

QObject * ParameterContainerItem::parameterTreeRoot

(

)

Definition at line 220 of file ParameterTreeItems.cpp.

{
    return m_parameterTreeRoot.get();
}

References m_parameterTreeRoot.

readContentFrom()

void ParameterContainerItem::readContentFrom

(

QXmlStreamReader *

reader

)

Definition at line 167 of file ParameterTreeItems.cpp.

{
    m_backupValues.clear();
    const int version = reader->attributes().value(GUI::Session::XML::Version).toInt();
 
    if (version < 1)
        throw DeserializationException::tooOld();
 
    if (version > 1)
        throw DeserializationException::tooNew();
 
    while (reader->readNextStartElement()) {
        if (reader->name().toString() == Tags::BackupValues) {
            while (reader->readNextStartElement()) {
                ASSERT(reader->name().toString() == Tags::BackupValue);
                QString link;
                double d;
                GUI::Session::XML::readAttribute(reader, Tags::Link, &link);
                GUI::Session::XML::readAttribute(reader, Tags::Value, &d);
                m_backupValues[link] = d;
                reader->skipCurrentElement();
            }
        }
    }
}

References m_backupValues, GUI::Session::XML::readAttribute(), DeserializationException::tooNew(), DeserializationException::tooOld(), XML::Tags::Value(), and GUI::Session::XML::Version().

Referenced by JobItem::readNonSessionItems().

Here is the call graph for this function:

restoreBackupValue()

void ParameterContainerItem::restoreBackupValue ( QObject *  item )

private

Definition at line 198 of file ParameterTreeItems.cpp.

{
    ASSERT(item);
    if (auto* parameter = dynamic_cast<ParameterItem*>(item))
        if (m_backupValues.contains(parameter->link()))
            parameter->propagateValueToLink(m_backupValues[parameter->link()]);
 
    for (auto* child : item->children())
        restoreBackupValue(child);
}

References m_backupValues.

Referenced by restoreBackupValues().

restoreBackupValues()

void ParameterContainerItem::restoreBackupValues

(

)

Definition at line 209 of file ParameterTreeItems.cpp.

{
    for (auto* child : m_parameterTreeRoot->children())
        restoreBackupValue(child);
}

References m_parameterTreeRoot, and restoreBackupValue().

Referenced by JobModel::restore().

Here is the call graph for this function:

setBackupValue()

void ParameterContainerItem::setBackupValue	(	const QString &	link,
		double	d
	)

Definition at line 193 of file ParameterTreeItems.cpp.

{
    m_backupValues[link] = d;
}

References m_backupValues.

Referenced by ParameterTreeBuilder::addParameterItem().

writeContentTo()

void ParameterContainerItem::writeContentTo

(

QXmlStreamWriter *

writer

)

const

Definition at line 153 of file ParameterTreeItems.cpp.

{
    GUI::Session::XML::writeAttribute(writer, GUI::Session::XML::Version, int(1));
 
    writer->writeStartElement(Tags::BackupValues);
 
    for (auto v = m_backupValues.cbegin(); v != m_backupValues.cend(); v++) {
        writer->writeEmptyElement(Tags::BackupValue);
        GUI::Session::XML::writeAttribute(writer, Tags::Link, v.key());
        GUI::Session::XML::writeAttribute(writer, Tags::Value, v.value());
    }
    writer->writeEndElement();
}

References m_backupValues, XML::Tags::Value(), GUI::Session::XML::Version(), and GUI::Session::XML::writeAttribute().

Referenced by JobItem::writeNonSessionItems().

Here is the call graph for this function:

Member Data Documentation

m_backupValues

QMap<QString, double> ParameterContainerItem::m_backupValues

private

Definition at line 98 of file ParameterTreeItems.h.

Referenced by readContentFrom(), restoreBackupValue(), setBackupValue(), and writeContentTo().

m_parameterTreeRoot

std::unique_ptr<QObject> ParameterContainerItem::m_parameterTreeRoot

private

Definition at line 99 of file ParameterTreeItems.h.

Referenced by ParameterContainerItem(), findParameterItem(), parameterTreeRoot(), and restoreBackupValues().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Model/Job/ParameterTreeItems.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Model/Job/ParameterTreeItems.cpp