MetaData Class Reference

Handle metadata management for ParameterFileModel classes. More...

#include <MetaData.h>

Public Member Functions
	MetaData (QString fileName)
	Load metadata from given file.
Data queries
QStringList	getClasses () const
	get classes contained in this metadata file
QStringList	getOutputs (QString className) const
	get input slots of some given object More...
QStringList	getOutputDisplayNames (QString className) const
	get input slots of some given object More...
QStringList	getInputs (QString className) const
	get output slots of some given object More...
QStringList	getInputDisplayNames (QString className) const
	get output slots of some given object More...
QStringList	getParameters (QString className) const
	get parameters of some given object More...
QString	getType (QString parName, QString className) const
	Get type of some parameter or slot. More...
QString	getDefault (QString parName, QString className) const
	get default value for some editable parameter More...
QString	getDocString (QString parName, QString className) const
	get docstring for some parameter or some class. More...
QString	getDocFile (QString parName, QString className) const
	get filename for some parameter or class documentation. More...
bool	isInputSlot (QString name, QString className) const
	Check if some parameter/slot is an input slot. More...
bool	isOptionalSlot (QString slotName, QString className) const
	Check if some slot is optional. More...
bool	isMultiSlot (QString slotName, QString className) const
	Check if some slot is a multi slot. More...
bool	isDynamic (QString className) const
	Check if module is dynamic. More...
QStringList	getTags (QString className) const
	Get the tags of a given object. More...

Private Attributes
QStringList	_classes
	contained classes
const QParameterFile *	_data
	used ParameterFile (read only)

Detailed Description

Definition at line 31 of file MetaData.h.

Member Function Documentation

QString MetaData::getDefault	(	QString	parName,
		QString	className
	)		const

Parameters

parName	name of the parameter
className	object class name

Returns

empty string, if no default given

Definition at line 86 of file MetaData.cpp.

References _data, and QParameterFile::get().

QString MetaData::getDocFile	(	QString	parName,
		QString	className
	)		const

Parameters

parName	name of the parameter
className	object class name

Returns

empty string, if no docfile given

Definition at line 102 of file MetaData.cpp.

References _data, and QParameterFile::get().

QString MetaData::getDocString	(	QString	parName,
		QString	className
	)		const

Parameters

parName	name of the parameter
className	object class name

Returns

empty string, if no docstring given

Definition at line 93 of file MetaData.cpp.

References _data, and QParameterFile::get().

QStringList MetaData::getInputDisplayNames

(

QString

className

)

const

Parameters

className

object class name (use ParameterFileModel::getClass to get this)

Returns

list of output slots

Definition at line 142 of file MetaData.cpp.

References _data, and QParameterFile::get().

QStringList MetaData::getInputs

(

QString

className

)

const

Parameters

className

object class name (use ParameterFileModel::getClass to get this)

Returns

list of output slots

Definition at line 65 of file MetaData.cpp.

References _data, and QParameterFile::get().

QStringList MetaData::getOutputDisplayNames

(

QString

className

)

const

Parameters

className

object class name (use ParameterFileModel::getClass to get this)

Returns

list of input slots

Definition at line 159 of file MetaData.cpp.

References _data, and QParameterFile::get().

QStringList MetaData::getOutputs

(

QString

className

)

const

Parameters

className

object class name (use ParameterFileModel::getClass to get this)

Returns

list of input slots

Definition at line 59 of file MetaData.cpp.

References _data, and QParameterFile::get().

QStringList MetaData::getParameters

(

QString

className

)

const

Parameters

className

object class name (use ParameterFileModel::getClass to get this)

Returns

list of parameters

Definition at line 72 of file MetaData.cpp.

References _data, and QParameterFile::get().

QStringList MetaData::getTags

(

QString

className

)

const

Parameters

className

......object class name

Returns

................list of tags

Definition at line 137 of file MetaData.cpp.

References _data, and QParameterFile::get().

QString MetaData::getType	(	QString	parName,
		QString	className
	)		const

Use GraphModel::getType if there are template arguments and you need to know the type in the specific instance.

Parameters

parName	name of the parameter
className	object class name (use ParameterFileModel::getClass to get this)

Returns

slot type

Definition at line 77 of file MetaData.cpp.

References _data, and QParameterFile::get().

bool MetaData::isDynamic

(

QString

className

)

const

Parameters

className

object class name

Return values

true	module is dynamic

Definition at line 133 of file MetaData.cpp.

References _data, and QParameterFile::get().

bool MetaData::isInputSlot	(	QString	name,
		QString	className
	)		const

Parameters

name	name of the slot
className	object class name

Return values

true	given object is an input slot

Definition at line 111 of file MetaData.cpp.

References getInputs().

bool MetaData::isMultiSlot	(	QString	slotName,
		QString	className
	)		const

Parameters

slotName	name of the slot
className	object class name

Exceptions

std::string

error message if slot is invalid (i.e. does not exists, etc.)

Return values

true	slot may have multiple targets

Definition at line 125 of file MetaData.cpp.

References _data, QParameterFile::get(), isInputSlot(), and QParameterFile::isSet().

bool MetaData::isOptionalSlot	(	QString	slotName,
		QString	className
	)		const

Parameters

slotName	name of the slot
className	object class name

Exceptions

std::string

error message if slot is invalid (i.e. does not exists, etc.)

Return values

true	slot is optional

Definition at line 117 of file MetaData.cpp.

References _data, QParameterFile::get(), isInputSlot(), and QParameterFile::isSet().

---

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

• src/MetaData.h
• src/MetaData.cpp