---

bmAnalyse Class Reference

Biggest mail analysis. More...

#include <bmanalyse.h>

Inheritance diagram for bmAnalyse:

List of all members.

Public Methods
	bmAnalyse ()
virtual const char *	Prefix (void) const
virtual const char *	Name (void) const
virtual const char *	Version (void) const
virtual const char *	Author (void) const
virtual const char *	Help (void) const
virtual void	run (std::map< std::string, unity_t > *unity_map)
virtual void	print (void)
virtual void	free (void)
virtual	~bmAnalyse ()
Private Attributes
const char *const	strPrefix
const char *const	strName
const char *const	strVersion
const char *const	strAuthor
const char *const	strHelp
std::map< std::string, unity_t > *	unity_map
std::multimap< long, std::string >	biggest_mail

---

Detailed Description

Biggest mail analysis.

This analysis module create a statistic about the biggest mail received or sent. The result ist sorted by the size of the mail.

Author:

Tobias Erbsland

---

Constructor & Destructor Documentation

bmAnalyse::bmAnalyse (    )

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

---

Member Function Documentation

virtual const char* bmAnalyse::Author (  void    )  const [inline, virtual]

Name of authors of the Object with Email in format "Firstname Lastname <email>" up to 40 chars. Reimplemented from Parameter.

void bmAnalyse::free (  void    )  [virtual]

This funcion should free unused memory (from map's etc.). Implements Analyse.

virtual const char* bmAnalyse::Help (  void    )  const [inline, virtual]

A short helptext, or description to this object. Reimplemented from Parameter.

virtual const char* bmAnalyse::Name (  void    )  const [inline, virtual]

Select a short Name for the parameter Object. Reimplemented from Parameter.

virtual const char* bmAnalyse::Prefix (  void    )  const [inline, virtual]

This function returns a unique object prefix. Use only lowercase letters (a-z) and keep this name short as possible. Implements Parameter.

void bmAnalyse::print (  void    )  [virtual]

This function printout the result of this analyse to the selected report object. Is no report object selected (report is a null pointer) - nothing should happens. (check also report first!). Implements Analyse.

void bmAnalyse::run (  std::map< std::string, unity_t > *    unity_map )  [virtual]

This function should do all calculations for this analyse, and store the result for multible print() calls until someone call free() or destroy the object. Implements Analyse.

virtual const char* bmAnalyse::Version (  void    )  const [inline, virtual]

Version up to 8 chars in the format V-.- Reimplemented from Parameter.

---

Member Data Documentation

std::multimap< long, std::string > bmAnalyse::biggest_mail [private]

Map for the analysis.

const char* const bmAnalyse::strAuthor [private]

const char* const bmAnalyse::strHelp [private]

const char* const bmAnalyse::strName [private]

const char* const bmAnalyse::strPrefix [private]

const char* const bmAnalyse::strVersion [private]

std::map< std::string, unity_t >* bmAnalyse::unity_map [private]

This pointer is used to save the pointer to the _unity map_. The unity map pointer is later used in the result to get detail informations about the mails.

---

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

• bmanalyse.h
• bmanalyse.cpp

---