US_Rotor::Rotor Class Reference

the rotor structure describes a derived 4- or 8-hole rotor More...

#include "us_rotor.h"

Public Member Functions
	Rotor ()
	Generic constructor for the Rotor class. More...
int	addRotorDB (US_DB2 *=0)
	Function to add the current rotor as a new rotor in the DB. More...
Status	readDB (int, US_DB2 *=0)
	Function to read an entire rotor structure from the DB. More...
void	saveDisk (void)
	Method to save the current rotor to disk. More...
Status	readDisk (const int &)
	A function to read information about a rotor from disk. More...
void	reset (void)
	Resets the class variables to default values. More...
void	show (void)
	Displays the contents of the class variables in qDebug() statements. More...

Static Public Member Functions
static int	deleteRotorDB (int, US_DB2 *=0)
	Function to delete the specified rotor from the DB. More...

Public Attributes
int	ID
	The database ID of this rotor. More...
int	abstractRotorID
	The ID of the rotor type. More...
QString	abstractRotorGUID
	The GUID of the rotor type. More...
int	labID
	The ID of the laboratory which owns this rotor. More...
QString	GUID
	The GUID of this rotor. More...
QString	name
	The local name of the rotor. More...
QString	serialNumber
	The serial number of the rotor. More...

Detailed Description

the rotor structure describes a derived 4- or 8-hole rotor

Definition at line 117 of file us_rotor.h.

Constructor & Destructor Documentation

US_Rotor::Rotor::Rotor

(

)

Generic constructor for the Rotor class.

Definition at line 776 of file us_rotor.cpp.

Member Function Documentation

int US_Rotor::Rotor::addRotorDB

(

US_DB2 *

db = 0

)

Function to add the current rotor as a new rotor in the DB.

Parameters

db	For database access, an open database connection

Definition at line 782 of file us_rotor.cpp.

int US_Rotor::Rotor::deleteRotorDB ( int  rotorID, US_DB2 *  db = 0  )

static

Function to delete the specified rotor from the DB.

Parameters

rotorID	The database rotorID of the rotor to delete
db	For database access, an open database connection

Definition at line 825 of file us_rotor.cpp.

US_Rotor::Status US_Rotor::Rotor::readDB	(	int	rotorID,
		US_DB2 *	db = 0
	)

Function to read an entire rotor structure from the DB.

Parameters

rotorID	The database rotorID of the desired rotor
db	For database access, an open database connection

Definition at line 798 of file us_rotor.cpp.

US_Rotor::Status US_Rotor::Rotor::readDisk

(

const int &

id

)

A function to read information about a rotor from disk.

Parameters

id	A reference to the id that identifies the rotor

Definition at line 892 of file us_rotor.cpp.

void US_Rotor::Rotor::reset

(

void

)

Resets the class variables to default values.

Definition at line 951 of file us_rotor.cpp.

void US_Rotor::Rotor::saveDisk

(

void

)

Method to save the current rotor to disk.

Definition at line 837 of file us_rotor.cpp.

void US_Rotor::Rotor::show

(

void

)

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

Definition at line 961 of file us_rotor.cpp.

Member Data Documentation

QString US_Rotor::Rotor::abstractRotorGUID

The GUID of the rotor type.

Definition at line 122 of file us_rotor.h.

int US_Rotor::Rotor::abstractRotorID

The ID of the rotor type.

Definition at line 121 of file us_rotor.h.

QString US_Rotor::Rotor::GUID

The GUID of this rotor.

Definition at line 124 of file us_rotor.h.

int US_Rotor::Rotor::ID

The database ID of this rotor.

Definition at line 120 of file us_rotor.h.

int US_Rotor::Rotor::labID

The ID of the laboratory which owns this rotor.

Definition at line 123 of file us_rotor.h.

QString US_Rotor::Rotor::name

The local name of the rotor.

Definition at line 125 of file us_rotor.h.

QString US_Rotor::Rotor::serialNumber

The serial number of the rotor.

Definition at line 126 of file us_rotor.h.

---

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

• us_rotor.h
• us_rotor.cpp