AFreecellGameBoard.h File Reference

This file contains the AFreecellGameBoard class and all the game supporting data. More...

Go to the source code of this file.

Classes
struct	BoardName
	Structure to link a game name string with its enum value. More...
class	AFreecellGameBoard
	The abstract, parent class for all game board generation. More...
Defines
#define	GAME_NAME_LENGTH   32
	Maximum string length of a game.
#define	MakeCard(value, suit)   (((suit&0x03)<<4)+(value))
	Convert card values into a char.
#define	GetSuit(card)   ((card >> 4) & 0x03)
	Get the suit of a card.
#define	GetValue(card)   (card&0x0f)
	Get the face value of a card.
Typedefs
typedef BoardName	BoardName
	Structure to link a game name string with its enum value.
Enumerations
enum	BoardID {   BOARD_ID_NONE = -1, BOARD_ID_BAKERS_DOZEN, BOARD_ID_BAKERS_GAME, BOARD_ID_BELEAGUERED_CASTLE,   BOARD_ID_CITADEL, BOARD_ID_CRUEL, BOARD_ID_DER_KATZENSCHWANZ, BOARD_ID_DIE_SCHLANGE,   BOARD_ID_EIGHT_OFF, BOARD_ID_FAN, BOARD_ID_FORECELL, BOARD_ID_FREECELL,   BOARD_ID_GNOME_FREECELL, BOARD_ID_GOOD_MEASURE, BOARD_ID_GYPSY, BOARD_ID_KINGS_ONLY_BAKERS_GAME,   BOARD_ID_KLONDIKE, BOARD_ID_MICROSOFT_FREECELL, BOARD_ID_PYSOL_BAKERS_GAME, BOARD_ID_PYSOL_EIGHT_OFF,   BOARD_ID_PYSOL_FREECELL, BOARD_ID_PYSOL_KINGS_ONLY_BAKERS_GAME, BOARD_ID_PYSOL_RELAXED_FREECELL, BOARD_ID_PYSOL_RELAXED_SEAHAVEN_TOWERS,   BOARD_ID_PYSOL_SEAHAVEN_TOWERS, BOARD_ID_PYSOL_BELEAGUERED_CASTLE, BOARD_ID_PYSOL_KLONDIKE, BOARD_ID_PYSOL_STREETS_AND_ALLEYS,   BOARD_ID_RELAXED_FREECELL, BOARD_ID_RELAXED_SEAHAVEN_TOWERS, BOARD_ID_SEAHAVEN_TOWERS, BOARD_ID_SIMPLE_SIMON,   BOARD_ID_SMALL_HARP, BOARD_ID_STREETS_AND_ALLEYS, BOARD_ID_WHITEHEAD, BOARD_ID_YUKON }
	This is all the games that are currently supported.
Functions
AFreecellGameBoard *	CreateAFreecellGameBoard (char *GameName, bool Display10AsT)
	Create a game board generator object.

---

Detailed Description

Author:

Michael Mann

Version:

1.0

Date:

September 2002

Definition in file AFreecellGameBoard.h.

---

Function Documentation

AFreecellGameBoard* CreateAFreecellGameBoard (  char *  GameName, bool  Display10AsT )

Parameters: GameName  is the string name of the game to be created Display10AsT  determines whether or not to display a 10 as "10" or "T" Returns: A pointer to the newly created object Definition at line 233 of file AFreecellGameBoard.cpp. References GetBoardID(). Referenced by main(), and TestEachGame().

---