JDETECTOR::JModuleCalibration_t Struct Reference

Auxiliary data structure for module time calibration. More...

#include <JDetectorCalibration.hh>

Inheritance diagram for JDETECTOR::JModuleCalibration_t:

Public Member Functions
	JModuleCalibration_t ()
	Default constructor.
	JModuleCalibration_t (const int id, const JCalibration &calibration)
	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.
const JCalibration &	getCalibration () const
	Get calibration.
JCalibration &	getCalibration ()
	Get calibration.
void	setCalibration (const JCalibration &cal)
	Set calibration.
double	getT0 () const
	Get time offset.
void	setT0 (const double t0)
	Set time offset.
void	addT0 (const double t0)
	Add time offset.
void	subT0 (const double t0)
	Subtract time offset.

Protected Attributes
int	_id_
double	t0

Friends
void	to_json (json &js, const JModuleCalibration_t &object)
	Convert module time calibration to JSon.
void	from_json (const json &js, JModuleCalibration_t &object)
	Convert JSon to module time calibration.

Detailed Description

Auxiliary data structure for module time calibration.

Definition at line 685 of file JDetectorCalibration.hh.

Constructor & Destructor Documentation

JModuleCalibration_t() [1/2]

JDETECTOR::JModuleCalibration_t::JModuleCalibration_t ( )

inline

Default constructor.

Definition at line 692 of file JDetectorCalibration.hh.

    {}

JModuleCalibration_t() [2/2]

JDETECTOR::JModuleCalibration_t::JModuleCalibration_t ( const int id, const JCalibration & calibration )

inline

Constructor.

Parameters

id	module identifier
calibration	module time calibration

Definition at line 702 of file JDetectorCalibration.hh.

                                                          :
      JObjectID<JModuleCalibration_t>(id),
      JCalibration(calibration)
    {}

Member Function Documentation

getID() [1/2]

template<class T >

int JLANG::JObjectID< T >::getID ( ) const

inlineinherited

Get identifier.

Returns

identifier

Definition at line 63 of file JObjectID.hh.

    { 
      return _id_;
    }

getID() [2/2]

template<class T >

int & JLANG::JObjectID< T >::getID ( )

inlineinherited

Get identifier.

Returns

identifier

Definition at line 74 of file JObjectID.hh.

    { 
      return _id_;
    }

setID()

template<class T >

void JLANG::JObjectID< T >::setID ( const int id )

inlineinherited

Set identifier.

Parameters

id	identifier

Definition at line 85 of file JObjectID.hh.

    { 
      this->_id_ = id;
    }

less() [1/2]

template<class T >

bool JLANG::JObjectID< T >::less ( const JObjectID< T > & object ) const

inlineinherited

Less than method.

Parameters

object

object identifier

Returns

true if this identifier less than given identifier; else false

Definition at line 97 of file JObjectID.hh.

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

less() [2/2]

template<class T >

bool JLANG::JObjectID< T >::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 109 of file JObjectID.hh.

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

more()

template<class T >

bool JLANG::JObjectID< T >::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 121 of file JObjectID.hh.

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

getCalibration() [1/2]

const JCalibration & JDETECTOR::JCalibration::getCalibration ( ) const

inlineinherited

Get calibration.

Returns

calibration

Definition at line 67 of file JDetector/JCalibration.hh.

    {
      return *this;
    }

getCalibration() [2/2]

JCalibration & JDETECTOR::JCalibration::getCalibration ( )

inlineinherited

Get calibration.

Returns

calibration

Definition at line 78 of file JDetector/JCalibration.hh.

    {
      return *this;
    }

setCalibration()

void JDETECTOR::JCalibration::setCalibration ( const JCalibration & cal )

inlineinherited

Set calibration.

Parameters

cal	calibration

Definition at line 89 of file JDetector/JCalibration.hh.

    {
      *this = cal;
    }

getT0()

double JDETECTOR::JCalibration::getT0 ( ) const

inlineinherited

Get time offset.

Returns

time offset [ns]

Definition at line 100 of file JDetector/JCalibration.hh.

    {
      return t0;
    }

setT0()

void JDETECTOR::JCalibration::setT0 ( const double t0 )

inlineinherited

Set time offset.

Parameters

t0	time offset [ns]

Definition at line 111 of file JDetector/JCalibration.hh.

    {
      this->t0 = t0;
    }

addT0()

void JDETECTOR::JCalibration::addT0 ( const double t0 )

inlineinherited

Add time offset.

Parameters

t0	time offset [ns]

Definition at line 122 of file JDetector/JCalibration.hh.

    {
      this->t0 += t0;
    }

subT0()

void JDETECTOR::JCalibration::subT0 ( const double t0 )

inlineinherited

Subtract time offset.

Parameters

t0	time offset [ns]

Definition at line 133 of file JDetector/JCalibration.hh.

    {
      this->t0 -= t0;
    }

Friends And Related Symbol Documentation

to_json

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

friend

Convert module time calibration to JSon.

Parameters

js	json
object	module time calibration

Definition at line 715 of file JDetectorCalibration.hh.

    {
      js = json{ { Id_t, object.getID() },
                 { T0_t, object.getT0() } };
    }

from_json

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

friend

Convert JSon to module time calibration.

Parameters

js	json
object	module time calibration

Definition at line 728 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.setT0(js.at(T0_t).get<double>());
    }

Member Data Documentation

_id_

template<class T >

int JLANG::JObjectID< T >::_id_

protectedinherited

Definition at line 153 of file JObjectID.hh.

t0

double JDETECTOR::JCalibration::t0

protectedinherited

Definition at line 202 of file JDetector/JCalibration.hh.

---

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

• JDetectorCalibration.hh