SctCalibrationController::Test Class Reference

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

#include <Test.h>

Collaboration diagram for SctCalibrationController::Test:

[legend]

Public Member Functions
	Test (const TestData &data, const list< string > &list)
	Construct a Test.
	~Test ()
	Removes the TestData object from IS.
void	addScan (Sct_SctApi::Scan_ptr scan)
	Adds a Scan to this Test.
const TestData &	getData () const
	Get access to the underlying TestData.
list< string >	getModuleList () const
	Get the module list.
void	setStatus (TestData::status_E status)
	Set the status of this Test - see TestData.
void	setOptions (const std::string &options)
	set the scan options - which may not be immediatley available.
Sct::UniqueID	getUniqueID () const
	Returns a uniqueID for this Test - used for the name in IS.
Sct_SctApi::Scan_ptr	getScan (unsigned int index) const
	Retrieve one of the constituent Scans Exceptions: InvalidArgumentError  if index is too large.
Private Types
typedef vector< Sct_SctApi::Scan_var >	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 24 of file Test.h.

---

Member Typedef Documentation

typedef vector<Sct_SctApi::Scan_var> SctCalibrationController::Test::ScanVector [private]

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

---

Constructor & Destructor Documentation

SctCalibrationController::Test::Test (  const TestData &  data, const list< string > &  list )

Construct a Test. Puts data into IS. Parameters: data  the TestData that defines this Test list  the list of modules this Test is done on (for ease!) Exceptions: InvalidArgumentError  if data is not consistent. Definition at line 20 of file Test.cpp. References data, getUniqueID(), TestData::nScans, TestData::testPoints, and TestData::testPoints_size. Here is the call graph for this function:

SctCalibrationController::Test::~Test (   )

Removes the TestData object from IS. Definition at line 45 of file Test.cpp. References withdraw(). Here is the call graph for this function:

---

Member Function Documentation

void SctCalibrationController::Test::addScan (  Sct_SctApi::Scan_ptr  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 49 of file Test.cpp. References data, getUniqueID(), TestData::nScans, and scans. Here is the call graph for this function:

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

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

list< string > SctCalibrationController::Test::getModuleList (   )  const

Get the module list. Note: Nothrow Definition at line 76 of file Test.cpp. References data, TestData::modules, and TestData::modules_size.

Sct_SctApi::Scan_ptr SctCalibrationController::Test::getScan (  unsigned int  index  )  const

Retrieve one of the constituent Scans Exceptions: InvalidArgumentError  if index is too large. Definition at line 67 of file Test.cpp. References getUniqueID(), and scans. Here is the call graph for this function:

Sct::UniqueID SctCalibrationController::Test::getUniqueID (   )  const

Returns a uniqueID for this Test - used for the name in IS. Definition at line 59 of file Test.cpp. References data, TestData::runNumber, TestData::startScanNumber, and TestData::testName. 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 109 of file Test.cpp. References Sct::ISUtilities::addOrUpdateOrMessage(), data, and getUniqueID(). Referenced by setOptions(). Here is the call graph for this function:

void SctCalibrationController::Test::setOptions (  const std::string &  options  )

set the scan options - which may not be immediatley available. Definition at line 84 of file Test.cpp. References data, TestData::options, and publish(). Here is the call graph for this function:

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 89 of file Test.cpp. References data, getUniqueID(), TestData::nScans, scans, and TestData::status. Here is the call graph for this function:

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

Remove the TestData object from IS. Won't throw - just reports errors Definition at line 117 of file Test.cpp. References getUniqueID(), and Sct::AbstractThrowable::sendToMrs(). Referenced by ~Test(). Here is the call graph for this function:

---

Field Documentation

TestData SctCalibrationController::Test::data [private]

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

ScanVector SctCalibrationController::Test::scans [private]

The constituent Scans. Definition at line 100 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

---