Manages annotations. More...

Collaboration diagram for MAKLogger::DtLgrAnnotationManager:

Public Types
typedef std::list < DtLgrAnnotation * >	AnnotationList

Public Member Functions
	DtLgrAnnotationManager ()

virtual	~DtLgrAnnotationManager ()

virtual void	setAllowChanges (bool allowed)
	Control whether changes may be made to the annotations. More...

virtual bool	allowChanges () const
	Get whether changes may be made to the annotations. More...

virtual void	addAnnotation (DtLgrAnnotation *annotation)
	Adds an annotation to the manager. More...

virtual void	removeAnnotation (DtLgrAnnotation *annotation)
	Removes the given annotation. The annotation is deallocated. More...

virtual void	clearAnnotations ()
	Remove all annotations. All annotation are deallocated. More...

virtual void	deleteTimeRange (const DtAbsoluteTime &start, const DtAbsoluteTime &end)
	Delete all annotations in the range, or clip those who are partially in the range. More...

virtual void	moveTimeRange (const DtAbsoluteTime &start, const DtAbsoluteTime &end, const DtRelativeTime &offset)
	Move all annotations in the range by the offset. More...

virtual void	annotationsStartingAt (DtAbsoluteTime, AnnotationList &output)
	Get a list of all annotations starting at the given time. More...

virtual void	annotationsEndingAt (DtAbsoluteTime, AnnotationList &output)
	Get a list of all annotations ending at a given time. More...

virtual void	annotationsDuring (DtAbsoluteTime, AnnotationList &output)
	Get a list of all annotations which have the given time between their starting and ending points. More...

virtual const AnnotationList &	annotations ()
	Get a list of all annotations. More...

virtual void	annotationChanged (DtLgrAnnotation *annotation)
	Called by annotation when it is modified. More...

virtual void	annotationsChanged ()
	Called by when annotations in the manager changed. More...

virtual bool	isAnnotationStateSaved () const
	Get whether the annotation state is currently saved. More...

virtual void	saveAnnotationState (DtEnvironment environment)
	Save the annotations to the provided environment. More...

virtual void	setAnnotationState (const DtEnvironment environment, bool clear=true)
	Reads the annotations from the environment. More...

virtual void	addView (DtLgrAnnotationBaseView *view)
	Add a view to be notified of changes. More...

virtual void	removeView (DtLgrAnnotationBaseView *view)
	Remove a view from the model which stops it from receiving notification of changes. More...

virtual void	annotationsSaved ()
	Called when annotations have been saved. More...

virtual bool	autoLoad () const
	Annotations are automatically loaded when a lgr file is opened. More...

virtual void	setAutoLoad (bool autoLoad)
	Set whether annotations are automatically loaded when a lgr file is opened. More...

virtual bool	empty () const
	Whether the are no annotations. More...

Protected Types
typedef std::set < DtLgrAnnotationBaseView * >	ViewSet
	List type of views. More...

Protected Attributes
AnnotationList	myAnnotations
	The managers list of annotations. More...

bool	myAnnotationStateSaved
	Stores whether the state is considered 'saved'. More...

bool	myUnlockedState

ViewSet	myViews
	A list of views the model will notify of changes. More...

bool	myAutoLoadFlag

Private Member Functions
	DtLgrAnnotationManager (const DtLgrAnnotationManager &)
	Not Implemented. More...

DtLgrAnnotationManager &	operator= (const DtLgrAnnotationManager &)
	Not Implemented. More...

Detailed Description

Manages annotations.

Member Typedef Documentation

typedef std::list<DtLgrAnnotation*> MAKLogger::DtLgrAnnotationManager::AnnotationList

typedef std::set<DtLgrAnnotationBaseView*> MAKLogger::DtLgrAnnotationManager::ViewSet

protected

List type of views.

Constructor & Destructor Documentation

MAKLogger::DtLgrAnnotationManager::DtLgrAnnotationManager ( )

virtual MAKLogger::DtLgrAnnotationManager::~DtLgrAnnotationManager ( )

virtual

MAKLogger::DtLgrAnnotationManager::DtLgrAnnotationManager ( const DtLgrAnnotationManager & )

private

Not Implemented.

Member Function Documentation

virtual void MAKLogger::DtLgrAnnotationManager::addAnnotation ( DtLgrAnnotation * annotation )

virtual

Adds an annotation to the manager.

The manager assumes ownership of the annotation.

virtual void MAKLogger::DtLgrAnnotationManager::addView ( DtLgrAnnotationBaseView * view )

virtual

Add a view to be notified of changes.

All views must be removed before being deallocated.

virtual bool MAKLogger::DtLgrAnnotationManager::allowChanges ( ) const

virtual

Get whether changes may be made to the annotations.

virtual void MAKLogger::DtLgrAnnotationManager::annotationChanged ( DtLgrAnnotation * annotation )

virtual

Called by annotation when it is modified.

This function is used to track annotation changes.

virtual const AnnotationList& MAKLogger::DtLgrAnnotationManager::annotations ( )

virtual

Get a list of all annotations.

virtual void MAKLogger::DtLgrAnnotationManager::annotationsChanged ( )

virtual

Called by when annotations in the manager changed.

virtual void MAKLogger::DtLgrAnnotationManager::annotationsDuring	(	DtAbsoluteTime	,
		AnnotationList &	output
	)

virtual

Get a list of all annotations which have the given time between their starting and ending points.

virtual void MAKLogger::DtLgrAnnotationManager::annotationsEndingAt	(	DtAbsoluteTime	,
		AnnotationList &	output
	)

virtual

Get a list of all annotations ending at a given time.

virtual void MAKLogger::DtLgrAnnotationManager::annotationsSaved ( )

virtual

Called when annotations have been saved.

virtual void MAKLogger::DtLgrAnnotationManager::annotationsStartingAt	(	DtAbsoluteTime	,
		AnnotationList &	output
	)

virtual

Get a list of all annotations starting at the given time.

virtual bool MAKLogger::DtLgrAnnotationManager::autoLoad ( ) const

virtual

Annotations are automatically loaded when a lgr file is opened.

virtual void MAKLogger::DtLgrAnnotationManager::clearAnnotations ( )

virtual

Remove all annotations. All annotation are deallocated.

virtual void MAKLogger::DtLgrAnnotationManager::deleteTimeRange	(	const DtAbsoluteTime &	start,
		const DtAbsoluteTime &	end
	)

virtual

Delete all annotations in the range, or clip those who are partially in the range.

virtual bool MAKLogger::DtLgrAnnotationManager::empty ( ) const

virtual

Whether the are no annotations.

virtual bool MAKLogger::DtLgrAnnotationManager::isAnnotationStateSaved ( ) const

virtual

Get whether the annotation state is currently saved.

virtual void MAKLogger::DtLgrAnnotationManager::moveTimeRange	(	const DtAbsoluteTime &	start,
		const DtAbsoluteTime &	end,
		const DtRelativeTime &	offset
	)

virtual

Move all annotations in the range by the offset.

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

private

Not Implemented.

virtual void MAKLogger::DtLgrAnnotationManager::removeAnnotation ( DtLgrAnnotation * annotation )

virtual

Removes the given annotation. The annotation is deallocated.

virtual void MAKLogger::DtLgrAnnotationManager::removeView ( DtLgrAnnotationBaseView * view )

virtual

Remove a view from the model which stops it from receiving notification of changes.

virtual void MAKLogger::DtLgrAnnotationManager::saveAnnotationState ( DtEnvironment environment )

virtual

Save the annotations to the provided environment.

virtual void MAKLogger::DtLgrAnnotationManager::setAllowChanges ( bool allowed )

virtual

Control whether changes may be made to the annotations.

virtual void MAKLogger::DtLgrAnnotationManager::setAnnotationState	(	const DtEnvironment	environment,
		bool	clear = `true`
	)

virtual

Reads the annotations from the environment.

Only the root's child annotation objects in the environment will be used. Existing annotations are deleted unless clear is set to false.

Parameters

Input
clear	Controls whether the existing annotations are cleared first.

virtual void MAKLogger::DtLgrAnnotationManager::setAutoLoad ( bool autoLoad )

virtual

Set whether annotations are automatically loaded when a lgr file is opened.

Member Data Documentation

AnnotationList MAKLogger::DtLgrAnnotationManager::myAnnotations

protected

The managers list of annotations.

bool MAKLogger::DtLgrAnnotationManager::myAnnotationStateSaved

protected

Stores whether the state is considered 'saved'.

Initially the state is not saved. Upon opening a file the state is considered saved until a changes is made. Once a change is made the state will be false until the state is re-saved.

bool MAKLogger::DtLgrAnnotationManager::myAutoLoadFlag

protected

bool MAKLogger::DtLgrAnnotationManager::myUnlockedState

protected

ViewSet MAKLogger::DtLgrAnnotationManager::myViews

protected

A list of views the model will notify of changes.

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

lgrAnnotationManager.h

Public Types

Public Member Functions

Protected Types

Protected Attributes

Private Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation