SctApi::Crate Class Reference

A representation of the crate controller. More...

#include <crate.h>

Inheritance diagram for SctApi::Crate:

[legend]

Public Types
enum	PLControl { C_PL_STOP, C_PL_PAUSE, C_PL_RESUME, C_PL_CANCEL }
	C_PL_STOP Abort the current primitiveList C_PL_PAUSE Pause the current primitiveList C_PL_RESUME Resume the current primitiveList C_PL_CANCEL Cancel the recently sent primitiveList (only if not started execution). More...
Public Member Functions
	Crate ()
	An empty default constructor.
virtual	~Crate ()
	Delete all the RodModules and VmeInterface.
virtual int	initialiseCrate ()=0
	Return number of RODs initialised.
virtual int	initialiseTim ()=0
	Return 0 for success.
virtual int	initialiseRod (unsigned int rod)=0
	Store object in local map.
virtual int	initialiseBOC (unsigned int rod)=0
	Return 0 for success.
virtual int	configureBOC (unsigned int rod)=0
	Return 0 for success.
virtual int	sendPrimList (unsigned int rod, boost::shared_ptr< PrimListWrapper > prim)=0
	Return 0 for success.
virtual int	sendPrimListAll (boost::shared_ptr< PrimListWrapper > prim)=0
	Return 0 for success.
virtual int	awaitResponse (unsigned int rod, int timeout)=0
	Await response from a ROD within this crate.
virtual int	awaitResponseAll (int timeout)=0
	Handle text messages sent by the RODs (print to stdout).
virtual boost::shared_ptr< SctPixelRod::RodOutList >	getResponse (unsigned int rod)=0
	Return the response to the last primlist (a wrapped copy).
virtual void	setMrsStream (MRSStream *stream)=0
virtual bool	getRodMessage (unsigned int rod, char *buffer, unsigned long &length)=0
virtual int	mdspBlockRead (unsigned int rod, long dspStart, unsigned long *buffer, unsigned long numWords)=0
	Proxy for RodModule method.
virtual int	slvBlockRead (unsigned int rod, long dspStart, unsigned long *buffer, unsigned long numWords, long slaveNumber)=0
	Proxy for RodModule method.
virtual int	slvBlockWrite (unsigned int rod, long dspStart, unsigned long *buffer, unsigned long numWords, long dspNumber)=0
	Proxy for RodModule method.
virtual int	mdspBlockWrite (unsigned int rod, long dspStart, unsigned long *buffer, unsigned long numWords)=0
	Proxy for RodModule method.
virtual unsigned long	readRodStatusReg (unsigned int rod, long regNumber)=0
	Proxy for RodModule method.
virtual unsigned long	readRodCommandReg (unsigned int rod, long regNumber)=0
	Proxy for RodModule method.
virtual unsigned long	dspSingleRead (unsigned int rod, const unsigned long dspAddr, long dspNumber)=0
	Proxy for RodModule method.
virtual int	dspSingleWrite (unsigned int rod, unsigned long dspAddr, unsigned long buffer, long dspNumber)=0
	Proxy for RodModule method.
virtual void	status ()=0
	Print status of rods on crate.
virtual void	primListControl (unsigned int rod, PLControl function)=0
	Control the primitive list running on a rod (Untested).
virtual void	printBOCSetup (unsigned int rod)=0
	Print all BOC paramters as set up.
virtual std::vector< SctConfiguration::BOCChannelConfig >	currentBOCSetup (unsigned int rod)=0
	Return channel parameters as stored in BOC.
virtual void	printBOCRegisters (unsigned int rod)=0
	Print all BOC registers.
virtual SctConfiguration::BOCGlobalConfig	currentBOCRegisters (unsigned int rod)=0
	Return global registers as stored in BOC.
virtual void	saveBOCSetup (unsigned int rod)=0
	Save BOC channel setup.
virtual void	saveBOCRegisters (unsigned int rod)=0
	Save BOC register setup.
virtual void	restoreBOCSetup (unsigned int rod)=0
	Restore BOC channel setup.
virtual void	restoreBOCRegisters (unsigned int rod)=0
	Restore BOC register setup.
virtual bool	checkBOCLasersOn (unsigned int rod)=0
	Check BOC laser interlock.
virtual void	enterBOCClockBy2Mode (unsigned int rod)=0
	Setup BOC to sample at 20MHz.
virtual void	leaveBOCClockBy2Mode (unsigned int rod)=0
	Restore BOC to 40MHz mode.
virtual void	modifyBOCParam (unsigned int type, unsigned int val, bool raw)=0
virtual void	modifyBOCParam (unsigned int rod, unsigned int channel, unsigned int type, unsigned int val, bool raw)=0
virtual void	lasersOff ()=0
	Turn all BOC laser currents to 0.
virtual void	timSetFrequency (double trigFreq, double rstFreq)=0
virtual void	freeTriggers ()=0
	Start the TIM generating regular triggers.
virtual void	stopTriggers ()=0
	Stop the TIM generating regular triggers.
virtual void	timL1A ()=0
	Tell the TIM to send an L1A.
virtual void	timCalL1A (int delay)=0
	Tell TIM to send Cal + L1A.
virtual void	timECR ()=0
virtual void	timBCR ()=0
virtual void	timFER ()=0
virtual void	sendTimBurst (int count)=0
	Tell TIM to send a burst of triggers.
virtual void	timVerbose ()=0
	Print all the Tim registers.
virtual void	timRegLoad (int reg, UINT16 val)=0
	Debug, load TIM register.
virtual UINT16	timRegRead (int reg)=0
	Debug, read TIM register.
virtual bool	slavePresent (int rod, int index) const=0
	Check if a slave has been started.
virtual void	slaveStarted (int rod, int slave)=0
	Notify that slave was started externally...
virtual bool	RODPresent (int rod) const=0
	Check if a ROD has been configured.
virtual long	getRodSlot (int rod) const=0
virtual int	getRodRevision (int rod) const=0
	Get ROD Revision.
virtual void	stopPolling ()=0
	Stop the primitive list polling.
virtual void	resumePolling ()=0
	Restart the primitive list polling.
Private Member Functions
	Crate (const Crate &)
Crate &	operator= (const Crate &)

---

Detailed Description

A representation of the crate controller.

This is used by SCTAPI to send commands to RodModule objects. These are stored in crate memory.

Module configuration will eventually be stored here also?

Definition at line 49 of file crate.h.

---

Member Enumeration Documentation

enum SctApi::Crate::PLControl

C_PL_STOP Abort the current primitiveList C_PL_PAUSE Pause the current primitiveList C_PL_RESUME Resume the current primitiveList C_PL_CANCEL Cancel the recently sent primitiveList (only if not started execution). Definition at line 208 of file crate.h.

---

Constructor & Destructor Documentation

SctApi::Crate::Crate (   )  [inline]

An empty default constructor. Definition at line 55 of file crate.h.

virtual SctApi::Crate::~Crate (   )  [inline, virtual]

Delete all the RodModules and VmeInterface. Definition at line 61 of file crate.h.

---

Member Function Documentation

virtual int SctApi::Crate::awaitResponse (  unsigned int  rod, int  timeout )  [pure virtual]

Await response from a ROD within this crate. Handle text messages sent by the ROD (print to stdout) If waiting longer than timeout seconds then return anyway Implemented in SctApi::CrateImpl.

virtual int SctApi::Crate::awaitResponseAll (  int  timeout  )  [pure virtual]

Handle text messages sent by the RODs (print to stdout). If waiting longer than timeout seconds then return anyway Implemented in SctApi::CrateImpl.

virtual bool SctApi::Crate::checkBOCLasersOn (  unsigned int  rod  )  [pure virtual]

Check BOC laser interlock. Implemented in SctApi::CrateImpl.

virtual int SctApi::Crate::configureBOC (  unsigned int  rod  )  [pure virtual]

Return 0 for success. Implemented in SctApi::CrateImpl.

virtual SctConfiguration::BOCGlobalConfig SctApi::Crate::currentBOCRegisters (  unsigned int  rod  )  [pure virtual]

Return global registers as stored in BOC. Implemented in SctApi::CrateImpl.

virtual std::vector<SctConfiguration::BOCChannelConfig> SctApi::Crate::currentBOCSetup (  unsigned int  rod  )  [pure virtual]

Return channel parameters as stored in BOC. Implemented in SctApi::CrateImpl.

virtual unsigned long SctApi::Crate::dspSingleRead (  unsigned int  rod, const unsigned long  dspAddr, long  dspNumber )  [pure virtual]

Proxy for RodModule method. Implemented in SctApi::CrateImpl.

virtual int SctApi::Crate::dspSingleWrite (  unsigned int  rod, unsigned long  dspAddr, unsigned long  buffer, long  dspNumber )  [pure virtual]

Proxy for RodModule method. Implemented in SctApi::CrateImpl.

virtual void SctApi::Crate::enterBOCClockBy2Mode (  unsigned int  rod  )  [pure virtual]

Setup BOC to sample at 20MHz. Implemented in SctApi::CrateImpl.

virtual void SctApi::Crate::freeTriggers (   )  [pure virtual]

Start the TIM generating regular triggers. Implemented in SctApi::CrateImpl.

virtual boost::shared_ptr<SctPixelRod::RodOutList> SctApi::Crate::getResponse (  unsigned int  rod  )  [pure virtual]

Return the response to the last primlist (a wrapped copy). Implemented in SctApi::CrateImpl.

virtual bool SctApi::Crate::getRodMessage (  unsigned int  rod, char *  buffer, unsigned long &  length )  [pure virtual]

Parameters: rod  Index of ROD buffer  Buffer to write text into length  Length of buffer allocated, on return contains amount of data copied. Return message from ROD if present Implemented in SctApi::CrateImpl.

virtual int SctApi::Crate::getRodRevision (  int  rod  )  const [pure virtual]

Get ROD Revision. Implemented in SctApi::CrateImpl.

virtual int SctApi::Crate::initialiseBOC (  unsigned int  rod  )  [pure virtual]

Return 0 for success. Implemented in SctApi::CrateImpl.

virtual int SctApi::Crate::initialiseCrate (   )  [pure virtual]

Return number of RODs initialised. Implemented in SctApi::CrateImpl.

virtual int SctApi::Crate::initialiseRod (  unsigned int  rod  )  [pure virtual]

Store object in local map. Return 0 for success Implemented in SctApi::CrateImpl.

virtual int SctApi::Crate::initialiseTim (   )  [pure virtual]

Return 0 for success. Implemented in SctApi::CrateImpl.

virtual void SctApi::Crate::lasersOff (   )  [pure virtual]

Turn all BOC laser currents to 0. Implemented in SctApi::CrateImpl.

virtual void SctApi::Crate::leaveBOCClockBy2Mode (  unsigned int  rod  )  [pure virtual]

Restore BOC to 40MHz mode. Implemented in SctApi::CrateImpl.

virtual int SctApi::Crate::mdspBlockRead (  unsigned int  rod, long  dspStart, unsigned long *  buffer, unsigned long  numWords )  [pure virtual]

Proxy for RodModule method. Implemented in SctApi::CrateImpl.

virtual int SctApi::Crate::mdspBlockWrite (  unsigned int  rod, long  dspStart, unsigned long *  buffer, unsigned long  numWords )  [pure virtual]

Proxy for RodModule method. Implemented in SctApi::CrateImpl.

virtual void SctApi::Crate::modifyBOCParam (  unsigned int  rod, unsigned int  channel, unsigned int  type, unsigned int  val, bool  raw )  [pure virtual]

Parameters: raw  If false then map module channel to BOC, otherwise channel refers to BOC channel Implemented in SctApi::CrateImpl.

virtual void SctApi::Crate::modifyBOCParam (  unsigned int  type, unsigned int  val, bool  raw )  [pure virtual]

Parameters: raw  If false then map module channel to BOC, otherwise channel refers to BOC channel Implemented in SctApi::CrateImpl.

virtual void SctApi::Crate::primListControl (  unsigned int  rod, PLControl  function )  [pure virtual]

Control the primitive list running on a rod (Untested). Implemented in SctApi::CrateImpl.

virtual void SctApi::Crate::printBOCRegisters (  unsigned int  rod  )  [pure virtual]

Print all BOC registers. Implemented in SctApi::CrateImpl.

virtual void SctApi::Crate::printBOCSetup (  unsigned int  rod  )  [pure virtual]

Print all BOC paramters as set up. Implemented in SctApi::CrateImpl.

virtual unsigned long SctApi::Crate::readRodCommandReg (  unsigned int  rod, long  regNumber )  [pure virtual]

Proxy for RodModule method. Implemented in SctApi::CrateImpl.

virtual unsigned long SctApi::Crate::readRodStatusReg (  unsigned int  rod, long  regNumber )  [pure virtual]

Proxy for RodModule method. Implemented in SctApi::CrateImpl.

virtual void SctApi::Crate::restoreBOCRegisters (  unsigned int  rod  )  [pure virtual]

Restore BOC register setup. Implemented in SctApi::CrateImpl.

virtual void SctApi::Crate::restoreBOCSetup (  unsigned int  rod  )  [pure virtual]

Restore BOC channel setup. Implemented in SctApi::CrateImpl.

virtual void SctApi::Crate::resumePolling (   )  [pure virtual]

Restart the primitive list polling. Implemented in SctApi::CrateImpl.

virtual bool SctApi::Crate::RODPresent (  int  rod  )  const [pure virtual]

Check if a ROD has been configured. Implemented in SctApi::CrateImpl.

virtual void SctApi::Crate::saveBOCRegisters (  unsigned int  rod  )  [pure virtual]

Save BOC register setup. Implemented in SctApi::CrateImpl.

virtual void SctApi::Crate::saveBOCSetup (  unsigned int  rod  )  [pure virtual]

Save BOC channel setup. Implemented in SctApi::CrateImpl.

virtual int SctApi::Crate::sendPrimList (  unsigned int  rod, boost::shared_ptr< PrimListWrapper >  prim )  [pure virtual]

Return 0 for success. Implemented in SctApi::CrateImpl.

virtual int SctApi::Crate::sendPrimListAll (  boost::shared_ptr< PrimListWrapper >  prim  )  [pure virtual]

Return 0 for success. Implemented in SctApi::CrateImpl.

virtual void SctApi::Crate::sendTimBurst (  int  count  )  [pure virtual]

Tell TIM to send a burst of triggers. Implemented in SctApi::CrateImpl.

virtual bool SctApi::Crate::slavePresent (  int  rod, int  index )  const [pure virtual]

Check if a slave has been started. Implemented in SctApi::CrateImpl.

virtual void SctApi::Crate::slaveStarted (  int  rod, int  slave )  [pure virtual]

Notify that slave was started externally... Implemented in SctApi::CrateImpl.

virtual int SctApi::Crate::slvBlockRead (  unsigned int  rod, long  dspStart, unsigned long *  buffer, unsigned long  numWords, long  slaveNumber )  [pure virtual]

Proxy for RodModule method. Implemented in SctApi::CrateImpl.

virtual int SctApi::Crate::slvBlockWrite (  unsigned int  rod, long  dspStart, unsigned long *  buffer, unsigned long  numWords, long  dspNumber )  [pure virtual]

Proxy for RodModule method. Implemented in SctApi::CrateImpl.

virtual void SctApi::Crate::status (   )  [pure virtual]

Print status of rods on crate. Implemented in SctApi::CrateImpl.

virtual void SctApi::Crate::stopPolling (   )  [pure virtual]

Stop the primitive list polling. Implemented in SctApi::CrateImpl.

virtual void SctApi::Crate::stopTriggers (   )  [pure virtual]

Stop the TIM generating regular triggers. Implemented in SctApi::CrateImpl.

virtual void SctApi::Crate::timCalL1A (  int  delay  )  [pure virtual]

Tell TIM to send Cal + L1A. Implemented in SctApi::CrateImpl.

virtual void SctApi::Crate::timL1A (   )  [pure virtual]

Tell the TIM to send an L1A. Implemented in SctApi::CrateImpl.

virtual void SctApi::Crate::timRegLoad (  int  reg, UINT16  val )  [pure virtual]

Debug, load TIM register. Implemented in SctApi::CrateImpl.

virtual UINT16 SctApi::Crate::timRegRead (  int  reg  )  [pure virtual]

Debug, read TIM register. Implemented in SctApi::CrateImpl.

virtual void SctApi::Crate::timSetFrequency (  double  trigFreq, double  rstFreq )  [pure virtual]

Parameters: trigFrequency  Frequency of triggers rstFrequency  Frequency of resets Implemented in SctApi::CrateImpl.

virtual void SctApi::Crate::timVerbose (   )  [pure virtual]

Print all the Tim registers. Implemented in SctApi::CrateImpl.

---

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

• crate.h

---