SctAnalysis::AnalysisAlgorithm Class Reference

An abstract base class for all the analysis algorithms. More...

#include <AnalysisAlgorithm.h>

Inheritance diagram for SctAnalysis::AnalysisAlgorithm:

[legend]Collaboration diagram for SctAnalysis::AnalysisAlgorithm:

[legend]

Public Member Functions
virtual	~AnalysisAlgorithm () throw ()
	Destructor.
shared_ptr< const TestData >	getTestData () const
	get a pointer to the cached TestData;
void	setTestData (shared_ptr< const TestData > testdata)
	set TestData - used for updating TestData.
const std::string	getModuleName () const throw ()
	Get the name of the module which this algorithm is working on.
virtual boost::shared_ptr< AnalysisAlgorithm >	clone (shared_ptr< const TestData > testData, const string &moduleName) const =0 throw ()
	Must be overridden by sub-classes.
void	addFitScanResult (shared_ptr< Sct::IOName > name)
	Add a named FitScanResult.
void	addRawScanResult (shared_ptr< Sct::IOName > name)
	Add a named RawScanResult.
void	checkForZeroTriggerBins ()
	mark result as problem if there are bins containing no triggers - which might suggest a ROD problem
void	checkTestResultExists ()
	Used by other methods to ensure that a TestResult has been made.
bool	isDone () const throw ()
	Method indicates when a particular analysis is finished.
void	finish ()
	Publishes the TestResult, and sets `done'.
boost::shared_ptr< SctData::TestResult >	getTestResult () const
	Access to the TestResult if required.
boost::recursive_mutex &	getMutex () const
	Access the mutex.
virtual bool	canAnalyze () const =0
	Should check to see if the analysis can be performed.
virtual void	analyze ()=0
	Does the analysis.
virtual void	loadData ()=0
	Called to indicate the algorithm should try and load as much data as it can - perhaps by calling loadAllFits or loadAllRaws().
void	setFit (unsigned index, const std::string &fit)
	Method to use only when expert re-analysing data.
void	setRaw (unsigned index, const std::string &raw)
	Method to use only when expert re-analysing data.
Status and timing methods
Note: These methods are external rather than internal so the calling method can include its overheads etc
void	addFailure ()
	Adds a pass for this test.
void	addPass ()
	Adds a failure for this test.
void	addIOTime (double ioTime)
	Adds some time spent doing I/O.
void	addAnalysisTime (double time)
	Adds to the analysis time, and increments the number of analyses successfully done.
void	addOverheadTime (double time)
	Adds to the overhead time.
string	getStatus () const
	Returns a string giving the status of this algorithm including some info how long things are taking.
Protected Member Functions
	AnalysisAlgorithm (shared_ptr< const TestData > testData, const string &moduleName, const AnalysisAlgorithm &prototype) throw ()
	Default constructor, to be used in creation of map.
virtual shared_ptr< SctData::TestResult >	createTestResult () const =0
	Called if the TestResult needs to be created.
void	loadAllFits ()
	Loads all the fits it can.
void	loadAllRaws ()
	Loads all the raws it can.
bool	hasAllRaws () const
	Returns true if all the RawScanResult objects are available in IS.
bool	hasAllFits () const
	Returns true if all the FitScanResult objects are available in IS.
shared_ptr< SctData::RawScanResult >	getRaw (unsigned int index) const
	Returns a shared pointer to the RawScanResult at index.
shared_ptr< SctData::FitScanResult >	getFit (unsigned int index) const
	Returns a shared pointer to the RawScanResult at index.
void	mergeDefects ()
	Merges all the defects from the FitScanResults into the TestResult.
	AnalysisAlgorithm ()
Private Member Functions
void	initializeTestResult ()
	Useful function that initializes TestResult from Test and module name.
Private Attributes
const string	m_modulename
	name of the module being worked on.
shared_ptr< SctData::TestResult >	m_result
	pointer to the result.
shared_ptr< const TestData >	m_test
	pointer to the testdata.
vector< ScanData >	scanData
bool	m_done
	a vector of ScanData objects true if finish() has been called.
boost::recursive_mutex	m_access
	access to the algorithm can be locked for thread-safeness.
boost::recursive_mutex	m_status_access
	access to the status information
const AnalysisAlgorithm &	prototype
	A reference to the prototype.
double	ioTime
	The total time spent doing I/O.
double	analysisTime
	The total time spent doing analysis.
double	overheadTime
	The time spent just getting stuff, checking it etc.
unsigned int	nCalls
	The number of times this alg has been accessed.
unsigned int	nAnalyses
	The number of analyses performed.
unsigned int	nPassed
	The number of tests which passed.
unsigned int	nFailed
	The number of analyses which failed.
Data Structures
class	ScanData

---

Detailed Description

An abstract base class for all the analysis algorithms.

Author:

Matthew Palmer

Date:

11 June 2003

Definition at line 33 of file AnalysisAlgorithm.h.

---

Constructor & Destructor Documentation

SctAnalysis::AnalysisAlgorithm::~AnalysisAlgorithm (   )  throw () [virtual]

Destructor. Definition at line 44 of file AnalysisAlgorithm.cpp. References m_access, and m_result.

SctAnalysis::AnalysisAlgorithm::AnalysisAlgorithm (  shared_ptr< const TestData >  testData, const string &  moduleName, const AnalysisAlgorithm &  prototype )  throw () [protected]

Default constructor, to be used in creation of map. Definition at line 37 of file AnalysisAlgorithm.cpp.

---

Member Function Documentation

void SctAnalysis::AnalysisAlgorithm::addAnalysisTime (  double  time  )  [inline]

Adds to the analysis time, and increments the number of analyses successfully done. Note: Nothrow Definition at line 276 of file AnalysisAlgorithm.h. References analysisTime, m_status_access, nAnalyses, and prototype.

void SctAnalysis::AnalysisAlgorithm::addFailure (   )  [inline]

Adds a pass for this test. Definition at line 266 of file AnalysisAlgorithm.h. References m_status_access, nFailed, and prototype. Referenced by finish().

void SctAnalysis::AnalysisAlgorithm::addFitScanResult (  shared_ptr< Sct::IOName >  name  )

Add a named FitScanResult. Parameters: name  the IS name of the FitScanResult. Exceptions: LogicError  if name does not belong in this algorithm

void SctAnalysis::AnalysisAlgorithm::addIOTime (  double  ioTime  )  [inline]

Adds some time spent doing I/O. The number of IO operations is assumed to be the same as the number of analyses Note: Nothrow Definition at line 271 of file AnalysisAlgorithm.h. References ioTime, m_status_access, and prototype.

void SctAnalysis::AnalysisAlgorithm::addOverheadTime (  double  time  )  [inline]

Adds to the overhead time. It is assumed there is 1 overhead time per Fit or Raw ScanResult Note: Nothrow Definition at line 282 of file AnalysisAlgorithm.h. References m_status_access, nCalls, overheadTime, and prototype.

void SctAnalysis::AnalysisAlgorithm::addPass (   )  [inline]

Adds a failure for this test. Definition at line 261 of file AnalysisAlgorithm.h. References m_status_access, nPassed, and prototype. Referenced by finish().

void SctAnalysis::AnalysisAlgorithm::addRawScanResult (  shared_ptr< Sct::IOName >  name  )

Add a named RawScanResult. Parameters: name  the IS name of the RawScanResult. Note: nothrow

virtual void SctAnalysis::AnalysisAlgorithm::analyze (   )  [pure virtual]

Does the analysis. Should only be called after canAnalyze() returns true. Should not be called is isDone() returns true. It should also do any final initialization of the TestResult which requires data to be present Exceptions: any  Exception Implemented in SctAnalysis::ChipCounterAlgorithm, SctAnalysis::DoubleTriggerNoiseAlgorithm, SctAnalysis::FullBypassAlgorithm, SctAnalysis::MarkSpaceRatioAlgorithm, SctAnalysis::NMaskAlgorithm, SctAnalysis::NoiseOccupancyAlgorithm, SctAnalysis::NPtGainAlgorithm, SctAnalysis::PipelineAlgorithm, SctAnalysis::PreTriggerNoiseAlgorithm, SctAnalysis::RxDelayAlgorithm, SctAnalysis::RxThresholdAlgorithm, SctAnalysis::RxThresholdBasedOnConfigRegisterAlgorithm, SctAnalysis::StrobeDelayAlgorithm, SctAnalysis::TimeWalkAlgorithm, SctAnalysis::TrimRangeAlgorithm, and SctAnalysis::TxCurrentAlgorithm.

virtual bool SctAnalysis::AnalysisAlgorithm::canAnalyze (   )  const [pure virtual]

Should check to see if the analysis can be performed. Probably wants to call hasAllRaws() or hasAllFits(). Exceptions: no  exceotions. Implemented in SctAnalysis::ChipCounterAlgorithm, SctAnalysis::DoubleTriggerNoiseAlgorithm, SctAnalysis::FullBypassAlgorithm, SctAnalysis::MarkSpaceRatioAlgorithm, SctAnalysis::NMaskAlgorithm, SctAnalysis::NoiseOccupancyAlgorithm, SctAnalysis::NPtGainAlgorithm, SctAnalysis::PipelineAlgorithm, SctAnalysis::PreTriggerNoiseAlgorithm, SctAnalysis::RxDelayAlgorithm, SctAnalysis::RxThresholdAlgorithm, SctAnalysis::RxThresholdBasedOnConfigRegisterAlgorithm, SctAnalysis::StrobeDelayAlgorithm, SctAnalysis::TimeWalkAlgorithm, SctAnalysis::TrimRangeAlgorithm, and SctAnalysis::TxCurrentAlgorithm.

void SctAnalysis::AnalysisAlgorithm::checkForZeroTriggerBins (   )

mark result as problem if there are bins containing no triggers - which might suggest a ROD problem Definition at line 145 of file AnalysisAlgorithm.cpp. References SctData::ScanPoints::getNEvents(), SctData::ScanPoints::getNPoints(), m_result, and scanData. Referenced by finish(). Here is the call graph for this function:

void SctAnalysis::AnalysisAlgorithm::checkTestResultExists (   )

Used by other methods to ensure that a TestResult has been made. Call createTestResult if it doesn't then initializes it. Exceptions: nothing  Definition at line 60 of file AnalysisAlgorithm.cpp. References createTestResult(), initializeTestResult(), and m_result. Referenced by finish(). Here is the call graph for this function:

virtual boost::shared_ptr<AnalysisAlgorithm> SctAnalysis::AnalysisAlgorithm::clone (  shared_ptr< const TestData >  testData, const string &  moduleName )  const throw () [pure virtual]

Must be overridden by sub-classes. Returns a shared pointer to a concrete AnalysisAlgorithm of the correct type. Primarily used by the map to get an AnalysisAlgorithm of the correct type. Implemented in SctAnalysis::ChipCounterAlgorithm, SctAnalysis::DoubleTriggerNoiseAlgorithm, SctAnalysis::FullBypassAlgorithm, SctAnalysis::MarkSpaceRatioAlgorithm, SctAnalysis::NMaskAlgorithm, SctAnalysis::NoiseOccupancyAlgorithm, SctAnalysis::NPtGainAlgorithm, SctAnalysis::PipelineAlgorithm, SctAnalysis::PreTriggerNoiseAlgorithm, SctAnalysis::RxDelayAlgorithm, SctAnalysis::RxThresholdAlgorithm, SctAnalysis::RxThresholdBasedOnConfigRegisterAlgorithm, SctAnalysis::StrobeDelayAlgorithm, SctAnalysis::TimeWalkAlgorithm, SctAnalysis::TrimRangeAlgorithm, and SctAnalysis::TxCurrentAlgorithm.

virtual shared_ptr<SctData::TestResult> SctAnalysis::AnalysisAlgorithm::createTestResult (   )  const [protected, pure virtual]

Called if the TestResult needs to be created. Exceptions: nothing.  Implemented in SctAnalysis::ChipCounterAlgorithm, SctAnalysis::DoubleTriggerNoiseAlgorithm, SctAnalysis::FullBypassAlgorithm, SctAnalysis::MarkSpaceRatioAlgorithm, SctAnalysis::NMaskAlgorithm, SctAnalysis::NoiseOccupancyAlgorithm, SctAnalysis::NPtGainAlgorithm, SctAnalysis::PipelineAlgorithm, SctAnalysis::PreTriggerNoiseAlgorithm, SctAnalysis::RxDelayAlgorithm, SctAnalysis::RxThresholdAlgorithm, SctAnalysis::RxThresholdBasedOnConfigRegisterAlgorithm, SctAnalysis::StrobeDelayAlgorithm, SctAnalysis::TimeWalkAlgorithm, SctAnalysis::TrimRangeAlgorithm, and SctAnalysis::TxCurrentAlgorithm. Referenced by checkTestResultExists().

void SctAnalysis::AnalysisAlgorithm::finish (   )

Publishes the TestResult, and sets `done'. Exceptions: IOException  if there is some IO problem Definition at line 176 of file AnalysisAlgorithm.cpp. References addFailure(), Sct::ISUtilities::addOrUpdateOrThrow(), addPass(), checkForZeroTriggerBins(), checkTestResultExists(), TestSummaryIS::dataString, SctAnalysis::AnalysisService::getOutputISServerName(), getTestData(), SctData::ISTestSummary::ISSummaryManager::instance(), SctData::TestSummary::SummaryManager::instance(), Sct::ISProxy::IOManagerISProxy::instance(), SctAnalysis::AnalysisService::instance(), m_done, m_result, and Sct::Throwable::sendToMrs(). Here is the call graph for this function:

shared_ptr< FitScanResult > SctAnalysis::AnalysisAlgorithm::getFit (  unsigned int  index  )  const [protected]

Returns a shared pointer to the RawScanResult at index. Guarenteed not to run a null pointer Exceptions: InvalidStateError  if the raw is not available Definition at line 140 of file AnalysisAlgorithm.cpp. References scanData. Referenced by SctAnalysis::TrimRangeAlgorithm::analyze(), SctAnalysis::TimeWalkAlgorithm::analyze(), SctAnalysis::StrobeDelayAlgorithm::analyze(), SctAnalysis::NPtGainAlgorithm::analyze(), SctAnalysis::NoiseOccupancyAlgorithm::analyze(), and SctAnalysis::NPtGainAlgorithm::mergeDefects().

const std::string SctAnalysis::AnalysisAlgorithm::getModuleName (   )  const throw () [inline]

Get the name of the module which this algorithm is working on. Definition at line 53 of file AnalysisAlgorithm.h. References m_modulename.

boost::recursive_mutex& SctAnalysis::AnalysisAlgorithm::getMutex (   )  const [inline]

Access the mutex. Definition at line 100 of file AnalysisAlgorithm.h. References m_access.

shared_ptr< RawScanResult > SctAnalysis::AnalysisAlgorithm::getRaw (  unsigned int  index  )  const [protected]

Returns a shared pointer to the RawScanResult at index. Guarenteed not to run a null pointer Exceptions: InvalidStateError  if the raw is not available Definition at line 135 of file AnalysisAlgorithm.cpp. References scanData. Referenced by SctAnalysis::TxCurrentAlgorithm::analyze(), SctAnalysis::RxThresholdBasedOnConfigRegisterAlgorithm::analyze(), SctAnalysis::RxThresholdAlgorithm::analyze(), SctAnalysis::RxDelayAlgorithm::analyze(), SctAnalysis::PreTriggerNoiseAlgorithm::analyze(), SctAnalysis::PipelineAlgorithm::analyze(), SctAnalysis::NoiseOccupancyAlgorithm::analyze(), SctAnalysis::NMaskAlgorithm::analyze(), SctAnalysis::MarkSpaceRatioAlgorithm::analyze(), SctAnalysis::FullBypassAlgorithm::analyze(), SctAnalysis::DoubleTriggerNoiseAlgorithm::analyze(), and SctAnalysis::ChipCounterAlgorithm::analyze().

string SctAnalysis::AnalysisAlgorithm::getStatus (   )  const

Returns a string giving the status of this algorithm including some info how long things are taking. Definition at line 224 of file AnalysisAlgorithm.cpp. References analysisTime, ioTime, m_status_access, nAnalyses, nCalls, nFailed, nPassed, overheadTime, and prototype.

shared_ptr< const TestData > SctAnalysis::AnalysisAlgorithm::getTestData (   )  const

get a pointer to the cached TestData; Returns: - guarentees always to return a non-null pointer to a TestData Exceptions: -  throws a LogicError if the pointer was null Definition at line 50 of file AnalysisAlgorithm.cpp. References m_test. Referenced by finish(), and initializeTestResult().

boost::shared_ptr<SctData::TestResult> SctAnalysis::AnalysisAlgorithm::getTestResult (   )  const [inline]

Access to the TestResult if required. Definition at line 95 of file AnalysisAlgorithm.h. References m_result. Referenced by SctAnalysis::TxCurrentAlgorithm::analyze(), SctAnalysis::TrimRangeAlgorithm::analyze(), SctAnalysis::TimeWalkAlgorithm::analyze(), SctAnalysis::StrobeDelayAlgorithm::analyze(), SctAnalysis::RxThresholdBasedOnConfigRegisterAlgorithm::analyze(), SctAnalysis::RxThresholdAlgorithm::analyze(), SctAnalysis::RxDelayAlgorithm::analyze(), SctAnalysis::PreTriggerNoiseAlgorithm::analyze(), SctAnalysis::PipelineAlgorithm::analyze(), SctAnalysis::NPtGainAlgorithm::analyze(), SctAnalysis::NoiseOccupancyAlgorithm::analyze(), SctAnalysis::NMaskAlgorithm::analyze(), SctAnalysis::MarkSpaceRatioAlgorithm::analyze(), SctAnalysis::FullBypassAlgorithm::analyze(), SctAnalysis::DoubleTriggerNoiseAlgorithm::analyze(), and SctAnalysis::ChipCounterAlgorithm::analyze().

bool SctAnalysis::AnalysisAlgorithm::hasAllFits (   )  const [protected]

Returns true if all the FitScanResult objects are available in IS. Exceptions: nothing  Definition at line 113 of file AnalysisAlgorithm.cpp. References scanData. Referenced by SctAnalysis::TrimRangeAlgorithm::canAnalyze(), SctAnalysis::TimeWalkAlgorithm::canAnalyze(), SctAnalysis::StrobeDelayAlgorithm::canAnalyze(), SctAnalysis::NPtGainAlgorithm::canAnalyze(), and SctAnalysis::NoiseOccupancyAlgorithm::canAnalyze().

bool SctAnalysis::AnalysisAlgorithm::hasAllRaws (   )  const [protected]

Returns true if all the RawScanResult objects are available in IS. Note: nothrow Definition at line 106 of file AnalysisAlgorithm.cpp. References scanData. Referenced by SctAnalysis::TxCurrentAlgorithm::canAnalyze(), SctAnalysis::RxThresholdBasedOnConfigRegisterAlgorithm::canAnalyze(), SctAnalysis::RxThresholdAlgorithm::canAnalyze(), SctAnalysis::RxDelayAlgorithm::canAnalyze(), SctAnalysis::PreTriggerNoiseAlgorithm::canAnalyze(), SctAnalysis::PipelineAlgorithm::canAnalyze(), SctAnalysis::NoiseOccupancyAlgorithm::canAnalyze(), SctAnalysis::NMaskAlgorithm::canAnalyze(), SctAnalysis::MarkSpaceRatioAlgorithm::canAnalyze(), SctAnalysis::FullBypassAlgorithm::canAnalyze(), SctAnalysis::DoubleTriggerNoiseAlgorithm::canAnalyze(), and SctAnalysis::ChipCounterAlgorithm::canAnalyze().

void SctAnalysis::AnalysisAlgorithm::initializeTestResult (   )  [private]

Useful function that initializes TestResult from Test and module name. Sets up stuff that can be done here. Anything else must be done by the algorithm in analyze. Note: TestResult must have been created first! Definition at line 69 of file AnalysisAlgorithm.cpp. References SctData::ConfigurationVariableIOHelper::getFromTypeRep(), getTestData(), m_modulename, and m_result. Referenced by checkTestResultExists(). Here is the call graph for this function:

bool SctAnalysis::AnalysisAlgorithm::isDone (   )  const throw () [inline]

Method indicates when a particular analysis is finished. Definition at line 85 of file AnalysisAlgorithm.h. References m_done.

void SctAnalysis::AnalysisAlgorithm::loadAllFits (   )  [protected]

Loads all the fits it can. Exceptions: Sct::IoException  if there is an IO problem Definition at line 128 of file AnalysisAlgorithm.cpp. References scanData. Referenced by SctAnalysis::TrimRangeAlgorithm::loadData(), SctAnalysis::TimeWalkAlgorithm::loadData(), SctAnalysis::StrobeDelayAlgorithm::loadData(), SctAnalysis::NPtGainAlgorithm::loadData(), and SctAnalysis::NoiseOccupancyAlgorithm::loadData().

void SctAnalysis::AnalysisAlgorithm::loadAllRaws (   )  [protected]

Loads all the raws it can. Exceptions: Sct::IoException  if there is an IO problem Definition at line 120 of file AnalysisAlgorithm.cpp. References scanData. Referenced by SctAnalysis::TxCurrentAlgorithm::loadData(), SctAnalysis::RxThresholdBasedOnConfigRegisterAlgorithm::loadData(), SctAnalysis::RxThresholdAlgorithm::loadData(), SctAnalysis::RxDelayAlgorithm::loadData(), SctAnalysis::PreTriggerNoiseAlgorithm::loadData(), SctAnalysis::PipelineAlgorithm::loadData(), SctAnalysis::NoiseOccupancyAlgorithm::loadData(), SctAnalysis::NMaskAlgorithm::loadData(), SctAnalysis::MarkSpaceRatioAlgorithm::loadData(), SctAnalysis::FullBypassAlgorithm::loadData(), SctAnalysis::DoubleTriggerNoiseAlgorithm::loadData(), and SctAnalysis::ChipCounterAlgorithm::loadData().

virtual void SctAnalysis::AnalysisAlgorithm::loadData (   )  [pure virtual]

Called to indicate the algorithm should try and load as much data as it can - perhaps by calling loadAllFits or loadAllRaws(). This is guarenteed to be called shortly before analyze(). Implemented in SctAnalysis::ChipCounterAlgorithm, SctAnalysis::DoubleTriggerNoiseAlgorithm, SctAnalysis::FullBypassAlgorithm, SctAnalysis::MarkSpaceRatioAlgorithm, SctAnalysis::NMaskAlgorithm, SctAnalysis::NoiseOccupancyAlgorithm, SctAnalysis::NPtGainAlgorithm, SctAnalysis::PipelineAlgorithm, SctAnalysis::PreTriggerNoiseAlgorithm, SctAnalysis::RxDelayAlgorithm, SctAnalysis::RxThresholdAlgorithm, SctAnalysis::RxThresholdBasedOnConfigRegisterAlgorithm, SctAnalysis::StrobeDelayAlgorithm, SctAnalysis::TimeWalkAlgorithm, SctAnalysis::TrimRangeAlgorithm, and SctAnalysis::TxCurrentAlgorithm.

void SctAnalysis::AnalysisAlgorithm::mergeDefects (   )  [protected]

Merges all the defects from the FitScanResults into the TestResult. Utility method for algorithms. Ignores FitScanResults that don't exist. Does nothing if the TestResult doesn't exist. Definition at line 167 of file AnalysisAlgorithm.cpp. References m_result, and scanData.

void SctAnalysis::AnalysisAlgorithm::setFit (  unsigned  index, const std::string &  fit )

Method to use only when expert re-analysing data. Definition at line 96 of file AnalysisAlgorithm.cpp. References scanData.

void SctAnalysis::AnalysisAlgorithm::setRaw (  unsigned  index, const std::string &  raw )

Method to use only when expert re-analysing data. Definition at line 101 of file AnalysisAlgorithm.cpp. References scanData.

void SctAnalysis::AnalysisAlgorithm::setTestData (  shared_ptr< const TestData >  testdata  )

set TestData - used for updating TestData. .. Definition at line 55 of file AnalysisAlgorithm.cpp. References m_test.

---

Field Documentation

double SctAnalysis::AnalysisAlgorithm::analysisTime [mutable, private]

The total time spent doing analysis. Definition at line 253 of file AnalysisAlgorithm.h. Referenced by addAnalysisTime(), and getStatus().

double SctAnalysis::AnalysisAlgorithm::ioTime [mutable, private]

The total time spent doing I/O. Definition at line 252 of file AnalysisAlgorithm.h. Referenced by addIOTime(), and getStatus().

boost::recursive_mutex SctAnalysis::AnalysisAlgorithm::m_access [mutable, private]

access to the algorithm can be locked for thread-safeness. Definition at line 247 of file AnalysisAlgorithm.h. Referenced by getMutex(), and ~AnalysisAlgorithm().

bool SctAnalysis::AnalysisAlgorithm::m_done [private]

a vector of ScanData objects true if finish() has been called. Definition at line 246 of file AnalysisAlgorithm.h. Referenced by finish(), and isDone().

const string SctAnalysis::AnalysisAlgorithm::m_modulename [private]

name of the module being worked on. Definition at line 242 of file AnalysisAlgorithm.h. Referenced by getModuleName(), and initializeTestResult().

shared_ptr<SctData::TestResult> SctAnalysis::AnalysisAlgorithm::m_result [private]

pointer to the result. Note: it is up to the Concrete class to make one! Definition at line 243 of file AnalysisAlgorithm.h. Referenced by checkForZeroTriggerBins(), checkTestResultExists(), finish(), getTestResult(), initializeTestResult(), mergeDefects(), and ~AnalysisAlgorithm().

boost::recursive_mutex SctAnalysis::AnalysisAlgorithm::m_status_access [mutable, private]

access to the status information Definition at line 250 of file AnalysisAlgorithm.h. Referenced by addAnalysisTime(), addFailure(), addIOTime(), addOverheadTime(), addPass(), and getStatus().

shared_ptr<const TestData> SctAnalysis::AnalysisAlgorithm::m_test [private]

pointer to the testdata. Definition at line 244 of file AnalysisAlgorithm.h. Referenced by getTestData(), and setTestData().

unsigned int SctAnalysis::AnalysisAlgorithm::nAnalyses [mutable, private]

The number of analyses performed. Definition at line 256 of file AnalysisAlgorithm.h. Referenced by addAnalysisTime(), and getStatus().

unsigned int SctAnalysis::AnalysisAlgorithm::nCalls [mutable, private]

The number of times this alg has been accessed. Definition at line 255 of file AnalysisAlgorithm.h. Referenced by addOverheadTime(), and getStatus().

unsigned int SctAnalysis::AnalysisAlgorithm::nFailed [mutable, private]

The number of analyses which failed. Definition at line 258 of file AnalysisAlgorithm.h. Referenced by addFailure(), and getStatus().

unsigned int SctAnalysis::AnalysisAlgorithm::nPassed [mutable, private]

The number of tests which passed. Definition at line 257 of file AnalysisAlgorithm.h. Referenced by addPass(), and getStatus().

double SctAnalysis::AnalysisAlgorithm::overheadTime [mutable, private]

The time spent just getting stuff, checking it etc. Definition at line 254 of file AnalysisAlgorithm.h. Referenced by addOverheadTime(), and getStatus().

const AnalysisAlgorithm& SctAnalysis::AnalysisAlgorithm::prototype [private]

A reference to the prototype. Definition at line 251 of file AnalysisAlgorithm.h. Referenced by addAnalysisTime(), addFailure(), addIOTime(), addOverheadTime(), addPass(), and getStatus().

---

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

• AnalysisAlgorithm.h
• AnalysisAlgorithm.cpp

---