TransformDescription Struct Reference

Metadata associated with a transform. More...

#include <TransformDescription.h>

Collaboration diagram for TransformDescription:

Public Types
enum	Type {   Analysis, Effects, EffectsData, Generator,   UnknownType }

Public Member Functions
	TransformDescription ()
	TransformDescription (Type _type, QString _category, TransformId _identifier, QString _name, QString _friendlyName, QString _description, QString _longDescription, QString _maker, QString _units, bool _configurable)
bool	operator< (const TransformDescription &od) const

Static Public Member Functions
static bool	compareUserStrings (QString s1, QString s2)

Public Attributes
Type	type
QString	category
TransformId	identifier
QString	name
QString	friendlyName
QString	description
QString	longDescription
QString	maker
Provider	provider
QString	units
bool	configurable

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 48 of file TransformDescription.h.

Member Enumeration Documentation

enum TransformDescription::Type

Enumerator
Analysis
Effects
EffectsData
Generator
UnknownType

Definition at line 50 of file TransformDescription.h.

Constructor & Destructor Documentation

TransformDescription::TransformDescription ( )

inline

Definition at line 58 of file TransformDescription.h.

TransformDescription::TransformDescription ( Type  _type, QString  _category, TransformId  _identifier, QString  _name, QString  _friendlyName, QString  _description, QString  _longDescription, QString  _maker, QString  _units, bool  _configurable  )

inline

Definition at line 60 of file TransformDescription.h.

Member Function Documentation

static bool TransformDescription::compareUserStrings ( QString  s1, QString  s2  )

inlinestatic

Definition at line 85 of file TransformDescription.h.

Referenced by TransformFactory::getTransformCategories(), TransformFactory::getTransformMakers(), and operator<().

bool TransformDescription::operator< ( const TransformDescription &  od ) const

inline

Definition at line 89 of file TransformDescription.h.

References compareUserStrings(), identifier, and name.

Member Data Documentation

Type TransformDescription::type

Definition at line 71 of file TransformDescription.h.

Referenced by TransformFactory::populateUninstalledTransforms().

QString TransformDescription::category

Definition at line 72 of file TransformDescription.h.

Referenced by TransformFactory::populateUninstalledTransforms().

TransformId TransformDescription::identifier

Definition at line 73 of file TransformDescription.h.

Referenced by operator<(), TransformFactory::populateTransforms(), and TransformFactory::populateUninstalledTransforms().

QString TransformDescription::name

Definition at line 74 of file TransformDescription.h.

Referenced by operator<(), TransformFactory::populateTransforms(), and TransformFactory::populateUninstalledTransforms().

QString TransformDescription::friendlyName

Definition at line 75 of file TransformDescription.h.

Referenced by TransformFactory::populateUninstalledTransforms().

QString TransformDescription::description

Definition at line 76 of file TransformDescription.h.

Referenced by TransformFactory::populateUninstalledTransforms().

QString TransformDescription::longDescription

Definition at line 77 of file TransformDescription.h.

Referenced by TransformFactory::populateUninstalledTransforms().

QString TransformDescription::maker

Definition at line 78 of file TransformDescription.h.

Referenced by TransformFactory::populateTransforms(), and TransformFactory::populateUninstalledTransforms().

Provider TransformDescription::provider

Definition at line 79 of file TransformDescription.h.

Referenced by TransformFactory::populateUninstalledTransforms().

QString TransformDescription::units

Definition at line 80 of file TransformDescription.h.

Referenced by TransformFactory::populateUninstalledTransforms().

bool TransformDescription::configurable

Definition at line 81 of file TransformDescription.h.

Referenced by TransformFactory::populateUninstalledTransforms().

---

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

• TransformDescription.h