SctAnalysis::PreTriggerNoiseAlgorithm Class Reference

Inheritance diagram for SctAnalysis::PreTriggerNoiseAlgorithm:

[legend]Collaboration diagram for SctAnalysis::PreTriggerNoiseAlgorithm:

[legend]

Public Member Functions
	PreTriggerNoiseAlgorithm (shared_ptr< const TestData > testData, const string &moduleName, const AnalysisAlgorithm &alg) throw ()
	constructor
virtual	~PreTriggerNoiseAlgorithm () throw ()
	destructor
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 bool	canAnalyze () const
	Should check to see if the analysis can be performed.
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.
Private Member Functions
	PreTriggerNoiseAlgorithm ()
Private Attributes
unsigned short	m_scanVariable
	pointer to variable type.
Static Private Attributes
static bool	inMap

---

Detailed Description

Definition at line 12 of file PreTriggerNoiseAlgorithm.h.

---

Constructor & Destructor Documentation

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

constructor Definition at line 17 of file PreTriggerNoiseAlgorithm.h.

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

destructor Definition at line 23 of file PreTriggerNoiseAlgorithm.cpp.

---

Member Function Documentation

void SctAnalysis::PreTriggerNoiseAlgorithm::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 45 of file PreTriggerNoiseAlgorithm.cpp. References SctAnalysis::AnalysisAlgorithm::getRaw(), SctAnalysis::AnalysisAlgorithm::getTestResult(), SctData::ConfigurationVariableIOHelper::getTypeRep(), m_scanVariable, and Sct::nLinkModule. Here is the call graph for this function:

bool SctAnalysis::PreTriggerNoiseAlgorithm::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 37 of file PreTriggerNoiseAlgorithm.cpp. References SctAnalysis::AnalysisAlgorithm::hasAllRaws(). Here is the call graph for this function:

shared_ptr< AnalysisAlgorithm > SctAnalysis::PreTriggerNoiseAlgorithm::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 25 of file PreTriggerNoiseAlgorithm.cpp.

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

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

void SctAnalysis::PreTriggerNoiseAlgorithm::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 33 of file PreTriggerNoiseAlgorithm.cpp. References SctAnalysis::AnalysisAlgorithm::loadAllRaws(). Here is the call graph for this function:

---

Field Documentation

unsigned short SctAnalysis::PreTriggerNoiseAlgorithm::m_scanVariable [private]

pointer to variable type. Definition at line 30 of file PreTriggerNoiseAlgorithm.h. Referenced by analyze().

---

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

• PreTriggerNoiseAlgorithm.h
• PreTriggerNoiseAlgorithm.cpp

---