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...

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
size_t	getSizeof ()
	Definition of method to get size of data type. More...
JReader &	operator>> (JReader &, JDAQHit &)
	Read DAQ hit from input. More...
JWriter &	operator<< (JWriter &, const JDAQHit &)
	Write DAQ hit to output. More...
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...

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 34 of file JDAQHit.hh.

Member Typedef Documentation

typedef unsigned char KM3NETDAQ::JDAQHit::JPMT_t

PMT channel in FPGA.

Definition at line 38 of file JDAQHit.hh.

typedef unsigned int KM3NETDAQ::JDAQHit::JTDC_t

leading edge [ns]

Definition at line 39 of file JDAQHit.hh.

typedef unsigned char KM3NETDAQ::JDAQHit::JTOT_t

time over threshold [ns]

Definition at line 40 of file JDAQHit.hh.

Constructor & Destructor Documentation

KM3NETDAQ::JDAQHit::JDAQHit ( )

inline

Default constructor.

Definition at line 49 of file JDAQHit.hh.

    {}

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 60 of file JDAQHit.hh.

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

Member Function Documentation

JPMT_t KM3NETDAQ::JDAQHit::getPMT ( ) const

inline

Get PMT.

Returns

PMT

Definition at line 75 of file JDAQHit.hh.

    { 
      return pmt;
    }

JTDC_t KM3NETDAQ::JDAQHit::getT ( ) const

inline

Get time.

Returns

time [ns]

Definition at line 86 of file JDAQHit.hh.

    { 
      return ntohl(tdc);
    }

JTOT_t KM3NETDAQ::JDAQHit::getToT ( ) const

inline

Get time-over-threshold.

Returns

time-over-threshold [ns]

Definition at line 97 of file JDAQHit.hh.

    { 
      return tot;
    }

static JTOT_t KM3NETDAQ::JDAQHit::getMaximalToT ( )

inlinestatic

Get maximal time-over-threshold.

Returns

time-over-threshold [ns]

Definition at line 108 of file JDAQHit.hh.

    {
      return 0xFF;
    }

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

Friends And Related Function Documentation

size_t getSizeof ( )

friend

Definition of method to get size of data type.

This method should be specialised for each desired data type with fixed length.

Returns

number of bytes

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

friend

Read DAQ hit from input.

Parameters

in	reader
hit	DAQ hit

Returns

reader

Definition at line 34 of file JDAQHitIO.hh.

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

    return in;
  }

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

friend

Write DAQ hit to output.

Parameters

out	writer
hit	DAQ hit

Returns

writer

Definition at line 51 of file JDAQHitIO.hh.

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

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 121 of file JDAQHit.hh.

    {
      int pmt;
      int tdc;
      int tot;

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

      return in;
    }

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 142 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;
    }

Member Data Documentation

JPMT_t KM3NETDAQ::JDAQHit::pmt

protected

PMT readout channel in FPGA.

Definition at line 158 of file JDAQHit.hh.

JTDC_t KM3NETDAQ::JDAQHit::tdc

protected

leading edge [ns]

Definition at line 159 of file JDAQHit.hh.

JTOT_t KM3NETDAQ::JDAQHit::tot

protected

time over threshold [ns]

Definition at line 160 of file JDAQHit.hh.

---

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

• JDAQHit.hh