SctApi Namespace Reference

Namespace containing SctApi and auxiliary classes. More...

Data Structures
class	Crate
	A representation of the crate controller. More...
class	CrateException
	Exception to be thrown by public API methods. More...
class	CrateImpl
	A representation of the crate controller. More...
class	Debug
class	Log
	A logging class, just an ofstream that opens a fixed file. More...
struct	ModuleMask
class	PrimBuilder
struct	PrimListWrapper
class	RodInfo
struct	RodLabel
class	RodScanEx
	All this stuff restricts a scan to one ROD. More...
struct	RodStatus
class	Scan
	Scan class. More...
class	ScanControl
class	ScanControlRODHisto
class	ScanControlTIMHisto
class	ScanDefImpl
	ScanDefImpl class. More...
class	ScanEx
class	SctApi
	SctApi class. More...
class	SctApiException
	Exception to be thrown by public API methods. More...
class	Trigger
	Trigger interface. More...
class	TriggerImpl
	Implement Sct::Api::Trigger class. More...
Enumerations
enum	DebugOptions {   DEBUG_DIAG, DEBUG_DIAG2, DEBUG_DUMP_PRIM_BINARY, DEBUG_DIAG_RESPONSE,   DEBUG_MODULE_CONFIG, DEBUG_SAVE_PRIM, DEBUG_SAVE_HISTOGRAM, DEBUG_SAVE_RAW_CAPTURE,   DEBUG_VERBOSE_PROBE, DEBUG_PRINT_IN_PRIM, DEBUG_PRINT_OUT_PRIM, DEBUG_PRINT_CALIB,   DEBUG_PRINT_RAW, DEBUG_LOG_PRINT_PRIM, DEBUG_EXTRA_DUMPS, DEBUG_PRINT_UNKNOWN,   DEBUG_BOC_SETUP, DEBUG_DUMP_RAW_EVENT, DEBUG_SCAN_ERROR_TRAP, DEBUG_SCAN_ERROR_TRAP_ALL,   DEBUG_SCAN_AUTO_STALL, DEBUG_SCAN_STEP_MODE, DEBUG_SCAN_PAUSE_PULSE, DEBUG_SCAN_ROD_MODE_BITS,   DEBUG_END_OPTIONS }
enum	BankType { SCTAPI_BANK_PHYSICS, SCTAPI_BANK_SCAN, SCTAPI_BANK_CALIBRATION }
enum	ConfigType { SCTAPI_CONFIG_BASIC, SCTAPI_CONFIG_TRIM, SCTAPI_CONFIG_ALL }
Functions
void	printOutList (unsigned long *primList, unsigned long length, bool in, int level, std::ostream &stream, bool dumpUnknown, bool dumpRaw)
	Should this be somewhere else (eg Sct).
void	saveHistogramToFile (scan_result_ptrs histo, std::string filename)
	Write a histogram to a file.
void	readHistogramToFile (const Scan &scan, const ScanEx &ex, UINT32 mid, std::string sn, scan_result_ptrs scanData, time_t saveTime, int frame=0)
	Read the histogram data in to a file.
void	readHistogramToIS (const Scan &scan, const ScanEx &ex, UINT32 mid, scan_result_ptrs scanData)
	Read the histogram data in to IS.
Variables
const int	numSlaves
const unsigned long	rodMapSize
const unsigned long	timMapSize

---

Detailed Description

Namespace containing SctApi and auxiliary classes.

SctApi provides most of the high level access to the ROD used by the SCT.

Scan is a class which describes a Scan to be carried out on the modules attached to the system.

Trigger describes a single trigger which forms an event in a scan.

---

Function Documentation

void printOutList (  unsigned long *  primList, unsigned long  length, bool  in, int  level, std::ostream &  stream, bool  dumpUnknown, bool  dumpRaw )

Should this be somewhere else (eg Sct). Parameters: primList  The list as a block of words lenth  Length of the block of words in  Is this an input list (hence negating the method name!

void readHistogramToFile (  const Scan &  scan, const ScanEx &  ex, UINT32  mid, std::string  sn, scan_result_ptrs  scanData, time_t  saveTime, int  frame = 0 )

Read the histogram data in to a file.

void readHistogramToIS (  const Scan &  scan, const ScanEx &  ex, UINT32  mid, scan_result_ptrs  scanData )

Read the histogram data in to IS.

void saveHistogramToFile (  scan_result_ptrs  histo, std::string  filename )

Write a histogram to a file.

---