JDETECTOR::JModuleStatus_t Struct Reference

Auxiliary data structure for module status. More...

#include <JDetectorCalibration.hh>

Inheritance diagram for JDETECTOR::JModuleStatus_t:

Public Member Functions
	JModuleStatus_t ()
	Default constructor.
	JModuleStatus_t (const JObjectID &id, const JStatus &status)
	Constructor.
int	getID () const
	Get identifier.
int &	getID ()
	Get identifier.
void	setID (const int id)
	Set identifier.
bool	less (const JObjectID &object) const
	Less than method.
bool	less (const int id) const
	Less than method.
bool	more (const int id) const
	More than method.
int	getStatus () const
	Get status.
JStatus &	getStatus ()
	Get status.
int	getStatus (const int mask) const
	Get status.
void	setStatus (const JStatus &status)
	Set status.
bool	equals (const JStatus &status) const
	Equal method.
bool	has (const int bit) const
	Test PMT status.
void	set (const int bit)
	Set PMT status.
void	reset (const int bit)
	Reset PMT status.

Protected Attributes
int	__id
int	status

Friends
void	to_json (json &js, const JModuleStatus_t &object)
	Convert module status to JSon.
void	from_json (const json &js, JModuleStatus_t &object)
	Convert JSon to module status.

Detailed Description

Auxiliary data structure for module status.

Definition at line 626 of file JDetectorCalibration.hh.

Constructor & Destructor Documentation

JModuleStatus_t() [1/2]

JDETECTOR::JModuleStatus_t::JModuleStatus_t ( )

inline

Default constructor.

Definition at line 633 of file JDetectorCalibration.hh.

    {}

JModuleStatus_t() [2/2]

JDETECTOR::JModuleStatus_t::JModuleStatus_t ( const JObjectID & id, const JStatus & status )

inline

Constructor.

Parameters

id	module identifier
status	module status

Definition at line 643 of file JDetectorCalibration.hh.

                                             :
      JObjectID(id),
      JStatus  (status)
    {}

Member Function Documentation

getID() [1/2]

int JLANG::JObjectID::getID ( ) const

inlineinherited

Get identifier.

Returns

identifier

Definition at line 50 of file JObjectID.hh.

    { 
      return __id;
    }

getID() [2/2]

int & JLANG::JObjectID::getID ( )

inlineinherited

Get identifier.

Returns

identifier

Definition at line 61 of file JObjectID.hh.

    { 
      return __id;
    }

setID()

void JLANG::JObjectID::setID ( const int id )

inlineinherited

Set identifier.

Parameters

id	identifier

Definition at line 72 of file JObjectID.hh.

    { 
      this->__id = id;
    }

less() [1/2]

bool JLANG::JObjectID::less ( const JObjectID & object ) const

inlineinherited

Less than method.

Parameters

object

object identifier

Returns

true if this identifier less than given identifier; else false

Definition at line 84 of file JObjectID.hh.

    { 
      return this->getID() < object.getID();
    }

less() [2/2]

bool JLANG::JObjectID::less ( const int id ) const

inlineinherited

Less than method.

Parameters

id	identifier

Returns

true if this identifier less than given identifier; else false

Definition at line 96 of file JObjectID.hh.

    { 
      return this->getID() < id;
    }

more()

bool JLANG::JObjectID::more ( const int id ) const

inlineinherited

More than method.

Parameters

id	identifier

Returns

true if this identifier greater than given identifier; else false

Definition at line 108 of file JObjectID.hh.

    { 
      return this->getID() > id;
    }

getStatus() [1/3]

int JEEP::JStatus::getStatus ( ) const

inlineinherited

Get status.

Returns

status

Definition at line 63 of file JStatus.hh.

    { 
      return this->status;
    }

getStatus() [2/3]

JStatus & JEEP::JStatus::getStatus ( )

inlineinherited

Get status.

Returns

status

Definition at line 74 of file JStatus.hh.

    { 
      return *this;
    }

getStatus() [3/3]

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

inlineinherited

Get status.

Parameters

mask

mask

Returns

status

Definition at line 86 of file JStatus.hh.

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

setStatus()

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

inlineinherited

Set status.

Parameters

status

status

Definition at line 97 of file JStatus.hh.

    { 
      this->status = status.status;
    }

equals()

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

inlineinherited

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

has()

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

inlineinherited

Test PMT status.

Parameters

bit

bit

Definition at line 120 of file JStatus.hh.

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

set()

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

inlineinherited

Set PMT status.

Parameters

bit

bit

Definition at line 131 of file JStatus.hh.

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

reset()

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

inlineinherited

Reset PMT status.

Parameters

bit

bit

Definition at line 142 of file JStatus.hh.

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

Friends And Related Symbol Documentation

to_json

void to_json ( json & js, const JModuleStatus_t & object )

friend

Convert module status to JSon.

Parameters

js	json
object	module status

Definition at line 656 of file JDetectorCalibration.hh.

    {
      js = json{ { Id_t,     object.getID() },
                 { STATUS_t, object.getStatus() } };
    }

from_json

void from_json ( const json & js, JModuleStatus_t & object )

friend

Convert JSon to module status.

Parameters

js	json
object	module status

Definition at line 669 of file JDetectorCalibration.hh.

    {
      if      (js.contains(DOMId_t))
        object.setID(js.at(DOMId_t).get<int>());
      else if (js.contains(Id_t))
        object.setID(js.at(Id_t)   .get<int>());
      else
        THROW(JNoValue, "Missing module identifier.");
 
      object.setStatus(js.at(STATUS_t).get<int>());
    }

Member Data Documentation

__id

int JLANG::JObjectID::__id

protectedinherited

Definition at line 140 of file JObjectID.hh.

status

int JEEP::JStatus::status

protectedinherited

Definition at line 200 of file JStatus.hh.

---

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

• JDetectorCalibration.hh