DAQ triggered hit. More...

#include <JDAQTriggeredHit.hh>

Inheritance diagram for KM3NETDAQ::JDAQTriggeredHit:

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
	JDAQTriggeredHit ()
	Default constructor. More...

	JDAQTriggeredHit (const JDAQModuleIdentifier &ID, const JDAQHit &hit, const JDAQTriggerMask &mask)
	Constructor. More...

virtual	~JDAQTriggeredHit ()
	Virtual destructor. More...

	ClassDef (JDAQTriggeredHit, 2)

	operator JDAQPMTIdentifier () const
	Type conversion operator. More...

	ClassDef (JDAQKeyHit, 1)

const JDAQModuleIdentifier &	getModuleIdentifier () const
	Get Module identifier. More...

void	setModuleIdentifier (const JDAQModuleIdentifier &module)
	Set Module identifier. More...

int	getModuleID () const
	Get module identifier. More...

	ClassDefNV (JDAQModuleIdentifier, 1)

	ClassDefNV (JDAQHit, 1)

JPMT_t	getPMT () const
	Get PMT. More...

JTDC_t	getT () const
	Get time. More...

JTOT_t	getToT () const
	Get time-over-threshold. More...

const JDAQTriggerMask &	getDAQTriggerMask () const
	Get DAQ trigger mask. More...

JTriggerMask_t	getTriggerMask () const
	Get trigger mask. More...

void	setDAQTriggerMask (const JDAQTriggerMask &mask)
	Set trigger mask. More...

void	setTriggerMask (const JTriggerMask_t mask)
	Set trigger mask. More...

JDAQTriggerMask &	addTriggerMask (const JDAQTriggerMask &mask)
	Add trigger bit pattern. More...

bool	hasTriggerMask (const JDAQTriggerMask &mask) const
	Has trigger bit pattern. More...

JDAQTriggerMask &	addTriggerBit (const unsigned int bit)
	Add trigger bit. More...

bool	hasTriggerBit (const unsigned int bit) const
	Check trigger bit. More...

std::string	toString () const
	Convert trigger mask. More...

	ClassDef (JDAQTriggerMask, 1)

Static Public Member Functions
static JTOT_t	getMaximalToT ()
	Get maximal time-over-threshold. More...

static JDAQTriggerMask	valueOf (const std::string &buffer)
	Extract trigger mask. More...

Protected Attributes
int	id

JPMT_t	pmt
	PMT readout channel in FPGA. More...

JTDC_t	tdc
	leading edge [ns] More...

JTOT_t	tot
	time over threshold [ns] More...

JTriggerMask_t	trigger_mask

Friends
size_t	getSizeof ()
	Definition of method to get size of data type. More...

JReader &	operator>> (JReader &, JDAQTriggeredHit &)
	Read DAQ triggered hit from input. More...

JWriter &	operator<< (JWriter &, const JDAQTriggeredHit &)
	Write DAQ triggered hit to output. More...

Detailed Description

DAQ triggered hit.

Definition at line 20 of file JDAQTriggeredHit.hh.

Member Typedef Documentation

typedef unsigned char KM3NETDAQ::JDAQHit::JPMT_t

inherited

PMT channel in FPGA.

Definition at line 38 of file JDAQHit.hh.

typedef unsigned int KM3NETDAQ::JDAQHit::JTDC_t

inherited

leading edge [ns]

Definition at line 39 of file JDAQHit.hh.

typedef unsigned char KM3NETDAQ::JDAQHit::JTOT_t

inherited

time over threshold [ns]

Definition at line 40 of file JDAQHit.hh.

Constructor & Destructor Documentation

KM3NETDAQ::JDAQTriggeredHit::JDAQTriggeredHit ( )

inline

Default constructor.

Definition at line 33 of file JDAQTriggeredHit.hh.

                        :
       JDAQKeyHit     (),
       JDAQTriggerMask()
     {}

KM3NETDAQ::JDAQTriggeredHit::JDAQTriggeredHit	(	const JDAQModuleIdentifier &	ID,
		const JDAQHit &	hit,
		const JDAQTriggerMask &	mask
	)

inline

Constructor.

Parameters

ID	module identifier
hit	PMT hit
mask	trigger mask

Definition at line 46 of file JDAQTriggeredHit.hh.

                                                        :
       JDAQKeyHit(ID,hit),
       JDAQTriggerMask(mask)
     {}

virtual KM3NETDAQ::JDAQTriggeredHit::~JDAQTriggeredHit ( )

inlinevirtual

Virtual destructor.

Definition at line 57 of file JDAQTriggeredHit.hh.

58 {}

Member Function Documentation

KM3NETDAQ::JDAQTriggeredHit::ClassDef	(	JDAQTriggeredHit	,
		2
	)

KM3NETDAQ::JDAQKeyHit::operator JDAQPMTIdentifier ( ) const

inlineinherited

Type conversion operator.

Returns: axis

Definition at line 63 of file JDAQKeyHit.hh.

     {
       return JDAQPMTIdentifier(this->getModuleID(), this->getPMT());
     }

KM3NETDAQ::JDAQKeyHit::ClassDef	(	JDAQKeyHit	,
		1
	)

inherited

const JDAQModuleIdentifier& KM3NETDAQ::JDAQModuleIdentifier::getModuleIdentifier ( ) const

inlineinherited

Get Module identifier.

Returns: Module identifier

Definition at line 50 of file JDAQModuleIdentifier.hh.

     { 
       return *this; 
     }

void KM3NETDAQ::JDAQModuleIdentifier::setModuleIdentifier ( const JDAQModuleIdentifier & module )

inlineinherited

Set Module identifier.

Parameters

module Module identifier

Definition at line 61 of file JDAQModuleIdentifier.hh.

     { 
       *this = module;
     }

int KM3NETDAQ::JDAQModuleIdentifier::getModuleID ( ) const

inlineinherited

Get module identifier.

Returns: module identifier

Definition at line 72 of file JDAQModuleIdentifier.hh.

     { 
       return id;
     }

KM3NETDAQ::JDAQModuleIdentifier::ClassDefNV	(	JDAQModuleIdentifier	,
		1
	)

inherited

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

inherited

JPMT_t KM3NETDAQ::JDAQHit::getPMT ( ) const

inlineinherited

Get PMT.

Returns: PMT

Definition at line 75 of file JDAQHit.hh.

     { 
       return pmt;
     }

JTDC_t KM3NETDAQ::JDAQHit::getT ( ) const

inlineinherited

Get time.

Returns: time [ns]

Definition at line 86 of file JDAQHit.hh.

     { 
       return ntohl(tdc);
     }

JTOT_t KM3NETDAQ::JDAQHit::getToT ( ) const

inlineinherited

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 ( )

inlinestaticinherited

Get maximal time-over-threshold.

Returns: time-over-threshold [ns]

Definition at line 108 of file JDAQHit.hh.

     {
       return 0xFF;
     }

const JDAQTriggerMask& KM3NETDAQ::JDAQTriggerMask::getDAQTriggerMask ( ) const

inlineinherited

Get DAQ trigger mask.

Returns: DAQ trigger mask

Definition at line 95 of file JDAQTriggerMask.hh.

     {
       return static_cast<const JDAQTriggerMask&>(*this);
     }

JTriggerMask_t KM3NETDAQ::JDAQTriggerMask::getTriggerMask ( ) const

inlineinherited

Get trigger mask.

Returns: trigger mask

Definition at line 106 of file JDAQTriggerMask.hh.

     {
       return trigger_mask;
     }

void KM3NETDAQ::JDAQTriggerMask::setDAQTriggerMask ( const JDAQTriggerMask & mask )

inlineinherited

Set trigger mask.

Parameters

mask	trigger mask

Definition at line 117 of file JDAQTriggerMask.hh.

     {
       trigger_mask = mask.trigger_mask;
     }

void KM3NETDAQ::JDAQTriggerMask::setTriggerMask ( const JTriggerMask_t mask )

inlineinherited

Set trigger mask.

Parameters

mask	trigger mask

Definition at line 128 of file JDAQTriggerMask.hh.

     {
       trigger_mask = mask;
     }

JDAQTriggerMask& KM3NETDAQ::JDAQTriggerMask::addTriggerMask ( const JDAQTriggerMask & mask )

inlineinherited

Add trigger bit pattern.

Parameters

mask	trigger mask

Returns: trigger mask

Definition at line 140 of file JDAQTriggerMask.hh.

     {
       trigger_mask |= mask.trigger_mask;
 
       return *this;
     }

bool KM3NETDAQ::JDAQTriggerMask::hasTriggerMask ( const JDAQTriggerMask & mask ) const

inlineinherited

Has trigger bit pattern.

Parameters

mask	trigger mask

Returns: true if one of the bits is set; else false

Definition at line 154 of file JDAQTriggerMask.hh.

     {
       return trigger_mask & mask.trigger_mask;
     }

JDAQTriggerMask& KM3NETDAQ::JDAQTriggerMask::addTriggerBit ( const unsigned int bit )

inlineinherited

Add trigger bit.

Parameters

bit	trigger bit

Returns: trigger mask

Definition at line 166 of file JDAQTriggerMask.hh.

     {
       trigger_mask |= KM3NETDAQ::getTriggerMask(bit);
 
       return *this;
     }

bool KM3NETDAQ::JDAQTriggerMask::hasTriggerBit ( const unsigned int bit ) const

inlineinherited

Check trigger bit.

Parameters

bit	trigger bit

Returns: true if bit is set; else false

Definition at line 180 of file JDAQTriggerMask.hh.

     {
       return trigger_mask & KM3NETDAQ::getTriggerMask(bit);
     }

static JDAQTriggerMask KM3NETDAQ::JDAQTriggerMask::valueOf ( const std::string & buffer )

inlinestaticinherited

Extract trigger mask.

Parameters

buffer trigger bit pattern (i.e. sequence of '0' and '1').

Returns: trigger mask

Definition at line 192 of file JDAQTriggerMask.hh.

     {
       JDAQTriggerMask trigger_mask;
 
       unsigned int bit = 0;
 
       for (std::string::const_reverse_iterator i = buffer.rbegin(); i != buffer.rend() && bit != NUMBER_OF_TRIGGER_BITS; ++i, ++bit) {
         if (*i == '1') {
           trigger_mask.addTriggerBit(bit);
         }
       }
 
       return trigger_mask;
     }

std::string KM3NETDAQ::JDAQTriggerMask::toString ( ) const

inlineinherited

Convert trigger mask.

Returns: trigger bit pattern (i.e. sequence of '0' and '1').

Definition at line 213 of file JDAQTriggerMask.hh.

     {
       std::string buffer(NUMBER_OF_TRIGGER_BITS, '0');
 
       unsigned int bit = 0;
 
       for (std::string::reverse_iterator i = buffer.rbegin(); i != buffer.rend() && bit != NUMBER_OF_TRIGGER_BITS; ++i, ++bit) {
         if (hasTriggerBit(bit)) {
           *i = '1';
         }
       }
 
       return buffer;
     }

KM3NETDAQ::JDAQTriggerMask::ClassDef	(	JDAQTriggerMask	,
		1
	)

inherited

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,
		JDAQTriggeredHit &	hit
	)

friend

Read DAQ triggered hit from input.

Parameters

in	reader
hit	DAQ triggered hit

Returns: reader

Definition at line 36 of file JDAQTriggeredHitIO.hh.

   {
     in >> static_cast<JDAQKeyHit&>     (hit);
     in >> static_cast<JDAQTriggerMask&>(hit);
  
     return in;
   }

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

friend

Write DAQ triggered hit to output.

Parameters

out	writer
hit	DAQ triggered hit

Returns: writer

Definition at line 52 of file JDAQTriggeredHitIO.hh.

   {
     out << static_cast<const JDAQKeyHit&>     (hit);
     out << static_cast<const JDAQTriggerMask&>(hit);
 
     return out;
   }

Member Data Documentation

int KM3NETDAQ::JDAQModuleIdentifier::id

protectedinherited

Definition at line 112 of file JDAQModuleIdentifier.hh.

JPMT_t KM3NETDAQ::JDAQHit::pmt

protectedinherited

PMT readout channel in FPGA.

Definition at line 158 of file JDAQHit.hh.

JTDC_t KM3NETDAQ::JDAQHit::tdc

protectedinherited

leading edge [ns]

Definition at line 159 of file JDAQHit.hh.

JTOT_t KM3NETDAQ::JDAQHit::tot

protectedinherited

time over threshold [ns]

Definition at line 160 of file JDAQHit.hh.

JTriggerMask_t KM3NETDAQ::JDAQTriggerMask::trigger_mask

protectedinherited

Definition at line 267 of file JDAQTriggerMask.hh.

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

JDAQTriggeredHit.hh

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation