Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Data Structures | File List | Namespace Members | Data Fields | Related Pages

SctData::TestResult Class Reference

This class is the Abstract Base Class for all TestResults. More...

#include <TestResult.h>

Inheritance diagram for SctData::TestResult:

Inheritance graph
[legend]
Collaboration diagram for SctData::TestResult:

Collaboration graph
[legend]

Public Member Functions

 ~TestResult () throw ()
 Constructor is in protected.

virtual string getUniqueID () const throw (LogicError)
 Serializable override
Exceptions:
LogicError if TestResult is empty.


unsigned int getRunNumber () const throw ()
 the run number

void setRunNumber (unsigned int runNumber) throw ()
string getModuleName () const throw ()
 the module name

void setModuleName (string name) throw ()
const ConfigurationVariable & getScanVariable () const throw ()
 Get the configuration variable associated with all the scans in this test.

void setScanVariable (const ConfigurationVariable &scanVariable) throw ()
virtual const ResultHeader & getHeader () const
 Gets the header.

virtual ResultHeader & getHeader ()
 Gets the header.

const ConfigurationVariable & getTestVariable () const throw ()
 Get the configuration variable associated with this test.

void setTestVariable (const ConfigurationVariable &testVariable) throw ()
unsigned getScanNumberAt (unsigned int i) const throw (LogicError)
 gets the scan number at a particular postition `i' within the data.

double getTestPointAt (unsigned int i) const throw (LogicError)
 gets the test point at a particular position `i' within the data.

const DefectList & getDefects () const throw ()
 Get the defects found in the TestResult.

DefectList & getDefects () throw ()
bool getPassed () const throw ()
 Return true if the module passed the Test.

void setPassed (bool passed) throw ()
 Set whether the module passed the scan.

bool getProblem () const throw ()
 Return true if the module had a problem.

void setProblem (bool problem) throw ()
 Set whether the module had a problem.

vector< string > getComments () const throw ()
 Return all the comments.

void addComment (string comment) throw ()
 Add a comment - must be a single line (no newlines).

virtual void addScan (const unsigned int scanNumber, const double testPoint) throw (LogicError)
 Add a scan to this test.

const unsigned int getNScans () const throw ()
unsigned int getIndex (const unsigned int scanNumber) const throw (LogicError)
 Find the index for a particular scanNumber.

shared_ptr< const DcsData > getDcsData () const
 Get DcsData pointer.

void setDcsData (boost::shared_ptr< const DcsData > dcs)
 Set the DcsData object.


Protected Member Functions

 TestResult () throw ()
 Default constructor.

 TestResult (const unsigned int runNumber, const string &moduleName, const ConfigurationVariable &testVariable, const ConfigurationVariable &scanVariable) throw ()
 Create a TestResult from all the stuff needed to initialize it.


Protected Attributes

vector< ScanData > data
ResultHeader header
 The header.

const ConfigurationVariable * testVariable
 The test variable.

DefectList defects
 The Defects found in producing this TestResult.

bool passed
 True if the module passed the Test.

bool problem
 True if there was a problem with the Module.

vector< string > comments
 Comments.

boost::shared_ptr< const DcsData > m_dcsData
 Dcs Data if available.

Detailed Description

This class is the Abstract Base Class for all TestResults.

Examples are Response Curves, Trim Range Tests and StrobeDelay Test. It provides useful data and functions to the sub-classes. For instance, identifying information such as the list of scan numbers, the run number, module name and the test points.

Author:
Matthew Palmer
Date:
12 March 2003

Definition at line 31 of file TestResult.h.

Constructor & Destructor Documentation

SctData::TestResult::~TestResult (   )  throw () [inline]
 

Constructor is in protected.

Definition at line 34 of file TestResult.h.

SctData::TestResult::TestResult (   )  throw () [protected]
 

Default constructor.

Definition at line 27 of file TestResult.cpp.

SctData::TestResult::TestResult (  const unsigned int  runNumber,
const string &  moduleName,
const ConfigurationVariable &  testVariable,
const ConfigurationVariable &  scanVariable
)  throw () [protected]
 

Create a TestResult from all the stuff needed to initialize it.

Definition at line 20 of file TestResult.cpp.

Member Function Documentation

void SctData::TestResult::addComment (  string  comment  )  throw ()
 

Add a comment - must be a single line (no newlines).

Definition at line 99 of file TestResult.cpp.

Referenced by SctData::IO::TestResultStreamer_v3::read(), and SctData::IO::TestResultStreamer_v1::read().

void SctData::TestResult::addScan (  const unsigned int  scanNumber,
const double  testPoint
)  throw (LogicError) [virtual]
 

Add a scan to this test.

Reimplemented in SctData::SingleVariableTestResult.

Definition at line 103 of file TestResult.cpp.

Referenced by SctData::IO::TestResultStreamer_v3::read(), and SctData::IO::TestResultStreamer_v1::read().

vector< string > SctData::TestResult::getComments (   )  const throw ()
 

Return all the comments.

Definition at line 95 of file TestResult.cpp.

Referenced by SctData::IO::TestResultStreamer_v3::write(), and SctData::IO::TestResultStreamer_v1::write().

boost::shared_ptr< const DcsData > SctData::TestResult::getDcsData (   )  const
 

Get DcsData pointer.

Null if none available.

Definition at line 166 of file TestResult.cpp.

References m_dcsData.

Referenced by SctData::IO::TestResultStreamer_v3::write().

const DefectList & SctData::TestResult::getDefects (   )  const throw ()
 

Get the defects found in the TestResult.

Returns:
The DefectList class representing all the defects found in this TestResult.

Definition at line 55 of file TestResult.cpp.

Referenced by SctAnalysis::StrobeDelayAlgorithm::analyze(), SctCalibrationController::ConfigUpdater::maskChannels(), SctAnalysis::NPtGainAlgorithm::mergeDefects(), SctData::IO::TestResultStreamer_v3::read(), SctData::IO::TestResultStreamer_v1::read(), SctData::IO::TestResultStreamer_v3::write(), SctData::IO::TestResultStreamer_v1::write(), SctData::TestSummary::StrobeDelaySummaryWriter::write(), SctData::TestSummary::RxThresholdSummaryWriter::write(), SctData::TestSummary::RxDelaySummaryWriter::write(), and SctData::TestSummary::NPtGainSummaryWriter::write().

ResultHeader & SctData::TestResult::getHeader (   )  [virtual]
 

Gets the header.

Note:
Nothrow

Implements SctData::Result.

Definition at line 35 of file TestResult.cpp.

References header.

const ResultHeader & SctData::TestResult::getHeader (   )  const [virtual]
 

Gets the header.

Note:
Nothrow

Implements SctData::Result.

Definition at line 31 of file TestResult.cpp.

References header.

Referenced by SctData::IO::TestResultStreamer_v3::read(), SctData::IO::TestResultStreamer_v1::read(), SctData::IO::TestResultStreamer_v3::write(), and SctData::IO::TestResultStreamer_v1::write().

unsigned int SctData::TestResult::getIndex (  const unsigned int  scanNumber  )  const throw (LogicError)
 

Find the index for a particular scanNumber.

Exceptions:
LogicError if not found.

Definition at line 130 of file TestResult.cpp.

string SctData::TestResult::getModuleName (   )  const throw ()
 

the module name

Definition at line 47 of file TestResult.cpp.

Referenced by SctDataDisplay::TestDisplayer::displayAllRaws(), and SctCalibrationController::ConfigUpdater::getMID().

const unsigned int SctData::TestResult::getNScans (   )  const throw () [inline]
 

Returns:
the number of scans in this test.

Definition at line 133 of file TestResult.h.

Referenced by SctDataDisplay::TestDisplayer::displayAllRaws(), SctData::IO::TestResultStreamer_v3::write(), SctData::IO::TestResultStreamer_v1::write(), SctData::TestSummary::NPtGainSummaryWriter::write(), and SctData::TestSummary::FullBypassSummaryWriter::write().

bool SctData::TestResult::getPassed (   )  const throw ()
 

Return true if the module passed the Test.

Definition at line 79 of file TestResult.cpp.

Referenced by SctCalibrationController::ConfigUpdaterManager::update(), SctData::IO::TestResultStreamer_v3::write(), and SctData::IO::TestResultStreamer_v1::write().

bool SctData::TestResult::getProblem (   )  const throw ()
 

Return true if the module had a problem.

Definition at line 87 of file TestResult.cpp.

Referenced by SctData::IO::TestResultStreamer_v3::write(), and SctData::IO::TestResultStreamer_v1::write().

unsigned int SctData::TestResult::getRunNumber (   )  const throw ()
 

the run number

Definition at line 39 of file TestResult.cpp.

References SctData::ResultHeader::getRunNumber().

Referenced by SctDataDisplay::TestDisplayer::displayAllRaws().

Here is the call graph for this function:

unsigned SctData::TestResult::getScanNumberAt (  unsigned int  i  )  const throw (LogicError)
 

gets the scan number at a particular postition `i' within the data.

Definition at line 118 of file TestResult.cpp.

Referenced by SctDataDisplay::TestDisplayer::displayAllRaws(), SctData::IO::TestResultStreamer_v3::write(), and SctData::IO::TestResultStreamer_v1::write().

const ConfigurationVariable & SctData::TestResult::getScanVariable (   )  const throw ()
 

Get the configuration variable associated with all the scans in this test.

Definition at line 63 of file TestResult.cpp.

double SctData::TestResult::getTestPointAt (  unsigned int  i  )  const throw (LogicError)
 

gets the test point at a particular position `i' within the data.

Definition at line 124 of file TestResult.cpp.

Referenced by SctData::NPtGainTestResult::getSpecialScanPointValue(), SctData::IO::TestResultStreamer_v3::write(), SctData::IO::TestResultStreamer_v1::write(), and SctData::TestSummary::FullBypassSummaryWriter::write().

const ConfigurationVariable & SctData::TestResult::getTestVariable (   )  const throw ()
 

Get the configuration variable associated with this test.

Definition at line 71 of file TestResult.cpp.

Referenced by SctData::IO::TestResultStreamer_v3::write(), and SctData::IO::TestResultStreamer_v1::write().

string SctData::TestResult::getUniqueID (   )  const throw (LogicError) [virtual]
 

Serializable override

Exceptions:
LogicError if TestResult is empty.

Implements Sct::Serializable.

Definition at line 111 of file TestResult.cpp.

Referenced by SctDataDisplay::TestDisplayer::displayAllRaws(), and SctCalibrationController::ConfigUpdaterManager::update().

void SctData::TestResult::setDcsData (  boost::shared_ptr< const DcsData >  dcs  ) 
 

Set the DcsData object.

Definition at line 162 of file TestResult.cpp.

References m_dcsData.

Referenced by SctData::IO::TestResultStreamer_v3::read().

void SctData::TestResult::setPassed (  bool  passed  )  throw ()
 

Set whether the module passed the scan.

Definition at line 83 of file TestResult.cpp.

Referenced by SctAnalysis::StrobeDelayAlgorithm::analyze(), SctAnalysis::RxThresholdAlgorithm::analyze(), SctAnalysis::RxDelayAlgorithm::analyze(), SctData::IO::TestResultStreamer_v3::read(), and SctData::IO::TestResultStreamer_v1::read().

void SctData::TestResult::setProblem (  bool  problem  )  throw ()
 

Set whether the module had a problem.

Definition at line 91 of file TestResult.cpp.

Referenced by SctData::IO::TestResultStreamer_v3::read(), and SctData::IO::TestResultStreamer_v1::read().

Field Documentation

vector<string> SctData::TestResult::comments [protected]
 

Comments.

Definition at line 193 of file TestResult.h.

DefectList SctData::TestResult::defects [protected]
 

The Defects found in producing this TestResult.

Definition at line 190 of file TestResult.h.

ResultHeader SctData::TestResult::header [protected]
 

The header.

Definition at line 188 of file TestResult.h.

Referenced by getHeader().

boost::shared_ptr<const DcsData> SctData::TestResult::m_dcsData [protected]
 

Dcs Data if available.

Definition at line 194 of file TestResult.h.

Referenced by getDcsData(), and setDcsData().

bool SctData::TestResult::passed [protected]
 

True if the module passed the Test.

Definition at line 191 of file TestResult.h.

bool SctData::TestResult::problem [protected]
 

True if there was a problem with the Module.

Definition at line 192 of file TestResult.h.

const ConfigurationVariable* SctData::TestResult::testVariable [protected]
 

The test variable.

Definition at line 189 of file TestResult.h.

The documentation for this class was generated from the following files:
Generated on Thu Jul 15 09:53:02 2004 for SCT DAQ/DCS Software - C++ by doxygen 1.3.5