JDETECTOR::JStatus Struct Reference

Auxiliary class for controlling PMT status. More...

#include <JStatus.hh>

Inheritance diagram for JDETECTOR::JStatus:

Public Types
enum	JPMTStatusBits_t {   PMT_DISABLE = 0, HIGH_RATE_VETO_DISABLE = 1, FIFO_FULL_DISABLE = 2, UDP_COUNTER_DISABLE = 3,   UDP_TRAILER_DISABLE = 4 }
	Enumeration of status bits. More...

Public Member Functions
	JStatus ()
	Default constructor. More...
	JStatus (const int status)
	Constructor. More...
const JStatus &	getStatus () const
	Get status. More...
JStatus	getStatus ()
	Get status. More...
void	setStatus (const JStatus &status)
	Set status. More...
bool	equals (const JStatus &status) const
	Equal method. More...
bool	has (const JPMTStatusBits_t bit) const
	Test PMT status. More...
void	set (const JPMTStatusBits_t bit)
	Set PMT status. More...
void	reset (const JPMTStatusBits_t bit)
	Reset PMT status. More...
void	print (std::ostream &out) const
	Print status. More...

Protected Attributes
int	status

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

Detailed Description

Auxiliary class for controlling PMT status.

The various status are controlled using a bitwise data field.
The corresponding bits are defined via an internal enumeration.

Definition at line 40 of file JStatus.hh.

Member Enumeration Documentation

enum JDETECTOR::JStatus::JPMTStatusBits_t

Enumeration of status bits.

Additional status bits should be included in JGetPMTStatusBit::JGetPMTStatusBit.

Enumerator
PMT_DISABLE	Enable (disable) use of this PMT if this status bit is 0 (1);.
HIGH_RATE_VETO_DISABLE	Enable (disable) use of high-rate veto test if this status bit is 0 (1);.
FIFO_FULL_DISABLE	Enable (disable) use of FIFO (almost) full test if this status bit is 0 (1);.
UDP_COUNTER_DISABLE	Enable (disable) use of UDP packet counter test if this status bit is 0 (1);.
UDP_TRAILER_DISABLE	Enable (disable) use of UDP packet trailer test if this status bit is 0 (1);.

Definition at line 48 of file JStatus.hh.

                          {
      PMT_DISABLE              =   0,    //!< Enable (disable) use of this PMT if this status bit is 0 (1);
      HIGH_RATE_VETO_DISABLE   =   1,    //!< Enable (disable) use of high-rate veto test if this status bit is 0 (1);
      FIFO_FULL_DISABLE        =   2,    //!< Enable (disable) use of FIFO (almost) full test if this status bit is 0 (1);
      UDP_COUNTER_DISABLE      =   3,    //!< Enable (disable) use of UDP packet counter test if this status bit is 0 (1);
      UDP_TRAILER_DISABLE      =   4     //!< Enable (disable) use of UDP packet trailer test if this status bit is 0 (1);
    };

Constructor & Destructor Documentation

JDETECTOR::JStatus::JStatus ( )

inline

Default constructor.

Definition at line 60 of file JStatus.hh.

              :
      status(0)
    {}

JDETECTOR::JStatus::JStatus ( const int  status )

inline

Constructor.

Parameters

status

status

Definition at line 70 of file JStatus.hh.

                              :
      status(status)
    {}

Member Function Documentation

const JStatus& JDETECTOR::JStatus::getStatus ( ) const

inline

Get status.

Returns

status

Definition at line 80 of file JStatus.hh.

    { 
      return *this;
    }

JStatus JDETECTOR::JStatus::getStatus ( )

inline

Get status.

Returns

status

Definition at line 91 of file JStatus.hh.

    { 
      return *this;
    }

void JDETECTOR::JStatus::setStatus ( const JStatus &  status )

inline

Set status.

Parameters

status

status

Definition at line 102 of file JStatus.hh.

    { 
      this->status = status.status;
    }

bool JDETECTOR::JStatus::equals ( const JStatus &  status ) const

inline

Equal method.

Parameters

status

status

Returns

true if this status equal to given status; else false

Definition at line 114 of file JStatus.hh.

    {
      return this->status == status.status;
    }

bool JDETECTOR::JStatus::has ( const JPMTStatusBits_t  bit ) const

inline

Test PMT status.

Parameters

bit

bit

Definition at line 125 of file JStatus.hh.

    {
      return (this->status & (1<<bit)) != 0;
    }

void JDETECTOR::JStatus::set ( const JPMTStatusBits_t  bit )

inline

Set PMT status.

Parameters

bit

bit

Definition at line 136 of file JStatus.hh.

    {
      this->status |= (1<<bit);
    }

void JDETECTOR::JStatus::reset ( const JPMTStatusBits_t  bit )

inline

Reset PMT status.

Parameters

bit

bit

Definition at line 147 of file JStatus.hh.

    {
      this->status &= ~(1<<bit);
    }

void JDETECTOR::JStatus::print ( std::ostream &  out ) const

inline

Print status.

Print PMT status.

Parameters

out	output stream

Definition at line 342 of file JStatus.hh.

  {
    using namespace std;

    for (int i = 0; i != sizeof(JStatus) * 8; ++i) {

      try {

        const JPMTStatusBits_t bit = (JPMTStatusBits_t) i;

        out << setw(24) << left << putPMTStatusBit(bit) << right << this->has(bit) << endl;
      }
      catch(const exception&) {}
    }
  }

Friends And Related Function Documentation

std::istream& operator>> ( std::istream &  in, JStatus &  status  )

friend

Read status from input.

Parameters

in	input stream
status	status

Returns

input stream

Definition at line 168 of file JStatus.hh.

    {
      return in >> status.status;
    }

std::ostream& operator<< ( std::ostream &  out, const JStatus &  status  )

friend

Write status to output.

Parameters

out	output stream
status	status

Returns

output stream

Definition at line 181 of file JStatus.hh.

    {
      return out << status.status;
    }

JReader& operator>> ( JReader &  in, JStatus &  status  )

friend

Read status from input.

Parameters

in	reader
status	status

Returns

reader

Definition at line 194 of file JStatus.hh.

    {
      return in >> status.status;
    }

JWriter& operator<< ( JWriter &  out, const JStatus &  status  )

friend

Write status to output.

Parameters

out	writer
status	status

Returns

writer

Definition at line 207 of file JStatus.hh.

    {
      return out << status.status;
    }       

Member Data Documentation

int JDETECTOR::JStatus::status

protected

Definition at line 213 of file JStatus.hh.

---

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

• JStatus.hh