---

clawsoft::TemporalBuffer Class Reference

#include <TemporalBuffer.h>

Inheritance diagram for clawsoft::TemporalBuffer:

[legend]Collaboration diagram for clawsoft::TemporalBuffer:

[legend]

---

Detailed Description

This class identifies a temporary memory object it is intended to be used by the garbage collector Please be carefull while using temporary memory buffers because after the timeout has been reached all the memory it is storing will be PERMANENTLY ERASED

STATUS: READY TO TEST

.

Public Methods
	TemporalBuffer ()
	Default constructor, this will initialize the buffer memory address to 0x0000 and also the timeout.
const char *	getClassName ()
	Returns the name of the current class.
Static Public Methods
int	installedCPUs ()
	This will return how many CPUs are installed in the system.
double	cpuSpeed ()
	This will return the CPU speed in megahertz.
int	totalMemory ()
	Will return the total amount of system memory.
int	freeMemory ()
	Will return the total amount of free system memory.
void	usleep (Uint32 usec)
	Will freeze the software for usec microseconds.
Data Fields
void *	buffer
	This is the memory buffer as intended to be.
Protected Methods
void	setClassName (const char *n)
	Call this method when you need to set the name of the class you're creating, typically in it's constructor, remember that you must set the classname for every class you create, that way you can have more information while debugging.
Protected Attributes
Uint32	_elapsed
	This variable holds current elapsed time since the buffer was allocated.
Uint32	_timeout
	Live timeout in seconds, after this period expires all memory allocated for this buffer will be released.

---

Constructor & Destructor Documentation

clawsoft::TemporalBuffer::TemporalBuffer (    )

Default constructor, this will initialize the buffer memory address to 0x0000 and also the timeout.

---

Member Function Documentation

double clawsoft::System::cpuSpeed (    )  [static, inherited]

This will return the CPU speed in megahertz.

int clawsoft::System::freeMemory (    )  [static, inherited]

Will return the total amount of free system memory.

const char * clawsoft::Object::getClassName (    )  [inherited]

Returns the name of the current class.

int clawsoft::System::installedCPUs (    )  [static, inherited]

This will return how many CPUs are installed in the system.

void clawsoft::Object::setClassName (  const char *    n )  [protected, inherited]

Call this method when you need to set the name of the class you're creating, typically in it's constructor, remember that you must set the classname for every class you create, that way you can have more information while debugging.

int clawsoft::System::totalMemory (    )  [static, inherited]

Will return the total amount of system memory.

void clawsoft::System::usleep (  Uint32    usec )  [static, inherited]

Will freeze the software for usec microseconds.

---

Field Documentation

Uint32 clawsoft::TemporalBuffer::_elapsed [protected]

This variable holds current elapsed time since the buffer was allocated.

Uint32 clawsoft::TemporalBuffer::_timeout [protected]

Live timeout in seconds, after this period expires all memory allocated for this buffer will be released.

void* clawsoft::TemporalBuffer::buffer

This is the memory buffer as intended to be.

---

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

• TemporalBuffer.h
• TemporalBuffer.cpp

Authors:

Juan V. Guerrero
Jannette C. Mejia
Juan C. Guevara

Powered by: