MAKLogger::DtLgrAnnotationFactory Class Reference

Annotation factory responsible for holding functions with display an annotation creation dialog and return a new annotation. More...

Collaboration diagram for MAKLogger::DtLgrAnnotationFactory:

Static Public Member Functions
static const DtAnnotationTypeMap &	annotationTypesMap ()
	Get a list of all annotation types. More...
static const QStringList &	annotationTypeNames ()
	Get a list of all the annotation type names. More...
static DtLgrAnnotation *	createAnnotation (const DtString &type, QWidget *parent, DtLgrGuiModel *model)
	Create an annotation of a given type. More...
static void	editAnnotation (QWidget *parent, DtLgrAnnotation *, DtLgrGuiModel *model)
	Edit an annotation, the annotation will provide the type. More...
static DtLgrAnnotation *	convertAnnotation (const DtString &type, const DtLgrAnnotation *source)
	Convert an annotation. More...
static DtLgrAnnotation *	loadAnnotation (const DtEnvObject *object)
	Load an annotation for an environment object. More...
static DtLgrAnnotationSliderBar *	createSliderBar (DtLgrAnnotation *)
	Create a slider bar for the annotation. More...
static bool	isAnnotationType (const DtString &type)
	Check whether a string is a registered type. More...
static void	registerAnnotationType (const DtLgrAnnotationDefinition &typeDefinition)
	Register an annotation type, with a creator and modifier functions. More...
static void	registerAnnotationConversion (const DtString &destinationType, const DtString &sourceType, DtLgrAnnotationDefinition::AnnotationConvertor function)
static const std::list < DtString > &	availableConversions (const DtString &sourceType)
	Get available conversion functions for a given type. More...

Protected Types
typedef std::map< DtString, DtLgrAnnotationDefinition::AnnotationConvertor >	ConvertorMap
typedef std::map< DtString, std::list< DtString > >	ConversionListMap

Static Protected Member Functions
static DtLgrAnnotationDefinition &	getKnownDefinition (const DtString &type)
	Get the definition object of a known type. More...
static DtString	conversionKey (const DtString &destType, const DtString &srcType)

Static Protected Attributes
static std::list< DtString >	theAnnotationTypeList
	The list of type strings. More...
static QStringList	theAnnotationTypeNames
static DtAnnotationTypeMap	theAnnotationTypes
	The list of annotation types. More...
static ConvertorMap	theConvertorMap
	A map of conversion functions. More...
static ConversionListMap	theConversionListMap

Private Member Functions
	DtLgrAnnotationFactory ()
	Not Implemented. More...
	~DtLgrAnnotationFactory ()
	Not Implemented. More...
	DtLgrAnnotationFactory (const DtLgrAnnotationFactory &)
	Not Implemented. More...
DtLgrAnnotationFactory &	operator= (const DtLgrAnnotationFactory &)
	Not Implemented. More...

Detailed Description

Annotation factory responsible for holding functions with display an annotation creation dialog and return a new annotation.

Member Typedef Documentation

typedef std::map<DtString, std::list<DtString> > MAKLogger::DtLgrAnnotationFactory::ConversionListMap

protected

typedef std::map<DtString,DtLgrAnnotationDefinition::AnnotationConvertor> MAKLogger::DtLgrAnnotationFactory::ConvertorMap

protected

Constructor & Destructor Documentation

MAKLogger::DtLgrAnnotationFactory::DtLgrAnnotationFactory ( )

private

Not Implemented.

MAKLogger::DtLgrAnnotationFactory::~DtLgrAnnotationFactory ( )

private

Not Implemented.

MAKLogger::DtLgrAnnotationFactory::DtLgrAnnotationFactory ( const DtLgrAnnotationFactory &  )

private

Not Implemented.

Member Function Documentation

static const QStringList& MAKLogger::DtLgrAnnotationFactory::annotationTypeNames ( )

static

Get a list of all the annotation type names.

static const DtAnnotationTypeMap& MAKLogger::DtLgrAnnotationFactory::annotationTypesMap ( )

static

Get a list of all annotation types.

static const std::list<DtString>& MAKLogger::DtLgrAnnotationFactory::availableConversions ( const DtString &  sourceType )

static

Get available conversion functions for a given type.

static DtString MAKLogger::DtLgrAnnotationFactory::conversionKey ( const DtString &  destType, const DtString &  srcType  )

staticprotected

static DtLgrAnnotation* MAKLogger::DtLgrAnnotationFactory::convertAnnotation ( const DtString &  type, const DtLgrAnnotation *  source  )

static

Convert an annotation.

Returns NULL if no conversion available. Constructs a new annotation of type, using the source to provide any possible parameters.

static DtLgrAnnotation* MAKLogger::DtLgrAnnotationFactory::createAnnotation ( const DtString &  type, QWidget *  parent, DtLgrGuiModel *  model  )

static

Create an annotation of a given type.

static DtLgrAnnotationSliderBar* MAKLogger::DtLgrAnnotationFactory::createSliderBar ( DtLgrAnnotation *  )

static

Create a slider bar for the annotation.

static void MAKLogger::DtLgrAnnotationFactory::editAnnotation ( QWidget *  parent, DtLgrAnnotation *  , DtLgrGuiModel *  model  )

static

Edit an annotation, the annotation will provide the type.

static DtLgrAnnotationDefinition& MAKLogger::DtLgrAnnotationFactory::getKnownDefinition ( const DtString &  type )

staticprotected

Get the definition object of a known type.

The type must be valid so isAnnotationType should be used to check first.

static bool MAKLogger::DtLgrAnnotationFactory::isAnnotationType ( const DtString &  type )

static

Check whether a string is a registered type.

static DtLgrAnnotation* MAKLogger::DtLgrAnnotationFactory::loadAnnotation ( const DtEnvObject *  object )

static

Load an annotation for an environment object.

The type string will be stored in the object type.

DtLgrAnnotationFactory& MAKLogger::DtLgrAnnotationFactory::operator= ( const DtLgrAnnotationFactory &  )

private

Not Implemented.

static void MAKLogger::DtLgrAnnotationFactory::registerAnnotationConversion ( const DtString &  destinationType, const DtString &  sourceType, DtLgrAnnotationDefinition::AnnotationConvertor  function  )

static

static void MAKLogger::DtLgrAnnotationFactory::registerAnnotationType ( const DtLgrAnnotationDefinition &  typeDefinition )

static

Register an annotation type, with a creator and modifier functions.

Member Data Documentation

std::list<DtString> MAKLogger::DtLgrAnnotationFactory::theAnnotationTypeList

staticprotected

The list of type strings.

QStringList MAKLogger::DtLgrAnnotationFactory::theAnnotationTypeNames

staticprotected

DtAnnotationTypeMap MAKLogger::DtLgrAnnotationFactory::theAnnotationTypes

staticprotected

The list of annotation types.

ConversionListMap MAKLogger::DtLgrAnnotationFactory::theConversionListMap

staticprotected

ConvertorMap MAKLogger::DtLgrAnnotationFactory::theConvertorMap

staticprotected

A map of conversion functions.

---

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

• lgrAnnotationFactory.h