ParameterTreeUtils Namespace Reference

The ParameterTreeBuilder namespace contains helper functions to create container with ParameterItems. More...

Functions
void	createParameterTree (JobItem *jobItem)
QString	domainNameToParameterName (const QString &domainName, const SessionItem *source)
	Converts domain name to parameterItem name. More...
QVector< QPair< QString, QString > >	parameterDictionary (const SessionItem *source)
	Correspondance of parameter name to translated name for all properties found in source in its children. More...
QString	parameterNameToDomainName (const QString &parName, const SessionItem *source)
	Converts parameter name to domain name. More...
SessionItem *	parameterNameToLinkedItem (const QString &parName, const SessionItem *source)
	Converts parameter item name to the corresponding item in the tree below the source. More...
QStringList	parameterTreeNames (const SessionItem *source)
	Creates list with parameter names of source item. More...
void	populateParameterContainer (SessionItem *container, const SessionItem *source)
	Populates ParameterContainer with ParameterItem's corresponding to all properties found in a source item. More...
QStringList	translatedParameterTreeNames (const SessionItem *source)
	Creates domain translated list of parameter names for source item. More...
void	visitParameterContainer (SessionItem *container, std::function< void(ParameterItem *)> fun)
	Visit all ParameterItem in container and execute user function. More...

Detailed Description

The ParameterTreeBuilder namespace contains helper functions to create container with ParameterItems.

The ParameterItem appears in RealTimeView and provides real time tuning of MultiLayerItem and InstrumentItem.

Function Documentation

createParameterTree()

void ParameterTreeUtils::createParameterTree

(

JobItem *

jobItem

)

Definition at line 56 of file ParameterTreeUtils.cpp.

{
    auto container = jobItem->model()->insertItem<ParameterContainerItem>(
        jobItem, -1, JobItem::T_PARAMETER_TREE);
 
    populateParameterContainer(container, jobItem->getItem(JobItem::T_MATERIAL_CONTAINER));
 
    populateParameterContainer(container, jobItem->getItem(JobItem::T_SAMPLE));
 
    populateParameterContainer(container, jobItem->getItem(JobItem::T_INSTRUMENT));
 
#ifndef NDEBUG
    // Provides all items in "JobItem/Parameter Tree Container" with domain links already
    // at the stage of ParameterTree creation. It is necessary for validation, in Release mode
    // it will lead for unnecessary large project files.
    populateDomainLinks(container);
#endif
}

References SessionItem::getItem(), SessionModel::insertItem(), SessionItem::model(), populateParameterContainer(), JobItem::T_INSTRUMENT, JobItem::T_MATERIAL_CONTAINER, JobItem::T_PARAMETER_TREE, and JobItem::T_SAMPLE.

Referenced by JobModel::addJob().

Here is the call graph for this function:

domainNameToParameterName()

QString ParameterTreeUtils::domainNameToParameterName	(	const QString &	domainName,
		const SessionItem *	source
	)

Converts domain name to parameterItem name.

Parameter name should belong to item or one of its children.

Definition at line 168 of file ParameterTreeUtils.cpp.

{
    QString domain = removeLeadingSlash(domainName);
    for (auto pair : parameterDictionary(source)) { // parName, domainName
        if (pair.second == domain)
            return pair.first;
    }
 
    return {};
}

References parameterDictionary().

Referenced by ParticleDistributionItem::translateParameterNameToGUI().

Here is the call graph for this function:

parameterDictionary()

QVector< QPair< QString, QString > > ParameterTreeUtils::parameterDictionary

(

const SessionItem *

source

)

Correspondance of parameter name to translated name for all properties found in source in its children.

Definition at line 137 of file ParameterTreeUtils.cpp.

{
    ASSERT(source);
 
    QVector<QPair<QString, QString>> result;
 
    // Create container with ParameterItem's of given source item
    SampleModel model;
    auto container = model.insertItem<ParameterContainerItem>();
    populateParameterContainer(container, source);
 
    // Iterate through all ParameterItems and retrieve necessary data.
    visitParameterContainer(container, [&](ParameterItem* parItem) {
        // TODO replace with the method from ModelPath
        QString parPath = FitParameterHelper::getParameterItemPath(parItem);
 
        QString relPath =
            source->displayName() + "/" + parItem->getItemValue(ParameterItem::P_LINK).toString();
        SessionItem* linkedItem = ModelPath::getItemFromPath(relPath, source);
        QString translation = ModelPath::itemPathTranslation(*linkedItem, source->parent());
 
        result.push_back(QPair<QString, QString>(parPath, translation));
    });
    std::reverse(result.begin(), result.end());
 
    return result;
}

References ASSERT, SessionItem::displayName(), ModelPath::getItemFromPath(), SessionItem::getItemValue(), FitParameterHelper::getParameterItemPath(), SessionModel::insertItem(), ModelPath::itemPathTranslation(), ParameterItem::P_LINK, SessionItem::parent(), populateParameterContainer(), and visitParameterContainer().

Referenced by domainNameToParameterName(), parameterNameToDomainName(), parameterTreeNames(), and translatedParameterTreeNames().

Here is the call graph for this function:

parameterNameToDomainName()

QString ParameterTreeUtils::parameterNameToDomainName	(	const QString &	parName,
		const SessionItem *	source
	)

Converts parameter name to domain name.

Parameter name should belong to item or one of its children.

Definition at line 183 of file ParameterTreeUtils.cpp.

{
    for (auto pair : parameterDictionary(source)) // parName, domainName
        if (pair.first == parName)
            return "/" + pair.second;
 
    return {};
}

References parameterDictionary().

Referenced by ParticleDistributionItem::domainLinkedParameters(), and ParticleDistributionItem::domainMainParameter().

Here is the call graph for this function:

parameterNameToLinkedItem()

SessionItem * ParameterTreeUtils::parameterNameToLinkedItem	(	const QString &	parName,
		const SessionItem *	source
	)

Converts parameter item name to the corresponding item in the tree below the source.

Definition at line 195 of file ParameterTreeUtils.cpp.

{
    SampleModel model;
    auto container = model.insertItem<ParameterContainerItem>();
    populateParameterContainer(container, source);
 
    // Iterate through all ParameterItems and retrieve necessary data.
    SessionItem* result(nullptr);
    visitParameterContainer(container, [&](ParameterItem* parItem) {
        // TODO replace with the method from ModelPath
        QString parPath = FitParameterHelper::getParameterItemPath(parItem);
        if (parPath == parName) {
            QString relPath = source->displayName() + "/"
                              + parItem->getItemValue(ParameterItem::P_LINK).toString();
            result = ModelPath::getItemFromPath(relPath, source);
        }
    });
 
    return result;
}

References SessionItem::displayName(), ModelPath::getItemFromPath(), SessionItem::getItemValue(), FitParameterHelper::getParameterItemPath(), SessionModel::insertItem(), ParameterItem::P_LINK, populateParameterContainer(), and visitParameterContainer().

Here is the call graph for this function:

parameterTreeNames()

QStringList ParameterTreeUtils::parameterTreeNames

(

const SessionItem *

source

)

Creates list with parameter names of source item.

Definition at line 112 of file ParameterTreeUtils.cpp.

{
    QStringList result;
 
    for (auto pair : parameterDictionary(source))
        result << pair.first;
 
    return result;
}

References parameterDictionary().

Referenced by ParticleDistributionItem::childParameterNames().

Here is the call graph for this function:

populateParameterContainer()

void ParameterTreeUtils::populateParameterContainer	(	SessionItem *	container,
		const SessionItem *	source
	)

Populates ParameterContainer with ParameterItem's corresponding to all properties found in a source item.

Definition at line 78 of file ParameterTreeUtils.cpp.

{
    if (container->modelType() != "Parameter Container")
        throw GUIHelpers::Error("ParameterTreeUtils::populateParameterContainer() -> Error. "
                                "Not a ParameterContainerType.");
 
    auto sourceLabel = container->model()->insertItem<ParameterLabelItem>(container);
    handleItem(sourceLabel, source);
}

References SessionModel::insertItem(), SessionItem::model(), and SessionItem::modelType().

Referenced by createParameterTree(), parameterDictionary(), and parameterNameToLinkedItem().

Here is the call graph for this function:

translatedParameterTreeNames()

QStringList ParameterTreeUtils::translatedParameterTreeNames

(

const SessionItem *

source

)

Creates domain translated list of parameter names for source item.

Definition at line 124 of file ParameterTreeUtils.cpp.

{
    QStringList result;
 
    for (auto pair : parameterDictionary(source))
        result << pair.second;
 
    return result;
}

References parameterDictionary().

Here is the call graph for this function:

visitParameterContainer()

void ParameterTreeUtils::visitParameterContainer	(	SessionItem *	container,
		std::function< void(ParameterItem *)>	fun
	)

Visit all ParameterItem in container and execute user function.

Definition at line 91 of file ParameterTreeUtils.cpp.

{
    SessionItem* current(container);
    QStack<SessionItem*> stack;
    stack.push(current);
    while (!stack.empty()) {
        current = stack.pop();
        if (current->modelType() == "Parameter Label"
            || current->modelType() == "Parameter Container") {
            for (SessionItem* child : current->getItems())
                stack.push(child);
        } else {
            if (ParameterItem* parItem = dynamic_cast<ParameterItem*>(current))
                fun(parItem);
        }
    }
}

References SessionItem::getItems(), and SessionItem::modelType().

Referenced by parameterDictionary(), and parameterNameToLinkedItem().

Here is the call graph for this function: