Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

SecurePlayLibrary::SPPlayerInterface Class Reference

#include <SPPlayerInterface.h>

Inheritance diagram for SecurePlayLibrary::SPPlayerInterface:

SecurePlayLibrary::SPPlayerClass List of all members.

Detailed Description

This is the interface for the Player class.
Author:
IT GlobalSecure Inc.
See also:
SecurePlay License Information


Public Member Functions

virtual ~SPPlayerInterface ()
virtual string getPlayerID ()=0
virtual bool isInternal ()=0
virtual bool addGame (SPGameInterface *gameObj)=0
virtual bool removeGame (SPGameInterface *gameObj)=0
virtual bool clearPlayer ()=0
virtual bool configurePlayerPID (string pid)=0

Constructor & Destructor Documentation

virtual SecurePlayLibrary::SPPlayerInterface::~SPPlayerInterface (   )  [inline, virtual]
 

Virtual Destructor.

Member Function Documentation

virtual bool SecurePlayLibrary::SPPlayerInterface::addGame (  SPGameInterface *  gameObj  )  [pure 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

Implemented in SecurePlayLibrary::SPPlayerClass.

virtual bool SecurePlayLibrary::SPPlayerInterface::clearPlayer (   )  [pure 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

Implemented in SecurePlayLibrary::SPPlayerClass.

virtual bool SecurePlayLibrary::SPPlayerInterface::configurePlayerPID (  string  pid  )  [pure 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

Implemented in SecurePlayLibrary::SPPlayerClass.

virtual string SecurePlayLibrary::SPPlayerInterface::getPlayerID (   )  [pure virtual]
 

This method returns the Player ID for the current player instance

Returns:
string - the Player ID

Implemented in SecurePlayLibrary::SPPlayerClass.

virtual bool SecurePlayLibrary::SPPlayerInterface::isInternal (   )  [pure virtual]
 

Returns the status of the internalflag

Returns:
Bool: TRUE, if successful, FALSE, if not

Implemented in SecurePlayLibrary::SPPlayerClass.

virtual bool SecurePlayLibrary::SPPlayerInterface::removeGame (  SPGameInterface *  gameObj  )  [pure 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

Implemented in SecurePlayLibrary::SPPlayerClass.

The documentation for this class was generated from the following file: 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.