---

analysePlugin Class Reference

#include <analyseplugin.h>

Inheritance diagram for analysePlugin:

List of all members.

Public Methods
	analysePlugin ()
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	analyse (void)
	~analysePlugin ()
Private Methods
bool	execPlugin (ps_e(Plugin::*fp)(Analyse *), pa_e pa, const std::string &name, Analyse *ap)
Private Attributes
const char *const	strPrefix
const char *const	strName
const char *const	strVersion
const char *const	strAuthor
const char *const	strHelp

---

Detailed Description

This Plugin controls the execution of every analysis.

Author:

Tobias Erbsland

---

Constructor & Destructor Documentation

analysePlugin::analysePlugin (    )

analysePlugin::~analysePlugin (    )

---

Member Function Documentation

analysePlugin::ps_e analysePlugin::analyse (  void    )  [virtual]

Make sure that your plugin is the _only one_ use this function. A call should execute all selected analysis. Reimplemented from Plugin.

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

bool analysePlugin::execPlugin (  ps_e(Plugin::*    fp)(Analyse *), pa_e    pa, const std::string &    name, Analyse *    ap )  [private]

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

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

virtual ps_e analysePlugin::init (  void    )  [inline, virtual]

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

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

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

virtual int analysePlugin::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* analysePlugin::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* analysePlugin::Version (  void    )  const [inline, virtual]

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

---

Member Data Documentation

const char* const analysePlugin::strAuthor [private]

const char* const analysePlugin::strHelp [private]

const char* const analysePlugin::strName [private]

const char* const analysePlugin::strPrefix [private]

const char* const analysePlugin::strVersion [private]

---

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

• analyseplugin.h
• analyseplugin.cpp

---