---

Analyse Class Reference

Abstract base class of every analyse object. More...

#include <analyse.h>

Inheritance diagram for Analyse:

List of all members.

Public Methods
	Analyse ()
virtual void	run (std::map< std::string, unity_t > *unity_map)=0
virtual void	print (void)=0
virtual void	free (void)=0
virtual void	setReport (Report *r)
virtual Report *	getReport (void)
virtual	~Analyse ()
Protected Attributes
Report *	report

---

Detailed Description

Abstract base class of every analyse object.

This is the abstract base class of every analyse object. After filtering the input stream with a filter object, the this object make the analyse (...). that's the main reason for the name analyse ;-). A plugin (at the moment the analysePlugin object call first the function run(). After this one or more times print(). Finally it calling free() to cleanup unused memory.

Other plugins (current the reportPlugin Object) calling setReport to change the output report type before, after or between any of this tree function calls.

The filtered data in the unity_map must not change between the run() and the print() function call. You can also store this pointer to request details while print(). But it's possible that the funtions of this object are called many times in the order descibed above with different unity_map's.

Author:

Tobias Erbsland

See also:

reportPlugin , syslogFilter

---

Constructor & Destructor Documentation

Analyse::Analyse (    )  [inline]

Constructor of the Object. This constuctor here guarantee, that the report Pointer is initially 0.

Analyse::~Analyse (    )  [virtual]

Virtual deconstuctor.

---

Member Function Documentation

virtual void Analyse::free (  void    )  [pure virtual]

This funcion should free unused memory (from map's etc.). Implemented in bmAnalyse, ltAnalyse, ltdAnalyse, mfAnalyse, mrAnalyse, mtAnalyse, and xtAnalyse.

virtual Report* Analyse::getReport (  void    )  [inline, virtual]

Get current selected report for this Object Returns: A pointer to the selected report object.

virtual void Analyse::print (  void    )  [pure 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!). Implemented in bmAnalyse, ltAnalyse, ltdAnalyse, mfAnalyse, mrAnalyse, mtAnalyse, and xtAnalyse.

virtual void Analyse::run (  std::map< std::string, unity_t > *    unity_map )  [pure 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. Implemented in bmAnalyse, ltAnalyse, ltdAnalyse, mfAnalyse, mrAnalyse, mtAnalyse, and xtAnalyse.

virtual void Analyse::setReport (  Report *    r )  [inline, virtual]

Set the output to a report object. Parameters: r  A pointer to an existing report Object.

---

Member Data Documentation

Report* Analyse::report [protected]

This is a pointer to the defaultreport used in print(). See also: print

---

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

• analyse.h
• analyse.cpp

---