TransformDescription Struct Reference

#include <TransformDescription.h>

List of all members.

---

Detailed Description

Metadata associated with a transform.

The transform ID is the same as that used in the Transform class. It is intended to be computer-referenceable and unique within the application.

The name is intended to be human readable. In principle it doesn't have to be unique, but the factory that creates these objects should add suffixes to ensure that it is, all the same (just to avoid user confusion).

The friendly name is a shorter version of the name.

The type is also intended to be user-readable, for use in menus.

To obtain these objects, use TransformFactory::getAllTransformDescriptions and TransformFactory::getTransformDescription.

Definition at line 46 of file TransformDescription.h.

Public Member Functions
	TransformDescription ()
	TransformDescription (QString _type, QString _category, TransformId _identifier, QString _name, QString _friendlyName, QString _description, QString _maker, QString _units, bool _configurable)
bool	operator< (const TransformDescription &od) const
Public Attributes
QString	type
QString	category
TransformId	identifier
QString	name
QString	friendlyName
QString	description
QString	maker
QString	units
bool	configurable

---

Constructor & Destructor Documentation

TransformDescription::TransformDescription

(

)

[inline]

Definition at line 48 of file TransformDescription.h.

TransformDescription::TransformDescription	(	QString	_type,
		QString	_category,
		TransformId	_identifier,
		QString	_name,
		QString	_friendlyName,
		QString	_description,
		QString	_maker,
		QString	_units,
		bool	_configurable
	)			[inline]

Definition at line 49 of file TransformDescription.h.

---

Member Function Documentation

bool TransformDescription::operator<

(

const TransformDescription &

od

)

const [inline]

Definition at line 68 of file TransformDescription.h.

References identifier, and name.

---

Member Data Documentation

QString TransformDescription::type

Definition at line 58 of file TransformDescription.h.

QString TransformDescription::category

Definition at line 59 of file TransformDescription.h.

TransformId TransformDescription::identifier

Definition at line 60 of file TransformDescription.h.

Referenced by operator<().

QString TransformDescription::name

Definition at line 61 of file TransformDescription.h.

Referenced by operator<().

QString TransformDescription::friendlyName

Definition at line 62 of file TransformDescription.h.

QString TransformDescription::description

Definition at line 63 of file TransformDescription.h.

QString TransformDescription::maker

Definition at line 64 of file TransformDescription.h.

QString TransformDescription::units

Definition at line 65 of file TransformDescription.h.

bool TransformDescription::configurable

Definition at line 66 of file TransformDescription.h.

---

The documentation for this struct was generated from the following file:

• TransformDescription.h

---