---

asciiReport Class Reference

#include <asciireport.h>

Inheritance diagram for asciiReport:

List of all members.

Public Methods
	asciiReport ()
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	startNewReport (const std::string &title, const reportType_e reportType)
virtual void	printPageHeader (void)
virtual void	printHeader (void)
virtual void	printField (const std::string &field)
virtual void	printField (const long field)
virtual void	printField (const double field)
virtual void	skipField (const bool realline=true)
virtual void	printFooter (void)
virtual void	printPageFooter (void)
virtual	~asciiReport ()
Private Methods
void	printSpace (const int width=1)
void	printLine (const char ch= '-', const int size=-1)
void	checkAutoField (void)
bool	nextField (void)
Private Attributes
const char *const	strPrefix
const char *const	strName
const char *const	strVersion
const char *const	strAuthor
const char *const	strHelp
int	ScreenWidth

---

Detailed Description

This is a report for ascii outputs.

Author:

Tobias Erbsland

---

Constructor & Destructor Documentation

asciiReport::asciiReport (    )

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

---

Member Function Documentation

virtual const char* asciiReport::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 asciiReport::checkAutoField (  void    )  [private]

Creates perhaps all automatic generated fields.

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

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

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

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

bool asciiReport::nextField (  void    )  [private]

Jumps to the next field, and create perhaps a newline.

virtual const char* asciiReport::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 asciiReport::printField (  const double    field )  [virtual]

Implements Report.

void asciiReport::printField (  const long    field )  [virtual]

Implements Report.

void asciiReport::printField (  const std::string &    field )  [virtual]

If you create a Table, after setup all columns and calling printHeader, you must fill every Field auf the table (except autofilled-colums) with the right value from left to right, top to bottom. Implements Report.

void asciiReport::printFooter (  void    )  [virtual]

After the last line of the table, call this function to create perhaps a footer. Implements Report.

void asciiReport::printHeader (  void    )  [virtual]

After setup all columns with addCol, you must call this function. It's possible this function creates a header for the Report. Implements Report.

void asciiReport::printLine (  const char    ch = '-', const int    size = -1 )  [private]

Draws a line, default over the full screen width.

virtual void asciiReport::printPageFooter (  void    )  [inline, virtual]

Generate a final Footer before closing a stream Implements Report.

virtual void asciiReport::printPageHeader (  void    )  [inline, virtual]

Gererate a page Header for one or more single Reports Implements Report.

void asciiReport::printSpace (  const int    width = 1 )  [private]

Print "width" spaces.

void asciiReport::skipField (  const bool    realline = true )  [virtual]

If the Field empty, call this function. You can choose between a realline or not. See the examples in the current analyse modules. Implements Report.

void asciiReport::startNewReport (  const std::string &    title, const reportType_e    reportType )  [virtual]

This function must be called first, before any other function is called. With this, important parameters would be set. Parameters: title  Set the title of the following report. reportType  Set the next report type. Implements Report.

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

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

---

Member Data Documentation

int asciiReport::ScreenWidth [private]

This Variable is used to store the current screenwith.

const char* const asciiReport::strAuthor [private]

const char* const asciiReport::strHelp [private]

const char* const asciiReport::strName [private]

const char* const asciiReport::strPrefix [private]

const char* const asciiReport::strVersion [private]

---

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

• asciireport.h
• asciireport.cpp

---