vhist::SummaryReader Class Reference

A class reading and evaluating summary files. More...

#include <summaryreader.h>

List of all members.

Public Member Functions
	SummaryReader ()
	Creates a new SummaryReader object.
	~SummaryReader ()
	Destroys the SummaryReader object.
Summary	readSummary (const QString &data)
	Reads a summary file and creates a Summary object including all the information contained in the file.

---

Detailed Description

A class reading and evaluating summary files.

A summary file is an xml file containing all information about one workflowstep. A tool creating VHIST files will generate one summary file for every section it creates and embed this file as the last embedded file in the section.

---

Member Function Documentation

Summary SummaryReader::readSummary

(

const QString &

data

)

Reads a summary file and creates a Summary object including all the information contained in the file.

Parameters:

[in]

data

The content of the summary file.

Returns:

A Summary object. On success, the summaryOK member of the object will be set to true.

---

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

• /daten/ahuesgen/projects/vhist/code/vhistlib/include/unvhistlib/summaryreader.h
• /daten/ahuesgen/projects/vhist/code/vhistlib/src/unvhistlib/summaryreader.cpp