FCSDebugMove Class Reference

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

#include <FCSDebugMove.h>

Inheritance diagram for FCSDebugMove:

List of all members.

Public Member Functions
	FCSDebugMove ()
	Constructor.
virtual	~FCSDebugMove ()
	Destructor.
virtual void	Copy (FCSMove *Move)
	Copy a debug 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.
Private Attributes
unsigned char	m_Foundation
	The index of the foundation, in case there are more than one decks.
unsigned char	m_NumberOfCardsInSequence
	Number of cards in a sequence that moved (from stack to stack).
unsigned char	m_NumberOfCardsFlipped
	Number of cards that were flipped during the move.
unsigned char	m_SourceFreecell
	Source freecell of the move.
unsigned char	m_DestinationFreecell
	Destination freecell of the move.
unsigned char	m_SourceStack
	Source stack of the move.
unsigned char	m_DestinationStack
	Destination stack of the move.
FCSMoveTypes	m_Type
	The type of the move.

---

Detailed Description

This is the debug form of a move

Definition at line 17 of file FCSDebugMove.h.

---

Member Function Documentation

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

Parameters: Move  is the debug move object to be copied Implements FCSMove. Definition at line 28 of file FCSDebugMove.cpp. References FCSMove::GetDestFreecell(), FCSMove::GetDestStack(), FCSMove::GetFoundation(), FCSMove::GetNumberOfCardsFlipped(), FCSMove::GetNumberOfCardsInSequence(), FCSMove::GetSourceFreecell(), FCSMove::GetSourceStack(), FCSMove::GetType(), m_DestinationFreecell, m_DestinationStack, m_Foundation, m_NumberOfCardsFlipped, m_NumberOfCardsInSequence, m_SourceFreecell, m_SourceStack, and m_Type. Referenced by FCSDebugMoveStack::Copy(), and FCSDebugMoveStack::Push().

unsigned char FCSDebugMove::GetDestFreecell (   )  [virtual]

Returns: Return destination freecell of move Implements FCSMove. Definition at line 55 of file FCSDebugMove.cpp. References m_DestinationFreecell.

unsigned char FCSDebugMove::GetDestStack (   )  [virtual]

Returns: Return destination stack of move Implements FCSMove. Definition at line 50 of file FCSDebugMove.cpp. References m_DestinationStack.

unsigned char FCSDebugMove::GetFoundation (   )  [virtual]

Returns: Return foundation of move Implements FCSMove. Definition at line 60 of file FCSDebugMove.cpp. References m_Foundation.

unsigned char FCSDebugMove::GetNumberOfCardsFlipped (   )  [virtual]

Returns: Return number of cards flipped Implements FCSMove. Definition at line 75 of file FCSDebugMove.cpp. References m_NumberOfCardsFlipped.

unsigned char FCSDebugMove::GetNumberOfCardsInSequence (   )  [virtual]

Returns: Return the number of cards in a sequence that moved Implements FCSMove. Definition at line 70 of file FCSDebugMove.cpp. References m_NumberOfCardsInSequence.

unsigned char FCSDebugMove::GetSourceFreecell (   )  [virtual]

Returns: Return source freecell of move Implements FCSMove. Definition at line 45 of file FCSDebugMove.cpp. References m_SourceFreecell.

unsigned char FCSDebugMove::GetSourceStack (   )  [virtual]

Returns: Return source stack of move Implements FCSMove. Definition at line 40 of file FCSDebugMove.cpp. References m_SourceStack.

FCSMoveTypes FCSDebugMove::GetType (   )  [virtual]

Returns: Return the type of move Implements FCSMove. Definition at line 65 of file FCSDebugMove.cpp. References m_Type.

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

Parameters: FreecellNumber  is the number (position) of the freecell Implements FCSMove. Definition at line 95 of file FCSDebugMove.cpp. References m_DestinationFreecell.

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

Parameters: StackNumber  is the number of the destination stack Implements FCSMove. Definition at line 90 of file FCSDebugMove.cpp. References m_DestinationStack.

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

Parameters: FoundationNumber  is the number (position) of the foundation Implements FCSMove. Definition at line 100 of file FCSDebugMove.cpp. References m_Foundation.

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

Parameters: NumberOfCardsFlipped  is the number of cards flipped in the move Implements FCSMove. Definition at line 115 of file FCSDebugMove.cpp. References m_NumberOfCardsFlipped.

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

Parameters: NumberOfCardsInSequence  is the number of cards in a sequence that moved Implements FCSMove. Definition at line 110 of file FCSDebugMove.cpp. References m_NumberOfCardsInSequence.

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

Parameters: FreecellNumber  is the number (position) of the freecell Implements FCSMove. Definition at line 85 of file FCSDebugMove.cpp. References m_SourceFreecell.

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

Parameters: StackNumber  is the number of the source stack Implements FCSMove. Definition at line 80 of file FCSDebugMove.cpp. References m_SourceStack.

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

Parameters: MoveType  is the type of move Implements FCSMove. Definition at line 105 of file FCSDebugMove.cpp. References m_Type.

---

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

• FCSDebugMove.h
• FCSDebugMove.cpp

---