SecurePlayLibrary::SPLCircularLogClass Class Reference

#include <SPLCircularLogClass.h>

Inheritance diagram for SecurePlayLibrary::SPLCircularLogClass:

List of all members.

---

Detailed Description

This is a circular log to hold a limited number of messages. The log will then roll over.

Author:

ITGlobalSecure

See also:

SecurePlay License Information

Public Member Functions
	SPLCircularLogClass ()
	~SPLCircularLogClass ()
	SPLCircularLogClass (int ilogsize)
void	addEntry (void *entry)
void	clear ()
bool	reset ()
void *	getNextEntry ()
void *	getPreviousEntry ()
void *	getCurrentEntry ()
int	getLogLength ()
void	setLogLength (int logsize)
string	getLogtype ()
Private Attributes
vector< void * >	prentryList
int	prptr
int	loglength
int	currview
string	logtype

---

Constructor & Destructor Documentation

SPLCircularLogClass::SPLCircularLogClass (   )

Default Constructor.

SPLCircularLogClass::~SPLCircularLogClass (   )

Default Destructor

SPLCircularLogClass::SPLCircularLogClass (  int  ilogsize  )

Alternate Constructor. Constructs a new SPCircularLogClass() with log size set

---

Member Function Documentation

void SPLCircularLogClass::addEntry (  void *  entry  )  [virtual]

Add a entry to the log object. Parameters: entry  Object - An entry object that is used in a log. Implements SecurePlayLibrary::SPLogInterface.

void SPLCircularLogClass::clear (   )  [virtual]

Clear the log. Implements SecurePlayLibrary::SPLogInterface.

void * SPLCircularLogClass::getCurrentEntry (   )  [virtual]

This method returns the current entry in the Log - where the pointer indicates. Returns: obj - Object - An Object of type entry Implements SecurePlayLibrary::SPLogInterface.

int SPLCircularLogClass::getLogLength (   )  [virtual]

This method returns the number of logged objects in the log instance. Returns: length - int - number of entries in Log Implements SecurePlayLibrary::SPLogInterface.

string SPLCircularLogClass::getLogtype (   )  [virtual]

This method returns the log type of the log class that implements this log interface. Returns: logtype - String - log type of the log Implements SecurePlayLibrary::SPLogInterface.

void * SPLCircularLogClass::getNextEntry (   )  [virtual]

Get the next non-empty entry in the log. Returns: obj - Object - An entry object Implements SecurePlayLibrary::SPLogInterface.

void * SPLCircularLogClass::getPreviousEntry (   )  [virtual]

This method returns the previous entry in the log. Returns: obj - Object - Previous Log Entry. Implements SecurePlayLibrary::SPLogInterface.

bool SPLCircularLogClass::reset (   )  [virtual]

Resets the log pointer. Returns: result - Boolean: TRUE, to confirm the reset. Implements SecurePlayLibrary::SPLogInterface.

void SPLCircularLogClass::setLogLength (  int  logsize  )

This method sets the log size. If it is larger than the current size, it expands the log. If smaller, it empties the log

---

Member Data Documentation

int SecurePlayLibrary::SPLCircularLogClass::currview [private]

This is an integer value representing the current entry in the log for viewing

int SecurePlayLibrary::SPLCircularLogClass::loglength [private]

This is an integer value that is the length of the log

string SecurePlayLibrary::SPLCircularLogClass::logtype [private]

vector<void*> SecurePlayLibrary::SPLCircularLogClass::prentryList [private]

This is a private object that acts as the storage container for the log object entries.

int SecurePlayLibrary::SPLCircularLogClass::prptr [private]

This is a pointer to indicate the current location in an existing log object.

---

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

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