---

reportPlugin Class Reference

Report selection control and output plugin. More...

#include <reportplugin.h>

Inheritance diagram for reportPlugin:

List of all members.

Public Methods
	reportPlugin ()
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 int	pa (void)
virtual void	beforeParam (void)
virtual ps_e	init (void)
virtual ps_e	free (void)
	~reportPlugin ()
Private Attributes
const char *const	strPrefix
const char *const	strName
const char *const	strVersion
const char *const	strAuthor
const char *const	strHelp
std::map< Report *, int >	usedReports

---

Detailed Description

Report selection control and output plugin.

This plugin controls the selection of the report object of all, or some analysis. It also controls the output.

Author:

Tobias Erbsland

---

Constructor & Destructor Documentation

reportPlugin::reportPlugin (    )

reportPlugin::~reportPlugin (    )

---

Member Function Documentation

virtual const char* reportPlugin::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 reportPlugin::beforeParam (  void    )  [virtual]

This function is executed if the Flag PA_BEFORE_PARAM set before any Parameters are read from the plugin object. Place here code to generate generic parameters, based on other objects in the system. Reimplemented from Plugin.

Plugin::ps_e reportPlugin::free (  void    )  [virtual]

Before everything is done, this function is called to clean perhaps someting. Reimplemented from Plugin.

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

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

Plugin::ps_e reportPlugin::init (  void    )  [virtual]

After reading all parameters, this function is called. Reimplemented from Plugin.

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

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

virtual int reportPlugin::pa (  void    )  [inline, virtual]

This function is tested before every action. You can return a set of function flags to execute this functions of your plugin object. Reimplemented from Plugin.

virtual const char* reportPlugin::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.

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

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

---

Member Data Documentation

const char* const reportPlugin::strAuthor [private]

const char* const reportPlugin::strHelp [private]

const char* const reportPlugin::strName [private]

const char* const reportPlugin::strPrefix [private]

const char* const reportPlugin::strVersion [private]

std::map< Report *, int > reportPlugin::usedReports [private]

---

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

• reportplugin.h
• reportplugin.cpp

---