FCSTalonStateData Class Reference

Talon data associated with a state.

#include <FCTalonState.h>

Inheritance diagram for FCSTalonStateData:

List of all members.

Public Member Functions
	FCSTalonStateData ()
	Constructor.
virtual	~FCSTalonStateData ()
	Destructor.
virtual void	Copy (FCSTalonStateData *Data)
	Copy FCSTalonStateData object.
virtual int	Compare (const FCSTalonStateData *TalonData)
	Compare data of two talon states.
void	SetKlondikeNumberOfRedealsLeft (char RedealsLeft)
	Set the number of klondike redeals left.
char	GetKlondikeNumberOfRedealsLeft ()
	Get the number of klondike redeals left.
void	SetTalonPosition (char Position)
	Set the talon position.
char	GetTalonPosition ()
	Get the talon position.
void	SetTalonLength (char Length)
	Set the number of talons.
char	GetTalonLength ()
	Get the number of talons.
void	SetKlondikeTalonLength (char Length)
	Set the number of talons.
char	GetKlondikeTalonLength ()
	Get the number of talons.
void	SetKlondikeTalonStackPosition (char Position)
	Set the talon klondike stack position.
char	GetKlondikeTalonStackPosition ()
	Get the talon klondike stack position.
void	SetKlondikeTalonQueuePosition (char Position)
	Set the talon klondike queue position.
char	GetKlondikeTalonQueuePosition ()
	Get the talon klondike queue position.
void	KlondikeTalonRedealBare ()
	Make sure there are no more talons left to deal.
virtual void	KlondikeTalonQueueToStack ()=0
	Move a card from the talon queue to the talon stack.
virtual FCSCard *	GetKlondikeTalonTopCard ()=0
	Get the top card from the talon.
virtual FCSCard *	GetTalon (int Position)=0
	Get a talon card.
Protected Attributes
char	m_TalonParams [FC_TALON_NUMBER_OF_TALON_PARAMETERS]
	Information for talons.
char	m_KlondikeTalonLength
	Number of talon cards.
Friends
class	MD5TalonStateDataHashAlgorithm

---

Detailed Description

Definition at line 35 of file FCTalonState.h.

---

Member Function Documentation

int FCSTalonStateData::Compare (  const FCSTalonStateData *  TalonData  )  [virtual]

Returns: -1 if this talon data < TalonData, 1 if talon data > TalonData, 0 if talon data = TalonData Reimplemented in FCSDebugTalonStateData, FCSCompactTalonStateData, and FCSIndirectTalonStateData. Definition at line 47 of file FCTalonState.cpp. References FC_TALON_NUMBER_OF_TALON_PARAMETERS, m_KlondikeTalonLength, and m_TalonParams. Referenced by FCSIndirectTalonStateData::Compare(), FCSCompactTalonStateData::Compare(), and FCSDebugTalonStateData::Compare().

void FCSTalonStateData::Copy (  FCSTalonStateData *  Data  )  [virtual]

Parameters: Data  is the FCSTalonStateData to be copied Reimplemented in FCSDebugTalonStateData, FCSCompactTalonStateData, and FCSIndirectTalonStateData. Definition at line 41 of file FCTalonState.cpp. References m_KlondikeTalonLength, and m_TalonParams. Referenced by FCSIndirectTalonStateData::Copy(), FCSCompactTalonStateData::Copy(), FCSDebugTalonStateData::Copy(), and FCSTalonSolvingAlgorithm::GetCardFromKlondikeTalon().

char FCSTalonStateData::GetKlondikeNumberOfRedealsLeft (   )

Returns: The number of redeals left Definition at line 63 of file FCTalonState.cpp. References FC_TALON_PARAM_KLONDIKE_NUMBER_OF_REDEALS_LEFT, and m_TalonParams. Referenced by FCSTalonSolvingAlgorithm::GetCardFromKlondikeTalon().

char FCSTalonStateData::GetKlondikeTalonLength (   )

Returns: the number of talons Definition at line 93 of file FCTalonState.cpp. References m_KlondikeTalonLength. Referenced by FCSIndirectTalonStateWithLocations::CacheTalonStacks(), FCSCompactTalonStateWithLocations::CacheTalonStacks(), FCSDebugTalonStateWithLocations::CacheTalonStacks(), FCSTalonStateWithLocations::CheckStateValidity(), and FCSTalonSolvingAlgorithm::GetCardFromKlondikeTalon().

char FCSTalonStateData::GetKlondikeTalonQueuePosition (   )

Returns: Position of the talon klondike queue Definition at line 113 of file FCTalonState.cpp. References FC_TALON_PARAM_KLONDIKE_QUEUE_POSITION, and m_TalonParams. Referenced by FCSTalonSolvingAlgorithm::GetCardFromKlondikeTalon().

char FCSTalonStateData::GetKlondikeTalonStackPosition (   )

Returns: Position of the talon klondike stack Definition at line 103 of file FCTalonState.cpp. References FC_TALON_PARAM_KLONDIKE_STACK_POSITION, and m_TalonParams. Referenced by FCSTalonSolvingAlgorithm::GetCardFromKlondikeTalon().

virtual FCSCard* FCSTalonStateData::GetKlondikeTalonTopCard (   )  [pure virtual]

Returns: Card at the top of the talon Implemented in FCSDebugTalonStateData, FCSCompactTalonStateData, and FCSIndirectTalonStateData. Referenced by FCSTalonSolvingAlgorithm::GetCardFromKlondikeTalon().

virtual FCSCard* FCSTalonStateData::GetTalon (  int  Position  )  [pure virtual]

Parameters: Position  is the position of the talon card Returns: A pointer to the talon card Implemented in FCSDebugTalonStateData, FCSCompactTalonStateData, and FCSIndirectTalonStateData. Referenced by FCSTalonStateWithLocations::GetTalon().

char FCSTalonStateData::GetTalonLength (   )

Returns: Number of talons Definition at line 83 of file FCTalonState.cpp. References FC_TALON_PARAM_LENGTH, and m_TalonParams. Referenced by FCSTalonStateWithLocations::CheckStateValidity(), and FCSTalonStateWithLocations::CreateInitialState().

char FCSTalonStateData::GetTalonPosition (   )

Returns: Position of the talon Definition at line 73 of file FCTalonState.cpp. References FC_TALON_PARAM_POSITION, and m_TalonParams. Referenced by FCSTalonStateWithLocations::CheckStateValidity().

void FCSTalonStateData::SetKlondikeNumberOfRedealsLeft (  char  RedealsLeft  )

Parameters: RedealsLeft  is the number of redeals left Definition at line 58 of file FCTalonState.cpp. References FC_TALON_PARAM_KLONDIKE_NUMBER_OF_REDEALS_LEFT, and m_TalonParams. Referenced by FCSTalonStateWithLocations::CreateInitialState().

void FCSTalonStateData::SetKlondikeTalonLength (  char  Length  )

Parameters: Length  is the number of talons Definition at line 88 of file FCTalonState.cpp. References m_KlondikeTalonLength. Referenced by FCSTalonStateWithLocations::CreateInitialState().

void FCSTalonStateData::SetKlondikeTalonQueuePosition (  char  Position  )

Parameters: Position  to set the talon klondike queue Definition at line 108 of file FCTalonState.cpp. References FC_TALON_PARAM_KLONDIKE_QUEUE_POSITION, and m_TalonParams. Referenced by FCSTalonStateWithLocations::CreateInitialState().

void FCSTalonStateData::SetKlondikeTalonStackPosition (  char  Position  )

Parameters: Position  to set the talon klondike stack Definition at line 98 of file FCTalonState.cpp. References FC_TALON_PARAM_KLONDIKE_STACK_POSITION, and m_TalonParams. Referenced by FCSTalonStateWithLocations::CreateInitialState().

void FCSTalonStateData::SetTalonLength (  char  Length  )

Parameters: Length  is the number of talons Definition at line 78 of file FCTalonState.cpp. References FC_TALON_PARAM_LENGTH, and m_TalonParams. Referenced by FCSTalonStateWithLocations::CreateInitialState().

void FCSTalonStateData::SetTalonPosition (  char  Position  )

Parameters: Position  is the new talon position Definition at line 68 of file FCTalonState.cpp. References FC_TALON_PARAM_POSITION, and m_TalonParams. Referenced by FCSTalonStateWithLocations::CreateInitialState().

---

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

• FCTalonState.h
• FCTalonState.cpp

---