MAKLogger::DtLgrPointAnnotation Class Reference

Represents an annotation for a specific point in time. More...

Inheritance diagram for MAKLogger::DtLgrPointAnnotation:

Collaboration diagram for MAKLogger::DtLgrPointAnnotation:

Public Member Functions
	DtLgrPointAnnotation (const DtString &name, DtAbsoluteTime time, const DtString &text)
	CTOR takes the annotations name, time and text.
virtual	~DtLgrPointAnnotation ()
	DTOR.
virtual const DtString &	type () const
	Get the annotation's name.
virtual void	setName (const DtString &name)
	Set the annotation's name.
virtual const DtString &	name () const
	Get the annotation's name.
virtual void	setText (const DtString &text)
	Set the annotation's text.
virtual const DtString &	text () const
	Get the annotation's text.
virtual const DtAbsoluteTime &	startTime () const
	Get the annotation's start time.
virtual const DtAbsoluteTime &	endTime () const
	Get the annotation's end time.
virtual void	setStartTime (const DtAbsoluteTime &time)
virtual void	setEndTime (const DtAbsoluteTime &time)
virtual const DtAbsoluteTime &	time () const
	Get the annotation's time. The same as startTime and endTime.
virtual void	setTime (DtAbsoluteTime time)
	Set the annotation's time.
virtual void	initializeFromObject (const DtEnvObject *annotationObject)
	Initialize from environment object.
virtual void	createObject (DtEnvironment environment)
	Create an object in the environment.
Public Member Functions inherited from MAKLogger::DtLgrAnnotation
	DtLgrAnnotation (const DtLgrAnnotationDefinition *definition)
	CTOR.
virtual	~DtLgrAnnotation ()
const DtLgrAnnotationDefinition *	definition () const
	Get the definition of of this type of annotation.
virtual void	addedToManager (DtLgrAnnotationManager *manager)
	Called by manager after added to a given manager.

Static Public Attributes
static DtLgrAnnotationDefinition	theDefinition
	The global definition of the point annotation type.

Static Protected Member Functions
static DtLgrAnnotation *	load (const DtEnvObject *)
	Create an annotation from an object.
static DtLgrAnnotationSliderBar *	createBar (DtLgrAnnotation *)
	Draw the bar for a point annotation.

Protected Attributes
DtString	myName
	Name string is in UTF8 format.
DtString	myText
	Text string is in UTF8 format.
DtAbsoluteTime	myTime
Protected Attributes inherited from MAKLogger::DtLgrAnnotation
DtLgrAnnotationManager *	myManager
const DtLgrAnnotationDefinition *	myTypeDefinition

Additional Inherited Members
Static Public Member Functions inherited from MAKLogger::DtLgrAnnotation
static bool	compareNames (const DtLgrAnnotation *a, const DtLgrAnnotation *b)
	Static function used for sorting.
Protected Member Functions inherited from MAKLogger::DtLgrAnnotation
virtual void	annotationChanged ()
	Function should be called by any annotation function which modifies the state of the annotation.

Detailed Description

Represents an annotation for a specific point in time.

Constructor & Destructor Documentation

MAKLogger::DtLgrPointAnnotation::DtLgrPointAnnotation	(	const DtString &	name,
		DtAbsoluteTime	time,
		const DtString &	text
	)

CTOR takes the annotations name, time and text.

virtual MAKLogger::DtLgrPointAnnotation::~DtLgrPointAnnotation ( )

virtual

DTOR.

Member Function Documentation

static DtLgrAnnotationSliderBar* MAKLogger::DtLgrPointAnnotation::createBar ( DtLgrAnnotation *  )

staticprotected

Draw the bar for a point annotation.

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

virtual

Create an object in the environment.

Implements MAKLogger::DtLgrAnnotation.

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

virtual

Get the annotation's end time.

For point annotations start time and end time are the same.

Implements MAKLogger::DtLgrAnnotation.

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

virtual

Initialize from environment object.

Implements MAKLogger::DtLgrAnnotation.

static DtLgrAnnotation* MAKLogger::DtLgrPointAnnotation::load ( const DtEnvObject *  )

staticprotected

Create an annotation from an object.

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

virtual

Get the annotation's name.

Implements MAKLogger::DtLgrAnnotation.

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

virtual

Implements MAKLogger::DtLgrAnnotation.

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

virtual

Set the annotation's name.

Implements MAKLogger::DtLgrAnnotation.

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

virtual

Implements MAKLogger::DtLgrAnnotation.

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

virtual

Set the annotation's text.

Implements MAKLogger::DtLgrAnnotation.

virtual void MAKLogger::DtLgrPointAnnotation::setTime ( DtAbsoluteTime  time )

virtual

Set the annotation's time.

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

virtual

Get the annotation's start time.

For point annotations start time and end time are the same.

Implements MAKLogger::DtLgrAnnotation.

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

virtual

Get the annotation's text.

Implements MAKLogger::DtLgrAnnotation.

virtual const DtAbsoluteTime& MAKLogger::DtLgrPointAnnotation::time ( ) const

virtual

Get the annotation's time. The same as startTime and endTime.

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

virtual

Get the annotation's name.

Implements MAKLogger::DtLgrAnnotation.

Member Data Documentation

DtString MAKLogger::DtLgrPointAnnotation::myName

protected

Name string is in UTF8 format.

DtString MAKLogger::DtLgrPointAnnotation::myText

protected

Text string is in UTF8 format.

DtAbsoluteTime MAKLogger::DtLgrPointAnnotation::myTime

protected

DtLgrAnnotationDefinition MAKLogger::DtLgrPointAnnotation::theDefinition

static

The global definition of the point annotation type.

---

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

• lgrPointAnnotation.h