SimAnMinimizerItem Class Reference

Description

The SimAnMinimizerItem class represents settings for GSL's simulated annealing minimizer.

Definition at line 116 of file MinimizerItem.h.

Inheritance diagram for SimAnMinimizerItem:

Collaboration diagram for SimAnMinimizerItem:

Public Member Functions
	SimAnMinimizerItem ()
QVector< QString >	acceptableDefaultItemTypes () const
	Returns vector of acceptable default tag types. More...
bool	acceptsAsDefaultItem (const QString &item_name) const
	Returns true if model type can be added to default tag. More...
SessionItem *	addGroupProperty (const QString &groupTag, const GroupInfo &groupInfo)
template<typename T >
T *	addProperty (const QString &name)
SessionItem *	addProperty (const QString &name, const QVariant &variant)
	Add new property item and register new tag. name is the tag name and the display name. The property's value will be set to variant. More...
virtual bool	allowWritingChildToXml (SessionItem *child) const
SessionItem *	childAt (int row) const
	Returns the child at the given row. More...
QVector< SessionItem * >	children () const
	Returns vector of all children. More...
template<typename T >
QVector< T * >	childrenOfType () const
QVector< SessionItem * >	childrenOfType (const QString &model_type) const
	Returns a vector of all children of the given type. More...
std::unique_ptr< IMinimizer >	createMinimizer () const override
int	decimals () const
QString	defaultTag () const
	Get default tag. More...
virtual void	deserializeBinaryData (const QByteArray &data)
QString	displayName () const
	Get display name of item, append index if ambigue. More...
void	emitDataChanged (int role=Qt::DisplayRole)
	Notify model about data changes. More...
template<typename T >
T *	firstChildOfType () const
SessionItem *	getChildOfType (const QString &type) const
	Returns the first child of the given type. More...
SessionItem *	getGroupItem (const QString &groupName) const
	Access subitem of group item. More...
SessionItem *	getItem (const QString &tag="", int row=0) const
	Returns item in given row of given tag. More...
QVector< SessionItem * >	getItems (const QString &tag="") const
	Returns vector of all items of given tag. More...
QVariant	getItemValue (const QString &tag) const
	Directly access value of item under given tag. More...
QVector< int >	getRoles () const
	Returns vector of all present roles. More...
template<typename T >
T &	groupItem (const QString &groupName) const
bool	hasChildren () const
	Indicates whether this SessionItem has any child items. More...
template<typename T >
bool	hasModelType () const
QModelIndex	index () const
	Returns model index of this item. More...
void	insertChild (int row, SessionItem *item, const QString &tag="")
	Insert item into given tag into given row. More...
bool	isEditable () const
bool	isEnabled () const
bool	isTag (const QString &name) const
	Returns true if tag is available. More...
template<typename T >
T *	item (const QString &tag) const
QString	itemName () const
	Get item name, return display name if no name is set. More...
template<typename T >
QVector< T * >	items (const QString &tag="") const
RealLimits	limits () const
ModelMapper *	mapper ()
	Returns the current model mapper of this item. Creates new one if necessary. More...
SessionModel *	model () const
	Returns model of this item. More...
QString	modelType () const
	Get model type. More...
int	numberOfChildren () const
	Returns total number of children. More...
SessionItem *	parentItem () const
	Returns parent of this item. More...
int	parentRow ()
	Returns the index of the given item within its parent. Returns -1 when no parent is set. More...
virtual void	readNonSessionItems (QXmlStreamReader *reader)
bool	registerTag (const QString &name, int min=0, int max=-1, QStringList modelTypes={})
	Add new tag to this item with given name, min, max and types. max = -1 -> unlimited, modelTypes empty -> all types allowed. More...
QVariant	roleProperty (int role) const
	Returns corresponding variant under given role, invalid variant when role is not present. More...
int	rowOfChild (SessionItem *child) const
	Returns row index of given child. More...
virtual QByteArray	serializeBinaryData () const
const SessionItemTags *	sessionItemTags () const
SessionItem &	setDecimals (int n)
void	setDefaultTag (const QString &tag)
	Set default tag. More...
void	setDisplayName (const QString &display_name)
	Set display name. More...
void	setEditable (bool enabled)
void	setEnabled (bool enabled)
	Flags accessors. More...
SessionItem *	setGroupProperty (const QString &groupTag, const QString &modelType) const
	Set the current type of group item. More...
template<typename T >
T *	setGroupPropertyType (const QString &groupTag)
void	setItemName (const QString &name)
	Set item name, add property if necessary. More...
void	setItemValue (const QString &tag, const QVariant &variant) const
	Directly set value of item under given tag. More...
SessionItem &	setLimits (const RealLimits &value)
bool	setRoleProperty (int role, const QVariant &value)
	Set the contained role property to the given value. See also setTranslatorForRolePropertySetter. More...
SessionItem &	setToolTip (const QString &tooltip)
bool	setValue (QVariant value)
	Set value, ensure that variant types match. More...
QString	tagFromItem (const SessionItem *item) const
	Returns the tag name of given item when existing. More...
SessionItem *	takeItem (int row, const QString &tag)
	Remove item from given row from given tag. More...
SessionItem *	takeRow (int row)
	Removes row from item and returns the item. More...
QString	toolTip () const
QVariant	value () const
	Get value. More...
ValueDescriptors	valueDescriptorsForUI () const override
virtual void	writeNonSessionItems (QXmlStreamWriter *writer) const

Static Public Member Functions
static bool	isItemNamePropertyName (const QString &name)

Static Public Attributes
static constexpr auto	M_TYPE {"GSLSimAn"}

Private Member Functions
void	changeFlags (bool enabled, int flag)
	internal More...
void	childDeleted (SessionItem *child)
int	flags () const
int	getCopyNumberOfChild (const SessionItem *item) const
	internal More...
void	setModel (SessionModel *model)
void	setParentAndModel (SessionItem *parent, SessionModel *model)

Private Attributes
QVector< SessionItem * >	m_children
std::unique_ptr< ModelMapper >	m_mapper
SessionModel *	m_model
SessionItem *	m_parent
std::unique_ptr< SessionItemData >	m_properties
std::unique_ptr< SessionItemTags >	m_tags

Static Private Attributes
static constexpr auto	P_BOLTZMANN_K {"k"}
static constexpr auto	P_BOLTZMANN_MU {"mu"}
static constexpr auto	P_BOLTZMANN_TINIT {"t_init"}
static constexpr auto	P_BOLTZMANN_TMIN {"t_min"}
static constexpr auto	P_ITERATIONSTEMP {"IterationsAtTemp"}
static constexpr auto	P_MAXITERATIONS {"MaxIterations"}
static constexpr auto	P_NAME {"Name"}
static constexpr auto	P_STEPSIZE {"StepSize"}

Constructor & Destructor Documentation

SimAnMinimizerItem()

SimAnMinimizerItem::SimAnMinimizerItem

(

)

Definition at line 207 of file MinimizerItem.cpp.

    : MinimizerItem(M_TYPE)
{
    addProperty(P_MAXITERATIONS, 100)->setToolTip("Number of points to try for each step");
    addProperty(P_ITERATIONSTEMP, 10)->setToolTip("Number of iterations at each temperature");
    addProperty(P_STEPSIZE, 1.0)->setToolTip("Max step size used in random walk");
    addProperty(P_BOLTZMANN_K, 1.0)->setToolTip("Boltzmann k");
    addProperty(P_BOLTZMANN_TINIT, 50.0)->setToolTip("Boltzmann initial temperature");
    addProperty(P_BOLTZMANN_MU, 1.05)->setToolTip("Boltzmann mu");
    addProperty(P_BOLTZMANN_TMIN, 0.1)->setToolTip("Boltzmann minimal temperature");
}

References SessionItem::addProperty(), P_BOLTZMANN_K, P_BOLTZMANN_MU, P_BOLTZMANN_TINIT, P_BOLTZMANN_TMIN, P_ITERATIONSTEMP, P_MAXITERATIONS, P_STEPSIZE, and SessionItem::setToolTip().

Here is the call graph for this function:

Member Function Documentation

acceptableDefaultItemTypes()

QVector< QString > SessionItem::acceptableDefaultItemTypes ( ) const

inherited

Returns vector of acceptable default tag types.

Definition at line 193 of file SessionItem.cpp.

{
    return m_tags->modelTypesForTag(defaultTag()).toVector();
}

References SessionItem::defaultTag(), and SessionItem::m_tags.

Here is the call graph for this function:

acceptsAsDefaultItem()

bool SessionItem::acceptsAsDefaultItem ( const QString &  item_name ) const

inherited

Returns true if model type can be added to default tag.

Definition at line 186 of file SessionItem.cpp.

{
    return m_tags->isValid(defaultTag(), item_name);
}

References SessionItem::defaultTag(), and SessionItem::m_tags.

Here is the call graph for this function:

addGroupProperty()

SessionItem * SessionItem::addGroupProperty ( const QString &  groupTag, const GroupInfo &  groupInfo  )

inherited

Definition at line 306 of file SessionItem.cpp.

{
    GroupItem* groupItem =
        dynamic_cast<GroupItem*>(GUI::Model::ItemFactory::CreateItem(GroupItem::M_TYPE));
    ASSERT(groupItem);
    groupItem->setGroupInfo(groupInfo);
    registerTag(groupTag, 1, 1, {GroupItem::M_TYPE});
    groupItem->setDisplayName(groupTag);
    insertChild(0, groupItem, groupTag);
    return groupItem;
}

References GUI::Model::ItemFactory::CreateItem(), SessionItem::groupItem(), SessionItem::insertChild(), GroupItem::M_TYPE, and SessionItem::registerTag().

Referenced by MinimizerContainerItem::MinimizerContainerItem().

Here is the call graph for this function:

addProperty() [1/2]

template<typename T >

T * SessionItem::addProperty ( const QString &  name )

inherited

Definition at line 394 of file SessionItem.h.

{
    auto property = new T;
    property->setDisplayName(tagname);
    registerTag(tagname, 1, 1, QStringList() << property->modelType());
    insertChild(0, property, tagname);
    return property;
}

References SessionItem::insertChild(), SessionItem::registerTag(), and SessionItem::setDisplayName().

Here is the call graph for this function:

addProperty() [2/2]

SessionItem * SessionItem::addProperty ( const QString &  name, const QVariant &  variant  )

inherited

Add new property item and register new tag. name is the tag name and the display name. The property's value will be set to variant.

Definition at line 278 of file SessionItem.cpp.

{
    ASSERT(!isTag(name));
 
    SessionItem* property = GUI::Model::ItemFactory::CreateItem(PropertyItem::M_TYPE);
    property->setDisplayName(name);
    registerTag(name, 1, 1, {PropertyItem::M_TYPE});
    insertChild(0, property, name);
    property->setValue(variant);
    return property;
}

References GUI::Model::ItemFactory::CreateItem(), SessionItem::insertChild(), SessionItem::isTag(), PropertyItem::M_TYPE, GUI::RealSpace::Particles::name(), and SessionItem::registerTag().

Referenced by AmplitudeAxisItem::AmplitudeAxisItem(), BasicAxisItem::BasicAxisItem(), Data1DProperties::Data1DProperties(), Data1DViewItem::Data1DViewItem(), DataItem::DataItem(), DataProperties::DataProperties(), EllipseItem::EllipseItem(), FitParameterItem::FitParameterItem(), FitParameterLinkItem::FitParameterLinkItem(), FitSuiteItem::FitSuiteItem(), GeneticMinimizerItem::GeneticMinimizerItem(), GSLLMAMinimizerItem::GSLLMAMinimizerItem(), GSLMultiMinimizerItem::GSLMultiMinimizerItem(), HorizontalLineItem::HorizontalLineItem(), IntensityDataItem::IntensityDataItem(), JobItem::JobItem(), MaskItem::MaskItem(), MinimizerContainerItem::MinimizerContainerItem(), MinuitMinimizerItem::MinuitMinimizerItem(), PointwiseAxisItem::PointwiseAxisItem(), PolygonItem::PolygonItem(), PolygonPointItem::PolygonPointItem(), RealDataItem::RealDataItem(), RectangleItem::RectangleItem(), SimAnMinimizerItem(), SpecularDataItem::SpecularDataItem(), VerticalLineItem::VerticalLineItem(), and SessionItem::setItemName().

Here is the call graph for this function:

allowWritingChildToXml()

bool SessionItem::allowWritingChildToXml ( SessionItem *  child ) const

virtualinherited

Definition at line 528 of file SessionItem.cpp.

{
    return true;
}

Referenced by GUI::Session::XML::writeItemAndChildItems().

changeFlags()

void SessionItem::changeFlags ( bool  enabled, int  flag  )

privateinherited

internal

Definition at line 568 of file SessionItem.cpp.

{
    int flags = this->flags();
    if (enabled)
        flags |= flag;
    else
        flags &= ~flag;
 
    setRoleProperty(SessionFlags::FlagRole, flags);
}

References SessionFlags::FlagRole, SessionItem::flags(), and SessionItem::setRoleProperty().

Referenced by SessionItem::setEditable(), and SessionItem::setEnabled().

Here is the call graph for this function:

childAt()

SessionItem * SessionItem::childAt ( int  row ) const

inherited

Returns the child at the given row.

Definition at line 102 of file SessionItem.cpp.

{
    return m_children.value(row, nullptr);
}

References SessionItem::m_children.

Referenced by SessionModel::index(), and SessionItem::takeRow().

childDeleted()

void SessionItem::childDeleted ( SessionItem *  child )

privateinherited

Definition at line 533 of file SessionItem.cpp.

{
    int index = rowOfChild(child);
    ASSERT(index != -1);
    m_children.replace(index, nullptr);
}

References SessionItem::index(), SessionItem::m_children, and SessionItem::rowOfChild().

Referenced by SessionItem::~SessionItem().

Here is the call graph for this function:

children()

QVector< SessionItem * > SessionItem::children ( ) const

inherited

Returns vector of all children.

Definition at line 95 of file SessionItem.cpp.

{
    return m_children;
}

References SessionItem::m_children.

Referenced by MaskContainerItem::maskItems(), DataPropertyContainer::propertyItem(), and GUI::Session::XML::writeItemAndChildItems().

childrenOfType() [1/2]

template<typename T >

QVector< T * > SessionItem::childrenOfType

inherited

Definition at line 372 of file SessionItem.h.

{
    QVector<T*> result;
    for (auto* child : m_children)
        if (child->modelType() == T::M_TYPE)
            result.append(dynamic_cast<T*>(child));
 
    return result;
}

References SessionItem::m_children.

childrenOfType() [2/2]

QVector< SessionItem * > SessionItem::childrenOfType ( const QString &  model_type ) const

inherited

Returns a vector of all children of the given type.

Definition at line 127 of file SessionItem.cpp.

{
    QVector<SessionItem*> result;
    for (auto* child : m_children)
        if (child->modelType() == model_type)
            result.append(child);
 
    return result;
}

References SessionItem::m_children.

Referenced by ProjectionsPlot::projectionItems(), and SaveProjectionsAssistant::projectionItems().

createMinimizer()

std::unique_ptr< IMinimizer > SimAnMinimizerItem::createMinimizer ( ) const

overridevirtual

Implements MinimizerItem.

Definition at line 219 of file MinimizerItem.cpp.

{
    auto* domainMinimizer = new SimAnMinimizer();
    domainMinimizer->setMaxIterations(getItemValue(P_MAXITERATIONS).toInt());
    domainMinimizer->setIterationsAtEachTemp(getItemValue(P_ITERATIONSTEMP).toInt());
    domainMinimizer->setStepSize(getItemValue(P_STEPSIZE).toDouble());
    domainMinimizer->setBoltzmannK(getItemValue(P_BOLTZMANN_K).toDouble());
    domainMinimizer->setBoltzmannInitialTemp(getItemValue(P_BOLTZMANN_TINIT).toDouble());
    domainMinimizer->setBoltzmannMu(getItemValue(P_BOLTZMANN_MU).toDouble());
    domainMinimizer->setBoltzmannMinTemp(getItemValue(P_BOLTZMANN_TMIN).toDouble());
    return std::unique_ptr<IMinimizer>(domainMinimizer);
}

References SessionItem::getItemValue(), P_BOLTZMANN_K, P_BOLTZMANN_MU, P_BOLTZMANN_TINIT, P_BOLTZMANN_TMIN, P_ITERATIONSTEMP, P_MAXITERATIONS, and P_STEPSIZE.

Here is the call graph for this function:

decimals()

int SessionItem::decimals ( ) const

inherited

Definition at line 484 of file SessionItem.cpp.

{
    return roleProperty(SessionFlags::DecimalRole).toInt();
}

References SessionFlags::DecimalRole, and SessionItem::roleProperty().

Referenced by GUI::View::PropertyEditorFactory::CreateEditor().

Here is the call graph for this function:

defaultTag()

QString SessionItem::defaultTag ( ) const

inherited

Get default tag.

Definition at line 390 of file SessionItem.cpp.

{
    return roleProperty(SessionFlags::DefaultTagRole).toString();
}

References SessionFlags::DefaultTagRole, and SessionItem::roleProperty().

Referenced by SessionItem::acceptableDefaultItemTypes(), SessionItem::acceptsAsDefaultItem(), SessionModel::copy(), SessionItem::getItem(), SessionItem::getItems(), SessionItem::insertChild(), SessionModel::insertNewItem(), SessionModel::moveItem(), and SessionItem::takeItem().

Here is the call graph for this function:

deserializeBinaryData()

void SessionItem::deserializeBinaryData ( const QByteArray &  data )

virtualinherited

Reimplemented in PointwiseAxisItem, and RealDataItem.

Definition at line 522 of file SessionItem.cpp.

{}

Referenced by GUI::Session::XML::readItems().

displayName()

QString SessionItem::displayName ( ) const

inherited

Get display name of item, append index if ambigue.

Definition at line 404 of file SessionItem.cpp.

{
    QString result = roleProperty(SessionFlags::DisplayNameRole).toString();
 
    if (hasModelType<PropertyItem>() || hasModelType<GroupItem>())
        return result;
 
    if (m_parent) {
        QString tag = m_parent->tagFromItem(this);
        // if only one child of this type is allowed, return name without change
        if (m_parent->sessionItemTags()->isSingleItemTag(tag))
            return result;
 
        int index = m_parent->getCopyNumberOfChild(this);
        if (index >= 0)
            return result + QString::number(index);
    }
    return result;
}

References SessionFlags::DisplayNameRole, SessionItem::getCopyNumberOfChild(), SessionItem::index(), SessionItemTags::isSingleItemTag(), SessionItem::m_parent, SessionItem::roleProperty(), SessionItem::sessionItemTags(), and SessionItem::tagFromItem().

Referenced by SelectionDescriptor< T >::SelectionDescriptor(), and SessionItem::itemName().

Here is the call graph for this function:

emitDataChanged()

void SessionItem::emitDataChanged ( int  role = Qt::DisplayRole )

inherited

Notify model about data changes.

Definition at line 358 of file SessionItem.cpp.

{
    if (m_model) {
        QModelIndex index = m_model->indexOfItem(this);
        m_model->dataChanged(index, index.sibling(index.row(), 1), QVector<int>() << role);
    }
}

References SessionItem::index(), SessionModel::indexOfItem(), and SessionItem::m_model.

Referenced by GroupItem::onValueChange(), IntensityDataItem::setDatafield(), SpecularDataItem::setDatafield(), SessionItem::setRoleProperty(), and PointwiseAxisItem::updateIndicators().

Here is the call graph for this function:

firstChildOfType()

template<typename T >

T * SessionItem::firstChildOfType

inherited

Definition at line 384 of file SessionItem.h.

{
    for (auto* child : m_children)
        if (child->modelType() == T::M_TYPE)
            return dynamic_cast<T*>(child);
 
    return nullptr;
}

References SessionItem::m_children.

flags()

int SessionItem::flags ( ) const

privateinherited

Definition at line 557 of file SessionItem.cpp.

{
    QVariant flags = roleProperty(SessionFlags::FlagRole);
 
    if (!flags.isValid())
        return SessionFlags::VISIBLE | SessionFlags::EDITABLE | SessionFlags::ENABLED;
 
    return flags.toInt();
}

References SessionFlags::EDITABLE, SessionFlags::ENABLED, SessionFlags::FlagRole, SessionItem::roleProperty(), and SessionFlags::VISIBLE.

Referenced by SessionItem::changeFlags(), SessionItem::isEditable(), and SessionItem::isEnabled().

Here is the call graph for this function:

getChildOfType()

SessionItem * SessionItem::getChildOfType ( const QString &  type ) const

inherited

Returns the first child of the given type.

Definition at line 116 of file SessionItem.cpp.

{
    for (auto* child : m_children)
        if (child->modelType() == type)
            return child;
 
    return nullptr;
}

References SessionItem::m_children.

Referenced by GroupItemController::currentItem(), GroupItemController::getItemOfType(), and GroupItemController::setCurrentType().

getCopyNumberOfChild()

int SessionItem::getCopyNumberOfChild ( const SessionItem *  item ) const

privateinherited

internal

Definition at line 580 of file SessionItem.cpp.

{
    if (!item)
        return -1;
    int result = -1;
    int count = 0;
    QString model_type = item->modelType();
    // check child items:
    for (auto* p_child_item : m_children) {
        QString child_type = p_child_item->modelType();
        if (p_child_item == item)
            result = count;
        if (child_type == model_type && !p_child_item->isTag(P_NAME))
            ++count;
    }
    if (count > 1)
        return result;
    return -1;
}

References SessionItem::item(), SessionItem::m_children, and SessionItem::P_NAME.

Referenced by SessionItem::displayName().

Here is the call graph for this function:

getGroupItem()

SessionItem * SessionItem::getGroupItem ( const QString &  groupName ) const

inherited

Access subitem of group item.

Definition at line 327 of file SessionItem.cpp.

{
    return item<GroupItem>(groupName)->currentItem();
}

Referenced by SessionItem::groupItem(), and SessionItem::setGroupPropertyType().

getItem()

SessionItem * SessionItem::getItem ( const QString &  tag = "", int  row = 0  ) const

inherited

Returns item in given row of given tag.

Definition at line 200 of file SessionItem.cpp.

{
    const QString tagName = tag.isEmpty() ? defaultTag() : tag;
 
    if (!m_tags->isValid(tagName))
        return nullptr;
 
    if (m_tags->childCount(tagName) == 0)
        return nullptr;
 
    if (row < 0 || row >= m_tags->childCount(tagName))
        return nullptr;
 
    int index = m_tags->indexFromTagRow(tagName, row);
    ASSERT(index >= 0);
    ASSERT(index < m_children.size());
    return m_children[index];
}

References SessionItem::defaultTag(), SessionItem::index(), SessionItem::m_children, and SessionItem::m_tags.

Referenced by FitParameterItem::FitParameterItem(), EllipseItem::angle(), DataItem::axesUnits(), Data1DViewItem::axesUnitsDescriptor(), BasicAxisItem::binsItem(), FitSuiteItem::createFitParametersContainer(), JobItem::createFitSuiteItem(), FitSuiteItem::createMinimizerContainer(), JobItem::dataItem(), RealDataItem::dataItem(), JobItem::dataItemView(), JobItem::fitSuiteItem(), DataItem::getAxesUnitsItem(), SessionItem::getItemValue(), IntensityDataItem::gradient(), RealDataItem::initDataItem(), FitParameterItem::initMinMaxValues(), JobItem::intensityDataItem(), JobItem::isValidForFitting(), SessionItem::item(), FitParameterLinkItem::linkItem(), AmplitudeAxisItem::logScaleItem(), IntensityDataItem::maskContainerItem(), MaskItem::maskValueItem(), BasicAxisItem::max(), FitParameterItem::maximumItem(), BasicAxisItem::maxItem(), BasicAxisItem::min(), FitParameterItem::minimumItem(), BasicAxisItem::minItem(), RealDataItem::nativeData(), MinimizerContainerItem::normFunction(), MinimizerContainerItem::objectiveMetric(), VerticalLineItem::posX(), HorizontalLineItem::posY(), IntensityDataItem::projectionContainerItem(), JobItem::realDataItem(), BasicAxisItem::serialize(), PolygonPointItem::serialize(), AmplitudeAxisItem::serialize(), RectangleItem::serialize(), PolygonItem::serialize(), VerticalLineItem::serialize(), HorizontalLineItem::serialize(), EllipseItem::serialize(), MaskAllItem::serialize(), PointwiseAxisItem::serialize(), SessionItem::setItemValue(), FitParameterItem::setLimitEnabled(), RealDataItem::setNativeDataUnits(), FitParameterItem::startValueItem(), BasicAxisItem::titleItem(), FitParameterItem::typeItem(), MinuitMinimizerItem::valueDescriptorsForUI(), GSLMultiMinimizerItem::valueDescriptorsForUI(), GeneticMinimizerItem::valueDescriptorsForUI(), valueDescriptorsForUI(), GSLLMAMinimizerItem::valueDescriptorsForUI(), BasicAxisItem::visibilityItem(), EllipseItem::xCenter(), RectangleItem::xLow(), EllipseItem::xRadius(), RectangleItem::xUp(), EllipseItem::yCenter(), RectangleItem::yLow(), EllipseItem::yRadius(), and RectangleItem::yUp().

Here is the call graph for this function:

getItems()

QVector< SessionItem * > SessionItem::getItems ( const QString &  tag = "" ) const

inherited

Returns vector of all items of given tag.

Definition at line 221 of file SessionItem.cpp.

{
    const QString tagName = tag.isEmpty() ? defaultTag() : tag;
    if (!m_tags->isValid(tagName))
        return QVector<SessionItem*>();
 
    int index = m_tags->tagStartIndex(tagName);
    ASSERT(index >= 0 && index <= m_children.size());
    return m_children.mid(index, m_tags->childCount(tagName));
}

References SessionItem::defaultTag(), SessionItem::index(), SessionItem::m_children, and SessionItem::m_tags.

Referenced by MaskUnitsConverter::convertIntensityDataItem(), SessionModel::copy(), GroupItem::groupItems(), SessionItem::items(), SessionModel::moveItem(), DataPropertyContainer::propertyItem(), DataPropertyContainer::propertyItems(), and SessionItem::takeRow().

Here is the call graph for this function:

getItemValue()

QVariant SessionItem::getItemValue ( const QString &  tag ) const

inherited

Directly access value of item under given tag.

Definition at line 292 of file SessionItem.cpp.

{
    ASSERT(isTag(tag));
    return getItem(tag)->value();
}

References SessionItem::getItem(), SessionItem::isTag(), and SessionItem::value().

Referenced by FitParameterItem::attLimits(), Data1DViewItem::axesUnits(), JobItem::beginTime(), BasicAxisItem::binCount(), FitSuiteItem::chi2(), Data1DProperties::color(), Data1DProperties::colorName(), MaskUnitsConverter::convertCoordinate(), MinimizerContainerItem::createMetric(), MinuitMinimizerItem::createMinimizer(), GSLMultiMinimizerItem::createMinimizer(), GeneticMinimizerItem::createMinimizer(), createMinimizer(), GSLLMAMinimizerItem::createMinimizer(), RectangleItem::createShape(), VerticalLineItem::createShape(), HorizontalLineItem::createShape(), EllipseItem::createShape(), DataProperties::dataItem(), JobItem::endTime(), DataItem::fileName(), JobItem::getComments(), IntensityDataItem::getGradient(), JobItem::getIdentifier(), JobItem::getProgress(), JobItem::getStatus(), PointwiseAxisItem::getUnitsLabel(), FitParameterItem::initMinMaxValues(), RealDataItem::instrumentId(), JobItem::instrumentName(), PolygonItem::isClosed(), IntensityDataItem::isInterpolated(), AmplitudeAxisItem::isLocked(), AmplitudeAxisItem::isLogScale(), BasicAxisItem::isTitleVisible(), FitParameterItem::isValid(), MaskItem::isVisibleValue(), SessionItem::itemName(), FitSuiteItem::iterationCount(), Data1DProperties::line(), FitParameterLinkItem::link(), MaskItem::maskValue(), FitParameterItem::maximum(), FitParameterItem::minimum(), RealDataItem::nativeDataUnits(), Data1DProperties::nextColorName(), PropertyRepeater::onPropertyChanged(), FitParameterItem::parameterType(), PolygonPointItem::posX(), PolygonPointItem::posY(), JobItem::presentationType(), Data1DProperties::scatter(), DataItem::selectedCoords(), PropertyRepeater::setOnChildPropertyChange(), FitParameterItem::startValue(), BasicAxisItem::title(), FitParameterLinkItem::title(), and FitSuiteItem::updateInterval().

Here is the call graph for this function:

getRoles()

QVector< int > SessionItem::getRoles ( ) const

inherited

Returns vector of all present roles.

Definition at line 351 of file SessionItem.cpp.

{
    return m_properties->roles();
}

References SessionItem::m_properties.

Referenced by GUI::Session::XML::writeItemAndChildItems().

groupItem()

template<typename T >

T & SessionItem::groupItem ( const QString &  groupName ) const

inherited

Definition at line 413 of file SessionItem.h.

{
    auto* t = dynamic_cast<T*>(getGroupItem(groupName));
    ASSERT(t);
    return *t;
}

References SessionItem::getGroupItem().

Referenced by SessionItem::addGroupProperty().

Here is the call graph for this function:

hasChildren()

bool SessionItem::hasChildren ( ) const

inherited

Indicates whether this SessionItem has any child items.

Definition at line 81 of file SessionItem.cpp.

{
    return numberOfChildren() > 0;
}

References SessionItem::numberOfChildren().

Referenced by IntensityDataItem::hasProjections().

Here is the call graph for this function:

hasModelType()

template<typename T >

bool SessionItem::hasModelType

inherited

Definition at line 421 of file SessionItem.h.

{
    return modelType() == T::M_TYPE;
}

References SessionItem::modelType().

Referenced by MaskViewFactory::createMaskView(), FitParameterModel::flags(), FitParameterModel::index(), FitParameterModel::indexOfItem(), FitParameterWidget::onFitParametersSelectionChanged(), FitParameterModel::rowCount(), and MaskGraphicsScene::updateViews().

Here is the call graph for this function:

index()

QModelIndex SessionItem::index ( ) const

inherited

Returns model index of this item.

Definition at line 74 of file SessionItem.cpp.

{
    return model() ? model()->indexOfItem(const_cast<SessionItem*>(this)) : QModelIndex();
}

References SessionModel::indexOfItem(), and SessionItem::model().

Referenced by SessionItem::childDeleted(), MaskContainerItem::clear(), FitParameterContainerItem::createParameters(), SessionItem::displayName(), SessionItem::emitDataChanged(), SessionItem::getItem(), SessionItem::getItems(), SessionItem::insertChild(), FitParameterModel::isValidSourceItem(), ParameterItem::linkToSessionItem(), JobModel::removeJob(), FitParameterContainerItem::setValuesInParameterContainer(), IntensityDataProjectionsWidget::subscribeToItem(), SessionItem::tagFromItem(), and SessionItem::takeItem().

Here is the call graph for this function:

insertChild()

void SessionItem::insertChild ( int  row, SessionItem *  item, const QString &  tag = ""  )

inherited

Insert item into given tag into given row.

Definition at line 233 of file SessionItem.cpp.

{
    ASSERT(item);
    ASSERT(!item->parentItem());
 
    const QString tagName = tag.isEmpty() ? defaultTag() : tag;
    ASSERT(m_tags->isValid(tagName, item->modelType()));
 
    int index = m_tags->insertIndexFromTagRow(tagName, row);
    ASSERT(index >= 0);
    ASSERT(index <= m_children.size());
 
    if (m_model)
        m_model->beginInsertRows(this->index(), index, index);
 
    item->setParentAndModel(this, m_model);
    m_children.insert(index, item);
 
    m_tags->addChild(tagName);
    if (m_model)
        m_model->endInsertRows();
}

References SessionItem::defaultTag(), SessionItem::index(), SessionItem::item(), SessionItem::m_children, SessionItem::m_model, and SessionItem::m_tags.

Referenced by GroupItemController::GroupItemController(), JobItem::addDataViewItem(), SessionItem::addGroupProperty(), DataPropertyContainer::addItem(), MaskContainerItem::addMask(), PolygonItem::addPoint(), SessionItem::addProperty(), GUI::Model::ItemFactory::CreateItem(), GroupItemController::getItemOfType(), MaskItems::insertMask(), MaskContainerItem::insertMask(), SessionModel::insertNewItem(), SessionModel::moveItem(), and GroupItemController::setCurrentType().

Here is the call graph for this function:

isEditable()

bool SessionItem::isEditable ( ) const

inherited

Definition at line 468 of file SessionItem.cpp.

{
    return flags() & SessionFlags::EDITABLE;
}

References SessionFlags::EDITABLE, and SessionItem::flags().

Referenced by SessionModel::flags().

Here is the call graph for this function:

isEnabled()

bool SessionItem::isEnabled ( ) const

inherited

Definition at line 463 of file SessionItem.cpp.

{
    return flags() & SessionFlags::ENABLED;
}

References SessionFlags::ENABLED, and SessionItem::flags().

Referenced by SessionModel::flags().

Here is the call graph for this function:

isItemNamePropertyName()

bool SessionItem::isItemNamePropertyName ( const QString &  name )

staticinherited

Definition at line 446 of file SessionItem.cpp.

{
    return P_NAME == name;
}

References GUI::RealSpace::Particles::name(), and SessionItem::P_NAME.

Here is the call graph for this function:

isTag()

bool SessionItem::isTag ( const QString &  name ) const

inherited

Returns true if tag is available.

Definition at line 166 of file SessionItem.cpp.

{
    return m_tags->isValid(name);
}

References SessionItem::m_tags, and GUI::RealSpace::Particles::name().

Referenced by SessionItem::addProperty(), MaskUnitsConverter::convertCoordinate(), SessionItem::getItemValue(), JobItem::isValidForFitting(), SessionItem::itemName(), SessionItem::setItemName(), SessionItem::setItemValue(), and FitParameterItem::setLimitEnabled().

Here is the call graph for this function:

item()

template<typename T >

T * SessionItem::item ( const QString &  tag ) const

inherited

Definition at line 353 of file SessionItem.h.

{
    auto* t = dynamic_cast<T*>(getItem(tag));
    ASSERT(t);
    return t;
}

References SessionItem::getItem().

Referenced by MinimizerContainerItem::MinimizerContainerItem(), PolygonItem::createShape(), DataProperties::dataItem(), DataPropertyContainer::dataItems(), JobItem::fitParameterContainerItem(), FitParameterContainerItem::fitParameterItem(), FitParameterContainerItem::fitParameterNames(), SessionItem::getCopyNumberOfChild(), SessionItem::insertChild(), SessionItem::items(), Data1DViewItem::jobItem(), DataPropertyContainer::propertyItems(), DataProperties::setDataItem(), SessionItem::setGroupPropertyType(), SessionItem::tagFromItem(), SessionItem::takeRow(), SessionModel::topItems(), DataItem::updateAxesUnits(), JobItem::updateIntensityDataFileName(), and RealDataItem::updateNonXMLDataFileNames().

Here is the call graph for this function:

itemName()

QString SessionItem::itemName ( ) const

inherited

Get item name, return display name if no name is set.

Definition at line 432 of file SessionItem.cpp.

{
    return isTag(P_NAME) ? getItemValue(P_NAME).toString() : displayName();
}

References SessionItem::displayName(), SessionItem::getItemValue(), SessionItem::isTag(), and SessionItem::P_NAME.

Referenced by SessionModel::data(), RealDataItem::dataName(), JobItem::jobName(), MaskItem::maskName(), GUI::Session::XML::readItems(), MaskGraphicsScene::setItemName(), Plot1D::subscribeToItem(), SpecularPlot::subscribeToItem(), ColorMap::subscribeToItem(), ProjectionsPlot::subscribeToItem(), and JobItem::updateIntensityDataFileName().

Here is the call graph for this function:

items()

template<typename T >

QVector< T * > SessionItem::items ( const QString &  tag = "" ) const

inherited

Definition at line 361 of file SessionItem.h.

{
    QVector<T*> result;
 
    for (SessionItem* item : getItems(tag))
        if (auto* titem = dynamic_cast<T*>(item))
            result.push_back(titem);
    return result;
}

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

Referenced by DataPropertyContainer::dataItems(), SessionItem::takeRow(), and SessionModel::topItem().

Here is the call graph for this function:

limits()

RealLimits SessionItem::limits ( ) const

inherited

Definition at line 473 of file SessionItem.cpp.

{
    return roleProperty(SessionFlags::LimitsRole).value<RealLimits>();
}

References SessionFlags::LimitsRole, and SessionItem::roleProperty().

Referenced by GUI::View::PropertyEditorFactory::CreateEditor(), FitParameterContainerItem::createParameters(), and FitParameterItem::initMinMaxValues().

Here is the call graph for this function:

mapper()

ModelMapper * SessionItem::mapper ( )

inherited

Returns the current model mapper of this item. Creates new one if necessary.

Definition at line 508 of file SessionItem.cpp.

{
    if (!m_mapper) {
        m_mapper = std::make_unique<ModelMapper>();
        m_mapper->setItem(this);
    }
    return m_mapper.get();
}

References SessionItem::m_mapper.

Referenced by Data1DViewItem::Data1DViewItem(), FitParameterItem::FitParameterItem(), FitParameterModel::FitParameterModel(), GroupItem::GroupItem(), IShape2DView::IShape2DView(), FitParameterModel::~FitParameterModel(), IntensityDataPropertyWidget::~IntensityDataPropertyWidget(), PropertyRepeater::addItem(), MaskEditorPropertyPanel::addMaskCheckBox(), MaskEditorPropertyPanel::addMaskSpinBox(), IShape2DView::disconnectFromItem(), SessionItemController::onControllerDestroy(), SpecularDataPropertyWidget::setCurrentItem(), MaskEditorPropertyPanel::setCurrentMaskItem(), IntensityDataPropertyWidget::setItem(), FitSessionController::setItem(), SessionItemController::setItem(), RunFitControlWidget::subscribeToItem(), IntensityDataCanvas::subscribeToItem(), FitFlowWidget::subscribeToItem(), Plot1D::subscribeToItem(), SpecularPlot::subscribeToItem(), ColorMap::subscribeToItem(), ProjectionsPlot::subscribeToItem(), SessionItemController::unsubscribe(), RunFitControlWidget::unsubscribeFromChildren(), and ProjectionsPlot::unsubscribeFromChildren().

model()

SessionModel * SessionItem::model ( ) const

inherited

Returns model of this item.

Definition at line 60 of file SessionItem.cpp.

{
    return m_model;
}

References SessionItem::m_model.

Referenced by FitParameterModel::FitParameterModel(), DataPropertyContainer::addItem(), FitParameterItem::addLink(), MaskContainerItem::clear(), JobItem::copyRealDataIntoJob(), JobItem::createDataViewItem(), FitParameterContainerItem::createFitParameter(), FitSuiteItem::createFitParametersContainer(), JobItem::createFitSuiteItem(), FitSuiteItem::createMinimizerContainer(), Data1DViewItem::createPropertyContainerItem(), JobItem::createRealDataItem(), DataProperties::dataItem(), IntensityDataItem::getOrCreateMaskContainerItem(), IntensityDataItem::getOrCreateProjectionContainerItem(), SessionItem::index(), RealDataItem::initDataItem(), FitParameterWidget::onRemoveFitParAction(), GUI::Session::XML::readItems(), FitParameterItem::removeLink(), JobItem::setDataType(), ModelMapper::setItem(), SessionItem::setModel(), SessionItem::setParentAndModel(), FitParameterModel::sourceModel(), ParameterTuningWidget::subscribeToItem(), ItemStackWidget::validateItem(), and GUI::Session::XML::writeModel().

modelType()

QString SessionItem::modelType ( ) const

inherited

Get model type.

Definition at line 368 of file SessionItem.cpp.

{
    return roleProperty(SessionFlags::ModelTypeRole).toString();
}

References SessionFlags::ModelTypeRole, and SessionItem::roleProperty().

Referenced by GSLMultiMinimizerItem::GSLMultiMinimizerItem(), MinuitMinimizerItem::MinuitMinimizerItem(), RectangleItem::RectangleItem(), SessionItem::SessionItem(), GUI::Model::Path::ancestor(), MaskViewFactory::createMaskView(), FitParameterHelper::getParameterItem(), ProjectionsPlot::graphForItem(), SessionItem::hasModelType(), SessionModel::insertItem(), SessionModel::moveItem(), MaskGraphicsScene::processPolygonItem(), MaskGraphicsScene::processRectangleShapeItem(), GroupItem::setCurrentType(), ProjectionsPlot::setGraphFromItem(), SessionItem::setGroupProperty(), MaskGraphicsScene::setItemName(), MaskEditor::setMaskContext(), MaskGraphicsScene::setMaskContext(), SpecularPlot::subscribeToItem(), ColorMap::subscribeToItem(), ProjectionsPlot::subscribeToItem(), and GUI::Session::XML::writeItemAndChildItems().

Here is the call graph for this function:

numberOfChildren()

int SessionItem::numberOfChildren ( ) const

inherited

Returns total number of children.

Definition at line 88 of file SessionItem.cpp.

{
    return m_children.size();
}

References SessionItem::m_children.

Referenced by MaskContainerItem::clear(), SessionModel::dropMimeData(), SessionItem::hasChildren(), SessionModel::insertNewItem(), MaskEditorActions::isSendToBackPossible(), FitParameterModel::rowCount(), and SessionModel::rowCount().

parentItem()

SessionItem * SessionItem::parentItem ( ) const

inherited

Returns parent of this item.

Definition at line 67 of file SessionItem.cpp.

{
    return m_parent;
}

References SessionItem::m_parent.

Referenced by DataPropertyContainer::addItem(), GUI::Model::Path::ancestor(), FitComparison1DViewController::deleteDiffViewItem(), FitParameterHelper::getParameterItem(), FitParameterModel::indexOfItem(), SessionModel::indexOfItem(), MaskEditorActions::isSendToBackPossible(), Data1DViewItem::jobItem(), SessionModel::moveItem(), ModelMapper::nestlingDepth(), ModelMapper::onDataChanged(), FitParameterWidget::onFitParametersSelectionChanged(), ProjectionsEditorCanvas::onLeavingColorMap(), FitParameterModel::parent(), SessionModel::parent(), SessionItem::parentRow(), GUI::Session::XML::readItems(), GUI::Session::XML::readProperty(), IntensityDataCanvas::rotateData(), PropertyRepeater::setOnChildPropertyChange(), and GUI::Session::XML::writeItemAndChildItems().

parentRow()

int SessionItem::parentRow ( )

inherited

Returns the index of the given item within its parent. Returns -1 when no parent is set.

Definition at line 148 of file SessionItem.cpp.

{
    if (parentItem())
        return parentItem()->rowOfChild(this);
    return -1;
}

References SessionItem::parentItem(), and SessionItem::rowOfChild().

Referenced by FitParameterModel::indexOfItem(), and FitParameterModel::parent().

Here is the call graph for this function:

readNonSessionItems()

void SessionItem::readNonSessionItems ( QXmlStreamReader *  reader )

virtualinherited

Reimplemented in JobItem.

Definition at line 526 of file SessionItem.cpp.

{}

Referenced by GUI::Session::XML::readItems().

registerTag()

bool SessionItem::registerTag ( const QString &  name, int  min = 0, int  max = -1, QStringList  modelTypes = {}  )

inherited

Add new tag to this item with given name, min, max and types. max = -1 -> unlimited, modelTypes empty -> all types allowed.

Definition at line 159 of file SessionItem.cpp.

{
    return m_tags->registerTag(name, min, max, modelTypes);
}

References SessionItem::m_tags, and GUI::RealSpace::Particles::name().

Referenced by Data1DViewItem::Data1DViewItem(), DataPropertyContainer::DataPropertyContainer(), FitParameterContainerItem::FitParameterContainerItem(), FitParameterItem::FitParameterItem(), FitSuiteItem::FitSuiteItem(), GroupItem::GroupItem(), IntensityDataItem::IntensityDataItem(), JobItem::JobItem(), MaskContainerItem::MaskContainerItem(), PolygonItem::PolygonItem(), ProjectionContainerItem::ProjectionContainerItem(), RealDataItem::RealDataItem(), SessionItem::addGroupProperty(), SessionItem::addProperty(), and SessionModel::createRootItem().

Here is the call graph for this function:

roleProperty()

QVariant SessionItem::roleProperty ( int  role ) const

inherited

Returns corresponding variant under given role, invalid variant when role is not present.

Definition at line 334 of file SessionItem.cpp.

{
    return m_properties->data(role);
}

References SessionItem::m_properties.

Referenced by GUI::View::PropertyEditorFactory::CreateEditor(), SessionItem::decimals(), SessionItem::defaultTag(), SessionItem::displayName(), SessionItem::flags(), SessionItem::limits(), SessionItem::modelType(), SessionItem::toolTip(), SessionItem::value(), and GUI::Session::XML::writeItemAndChildItems().

rowOfChild()

int SessionItem::rowOfChild ( SessionItem *  child ) const

inherited

Returns row index of given child.

Definition at line 109 of file SessionItem.cpp.

{
    return m_children.indexOf(child);
}

Referenced by SessionItem::childDeleted(), SessionModel::indexOfItem(), SessionModel::moveItem(), ProjectionsEditorCanvas::onLeavingColorMap(), and SessionItem::parentRow().

serializeBinaryData()

QByteArray SessionItem::serializeBinaryData ( ) const

virtualinherited

Reimplemented in PointwiseAxisItem, and RealDataItem.

Definition at line 517 of file SessionItem.cpp.

{
    return QByteArray();
}

Referenced by GUI::Session::XML::writeItemAndChildItems().

sessionItemTags()

const SessionItemTags * SessionItem::sessionItemTags ( ) const

inherited

Definition at line 171 of file SessionItem.cpp.

{
    return m_tags.get();
}

References SessionItem::m_tags.

Referenced by SessionItem::displayName(), SessionModel::insertNewItem(), and SessionModel::moveItem().

setDecimals()

SessionItem & SessionItem::setDecimals ( int  n )

inherited

Definition at line 489 of file SessionItem.cpp.

{
    setRoleProperty(SessionFlags::DecimalRole, n);
    return *this;
}

References SessionFlags::DecimalRole, and SessionItem::setRoleProperty().

Referenced by BasicAxisItem::BasicAxisItem(), and SessionItem::SessionItem().

Here is the call graph for this function:

setDefaultTag()

void SessionItem::setDefaultTag ( const QString &  tag )

inherited

Set default tag.

Definition at line 397 of file SessionItem.cpp.

{
    setRoleProperty(SessionFlags::DefaultTagRole, tag);
}

References SessionFlags::DefaultTagRole, and SessionItem::setRoleProperty().

Referenced by DataPropertyContainer::DataPropertyContainer(), FitParameterContainerItem::FitParameterContainerItem(), FitParameterItem::FitParameterItem(), GroupItem::GroupItem(), IntensityDataItem::IntensityDataItem(), MaskContainerItem::MaskContainerItem(), PolygonItem::PolygonItem(), ProjectionContainerItem::ProjectionContainerItem(), and RealDataItem::RealDataItem().

Here is the call graph for this function:

setDisplayName()

void SessionItem::setDisplayName ( const QString &  display_name )

inherited

Set display name.

Definition at line 426 of file SessionItem.cpp.

{
    setRoleProperty(SessionFlags::DisplayNameRole, display_name);
}

References SessionFlags::DisplayNameRole, and SessionItem::setRoleProperty().

Referenced by SessionItem::SessionItem(), SessionItem::addProperty(), FitParameterContainerItem::createFitParameter(), and GUI::Session::XML::readItems().

Here is the call graph for this function:

setEditable()

void SessionItem::setEditable ( bool  enabled )

inherited

Definition at line 458 of file SessionItem.cpp.

{
    changeFlags(enabled, SessionFlags::EDITABLE);
}

References SessionItem::changeFlags(), and SessionFlags::EDITABLE.

Referenced by JobItem::JobItem(), and FitParameterItem::setLimitEnabled().

Here is the call graph for this function:

setEnabled()

void SessionItem::setEnabled ( bool  enabled )

inherited

Flags accessors.

Definition at line 453 of file SessionItem.cpp.

{
    changeFlags(enabled, SessionFlags::ENABLED);
}

References SessionItem::changeFlags(), and SessionFlags::ENABLED.

Referenced by FitParameterItem::FitParameterItem(), MaskAllItem::MaskAllItem(), PointwiseAxisItem::PointwiseAxisItem(), GroupItemController::getItemOfType(), and FitParameterItem::setLimitEnabled().

Here is the call graph for this function:

setGroupProperty()

SessionItem * SessionItem::setGroupProperty ( const QString &  groupTag, const QString &  modelType  ) const

inherited

Set the current type of group item.

Definition at line 320 of file SessionItem.cpp.

{
    return item<GroupItem>(groupTag)->setCurrentType(modelType);
}

References SessionItem::modelType().

Referenced by SessionItem::setGroupPropertyType().

Here is the call graph for this function:

setGroupPropertyType()

template<typename T >

T * SessionItem::setGroupPropertyType ( const QString &  groupTag )

inherited

Definition at line 404 of file SessionItem.h.

{
    SessionItem* item = getGroupItem(groupTag);
    if (!item->hasModelType<T>())
        return dynamic_cast<T*>(setGroupProperty(groupTag, T::M_TYPE));
    return dynamic_cast<T*>(item);
}

References SessionItem::getGroupItem(), SessionItem::item(), and SessionItem::setGroupProperty().

Here is the call graph for this function:

setItemName()

void SessionItem::setItemName ( const QString &  name )

inherited

Set item name, add property if necessary.

Definition at line 438 of file SessionItem.cpp.

{
    if (isTag(P_NAME))
        setItemValue(P_NAME, name);
    else
        addProperty(P_NAME, name);
}

References SessionItem::addProperty(), SessionItem::isTag(), GUI::RealSpace::Particles::name(), SessionItem::P_NAME, and SessionItem::setItemValue().

Referenced by EllipseItem::EllipseItem(), HorizontalLineItem::HorizontalLineItem(), JobItem::JobItem(), MaskAllItem::MaskAllItem(), PolygonItem::PolygonItem(), PolygonPointItem::PolygonPointItem(), RealDataItem::RealDataItem(), RectangleItem::RectangleItem(), VerticalLineItem::VerticalLineItem(), RealDataItem::setDataName(), MaskGraphicsScene::setItemName(), JobItem::setJobName(), and MaskItem::setMaskName().

Here is the call graph for this function:

setItemValue()

void SessionItem::setItemValue ( const QString &  tag, const QVariant &  variant  ) const

inherited

Directly set value of item under given tag.

Definition at line 300 of file SessionItem.cpp.

{
    ASSERT(isTag(tag));
    getItem(tag)->setValue(variant);
}

References SessionItem::getItem(), SessionItem::isTag(), and SessionItem::setValue().

Referenced by MaskUnitsConverter::convertCoordinate(), PointwiseAxisItem::init(), FitParameterItem::initMinMaxValues(), RealDataItem::linkToInstrument(), EllipseItem::setAngle(), Data1DViewItem::setAxesUnits(), DataItem::setAxesUnits(), JobItem::setBeginTime(), BasicAxisItem::setBinCount(), FitSuiteItem::setChi2(), Data1DProperties::setColorProperty(), JobItem::setComments(), DataProperties::setDataItem(), JobItem::setEndTime(), DataItem::setFileName(), IntensityDataItem::setGradient(), JobItem::setIdentifier(), JobItem::setInstrumentName(), IntensityDataItem::setInterpolated(), PolygonItem::setIsClosed(), MaskItem::setIsVisibleValue(), SessionItem::setItemName(), FitSuiteItem::setIterationCount(), Data1DProperties::setLineProperty(), FitParameterLinkItem::setLink(), AmplitudeAxisItem::setLocked(), AmplitudeAxisItem::setLogScale(), BasicAxisItem::setLowerBound(), MaskItem::setMaskValue(), FitParameterItem::setMaximum(), FitParameterItem::setMinimum(), PolygonPointItem::setPosX(), VerticalLineItem::setPosX(), PolygonPointItem::setPosY(), HorizontalLineItem::setPosY(), JobItem::setPresentationType(), JobItem::setProgress(), Data1DProperties::setScatterProperty(), FitParameterItem::setStartValue(), JobItem::setStatus(), BasicAxisItem::setTitle(), FitParameterLinkItem::setTitle(), FitSuiteItem::setUpdateInterval(), BasicAxisItem::setUpperBound(), BasicAxisItem::setVisibilityValue(), EllipseItem::setXCenter(), RectangleItem::setXLow(), EllipseItem::setXRadius(), RectangleItem::setXUp(), EllipseItem::setYCenter(), RectangleItem::setYLow(), EllipseItem::setYRadius(), RectangleItem::setYUp(), and RealDataItem::unlinkFromInstrument().

Here is the call graph for this function:

setLimits()

SessionItem & SessionItem::setLimits ( const RealLimits &  value )

inherited

Definition at line 478 of file SessionItem.cpp.

{
    setRoleProperty(SessionFlags::LimitsRole, QVariant::fromValue<RealLimits>(value));
    return *this;
}

References SessionFlags::LimitsRole, SessionItem::setRoleProperty(), and SessionItem::value().

Referenced by BasicAxisItem::BasicAxisItem(), EllipseItem::EllipseItem(), FitParameterItem::FitParameterItem(), HorizontalLineItem::HorizontalLineItem(), PolygonPointItem::PolygonPointItem(), RectangleItem::RectangleItem(), SessionItem::SessionItem(), VerticalLineItem::VerticalLineItem(), and FitParameterItem::initMinMaxValues().

Here is the call graph for this function:

setModel()

void SessionItem::setModel ( SessionModel *  model )

privateinherited

Definition at line 546 of file SessionItem.cpp.

{
    m_model = model;
 
    if (m_mapper)
        m_mapper->setItem(this);
 
    for (auto& child : m_children)
        child->setModel(model);
}

References SessionItem::m_children, SessionItem::m_mapper, SessionItem::m_model, and SessionItem::model().

Referenced by SessionItem::~SessionItem(), SessionModel::createRootItem(), and SessionItem::setParentAndModel().

Here is the call graph for this function:

setParentAndModel()

void SessionItem::setParentAndModel ( SessionItem *  parent, SessionModel *  model  )

privateinherited

Definition at line 540 of file SessionItem.cpp.

{
    setModel(model);
    m_parent = parent;
}

References SessionItem::m_parent, SessionItem::model(), and SessionItem::setModel().

Referenced by SessionItem::takeItem().

Here is the call graph for this function:

setRoleProperty()

bool SessionItem::setRoleProperty ( int  role, const QVariant &  value  )

inherited

Set the contained role property to the given value. See also setTranslatorForRolePropertySetter.

Set variant to role, create role if not present yet.

Definition at line 341 of file SessionItem.cpp.

{
    bool result = m_properties->setData(role, value);
    if (result)
        emitDataChanged(role);
    return result;
}

References SessionItem::emitDataChanged(), SessionItem::m_properties, and SessionItem::value().

Referenced by SessionItem::SessionItem(), SessionItem::changeFlags(), GUI::Session::XML::readProperty(), SessionModel::setData(), SessionItem::setDecimals(), SessionItem::setDefaultTag(), SessionItem::setDisplayName(), SessionItem::setLimits(), SessionItem::setToolTip(), and SessionItem::setValue().

Here is the call graph for this function:

setToolTip()

SessionItem & SessionItem::setToolTip ( const QString &  tooltip )

inherited

Definition at line 500 of file SessionItem.cpp.

{
    setRoleProperty(Qt::ToolTipRole, tooltip);
    return *this;
}

References SessionItem::setRoleProperty().

Referenced by GeneticMinimizerItem::GeneticMinimizerItem(), GSLLMAMinimizerItem::GSLLMAMinimizerItem(), GSLMultiMinimizerItem::GSLMultiMinimizerItem(), MinimizerContainerItem::MinimizerContainerItem(), MinuitMinimizerItem::MinuitMinimizerItem(), and SimAnMinimizerItem().

Here is the call graph for this function:

setValue()

bool SessionItem::setValue ( QVariant  value )

inherited

Set value, ensure that variant types match.

Definition at line 382 of file SessionItem.cpp.

{
    ASSERT(GUI::Util::Variant::CompatibleVariantTypes(this->value(), value));
    return setRoleProperty(Qt::DisplayRole, value);
}

References GUI::Util::Variant::CompatibleVariantTypes(), SessionItem::setRoleProperty(), and SessionItem::value().

Referenced by DoubleDescriptor::DoubleDescriptor(), SelectionDescriptor< T >::SelectionDescriptor(), UIntDescriptor::UIntDescriptor(), IntensityDataPropertyWidget::createCheckBox(), SpecularDataPropertyWidget::createCheckBox(), IntensityDataPropertyWidget::createTextEdit(), SpecularDataPropertyWidget::createTextEdit(), SessionItem::setItemValue(), RealDataItem::setNativeDataUnits(), and GroupItem::updateComboValue().

Here is the call graph for this function:

tagFromItem()

QString SessionItem::tagFromItem ( const SessionItem *  item ) const

inherited

Returns the tag name of given item when existing.

Definition at line 178 of file SessionItem.cpp.

{
    int index = m_children.indexOf(const_cast<SessionItem*>(item));
    return m_tags->tagFromIndex(index);
}

References SessionItem::index(), SessionItem::item(), SessionItem::m_children, and SessionItem::m_tags.

Referenced by SessionItem::displayName(), ModelMapper::onDataChanged(), PropertyRepeater::setOnChildPropertyChange(), SessionItem::takeRow(), and GUI::Session::XML::writeItemAndChildItems().

Here is the call graph for this function:

takeItem()

SessionItem * SessionItem::takeItem ( int  row, const QString &  tag  )

inherited

Remove item from given row from given tag.

Definition at line 258 of file SessionItem.cpp.

{
    const QString tagName = tag.isEmpty() ? defaultTag() : tag;
    ASSERT(m_tags->isValid(tagName));
    ASSERT(!m_tags->isSingleItemTag(tagName));
 
    int index = m_tags->indexFromTagRow(tagName, row);
    ASSERT(index >= 0 && index <= m_children.size());
 
    if (m_model)
        m_model->beginRemoveRows(this->index(), index, index);
    SessionItem* result = m_children.takeAt(index);
    result->setParentAndModel(nullptr, nullptr);
 
    m_tags->removeChild(tagName);
    if (m_model)
        m_model->endRemoveRows();
    return result;
}

References SessionItem::defaultTag(), SessionItem::index(), SessionItem::m_children, SessionItem::m_model, SessionItem::m_tags, and SessionItem::setParentAndModel().

Referenced by SessionModel::moveItem(), and SessionItem::takeRow().

Here is the call graph for this function:

takeRow()

SessionItem * SessionItem::takeRow ( int  row )

inherited

Removes row from item and returns the item.

Definition at line 139 of file SessionItem.cpp.

{
    SessionItem* item = childAt(row);
    QString tag = tagFromItem(item);
    auto items = getItems(tag);
    return takeItem(items.indexOf(item), tag);
}

References SessionItem::childAt(), SessionItem::getItems(), SessionItem::item(), SessionItem::items(), SessionItem::tagFromItem(), and SessionItem::takeItem().

Referenced by FitComparison1DViewController::deleteDiffViewItem(), SessionModel::moveItem(), ProjectionsEditorCanvas::onLeavingColorMap(), and SessionModel::removeRows().

Here is the call graph for this function:

toolTip()

QString SessionItem::toolTip ( ) const

inherited

Definition at line 495 of file SessionItem.cpp.

{
    return roleProperty(Qt::ToolTipRole).toString();
}

References SessionItem::roleProperty().

Referenced by SelectionDescriptor< T >::SelectionDescriptor().

Here is the call graph for this function:

value()

QVariant SessionItem::value ( ) const

inherited

Get value.

Definition at line 375 of file SessionItem.cpp.

{
    return roleProperty(Qt::DisplayRole);
}

References SessionItem::roleProperty().

Referenced by SelectionDescriptor< T >::SelectionDescriptor(), IntensityDataPropertyWidget::createCheckBox(), SpecularDataPropertyWidget::createCheckBox(), GUI::View::PropertyEditorFactory::CreateEditor(), IntensityDataPropertyWidget::createTextEdit(), SpecularDataPropertyWidget::createTextEdit(), SessionModel::data(), SessionModel::flags(), SessionItem::getItemValue(), FitParameterItem::initMinMaxValues(), FitParameterItem::isValid(), GroupItem::onValueChange(), BasicAxisItem::setBinCount(), SessionItem::setLimits(), AmplitudeAxisItem::setLogScale(), BasicAxisItem::setLowerBound(), Data1DViewItem::setLowerX(), IntensityDataItem::setLowerX(), SpecularDataItem::setLowerX(), Data1DViewItem::setLowerY(), IntensityDataItem::setLowerY(), SpecularDataItem::setLowerY(), SessionItem::setRoleProperty(), BasicAxisItem::setUpperBound(), Data1DViewItem::setUpperX(), IntensityDataItem::setUpperX(), SpecularDataItem::setUpperX(), Data1DViewItem::setUpperY(), IntensityDataItem::setUpperY(), SpecularDataItem::setUpperY(), SessionItem::setValue(), BasicAxisItem::visibilityValue(), and GUI::Session::XML::writeItemAndChildItems().

Here is the call graph for this function:

valueDescriptorsForUI()

ValueDescriptors SimAnMinimizerItem::valueDescriptorsForUI ( ) const

overridevirtual

Reimplemented from MinimizerItem.

Definition at line 232 of file MinimizerItem.cpp.

{
    return {
        UIntDescriptor(getItem(P_MAXITERATIONS), Unit::unitless),
        UIntDescriptor(getItem(P_ITERATIONSTEMP), Unit::unitless),
        DoubleDescriptor(getItem(P_STEPSIZE), Unit::unitless),
        DoubleDescriptor(getItem(P_BOLTZMANN_K), Unit::unitless),
        DoubleDescriptor(getItem(P_BOLTZMANN_TINIT), Unit::unitless),
        DoubleDescriptor(getItem(P_BOLTZMANN_MU), Unit::unitless),
        DoubleDescriptor(getItem(P_BOLTZMANN_TMIN), Unit::unitless),
    };
}

References SessionItem::getItem(), P_BOLTZMANN_K, P_BOLTZMANN_MU, P_BOLTZMANN_TINIT, P_BOLTZMANN_TMIN, P_ITERATIONSTEMP, P_MAXITERATIONS, P_STEPSIZE, and unitless.

Here is the call graph for this function:

writeNonSessionItems()

void SessionItem::writeNonSessionItems ( QXmlStreamWriter *  writer ) const

virtualinherited

Reimplemented in JobItem.

Definition at line 524 of file SessionItem.cpp.

{}

Referenced by GUI::Session::XML::writeItemAndChildItems().

Member Data Documentation

m_children

QVector<SessionItem*> SessionItem::m_children

privateinherited

Definition at line 332 of file SessionItem.h.

Referenced by SessionItem::~SessionItem(), SessionItem::childAt(), SessionItem::childDeleted(), SessionItem::children(), SessionItem::childrenOfType(), SessionItem::firstChildOfType(), SessionItem::getChildOfType(), SessionItem::getCopyNumberOfChild(), SessionItem::getItem(), SessionItem::getItems(), SessionItem::insertChild(), SessionItem::numberOfChildren(), SessionItem::setModel(), SessionItem::tagFromItem(), and SessionItem::takeItem().

m_mapper

std::unique_ptr<ModelMapper> SessionItem::m_mapper

privateinherited

Definition at line 335 of file SessionItem.h.

Referenced by SessionItem::~SessionItem(), SessionItem::mapper(), and SessionItem::setModel().

m_model

SessionModel* SessionItem::m_model

privateinherited

Definition at line 331 of file SessionItem.h.

Referenced by SessionItem::~SessionItem(), SessionItem::emitDataChanged(), SessionItem::insertChild(), SessionItem::model(), SessionItem::setModel(), and SessionItem::takeItem().

m_parent

SessionItem* SessionItem::m_parent

privateinherited

Definition at line 330 of file SessionItem.h.

Referenced by SessionItem::~SessionItem(), SessionItem::displayName(), SessionItem::parentItem(), and SessionItem::setParentAndModel().

m_properties

std::unique_ptr<SessionItemData> SessionItem::m_properties

privateinherited

Definition at line 333 of file SessionItem.h.

Referenced by SessionItem::getRoles(), SessionItem::roleProperty(), and SessionItem::setRoleProperty().

m_tags

std::unique_ptr<SessionItemTags> SessionItem::m_tags

privateinherited

Definition at line 334 of file SessionItem.h.

Referenced by SessionItem::acceptableDefaultItemTypes(), SessionItem::acceptsAsDefaultItem(), SessionItem::getItem(), SessionItem::getItems(), SessionItem::insertChild(), SessionItem::isTag(), SessionItem::registerTag(), SessionItem::sessionItemTags(), SessionItem::tagFromItem(), and SessionItem::takeItem().

M_TYPE

constexpr auto SimAnMinimizerItem::M_TYPE {"GSLSimAn"}

staticconstexpr

Definition at line 127 of file MinimizerItem.h.

P_BOLTZMANN_K

constexpr auto SimAnMinimizerItem::P_BOLTZMANN_K {"k"}

staticconstexprprivate

Definition at line 121 of file MinimizerItem.h.

Referenced by SimAnMinimizerItem(), createMinimizer(), and valueDescriptorsForUI().

P_BOLTZMANN_MU

constexpr auto SimAnMinimizerItem::P_BOLTZMANN_MU {"mu"}

staticconstexprprivate

Definition at line 123 of file MinimizerItem.h.

Referenced by SimAnMinimizerItem(), createMinimizer(), and valueDescriptorsForUI().

P_BOLTZMANN_TINIT

constexpr auto SimAnMinimizerItem::P_BOLTZMANN_TINIT {"t_init"}

staticconstexprprivate

Definition at line 122 of file MinimizerItem.h.

Referenced by SimAnMinimizerItem(), createMinimizer(), and valueDescriptorsForUI().

P_BOLTZMANN_TMIN

constexpr auto SimAnMinimizerItem::P_BOLTZMANN_TMIN {"t_min"}

staticconstexprprivate

Definition at line 124 of file MinimizerItem.h.

Referenced by SimAnMinimizerItem(), createMinimizer(), and valueDescriptorsForUI().

P_ITERATIONSTEMP

constexpr auto SimAnMinimizerItem::P_ITERATIONSTEMP {"IterationsAtTemp"}

staticconstexprprivate

Definition at line 119 of file MinimizerItem.h.

Referenced by SimAnMinimizerItem(), createMinimizer(), and valueDescriptorsForUI().

P_MAXITERATIONS

constexpr auto SimAnMinimizerItem::P_MAXITERATIONS {"MaxIterations"}

staticconstexprprivate

Definition at line 118 of file MinimizerItem.h.

Referenced by SimAnMinimizerItem(), createMinimizer(), and valueDescriptorsForUI().

P_NAME

constexpr auto SessionItem::P_NAME {"Name"}

staticconstexprprivateinherited

Definition at line 208 of file SessionItem.h.

Referenced by SessionItem::getCopyNumberOfChild(), SessionItem::isItemNamePropertyName(), SessionItem::itemName(), and SessionItem::setItemName().

P_STEPSIZE

constexpr auto SimAnMinimizerItem::P_STEPSIZE {"StepSize"}

staticconstexprprivate

Definition at line 120 of file MinimizerItem.h.

Referenced by SimAnMinimizerItem(), createMinimizer(), and valueDescriptorsForUI().

---

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

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