SctAnalysis::TxCurrentAlgorithm Class Reference

Algorithm for TxCurrent Test. More...

#include <TxCurrentAlgorithm.h>

Inheritance diagram for SctAnalysis::TxCurrentAlgorithm:

[legend]Collaboration diagram for SctAnalysis::TxCurrentAlgorithm:

[legend]

Public Types
enum	Category {   undecided, white, black, blackAndWhite,   coloured }
Public Member Functions
virtual bool	canAnalyze () const
	Should check to see if the analysis can be performed.
virtual void	analyze ()
	Does the analysis.
virtual void	loadData ()
	Called to indicate the algorithm should try and load as much data as it can - perhaps by calling loadAllFits or loadAllRaws().
virtual shared_ptr< SctData::TestResult >	createTestResult () const
	Called if the TestResult needs to be created.
virtual boost::shared_ptr< AnalysisAlgorithm >	clone (shared_ptr< const TestData > testData, const string &moduleName) const throw ()
	Must be overridden by sub-classes.
	TxCurrentAlgorithm (shared_ptr< const TestData > testData, const string &moduleName, const AnalysisAlgorithm &alg) throw ()
	constructor
virtual	~TxCurrentAlgorithm () throw ()
	destructor
Static Public Member Functions
static std::string	categoryToString (const Category &category)
Private Member Functions
	TxCurrentAlgorithm ()
Static Private Attributes
static bool	inMap

---

Detailed Description

Algorithm for TxCurrent Test.

Definition at line 10 of file TxCurrentAlgorithm.h.

---

Constructor & Destructor Documentation

SctAnalysis::TxCurrentAlgorithm::TxCurrentAlgorithm (  shared_ptr< const TestData >  testData, const string &  moduleName, const AnalysisAlgorithm &  alg )  throw () [inline]

constructor Definition at line 33 of file TxCurrentAlgorithm.h.

virtual SctAnalysis::TxCurrentAlgorithm::~TxCurrentAlgorithm (   )  throw () [inline, virtual]

destructor Definition at line 37 of file TxCurrentAlgorithm.h.

---

Member Function Documentation

void SctAnalysis::TxCurrentAlgorithm::analyze (   )  [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 Implements SctAnalysis::AnalysisAlgorithm. Definition at line 70 of file TxCurrentAlgorithm.cpp. References categoryToString(), SctAnalysis::debug, SctData::ScanPoints::getNEvents(), SctData::ScanPoints::getNPoints(), SctData::ScanPoints::getPoint(), SctAnalysis::AnalysisAlgorithm::getRaw(), SctAnalysis::AnalysisAlgorithm::getTestResult(), Sct::nLinkModule, and SctData::TestResult::setScanVariable(). Here is the call graph for this function:

bool SctAnalysis::TxCurrentAlgorithm::canAnalyze (   )  const [virtual]

Should check to see if the analysis can be performed. Probably wants to call hasAllRaws() or hasAllFits(). Exceptions: no  exceotions. Implements SctAnalysis::AnalysisAlgorithm. Definition at line 33 of file TxCurrentAlgorithm.cpp. References SctAnalysis::AnalysisAlgorithm::hasAllRaws(). Here is the call graph for this function:

shared_ptr< AnalysisAlgorithm > SctAnalysis::TxCurrentAlgorithm::clone (  shared_ptr< const TestData >  testData, const string &  moduleName )  const throw () [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. Implements SctAnalysis::AnalysisAlgorithm. Definition at line 24 of file TxCurrentAlgorithm.cpp.

shared_ptr< TestResult > SctAnalysis::TxCurrentAlgorithm::createTestResult (   )  const [virtual]

Called if the TestResult needs to be created. Exceptions: nothing.  Implements SctAnalysis::AnalysisAlgorithm. Definition at line 37 of file TxCurrentAlgorithm.cpp.

void SctAnalysis::TxCurrentAlgorithm::loadData (   )  [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(). Implements SctAnalysis::AnalysisAlgorithm. Definition at line 28 of file TxCurrentAlgorithm.cpp. References SctAnalysis::AnalysisAlgorithm::loadAllRaws(). Here is the call graph for this function:

---

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

• TxCurrentAlgorithm.h
• TxCurrentAlgorithm.cpp

---