KM3NETDAQ::JDAQTriggerMask Class Reference

Auxiliary class for trigger mask. More...

#include <JDAQTriggerMask.hh>

Inheritance diagram for KM3NETDAQ::JDAQTriggerMask:

Public Member Functions
	JDAQTriggerMask ()
	Default constructor. More...
	JDAQTriggerMask (const JTriggerMask_t mask)
	Constructor. More...
	JDAQTriggerMask (const std::string &buffer)
	Constructor. More...
virtual	~JDAQTriggerMask ()
	Virtual destructor. 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 JDAQTriggerMask	valueOf (const std::string &buffer)
	Extract trigger mask. More...

Protected Attributes
JTriggerMask_t	trigger_mask

Friends
size_t	getSizeof ()
	Definition of method to get size of data type. More...
JReader &	operator>> (JReader &, JDAQTriggerMask &)
	Read DAQ trigger mask from input. More...
JWriter &	operator<< (JWriter &, const JDAQTriggerMask &)
	Write DAQ trigger mask to output. More...
std::istream &	operator>> (std::istream &in, JDAQTriggerMask &mask)
	Read JDAQTriggerMask from input stream. More...
std::ostream &	operator<< (std::ostream &out, const JDAQTriggerMask &mask)
	Write JDAQTriggerMask to output stream. More...

Detailed Description

Auxiliary class for trigger mask.

Definition at line 48 of file JDAQTriggerMask.hh.

Constructor & Destructor Documentation

JDAQTriggerMask() [1/3]

KM3NETDAQ::JDAQTriggerMask::JDAQTriggerMask ( )

inline

Default constructor.

Definition at line 58 of file JDAQTriggerMask.hh.

                      :
      trigger_mask(0)
    {}

JDAQTriggerMask() [2/3]

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

inline

Constructor.

Parameters

mask	trigger mask

Definition at line 68 of file JDAQTriggerMask.hh.

                                               :
      trigger_mask(mask)
    {}

JDAQTriggerMask() [3/3]

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

inline

Constructor.

Parameters

buffer

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

Definition at line 78 of file JDAQTriggerMask.hh.

                                             :
      trigger_mask(valueOf(buffer).getTriggerMask())
    {}

~JDAQTriggerMask()

virtual KM3NETDAQ::JDAQTriggerMask::~JDAQTriggerMask ( )

inlinevirtual

Virtual destructor.

Definition at line 86 of file JDAQTriggerMask.hh.

    {}

Member Function Documentation

getDAQTriggerMask()

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

inline

Get DAQ trigger mask.

Returns

DAQ trigger mask

Definition at line 95 of file JDAQTriggerMask.hh.

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

getTriggerMask()

JTriggerMask_t KM3NETDAQ::JDAQTriggerMask::getTriggerMask ( ) const

inline

Get trigger mask.

Returns

trigger mask

Definition at line 106 of file JDAQTriggerMask.hh.

    {
      return trigger_mask;
    }

setDAQTriggerMask()

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

inline

Set trigger mask.

Parameters

mask	trigger mask

Definition at line 117 of file JDAQTriggerMask.hh.

    {
      trigger_mask = mask.trigger_mask;
    }

setTriggerMask()

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

inline

Set trigger mask.

Parameters

mask	trigger mask

Definition at line 128 of file JDAQTriggerMask.hh.

    {
      trigger_mask = mask;
    }

addTriggerMask()

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

inline

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

hasTriggerMask()

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

inline

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

addTriggerBit()

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

inline

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

hasTriggerBit()

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

inline

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

valueOf()

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

inlinestatic

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

toString()

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

inline

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

ClassDef()

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

Friends And Related Function Documentation

getSizeof

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

operator>> [1/2]

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

friend

Read DAQ trigger mask from input.

Parameters

in	reader
mask	DAQ trigger mask

Returns

reader

Definition at line 32 of file JDAQTriggerMaskIO.hh.

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

operator<< [1/2]

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

friend

Write DAQ trigger mask to output.

Parameters

out	writer
mask	DAQ trigger mask

Returns

writer

Definition at line 47 of file JDAQTriggerMaskIO.hh.

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

operator>> [2/2]

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

friend

Read JDAQTriggerMask from input stream.

Parameters

in	input stream
mask	JDAQTriggerMask

Returns

input stream

Definition at line 236 of file JDAQTriggerMask.hh.

    {
      std::string buffer;
      
      if (in >> buffer) {
        mask= JDAQTriggerMask::valueOf(buffer);
      }
 
      return in;
    }

operator<< [2/2]

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

friend

Write JDAQTriggerMask to output stream.

Parameters

out	output stream
mask	JDAQTriggerMask

Returns

output stream

Definition at line 255 of file JDAQTriggerMask.hh.

    {
      out << mask.toString();
 
      return out;
    }

Member Data Documentation

trigger_mask

JTriggerMask_t KM3NETDAQ::JDAQTriggerMask::trigger_mask

protected

Definition at line 267 of file JDAQTriggerMask.hh.

---

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

• JDAQTriggerMask.hh