TrgGemRegisters Class Reference

TrgGemRegisters class definition. More...

Inheritance diagram for TrgGemRegisters:

[legend]Collaboration diagram for TrgGemRegisters:

[legend]List of all members.

Public Member Functions
	__init__ ()
	TrgGem constructor.
	configurationRegister ()
	configurationRegister() method
	widthRegister ()
	widthRegister method
	periodicRateRegister ()
	periodicRateRegister method
	periodicModeRegister ()
	periodicModeRegister method
	periodicLimitRegister ()
	periodicLimitRegister method
	sequenceRegister ()
	sequenceRegister method
	templateRegister (registerNumber)
	templateRegister method
	lookupTableRegister (registerNumber)
	lookupTableRegister method
	roiRegister (registerNumber)
	roiRegister method
	towerEnableRegister (registerNumber)
	towerEnableRegister method
	towerBusyEnableRegister ()
	towerBusyEnableRegister method
	externalEnableRegister ()
	externalEnableRegister method
	cnoEnableRegister ()
	cnoEnableRegister method
	tileEnableRegister (registerNumber)
	tileEnableRegister method
	width ()
	width 'pure virtual' method
	responseHeaderParityEven ()
	responseHeaderParityEven 'pure virtual' method
	responseDataParityEven ()
	responseDataParityEven 'pure virtual' method
	eventHeaderParityEven ()
	eventHeaderParityEven 'pure virtual' method
	eventDataParityEven ()
	eventDataParityEven 'pure virtual' method
	triggerParityEven ()
	TriggerParityEven 'pure virtual' method.
	inhibitContribution ()
	inhibitContribution 'pure virtual' method

---

Detailed Description

TrgGemRegisters class definition.

Implements the register shape definitions for a GASU trigger system

Definition at line 20 of file TrgGemRegisters.py.

---

Member Function Documentation

cnoEnableRegister (   )

cnoEnableRegister method Returns: integer Returns a 32 bit integer corresponding to the ACD CNO enable register Ref: LAT-TD-01545, 2.9.2

configurationRegister (   )

configurationRegister() method Method to construct the value of the GEM configuration register Returns: An integer

eventDataParityEven (   )

eventDataParityEven 'pure virtual' method Returns: A boolean This value specifies whether or not the parity associated with a trigger message body initiated by the GEM should be sent with odd or even parity. If the value returned is TRUE, trigger message bodies will have even parity. If the value returned is FALSE, trigger message bodies will have odd parity. Reimplemented from TrgGemAbstract.

eventHeaderParityEven (   )

eventHeaderParityEven 'pure virtual' method Returns: A boolean This value specifies whether or not the parity associated with a trigger message header initiated by the GEM should be sent with odd or even parity. If the value returned is TRUE, trigger message headers will have even parity. If the value returned is FALSE, trigger message headers will have odd parity. Reimplemented from TrgGemAbstract.

externalEnableRegister (   )

externalEnableRegister method Returns: integer Returns a 32 bit integer corresponding to the external enable register

inhibitContribution (   )

inhibitContribution 'pure virtual' method Returns: A boolean This value specifies whether or not the GEM transmits a contribution to the event. If the value returned is TRUE, GEM contributions are inhibited. If the value returned is FALSE, GEM contributions are sent with the event. Reimplemented from TrgGemAbstract.

lookupTableRegister (  registerNumber   )

lookupTableRegister method Parameters: registerNumber  A reference into the Scheduler register set Returns: integer Returns a 32 bit integer referencing the TAM generator used for a particular trigger summary Ref: LAT-TD-01545, S 2.7

periodicLimitRegister (   )

periodicLimitRegister method Returns: integer Returns a 32 bit integer corresponding to the PERIODIC_LIMITS register of the GEM. Ref: LAT-TD-01545, S 2.3.3.3

periodicModeRegister (   )

periodicModeRegister method Returns: integer Returns a 32 bit integer corresponding to the PERIODIC_MODE register of the GEM. Ref: LAT-TD-01545, S 2.3.3.2

periodicRateRegister (   )

periodicRateRegister method Returns: integer Returns a 32 bit integer corresponding to the PERIODIC_RATE register of the GEM. Ref: LAT-TD-01545, S 2.3.3.1

responseDataParityEven (   )

responseDataParityEven 'pure virtual' method Returns: A boolean This value specifies whether or not the parity associated with a command response packet body should be sent with odd or even parity. If the value returned is TRUE, response bodies will have even parity. If the value returned is FALSE, responses will have odd parity. Reimplemented from TrgGemAbstract.

responseHeaderParityEven (   )

responseHeaderParityEven 'pure virtual' method Returns: A boolean This value specifies whether or not the parity associated with a command responsepacket header should be sent with odd or even parity. If the value returned is TRUE, response headers will have even parity. If the value returned is FALSE, responses will have odd parity. Reimplemented from TrgGemAbstract.

roiRegister (  registerNumber   )

roiRegister method Parameters: registerNumber  A reference into the ROI generator registers Returns: integer Returns a 32 bit integer referencing the 54 ROI registers defined in Ref: LAT-TD-01545, S 2.8

sequenceRegister (   )

sequenceRegister method Returns: integer Returns a 32 bit integer corresponding to the SEQUENCE register of the GEM. Ref: LAT-TD-01545, S 2.3.4

templateRegister (  registerNumber   )

templateRegister method Parameters: registerNumber  An registerNumber value Returns: integer Returns a 32 bit integer corresponding to the message engine template register of the TAM. Ref: LAT-TD-01545, S 2.5 Context portion is defined in 1.8.6.1

tileEnableRegister (  registerNumber   )

tileEnableRegister method Parameters: registerNumber  Returns: integer Returns a 32 bit integer corresponding to the ACD tile enable register. Ref: LAT-TD-01545, 2.9.3

towerBusyEnableRegister (   )

towerBusyEnableRegister method Returns: integer Returns a 32 bit integer corresponding to the Tower Busy enable register

towerEnableRegister (  registerNumber   )

towerEnableRegister method Parameters: registerNumber  A reference into the tower enable registers Returns: integer Returns a 32 bit object corresponding to figures 78/79 of the GEM documentation. This is used to construct the registers TOWERS_0_3, etc. Ref: LAT-TD-01545, 2.9.1

triggerParityEven (   )

TriggerParityEven 'pure virtual' method. Returns: A boolean This value specifies whether or not the parity associated with a trigger message initiated by the GEM should be sent with odd or even parity. If the value returned is TRUE, trigger messages will have even parity. If the value returned is FALSE, trigger messages will have odd parity. Reimplemented from TrgGemAbstract.

width (   )

width 'pure virtual' method Returns: An int. This value specifies the window of the GEM's trigger window (see [4]). The width is specified in units of system clock, where one system clock is 50 nanoseconds. Reimplemented from TrgGemAbstract.

widthRegister (   )

widthRegister method Returns: integer Returns a 32 bit integer corresponding to the WINDOW_WIDTH register of the GEM. Ref: LAT-TD-01545, S 2.9.1

---

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

• TrgGemRegisters.py

---