TApi Class Reference

The Root interface to SCTAPI. More...

#include <TApi.h>

Collaboration diagram for TApi:

[legend]

Public Member Functions
	TApi (std::string plugin="xml")
	Constructor.
	~TApi ()
	Destructor.
void	initialiseAll (int runNumber)
	Initialise all the Rods and modules found in the configuration.
bool	isInitialised ()
void	shutdownAll ()
	Shutdown everything.
void	setRunNumber (int newRun)
	Change the run number.
void	setScanNumber (int newScan)
	Change the scan number.
void	changeRunMode (enum SctApi::RunType mode)
	Change global run mode.
void	echo (unsigned int rod, unsigned int length, unsigned long *data)
	Using a primitive, send some data to the ROD.
void	echoAll (unsigned int length, unsigned long *data)
	Using a primitive, send some data to the ROD.
void	echoSlave (unsigned int rod, unsigned int slave, unsigned int length, unsigned long *data)
	Using a primitive, send some data to the ROD.
void	loadConfiguration ()
	Reload configuration from the "configuration database".
void	loadModuleConfigurations ()
	Load module configurations from the "configuration database".
void	configureBOC (unsigned int rod)
	Reset BOC configuration.
void	awaitResponse (unsigned int rod, int timeout=5)
	Wait for a ROD to finish a primlist.
unsigned long *	getResponse (unsigned int rod)
	Get a response from the rod.
unsigned long *	getResponse (unsigned int rod, unsigned long *length)
	Get a response from the rod.
bool	getRodMessage (unsigned int rod, char *buffer, unsigned long &length)
	Get a message from a ROD text buffer Returns whether the action was completed.
void	flashLED (unsigned int rod, long slaveNumber, long period=1000, long flashes=10)
	This creates its own primitive list and sends it to a slave DSP on the ROD.
void	status ()
Int_t	dspBlockDump (unsigned int rod, long dspStart, long numWords, long dspNumber, bool usePrimitive=true)
	Dump contents of a block of DSP memory to cout.
Int_t	dspBlockDumpFile (unsigned int rod, long dspStart, long numWords, long dspNumber, const char *filename, bool usePrimitive=true)
	Dump contents of a block of DSP memory to a file.
unsigned long *	dspBlockRead (unsigned int rod, long dspStart, long numWords, long dspNumber, unsigned long *length, bool usePrimitive=true)
	Read data.
int	dspBlockWrite (unsigned int rod, unsigned long *buffer, unsigned long dspAddress, long numWords, long dspNumber, bool usePrimitive=true)
	Write a block of memory to a ROD DSP.
unsigned long	readRodStatusReg (unsigned int rod, long regNumber)
	Read one ROD Status Register via HPI.
unsigned long	readRodCommandReg (unsigned int rod, long regNumber)
	Read one ROD Command Register via HPI.
unsigned long	dspSingleRead (unsigned int rod, const unsigned long dspAddr, long dspNumber)
	Read a single 32b word from MasterDSP SDRAM via HPI.
void	dspSingleWrite (unsigned int rod, unsigned long dspAddr, unsigned long value, long dspNumber)
	Write a single 32b word to MasterDSP SDRAM via HPI.
void	createDebugPrimList ()
	Create a prim list.
void	addDebugPrimList (unsigned long length, long index, long id, long version, unsigned long *body)
	Insert a primitive in a prim list.
void	sendDebugPrimList (unsigned int rod)
	Send the previously created prim list.
void	sendDebugPrimListAll ()
	Send the previously created prim list to all RODs.
void	sendDebugSlavePrimList (unsigned int rod, unsigned int slave, bool await, bool response)
	Send prim list to slave.
void	debugPrimListFromFile (const char *fileName)
void	dumpDebugPrimList ()
std::list< SctApi::RodLabel >	listRods ()
unsigned long *	retrieveModule (UINT32 mid)
	Return the module configuration data for the required module.
UINT32	findModule (const char *sn)
UINT32	findModule (INT32 mur, INT32 module)
	Return unique identifier for mur/module.
UINT32	findBarrelModule (INT32 barrel, INT32 row, INT32 number)
	Return unique identifer from barrel geometry.
UINT32	findEndcapModule (INT32 disk, INT32 ring, INT32 number)
	Return unique identifer from endcap geometry.
void	getABCDModules (UINT32 bank)
	Get all modules from ROD to memory.
void	getABCDModule (UINT32 mid, UINT32 bank)
	Get module from ROD to memory.
void	setABCDModules (UINT32 bank)
	Set all module configs in a ROD bank.
void	copyABCDModules (UINT32 source, std::list< UINT32 > targets)
	Copy all module config between banks.
void	copyABCDModules (UINT32 mid, UINT32 source, std::list< UINT32 > targets)
	Copy a single module config between banks.
void	setABCDModules (std::list< UINT32 > banks)
void	setABCDModule (UINT32 mid, UINT32 bank)
	Set module config in ROD bank.
void	sendABCDModule (UINT32 mid, UINT32 bank, UINT32 type=SctApi::SCTAPI_CONFIG_ALL)
void	sendABCDModules (UINT32 bank, UINT32 type=SctApi::SCTAPI_CONFIG_ALL)
void	modifyABCDMask (UINT32 mid, UINT32 *mask)
	Modify mask of module in online configuration.
void	modifyABCDTrims (UINT32 mid, UINT8 *trims)
	Modify trims of module in online configuration.
void	setAutoUpdateBanks (std::list< UINT32 > banks)
	update these banks when doing modifyABCDVar
void	setAutoUpdateBank (UINT32 bank)
	update this bank when doing modifyABCDVar
void	modifyABCDVar (UINT32 typ, FLOAT32 var)
	Modify variable of all modules in online configuration.
void	modifyABCDVar (UINT32 mid, UINT32 typ, FLOAT32 var)
	Modify variable of module in online configuration.
void	modifyABCDVar (UINT32 mid, UINT32 c, UINT32 typ, FLOAT32 var)
	Modify variable of one chip of module in online configuration.
void	modifyABCDVarROD (UINT32 mid, UINT32 chip, UINT32 typ, FLOAT32 var, UINT32 bank)
	Modify variable for specific module/chip in ROD bank.
void	modifyABCDVarROD (UINT32 mid, UINT32 chip, UINT32 typ, FLOAT32 var, std::list< UINT32 > banks)
	Modify variable for specific module/chip in ROD bank.
void	modifyABCDVarROD (UINT32 mid, UINT32 typ, FLOAT32 var, UINT32 bank)
	Modify variable for specific module/chip in ROD bank.
void	modifyABCDVarROD (UINT32 mid, UINT32 typ, FLOAT32 var, std::list< UINT32 > banks)
	Modify variable for specific module/chip in ROD bank.
void	modifyABCDVarROD (UINT32 typ, FLOAT32 var, UINT32 bank)
	Modify variable in ROD bank.
void	modifyABCDVarROD (UINT32 typ, FLOAT32 var, std::list< UINT32 > banks)
	Modify variable in ROD bank.
void	modifyBOCParam (unsigned int rod, unsigned int channel, unsigned int type, unsigned int val)
	Modify a BOC variable.
void	modifyBOCParam (unsigned int type, unsigned int val)
	Modify all BOC parameters.
void	defaultScan (int type)
	Do a scan (hardcoded for testing).
void	tidyHistogramming ()
	Tidy up just in case things got left behind.
TScanMonitor *	startAsyncScan (TScanDef tscan)
	Start an asynchronous (no SctApi control) scan.
void	doScan (TScanDef scan)
	Carry out the scan defined by scan.
void	awaitScan ()
void	doRawScan (TScanDef scan, int delay, int width, bool configure=true, bool clkBy2=false)
	Scan returning histograms of raw data.
void	sendRodTrigger (unsigned int rod, TTrigger trig, unsigned long count, int scan_point=0)
	Send one trigger to the currently configured modules.
unsigned long	sendTriggers (TTrigger trig, unsigned long count)
	send lots of triggers.
void	printABCDModule (int mid)
	Uses the sctConf method.
void	printABCDRodModule (int mid, int bank)
	Uses the sctConf method.
void	printBOCSetup (unsigned int rod)
	Print BOC setup of all channels.
void	currentBOCSetup (unsigned int rod)
void	printBOCRegisters (unsigned int rod)
	Print all BOC registers.
void	saveBOCSetup (unsigned int rod, UINT32 bank)
	Save BOC setup.
void	saveBOCRegisters (unsigned int rod, UINT32 bank)
	Save BOC registers.
void	restoreBOCSetup (unsigned int rod, UINT32 bank)
	Response BOC setup.
void	restoreBOCRegisters (unsigned int rod, UINT32 bank)
	Restore BOC registers.
void	rawData (unsigned int rod, int delay, int units, bool setMask=true, TTrigger trig=TTrigger())
	Print raw link data.
char *	probe (unsigned int rod, signed int harness=-1)
	Probe channels on a ROD to find out what's there.
char *	probeWithTrigger (unsigned int rod, TTrigger trig, signed int harness=-1)
	Probe channels on a ROD to find out what's there.
void	probeScan (unsigned int rod, TScanDef scan, signed int harness=-1)
	Probe channels on a ROD to find out what's there.
bool	checkAllModulesProbe (const char *value)
	Probe all modules and check if value returned is in string.
void	autoConfigure ()
	Attempt to configure.
void	bocHistogram (unsigned int rod, unsigned int samples, unsigned int numLoops)
	Print "BOC Histogram".
void	rodMode (unsigned int rod, int mode, int flag, int fifoSetup, int nBins, int delay, int message)
	Do something to the rod mode!
void	standardRegisterDump (unsigned int rod)
void	lasersOff ()
	For extra safety (don't use with lots of modules connected.
void	scanEvents (unsigned int rod, int sl=-1, bool extFlag=false, bool errorType=false)
	Scan for events.
void	decodeEvent (unsigned int rod, int sl, int index, bool extFlag=false, bool errorType=false)
	Print decoded event.
void	decodeConfig (unsigned int rod, bool skipTrim=false, bool bypass=false)
	Decode config bit stream (only valid after SEND_CONFIG.
void	testLinkOutSelect (unsigned int rod, unsigned int link)
void	setDebugOption (const char *opt)
void	unsetDebugOption (const char *opt)
void	listEnabledDebugOptions ()
void	listDebugOptions ()
void	debugStepHistogram ()
void	debugContinueHistogram ()
void	debugAbortHistogram ()
void	timSetFrequency (double trigFreq, double rstFreq)
	Set both trigger and reset frequency.
double	timGetResetFrequency ()
	Hz.
double	timGetTriggerFrequency ()
	kHz
void	freeTriggers ()
	Use currently set frequency.
void	stopTriggers ()
	Stop the TIM generating regular triggers.
void	timL1A ()
	Tell the TIM to send an L1A.
void	timCalL1A (int delay)
	Tell TIM to send Cal + L1A.
void	timSoftReset ()
	Tell the TIM to send a softReset.
void	timBCReset ()
	Tell the TIM to send a BCR.
unsigned long	sendTimBurst (unsigned long count, int random, bool external=false)
	Send a burst of triggers from the TIM.
unsigned long	runTimSequence (unsigned long count, int random, bool external=false)
	Run a sequence from the TIM.
void	timVerbose ()
	Print info about the TIM.
void	timRegLoad (int reg, UINT16 val)
UINT16	timReadRegister (int reg)
void	requestHardReset (UINT32 mid)
void	resumePolling ()
void	stopPolling ()
Private Member Functions
	TApi (const TApi &)
TApi &	operator= (const TApi &)
Private Attributes
SctApi::SctApi *	worker
	The worker that implements the functions.

---

Detailed Description

The Root interface to SCTAPI.

This class is processed to generate a Root dictionary that means it can be used from Root. This is basically a proxy for the SctApi class, all methods on it are delegated to an instance of the SctApi class which is created on construction.

A secondary purpose of this class is to extract the public interface from the SctApi class. This means that this class should be capable of doing anything it is necessary to do using the SctApi class, and also serves the purpose of testing the abstraction from the underlying RodModule classes and exceptions.

Definition at line 221 of file TApi.h.

---

Constructor & Destructor Documentation

TApi::TApi (  std::string  plugin = "xml"  )

Constructor.

TApi::~TApi (   )

Destructor. Definition at line 54 of file TApi.cxx. References worker.

---

Member Function Documentation

void TApi::addDebugPrimList (  unsigned long  length, long  index, long  id, long  version, unsigned long *  body )

Insert a primitive in a prim list. Definition at line 272 of file TApi.cxx. References SctApi::SctApi::addDebugPrimList(), and worker. Here is the call graph for this function:

void TApi::autoConfigure (   )

Attempt to configure. Definition at line 651 of file TApi.cxx. References worker.

void TApi::awaitResponse (  unsigned int  rod, int  timeout = 5 )

Wait for a ROD to finish a primlist. Definition at line 106 of file TApi.cxx. References SctApi::SctApi::awaitResponse(), and worker. Here is the call graph for this function:

void TApi::bocHistogram (  unsigned int  rod, unsigned int  samples, unsigned int  numLoops )

Print "BOC Histogram". Definition at line 673 of file TApi.cxx. References SctApi::SctApi::bocHistogram(), and worker. Here is the call graph for this function:

void TApi::changeRunMode (  enum SctApi::RunType  mode  )

Change global run mode. Definition at line 83 of file TApi.cxx. References SctApi::SctApi::changeRunMode(), and worker. Here is the call graph for this function:

bool TApi::checkAllModulesProbe (  const char *  value  )

Probe all modules and check if value returned is in string. Definition at line 647 of file TApi.cxx. References SctApi::SctApi::checkAllModulesProbe(), and worker. Here is the call graph for this function:

void TApi::configureBOC (  unsigned int  rod  )

Reset BOC configuration. Definition at line 260 of file TApi.cxx. References SctApi::SctApi::configureBOC(), and worker. Here is the call graph for this function:

void TApi::copyABCDModules (  UINT32  mid, UINT32  source, std::list< UINT32 >  targets )

Copy a single module config between banks. Definition at line 499 of file TApi.cxx. References SctApi::SctApi::copyABCDModule(), and worker. Here is the call graph for this function:

void TApi::copyABCDModules (  UINT32  source, std::list< UINT32 >  targets )

Copy all module config between banks. Definition at line 486 of file TApi.cxx. References SctApi::SctApi::copyABCDModules(), and worker. Here is the call graph for this function:

void TApi::createDebugPrimList (   )

Create a prim list. Definition at line 290 of file TApi.cxx. References SctApi::SctApi::createDebugPrimList(), and worker. Here is the call graph for this function:

void TApi::decodeConfig (  unsigned int  rod, bool  skipTrim = false, bool  bypass = false )

Decode config bit stream (only valid after SEND_CONFIG. Definition at line 744 of file TApi.cxx. References SctApi::SctApi::decodeConfig(), and worker. Here is the call graph for this function:

void TApi::decodeEvent (  unsigned int  rod, int  sl, int  index, bool  extFlag = false, bool  errorType = false )

Print decoded event. Definition at line 739 of file TApi.cxx. References SctApi::SctApi::decodeEvent(), and worker. Here is the call graph for this function:

void TApi::defaultScan (  int  type  )

Do a scan (hardcoded for testing). Definition at line 351 of file TApi.cxx. References SctApi::SctApi::defaultScan(), and worker. Here is the call graph for this function:

void TApi::doRawScan (  TScanDef  scan, int  delay, int  width, bool  configure = true, bool  clkBy2 = false )

Scan returning histograms of raw data. Definition at line 402 of file TApi.cxx. References SctApi::SctApi::doRawScan(), ScanDefWrapper::getScan(), TScanDef::update(), SctApi::SctApiException::what(), and worker. Here is the call graph for this function:

void TApi::doScan (  TScanDef  scan  )

Carry out the scan defined by scan. Definition at line 380 of file TApi.cxx. References SctApi::SctApi::doScan(), ScanDefWrapper::getScan(), TScanDef::update(), SctApi::SctApiException::what(), and worker. Here is the call graph for this function:

int TApi::dspBlockDump (  unsigned int  rod, long  dspStart, long  numWords, long  dspNumber, bool  usePrimitive = true )

Dump contents of a block of DSP memory to cout. Definition at line 309 of file TApi.cxx. References SctApi::SctApi::dspBlockDump(), and worker. Here is the call graph for this function:

int TApi::dspBlockDumpFile (  unsigned int  rod, long  dspStart, long  numWords, long  dspNumber, const char *  filename, bool  usePrimitive = true )

Dump contents of a block of DSP memory to a file. Definition at line 314 of file TApi.cxx. References SctApi::SctApi::dspBlockDumpFile(), and worker. Here is the call graph for this function:

unsigned long * TApi::dspBlockRead (  unsigned int  rod, long  dspStart, long  numWords, long  dspNumber, unsigned long *  length, bool  usePrimitive = true )

Read data. Definition at line 323 of file TApi.cxx. References SctApi::SctApi::dspBlockRead(), and worker. Here is the call graph for this function:

int TApi::dspBlockWrite (  unsigned int  rod, unsigned long *  buffer, unsigned long  dspAddress, long  numWords, long  dspNumber, bool  usePrimitive = true )

Write a block of memory to a ROD DSP. Definition at line 333 of file TApi.cxx. References SctApi::SctApi::dspBlockWrite(), and worker. Here is the call graph for this function:

unsigned long TApi::dspSingleRead (  unsigned int  rod, const unsigned long  dspAddr, long  dspNumber )

Read a single 32b word from MasterDSP SDRAM via HPI. Definition at line 340 of file TApi.cxx. References SctApi::SctApi::dspSingleRead(), and worker. Here is the call graph for this function:

void TApi::dspSingleWrite (  unsigned int  rod, unsigned long  dspAddr, unsigned long  value, long  dspNumber )

Write a single 32b word to MasterDSP SDRAM via HPI. Definition at line 346 of file TApi.cxx. References SctApi::SctApi::dspSingleWrite(), and worker. Here is the call graph for this function:

void TApi::echo (  unsigned int  rod, unsigned int  length, unsigned long *  data )

Using a primitive, send some data to the ROD. Expect an output. Definition at line 92 of file TApi.cxx. References SctApi::SctApi::echo(), and worker. Here is the call graph for this function:

void TApi::echoAll (  unsigned int  length, unsigned long *  data )

Using a primitive, send some data to the ROD. Expect an output. Definition at line 97 of file TApi.cxx. References SctApi::SctApi::echoAll(), and worker. Here is the call graph for this function:

void TApi::echoSlave (  unsigned int  rod, unsigned int  slave, unsigned int  length, unsigned long *  data )

Using a primitive, send some data to the ROD. Expect an output. Definition at line 101 of file TApi.cxx. References SctApi::SctApi::echoSlave(), and worker. Here is the call graph for this function:

UINT32 TApi::findBarrelModule (  INT32  barrel, INT32  row, INT32  number )

Return unique identifer from barrel geometry. Definition at line 264 of file TApi.cxx. References SctApi::SctApi::findBarrelModule(), and worker. Here is the call graph for this function:

UINT32 TApi::findEndcapModule (  INT32  disk, INT32  ring, INT32  number )

Return unique identifer from endcap geometry. Definition at line 268 of file TApi.cxx. References SctApi::SctApi::findEndcapModule(), and worker. Here is the call graph for this function:

UINT32 TApi::findModule (  INT32  mur, INT32  module )

Return unique identifier for mur/module. Definition at line 144 of file TApi.cxx. References SctApi::SctApi::findModule(), and worker. Here is the call graph for this function:

UINT32 TApi::findModule (  const char *  sn  )

Parameters: sn  Module serial number Returns: The unique identifier, BAD_MODULE if not found Definition at line 140 of file TApi.cxx. References SctApi::SctApi::findModule(), and worker. Here is the call graph for this function:

void TApi::flashLED (  unsigned int  rod, long  slaveNumber, long  period = 1000, long  flashes = 10 )

This creates its own primitive list and sends it to a slave DSP on the ROD. Period given in ms Definition at line 87 of file TApi.cxx. References SctApi::SctApi::flashLED(), and worker. Here is the call graph for this function:

void TApi::freeTriggers (   )

Use currently set frequency. Definition at line 762 of file TApi.cxx. References SctApi::SctApi::freeTriggers(), and worker. Here is the call graph for this function:

void TApi::getABCDModule (  UINT32  mid, UINT32  bank )

Get module from ROD to memory. Definition at line 168 of file TApi.cxx. References SctApi::SctApi::getABCDModule(), and worker. Here is the call graph for this function:

void TApi::getABCDModules (  UINT32  bank  )

Get all modules from ROD to memory. Definition at line 164 of file TApi.cxx. References SctApi::SctApi::getABCDModules(), and worker. Here is the call graph for this function:

unsigned long * TApi::getResponse (  unsigned int  rod, unsigned long *  length )

Get a response from the rod. Definition at line 126 of file TApi.cxx. References SctApi::SctApi::getResponse(), and worker. Here is the call graph for this function:

unsigned long * TApi::getResponse (  unsigned int  rod  )

Get a response from the rod. Definition at line 110 of file TApi.cxx. References SctApi::SctApi::getResponse(), and worker. Here is the call graph for this function:

bool TApi::getRodMessage (  unsigned int  rod, char *  buffer, unsigned long &  length )

Get a message from a ROD text buffer Returns whether the action was completed. Definition at line 135 of file TApi.cxx. References SctApi::SctApi::getRodMessage(), and worker. Here is the call graph for this function:

void TApi::initialiseAll (  int  runNumber  )

Initialise all the Rods and modules found in the configuration. Definition at line 60 of file TApi.cxx. References SctApi::SctApi::initialiseAll(), and worker. Here is the call graph for this function:

void TApi::lasersOff (   )

For extra safety (don't use with lots of modules connected. Definition at line 730 of file TApi.cxx. References SctApi::SctApi::lasersOff(), and worker. Here is the call graph for this function:

void TApi::loadConfiguration (   )

Reload configuration from the "configuration database". Definition at line 252 of file TApi.cxx. References SctApi::SctApi::loadConfiguration(), and worker. Here is the call graph for this function:

void TApi::loadModuleConfigurations (   )

Load module configurations from the "configuration database". Definition at line 256 of file TApi.cxx. References SctApi::SctApi::loadModuleConfigurations(), and worker. Here is the call graph for this function:

void TApi::modifyABCDMask (  UINT32  mid, UINT32 *  mask )

Modify mask of module in online configuration. Definition at line 172 of file TApi.cxx. References SctApi::SctApi::modifyABCDMask(), and worker. Here is the call graph for this function:

void TApi::modifyABCDTrims (  UINT32  mid, UINT8 *  trims )

Modify trims of module in online configuration. Definition at line 176 of file TApi.cxx. References SctApi::SctApi::modifyABCDTrims(), and worker. Here is the call graph for this function:

void TApi::modifyABCDVar (  UINT32  mid, UINT32  c, UINT32  typ, FLOAT32  var )

Modify variable of one chip of module in online configuration. Definition at line 188 of file TApi.cxx. References SctApi::SctApi::modifyABCDVar(), and worker. Here is the call graph for this function:

void TApi::modifyABCDVar (  UINT32  mid, UINT32  typ, FLOAT32  var )

Modify variable of module in online configuration. Definition at line 184 of file TApi.cxx. References SctApi::SctApi::modifyABCDVar(), and worker. Here is the call graph for this function:

void TApi::modifyABCDVar (  UINT32  typ, FLOAT32  var )

Modify variable of all modules in online configuration. Definition at line 180 of file TApi.cxx. References SctApi::SctApi::modifyABCDVar(), and worker. Here is the call graph for this function:

void TApi::modifyABCDVarROD (  UINT32  typ, FLOAT32  var, std::list< UINT32 >  banks )

Modify variable in ROD bank. Definition at line 234 of file TApi.cxx.

void TApi::modifyABCDVarROD (  UINT32  typ, FLOAT32  var, UINT32  bank )

Modify variable in ROD bank. Definition at line 230 of file TApi.cxx. References SctApi::SctApi::modifyABCDVarROD(), and worker. Here is the call graph for this function:

void TApi::modifyABCDVarROD (  UINT32  mid, UINT32  typ, FLOAT32  var, std::list< UINT32 >  banks )

Modify variable for specific module/chip in ROD bank. Definition at line 222 of file TApi.cxx.

void TApi::modifyABCDVarROD (  UINT32  mid, UINT32  typ, FLOAT32  var, UINT32  bank )

Modify variable for specific module/chip in ROD bank. Definition at line 218 of file TApi.cxx. References SctApi::SctApi::modifyABCDVarROD(), and worker. Here is the call graph for this function:

void TApi::modifyABCDVarROD (  UINT32  mid, UINT32  chip, UINT32  typ, FLOAT32  var, std::list< UINT32 >  banks )

Modify variable for specific module/chip in ROD bank. Definition at line 210 of file TApi.cxx.

void TApi::modifyABCDVarROD (  UINT32  mid, UINT32  chip, UINT32  typ, FLOAT32  var, UINT32  bank )

Modify variable for specific module/chip in ROD bank. Definition at line 206 of file TApi.cxx. References SctApi::SctApi::modifyABCDVarROD(), and worker. Here is the call graph for this function:

void TApi::modifyBOCParam (  unsigned int  type, unsigned int  val )

Modify all BOC parameters. Definition at line 248 of file TApi.cxx. References SctApi::SctApi::modifyBOCParam(), and worker. Here is the call graph for this function:

void TApi::modifyBOCParam (  unsigned int  rod, unsigned int  channel, unsigned int  type, unsigned int  val )

Modify a BOC variable. Definition at line 242 of file TApi.cxx. References SctApi::SctApi::modifyBOCParam(), and worker. Here is the call graph for this function:

void TApi::printABCDModule (  int  mid  )

Uses the sctConf method. Definition at line 516 of file TApi.cxx. References SctApi::SctApi::printABCDModule(), and worker. Here is the call graph for this function:

void TApi::printABCDRodModule (  int  mid, int  bank )

Uses the sctConf method. Definition at line 520 of file TApi.cxx. References SctApi::SctApi::printABCDRodModule(), and worker. Here is the call graph for this function:

void TApi::printBOCRegisters (  unsigned int  rod  )

Print all BOC registers. Definition at line 548 of file TApi.cxx. References SctApi::SctApi::printBOCRegisters(), and worker. Here is the call graph for this function:

void TApi::printBOCSetup (  unsigned int  rod  )

Print BOC setup of all channels. Definition at line 525 of file TApi.cxx. References SctApi::SctApi::printBOCSetup(), and worker. Here is the call graph for this function:

char * TApi::probe (  unsigned int  rod, signed int  harness = -1 )

Probe channels on a ROD to find out what's there. Definition at line 584 of file TApi.cxx. References SctApi::SctApi::probe(), and worker. Here is the call graph for this function:

void TApi::probeScan (  unsigned int  rod, TScanDef  scan, signed int  harness = -1 )

Probe channels on a ROD to find out what's there. Definition at line 622 of file TApi.cxx. References ScanDefWrapper::getScan(), SctApi::SctApi::probeScan(), TScanDef::update(), and worker. Here is the call graph for this function:

char * TApi::probeWithTrigger (  unsigned int  rod, TTrigger  trig, signed int  harness = -1 )

Probe channels on a ROD to find out what's there. Definition at line 598 of file TApi.cxx. References TriggerWrapper::getTrigger(), SctApi::SctApi::probeWithTrigger(), TTrigger::update(), and worker. Here is the call graph for this function:

void TApi::rawData (  unsigned int  rod, int  delay, int  units, bool  setMask = true, TTrigger  trig = TTrigger() )

Print raw link data. Definition at line 572 of file TApi.cxx. References TriggerWrapper::getTrigger(), SctApi::SctApi::rawData(), TTrigger::update(), and worker. Here is the call graph for this function:

unsigned long TApi::readRodCommandReg (  unsigned int  rod, long  regNumber )

Read one ROD Command Register via HPI. Definition at line 445 of file TApi.cxx. References SctApi::SctApi::readRodCommandReg(), and worker. Here is the call graph for this function:

unsigned long TApi::readRodStatusReg (  unsigned int  rod, long  regNumber )

Read one ROD Status Register via HPI. Definition at line 450 of file TApi.cxx. References SctApi::SctApi::readRodStatusReg(), and worker. Here is the call graph for this function:

void TApi::restoreBOCRegisters (  unsigned int  rod, UINT32  bank )

Restore BOC registers. Definition at line 568 of file TApi.cxx. References SctApi::SctApi::restoreBOCRegisters(), and worker. Here is the call graph for this function:

void TApi::restoreBOCSetup (  unsigned int  rod, UINT32  bank )

Response BOC setup. Definition at line 564 of file TApi.cxx. References SctApi::SctApi::restoreBOCSetup(), and worker. Here is the call graph for this function:

unsigned long * TApi::retrieveModule (  UINT32  mid  )

Return the module configuration data for the required module. Definition at line 512 of file TApi.cxx. References SctApi::SctApi::retrieveModule(), and worker. Here is the call graph for this function:

void TApi::rodMode (  unsigned int  rod, int  mode, int  flag, int  fifoSetup, int  nBins, int  delay, int  message )

Do something to the rod mode! Definition at line 667 of file TApi.cxx. References SctApi::SctApi::rodMode(), and worker. Here is the call graph for this function:

unsigned long TApi::runTimSequence (  unsigned long  count, int  random, bool  external = false )

Run a sequence from the TIM. Returns: last l1id Definition at line 790 of file TApi.cxx. References SctApi::SctApi::timRunSequence(), and worker. Here is the call graph for this function:

void TApi::saveBOCRegisters (  unsigned int  rod, UINT32  bank )

Save BOC registers. Definition at line 560 of file TApi.cxx. References SctApi::SctApi::saveBOCRegisters(), and worker. Here is the call graph for this function:

void TApi::saveBOCSetup (  unsigned int  rod, UINT32  bank )

Save BOC setup. Definition at line 556 of file TApi.cxx. References SctApi::SctApi::saveBOCSetup(), and worker. Here is the call graph for this function:

void TApi::scanEvents (  unsigned int  rod, int  sl = -1, bool  extFlag = false, bool  errorType = false )

Scan for events. Definition at line 734 of file TApi.cxx. References SctApi::SctApi::scanEvents(), and worker. Here is the call graph for this function:

void TApi::sendABCDModule (  UINT32  mid, UINT32  bank, UINT32  type = SctApi::SCTAPI_CONFIG_ALL )

Parameters: mid  Unique identifier of the module to send bank  Configuration bank in the ROD type  How much configuration to transmit Definition at line 156 of file TApi.cxx. References SctApi::SctApi::sendABCDModule(), SctApi::SctApiException::what(), and worker. Here is the call graph for this function:

void TApi::sendABCDModules (  UINT32  bank, UINT32  type = SctApi::SCTAPI_CONFIG_ALL )

Parameters: bank  Configuration bank in the ROD type  How much configuration to transmit Definition at line 148 of file TApi.cxx. References SctApi::SctApi::sendAllABCDModules(), SctApi::SctApiException::what(), and worker. Here is the call graph for this function:

void TApi::sendDebugPrimList (  unsigned int  rod  )

Send the previously created prim list. Definition at line 277 of file TApi.cxx. References SctApi::SctApi::sendDebugPrimList(), and worker. Here is the call graph for this function:

void TApi::sendDebugPrimListAll (   )

Send the previously created prim list to all RODs. Definition at line 281 of file TApi.cxx. References SctApi::SctApi::sendDebugPrimListAll(), and worker. Here is the call graph for this function:

void TApi::sendDebugSlavePrimList (  unsigned int  rod, unsigned int  slave, bool  await, bool  response )

Send prim list to slave. Definition at line 285 of file TApi.cxx. References SctApi::SctApi::sendDebugSlavePrimList(), and worker. Here is the call graph for this function:

void TApi::sendRodTrigger (  unsigned int  rod, TTrigger  trig, unsigned long  count, int  scan_point = 0 )

Send one trigger to the currently configured modules. Definition at line 430 of file TApi.cxx. References TriggerWrapper::getTrigger(), SctApi::SctApi::sendRodTrigger(), TTrigger::update(), and worker. Here is the call graph for this function:

unsigned long TApi::sendTimBurst (  unsigned long  count, int  random, bool  external = false )

Send a burst of triggers from the TIM. Returns: last l1id Definition at line 786 of file TApi.cxx. References SctApi::SctApi::sendTimBurst(), and worker. Here is the call graph for this function:

unsigned long TApi::sendTriggers (  TTrigger  trig, unsigned long  count )

send lots of triggers. frequency and source worked out from trigger Returns: last l1id; Definition at line 419 of file TApi.cxx. References TriggerWrapper::getTrigger(), SctApi::SctApi::sendTriggers(), TTrigger::update(), and worker. Here is the call graph for this function:

void TApi::setABCDModule (  UINT32  mid, UINT32  bank )

Set module config in ROD bank. Definition at line 455 of file TApi.cxx. References SctApi::SctApi::setABCDModule(), SctApi::SctApiException::what(), and worker. Here is the call graph for this function:

void TApi::setABCDModules (  UINT32  bank  )

Set all module configs in a ROD bank. Definition at line 477 of file TApi.cxx. References SctApi::SctApi::setABCDModules(), SctApi::SctApiException::what(), and worker. Here is the call graph for this function:

void TApi::setAutoUpdateBank (  UINT32  bank  )

update this bank when doing modifyABCDVar Definition at line 200 of file TApi.cxx. References SctApi::SctApi::setAutoUpdateBanks(), and worker. Here is the call graph for this function:

void TApi::setAutoUpdateBanks (  std::list< UINT32 >  banks  )

update these banks when doing modifyABCDVar Definition at line 192 of file TApi.cxx.

void TApi::setRunNumber (  int  newRun  )

Change the run number. Definition at line 75 of file TApi.cxx. References SctApi::SctApi::setRunNumber(), and worker. Here is the call graph for this function:

void TApi::setScanNumber (  int  newScan  )

Change the scan number. Definition at line 79 of file TApi.cxx. References SctApi::SctApi::setScanNumber(), and worker. Here is the call graph for this function:

void TApi::shutdownAll (   )

Shutdown everything. Definition at line 71 of file TApi.cxx. References SctApi::SctApi::shutdownAll(), and worker. Here is the call graph for this function:

TScanMonitor * TApi::startAsyncScan (  TScanDef  tscan  )

Start an asynchronous (no SctApi control) scan. Definition at line 359 of file TApi.cxx. References ScanMonitorWrapper::createMonitor(), ScanDefWrapper::getScan(), SctApi::SctApi::startAsyncScan(), TScanDef::update(), SctApi::SctApiException::what(), and worker. Here is the call graph for this function:

void TApi::stopTriggers (   )

Stop the TIM generating regular triggers. Definition at line 766 of file TApi.cxx. References SctApi::SctApi::stopTriggers(), and worker. Here is the call graph for this function:

void TApi::tidyHistogramming (   )

Tidy up just in case things got left behind. Definition at line 355 of file TApi.cxx. References SctApi::SctApi::tidyHistogramming(), and worker. Here is the call graph for this function:

void TApi::timBCReset (   )

Tell the TIM to send a BCR. Definition at line 782 of file TApi.cxx. References SctApi::SctApi::timBCReset(), and worker. Here is the call graph for this function:

void TApi::timCalL1A (  int  delay  )

Tell TIM to send Cal + L1A. Definition at line 774 of file TApi.cxx. References SctApi::SctApi::timCalL1A(), and worker. Here is the call graph for this function:

double TApi::timGetResetFrequency (   )

Hz. Definition at line 758 of file TApi.cxx. References SctApi::SctApi::timGetResetFrequency(), and worker. Here is the call graph for this function:

double TApi::timGetTriggerFrequency (   )

kHz Definition at line 754 of file TApi.cxx. References SctApi::SctApi::timGetTriggerFrequency(), and worker. Here is the call graph for this function:

void TApi::timL1A (   )

Tell the TIM to send an L1A. Definition at line 770 of file TApi.cxx. References SctApi::SctApi::timL1A(), and worker. Here is the call graph for this function:

void TApi::timSetFrequency (  double  trigFreq, double  rstFreq )

Set both trigger and reset frequency. Definition at line 749 of file TApi.cxx. References SctApi::SctApi::timSetFrequency(), and worker. Here is the call graph for this function:

void TApi::timSoftReset (   )

Tell the TIM to send a softReset. Definition at line 778 of file TApi.cxx. References SctApi::SctApi::timSoftReset(), and worker. Here is the call graph for this function:

void TApi::timVerbose (   )

Print info about the TIM. Definition at line 794 of file TApi.cxx. References SctApi::SctApi::timVerbose(), and worker. Here is the call graph for this function:

---

Field Documentation

SctApi::SctApi* TApi::worker [private]

The worker that implements the functions. Definition at line 670 of file TApi.h. Referenced by addDebugPrimList(), autoConfigure(), awaitResponse(), awaitScan(), bocHistogram(), changeRunMode(), checkAllModulesProbe(), configureBOC(), copyABCDModules(), createDebugPrimList(), currentBOCSetup(), debugAbortHistogram(), debugContinueHistogram(), debugPrimListFromFile(), debugStepHistogram(), decodeConfig(), decodeEvent(), defaultScan(), doRawScan(), doScan(), dspBlockDump(), dspBlockDumpFile(), dspBlockRead(), dspBlockWrite(), dspSingleRead(), dspSingleWrite(), dumpDebugPrimList(), echo(), echoAll(), echoSlave(), findBarrelModule(), findEndcapModule(), findModule(), flashLED(), freeTriggers(), getABCDModule(), getABCDModules(), getResponse(), getRodMessage(), initialiseAll(), isInitialised(), lasersOff(), listDebugOptions(), listEnabledDebugOptions(), listRods(), loadConfiguration(), loadModuleConfigurations(), modifyABCDMask(), modifyABCDTrims(), modifyABCDVar(), modifyABCDVarROD(), modifyBOCParam(), printABCDModule(), printABCDRodModule(), printBOCRegisters(), printBOCSetup(), probe(), probeScan(), probeWithTrigger(), rawData(), readRodCommandReg(), readRodStatusReg(), requestHardReset(), restoreBOCRegisters(), restoreBOCSetup(), resumePolling(), retrieveModule(), rodMode(), runTimSequence(), saveBOCRegisters(), saveBOCSetup(), scanEvents(), sendABCDModule(), sendABCDModules(), sendDebugPrimList(), sendDebugPrimListAll(), sendDebugSlavePrimList(), sendRodTrigger(), sendTimBurst(), sendTriggers(), setABCDModule(), setABCDModules(), setAutoUpdateBank(), setDebugOption(), setRunNumber(), setScanNumber(), shutdownAll(), standardRegisterDump(), startAsyncScan(), status(), stopPolling(), stopTriggers(), testLinkOutSelect(), tidyHistogramming(), timBCReset(), timCalL1A(), timGetResetFrequency(), timGetTriggerFrequency(), timL1A(), timReadRegister(), timRegLoad(), timSetFrequency(), timSoftReset(), timVerbose(), unsetDebugOption(), and ~TApi().

---

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

• TApi.h
• TApi.cxx

---