KM3NETDAQ::JDAQHit Class Reference

Hit data structure. More...

#include <JDAQHit.hh>

Inheritance diagram for KM3NETDAQ::JDAQHit:

Public Types
typedef unsigned char	JPMT_t
	PMT channel in FPGA. More...
typedef unsigned int	JTDC_t
	leading edge [ns] More...
typedef unsigned char	JTOT_t
	time over threshold [ns] More...

Public Member Functions
	JDAQHit ()
	Default constructor. More...
	JDAQHit (const JPMT_t pmt_id, const JTDC_t tdc_ns, const JTOT_t tot_ns)
	Constructor. More...
JPMT_t	getPMT () const
	Get PMT. More...
JTDC_t	getT () const
	Get time. More...
JTOT_t	getToT () const
	Get time-over-threshold. More...
	ClassDefNV (JDAQHit, 1)

Static Public Member Functions
static JTOT_t	getMaximalToT ()
	Get maximal time-over-threshold. More...
static int	sizeOf ()
	Get size of object. More...

Protected Attributes
JPMT_t	pmt
	PMT readout channel in FPGA. More...
JTDC_t	tdc
	leading edge [ns] More...
JTOT_t	tot
	time over threshold [ns] More...

Friends
std::istream &	operator>> (std::istream &in, JDAQHit &hit)
	Read DAQ hit from input. More...
std::ostream &	operator<< (std::ostream &out, const JDAQHit &hit)
	Write DAQ hit to output. More...
JReader &	operator>> (JReader &in, JDAQHit &hit)
	Read DAQ hit from input. More...
JWriter &	operator<< (JWriter &out, const JDAQHit &hit)
	Write DAQ hit to output. More...

Detailed Description

Hit data structure.

N.B. The size of this data structure (i.e. the value obtained with the sizeof() operator should exactly match the preset number of bytes from the DAQ system. The pragma statement is necessary to ensure the correct size of this object. Furthermore, this data structure should have no virtual methods and no virtual destructor. Consequently, the standard ROOT CLassDef() macro is replaced by the designated ClassDefNV() macro.

Definition at line 40 of file JDAQHit.hh.

Member Typedef Documentation

JPMT_t

typedef unsigned char KM3NETDAQ::JDAQHit::JPMT_t

PMT channel in FPGA.

Definition at line 44 of file JDAQHit.hh.

JTDC_t

typedef unsigned int KM3NETDAQ::JDAQHit::JTDC_t

leading edge [ns]

Definition at line 45 of file JDAQHit.hh.

JTOT_t

typedef unsigned char KM3NETDAQ::JDAQHit::JTOT_t

time over threshold [ns]

Definition at line 46 of file JDAQHit.hh.

Constructor & Destructor Documentation

JDAQHit() [1/2]

KM3NETDAQ::JDAQHit::JDAQHit ( )

inline

Default constructor.

Definition at line 52 of file JDAQHit.hh.

    {}

JDAQHit() [2/2]

KM3NETDAQ::JDAQHit::JDAQHit ( const JPMT_t  pmt_id, const JTDC_t  tdc_ns, const JTOT_t  tot_ns  )

inline

Constructor.

Parameters

pmt_id	PMT channel
tdc_ns	time of hit [ns]
tot_ns	time over threshold [ns]

Definition at line 63 of file JDAQHit.hh.

                                 :
      pmt(pmt_id),
      tdc(htonl(tdc_ns)),
      //tdc(tdc_ns),
      tot(tot_ns)
    {}

Member Function Documentation

getPMT()

JPMT_t KM3NETDAQ::JDAQHit::getPMT ( ) const

inline

Get PMT.

Returns

PMT

Definition at line 78 of file JDAQHit.hh.

    { 
      return pmt;
    }

getT()

JTDC_t KM3NETDAQ::JDAQHit::getT ( ) const

inline

Get time.

Returns

time [ns]

Definition at line 89 of file JDAQHit.hh.

    { 
      return ntohl(tdc);
    }

getToT()

JTOT_t KM3NETDAQ::JDAQHit::getToT ( ) const

inline

Get time-over-threshold.

Returns

time-over-threshold [ns]

Definition at line 100 of file JDAQHit.hh.

    { 
      return tot;
    }

getMaximalToT()

static JTOT_t KM3NETDAQ::JDAQHit::getMaximalToT ( )

inlinestatic

Get maximal time-over-threshold.

Returns

time-over-threshold [ns]

Definition at line 111 of file JDAQHit.hh.

    {
      return 0xFF;
    }

sizeOf()

static int KM3NETDAQ::JDAQHit::sizeOf ( )

inlinestatic

Get size of object.

Returns

number of bytes

Definition at line 196 of file JDAQHit.hh.

    {
      return sizeof(JDAQHit);
    }

ClassDefNV()

KM3NETDAQ::JDAQHit::ClassDefNV	(	JDAQHit	,
		1
	)

Friends And Related Function Documentation

operator>> [1/2]

std::istream& operator>> ( std::istream &  in, JDAQHit &  hit  )

friend

Read DAQ hit from input.

Parameters

in	input stream
hit	hit

Returns

input stream

Definition at line 124 of file JDAQHit.hh.

    {
      int pmt;
      int tdc;
      int tot;
 
      if (in >> pmt >> tdc >> tot) {
        hit = JDAQHit(pmt, tdc, tot);
      }
 
      return in;
    }

operator<< [1/2]

std::ostream& operator<< ( std::ostream &  out, const JDAQHit &  hit  )

friend

Write DAQ hit to output.

Parameters

out	output stream
hit	hit

Returns

output stream

Definition at line 145 of file JDAQHit.hh.

    {
      using namespace std;
 
      out << setw(2) << (int) hit.getPMT() << ' '
          << setw(8) << (int) hit.getT()   << ' '
          << setw(3) << (int) hit.getToT();
 
      return out;
    }

operator>> [2/2]

JReader& operator>> ( JReader &  in, JDAQHit &  hit  )

friend

Read DAQ hit from input.

Parameters

in	JReader
hit	JDAQHit

Returns

JReader

Definition at line 164 of file JDAQHit.hh.

    {
      in >> hit.pmt;
      in >> hit.tdc;
      in >> hit.tot;
 
      return in;
    }

operator<< [2/2]

JWriter& operator<< ( JWriter &  out, const JDAQHit &  hit  )

friend

Write DAQ hit to output.

Parameters

out	JWriter
hit	JDAQHit

Returns

JWriter

Definition at line 181 of file JDAQHit.hh.

    {
      out << hit.pmt;
      out << hit.tdc;
      out << hit.tot;
      
      return out;
    }

Member Data Documentation

pmt

JPMT_t KM3NETDAQ::JDAQHit::pmt

protected

PMT readout channel in FPGA.

Definition at line 206 of file JDAQHit.hh.

tdc

JTDC_t KM3NETDAQ::JDAQHit::tdc

protected

leading edge [ns]

Definition at line 207 of file JDAQHit.hh.

tot

JTOT_t KM3NETDAQ::JDAQHit::tot

protected

time over threshold [ns]

Definition at line 208 of file JDAQHit.hh.

---

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

• JDAQHit.hh