PositionsProvider Class Reference

Class storing and providing the position information. More...

#include <positionsprovider.h>

Inheritance diagram for PositionsProvider:

[legend]Collaboration diagram for PositionsProvider:


Public Types
enum	loadReturnMessage { OK = 0, OPEN_ERROR = 1, MISSING_FILE = 3, COUNT_ERROR = 4, INCORRECT_CONTENT = 5, OK = 0, OPEN_ERROR = 1, MISSING_FILE = 3, COUNT_ERROR = 4, INCORRECT_CONTENT = 5 }
	Information retun after a call to openFile/saveDocument/createFeatureFile.
enum	loadReturnMessage { OK = 0, OPEN_ERROR = 1, MISSING_FILE = 3, COUNT_ERROR = 4, INCORRECT_CONTENT = 5, OK = 0, OPEN_ERROR = 1, MISSING_FILE = 3, COUNT_ERROR = 4, INCORRECT_CONTENT = 5 }
	Information retun after a call to openFile/saveDocument/createFeatureFile.
Signals
void	dataReady (Array< dataType > &data, QObject *initiator)
	Signals that the data have been retrieved.
void	dataReady (Array< dataType > &data, QObject *initiator)
	Signals that the data have been retrieved.
Public Member Functions
	PositionsProvider (KURL fileUrl, double samplingRate, int width, int height, int rotation, int flip)
	Constructor.
void	requestData (long startTime, long endTime, QObject *initiator)
	Triggers the retrieve of the position information included in the time interval given by `startTime` and `endTime`.
void	retrieveAllData (QObject *initiator)
	Triggers the retrieve of all the positions.
int	loadData ()
	Loads the positions.
QString	getName () const
	Returns the name of the provider which is the position file name.
QString	getFilePath () const
	Returns the path to the position file.
void	updateVideoInformation (double videoSamplingRate, int rotation, int flip, int videoWidth, int videoHeight)
int	getNbSpots () const
	Returns the number of spots for each animal position recorded.
double	getSamplingRate () const
	Returns the sampling rate used to record the data contained in the file identified by fileUrl.
	PositionsProvider (KURL fileUrl, double samplingRate, int width, int height, int rotation, int flip)
	Constructor.
void	requestData (long startTime, long endTime, QObject *initiator)
	Triggers the retrieve of the position information included in the time interval given by `startTime` and `endTime`.
void	retrieveAllData (QObject *initiator)
	Triggers the retrieve of all the positions.
int	loadData ()
	Loads the positions.
QString	getName () const
	Returns the name of the provider which is the position file name.
QString	getFilePath () const
	Returns the path to the position file.
void	updateVideoInformation (double videoSamplingRate, int rotation, int flip, int videoWidth, int videoHeight)
int	getNbSpots () const
	Returns the number of spots for each animal position recorded.
double	getSamplingRate () const
	Returns the sampling rate used to record the data contained in the file identified by fileUrl.

Detailed Description

Class storing and providing the position information.

Author:: Lynn Hazan

Constructor & Destructor Documentation

PositionsProvider::PositionsProvider	(	KURL	fileUrl,
		double	samplingRate,
		int	width,
		int	height,
		int	rotation,
		int	flip
	)

Constructor.

Parameters:

	fileUrl	the url of the position file containing the positions.
	samplingRate	sampling rate used to record the data.
	width	video image width.
	height	video image height.
	rotation	video image rotation angle.
	flip	video image flip orientation, 0 stands for none, 1 for vertical and 2 for horizontal.

PositionsProvider::PositionsProvider	(	KURL	fileUrl,
		double	samplingRate,
		int	width,
		int	height,
		int	rotation,
		int	flip
	)

Constructor.

Parameters:

	fileUrl	the url of the position file containing the positions.
	samplingRate	sampling rate used to record the data.
	width	video image width.
	height	video image height.
	rotation	video image rotation angle.
	flip	video image flip orientation, 0 stands for none, 1 for vertical and 2 for horizontal.

Member Function Documentation

void PositionsProvider::requestData	(	long	startTime,
		long	endTime,
		QObject *	initiator
	)

Triggers the retrieve of the position information included in the time interval given by startTime and endTime.

Parameters:

	startTime	begining of the time interval from which to retrieve the data.
	endTime	end of the time interval from which to retrieve the data.
	initiator	instance requesting the data.

void PositionsProvider::retrieveAllData ( QObject * initiator )

Triggers the retrieve of all the positions.

Parameters:

initiator

instance requesting the data.

int PositionsProvider::loadData ( )

Loads the positions.

Returns:: an loadReturnMessage enum giving the load status

QString PositionsProvider::getName ( ) const [inline]

Returns the name of the provider which is the position file name.

Returns:: provider'name.

QString PositionsProvider::getFilePath ( ) const [inline]

Returns the path to the position file.

Returns:: path.

int PositionsProvider::getNbSpots ( ) const [inline]

Returns the number of spots for each animal position recorded.

It is either 1 or 2.

Returns:: number of spots.

void PositionsProvider::dataReady	(	Array< dataType > &	data,
		QObject *	initiator
	)			`[signal]`

Signals that the data have been retrieved.

Parameters:

	data	n column array containing the position of the animal. The two first columns contain the position of the first spot and the following optional pair of columns contain the position of optional spots.
	initiator	instance requesting the data.

void PositionsProvider::requestData	(	long	startTime,
		long	endTime,
		QObject *	initiator
	)

Triggers the retrieve of the position information included in the time interval given by startTime and endTime.

Parameters:

	startTime	begining of the time interval from which to retrieve the data.
	endTime	end of the time interval from which to retrieve the data.
	initiator	instance requesting the data.

void PositionsProvider::retrieveAllData ( QObject * initiator )

Triggers the retrieve of all the positions.

Parameters:

initiator

instance requesting the data.

int PositionsProvider::loadData ( )

Loads the positions.

Returns:: an loadReturnMessage enum giving the load status

QString PositionsProvider::getName ( ) const [inline]

Returns the name of the provider which is the position file name.

Returns:: provider'name.

QString PositionsProvider::getFilePath ( ) const [inline]

Returns the path to the position file.

Returns:: path.

int PositionsProvider::getNbSpots ( ) const [inline]

Returns the number of spots for each animal position recorded.

It is either 1 or 2.

Returns:: number of spots.

void PositionsProvider::dataReady	(	Array< dataType > &	data,
		QObject *	initiator
	)			`[signal]`

Signals that the data have been retrieved.

Parameters:

	data	n column array containing the position of the animal. The two first columns contain the position of the first spot and the following optional pair of columns contain the position of optional spots.
	initiator	instance requesting the data.

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

debug/src/positionsprovider.h
src/positionsprovider.h
debug/src/positionsprovider.cpp
debug/src/positionsprovider.moc.cpp
src/positionsprovider.cpp
src/positionsprovider.moc.cpp

Generated on Mon Sep 17 20:47:34 2007 for NeuroScope by

1.5.1

PositionsProvider Class Reference

Public Types

Signals

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation