SctData::TestResult Class Reference

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

#include <TestResult.h>

Inheritance diagram for SctData::TestResult:

[legend]Collaboration diagram for SctData::TestResult:

[legend]


Public Member Functions
	~TestResult () throw ()
	Constructor is in protected.
virtual Sct::UniqueID	getUniqueID () const throw (LogicError)
	Serializable override.
unsigned int	getRunNumber () const throw ()
void	setRunNumber (unsigned int runNumber) throw ()
string	getModuleName () const throw ()
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.
shared_ptr< const OpeResult >	getOpeResult () const
	get the OpeResult if there is one.
void	setOpeResult (boost::shared_ptr< const OpeResult > ope)
	Set the OpeResult;.
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
	vector of scanData (internal to this class) objects: one for each scan in the Test. 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.
boost::shared_ptr< const OpeResult >	m_opeResult
	Dcs Data if available.
Data Structures
class	ScanData
	small internal class contains all the data relevant to a particular scan. More...

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 28 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 21 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 100 of file TestResult.cpp.
Referenced by SctAnalysis::StrobeDelayAlgorithm::analyze(), and SctAnalysis::ChipCounterAlgorithm::analyze().

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 104 of file TestResult.cpp.
Referenced by SctData::SingleVariableTestResult::addScan(), SctData::NoiseOccupancyTestResult::addScan(), SctData::IO::TestResultStreamer_v4::read(), 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 96 of file TestResult.cpp.
References comments.

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

Get DcsData pointer.
Null if none available.
Definition at line 167 of file TestResult.cpp.
References m_dcsData.

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 56 of file TestResult.cpp.
References defects.
Referenced by SctAnalysis::StrobeDelayAlgorithm::analyze(), PipelineCompare::compare(), SctAnalysis::NPtGainAlgorithm::doSlopes(), SctCalibrationController::ConfigUpdater::maskChannels(), SctAnalysis::NPtGainAlgorithm::mergeDefects(), and SctData::ISTestSummary::ISNPtGainSummaryWriter::write().

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

Gets the header.

Note:
Nothrow

Implements SctData::Result.
Definition at line 36 of file TestResult.cpp.
References header.

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

Gets the header.

Note:
Nothrow

Implements SctData::Result.
Definition at line 32 of file TestResult.cpp.
References header.
Referenced by NoiseOccupancyCompare::compare(), getModuleName(), getRunNumber(), getScanVariable(), getUniqueID(), SctData::IO::TestResultStreamer_v4::read(), SctData::IO::TestResultStreamer_v3::read(), SctData::IO::TestResultStreamer_v1::read(), SctData::IO::TestResultStreamer_v4::write(), 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 131 of file TestResult.cpp.

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

Returns:
the module name

Definition at line 48 of file TestResult.cpp.
References getHeader(), and SctData::ResultHeader::getModuleName().
Referenced by TimeWalkCompare::compare(), StrobeDelayCompare::compare(), PipelineCompare::compare(), NoiseOccupancyCompare::compare(), FullBypassCompare::compare(), TrimRangeCompare::compareChannel(), TrimRangeCompare::compareChip(), NPtGainCompare::compareChip(), SctDataDisplay::TestDisplayer::displayAllRaws(), SctCalibrationController::ConfigUpdater::getMID(), SctCalibrationController::TxCurrentConfigUpdater::update(), SctCalibrationController::RxThresholdBasedOnConfigRegisterConfigUpdater::update(), SctCalibrationController::NPtGainConfigUpdater::update(), and SctData::ISTestSummary::ISSummaryWriter::writeHeader().
Here is the call graph for this function:

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.
References data.
Referenced by SctAnalysis::MarkSpaceRatioAlgorithm::analyze(), TimeWalkCompare::compare(), StrobeDelayCompare::compare(), PipelineCompare::compare(), NoiseOccupancyCompare::compare(), FullBypassCompare::compare(), TrimRangeCompare::compareChannel(), TrimRangeCompare::compareChip(), NPtGainCompare::compareChip(), SctDataDisplay::TestDisplayer::displayAllRaws(), SctCalibrationController::NPtGainConfigUpdater::update(), SctData::IO::TestResultStreamer_v4::write(), SctData::IO::TestResultStreamer_v3::write(), SctData::IO::TestResultStreamer_v1::write(), SctData::TestSummary::NPtGainSummaryWriter::write(), and SctData::TestSummary::FullBypassSummaryWriter::write().

boost::shared_ptr< const OpeResult > SctData::TestResult::getOpeResult ( ) const

get the OpeResult if there is one.
Otherwise null
Definition at line 175 of file TestResult.cpp.
References m_opeResult.

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

Return true if the module passed the Test.

Definition at line 80 of file TestResult.cpp.
References passed.
Referenced by TimeWalkCompare::compare(), StrobeDelayCompare::compare(), PipelineCompare::compare(), NoiseOccupancyCompare::compare(), FullBypassCompare::compare(), TrimRangeCompare::compareChip(), NPtGainCompare::compareChip(), and SctCalibrationController::ConfigUpdaterManager::update().

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

Return true if the module had a problem.

Definition at line 88 of file TestResult.cpp.
References problem.
Referenced by TrimRangeCompare::compareChip().

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

Returns:
the run number

Definition at line 40 of file TestResult.cpp.
References getHeader(), and SctData::ResultHeader::getRunNumber().
Referenced by TimeWalkCompare::compare(), StrobeDelayCompare::compare(), PipelineCompare::compare(), NoiseOccupancyCompare::compare(), FullBypassCompare::compare(), TrimRangeCompare::compareChannel(), TrimRangeCompare::compareChip(), NPtGainCompare::compareChip(), SctDataDisplay::TestDisplayer::displayAllRaws(), and SctData::ISTestSummary::ISSummaryWriter::writeHeader().
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 119 of file TestResult.cpp.
Referenced by TimeWalkCompare::compare(), StrobeDelayCompare::compare(), PipelineCompare::compare(), NoiseOccupancyCompare::compare(), FullBypassCompare::compare(), TrimRangeCompare::compareChannel(), TrimRangeCompare::compareChip(), NPtGainCompare::compareChip(), SctDataDisplay::TestDisplayer::displayAllRaws(), SctData::IO::TestResultStreamer_v4::write(), SctData::IO::TestResultStreamer_v3::write(), SctData::IO::TestResultStreamer_v1::write(), and SctData::ISTestSummary::ISSummaryWriter::writeHeader().

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

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

Definition at line 64 of file TestResult.cpp.
References getHeader(), and SctData::ResultHeader::getVariable().
Here is the call graph for this function:

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 125 of file TestResult.cpp.
Referenced by SctAnalysis::MarkSpaceRatioAlgorithm::analyze(), SctData::NPtGainTestResult::getSpecialScanPointValue(), SctData::IO::TestResultStreamer_v4::write(), 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 72 of file TestResult.cpp.
References testVariable.
Referenced by SctData::IO::TestResultStreamer_v4::write(), SctData::IO::TestResultStreamer_v3::write(), and SctData::IO::TestResultStreamer_v1::write().

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

Serializable override.

Exceptions:

LogicError if TestResult is empty.

Implements Sct::Serializable.
Definition at line 112 of file TestResult.cpp.
References data, getHeader(), and SctData::ResultHeader::getUniqueID().
Referenced by SctDataDisplay::TestDisplayer::displayAllRaws().
Here is the call graph for this function:

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

Set the DcsData object.

Definition at line 163 of file TestResult.cpp.
References m_dcsData.

void SctData::TestResult::setOpeResult ( boost::shared_ptr< const OpeResult > ope )

Set the OpeResult;.

Definition at line 171 of file TestResult.cpp.
References m_opeResult.

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

Set whether the module passed the scan.

Definition at line 84 of file TestResult.cpp.
Referenced by SctAnalysis::ChipCounterAlgorithm::analyze().

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

Set whether the module had a problem.

Definition at line 92 of file TestResult.cpp.

Field Documentation

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

Comments.

Definition at line 201 of file TestResult.h.
Referenced by getComments().

DefectList SctData::TestResult::defects [protected]

The Defects found in producing this TestResult.

Definition at line 198 of file TestResult.h.
Referenced by getDefects().

ResultHeader SctData::TestResult::header [protected]

vector of scanData (internal to this class) objects: one for each scan in the Test. The header

Definition at line 196 of file TestResult.h.
Referenced by getHeader().

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

Dcs Data if available.

Definition at line 202 of file TestResult.h.
Referenced by getDcsData(), and setDcsData().

boost::shared_ptr<const OpeResult> SctData::TestResult::m_opeResult [protected]

Dcs Data if available.

Definition at line 203 of file TestResult.h.
Referenced by getOpeResult(), and setOpeResult().

bool SctData::TestResult::passed [protected]

True if the module passed the Test.

Definition at line 199 of file TestResult.h.
Referenced by getPassed().

bool SctData::TestResult::problem [protected]

True if there was a problem with the Module.

Definition at line 200 of file TestResult.h.
Referenced by getProblem().

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

The test variable.

Definition at line 197 of file TestResult.h.
Referenced by getTestVariable().

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

Generated on Mon Feb 6 14:07:58 2006 for SCT DAQ/DCS Software - C++ by

1.4.6

SctData::TestResult Class Reference

Public Member Functions

Protected Member Functions

Protected Attributes

Data Structures

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation