The ReportTriple class describes an individual report. This report would ordinarily be associated with a particular runID and triple ( c/c/w ) within the experiment, and could contain any number of report documents. More...

#include "us_report.h"

Public Member Functions
	ReportTriple ()
	Generic constructor for the ReportTriple class. More...

Status	saveDB (int, US_DB2 *=0)
	Function to save/update the current triple to the DB. More...

Status	readDocsDB (US_DB2 *=0)
	Function to read all the documents for the current triple, except for the document content itself. More...

Status	addDocument (int, QString, QString, QString, QString, QString, QString, US_DB2 *=0)
	Function to add an empty report document record, both in the object and the DB. More...

Status	addDocument (US_Report::ReportDocument, QString, US_DB2 *=0)
	Function to add/replace an entire document record. More...

Status	removeDocument (int, US_DB2 *=0)
	Function to delete a report document from the DB. More...

int	findDocument (QString, QString, QString)
	Function to find an existing report document record, based on the analysis, subAnalysis, and documentType fields. More...

void	reset (void)
	Resets the class variables to their default values. More...

void	show (void)
	Displays the contents of the class variables in qDebug()s. More...

Public Attributes
int	tripleID
	The ID of this report. More...

QString	tripleGUID
	The GUID of this report. More...

int	resultID

QString	triple

QString	dataDescription

QVector< ReportDocument >	docs
	The report documents themselves. More...

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

Detailed Description

The ReportTriple class describes an individual report. This report would ordinarily be associated with a particular runID and triple ( c/c/w ) within the experiment, and could contain any number of report documents.

Definition at line 106 of file us_report.h.

Constructor & Destructor Documentation

US_Report::ReportTriple::ReportTriple ( )

Generic constructor for the ReportTriple class.

Definition at line 260 of file us_report.cpp.

Member Function Documentation

US_Report::Status US_Report::ReportTriple::addDocument	(	int	editedDataID,
		QString	label,
		QString	dir,
		QString	filename,
		QString	analysis,
		QString	subAnalysis,
		QString	documentType,
		US_DB2 *	db = `0`
	)

Function to add an empty report document record, both in the object and the DB.

Parameters

editedDataID	The edit profile in effect when the document was created
label	An identifying label
dir	The directory where the document can be found
filename	The filename of the document itself
analysis	The type of analysis (vHW, dcdt, 2DSA, etc.)
subAnalysis	The sub-analysis type (residuals, rinoise, sdistrib, etc.)
documentType	The type of document (png, csv, svg, html, etc.)
db	For database access, an open database connection

Returns: One of the US_Report error codes

Definition at line 370 of file us_report.cpp.

US_Report::Status US_Report::ReportTriple::addDocument	(	US_Report::ReportDocument	d,
		QString	dir,
		US_DB2 *	db = `0`
	)

Function to add/replace an entire document record.

Parameters

d	A US_Report::ReportDocument object
dir	The directory where the document can be found
db	For database access, an open database connection

Returns: One of the US_Report error codes

Definition at line 393 of file us_report.cpp.

int US_Report::ReportTriple::findDocument	(	QString	searchAnal,
		QString	searchSubanal,
		QString	searchType
	)

Function to find an existing report document record, based on the analysis, subAnalysis, and documentType fields.

Parameters

searchAnal	The type of analysis (vHW, dcdt, 2DSA, etc.)
searchSubanal	The sub-analysis type (residuals, rinoise, sdistrib, etc.)
searchType	The type of document (png, csv, svg, html, etc.)

Returns: The index into the QVector docs that matches all three analysis fields, or -1 if no match

Definition at line 438 of file us_report.cpp.

US_Report::Status US_Report::ReportTriple::readDocsDB ( US_DB2 * db = 0 )

Function to read all the documents for the current triple, except for the document content itself.

Parameters

db	For database access, an open database connection

Definition at line 336 of file us_report.cpp.

US_Report::Status US_Report::ReportTriple::removeDocument	(	int	ndx,
		US_DB2 *	db = `0`
	)

Function to delete a report document from the DB.

Parameters

ndx	The index into the docs QVector of the report document to delete
db	For database access, an open database connection

Definition at line 419 of file us_report.cpp.

void US_Report::ReportTriple::reset ( void )

Resets the class variables to their default values.

Definition at line 455 of file us_report.cpp.

US_Report::Status US_Report::ReportTriple::saveDB	(	int	reportID,
		US_DB2 *	db = `0`
	)

Function to save/update the current triple to the DB.

Parameters

reportID	The database ID of the global report structure this document is associated with
db	For database access, an open database connection

Returns: One of the US_Report error codes

Definition at line 266 of file us_report.cpp.

void US_Report::ReportTriple::show ( void )

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

Definition at line 468 of file us_report.cpp.

Member Data Documentation

QString US_Report::ReportTriple::dataDescription

 The data description from the first line of the

original data file

Definition at line 115 of file us_report.h.

int US_Report::ReportTriple::dbg_level

private

Debug level value.

Definition at line 195 of file us_report.h.

QVector< ReportDocument > US_Report::ReportTriple::docs

The report documents themselves.

Definition at line 117 of file us_report.h.

int US_Report::ReportTriple::resultID

      The resultID from the HPCAnalysisResult table record

that this triple was derived from

Definition at line 111 of file us_report.h.

QString US_Report::ReportTriple::triple

        The cell/channel/wavelength identifying which channel

this triple was derived from (Format: c/c/w)

Definition at line 113 of file us_report.h.

QString US_Report::ReportTriple::tripleGUID

The GUID of this report.

Definition at line 110 of file us_report.h.

int US_Report::ReportTriple::tripleID

The ID of this report.

Definition at line 109 of file us_report.h.

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

Public Member Functions

Public Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation