CRound Class Reference

CRound. More...

#include <Round.h>

List of all members.

Public Member Functions
	CRound (int32 id)
	CRound.
	~CRound ()
	~CRound
void	AddMatch (CMatch *match)
	AddMatch.
void	RemoveMatch (uint32 index)
	RemoveMatch.
CMatch *	GetMatch (uint32 index) const
	GetMatch.
uint32	GetMatchCount () const
	GetMatchCount.
STATE	GetRoundState () const
	GetRoundStarted.
int32	GetRoundId () const
	GetRoundId.
void	SetRoundId (int32 id)
	SetRoundId.

---

Detailed Description

CRound.

Description: A Round is a collection of matches that are run concurrently. The tournament consists of a series of rounds.

Limitations: None

---

Constructor & Destructor Documentation

CRound::CRound (  int32  id  )

CRound. Description: This constructor initalizes internal class attributes. Returns: None Limitations: None

CRound::~CRound (   )

~CRound Description: The destructor cleans up all resources allocated by the round object. Returns: None Limitations: None

---

Member Function Documentation

void CRound::AddMatch (  CMatch *  match  )

AddMatch. Description: This function adds a match to the round. Matches added will be configured and started when the round is configured and started. Parameters: match,:  The pointer to the match to add to the round. Returns: void Limitations: None

CMatch * CRound::GetMatch (  uint32  index  )  const

GetMatch. Description: This function retrieves a pointer to an attached match given the index of the match. Parameters: index,:  The zero-based index of the match. Returns: CMatch*: A pointer to the match at the given index. If The index was invalid or no match exists, NULL is returned. Limitations: None

uint32 CRound::GetMatchCount (   )  const

GetMatchCount. Description: The functions retrieves the total number of matches that have been included in the round. Returns: uint32: The number of matches. Limitations: None

int32 CRound::GetRoundId (   )  const

GetRoundId. Description: GetRoundID returns the unique round ID number that was previously associated with the round. Returns: int32: The unique round number. Limitations: The unique round ID must be first set using the SetRoundId function.

CRound::STATE CRound::GetRoundState (   )  const

GetRoundStarted. Description: GetRoundStarted checks to see if the round is currently running. The round is considered 'started' if any of the contained matches are running. Returns: bool: True if the round is running, or false otherwise. Limitations: None

void CRound::RemoveMatch (  uint32  index  )

RemoveMatch. Description: This function removes a match from the round given a match index number. Parameters: index,:  The index number of the match. The maximum index number is one less than the total number of matches added. Call GetMatchCount to find the total number of matches. Returns: void Limitations: None

void CRound::SetRoundId (  int32  id  )

SetRoundId. Description: This sets the unique round ID. Parameters: id,:  The ID to associate with the round. Returns: void Limitations: None

---

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

• Tournament/Round.h
• Tournament/Round.cpp

---

Copyright (c) 2005 Matt Bruns, Pat Hammond, Kevin Markussen, Travis Service, Brain Shaver