UltraScan III
List of all members | Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Static Private Member Functions
US_Ramp Class Reference

#include "us_ramp.h"

Classes

class  TripleInfo
 Class that contains information about relevant cell/channel/wavelength combinations. More...
 

Public Types

enum  ioError {
  OK, CANTOPEN, DUP_RUNID, NOPERSON,
  NODATA, NODB, NOAUC, NOXML,
  BADXML, BADGUID, PARTIAL_XML, NOT_WRITTEN
}
 Some status codes returned by the us_convert program. More...
 

Public Member Functions

 US_Ramp ()
 

Static Public Member Functions

static int saveToDisk (QVector< US_mwlRamp::RampRawData * > &, QList< TripleInfo > &, QString, QString, QString, bool)
 Generic constructor for the US_Convert class. This constructor establishes the dialog and its relationship to the parent dialog. More...
 
static int writeRawData (QString file, US_mwlRamp::RampRawData &data)
 Writes one cellchan combo to one .ramp file. More...
 
static int readUS3Disk (QString dir, QVector< US_mwlRamp::RampRawData > &rawConvertedData, QList< TripleInfo > &cellchans, QString &runType)
 Reads a saved Ramp run from US3 Disk. More...
 
static int readRawData (const QString file, US_mwlRamp::RampRawData &data)
 Reads one cellchan combo from a .ramp file. More...
 

Static Public Attributes

static const uint format_version = 1
 

Static Private Member Functions

static int setTriples (QList< US_DataIO::BeckmanRawScan > &rawLegacyData, QList< TripleInfo > &triples, QString runType, double tolerance)
 
static void setCcwTriples (QList< US_DataIO::BeckmanRawScan > &rawLegacyData, QList< TripleInfo > &triples, double tolerance)
 
static void setCcrTriples (QList< US_DataIO::BeckmanRawScan > &rawLegacyData, QList< TripleInfo > &triples, double tolerance)
 
static void setInterpolated (unsigned char *, int)
 
static void write (QDataStream &, const char *, int, quint32 &)
 
static void read (QDataStream &, char *, int, quint32 &)
 

Detailed Description

This class provides the ability to convert raw ramp data to the file format used by US3 for ramp data.

Definition at line 15 of file us_ramp.h.

Member Enumeration Documentation

Some status codes returned by the us_convert program.

Enumerator
OK 

Ok, no error.

CANTOPEN 

The file cannot be opened.

DUP_RUNID 

The given run ID already exists.

NOPERSON 

The person specified doesn't exist.

NODATA 

There is no data to read or write.

NODB 

Connection to database cannot be made.

NOAUC 

AUC File cannot be opened.

NOXML 

XML data has not been entered.

BADXML 

XML not formed correctly.

BADGUID 

GUID read in the XML was not found in the database.

PARTIAL_XML 

XML data has not been entered for all c/c/w combos.

NOT_WRITTEN 

Data was not written.

Definition at line 26 of file us_ramp.h.

Constructor & Destructor Documentation

US_Ramp::US_Ramp ( )

Definition at line 20 of file us_ramp.cpp.

Member Function Documentation

void US_Ramp::read ( QDataStream &  ds,
char *  cc,
int  len,
quint32 &  crc 
)
staticprivate

Definition at line 768 of file us_ramp.cpp.

int US_Ramp::readRawData ( const QString  file,
US_mwlRamp::RampRawData data 
)
static

Reads one cellchan combo from a .ramp file.

Definition at line 338 of file us_ramp.cpp.

int US_Ramp::readUS3Disk ( QString  dir,
QVector< US_mwlRamp::RampRawData > &  rawConvertedData,
QList< TripleInfo > &  cellchans,
QString &  runType 
)
static

Reads a saved Ramp run from US3 Disk.

Definition at line 277 of file us_ramp.cpp.

int US_Ramp::saveToDisk ( QVector< US_mwlRamp::RampRawData * > &  rawConvertedData,
QList< TripleInfo > &  all_chaninfo,
QString  runType,
QString  runID,
QString  dirname,
bool  saveGUIDs 
)
static

Generic constructor for the US_Convert class. This constructor establishes the dialog and its relationship to the parent dialog.

Writes the converted US3 data to disk.

Parameters
rawConvertedDataA reference to a structure provided by the calling function that already contains the US3 raw converted data.
all_chaninfoA reference to a structure provided by the calling function that already contains all the different cell/channel/wavelength combinations in the data.
runTypeA 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.
runIDThe run ID of the experiment.
dirnameDirectory in which files are to be written.
saveGUIDsBoolean value that indicates whether data has been saved to disk before and doesn't require new GUIDs
Returns
One of the ioError status codes, above

Definition at line 28 of file us_ramp.cpp.

static void US_Ramp::setCcrTriples ( QList< US_DataIO::BeckmanRawScan > &  rawLegacyData,
QList< TripleInfo > &  triples,
double  tolerance 
)
staticprivate
static void US_Ramp::setCcwTriples ( QList< US_DataIO::BeckmanRawScan > &  rawLegacyData,
QList< TripleInfo > &  triples,
double  tolerance 
)
staticprivate
static void US_Ramp::setInterpolated ( unsigned char *  ,
int   
)
staticprivate
static int US_Ramp::setTriples ( QList< US_DataIO::BeckmanRawScan > &  rawLegacyData,
QList< TripleInfo > &  triples,
QString  runType,
double  tolerance 
)
staticprivate
void US_Ramp::write ( QDataStream &  ds,
const char *  c,
int  len,
quint32 &  crc 
)
staticprivate

Definition at line 762 of file us_ramp.cpp.

int US_Ramp::writeRawData ( QString  file,
US_mwlRamp::RampRawData data 
)
static

Writes one cellchan combo to one .ramp file.

Definition at line 103 of file us_ramp.cpp.

Member Data Documentation

const uint US_Ramp::format_version = 1
static

A constant value that identifies the format of the auc raw data. Internal programs use this value to determine if the format of the file is known.

Definition at line 21 of file us_ramp.h.


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