FCSCompactMove Class Reference

Stores information about a move during a game. More...

#include <FCSCompactMove.h>

Inheritance diagram for FCSCompactMove:

List of all members.

Public Member Functions
	FCSCompactMove ()
	Constructor.
virtual	~FCSCompactMove ()
	Destructor.
virtual void	Copy (FCSMove *Move)
	Copy a compact move object.
unsigned char	GetSourceStack ()
	Get the source stack used in the move.
unsigned char	GetSourceFreecell ()
	Get the source freecell used in the move.
unsigned char	GetDestStack ()
	Get the destination stack used in the move.
unsigned char	GetDestFreecell ()
	Get the destination freecell used in the move.
unsigned char	GetFoundation ()
	Get the foundation used in the move.
FCSMoveTypes	GetType ()
	Get the type of the move.
unsigned char	GetNumberOfCardsInSequence ()
	Get the number of cards in a sequence that moved (from stack to stack).
unsigned char	GetNumberOfCardsFlipped ()
	Get the number of cards that were flipped during the move.
void	SetSourceStack (unsigned char StackNumber)
	Set the source stack used in the move.
void	SetSourceFreecell (unsigned char FreecellNumber)
	Set the source freecell used in the move.
void	SetDestStack (unsigned char StackNumber)
	Set the destination stack used in the move.
void	SetDestFreecell (unsigned char FreecellNumber)
	Set the destination freecell used in the move.
void	SetFoundation (unsigned char FoundationNumber)
	Set the foundation used in the move.
void	SetType (FCSMoveTypes MoveType)
	Set the type of the move.
void	SetNumberOfCardsInSequence (unsigned char NumberOfCardsInSequence)
	Set the number of cards in a sequence that moved (from stack to stack).
void	SetNumberOfCardsFlipped (unsigned char NumberOfCardsFlipped)
	Set the number of cards that were flipped during the move.
Protected Attributes
unsigned char	m_Data [4]
	data about the move

---

Detailed Description

This is the compact form of a move

Definition at line 28 of file FCSCompactMove.h.

---

Member Function Documentation

void FCSCompactMove::Copy (  FCSMove *  Move  )  [virtual]

Parameters: Move  is the compact move object to be copied Implements FCSMove. Definition at line 21 of file FCSCompactMove.cpp. References m_Data. Referenced by FCSCompactMoveStack::Copy(), and FCSCompactMoveStack::Push().

unsigned char FCSCompactMove::GetDestFreecell (   )  [virtual]

Returns: Return destination freecell of move Implements FCSMove. Definition at line 41 of file FCSCompactMove.cpp. References FCS_MOVE_DEST, and m_Data.

unsigned char FCSCompactMove::GetDestStack (   )  [virtual]

Returns: Return destination stack of move Implements FCSMove. Definition at line 36 of file FCSCompactMove.cpp. References FCS_MOVE_DEST, and m_Data.

unsigned char FCSCompactMove::GetFoundation (   )  [virtual]

Returns: Return foundation of move Implements FCSMove. Definition at line 46 of file FCSCompactMove.cpp. References FCS_MOVE_DEST, and m_Data.

unsigned char FCSCompactMove::GetNumberOfCardsFlipped (   )  [virtual]

Returns: Return number of cards flipped Implements FCSMove. Definition at line 61 of file FCSCompactMove.cpp. References FCS_MOVE_NUM_CARDS_FLIPPED, and m_Data.

unsigned char FCSCompactMove::GetNumberOfCardsInSequence (   )  [virtual]

Returns: Return the number of cards in a sequence that moved Implements FCSMove. Definition at line 56 of file FCSCompactMove.cpp. References FCS_MOVE_NUM_CARDS_IN_SEQ, and m_Data.

unsigned char FCSCompactMove::GetSourceFreecell (   )  [virtual]

Returns: Return source freecell of move Implements FCSMove. Definition at line 31 of file FCSCompactMove.cpp. References FCS_MOVE_SRC, and m_Data.

unsigned char FCSCompactMove::GetSourceStack (   )  [virtual]

Returns: Return source stack of move Implements FCSMove. Definition at line 26 of file FCSCompactMove.cpp. References FCS_MOVE_SRC, and m_Data.

FCSMoveTypes FCSCompactMove::GetType (   )  [virtual]

Returns: Return the type of move Implements FCSMove. Definition at line 51 of file FCSCompactMove.cpp. References FCS_MOVE_TYPE, and m_Data.

void FCSCompactMove::SetDestFreecell (  unsigned char  FreecellNumber  )  [virtual]

Parameters: FreecellNumber  is the number (position) of the freecell Implements FCSMove. Definition at line 81 of file FCSCompactMove.cpp. References FCS_MOVE_DEST, and m_Data.

void FCSCompactMove::SetDestStack (  unsigned char  StackNumber  )  [virtual]

Parameters: StackNumber  is the number of the destination stack Implements FCSMove. Definition at line 76 of file FCSCompactMove.cpp. References FCS_MOVE_DEST, and m_Data.

void FCSCompactMove::SetFoundation (  unsigned char  FoundationNumber  )  [virtual]

Parameters: FoundationNumber  is the number (position) of the foundation Implements FCSMove. Definition at line 86 of file FCSCompactMove.cpp. References FCS_MOVE_DEST, and m_Data.

void FCSCompactMove::SetNumberOfCardsFlipped (  unsigned char  NumberOfCardsFlipped  )  [virtual]

Parameters: NumberOfCardsFlipped  is the number of cards flipped in the move Implements FCSMove. Definition at line 101 of file FCSCompactMove.cpp. References FCS_MOVE_NUM_CARDS_FLIPPED, and m_Data.

void FCSCompactMove::SetNumberOfCardsInSequence (  unsigned char  NumberOfCardsInSequence  )  [virtual]

Parameters: NumberOfCardsInSequence  is the number of cards in a sequence that moved Implements FCSMove. Definition at line 96 of file FCSCompactMove.cpp. References FCS_MOVE_NUM_CARDS_IN_SEQ, and m_Data.

void FCSCompactMove::SetSourceFreecell (  unsigned char  FreecellNumber  )  [virtual]

Parameters: FreecellNumber  is the number (position) of the freecell Implements FCSMove. Definition at line 71 of file FCSCompactMove.cpp. References FCS_MOVE_SRC, and m_Data.

void FCSCompactMove::SetSourceStack (  unsigned char  StackNumber  )  [virtual]

Parameters: StackNumber  is the number of the source stack Implements FCSMove. Definition at line 66 of file FCSCompactMove.cpp. References FCS_MOVE_SRC, and m_Data.

void FCSCompactMove::SetType (  FCSMoveTypes  MoveType  )  [virtual]

Parameters: MoveType  is the type of move Implements FCSMove. Definition at line 91 of file FCSCompactMove.cpp. References FCS_MOVE_TYPE, and m_Data.

---

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

• FCSCompactMove.h
• FCSCompactMove.cpp

---