Annotation Class Reference

This class allows to load tracking annotation file. More...

Inheritance diagram for Annotation:

Public Slots
void	clear ()
	Clear the object.
void	write (int index, const QString &text)
	Adds an annotation to the annotation QHash.
void	read (int index)
	Reads an annotation from the annotation QHash.
void	find (const QString &expression)
	Finds the index of all the annotation with expression inside their text.
int	next ()
	Returns the next element of the findIndexes list of annotations that contains the expression to find.
int	prev ()
	Returns the previous element of the findIndexes list of annotations that contains the expression to find.

Signals
void	annotationText (const QString &text)
	Emitted when a new annotation is read.

Public Member Functions
	Annotation (QWidget *parent=nullptr)
	Constructs the annotation object from a file path.
	Annotation (const QString &annotationFile)
	Constructs the annotation object from a file path.
	Annotation (const Annotation &T)=delete
Annotation &	operator= (const Annotation &T)=delete
Annotation &	operator= (Annotation &&T)=delete
	Annotation (Annotation &&T)=delete
bool	setPath (const QString &annotationFile)
	Set the path for the annotation.

Public Attributes
bool	isActive

Private Member Functions
void	writeToFile ()
	Writes all the annotation to a file.

Private Attributes
QFile *	annotationFile
QHash< int, QString > *	annotations
QList< int >	findIndexes
qsizetype	findIndex

Detailed Description

This class allows to load tracking annotation file.

Author

Benjamin Gallois

Version

Revision

5

Contact: benja.nosp@m.min..nosp@m.gallo.nosp@m.is@f.nosp@m.asttr.nosp@m.ack..nosp@m.sh

Constructor & Destructor Documentation

Annotation()

Annotation::Annotation

(

const QString &

filePath

)

Constructs the annotation object from a file path.

Parameters

[in]

filePath

Path to the tracking folder.

Member Function Documentation

annotationText

void Annotation::annotationText ( const QString & text )

signal

Emitted when a new annotation is read.

Parameters

text	Text of the requested annotation.

find

void Annotation::find ( const QString & expression )

slot

Finds the index of all the annotation with expression inside their text.

Parameters

[in]

expression

Expression to find, case sensitive.

read

void Annotation::read ( int index )

slot

Reads an annotation from the annotation QHash.

Parameters

[in]

index

Image index.

setPath()

bool Annotation::setPath

(

const QString &

filePath

)

Set the path for the annotation.

Parameters

[in]

filePath

Path to the tracking folder.

write

void Annotation::write ( int index, const QString & text )

slot

Adds an annotation to the annotation QHash.

Parameters

[in]	index	Image index.
[in]	text	Annotation text.

---

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

• src/annotation.h
• src/annotation.cpp