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

#include <JModuleRouter.hh>

Inheritance diagram for JDETECTOR::JModuleRouter:

Public Types
typedef JDetector::const_iterator	const_iterator

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

const JModuleRouter &	getModuleRouter () const
	Get module router.

const JModuleAddress &	getAddress (const JModuleIdentifier &id) const
	Get address of module.

const JModule &	getModule (const JModuleIdentifier &id) const
	Get module parameters.

bool	hasModule (const JModuleIdentifier &id) const
	Has module.

const int	getIndex (const JModuleIdentifier &id) const
	Get index of module.

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

const JPMT &	getPMT (const JPMTIdentifier &id) const
	Get PMT parameters.

JUTMPosition	getUTMPosition (const JModuleIdentifier &id) const
	Get UTM position of given module 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< JModuleAddress >	router

Detailed Description

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

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

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

Definition at line 34 of file JModuleRouter.hh.

Member Typedef Documentation

◆ JReference_t

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

private

Definition at line 38 of file JModuleRouter.hh.

◆ const_iterator

JDetector::const_iterator JDETECTOR::JModuleRouter::const_iterator

Definition at line 42 of file JModuleRouter.hh.

Constructor & Destructor Documentation

◆ JModuleRouter()

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

inline

Constructor.

Parameters

detector detector

Definition at line 50 of file JModuleRouter.hh.

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

Member Function Documentation

◆ getModuleRouter()

const JModuleRouter & JDETECTOR::JModuleRouter::getModuleRouter ( ) const

inline

Get module router.

Returns: module router

Definition at line 65 of file JModuleRouter.hh.

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

◆ getAddress()

const JModuleAddress & JDETECTOR::JModuleRouter::getAddress ( const JModuleIdentifier & id ) const

inline

Get address of module.

Parameters

id	module identifier

Returns: address

Definition at line 77 of file JModuleRouter.hh.

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

◆ getModule()

const JModule & JDETECTOR::JModuleRouter::getModule ( const JModuleIdentifier & id ) const

inline

Get module parameters.

Parameters

id	module identifier

Returns: module parameters

Definition at line 89 of file JModuleRouter.hh.

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

◆ hasModule()

bool JDETECTOR::JModuleRouter::hasModule ( const JModuleIdentifier & id ) const

inline

Has module.

Parameters

id	module identifier

Returns: true if module present; else false

Definition at line 101 of file JModuleRouter.hh.

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

◆ getIndex()

const int JDETECTOR::JModuleRouter::getIndex ( const JModuleIdentifier & id ) const

inline

Get index of module.

Parameters

id	module identifier

Returns: index

Definition at line 113 of file JModuleRouter.hh.

    {
      return getAddress(id).first;
    }

◆ hasPMT()

bool JDETECTOR::JModuleRouter::hasPMT ( const JPMTIdentifier & id ) const

inline

Has PMT.

Parameters

id	PMT identifier

Returns: true if PMT present; else false

Definition at line 125 of file JModuleRouter.hh.

    {
      return hasModule(id.getID()) && id.getPMTAddress() >= 0 && id.getPMTAddress() < (int) getModule(id.getID()).size();
    }

◆ getPMT()

const JPMT & JDETECTOR::JModuleRouter::getPMT ( const JPMTIdentifier & id ) const

inline

Get PMT parameters.

Parameters

id	PMT identifier

Returns: PMT parameters

Definition at line 137 of file JModuleRouter.hh.

    {
      return getModule(id.getID()).getPMT(id.getPMTAddress());
    }

◆ getUTMPosition()

JUTMPosition JDETECTOR::JModuleRouter::getUTMPosition ( const JModuleIdentifier & id ) const

inline

Get UTM position of given module identifier.

Parameters

id	module identifier

Returns: UTM position

Definition at line 149 of file JModuleRouter.hh.

    {
      return JUTMPosition(getModule(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<JModuleAddress> JDETECTOR::JModuleRouter::router

private

Definition at line 155 of file JModuleRouter.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:

JModuleRouter.hh

Public Types

Public Member Functions

Protected Attributes

Private Types

Private Attributes

Detailed Description

Member Typedef Documentation

◆ JReference_t

◆ const_iterator

Constructor & Destructor Documentation

◆ JModuleRouter()

Member Function Documentation

◆ getModuleRouter()

◆ getAddress()

◆ getModule()

◆ hasModule()

◆ getIndex()

◆ hasPMT()

◆ getPMT()

◆ 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