JTRIGGER::JPMTMask Class Reference

Auxiliary class for PMT mask. More...

#include <JPMTMask.hh>

Public Member Functions
	JPMTMask ()
	Default constructor.
	JPMTMask (const JPMTMask_t mask)
	Constructor.
	JPMTMask (const std::string &buffer)
	Constructor.
JPMTMask_t	getPMTMask () const
	Get PMT bit pattern.
JPMTMask &	addPMTMask (const JPMTMask_t mask)
	Add PMT mask.
JPMTMask &	addPMTMask (const JPMTMask &mask)
	Add PMT mask.
JPMTMask &	addPMTBit (const unsigned int bit)
	Add PMT bit.
JPMTMask &	addPMT (const JPMTReadoutAddress &channel)
	Add PMT channel.
bool	hasPMTBit (const unsigned int bit) const
	Check PMT bit.
bool	hasPMT (const JPMTReadoutAddress &channel) const
	Check PMT.
std::string	toString () const
	Convert PMT mask.

Static Public Member Functions
static JPMTMask	valueOf (const std::string &buffer)
	Extract PMT mask.
static int	sizeOf ()
	Get size of object.

Protected Attributes
JPMTMask_t	pmt_mask

Friends
std::istream &	operator>> (std::istream &in, JPMTMask &mask)
	Read PMT mask from input.
std::ostream &	operator<< (std::ostream &out, const JPMTMask &mask)
	Write PMT mask to output.
JReader &	operator>> (JReader &in, JPMTMask &mask)
	Read PMT mask from input.
JWriter &	operator<< (JWriter &out, const JPMTMask &mask)
	Write PMT mask to output.

Detailed Description

Auxiliary class for PMT mask.

Definition at line 56 of file JPMTMask.hh.

Constructor & Destructor Documentation

JPMTMask() [1/3]

JTRIGGER::JPMTMask::JPMTMask ( )

inline

Default constructor.

Definition at line 61 of file JPMTMask.hh.

               :
      pmt_mask(0)
    {}

JPMTMask() [2/3]

JTRIGGER::JPMTMask::JPMTMask ( const JPMTMask_t mask )

inline

Constructor.

Parameters

mask

PMT mask

Definition at line 71 of file JPMTMask.hh.

                                    :
      pmt_mask(mask)
    {}

JPMTMask() [3/3]

JTRIGGER::JPMTMask::JPMTMask ( const std::string & buffer )

inline

Constructor.

Parameters

buffer

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

Definition at line 81 of file JPMTMask.hh.

                                      :
      pmt_mask(valueOf(buffer).getPMTMask())
    {}

Member Function Documentation

getPMTMask()

JPMTMask_t JTRIGGER::JPMTMask::getPMTMask ( ) const

inline

Get PMT bit pattern.

Returns

PMT mask

Definition at line 91 of file JPMTMask.hh.

    {
      return pmt_mask;
    }

addPMTMask() [1/2]

JPMTMask & JTRIGGER::JPMTMask::addPMTMask ( const JPMTMask_t mask )

inline

Add PMT mask.

Parameters

mask

PMT mask

Returns

PMT mask

Definition at line 103 of file JPMTMask.hh.

    {
      pmt_mask |= mask;
 
      return *this;
    }

addPMTMask() [2/2]

JPMTMask & JTRIGGER::JPMTMask::addPMTMask ( const JPMTMask & mask )

inline

Add PMT mask.

Parameters

mask	PMTed mask

Returns

PMTed mask

Definition at line 117 of file JPMTMask.hh.

    {
      return addPMTMask(mask.getPMTMask());
    }

addPMTBit()

JPMTMask & JTRIGGER::JPMTMask::addPMTBit ( const unsigned int bit )

inline

Add PMT bit.

Parameters

bit

PMT bit

Returns

PMT mask

Definition at line 128 of file JPMTMask.hh.

    {
      pmt_mask |= JTRIGGER::getPMTMask(bit);
 
      return *this;
    }

addPMT()

JPMTMask & JTRIGGER::JPMTMask::addPMT ( const JPMTReadoutAddress & channel )

inline

Add PMT channel.

Parameters

channel

PMT readout channel

Returns

PMT mask

Definition at line 142 of file JPMTMask.hh.

    {
      return addPMTBit(channel.getTDC());
    }

hasPMTBit()

bool JTRIGGER::JPMTMask::hasPMTBit ( const unsigned int bit ) const

inline

Check PMT bit.

Parameters

bit

PMT bit

Returns

true if bit is set; else false

Definition at line 154 of file JPMTMask.hh.

    {
      return pmt_mask & JTRIGGER::getPMTMask(bit);
    }

hasPMT()

bool JTRIGGER::JPMTMask::hasPMT ( const JPMTReadoutAddress & channel ) const

inline

Check PMT.

Parameters

channel

PMT channel

Returns

true if PMT is selected; else false

Definition at line 165 of file JPMTMask.hh.

    {
      return hasPMTBit(channel.getTDC());
    }

valueOf()

static JPMTMask JTRIGGER::JPMTMask::valueOf ( const std::string & buffer )

inlinestatic

Extract PMT mask.

Parameters

buffer

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

Returns

PMT mask

Definition at line 177 of file JPMTMask.hh.

    {
      JPMTMask pmt_mask;
 
      unsigned int bit = 0;
 
      for (std::string::const_reverse_iterator i = buffer.rbegin(); i != buffer.rend() && bit != NUMBER_OF_PMT_BITS; ++i, ++bit) {
        if (*i == '1') {
          pmt_mask.addPMTBit(bit);
        }
      }
 
      return pmt_mask;
    }

toString()

std::string JTRIGGER::JPMTMask::toString ( ) const

inline

Convert PMT mask.

Returns

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

Definition at line 198 of file JPMTMask.hh.

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

sizeOf()

static int JTRIGGER::JPMTMask::sizeOf ( )

inlinestatic

Get size of object.

Returns

number of bytes

Definition at line 275 of file JPMTMask.hh.

    {
      return sizeof(JPMTMask_t);
    }

Friends And Related Symbol Documentation

operator>> [1/2]

std::istream & operator>> ( std::istream & in, JPMTMask & mask )

friend

Read PMT mask from input.

Parameters

in	input stream
mask	PMT mask

Returns

input stream

Definition at line 221 of file JPMTMask.hh.

    {
      return in >> mask.pmt_mask;
    }

operator<< [1/2]

std::ostream & operator<< ( std::ostream & out, const JPMTMask & mask )

friend

Write PMT mask to output.

Parameters

out	output stream
mask	PMT mask

Returns

output stream

Definition at line 234 of file JPMTMask.hh.

    {
      return out << mask.pmt_mask;
    }

operator>> [2/2]

JReader & operator>> ( JReader & in, JPMTMask & mask )

friend

Read PMT mask from input.

Parameters

in	reader
mask	PMT mask

Returns

reader

Definition at line 247 of file JPMTMask.hh.

    {
      in >> mask.pmt_mask;
 
      return in;
    }

operator<< [2/2]

JWriter & operator<< ( JWriter & out, const JPMTMask & mask )

friend

Write PMT mask to output.

Parameters

out	writer
mask	PMT mask

Returns

writer

Definition at line 262 of file JPMTMask.hh.

    {
      out << mask.pmt_mask;
 
      return out;
    }

Member Data Documentation

pmt_mask

JPMTMask_t JTRIGGER::JPMTMask::pmt_mask

protected

Definition at line 281 of file JPMTMask.hh.

---

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

• JPMTMask.hh