X-Git-Url: https://vcs.maemo.org/git/?a=blobdiff_plain;f=www%2Fhtml%2Fclass_turn_information.html;fp=www%2Fhtml%2Fclass_turn_information.html;h=36e54376763b3305f36f817e52bba31f7081c475;hb=0488ea4e4628cf9e931a6e35540123fb854ff189;hp=0000000000000000000000000000000000000000;hpb=ea1e07a863e352f789550f5969529a3891517696;p=chessclock diff --git a/www/html/class_turn_information.html b/www/html/class_turn_information.html new file mode 100644 index 0000000..36e5437 --- /dev/null +++ b/www/html/class_turn_information.html @@ -0,0 +1,426 @@ + + + + + +Chess Clock: TurnInformation Class Reference + + + + + + + + + +
+

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 ()
int getDuration ()
 Duration of turn.
int getPaused ()
 Duration of pauses during this turn.
int getTimeAfter ()
 Time available for this player after this turn.
bool isWhiteTurn ()
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 ( )  [inline]
+
+
+ +

Duration of turn.

+
Returns:
Duration of turn in msecs
+ +

Definition at line 47 of file turninformation.h.

+ +
+
+ +
+
+ + + + + + + + +
int TurnInformation::getPaused ( )  [inline]
+
+
+ +

Duration of pauses during this turn.

+
Returns:
Duration of pauses in msecs
+ +

Definition at line 51 of file turninformation.h.

+ +
+
+ +
+
+ + + + + + + + +
int TurnInformation::getTimeAfter ( ) 
+
+
+ +

Time available for this player after this turn.

+
Returns:
Time available in msecs
+ +

Definition at line 52 of file turninformation.cpp.

+ +
+
+ +
+
+ + + + + + + + +
int TurnInformation::getTurnId ( )  [inline]
+
+
+ +

Definition at line 43 of file turninformation.h.

+ +
+
+ +
+
+ + + + + + + + +
bool TurnInformation::isWhiteTurn ( )  [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 46 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: +
+ +
+ All Classes Files Functions Variables
+ + +
+ +
+ +
Generated on Fri Aug 13 22:27:27 2010 for Chess Clock by  + +doxygen 1.6.3
+ +