---

ZDCDataFrame Class Reference

Precision readout digi for ZDC. More...

#include <DataFormats/HcalDigi/interface/ZDCDataFrame.h>

List of all members.

Public Types
typedef HcalZDCDetId	key_type
	For the sorted collection.
Public Member Functions
const HcalElectronicsId &	elecId () const
const HcalZDCDetId &	id () const
const HcalQIESample &	operator[] (int i) const
	access a sample
int	presamples () const
	number of samples before the sample from the triggered beam crossing (according to the hardware)
const HcalQIESample &	sample (int i) const
	access a sample
void	setPresamples (int ps)
void	setReadoutIds (const HcalElectronicsId &eid)
void	setSample (int i, const HcalQIESample &sam)
void	setSize (int size)
void	setZSInfo (bool unsuppressed, bool markAndPass)
int	size () const
	total number of samples in the digi
bool	validate (int firstSample=0, int nSamples=100) const
	validate appropriate DV and ER bits as well as capid rotation for the specified samples (default is all)
	ZDCDataFrame (const HcalZDCDetId &id)
	ZDCDataFrame ()
bool	zsMarkAndPass () const
	was ZS MarkAndPass?
bool	zsUnsuppressed () const
	was ZS unsuppressed?
Static Public Attributes
static const int	MAXSAMPLES = 10
Private Attributes
HcalQIESample	data_ [MAXSAMPLES]
HcalElectronicsId	electronicsId_
int	hcalPresamples_
HcalZDCDetId	id_
int	size_

---

Detailed Description

Precision readout digi for ZDC.

Definition at line 15 of file ZDCDataFrame.h.

---

Member Typedef Documentation

typedef HcalZDCDetId ZDCDataFrame::key_type

For the sorted collection.

Definition at line 17 of file ZDCDataFrame.h.

---

Constructor & Destructor Documentation

ZDCDataFrame::ZDCDataFrame

(

)

Definition at line 3 of file ZDCDataFrame.cc.

                           : id_(0), 
                             size_(0),
                             hcalPresamples_(0)
{
}

ZDCDataFrame::ZDCDataFrame

(

const HcalZDCDetId &

id

)

[explicit]

Definition at line 9 of file ZDCDataFrame.cc.

                                                 : 
  id_(id), 
  size_(0),
  hcalPresamples_(0)
{
  // TODO : test id for ZDC
}

---

Member Function Documentation

const HcalElectronicsId& ZDCDataFrame::elecId

(

)

const [inline]

Definition at line 23 of file ZDCDataFrame.h.

References electronicsId_.

{ return electronicsId_; }

const HcalZDCDetId& ZDCDataFrame::id

(

void

)

const [inline]

Definition at line 22 of file ZDCDataFrame.h.

References id_.

Referenced by HcalNominalCoder::adc2fC(), and operator<<().

{ return id_; }

const HcalQIESample& ZDCDataFrame::operator[]

(

int

i

)

const [inline]

access a sample

Definition at line 35 of file ZDCDataFrame.h.

References data_.

{ return data_[i]; }

int ZDCDataFrame::presamples

(

)

const [inline]

number of samples before the sample from the triggered beam crossing (according to the hardware)

Definition at line 28 of file ZDCDataFrame.h.

References hcalPresamples_.

Referenced by HcalNominalCoder::adc2fC(), and operator<<().

{ return hcalPresamples_&0xF; }

const HcalQIESample& ZDCDataFrame::sample

(

int

i

)

const [inline]

access a sample

Definition at line 37 of file ZDCDataFrame.h.

References data_.

Referenced by operator<<().

{ return data_[i]; }

void ZDCDataFrame::setPresamples

(

int

ps

)

Definition at line 22 of file ZDCDataFrame.cc.

References hcalPresamples_.

                                       {
  hcalPresamples_|=ps&0xF;
}

void ZDCDataFrame::setReadoutIds

(

const HcalElectronicsId &

eid

)

Definition at line 25 of file ZDCDataFrame.cc.

References electronicsId_.

                                                             {
  electronicsId_=eid;
}

void ZDCDataFrame::setSample	(	int	i,
		const HcalQIESample &	sam
	)			[inline]

Definition at line 45 of file ZDCDataFrame.h.

References data_.

{ data_[i]=sam; }

void ZDCDataFrame::setSize

(

int

size

)

Definition at line 17 of file ZDCDataFrame.cc.

References MAXSAMPLES, and size_.

                                   {
  if (size>MAXSAMPLES) size_=MAXSAMPLES;
  else if (size<=0) size_=0;
  else size_=size;
}

void ZDCDataFrame::setZSInfo	(	bool	unsuppressed,
		bool	markAndPass
	)

Definition at line 41 of file ZDCDataFrame.cc.

References hcalPresamples_.

                                                                {
  if (markAndPass) hcalPresamples_|=0x10;
  if (unsuppressed) hcalPresamples_|=0x20;
}

int ZDCDataFrame::size

(

void

)

const [inline]

total number of samples in the digi

Definition at line 26 of file ZDCDataFrame.h.

References size_.

Referenced by HcalNominalCoder::adc2fC(), and operator<<().

{ return size_&0xF; }

bool ZDCDataFrame::validate	(	int	firstSample = 0,
		int	nSamples = 100
	)			const

validate appropriate DV and ER bits as well as capid rotation for the specified samples (default is all)

Definition at line 29 of file ZDCDataFrame.cc.

References HcalQIESample::capid(), data_, i, and size_.

                                                               {
  int capid=-1;
  bool ok=true;
  for (int i=0; ok && i<nSamples && i+firstSample<size_; i++) {
    if (data_[i+firstSample].er() || !data_[i+firstSample].dv()) ok=false;
    if (i==0) capid=data_[i+firstSample].capid();
    if (capid!=data_[i+firstSample].capid()) ok=false;
    capid=(capid+1)%4;
  }
  return ok;
}

bool ZDCDataFrame::zsMarkAndPass

(

)

const [inline]

was ZS MarkAndPass?

Definition at line 30 of file ZDCDataFrame.h.

References hcalPresamples_.

Referenced by operator<<().

{ return (hcalPresamples_&0x10); }

bool ZDCDataFrame::zsUnsuppressed

(

)

const [inline]

was ZS unsuppressed?

Definition at line 32 of file ZDCDataFrame.h.

References hcalPresamples_.

Referenced by operator<<().

{ return (hcalPresamples_&0x20); }

---

Member Data Documentation

HcalQIESample ZDCDataFrame::data_[MAXSAMPLES] [private]

Definition at line 54 of file ZDCDataFrame.h.

Referenced by operator[](), sample(), setSample(), and validate().

HcalElectronicsId ZDCDataFrame::electronicsId_ [private]

Definition at line 51 of file ZDCDataFrame.h.

Referenced by elecId(), and setReadoutIds().

int ZDCDataFrame::hcalPresamples_ [private]

Definition at line 53 of file ZDCDataFrame.h.

Referenced by presamples(), setPresamples(), setZSInfo(), zsMarkAndPass(), and zsUnsuppressed().

HcalZDCDetId ZDCDataFrame::id_ [private]

Definition at line 50 of file ZDCDataFrame.h.

Referenced by id().

const int ZDCDataFrame::MAXSAMPLES = 10 [static]

Definition at line 48 of file ZDCDataFrame.h.

Referenced by setSize().

int ZDCDataFrame::size_ [private]

Definition at line 52 of file ZDCDataFrame.h.

Referenced by setSize(), size(), and validate().

---

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

• DataFormats/HcalDigi/interface/ZDCDataFrame.h
• DataFormats/HcalDigi/src/ZDCDataFrame.cc

---