#include "us_experiment_ra.h"

Collaboration diagram for US_ExperimentRa:

Classes
struct	CalibrationInfo

struct	RotorInfo

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

int	checkRunID (US_DB2 *=0)
	Determine if the current experiment runID exists in the DB. Updates expID accordingly, or to 0 if not found. More...

int	saveToDB (bool=false, US_DB2 *=0)
	Function to save the experiment information to db. More...

int	readFromDB (QString, US_DB2 *=0)
	Reads experiment information from the db. More...

int	saveToDisk (QVector< US_mwlRamp::RampRawData * > &, QList< US_Ramp::TripleInfo > &, QString, QString, QString)
	Writes an xml file. More...

int	readFromDisk (QList< US_Ramp::TripleInfo > &, QString, QString, QString)
	Reads an xml file. More...

void	clear (void)
	Function to reset all class variables to defaults. More...

void	show (void)

Public Attributes
int	invID
	The personID of the investigator. More...

QString	invGUID
	The GUID of the investigator. More...

QString	name
	The name of the investigator. More...

int	expID
	The ID of the experiment itself. More...

QString	expGUID
	The GUID of the experiment. More...

US_Project	project
	The project this experiment is associated with. More...

QString	runID
	The run ID. More...

int	labID
	The lab in which the experiment was conducted. More...

int	instrumentID
	The identifier of the ultra-centrifuge. More...

QString	instrumentSerial
	The serial number of the instrument. More...

int	operatorID
	The personID of the person who operated the centrifuge. More...

QString	operatorGUID
	The GUID of the operator. More...

int	rotorID
	The rotor that was used. More...

QString	rotorGUID
	The GUID of the rotor. More...

QString	rotorSerial
	The serial number of the rotor. More...

QString	rotorName
	The name of the rotor. More...

int	calibrationID
	The ID of the rotor calibration. More...

double	rotorCoeff1
	The first rotor stretch calibration coefficient. More...

double	rotorCoeff2
	The second rotor stretch coefficient. More...

QDate	rotorUpdated
	The date of the calibration. More...

QString	expType
	The type of experiment. More...

QByteArray	opticalSystem
	The type of optical system used. More...

QString	runTemp
	The run temperature. More...

QString	label
	The experiment label, or identifying information. More...

QString	comments
	Comments that were associated with the experiment. More...

QString	centrifugeProtocol
	The governing centrifuge protocol. More...

QString	date
	The date the record was entered or last updated. More...

bool	syncOK
	The user has connected with the db. More...

QStringList	experimentTypes
	A list of possible experiment types. More...

RotorInfo	hwInfo

Private Member Functions
void	readExperiment (QXmlStreamReader &, QList< US_Ramp::TripleInfo > &, QString, QString)

void	readDataset (QXmlStreamReader &, US_Ramp::TripleInfo &)

Detailed Description

Definition at line 16 of file us_experiment_ra.h.

Constructor & Destructor Documentation

US_ExperimentRa::US_ExperimentRa ( void )

Generic constructor for the US_ExperimentRa class.

Definition at line 12 of file us_experiment_ra.cpp.

Member Function Documentation

int US_ExperimentRa::checkRunID ( US_DB2 * db = 0 )

Determine if the current experiment runID exists in the DB. Updates expID accordingly, or to 0 if not found.

Parameters

db	For database access, an open database connection

Definition at line 25 of file us_experiment_ra.cpp.

void US_ExperimentRa::clear ( void )

Function to reset all class variables to defaults.

Definition at line 648 of file us_experiment_ra.cpp.

void US_ExperimentRa::readDataset	(	QXmlStreamReader &	xml,
		US_Ramp::TripleInfo &	triple
	)

private

Definition at line 608 of file us_experiment_ra.cpp.

void US_ExperimentRa::readExperiment	(	QXmlStreamReader &	xml,
		QList< US_Ramp::TripleInfo > &	triples,
		QString	runType,
		QString	runID
	)

private

Definition at line 445 of file us_experiment_ra.cpp.

int US_ExperimentRa::readFromDB	(	QString	runID,
		US_DB2 *	db = `0`
	)

Reads experiment information from the db.

Parameters

runID	The run ID of the experiment.
db	For database access, an open database connection

Returns: One of the US_DB2 error codes

Definition at line 132 of file us_experiment_ra.cpp.

int US_ExperimentRa::readFromDisk	(	QList< US_Ramp::TripleInfo > &	triples,
		QString	runType,
		QString	runID,
		QString	dirname
	)

Reads an xml file.

Parameters

triples	A reference to a structure provided by the calling function that will contain all the different cell/channel/wavelength defined by the xml file.
runType	A reference to a variable that will contain the type of data ( "RA", "IP", "RI", "FI", "WA", or "WI"). This information will affect how the data is stored.
runID	The run ID of the experiment.
dirname	The directory from which the files are read.

Definition at line 402 of file us_experiment_ra.cpp.

int US_ExperimentRa::saveToDB	(	bool	update = `false`,
		US_DB2 *	db = `0`
	)

Function to save the experiment information to db.

Parameters

update	Is it ok to update an existing database runID (maybe the user is updating a DB record)?
db	For database access, an open database connection

Definition at line 42 of file us_experiment_ra.cpp.

int US_ExperimentRa::saveToDisk	(	QVector< US_mwlRamp::RampRawData * > &	data,
		QList< US_Ramp::TripleInfo > &	triples,
		QString	runType,
		QString	runID,
		QString	dirname
	)

Writes an xml file.

Parameters

data	A reference to a RampRawData vector.
triples	A reference to a structure provided by the calling function that already contains all the different cell/channel/wavelength combinations in the data.
runType	A reference to a variable that already contains the type of data ( "RA", "IP", "RI", "FI", "WA", or "WI"). This information will affect how the data is written.
runID	The run ID of the experiment.
dirname	The directory in which the files are to be written.

Definition at line 236 of file us_experiment_ra.cpp.

void US_ExperimentRa::show ( void )

Definition at line 680 of file us_experiment_ra.cpp.

Member Data Documentation

int US_ExperimentRa::calibrationID

The ID of the rotor calibration.

Definition at line 52 of file us_experiment_ra.h.

QString US_ExperimentRa::centrifugeProtocol

The governing centrifuge protocol.

Definition at line 62 of file us_experiment_ra.h.

QString US_ExperimentRa::comments

Comments that were associated with the experiment.

Definition at line 61 of file us_experiment_ra.h.

QString US_ExperimentRa::date

The date the record was entered or last updated.

Definition at line 63 of file us_experiment_ra.h.

QStringList US_ExperimentRa::experimentTypes

A list of possible experiment types.

Definition at line 65 of file us_experiment_ra.h.

QString US_ExperimentRa::expGUID

The GUID of the experiment.

Definition at line 40 of file us_experiment_ra.h.

int US_ExperimentRa::expID

The ID of the experiment itself.

Definition at line 39 of file us_experiment_ra.h.

QString US_ExperimentRa::expType

The type of experiment.

Definition at line 56 of file us_experiment_ra.h.

RotorInfo US_ExperimentRa::hwInfo

Definition at line 138 of file us_experiment_ra.h.

int US_ExperimentRa::instrumentID

The identifier of the ultra-centrifuge.

Definition at line 44 of file us_experiment_ra.h.

QString US_ExperimentRa::instrumentSerial

The serial number of the instrument.

Definition at line 45 of file us_experiment_ra.h.

QString US_ExperimentRa::invGUID

The GUID of the investigator.

Definition at line 36 of file us_experiment_ra.h.

int US_ExperimentRa::invID

The personID of the investigator.

Definition at line 35 of file us_experiment_ra.h.

QString US_ExperimentRa::label

The experiment label, or identifying information.

Definition at line 60 of file us_experiment_ra.h.

int US_ExperimentRa::labID

The lab in which the experiment was conducted.

Definition at line 43 of file us_experiment_ra.h.

QString US_ExperimentRa::name

The name of the investigator.

Definition at line 38 of file us_experiment_ra.h.

QString US_ExperimentRa::operatorGUID

The GUID of the operator.

Definition at line 47 of file us_experiment_ra.h.

int US_ExperimentRa::operatorID

The personID of the person who operated the centrifuge.

Definition at line 46 of file us_experiment_ra.h.

QByteArray US_ExperimentRa::opticalSystem

The type of optical system used.

Definition at line 57 of file us_experiment_ra.h.

US_Project US_ExperimentRa::project

The project this experiment is associated with.

Definition at line 41 of file us_experiment_ra.h.

double US_ExperimentRa::rotorCoeff1

The first rotor stretch calibration coefficient.

Definition at line 53 of file us_experiment_ra.h.

double US_ExperimentRa::rotorCoeff2

The second rotor stretch coefficient.

Definition at line 54 of file us_experiment_ra.h.

QString US_ExperimentRa::rotorGUID

The GUID of the rotor.

Definition at line 49 of file us_experiment_ra.h.

int US_ExperimentRa::rotorID

The rotor that was used.

Definition at line 48 of file us_experiment_ra.h.

QString US_ExperimentRa::rotorName

The name of the rotor.

Definition at line 51 of file us_experiment_ra.h.

QString US_ExperimentRa::rotorSerial

The serial number of the rotor.

Definition at line 50 of file us_experiment_ra.h.

QDate US_ExperimentRa::rotorUpdated

The date of the calibration.

Definition at line 55 of file us_experiment_ra.h.

QString US_ExperimentRa::runID

The run ID.

Definition at line 42 of file us_experiment_ra.h.

QString US_ExperimentRa::runTemp

The run temperature.

Definition at line 59 of file us_experiment_ra.h.

bool US_ExperimentRa::syncOK

The user has connected with the db.

Definition at line 64 of file us_experiment_ra.h.

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

Classes

Public Member Functions

Public Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation