SctAnalysis::RxThresholdBasedOnConfigRegisterAlgorithm Class Reference

Algorithm for RxThresholdBasedOnConfigRegister Test. More...

#include <RxThresholdBasedOnConfigRegisterAlgorithm.h>

Inheritance diagram for SctAnalysis::RxThresholdBasedOnConfigRegisterAlgorithm:

Inheritance graph
[legend]
Collaboration diagram for SctAnalysis::RxThresholdBasedOnConfigRegisterAlgorithm:

Collaboration graph
[legend]

Public Types

enum  Category {
  undecided, white, black, blackAndWhite,
  meaningfulData, 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::TestResultcreateTestResult () 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.
 RxThresholdBasedOnConfigRegisterAlgorithm (shared_ptr< const TestData > testData, const string &moduleName, const AnalysisAlgorithm &alg) throw ()
 constructor
virtual ~RxThresholdBasedOnConfigRegisterAlgorithm () throw ()
 destructor
void setFraction (float fraction)
float getFraction () const

Static Public Member Functions

static std::string categoryToString (const Category &category)

Private Member Functions

bool canRead (const std::vector< char > &wanted, const std::vector< bool > &have, std::vector< bool >::const_iterator &pos, const bool showDebug=false)
 RxThresholdBasedOnConfigRegisterAlgorithm ()

Private Attributes

float m_fraction

Static Private Attributes

static bool inMap

Detailed Description

Algorithm for RxThresholdBasedOnConfigRegister Test.

Definition at line 10 of file RxThresholdBasedOnConfigRegisterAlgorithm.h.


Constructor & Destructor Documentation

SctAnalysis::RxThresholdBasedOnConfigRegisterAlgorithm::RxThresholdBasedOnConfigRegisterAlgorithm shared_ptr< const TestData testData,
const string &  moduleName,
const AnalysisAlgorithm alg
throw ()
 

constructor

Definition at line 26 of file RxThresholdBasedOnConfigRegisterAlgorithm.cpp.

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

destructor

Definition at line 38 of file RxThresholdBasedOnConfigRegisterAlgorithm.h.


Member Function Documentation

void SctAnalysis::RxThresholdBasedOnConfigRegisterAlgorithm::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 137 of file RxThresholdBasedOnConfigRegisterAlgorithm.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::RxThresholdBasedOnConfigRegisterAlgorithm::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 RxThresholdBasedOnConfigRegisterAlgorithm.cpp.

References SctAnalysis::AnalysisAlgorithm::hasAllRaws().

Here is the call graph for this function:

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

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

Called if the TestResult needs to be created.

Exceptions:
nothing. 

Implements SctAnalysis::AnalysisAlgorithm.

Definition at line 41 of file RxThresholdBasedOnConfigRegisterAlgorithm.cpp.

void SctAnalysis::RxThresholdBasedOnConfigRegisterAlgorithm::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 32 of file RxThresholdBasedOnConfigRegisterAlgorithm.cpp.

References SctAnalysis::AnalysisAlgorithm::loadAllRaws().

Here is the call graph for this function:


The documentation for this class was generated from the following files:
Generated on Mon Feb 6 14:04:07 2006 for SCT DAQ/DCS Software - C++ by  doxygen 1.4.6