Router for direct addressing of PMT data in detector data structure. More...

#include <JPMTRouter.hh>

Inheritance diagram for JDETECTOR::JPMTRouter:

Public Types
typedef JDetector::const_iterator	const_iterator

Public Member Functions
	JPMTRouter (const JDetector &detector)
	Constructor.

const JPMTRouter &	getPMTRouter () const
	Get PMT router.

const JPMTAddress &	getAddress (const JObjectID &id) const
	Get address of PMT.

const JPMT &	getPMT (const JPMTAddress &address) const
	Get PMT.

const JPMT &	getPMT (const JObjectID &id) const
	Get PMT.

bool	hasPMT (const JObjectID &id) const
	Has PMT.

JPMTIdentifier	getIdentifier (const JPMTAddress &address) const
	Get identifier of PMT.

JPMTIdentifier	getIdentifier (const JObjectID &id) const
	Get identifier of PMT.

const JModule &	getModule (const JModuleAddress &address) const
	Get module.

const JModule &	getParentModule (const JObjectID &id) const
	Get parent module.

int	getParentModuleID (const JObjectID &id) const
	Get parent module identifier.

JPMTChannel	getPMTChannel (const JPMTAddress &address) const
	Get PMT channel.

JPMTChannel	getPMTChannel (const JObjectID &id) const
	Get PMT channel.

JUTMPosition	getUTMPosition (const JObjectID &id) const
	Get UTM position of given PMT identifier.

const JClass_t &	getReference () const
	Get reference to object.

JClass_t &	getReference ()
	Get reference to object.

bool	is_valid () const
	Check validity of reference.

const JClass_t *	operator-> () const
	Smart pointer.

JClass_t *	operator-> ()
	Smart pointer.

const JClass_t &	operator* () const
	Dereference operator.

JClass_t &	operator* ()
	Dereference operator.

Protected Attributes
JClass_t &	__object

Private Types
typedef JReference< const JDetector >	JReference_t

Private Attributes
JTOOLS::JRouter< JPMTAddress >	router

Detailed Description

Router for direct addressing of PMT data in detector data structure.

This router can be used to directly map the PMT identifier to the logical address of the PMT (JPMTAddress) in the detector data structure.

Note that the required memory is determined by the range covered by the PMT identifiers.

Definition at line 35 of file JPMTRouter.hh.

Member Typedef Documentation

◆ JReference_t

JReference<const JDetector> JDETECTOR::JPMTRouter::JReference_t

private

Definition at line 39 of file JPMTRouter.hh.

◆ const_iterator

JDetector::const_iterator JDETECTOR::JPMTRouter::const_iterator

Definition at line 43 of file JPMTRouter.hh.

Constructor & Destructor Documentation

◆ JPMTRouter()

JDETECTOR::JPMTRouter::JPMTRouter ( const JDetector & detector )

inline

Constructor.

Parameters

detector detector

Definition at line 51 of file JPMTRouter.hh.

                                          :
      JReference_t(detector),
      router(JPMTAddress())
    {
      for (const_iterator module = detector.begin(); module != detector.end(); ++module) {
        for (JModule::const_iterator pmt = module->begin(); pmt != module->end(); ++pmt) {
          router.put(pmt->getID(), JPMTAddress(JModuleAddress(std::distance(detector.begin(), module)), std::distance(module->begin(), pmt)));
        }
      }
    }

Member Function Documentation

◆ getPMTRouter()

const JPMTRouter & JDETECTOR::JPMTRouter::getPMTRouter ( ) const

inline

Get PMT router.

Returns: PMT router

Definition at line 68 of file JPMTRouter.hh.

    {
      return static_cast<const JPMTRouter&>(*this);
    }

◆ getAddress()

const JPMTAddress & JDETECTOR::JPMTRouter::getAddress ( const JObjectID & id ) const

inline

Get address of PMT.

Parameters

id	PMT identifier

Returns: address

Definition at line 80 of file JPMTRouter.hh.

    {
      return router.get(id.getID());
    }

◆ getPMT() [1/2]

const JPMT & JDETECTOR::JPMTRouter::getPMT ( const JPMTAddress & address ) const

inline

Get PMT.

Parameters

address PMT address

Returns: PMT

Definition at line 92 of file JPMTRouter.hh.

    {
      return getReference().getPMT(address);
    }

◆ getPMT() [2/2]

const JPMT & JDETECTOR::JPMTRouter::getPMT ( const JObjectID & id ) const

inline

Get PMT.

Parameters

id	PMT identifier

Returns: PMT

Definition at line 104 of file JPMTRouter.hh.

    {
      return getReference().getPMT(this->getAddress(id));
    }

◆ hasPMT()

bool JDETECTOR::JPMTRouter::hasPMT ( const JObjectID & id ) const

inline

Has PMT.

Parameters

id	PMT identifier

Returns: true if PMT present; else false

Definition at line 116 of file JPMTRouter.hh.

    {
      return router.has(id.getID());
    }

◆ getIdentifier() [1/2]

JPMTIdentifier JDETECTOR::JPMTRouter::getIdentifier ( const JPMTAddress & address ) const

inline

Get identifier of PMT.

Parameters

address PMT address

Returns: address

Definition at line 128 of file JPMTRouter.hh.

    {
      return JPMTIdentifier(getModule(address), address.second);
    }

◆ getIdentifier() [2/2]

JPMTIdentifier JDETECTOR::JPMTRouter::getIdentifier ( const JObjectID & id ) const

inline

Get identifier of PMT.

Parameters

id	PMT identifier

Returns: address

Definition at line 140 of file JPMTRouter.hh.

    {
      return getIdentifier(this->getAddress(id));
    }

◆ getModule()

const JModule & JDETECTOR::JPMTRouter::getModule ( const JModuleAddress & address ) const

inline

Get module.

Parameters

address module address

Returns: module

Definition at line 152 of file JPMTRouter.hh.

    {
      return getReference().getModule(address);
    }

◆ getParentModule()

const JModule & JDETECTOR::JPMTRouter::getParentModule ( const JObjectID & id ) const

inline

Get parent module.

Parameters

id	PMT identifier

Returns: module

Definition at line 164 of file JPMTRouter.hh.

    {
      return getModule(this->getAddress(id));
    }

◆ getParentModuleID()

int JDETECTOR::JPMTRouter::getParentModuleID ( const JObjectID & id ) const

inline

Get parent module identifier.

Parameters

id	PMT identifier

Returns: module identifier

Definition at line 176 of file JPMTRouter.hh.

    {
      return getParentModule(id).getID();
    }

◆ getPMTChannel() [1/2]

JPMTChannel JDETECTOR::JPMTRouter::getPMTChannel ( const JPMTAddress & address ) const

inline

Get PMT channel.

Parameters

address PMT address

Returns: PMT channel

Definition at line 188 of file JPMTRouter.hh.

    {
      return JPMTChannel(getModule(address).getLocation(), address.second);
    }

◆ getPMTChannel() [2/2]

JPMTChannel JDETECTOR::JPMTRouter::getPMTChannel ( const JObjectID & id ) const

inline

Get PMT channel.

Parameters

id	PMT identifier

Returns: PMT channel

Definition at line 200 of file JPMTRouter.hh.

    {
      return getPMTChannel(getAddress(id));
    }

◆ getUTMPosition()

JUTMPosition JDETECTOR::JPMTRouter::getUTMPosition ( const JObjectID & id ) const

inline

Get UTM position of given PMT identifier.

Parameters

id	PMT identifier

Returns: UTM position

Definition at line 212 of file JPMTRouter.hh.

    {
      return JUTMPosition(getPMT(id).getPosition() + getReference().getPosition());
    }

◆ getReference() [1/2]

template<class JClass_t >

const JClass_t & JLANG::JReference< JClass_t >::getReference ( ) const

inlineinherited

Get reference to object.

Returns: reference to object

Definition at line 38 of file JReference.hh.

    {
      return __object;
    }

◆ getReference() [2/2]

template<class JClass_t >

JClass_t & JLANG::JReference< JClass_t >::getReference ( )

inlineinherited

Get reference to object.

Returns: reference to object

Definition at line 49 of file JReference.hh.

    {
      return __object;
    }

◆ is_valid()

template<class JClass_t >

bool JLANG::JReference< JClass_t >::is_valid ( ) const

inlineinherited

Check validity of reference.

Returns: true

Definition at line 60 of file JReference.hh.

    {
      return true;
    }

◆ operator->() [1/2]

template<class JClass_t >

const JClass_t * JLANG::JReference< JClass_t >::operator-> ( ) const

inlineinherited

Smart pointer.

Returns: pointer to object

Definition at line 71 of file JReference.hh.

    {
      return &__object;
    }

◆ operator->() [2/2]

template<class JClass_t >

JClass_t * JLANG::JReference< JClass_t >::operator-> ( )

inlineinherited

Smart pointer.

Returns: pointer to object

Definition at line 82 of file JReference.hh.

    {
      return &__object;
    }

◆ operator*() [1/2]

template<class JClass_t >

const JClass_t & JLANG::JReference< JClass_t >::operator* ( ) const

inlineinherited

Dereference operator.

Returns: reference to object

Definition at line 93 of file JReference.hh.

    {
      return __object;
    }

◆ operator*() [2/2]

template<class JClass_t >

JClass_t & JLANG::JReference< JClass_t >::operator* ( )

inlineinherited

Dereference operator.

Returns: reference to object

Definition at line 104 of file JReference.hh.

    {
      return __object;
    }

Member Data Documentation

◆ router

JTOOLS::JRouter<JPMTAddress> JDETECTOR::JPMTRouter::router

private

Definition at line 218 of file JPMTRouter.hh.

◆ __object

template<class JClass_t >

JClass_t& JLANG::JReference< JClass_t >::__object

protectedinherited

Definition at line 110 of file JReference.hh.

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

JPMTRouter.hh

Public Types

Public Member Functions

Protected Attributes

Private Types

Private Attributes

Detailed Description

Member Typedef Documentation

◆ JReference_t

◆ const_iterator

Constructor & Destructor Documentation

◆ JPMTRouter()

Member Function Documentation

◆ getPMTRouter()

◆ getAddress()

◆ getPMT() [1/2]

◆ getPMT() [2/2]

◆ hasPMT()

◆ getIdentifier() [1/2]

◆ getIdentifier() [2/2]

◆ getModule()

◆ getParentModule()

◆ getParentModuleID()

◆ getPMTChannel() [1/2]

◆ getPMTChannel() [2/2]

◆ getUTMPosition()

◆ getReference() [1/2]

◆ getReference() [2/2]

◆ is_valid()

◆ operator->() [1/2]

◆ operator->() [2/2]

◆ operator*() [1/2]

◆ operator*() [2/2]

Member Data Documentation

◆ router

◆ __object