Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Data Structures | File List | Namespace Members | Data Fields | Globals | Related Pages

SctApi Namespace Reference

Should probably move this out of SctApi pacakge and into SCT/src as this doesn't depend on anything in SctApi. More...


Data Structures

class  ConfigUtility
 compares ABCDModule structs and their sub-types More...

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...

struct  CrateLabel
class  DCSAccess
 High level access to DCS. More...

class  DCSAccessDummy
 Provide dummy answers to everything... More...

class  Debug
 Manage debug options, singleton class. More...

class  Idiosyncrasy
class  IdiosyncrasyServer
class  Log
 A logging class, just an ofstream that opens a fixed file. More...

struct  ModuleMask
class  PreLoadConfigurations
 little class holds information for thread to load module configurations from config service The thread which starts with this object starts loading up the configurations from the config service, but does not send those to the ROD. More...

class  PrimBuilder
struct  PrimListWrapper
 Wrap the SctPixelRod::RodPrimList class. More...

class  RodInfo
struct  RodLabel
class  RodScanEx
 This information is used per ROD, stored in a map in ScanEx. More...

struct  RodStatus
class  Scan
class  ScanControl
 Interface used by doScan to control and retrieve data from a histogram. More...

class  ScanControlAsyncHisto
 SctApi delegates control of sending the triggers. More...

class  ScanControlRODHisto
 Control a histogram on a ROD. More...

class  ScanControlTIMHisto
 TIM takes control of sending the triggers. More...

class  ScanDefImpl
class  ScanEx
 Internal scan class with lots more information. More...

class  ScanMonitor
 High-level scan interface for use over IPC. More...

class  ScanMonitorImpl
class  SctApi
 SctApi class. More...

class  SctApiConfigCache
 This is supposed to mirror the module configuration banks on the rod. More...

class  SctApiConfigCache::ModuleBanks
 Class to hold different ABCDModule configurations for a particular module. More...

struct  SctApiCounters
class  SctApiDDC
class  SctApiException
class  Trigger
class  TriggerImpl

Typedefs

typedef std::list< std::string > ModuleList

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_USE_RAW_PRIMITIVE, 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_SCAN_USE_CCODE, DEBUG_TIM_SCAN_STATUS, DEBUG_API_CONFIG_CACHE_CHECK,
  DEBUG_API_CONFIG_CACHE_SEND, DEBUG_API_CONFIG_NO_COPY, DEBUG_CALIB_NO_SLINK, DEBUG_CALIB_RTR_STOP_OUTPUT,
  DEBUG_END_OPTIONS
}
 Possible options for the Debug class. More...

enum  BankType { SCTAPI_BANK_PHYSICS, SCTAPI_BANK_SCAN, SCTAPI_BANK_CALIBRATION }
enum  ConfigType {
  SCTAPI_CONFIG_NONE, SCTAPI_CONFIG_BASIC, SCTAPI_CONFIG_TRIM, SCTAPI_CONFIG_MASK,
  SCTAPI_CONFIG_CFG, SCTAPI_CONFIG_OTHER, SCTAPI_CONFIG_ALL
}
enum  RunType { SCTAPI_RUN_PHYSICS, SCTAPI_RUN_CALIBRATION }
enum  EventFormatType { SCTAPI_EVENT_FORMAT_NORMAL, SCTAPI_EVENT_FORMAT_EXPANDED, SCTAPI_EVENT_FORMAT_RAW }

Functions

void printOutList (unsigned long *result, unsigned long length, bool in, int level, ostream &stream, bool dumpUnknown, bool dumpRaw)
 Should this be somewhere else (eg Sct).

UINT32 eventWord (const UINT32 *const buffer, const int frame, const int index)
bool hasPostSeptember2004Firmware (const UINT32 *const frameBuffer, const int frame)
 Only apply the following method to NON ERROR events.

int findEOF (UINT32 *buffer, int startFrame)
int useCCode (const SctApi &api, const Scan &scan)
 AJB.

void readHistogramToFile (const Sct::UCID &ucid, const Scan &scan, const ScanEx &ex, UINT32 mid, std::string sn, scan_result_ptrs scanData, time_t saveTime, int frame)
 Read the histogram data in to a file.

void saveHistogramToFile (scan_result_ptrs histo, std::string filename)
 Write a histogram to a file.

void readHistogramToIS (const Sct::UCID &ucid, const Scan &scan, const ScanEx &ex, UINT32 mid, scan_result_ptrs scanData)
 Read the histogram data in to IS.

void printBanks (list< BankType > banks, ostream &os)
int lookupFifoHit (UINT16 *bufA, UINT16 *bufB, int channel, int pos)
 Is there a hit at a position.


Variables

const short tokens [20]
const char * chipRoles []
SctApiCounters publishedStats
SctApiCounters currentStats
const int numSlaves
const unsigned long rodMapSize
const unsigned long timMapSize
const int eventSize
const int eventWords
const int frameCount


Detailed Description

Should probably move this out of SctApi pacakge and into SCT/src as this doesn't depend on anything in SctApi.

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.


Enumeration Type Documentation

enum SctApi::DebugOptions
 

Possible options for the Debug class.

Definition at line 15 of file SctApiDebug.h.


Function Documentation

bool hasPostSeptember2004Firmware const UINT32 *const  frameBuffer,
const int  frame
 

Only apply the following method to NON ERROR events.

Otherwise it will look at the BCID not the version !!!

Definition at line 54 of file SctApiEvent.cxx.

Referenced by SctApi::SctApi::decodeEvent(), SctApi::SctApi::reportEventErrors(), and SctApi::SctApi::scanEvents().

int lookupFifoHit UINT16 *  bufA,
UINT16 *  bufB,
int  channel,
int  pos
[static]
 

Is there a hit at a position.

Definition at line 148 of file SctApiRaw.cxx.

Referenced by SctApi::SctApi::doRawScanThreadInnards(), SctApi::SctApi::probeWithTrigger(), SctApi::SctApi::rawData(), and SctApi::SctApi::readRawData().

void SctApi::SctApi::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!

Definition at line 36 of file primUtils.cxx.

void SctApi::SctApi::readHistogramToFile const Sct::UCID ucid,
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.

Definition at line 1647 of file SctApiHisto.cxx.

References saveHistogramToFile().

Referenced by SctApi::ScanControlRODHisto::readHistograms().

Here is the call graph for this function:

void SctApi::SctApi::readHistogramToIS const Sct::UCID ucid,
const Scan &  scan,
const ScanEx &  ex,
UINT32  mid,
scan_result_ptrs  scanData
 

Read the histogram data in to IS.

Definition at line 1707 of file SctApiHisto.cxx.

References SctData::ScanResultWriter::publish().

Referenced by SctApi::ScanControlRODHisto::readHistograms().

Here is the call graph for this function:

void SctApi::SctApi::saveHistogramToFile scan_result_ptrs  histo,
std::string  filename
 

Write a histogram to a file.

Definition at line 1684 of file SctApiHisto.cxx.

References scan_result_ptrs::data, scan_result_ptrs::header, ScanHeader::length, scan_result_ptrs::nErrorEvents, scan_result_ptrs::nEvents, ScanHeader::pntData, ScanHeader::pntErrors, ScanHeader::pntEvents, ScanHeader::pntPoints, scan_result_ptrs::points, and ScanHeader::size.

Referenced by SctApi::SctApi::doRawScanThreadInnards(), readHistogramToFile(), and SctApi::SctApi::readRawData().

int useCCode const SctApi &  api,
const Scan &  scan
 

AJB.

"Intellegent" function which works out if the CCode histogramming needs to be used. Returns true if either :

  • the debug option to use CCODE is set or
  • the scan "needs" CCODE because as of at 26/7/2005: -- synch trigs fails with assembly -- full histograms require ccode -- OPE currently requires ccode

Definition at line 72 of file SctApiHisto.cxx.

Referenced by SctApi::ScanControlRODHisto::finishHistogram(), SctApi::SctApi::setupHistogramming(), and SctApi::ScanControlRODHisto::startHistogramming().


Generated on Thu Dec 22 20:19:04 2005 for SCT DAQ/DCS Software - C++ by doxygen 1.3.5