UltraScan III
List of all members | Public Member Functions | Static Public Member Functions | Public Attributes
US_Rotor::RotorCalibration Class Reference

the RotorCalibration class describes a calibration experiment and associated data More...

#include "us_rotor.h"

Public Member Functions

 RotorCalibration ()
 Generic constructor for the RotorCalibration class. More...
 
int saveDB (int, US_DB2 *=0)
 Function to save the current calibration in the DB. More...
 
Status readDB (int, US_DB2 *=0)
 Function to read an entire rotor calibration structure from the DB. More...
 
int replaceDummyDB (int &, US_DB2 *=0)
 Function to find the dummy calibration for the current rotor in the DB, and to replace it in all experiments with this one if it exists. Most likely it is the single calibration experiment that generated the dummy calibration in the first place. More...
 
void saveDisk (void)
 Method to save the current rotor calibration to disk. More...
 
Status readDisk (const int &)
 A function to read information about a rotor calibration from disk. More...
 
void readReport (QXmlStreamReader &)
 A function to read the report part of the rotor calibration from disk. 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...
 

Static Public Member Functions

static int deleteCalibrationDB (int, US_DB2 *=0)
 Function to delete the specified rotor calibration from the DB. More...
 

Public Attributes

int ID
 The ID of this calibration. More...
 
QString GUID
 The GUID of this calibration. More...
 
int rotorID
 The ID of the rotor this calibration is associated with. More...
 
QString rotorGUID
 The GUID of the rotor this calibration is associated with. More...
 
int calibrationExperimentID
 The ID of the experiment that contains the calibration data. More...
 
QString calibrationExperimentGUID
 The GUID of the experiment that contains the calibration data. More...
 
double coeff1
 The first order coefficient for the second order polynomial. More...
 
double coeff2
 
QString label
 An identifying label for the calibration profile. More...
 
QString report
 a calibration report More...
 
QDate lastUpdated
 the date on which the rotor was calibrated More...
 
double omega2t
 the cumulative force exerted on the rotor More...
 

Detailed Description

the RotorCalibration class describes a calibration experiment and associated data

Definition at line 168 of file us_rotor.h.

Constructor & Destructor Documentation

US_Rotor::RotorCalibration::RotorCalibration ( )

Generic constructor for the RotorCalibration class.

Definition at line 971 of file us_rotor.cpp.

Member Function Documentation

int US_Rotor::RotorCalibration::deleteCalibrationDB ( int  calibrationID,
US_DB2 db = 0 
)
static

Function to delete the specified rotor calibration from the DB.

Parameters
calibrationIDThe database calibrationID of the rotor calibration to delete
dbFor database access, an open database connection

Definition at line 1033 of file us_rotor.cpp.

US_Rotor::Status US_Rotor::RotorCalibration::readDB ( int  calibrationID,
US_DB2 db = 0 
)

Function to read an entire rotor calibration structure from the DB.

Parameters
calibrationIDThe database rotorCalibrationID of the desired calibration
dbFor database access, an open database connection

Definition at line 997 of file us_rotor.cpp.

US_Rotor::Status US_Rotor::RotorCalibration::readDisk ( const int &  id)

A function to read information about a rotor calibration from disk.

Parameters
idA reference to the id that identifies the rotor

Definition at line 1161 of file us_rotor.cpp.

void US_Rotor::RotorCalibration::readReport ( QXmlStreamReader &  xml)

A function to read the report part of the rotor calibration from disk.

Definition at line 1225 of file us_rotor.cpp.

int US_Rotor::RotorCalibration::replaceDummyDB ( int &  oldCalibrationID,
US_DB2 db = 0 
)

Function to find the dummy calibration for the current rotor in the DB, and to replace it in all experiments with this one if it exists. Most likely it is the single calibration experiment that generated the dummy calibration in the first place.

Parameters
oldCalibrationIDReturns the database ID of the old dummy calibration here
dbFor database access, an open database connection

Definition at line 1046 of file us_rotor.cpp.

void US_Rotor::RotorCalibration::reset ( void  )

Resets the class variables to their default vaules.

Definition at line 1244 of file us_rotor.cpp.

int US_Rotor::RotorCalibration::saveDB ( int  rotorID,
US_DB2 db = 0 
)

Function to save the current calibration in the DB.

Parameters
rotorIDThe ID of the rotor this calibration is associated with
dbFor database access, an open database connection

Definition at line 976 of file us_rotor.cpp.

void US_Rotor::RotorCalibration::saveDisk ( void  )

Method to save the current rotor calibration to disk.

Definition at line 1101 of file us_rotor.cpp.

void US_Rotor::RotorCalibration::show ( void  )

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

Definition at line 1257 of file us_rotor.cpp.

Member Data Documentation

QString US_Rotor::RotorCalibration::calibrationExperimentGUID

The GUID of the experiment that contains the calibration data.

Definition at line 176 of file us_rotor.h.

int US_Rotor::RotorCalibration::calibrationExperimentID

The ID of the experiment that contains the calibration data.

Definition at line 175 of file us_rotor.h.

double US_Rotor::RotorCalibration::coeff1

The first order coefficient for the second order polynomial.

Definition at line 177 of file us_rotor.h.

double US_Rotor::RotorCalibration::coeff2
       The second order coefficient for the second order polynomial

the zeroth order coefficient is always zero (no stretch at 0 RPM)

Definition at line 178 of file us_rotor.h.

QString US_Rotor::RotorCalibration::GUID

The GUID of this calibration.

Definition at line 172 of file us_rotor.h.

int US_Rotor::RotorCalibration::ID

The ID of this calibration.

Definition at line 171 of file us_rotor.h.

QString US_Rotor::RotorCalibration::label

An identifying label for the calibration profile.

Definition at line 180 of file us_rotor.h.

QDate US_Rotor::RotorCalibration::lastUpdated

the date on which the rotor was calibrated

Definition at line 182 of file us_rotor.h.

double US_Rotor::RotorCalibration::omega2t

the cumulative force exerted on the rotor

Definition at line 183 of file us_rotor.h.

QString US_Rotor::RotorCalibration::report

a calibration report

Definition at line 181 of file us_rotor.h.

QString US_Rotor::RotorCalibration::rotorGUID

The GUID of the rotor this calibration is associated with.

Definition at line 174 of file us_rotor.h.

int US_Rotor::RotorCalibration::rotorID

The ID of the rotor this calibration is associated with.

Definition at line 173 of file us_rotor.h.


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