JEEP::JStatus Struct Reference

Auxiliary class for handling status. More...

#include <JStatus.hh>

Inheritance diagram for JEEP::JStatus:

Public Member Functions
	JStatus ()
	Default constructor. More...
	JStatus (const int status)
	Constructor. More...
int	getStatus () const
	Get status. More...
JStatus &	getStatus ()
	Get status. More...
int	getStatus (const int mask) const
	Get status. More...
void	setStatus (const JStatus &status)
	Set status. More...
bool	equals (const JStatus &status) const
	Equal method. More...
bool	has (const int bit) const
	Test PMT status. More...
void	set (const int bit)
	Set PMT status. More...
void	reset (const int bit)
	Reset PMT 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 handling status.

The various status are controlled using a bitwise data field.
The corresponding bits can externally be defined (e.g. via an enumeration).

Definition at line 37 of file JStatus.hh.

Constructor & Destructor Documentation

JEEP::JStatus::JStatus ( )

inline

Default constructor.

Definition at line 43 of file JStatus.hh.

              :
      status(0)
    {}

JEEP::JStatus::JStatus ( const int  status )

inline

Constructor.

Parameters

status

status

Definition at line 53 of file JStatus.hh.

                              :
      status(status)
    {}

Member Function Documentation

int JEEP::JStatus::getStatus ( ) const

inline

Get status.

Returns

status

Definition at line 63 of file JStatus.hh.

    { 
      return this->status;
    }

JStatus& JEEP::JStatus::getStatus ( )

inline

Get status.

Returns

status

Definition at line 74 of file JStatus.hh.

    { 
      return *this;
    }

int JEEP::JStatus::getStatus ( const int  mask ) const

inline

Get status.

Parameters

mask

mask

Returns

status

Definition at line 86 of file JStatus.hh.

    { 
      return (this->status & mask);
    }

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

inline

Set status.

Parameters

status

status

Definition at line 97 of file JStatus.hh.

    { 
      this->status = status.status;
    }

bool JEEP::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 109 of file JStatus.hh.

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

bool JEEP::JStatus::has ( const int  bit ) const

inline

Test PMT status.

Parameters

bit

bit

Definition at line 120 of file JStatus.hh.

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

void JEEP::JStatus::set ( const int  bit )

inline

Set PMT status.

Parameters

bit

bit

Definition at line 131 of file JStatus.hh.

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

void JEEP::JStatus::reset ( const int  bit )

inline

Reset PMT status.

Parameters

bit

bit

Definition at line 142 of file JStatus.hh.

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

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 155 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 168 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 181 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 194 of file JStatus.hh.

    {
      return out << status.status;
    }       

Member Data Documentation

int JEEP::JStatus::status

protected

Definition at line 200 of file JStatus.hh.

---

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

• JStatus.hh