Main Page | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

CBGPlayerTurn Class Reference

CBGPlayerTurn. More...

#include <Backgammon.h>

Inheritance diagram for CBGPlayerTurn:

CPiece List of all members.

Public Member Functions

 CBGPlayerTurn ()
 CBGPlayerTurn.
 CBGPlayerTurn (const CBGPlayerTurn &pt)
 CBGPlayerTurn.
 ~CBGPlayerTurn ()
 ~CBGPlayerTurn
void SetPiece (CBGPiece p)
 SetPiece.
CBGPiece GetPiece () const
 GetPiece.
void SetRoll (uint32 r1, uint32 r2)
 SetRoll.
void GetRoll (uint32 &r1, uint32 &r2)
 GetRoll.
void operator= (const CBGPlayerTurn &pt)
 operator =

Detailed Description

CBGPlayerTurn.

Description: Backgammon player turn. Contains the piece of the player that is to play and that player's roll.

Limitations: NONE


Constructor & Destructor Documentation

CBGPlayerTurn::CBGPlayerTurn  )  [inline]
 

CBGPlayerTurn.

Description: Class constrcutor

Limitations: NONE

CBGPlayerTurn::CBGPlayerTurn const CBGPlayerTurn pt  )  [inline]
 

CBGPlayerTurn.

Description: Class copy constrcutor

Parameters:
pt is the CBGPlayerTurn to copy.
Limitations: NONE

CBGPlayerTurn::~CBGPlayerTurn  )  [inline]
 

~CBGPlayerTurn

Description: Class deconstrcutor

Limitations: NONE


Member Function Documentation

CBGPiece CBGPlayerTurn::GetPiece  )  const [inline]
 

GetPiece.

Description: Gets the piece of the player turn.

Returns:
The piece contained in this class.
Limitations: NONE

void CBGPlayerTurn::GetRoll uint32 &  r1,
uint32 &  r2
[inline]
 

GetRoll.

Description: Gets the roll of the player turn.

Parameters:
r1 is the first roll value. (output)
r2 is the second roll value. (output)
Returns:
void
Limitations: NONE

void CBGPlayerTurn::operator= const CBGPlayerTurn pt  )  [inline]
 

operator =

Description: Assignment operator

Parameters:
pt is the CBGPlayerTurn to assign to this object.
Limitations: NONE

void CBGPlayerTurn::SetPiece CBGPiece  p  )  [inline]
 

SetPiece.

Description: Sets the piece of the player turn.

Parameters:
p is the piece to set.
Returns:
void
Limitations: NONE

void CBGPlayerTurn::SetRoll uint32  r1,
uint32  r2
[inline]
 

SetRoll.

Description: Sets the roll of the player turn.

Parameters:
r1 is the first roll value.
r2 is the second roll value.
Returns:
void
Limitations: NONE


The documentation for this class was generated from the following file:
Copyright (c) 2005 Matt Bruns, Pat Hammond, Kevin Markussen, Travis Service, Brain Shaver

SourceForge.net Logo