MAKLogger::DtLgrAnnotation Class Reference

Base annotation class defines interface for all annotations. More...

Inheritance diagram for MAKLogger::DtLgrAnnotation:

Collaboration diagram for MAKLogger::DtLgrAnnotation:

Public Member Functions
	DtLgrAnnotation (const DtLgrAnnotationDefinition *definition)
	CTOR. More...
virtual	~DtLgrAnnotation ()
const DtLgrAnnotationDefinition *	definition () const
	Get the definition of of this type of annotation. More...
virtual void	addedToManager (DtLgrAnnotationManager *manager)
	Called by manager after added to a given manager. More...
virtual const DtString &	type () const =0
virtual void	setName (const DtString &name)=0
virtual const DtString &	name () const =0
virtual void	setText (const DtString &text)=0
virtual const DtString &	text () const =0
virtual void	setStartTime (const DtAbsoluteTime &time)=0
virtual const DtAbsoluteTime &	startTime () const =0
virtual void	setEndTime (const DtAbsoluteTime &time)=0
virtual const DtAbsoluteTime &	endTime () const =0
virtual void	initializeFromObject (const DtEnvObject *annotationObject)=0
	Initialize from environment object. More...
virtual void	createObject (DtEnvironment environment)=0
	Set the attributes on an environment object. More...

Static Public Member Functions
static bool	compareNames (const DtLgrAnnotation *a, const DtLgrAnnotation *b)
	Static function used for sorting. More...

Protected Member Functions
virtual void	annotationChanged ()
	Function should be called by any annotation function which modifies the state of the annotation. More...

Protected Attributes
DtLgrAnnotationManager *	myManager
const DtLgrAnnotationDefinition *	myTypeDefinition

Detailed Description

Base annotation class defines interface for all annotations.

Constructor & Destructor Documentation

MAKLogger::DtLgrAnnotation::DtLgrAnnotation

(

const DtLgrAnnotationDefinition *

definition

)

CTOR.

virtual MAKLogger::DtLgrAnnotation::~DtLgrAnnotation ( )

virtual

Member Function Documentation

virtual void MAKLogger::DtLgrAnnotation::addedToManager ( DtLgrAnnotationManager *  manager )

virtual

Called by manager after added to a given manager.

Annotations maintain a pointer to the manager to notify it of changes.

virtual void MAKLogger::DtLgrAnnotation::annotationChanged ( )

protectedvirtual

Function should be called by any annotation function which modifies the state of the annotation.

static bool MAKLogger::DtLgrAnnotation::compareNames ( const DtLgrAnnotation *  a, const DtLgrAnnotation *  b  )

static

Static function used for sorting.

virtual void MAKLogger::DtLgrAnnotation::createObject ( DtEnvironment  environment )

pure virtual

Set the attributes on an environment object.

Implemented in MAKLogger::DtLgrPointAnnotation, and MAKLogger::DtLgrRangeAnnotation.

const DtLgrAnnotationDefinition* MAKLogger::DtLgrAnnotation::definition

(

)

const

Get the definition of of this type of annotation.

This is non null if object is created using the annotation factory.

virtual const DtAbsoluteTime& MAKLogger::DtLgrAnnotation::endTime ( ) const

pure virtual

Implemented in MAKLogger::DtLgrRangeAnnotation, and MAKLogger::DtLgrPointAnnotation.

virtual void MAKLogger::DtLgrAnnotation::initializeFromObject ( const DtEnvObject *  annotationObject )

pure virtual

Initialize from environment object.

Implemented in MAKLogger::DtLgrPointAnnotation, and MAKLogger::DtLgrRangeAnnotation.

virtual const DtString& MAKLogger::DtLgrAnnotation::name ( ) const

pure virtual

Implemented in MAKLogger::DtLgrRangeAnnotation, and MAKLogger::DtLgrPointAnnotation.

virtual void MAKLogger::DtLgrAnnotation::setEndTime ( const DtAbsoluteTime &  time )

pure virtual

Implemented in MAKLogger::DtLgrPointAnnotation, and MAKLogger::DtLgrRangeAnnotation.

virtual void MAKLogger::DtLgrAnnotation::setName ( const DtString &  name )

pure virtual

Implemented in MAKLogger::DtLgrRangeAnnotation, and MAKLogger::DtLgrPointAnnotation.

virtual void MAKLogger::DtLgrAnnotation::setStartTime ( const DtAbsoluteTime &  time )

pure virtual

Implemented in MAKLogger::DtLgrPointAnnotation, and MAKLogger::DtLgrRangeAnnotation.

virtual void MAKLogger::DtLgrAnnotation::setText ( const DtString &  text )

pure virtual

Implemented in MAKLogger::DtLgrRangeAnnotation, and MAKLogger::DtLgrPointAnnotation.

virtual const DtAbsoluteTime& MAKLogger::DtLgrAnnotation::startTime ( ) const

pure virtual

Implemented in MAKLogger::DtLgrRangeAnnotation, and MAKLogger::DtLgrPointAnnotation.

virtual const DtString& MAKLogger::DtLgrAnnotation::text ( ) const

pure virtual

Implemented in MAKLogger::DtLgrRangeAnnotation, and MAKLogger::DtLgrPointAnnotation.

virtual const DtString& MAKLogger::DtLgrAnnotation::type ( ) const

pure virtual

Implemented in MAKLogger::DtLgrRangeAnnotation, and MAKLogger::DtLgrPointAnnotation.

Member Data Documentation

DtLgrAnnotationManager* MAKLogger::DtLgrAnnotation::myManager

protected

const DtLgrAnnotationDefinition* MAKLogger::DtLgrAnnotation::myTypeDefinition

protected

---

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

• lgrAnnotation.h