SecurePlayLibrary::SPPlayerClass Class Reference

#include <SPPlayerClass.h>

Inheritance diagram for SecurePlayLibrary::SPPlayerClass:

List of all members.

---

Detailed Description

A player or participant in a game.

Author:

IT GlobalSecure

See also:

SecurePlay License Information

Public Member Functions
	SPPlayerClass ()
	~SPPlayerClass ()
	SPPlayerClass (string playerID, bool internalflag)
	SPPlayerClass (string playerID)
string	getPlayerID ()
bool	isInternal ()
bool	addGame (SPGameInterface *gameObj)
bool	removeGame (SPGameInterface *gameObj)
bool	clearPlayer ()
void	logerror ()
bool	configurePlayerPID (string pid)
vector< string >	getGameIDList ()
Public Attributes
const string	extendedversion
const string	releaseversion
Private Member Functions
	SPPlayerClass (const SPPlayerClass &p)
	operator= (const SPPlayerClass &p)
Private Attributes
string	playerID
bool	internalflag
map< string, SPGameInterface * >	prgameList

---

Constructor & Destructor Documentation

SecurePlayLibrary::SPPlayerClass::SPPlayerClass (  const SPPlayerClass &  p  )  [inline, private]

Private Copy Constructor that protects this class from being copied.

SPPlayerClass::SPPlayerClass (   )

Default Constructor.

SPPlayerClass::~SPPlayerClass (   )

Default Destructor

SPPlayerClass::SPPlayerClass (  string  playerID, bool  internalflag )

Constructs an overloaded instance of SPPlayerClass. Parameters: playerID  string - player id internalflag  bool - internal flag

SPPlayerClass::SPPlayerClass (  string  playerID  )

Constructs an overloaded instance of SPPlayerClass. Parameters: playerID  string - player id

---

Member Function Documentation

bool SPPlayerClass::addGame (  SPGameInterface *  gameObj  )  [virtual]

This method adds a game association to a player object. It will return TRUE if the game is newly added or already associated with the Player. This method should not be called directly, it should be called through the Game instance. Parameters: gameObj  SPGameInterface* - game object handler, the game to be added Returns: Boolean: TRUE, if successful, FALSE, if not Implements SecurePlayLibrary::SPPlayerInterface.

bool SPPlayerClass::clearPlayer (   )  [virtual]

This function safely removes a player's association with all games - it can only be done if this will not damage any ongoing games. If any associations cannot be closed, it will return FALSE Returns: Bool: TRUE, if successful, FALSE, if not Implements SecurePlayLibrary::SPPlayerInterface.

bool SPPlayerClass::configurePlayerPID (  string  pid  )  [virtual]

This method sets the Player ID for a previously created Player object to associate it with a SecurePlay library. Parameters: pid  string - id of the player to be configured Returns: Bool: TRUE, if successful, FALSE, if not Implements SecurePlayLibrary::SPPlayerInterface.

vector< string > SPPlayerClass::getGameIDList (   )

Getter function that returns the property: gameIDList Returns: gameIDList - String[]

string SPPlayerClass::getPlayerID (   )  [virtual]

This method returns the Player ID for the current player instance Returns: string - the Player ID Implements SecurePlayLibrary::SPPlayerInterface.

bool SPPlayerClass::isInternal (   )  [virtual]

Returns the status of the internalflag Returns: Bool: TRUE, if successful, FALSE, if not Implements SecurePlayLibrary::SPPlayerInterface.

void SPPlayerClass::logerror (   )

This is a placeholder for future logging support.

SecurePlayLibrary::SPPlayerClass::operator= (  const SPPlayerClass &  p  )  [inline, private]

Private = operator that protects this class from being copied.

bool SPPlayerClass::removeGame (  SPGameInterface *  gameObj  )  [virtual]

This method removes an assocation between a Player and a Game Instance. This method should not be called directly, it should be called through the game instance. Parameters: gameObj  SPGameInterface* - game object handler, the game to be removed Returns: Boolean: TRUE, if successful, FALSE, if not Implements SecurePlayLibrary::SPPlayerInterface.

---

Member Data Documentation

const string SecurePlayLibrary::SPPlayerClass::extendedversion

Developer extended version.

bool SecurePlayLibrary::SPPlayerClass::internalflag [private]

This flag is used to track the internal players. NOTE: This property will not be supported in future versions.

string SecurePlayLibrary::SPPlayerClass::playerID [private]

This property is the unique identifier for the player.

map<string, SPGameInterface*> SecurePlayLibrary::SPPlayerClass::prgameList [private]

This associative array provides an association with gameID and game instance objects.

const string SecurePlayLibrary::SPPlayerClass::releaseversion

IT GlobalSecure release version.

---

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

• SPPlayerClass.h
• SPPlayerClass.cpp

2006 Copyright Filed by IT GlobalSecure, Inc. All Rights Reserved. Not to be used without authorization by Author. SecurePlay, IT GlobalSecure, and IT Armor are registered trademarks by IT GlobalSecure, Inc. Software protected by software license, and one or more the following U.S. and International patent numbers: U.S. Patent 6,030,288, U.S. Patent 6,165,072, European Patent Office EP1016049A1,and World Intellectual Property Organization WO9912135C1 and additional filings worldwide.