Tekkotsu Homepage
Demos
Overview
Downloads
Dev. Resources
Reference
Credits

FreeMemReportControl Class Reference

#include <FreeMemReportControl.h>

Inheritance diagram for FreeMemReportControl:

List of all members.


Detailed Description

gives reports on free memory size at variable rates, can also warn if free memory drops too low.

Definition at line 12 of file FreeMemReportControl.h.


Public Member Functions

virtual void DoStart ()
 By default, merely adds to the reference counter (through AddReference()); Note you should still call this from your overriding methods.
virtual void DoStop ()
 By default, subtracts from the reference counter (RemoveReference()), and thus may deletex if zero; Don't forget to still call this when you override this; Warning: call this at the end of your DoStop(), not beginning (it might delete this ).
virtual void processEvent (const EventBase &e)
 By defining here, allows you to get away with not supplying a processEvent() function for the EventListener interface. By default, does nothing.
virtual std::string getName () const
 Identifies the behavior in menus and such.
virtual void refresh ()
 called when the child has deactivated and this control should refresh its display, or some other event (such as the user pressing the refresh button) has happened to cause a refresh to be needed
void report ()
 reports size of free memory - if this is below low_mem, also generates a warning
void resetTimerFreq ()
 resets timer delays
Contructors/Destructors
contructor

 FreeMemReportControl ()
 FreeMemReportControl (const std::string &n)
 FreeMemReportControl (const std::string &n, const std::string &d)
virtual ~FreeMemReportControl ()
 destructor

Static Public Member Functions

static size_t freeMem ()
 returns the size of the free memory

Protected Member Functions

void init ()
 builds the submenus

Protected Attributes

int report_freq
 how often to report memory size (in milliseconds - negative turns off, 0 is as often as possible)
unsigned int low_mem
 threshold to trigger low memory warning (in kilobytes)
unsigned int monitor_freq
 how often to check for low memory (in milliseconds - -1U turns off, 0 is as often as possible)
bool isWarning
 true we already know we're below threshold
size_t lastReport
 free memory at last report so we can report the difference

Constructor & Destructor Documentation

FreeMemReportControl::FreeMemReportControl (  )  [inline]

Definition at line 16 of file FreeMemReportControl.h.

FreeMemReportControl::FreeMemReportControl ( const std::string &  n  )  [inline]

Definition at line 17 of file FreeMemReportControl.h.

FreeMemReportControl::FreeMemReportControl ( const std::string &  n,
const std::string &  d 
) [inline]

Definition at line 18 of file FreeMemReportControl.h.

virtual FreeMemReportControl::~FreeMemReportControl (  )  [inline, virtual]

destructor

Definition at line 19 of file FreeMemReportControl.h.


Member Function Documentation

virtual void FreeMemReportControl::DoStart (  )  [inline, virtual]

By default, merely adds to the reference counter (through AddReference()); Note you should still call this from your overriding methods.

Reimplemented from BehaviorBase.

Definition at line 22 of file FreeMemReportControl.h.

virtual void FreeMemReportControl::DoStop (  )  [inline, virtual]

By default, subtracts from the reference counter (RemoveReference()), and thus may deletex if zero; Don't forget to still call this when you override this; Warning: call this at the end of your DoStop(), not beginning (it might delete this ).

Reimplemented from BehaviorBase.

Definition at line 27 of file FreeMemReportControl.h.

Referenced by ~FreeMemReportControl().

void FreeMemReportControl::processEvent ( const EventBase  )  [virtual]

By defining here, allows you to get away with not supplying a processEvent() function for the EventListener interface. By default, does nothing.

Reimplemented from BehaviorBase.

Definition at line 7 of file FreeMemReportControl.cc.

virtual std::string FreeMemReportControl::getName (  )  const [inline, virtual]

Identifies the behavior in menus and such.

Reimplemented from BehaviorBase.

Definition at line 35 of file FreeMemReportControl.h.

void FreeMemReportControl::refresh (  )  [virtual]

called when the child has deactivated and this control should refresh its display, or some other event (such as the user pressing the refresh button) has happened to cause a refresh to be needed

Reimplemented from ControlBase.

Definition at line 28 of file FreeMemReportControl.cc.

void FreeMemReportControl::report (  ) 

reports size of free memory - if this is below low_mem, also generates a warning

Definition at line 38 of file FreeMemReportControl.cc.

Referenced by processEvent(), and refresh().

size_t FreeMemReportControl::freeMem (  )  [static]

returns the size of the free memory

Definition at line 49 of file FreeMemReportControl.cc.

Referenced by init(), processEvent(), refresh(), and report().

void FreeMemReportControl::resetTimerFreq (  ) 

resets timer delays

Definition at line 60 of file FreeMemReportControl.cc.

Referenced by DoStart(), and report().

void FreeMemReportControl::init (  )  [inline, protected]

builds the submenus

Definition at line 50 of file FreeMemReportControl.h.

Referenced by FreeMemReportControl().


Member Data Documentation

how often to report memory size (in milliseconds - negative turns off, 0 is as often as possible)

Definition at line 59 of file FreeMemReportControl.h.

Referenced by init(), and resetTimerFreq().

unsigned int FreeMemReportControl::low_mem [protected]

threshold to trigger low memory warning (in kilobytes)

Definition at line 60 of file FreeMemReportControl.h.

Referenced by init(), processEvent(), and report().

unsigned int FreeMemReportControl::monitor_freq [protected]

how often to check for low memory (in milliseconds - -1U turns off, 0 is as often as possible)

Definition at line 61 of file FreeMemReportControl.h.

Referenced by init(), and resetTimerFreq().

true we already know we're below threshold

Definition at line 62 of file FreeMemReportControl.h.

Referenced by DoStop(), processEvent(), and report().

free memory at last report so we can report the difference

Definition at line 63 of file FreeMemReportControl.h.

Referenced by init(), and report().


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

Tekkotsu v4.0
Generated Thu Nov 22 00:58:25 2007 by Doxygen 1.5.4