MAKLogger::DtLgrRangeAnnotation Class Reference

Class responsible for representing an annotation over a span of time. More...

Inheritance diagram for MAKLogger::DtLgrRangeAnnotation:

Collaboration diagram for MAKLogger::DtLgrRangeAnnotation:

Public Member Functions
	DtLgrRangeAnnotation (const DtString &name, const DtString &description, DtAbsoluteTime startTime, DtAbsoluteTime endTime)
virtual	~DtLgrRangeAnnotation ()
virtual const DtString &	type () const
	Accessor for getting the annotation type.
virtual void	setName (const DtString &name)
	Accessor for setting the annotation name.
virtual const DtString &	name () const
	Accessor for getting the annotation name.
virtual void	setText (const DtString &name)
	Accessor for setting the annotation text.
virtual const DtString &	text () const
	Accessor for getting the annotation text.
virtual void	setStartTime (const DtAbsoluteTime &time)
	Accessor for setting the annotation start time.
virtual const DtAbsoluteTime &	startTime () const
	Get the start time.
virtual void	setEndTime (const DtAbsoluteTime &time)
	Accessor for setting the annotation start time.
virtual const DtAbsoluteTime &	endTime () const
	Get the end time.
virtual DtRelativeTime	duration () const
	Get the End Time - start 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
	Annotation type definition.

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

Protected Attributes
DtString	myName
DtString	myText
DtAbsoluteTime	myStartTime
DtAbsoluteTime	myEndTime
Protected Attributes inherited from MAKLogger::DtLgrAnnotation
DtLgrAnnotationManager *	myManager
const DtLgrAnnotationDefinition *	myTypeDefinition

Private Member Functions
	DtLgrRangeAnnotation (const DtLgrRangeAnnotation &)
	Not Implemented.
DtLgrRangeAnnotation &	operator= (const DtLgrRangeAnnotation &)
	Not Implemented.

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

Class responsible for representing an annotation over a span of time.

Constructor & Destructor Documentation

MAKLogger::DtLgrRangeAnnotation::DtLgrRangeAnnotation	(	const DtString &	name,
		const DtString &	description,
		DtAbsoluteTime	startTime,
		DtAbsoluteTime	endTime
	)

virtual MAKLogger::DtLgrRangeAnnotation::~DtLgrRangeAnnotation ( )

virtual

MAKLogger::DtLgrRangeAnnotation::DtLgrRangeAnnotation ( const DtLgrRangeAnnotation &  )

private

Not Implemented.

Member Function Documentation

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

staticprotected

Create a range annotation slider bar for the annotation.

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

virtual

Create an object in the environment.

Implements MAKLogger::DtLgrAnnotation.

virtual DtRelativeTime MAKLogger::DtLgrRangeAnnotation::duration ( ) const

virtual

Get the End Time - start time.

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

virtual

Get the end time.

Implements MAKLogger::DtLgrAnnotation.

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

virtual

Initialize from environment object.

Implements MAKLogger::DtLgrAnnotation.

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

staticprotected

Create a range annotation from an env object.

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

virtual

Accessor for getting the annotation name.

Implements MAKLogger::DtLgrAnnotation.

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

private

Not Implemented.

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

virtual

Accessor for setting the annotation start time.

Implements MAKLogger::DtLgrAnnotation.

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

virtual

Accessor for setting the annotation name.

Implements MAKLogger::DtLgrAnnotation.

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

virtual

Accessor for setting the annotation start time.

Implements MAKLogger::DtLgrAnnotation.

virtual void MAKLogger::DtLgrRangeAnnotation::setText ( const DtString &  name )

virtual

Accessor for setting the annotation text.

Implements MAKLogger::DtLgrAnnotation.

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

virtual

Get the start time.

Implements MAKLogger::DtLgrAnnotation.

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

virtual

Accessor for getting the annotation text.

Implements MAKLogger::DtLgrAnnotation.

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

virtual

Accessor for getting the annotation type.

Implements MAKLogger::DtLgrAnnotation.

Member Data Documentation

DtAbsoluteTime MAKLogger::DtLgrRangeAnnotation::myEndTime

protected

DtString MAKLogger::DtLgrRangeAnnotation::myName

protected

DtAbsoluteTime MAKLogger::DtLgrRangeAnnotation::myStartTime

protected

DtString MAKLogger::DtLgrRangeAnnotation::myText

protected

DtLgrAnnotationDefinition MAKLogger::DtLgrRangeAnnotation::theDefinition

static

Annotation type definition.

---

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

• lgrRangeAnnotation.h