This class encapsulates all data related to one task. More...

#include <taskdata.h>

Public Member Functions
virtual	~TaskData ()
QString	toXml () const
TaskPoint *	getTaskPoint (int position)
	Find and return TaskPoint on specified position.
const TaskPoint *	getTaskPoint (int position) const
	Same as non-const getTaskPoint()
bool	fromXml (const QString &serialized)
	Tries to parse xml file.
bool	insertTaskPoint (TaskPoint *taskPoint, int position)
	Inserts new TaskPoint.
void	moveTaskPoint (int from, int to)
	Changes position of TaskPoint in sequence.
void	deleteTaskPoint (int position)
	Deletes TaskPoint on desired position.
int	size () const
	Return number of task points in this declaration.
void	setAddTaskPointButton (int position)
	Set the information about the checked add TaskPoint button.
int	getAddTaskPointButton () const
	Get the currently checked add TaskPoint button.
qreal	totalDistance () const
	Return length between all turn points in meters.
qreal	officialDistance () const
	Return the FAI official length of the track.
bool	isClosed () const
	Return true if the task is a closed course.
bool	isFaiTriangle () const
	Return true if the task is a valid FAI triangle.
qreal	distance (int i, int j) const
	Returns shortest distance from turn point i to turn point j.
qreal	distanceAzimuth (int i, int j, qreal *azimuth) const
	Returns shortest distance from turn point i to turn point j and optionally azimuths i to j and j to i.
Private Types
typedef QVector< TaskPoint * >	PointsContainer
Private Member Functions
	TaskData ()
	Only DataHistory objects can create TaskData.
qreal	distanceReduction (int i) const
	Return the distance reduction of this task point caused by the use of FAI cylinders.
float	faiTriangleDistance () const
	Calculate official distance, or -1 if the task is not a FAI triangle.
	TaskData (const TaskData &taskData)
	Only DataHistory objects can make copies of TaskData.
Private Attributes
PointsContainer	taskPoints
	Ordered sequence of TaskPoints.
int	selectedAddButton
	Selected add TaskPoint button in the gui.
Friends
class	DataHistory

Detailed Description

This class encapsulates all data related to one task.

It can be used only with DataHistory and TaskFile. These three classes together form a Memento design pattern.

Member Typedef Documentation

typedef QVector<TaskPoint*> Updraft::TaskData::PointsContainer [private]

Constructor & Destructor Documentation

Updraft::TaskData::~TaskData ( ) [virtual]

Updraft::TaskData::TaskData ( ) [inline, private]

Only DataHistory objects can create TaskData.

Updraft::TaskData::TaskData ( const TaskData & taskData ) [private]

Only DataHistory objects can make copies of TaskData.

Member Function Documentation

void Updraft::TaskData::deleteTaskPoint ( int position )

Deletes TaskPoint on desired position.

Parameters:

position position of target TaskPoint

qreal Updraft::TaskData::distance	(	int	i,
		int	j
	)		const

Returns shortest distance from turn point i to turn point j.

Doesn't do any checks on the values i,j.

Returns:: Length of shortest path from i-th to j-th turn point

qreal Updraft::TaskData::distanceAzimuth	(	int	i,
		int	j,
		qreal *	azimuth
	)		const

Returns shortest distance from turn point i to turn point j and optionally azimuths i to j and j to i.

Doesn't do any checks on the values i,j.

Parameters:

	i	Index of the first turn-point
	j	Index of the second turn-point
[out]	azimuth	azimuth from point i to j

Returns:: Length of shortest path from i-th to j-th turn point

qreal Updraft::TaskData::distanceReduction ( int i ) const [private]

Return the distance reduction of this task point caused by the use of FAI cylinders.

This reduction must be used twice for task points inside the track (that are entered and left).

float Updraft::TaskData::faiTriangleDistance ( ) const [private]

Calculate official distance, or -1 if the task is not a FAI triangle.

bool Updraft::TaskData::fromXml ( const QString & serialized )

Tries to parse xml file.

If it fails, TaskData is empty.

Parameters:

serialized string with xml file content

Returns:: True on success, otherwise false.

int Updraft::TaskData::getAddTaskPointButton ( ) const

Get the currently checked add TaskPoint button.

TaskPoint * Updraft::TaskData::getTaskPoint ( int position )

Find and return TaskPoint on specified position.

This function serves for both reading and editing of TaskPoint.

Parameters:

position position of TaskPoint in sequence

Returns:: Pointer to a task point on desired position If position is out of range, it returns NULL.

const TaskPoint * Updraft::TaskData::getTaskPoint ( int position ) const

Same as non-const getTaskPoint()

bool Updraft::TaskData::insertTaskPoint	(	TaskPoint *	taskPoint,
		int	position
	)

Inserts new TaskPoint.

All TaskPoints are deleted in ~TaskData.

Parameters:

position	target position of TaskPoint in sequence
taskPoint	The task point to be inserted If position is invalid, TaskPoint is appended to end of sequence.

bool Updraft::TaskData::isClosed ( ) const

Return true if the task is a closed course.

This function accepts a endpoints located at most 500 m from start points. This is a bit broader definition than FAI rules has, but shouldn't be too much trouble.

bool Updraft::TaskData::isFaiTriangle ( ) const

Return true if the task is a valid FAI triangle.

void Updraft::TaskData::moveTaskPoint	(	int	from,
		int	to
	)

Changes position of TaskPoint in sequence.

Parameters:

from	position of desired TaskPoint
to	destination position If "to" is invalid position, TaskPoint is moved to end of sequence.

qreal Updraft::TaskData::officialDistance ( ) const

Return the FAI official length of the track.

void Updraft::TaskData::setAddTaskPointButton ( int position )

Set the information about the checked add TaskPoint button.

Parameters:

position new position of the checked TaskPoint button

int Updraft::TaskData::size ( ) const [inline]

Return number of task points in this declaration.

qreal Updraft::TaskData::totalDistance ( ) const

Return length between all turn points in meters.

QString Updraft::TaskData::toXml ( ) const

Returns:: Xml text representation of TaskData

Friends And Related Function Documentation

friend class DataHistory [friend]

Member Data Documentation

int Updraft::TaskData::selectedAddButton [private]

Selected add TaskPoint button in the gui.

If it is -1, it means that no button is selected

PointsContainer Updraft::TaskData::taskPoints [private]

Ordered sequence of TaskPoints.

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

/home/cube/development/c/updraft/Updraft/src/plugins/taskdecl/taskdata.h
/home/cube/development/c/updraft/Updraft/src/plugins/taskdecl/taskdata.cpp

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation