SctApi::ScanControl Class Reference

Interface used by doScan to control and retrieve data from a histogram. More...

#include <SctApiHisto.h>

Inheritance diagram for SctApi::ScanControl:

[legend]Collaboration diagram for SctApi::ScanControl:

[legend]

Public Member Functions
virtual void	startHistogramming ()=0
	Check possible and start.
virtual void	initialisePolling ()=0
	Called before starting polling.
virtual void	reportEventErrors ()=0
	Report on what might have gone wrong.
virtual void	reportTimeout ()=0
	Report on progress at timeout.
virtual void	nextBin ()=0
	Move to the next bin if necessary.
virtual bool	checkScanComplete (bool &progressMade, bool &newBin)=0
	Is the scan complete?
virtual void	abort ()=0
	Somehow make the scan stop quickly.
virtual void	finishHistogram (bool success)=0
	Tidy up, read out and save histogram.
void	printVetoStatus ()
Static Public Member Functions
static void	setModuleScanCacheToLastPointInScan (SctApi &api, boost::shared_ptr< const Scan > aScan)
Protected Member Functions
	ScanControl (SctApi &api, int bin, int event)
	ScanControl (SctApi &api)
virtual	~ScanControl ()
Protected Attributes
SctApi &	api

---

Detailed Description

Interface used by doScan to control and retrieve data from a histogram.

Procedure as follows:

initialisePolling

startHistogramming

loop over checkScanComplete

if newBin is true then call nextBin

reportTimeout is called if checkScanComplete persists in not setting progressMade

finishHistogram tidies up and saves the histogram data

Definition at line 143 of file SctApiHisto.h.

---

Member Function Documentation

virtual void SctApi::ScanControl::abort (   )  [pure virtual]

Somehow make the scan stop quickly. Implemented in SctApi::ScanControlRODHisto.

virtual bool SctApi::ScanControl::checkScanComplete (  bool &  progressMade, bool &  newBin )  [pure virtual]

Is the scan complete? Parameters: progressMade  Is set to true if progress was made (reset the timeout) newBin  Is set if the end of the current bin was reached (ie nextBin should be called) Implemented in SctApi::ScanControlRODHisto.

virtual void SctApi::ScanControl::finishHistogram (  bool  success  )  [pure virtual]

Tidy up, read out and save histogram. Parameters: success  reports whether the scan was successful Implemented in SctApi::ScanControlRODHisto, SctApi::ScanControlTIMHisto, and SctApi::ScanControlAsyncHisto.

virtual void SctApi::ScanControl::initialisePolling (   )  [pure virtual]

Called before starting polling. Implemented in SctApi::ScanControlRODHisto.

virtual void SctApi::ScanControl::nextBin (   )  [pure virtual]

Move to the next bin if necessary. Implemented in SctApi::ScanControlRODHisto, SctApi::ScanControlTIMHisto, and SctApi::ScanControlAsyncHisto.

virtual void SctApi::ScanControl::reportEventErrors (   )  [pure virtual]

Report on what might have gone wrong. Implemented in SctApi::ScanControlRODHisto.

virtual void SctApi::ScanControl::reportTimeout (   )  [pure virtual]

Report on progress at timeout. Implemented in SctApi::ScanControlRODHisto.

virtual void SctApi::ScanControl::startHistogramming (   )  [pure virtual]

Check possible and start. Implemented in SctApi::ScanControlRODHisto, SctApi::ScanControlTIMHisto, and SctApi::ScanControlAsyncHisto.

---

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

• SctApiHisto.h
• SctApiHisto.cxx

---