svcore  1.9
TransformDescription Struct Reference

Metadata associated with a transform. More...

#include <TransformDescription.h>

List of all members.

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

Public Attributes

Type type
QString category
TransformId identifier
QString name
QString friendlyName
QString description
QString longDescription
QString maker
QString infoUrl
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 46 of file TransformDescription.h.


Member Enumeration Documentation

Enumerator:
Analysis 
Effects 
EffectsData 
Generator 
UnknownType 

Definition at line 48 of file TransformDescription.h.


Constructor & Destructor Documentation

Definition at line 56 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 58 of file TransformDescription.h.


Member Function Documentation

bool TransformDescription::operator< ( const TransformDescription od) const [inline]

Definition at line 81 of file TransformDescription.h.

References identifier, and name.


Member Data Documentation


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