Jpp  15.0.1-rc.1-highQE
the software that should make you happy
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Protected Attributes | Friends | List of all members
JEEP::JStatus Struct Reference

Auxiliary class for handling status. More...

#include <JStatus.hh>

Inheritance diagram for JEEP::JStatus:
JLANG::JEquals< JFirst_t, JSecond_t > JDETECTOR::JModule JDETECTOR::JPMT JCALIBRATE::JFitK40_t< JNullType > JMONITOR::JClusterBuilder

Public Member Functions

 JStatus ()
 Default constructor. More...
 
 JStatus (const int status)
 Constructor. More...
 
const JStatusgetStatus () const
 Get status. More...
 
JStatusgetStatus ()
 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...
 
JReaderoperator>> (JReader &in, JStatus &status)
 Read status from input. More...
 
JWriteroperator<< (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.

43  :
44  status(0)
45  {}
JEEP::JStatus::JStatus ( const int  status)
inline

Constructor.

Parameters
statusstatus

Definition at line 53 of file JStatus.hh.

53  :
54  status(status)
55  {}

Member Function Documentation

const JStatus& JEEP::JStatus::getStatus ( ) const
inline

Get status.

Returns
status

Definition at line 63 of file JStatus.hh.

64  {
65  return *this;
66  }
JStatus& JEEP::JStatus::getStatus ( )
inline

Get status.

Returns
status

Definition at line 74 of file JStatus.hh.

75  {
76  return *this;
77  }
void JEEP::JStatus::setStatus ( const JStatus status)
inline

Set status.

Parameters
statusstatus

Definition at line 85 of file JStatus.hh.

86  {
87  this->status = status.status;
88  }
bool JEEP::JStatus::equals ( const JStatus status) const
inline

Equal method.

Parameters
statusstatus
Returns
true if this status equal to given status; else false

Definition at line 97 of file JStatus.hh.

98  {
99  return this->status == status.status;
100  }
bool JEEP::JStatus::has ( const int  bit) const
inline

Test PMT status.

Parameters
bitbit

Definition at line 108 of file JStatus.hh.

109  {
110  return (this->status & (1<<bit)) != 0;
111  }
void JEEP::JStatus::set ( const int  bit)
inline

Set PMT status.

Parameters
bitbit

Definition at line 119 of file JStatus.hh.

120  {
121  this->status |= (1<<bit);
122  }
void JEEP::JStatus::reset ( const int  bit)
inline

Reset PMT status.

Parameters
bitbit

Definition at line 130 of file JStatus.hh.

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

Friends And Related Function Documentation

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

Read status from input.

Parameters
ininput stream
statusstatus
Returns
input stream

Definition at line 143 of file JStatus.hh.

144  {
145  return in >> status.status;
146  }
then fatal Wrong number of arguments fi set_variable DETECTOR $argv[1] set_variable INPUT_FILE $argv[2] eval JPrintDetector a $DETECTOR O IDENTIFIER eval JPrintDetector a $DETECTOR O SUMMARY source JAcoustics sh $DETECTOR_ID CHECK_EXIT_CODE typeset A TRIPODS get_tripods $WORKDIR tripod txt TRIPODS for EMITTER in
Definition: JCanberra.sh:41
std::ostream& operator<< ( std::ostream &  out,
const JStatus status 
)
friend

Write status to output.

Parameters
outoutput stream
statusstatus
Returns
output stream

Definition at line 156 of file JStatus.hh.

157  {
158  return out << status.status;
159  }
JReader& operator>> ( JReader in,
JStatus status 
)
friend

Read status from input.

Parameters
inreader
statusstatus
Returns
reader

Definition at line 169 of file JStatus.hh.

170  {
171  return in >> status.status;
172  }
then fatal Wrong number of arguments fi set_variable DETECTOR $argv[1] set_variable INPUT_FILE $argv[2] eval JPrintDetector a $DETECTOR O IDENTIFIER eval JPrintDetector a $DETECTOR O SUMMARY source JAcoustics sh $DETECTOR_ID CHECK_EXIT_CODE typeset A TRIPODS get_tripods $WORKDIR tripod txt TRIPODS for EMITTER in
Definition: JCanberra.sh:41
JWriter& operator<< ( JWriter out,
const JStatus status 
)
friend

Write status to output.

Parameters
outwriter
statusstatus
Returns
writer

Definition at line 182 of file JStatus.hh.

183  {
184  return out << status.status;
185  }

Member Data Documentation

int JEEP::JStatus::status
protected

Definition at line 188 of file JStatus.hh.


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