TurnInformation Class Reference

Turn information class. More...

#include <turninformation.h>

List of all members.

Public Member Functions
	TurnInformation (int turnId, bool white)
	Turn information object.
int	getTurnId () const
int	getDuration () const
	Duration of turn.
int	getPaused () const
	Duration of pauses during this turn.
int	getTimeAfter () const
	Time available for this player after this turn.
bool	isWhiteTurn () const
void	addTime (int msecs)
void	addPause (int msecs)
void	turnReady (int msecs)
	Mark turn ready.
Protected Attributes
int	turnId_
int	duration_
	id of turn
int	paused_
	duration of turn in msecs
int	timeAfter_
	duration of pauses in msecs
bool	turnReady_
	time available after this turn in msecs
bool	white_
	turn is ready and locked

---

Detailed Description

Turn information class.

Author:

Arto Hyvättinen

Date:

2010-08-13

Store information about one turn of player

Definition at line 34 of file turninformation.h.

---

Constructor & Destructor Documentation

TurnInformation::TurnInformation	(	int	turnId,
		bool	white
	)

Turn information object.

Parameters:

	turnId	Id of turn of player
	white	true if turn on white, false id black

Definition at line 24 of file turninformation.cpp.

---

Member Function Documentation

void TurnInformation::addPause

(

int

msecs

)

Definition at line 40 of file turninformation.cpp.

void TurnInformation::addTime

(

int

msecs

)

Definition at line 34 of file turninformation.cpp.

int TurnInformation::getDuration

(

)

const [inline]

Duration of turn.

Returns:

Duration of turn in msecs

Definition at line 47 of file turninformation.h.

int TurnInformation::getPaused

(

)

const [inline]

Duration of pauses during this turn.

Returns:

Duration of pauses in msecs

Definition at line 51 of file turninformation.h.

int TurnInformation::getTimeAfter

(

)

const

Time available for this player after this turn.

Returns:

Time available in msecs

Definition at line 53 of file turninformation.cpp.

int TurnInformation::getTurnId

(

)

const [inline]

Definition at line 43 of file turninformation.h.

bool TurnInformation::isWhiteTurn

(

)

const [inline]

Definition at line 56 of file turninformation.h.

void TurnInformation::turnReady

(

int

msecs

)

Mark turn ready.

Turn will be locked to chances.

Parameters:

msecs

Time available after this turn in msecs

Definition at line 47 of file turninformation.cpp.

---

Member Data Documentation

int TurnInformation::duration_ [protected]

id of turn

Definition at line 72 of file turninformation.h.

int TurnInformation::paused_ [protected]

duration of turn in msecs

Definition at line 73 of file turninformation.h.

int TurnInformation::timeAfter_ [protected]

duration of pauses in msecs

Definition at line 74 of file turninformation.h.

int TurnInformation::turnId_ [protected]

Definition at line 71 of file turninformation.h.

bool TurnInformation::turnReady_ [protected]

time available after this turn in msecs

Definition at line 75 of file turninformation.h.

bool TurnInformation::white_ [protected]

turn is ready and locked

Definition at line 76 of file turninformation.h.

---

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

• /holvi/arto/ohjelmointi/ChessClock/chessclock/classes/turninformation.h
• /holvi/arto/ohjelmointi/ChessClock/chessclock/classes/turninformation.cpp