US_Project Class Reference

#include "us_project.h"

Public Types
enum	projectStatus {   NOT_SAVED, EDITING, HD_ONLY, DB_ONLY,   BOTH }
	Some status codes to keep track of where project data has been saved to. More...

Public Member Functions
	US_Project ()
	Generic constructor for the US_Project class. More...
	~US_Project ()
	A null destructor. More...
int	readFromDisk (QString &)
	Function to read an entire project structure from the disk. More...
int	readFromDB (int, US_DB2 *=0)
	Function to read an entire project structure from the DB. More...
void	clear (void)
	Quick method to zero out the project attributes. More...
void	saveToDisk (void)
	Method to save the current project to disk. More...
int	saveToDB (US_DB2 *=0)
	Function to save the project information to db. More...
void	deleteFromDisk (void)
	Function to delete the current project from disk, if it exists. More...
void	deleteFromDB (US_DB2 *=0)
	Function to delete the current project from the db, if it exists. More...
bool	diskFilename (const QString &, QString &)
	Function to find the filename of a project on disk, if it exists. Returns true if successful, false otherwise. More...
bool	diskPath (QString &)
	Function to find out where the project xml files are stored on disk Returns true if successful, false otherwise. More...
void	show (void)
	Displays the contents of the class variables in qDebug() statements. More...

Public Attributes
int	projectID
	The ID of the project. More...
QString	projectGUID
	The GUID of the project. More...
QString	goals
	A detailed description of the goals of the research. More...
QString	molecules
	Proteins/DNA molecules involved, and mw. More...
QString	purity
	Approximate purity of the samples, in %. More...
QString	expense
	Expense of providing appropriate concentration ok. More...
QString	bufferComponents
	A text listing of buffer components. More...
QString	saltInformation
	Explanation of an acceptable salt concentration. More...
QString	AUC_questions
	Questions research is attempting to answer with the AUC. More...
QString	expDesign
	Experiment design. More...
QString	notes
	Special instructions, notes, questions. More...
QString	projectDesc
	A description of the project. More...
QString	status
	Project status. More...
projectStatus	saveStatus
	Most recent save status. More...

Private Member Functions
void	readProjectInfo (QXmlStreamReader &xml)
QString	get_filename (const QString &, bool &)

Detailed Description

This class provides the ability to enter information about a new project, and to select the project.

Definition at line 13 of file us_project.h.

Member Enumeration Documentation

enum US_Project::projectStatus

Some status codes to keep track of where project data has been saved to.

Enumerator
NOT_SAVED	The file has not been saved.
EDITING	Data is being edited; certain operations not permitted.
HD_ONLY	The file has been saved to the HD.
DB_ONLY	The file has been saved to the DB.
BOTH	The file has been saved to both HD and DB.

Definition at line 18 of file us_project.h.

Constructor & Destructor Documentation

US_Project::US_Project

(

)

Generic constructor for the US_Project class.

Definition at line 11 of file us_project.cpp.

US_Project::~US_Project ( )

inline

A null destructor.

Definition at line 47 of file us_project.h.

Member Function Documentation

void US_Project::clear

(

void

)

Quick method to zero out the project attributes.

Definition at line 492 of file us_project.cpp.

void US_Project::deleteFromDB

(

US_DB2 *

db = 0

)

Function to delete the current project from the db, if it exists.

Parameters

db	For database access, an open database connection

Definition at line 336 of file us_project.cpp.

void US_Project::deleteFromDisk

(

void

)

Function to delete the current project from disk, if it exists.

Definition at line 316 of file us_project.cpp.

bool US_Project::diskFilename	(	const QString &	guid,
		QString &	filename
	)

Function to find the filename of a project on disk, if it exists. Returns true if successful, false otherwise.

Parameters

guid	The GUID of the project to look for on disk
filename	The function will return the filename here if it is found

Definition at line 371 of file us_project.cpp.

bool US_Project::diskPath

(

QString &

path

)

Function to find out where the project xml files are stored on disk Returns true if successful, false otherwise.

Parameters

path	The function will return the path here if it is found

Definition at line 425 of file us_project.cpp.

QString US_Project::get_filename ( const QString &  path, bool &  newFile  )

private

Definition at line 444 of file us_project.cpp.

int US_Project::readFromDB	(	int	projectID,
		US_DB2 *	db = 0
	)

Function to read an entire project structure from the DB.

Parameters

projectID	The database projectID of the desired project
db	For database access, an open database connection

Returns

One of the US_DB2 error codes

Definition at line 146 of file us_project.cpp.

int US_Project::readFromDisk

(

QString &

guid

)

Function to read an entire project structure from the disk.

Parameters

guid	The GUID of the project to look for

Returns

One of the US_DB2 error codes

Definition at line 17 of file us_project.cpp.

void US_Project::readProjectInfo ( QXmlStreamReader &  xml )

private

Definition at line 72 of file us_project.cpp.

int US_Project::saveToDB

(

US_DB2 *

db = 0

)

Function to save the project information to db.

Parameters

db	For database access, an open database connection

Definition at line 241 of file us_project.cpp.

void US_Project::saveToDisk

(

void

)

Method to save the current project to disk.

Definition at line 181 of file us_project.cpp.

void US_Project::show

(

void

)

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

Definition at line 511 of file us_project.cpp.

Member Data Documentation

QString US_Project::AUC_questions

Questions research is attempting to answer with the AUC.

Definition at line 35 of file us_project.h.

QString US_Project::bufferComponents

A text listing of buffer components.

Definition at line 33 of file us_project.h.

QString US_Project::expDesign

Experiment design.

Definition at line 36 of file us_project.h.

QString US_Project::expense

Expense of providing appropriate concentration ok.

Definition at line 32 of file us_project.h.

QString US_Project::goals

A detailed description of the goals of the research.

Definition at line 29 of file us_project.h.

QString US_Project::molecules

Proteins/DNA molecules involved, and mw.

Definition at line 30 of file us_project.h.

QString US_Project::notes

Special instructions, notes, questions.

Definition at line 37 of file us_project.h.

QString US_Project::projectDesc

A description of the project.

Definition at line 38 of file us_project.h.

QString US_Project::projectGUID

The GUID of the project.

Definition at line 28 of file us_project.h.

int US_Project::projectID

The ID of the project.

Definition at line 27 of file us_project.h.

QString US_Project::purity

Approximate purity of the samples, in %.

Definition at line 31 of file us_project.h.

QString US_Project::saltInformation

Explanation of an acceptable salt concentration.

Definition at line 34 of file us_project.h.

projectStatus US_Project::saveStatus

Most recent save status.

Definition at line 41 of file us_project.h.

QString US_Project::status

Project status.

Definition at line 39 of file us_project.h.

---

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

• us_project.h
• us_project.cpp