SecurePlayLibrary::SPRootTransactionClass Class Reference

#include <SPRootTransactionClass.h>

Inheritance diagram for SecurePlayLibrary::SPRootTransactionClass:

List of all members.

---

Detailed Description

This abstract class provides the common services for all game and transaction types.

Author:

IT GlobalSecure Inc.

See also:

SecurePlay License Information

Public Member Functions
	SPRootTransactionClass ()
	~SPRootTransactionClass ()
string	getGameID ()
string	getTransactionID ()
string	getMaster ()
vector< string >	getPlayerIDList ()
bool	APIAddListener (SPEventInterface *gameobj)
bool	APIRemoveListener (SPEventInterface *gameobj)
vector< SPEventInterface * >	APIGetListeners ()
bool	APIClearListeners ()
int	APIGetListenerCount ()
void	SPnotify (string eventdescription, vector< string > args)
bool	isPlayerIncluded (string pid)
Public Attributes
const string	extendedversion
const string	releaseversion
Protected Member Functions
	SPRootTransactionClass (const SPRootTransactionClass &p)
	operator= (const SPRootTransactionClass &p)
Protected Attributes
string	gameID
vector< string >	playerIDList
string	transactionID
string	master
vector< SPEventInterface * >	EventListenerList

---

Constructor & Destructor Documentation

SecurePlayLibrary::SPRootTransactionClass::SPRootTransactionClass (  const SPRootTransactionClass &  p  )  [inline, protected]

Private Copy Constructor that protects this class from being copied.

SPRootTransactionClass::SPRootTransactionClass (   )

Default Constructor.

SPRootTransactionClass::~SPRootTransactionClass (   )

Default Destructor

---

Member Function Documentation

bool SPRootTransactionClass::APIAddListener (  SPEventInterface *  gameobj  )

This method adds a listener object for events Parameters: gameobj  SPEventInterface* - an object that supports SPEventInterface that will be added to the listener list. Returns: bool: TRUE, if successful, FALSE, if not

bool SPRootTransactionClass::APIClearListeners (   )

This method clears the listener objects for events Returns: bool: TRUE, if successful, FALSE, if not

int SPRootTransactionClass::APIGetListenerCount (   )

This method returns the number of listener objects for events Returns: int - returns the number of listeners

vector< SPEventInterface * > SPRootTransactionClass::APIGetListeners (   )

This method returns a list of listener objects for events Returns: vector<SPEventInterface*> - gets the array of listener objects

bool SPRootTransactionClass::APIRemoveListener (  SPEventInterface *  gameobj  )

This method removes a listener object for events Parameters: gameobj  SPEventInterface* - an object that supports SPEventInterface that will be removed from listener list. Returns: bool: TRUE, if successful, FALSE, if not

string SPRootTransactionClass::getGameID (   )

Gets the game id associated with the transaction or game. Returns: string - game id Reimplemented in SecurePlayLibrary::SPAbstractTransactionClass, and SecurePlayLibrary::SPGameClass.

string SPRootTransactionClass::getMaster (   )

Gets the master of the transaction or game Returns: string - returns the id of the master Reimplemented in SecurePlayLibrary::SPAbstractTransactionClass, and SecurePlayLibrary::SPGameClass.

vector< string > SPRootTransactionClass::getPlayerIDList (   )

Gets the player id list of the players associated with the transaction or the game. Returns: vector<string> - players associated with a game or transaction in a string array. Reimplemented in SecurePlayLibrary::SPAbstractTransactionClass, and SecurePlayLibrary::SPGameClass.

string SPRootTransactionClass::getTransactionID (   )

Gets the transaction id. Returns: string - the transaction id Reimplemented in SecurePlayLibrary::SPAbstractTransactionClass, and SecurePlayLibrary::SPGameClass.

bool SPRootTransactionClass::isPlayerIncluded (  string  pid  )

This method tests to determine if a specified player is a transaction participant. Parameters: pid  string - the player id in question Returns: bool - TRUE, if player is a transaction participant, FALSE, if not.

SecurePlayLibrary::SPRootTransactionClass::operator= (  const SPRootTransactionClass &  p  )  [inline, protected]

Private = operator that protects this class from being copied.

void SPRootTransactionClass::SPnotify (  string  eventdescription, vector< string >  args )

This method notifies the Listeners of events Parameters: eventdescription  vector<string>  - arguments Reimplemented in SecurePlayLibrary::SPAbstractTransactionClass, and SecurePlayLibrary::SPGameClass.

---

Member Data Documentation

vector<SPEventInterface*> SecurePlayLibrary::SPRootTransactionClass::EventListenerList [protected]

This holds the list of objects that listen to events from the transaction or game object

const string SecurePlayLibrary::SPRootTransactionClass::extendedversion

Developer extended version. Reimplemented in SecurePlayLibrary::SPGameClass.

string SecurePlayLibrary::SPRootTransactionClass::gameID [protected]

If associated with a transaction: This property is the identifier of the game instance with which the transaction is associated.

string SecurePlayLibrary::SPRootTransactionClass::master [protected]

If associated with a transaction: This is the PlayerID of the player that is the master of this transaction. The master of the transaction is the only entity that can start, configure, or end the transaction.

vector<string> SecurePlayLibrary::SPRootTransactionClass::playerIDList [protected]

If associated with a transaction: This is an array that holds the Player IDs of the players within the game that are participating in this transaction.

const string SecurePlayLibrary::SPRootTransactionClass::releaseversion

IT GlobalSecure release version. Reimplemented in SecurePlayLibrary::SPGameClass.

string SecurePlayLibrary::SPRootTransactionClass::transactionID [protected]

If associated with a transaction: This property holds the unique identifier for the transaction instance within a game instance.

---

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

• SPRootTransactionClass.h
• SPRootTransactionClass.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.