iAAttributes.h File Reference

#include "iAbase_export.h"
#include "iAAttributeDescriptor.h"
#include <QVector>
#include <QSharedPointer>

Typedefs
using	iAAttributes = QVector< QSharedPointer< iAAttributeDescriptor > >
	List of descriptors for e.g. parameter values.

Functions
iAbase_API void	addAttr (iAAttributes &attributes, QString const &name, iAValueType valueType, QVariant defaultValue=0.0, double min=std::numeric_limits< double >::lowest(), double max=std::numeric_limits< double >::max())
iAbase_API iAAttributes	combineAttributesWithValues (iAAttributes const &attributes, QVariantMap const &values)
	Merge the given values into the descriptors (returns new descriptors with the given values as default values)
iAbase_API int	countAttributes (iAAttributes const &attributes, iAAttributeDescriptor::iAAttributeType type=iAAttributeDescriptor::None)
	Count the attribute descriptors of the given type in the given collection.
iAbase_API QSharedPointer< iAAttributes >	createAttributes (QTextStream &in)
	Create a descriptor from a given text stream.
iAbase_API QVariantMap	extractValues (iAAttributes const &attributes)
	Extract just the values from the given descriptors into a map.
iAbase_API int	findAttribute (iAAttributes const &attributes, QString const &name)
	Find a descriptor with the given name and return its index.
iAbase_API QVariantMap	joinValues (QVariantMap const &baseValues, QVariantMap const &newValues)
	Merge the values from newValues into baseValues.
iAbase_API void	setApplyingValues (QVariantMap &out, iAAttributes const &attributes, QVariantMap const &in)
	In a given key/value map out, set values from another map in, for all keys that exist in the given attributes and the in map.
iAbase_API void	storeAttributes (QTextStream &out, iAAttributes const &attributes)
	Store the given descriptors in the given text stream.

Typedef Documentation

iAAttributes

using iAAttributes = QVector<QSharedPointer<iAAttributeDescriptor> >

List of descriptors for e.g. parameter values.

Function Documentation

addAttr()

iAbase_API void addAttr	(	iAAttributes &	attributes,
		QString const &	name,
		iAValueType	valueType,
		QVariant	defaultValue = 0.0,
		double	min = std::numeric_limits< double >::lowest(),
		double	max = std::numeric_limits< double >::max()
	)

combineAttributesWithValues()

iAbase_API iAAttributes combineAttributesWithValues	(	iAAttributes const &	attributes,
		QVariantMap const &	values
	)

Merge the given values into the descriptors (returns new descriptors with the given values as default values)

countAttributes()

iAbase_API int countAttributes	(	iAAttributes const &	attributes,
		iAAttributeDescriptor::iAAttributeType	type = iAAttributeDescriptor::None
	)

Count the attribute descriptors of the given type in the given collection.

createAttributes()

iAbase_API QSharedPointer< iAAttributes > createAttributes

(

QTextStream &

in

)

Create a descriptor from a given text stream.

extractValues()

iAbase_API QVariantMap extractValues

(

iAAttributes const &

attributes

)

Extract just the values from the given descriptors into a map.

findAttribute()

iAbase_API int findAttribute	(	iAAttributes const &	attributes,
		QString const &	name
	)

Find a descriptor with the given name and return its index.

joinValues()

iAbase_API QVariantMap joinValues	(	QVariantMap const &	baseValues,
		QVariantMap const &	newValues
	)

Merge the values from newValues into baseValues.

setApplyingValues()

iAbase_API void setApplyingValues	(	QVariantMap &	out,
		iAAttributes const &	attributes,
		QVariantMap const &	in
	)

In a given key/value map out, set values from another map in, for all keys that exist in the given attributes and the in map.

Parameters

out	the key/value map that is modified
attributes	list of possible attributes - only keys in out which have a corresponding entry in here will be set
in	the map of key/values used as input; any values existing in this map AND in attributes, will be set in out

storeAttributes()

iAbase_API void storeAttributes	(	QTextStream &	out,
		iAAttributes const &	attributes
	)

Store the given descriptors in the given text stream.