---

SctCalibrationController::Test Class Reference

This a record of each Test that is done. More...

#include <Test.h>

Public Member Functions
	Test (const TestData &data)
	Construct a Test.
	~Test ()
	Removes the TestData object from IS.
void	addScan (Sct_SctApi_T_Scan *scan)
	Adds a Scan to this Test.
const TestData &	getData () const
	Get access to the underlying TestData.
void	setStatus (TestData::status_E status)
	Set the status of this Test - see TestData.
string	getUniqueID () const
	Returns a uniqueID for this Test - used for the name in IS.
Sct_SctApi_T_Scan *	getScan (unsigned int index) const
	Retrieve one of the constituent Scans Exceptions: InvalidArgumentError  if index is too large.
Private Types
typedef vector< Sct_SctApi_T_Scan * >	ScanVector
	A vector of Scans!
Private Member Functions
void	publish ()
	Publish or update the TestData object in IS.
void	withdraw ()
	Remove the TestData object from IS.
Private Attributes
TestData	data
	Most of the underlying data.
ScanVector	scans
	The constituent Scans.

---

Detailed Description

This a record of each Test that is done.

It contains references to the Scans that made it up and also the TestData object that is available in IS.

Definition at line 22 of file Test.h.

---

Member Typedef Documentation

typedef vector<Sct_SctApi_T_Scan*> SctCalibrationController::Test::ScanVector [private]

A vector of Scans! Definition at line 84 of file Test.h.

---

Constructor & Destructor Documentation

SctCalibrationController::Test::Test (  const TestData &    data )

Construct a Test. Puts data into IS. Parameters: data  the TestData that defines this Test Exceptions: InvalidArgumentError  if data is not consistent. Definition at line 12 of file Test.cpp. References data, getUniqueID(), TestData::nScans, publish(), TestData::testPoints, and TestData::testPoints_size.

SctCalibrationController::Test::~Test (    )

Removes the TestData object from IS. Definition at line 25 of file Test.cpp. References withdraw().

---

Member Function Documentation

void SctCalibrationController::Test::addScan (  Sct_SctApi_T_Scan *    scan )

Adds a Scan to this Test. You may only add the correct number of Scans. Parameters: scan  the Scan to add. Exceptions: InvalidArgumentError  if too many Scans are added Definition at line 29 of file Test.cpp. References data, getUniqueID(), TestData::nScans, and scans.

const TestData & SctCalibrationController::Test::getData (    )  const

Get access to the underlying TestData. Definition at line 35 of file Test.cpp. References data.

Sct_SctApi_T_Scan * SctCalibrationController::Test::getScan (  unsigned int    index )  const

Retrieve one of the constituent Scans Exceptions: InvalidArgumentError  if index is too large. Definition at line 45 of file Test.cpp. References getUniqueID(), and scans.

string SctCalibrationController::Test::getUniqueID (    )  const

Returns a uniqueID for this Test - used for the name in IS. Definition at line 39 of file Test.cpp. References data, TestData::runNumber, and TestData::startScanNumber. Referenced by addScan(), getScan(), publish(), setStatus(), Test(), and withdraw().

void SctCalibrationController::Test::publish (    )  [private]

Publish or update the TestData object in IS. Won't throw - just reports errors Definition at line 69 of file Test.cpp. References data, and getUniqueID(). Referenced by setStatus(), and Test().

void SctCalibrationController::Test::setStatus (  TestData::status_E    status )

Set the status of this Test - see TestData. A Test may only have the COMPLETED state if all the Scans have been added. Once a Test has entered the ABORTED or COMPLETED states, it cannot be changed. Exceptions: InvalidArgumentError  if not enough Scans have been added or if the status is currently ABORTED or COMPLETED and status is not ABORTED or COMPLETED respectively. Definition at line 54 of file Test.cpp. References TestData::ABORTED, TestData::COMPLETED, data, TestData::EXECUTING, getUniqueID(), TestData::nScans, publish(), scans, and TestData::status.

void SctCalibrationController::Test::withdraw (    )  [private]

Remove the TestData object from IS. Won't throw - just reports errors Definition at line 88 of file Test.cpp. References getUniqueID(). Referenced by ~Test().

---

Field Documentation

TestData SctCalibrationController::Test::data [private]

Most of the underlying data. Definition at line 83 of file Test.h. Referenced by addScan(), getData(), getUniqueID(), publish(), setStatus(), and Test().

ScanVector SctCalibrationController::Test::scans [private]

The constituent Scans. Definition at line 85 of file Test.h. Referenced by addScan(), getScan(), and setStatus().

---

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

• Test.h
• Test.cpp

---