US_Report::ReportDocument Class Reference

The ReportDocument class describes an individual report document. This document would be a png or an html snippet that could be included as one of many documents available to be a part of a report. More...

#include "us_report.h"

Public Member Functions
	ReportDocument ()
	Generic constructor for the ReportDocument class. More...
Status	saveDB (int, QString, US_DB2 *=0)
	Function to save/update the current report document to the DB. More...
Status	readDB (QString, US_DB2 *=0)
	Function to read the entire current report document from the DB. More...
void	reset (void)
	Resets the class variables to their default vaules. More...
void	show (void)
	Displays the contents of the class variables in qDebug() statements. More...

Public Attributes
int	documentID
	The ID of this report document. More...
QString	documentGUID
	The GUID of this report document. More...
int	editedDataID
	The edit profile in place when report was generated. More...
QString	label
	An identifying label for the report document profile. More...
QString	filename
	The filename of the disk file that stored this document. More...
QString	analysis
QString	subAnalysis
QString	documentType
	What type of document this is (png, svg, etc.) More...

Private Attributes
int	dbg_level
	Debug level value. More...

Detailed Description

The ReportDocument class describes an individual report document. This document would be a png or an html snippet that could be included as one of many documents available to be a part of a report.

Definition at line 58 of file us_report.h.

Constructor & Destructor Documentation

US_Report::ReportDocument::ReportDocument

(

)

Generic constructor for the ReportDocument class.

Definition at line 78 of file us_report.cpp.

Member Function Documentation

US_Report::Status US_Report::ReportDocument::readDB	(	QString	dir,
		US_DB2 *	db = 0
	)

Function to read the entire current report document from the DB.

Parameters

dir	The directory where the document will be written
db	For database access, an open database connection

Definition at line 182 of file us_report.cpp.

void US_Report::ReportDocument::reset

(

void

)

Resets the class variables to their default vaules.

Definition at line 231 of file us_report.cpp.

US_Report::Status US_Report::ReportDocument::saveDB	(	int	tripleID,
		QString	dir,
		US_DB2 *	db = 0
	)

Function to save/update the current report document to the DB.

Parameters

tripleID	The database ID of the report triple this document is associated with
dir	The directory where the document contents file is located
db	For database access, an open database connection

Definition at line 84 of file us_report.cpp.

void US_Report::ReportDocument::show

(

void

)

Displays the contents of the class variables in qDebug() statements.

Definition at line 245 of file us_report.cpp.

Member Data Documentation

QString US_Report::ReportDocument::analysis

      The type of analysis that this document was derived from

(2DSA, GA, dcdt, etc.)

Definition at line 66 of file us_report.h.

int US_Report::ReportDocument::dbg_level

private

Debug level value.

Definition at line 98 of file us_report.h.

QString US_Report::ReportDocument::documentGUID

The GUID of this report document.

Definition at line 62 of file us_report.h.

int US_Report::ReportDocument::documentID

The ID of this report document.

Definition at line 61 of file us_report.h.

QString US_Report::ReportDocument::documentType

What type of document this is (png, svg, etc.)

Definition at line 70 of file us_report.h.

int US_Report::ReportDocument::editedDataID

The edit profile in place when report was generated.

Definition at line 63 of file us_report.h.

QString US_Report::ReportDocument::filename

The filename of the disk file that stored this document.

Definition at line 65 of file us_report.h.

QString US_Report::ReportDocument::label

An identifying label for the report document profile.

Definition at line 64 of file us_report.h.

QString US_Report::ReportDocument::subAnalysis

   Further information that helps to identify what type of content it is

(report, residuals, rinoise, etc.)

Definition at line 68 of file us_report.h.

---

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

• us_report.h
• us_report.cpp