Jpp
Public Member Functions | Protected Attributes | Friends | List of all members
JEEP::JStatus Class Reference

Auxiliary class for status identifier. More...

#include <JStatus.hh>

Inheritance diagram for JEEP::JStatus:
JLANG::JEquals< JFirst_t, JSecond_t > JDETECTOR::JPMT JFIT::JPMTW0

Public Member Functions

 JStatus ()
 Default constructor. More...
 
 JStatus (const int &status)
 Constructor. More...
 
int getStatus () const
 Get status. More...
 
int & getStatus ()
 Get status. More...
 
void setStatus (const int status)
 Set status. More...
 
bool equals (const JStatus &status) const
 Equal method. 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 status identifier.

Definition at line 29 of file JStatus.hh.

Constructor & Destructor Documentation

◆ JStatus() [1/2]

JEEP::JStatus::JStatus ( )
inline

Default constructor.

Definition at line 36 of file JStatus.hh.

36  :
37  __status(0)
38  {}

◆ JStatus() [2/2]

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

Constructor.

Parameters
statusstatus

Definition at line 46 of file JStatus.hh.

46  :
47  __status(status)
48  {}

Member Function Documentation

◆ getStatus() [1/2]

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

Get status.

Returns
status

Definition at line 56 of file JStatus.hh.

57  {
58  return this->__status;
59  }

◆ getStatus() [2/2]

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

Get status.

Returns
status

Definition at line 67 of file JStatus.hh.

68  {
69  return this->__status;
70  }

◆ setStatus()

void JEEP::JStatus::setStatus ( const int  status)
inline

Set status.

Parameters
statusstatus

Definition at line 78 of file JStatus.hh.

79  {
80  this->__status = status;
81  }

◆ equals()

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 90 of file JStatus.hh.

91  {
92  return this->getStatus() == status.getStatus();
93  }

Friends And Related Function Documentation

◆ operator>> [1/2]

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

Read status from input.

Parameters
ininput stream
statusstatus
Returns
input stream

Definition at line 103 of file JStatus.hh.

104  {
105  return in >> status.__status;
106  }

◆ operator<< [1/2]

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

Write status to output.

Parameters
outoutput stream
statusstatus
Returns
output stream

Definition at line 116 of file JStatus.hh.

117  {
118  return out << status.__status;
119  }

◆ operator>> [2/2]

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

Read status from input.

Parameters
inreader
statusstatus
Returns
reader

Definition at line 129 of file JStatus.hh.

130  {
131  return in >> status.__status;
132  }

◆ operator<< [2/2]

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

Write status to output.

Parameters
outwriter
statusstatus
Returns
writer

Definition at line 142 of file JStatus.hh.

143  {
144  return out << status.__status;
145  }

Member Data Documentation

◆ __status

int JEEP::JStatus::__status
protected

Definition at line 148 of file JStatus.hh.


The documentation for this class was generated from the following file:
JEEP::JStatus::__status
int __status
Definition: JStatus.hh:148
JEEP::JStatus::getStatus
int getStatus() const
Get status.
Definition: JStatus.hh:56