Mapper for directly addressing of associated modules in the detector data structure. More...

#include <JModuleMapper.hh>

Inheritance diagram for JDETECTOR::JModuleMapper< JAttributes_t >:

Public Types
typedef JModuleAttributes< JAttributes_t >	moduleattributes_type
	Type definition of module data. More...

typedef std::vector< moduleattributes_type >	container_type
	Type definition of a list with module data. More...

typedef JDetector::const_iterator	const_iterator

Public Member Functions
	JModuleMapper (const JDetector &detector)
	Constructor. More...

	JModuleMapper (const JModuleRouter &router)
	Constructor. More...

template<class JMatch_t >
	JModuleMapper (const JDetector &detector, JMatch_t match)
	Constructor. More...

template<class JMatch_t >
	JModuleMapper (const JModuleRouter &router, JMatch_t match)
	Constructor. More...

const container_type &	getList (const JObjectID &id) const
	Get list with module data matching given module. More...

template<class JMatch_t >
void	configure (JMatch_t match)
	Configure this module mapper. More...

const JModuleRouter &	getModuleRouter () const
	Get module router. More...

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

const JModule &	getModule (const JObjectID &id) const
	Get module parameters. More...

bool	hasModule (const JObjectID &id) const
	Has module. More...

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

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

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

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

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

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

bool	is_valid () const
	Check validity of reference. More...

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

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

const JClass_t &	operator* () const
	Dereference operator. More...

JClass_t &	operator* ()
	Dereference operator. More...

Protected Attributes
std::vector< container_type >	zmap

JClass_t &	__object

Private Types
typedef JReference< const JDetector >	JReference_t

Private Attributes
JTOOLS::JRouter< JModuleAddress >	router

Detailed Description

template<class JAttributes_t = JNullType>
class JDETECTOR::JModuleMapper< JAttributes_t >

Mapper for directly addressing of associated modules in the detector data structure.

The template argument refers to the module attributes. Note that, by construction, a module will not be assiciated to itself.

Definition at line 162 of file JModuleMapper.hh.

Member Typedef Documentation

◆ moduleattributes_type

template<class JAttributes_t = JNullType>

typedef JModuleAttributes<JAttributes_t> JDETECTOR::JModuleMapper< JAttributes_t >::moduleattributes_type

Type definition of module data.

Definition at line 169 of file JModuleMapper.hh.

◆ container_type

template<class JAttributes_t = JNullType>

typedef std::vector<moduleattributes_type> JDETECTOR::JModuleMapper< JAttributes_t >::container_type

Type definition of a list with module data.

Definition at line 174 of file JModuleMapper.hh.

◆ JReference_t

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

privateinherited

Definition at line 40 of file JModuleRouter.hh.

◆ const_iterator

typedef JDetector::const_iterator JDETECTOR::JModuleRouter::const_iterator

inherited

Definition at line 44 of file JModuleRouter.hh.

Constructor & Destructor Documentation

◆ JModuleMapper() [1/4]

template<class JAttributes_t = JNullType>

JDETECTOR::JModuleMapper< JAttributes_t >::JModuleMapper ( const JDetector & detector )

inline

Constructor.

Parameters

detector detector

Definition at line 182 of file JModuleMapper.hh.

                                              :
       JModuleRouter(detector)
     {
       configure(JMaximalDistance(std::numeric_limits<double>::max()));
     }

◆ JModuleMapper() [2/4]

template<class JAttributes_t = JNullType>

JDETECTOR::JModuleMapper< JAttributes_t >::JModuleMapper ( const JModuleRouter & router )

inline

Constructor.

Parameters

router module router

Definition at line 194 of file JModuleMapper.hh.

                                                :
       JModuleRouter(router)
     {
       configure(JMaximalDistance(std::numeric_limits<double>::max()));
     }

◆ JModuleMapper() [3/4]

template<class JAttributes_t = JNullType>

template<class JMatch_t >

JDETECTOR::JModuleMapper< JAttributes_t >::JModuleMapper	(	const JDetector &	detector,
		JMatch_t	match
	)

inline

Constructor.

The argument matchrefers to a template which should implement the following operator:

      bool operator()(const JModule& first, const JModule& second);

Parameters

detector	detector
match	module matcher

Definition at line 213 of file JModuleMapper.hh.

                                                              :
       JModuleRouter(detector)
     {
       configure(match);
     }

◆ JModuleMapper() [4/4]

template<class JAttributes_t = JNullType>

template<class JMatch_t >

JDETECTOR::JModuleMapper< JAttributes_t >::JModuleMapper	(	const JModuleRouter &	router,
		JMatch_t	match
	)

inline

Constructor.

The argument matchrefers to a template which should implement the following operator:

      bool operator()(const JModule& first, const JModule& second);

Parameters

router	module router
match	module matcher

Definition at line 232 of file JModuleMapper.hh.

                                                                :
       JModuleRouter(router)
     {
       configure(match);
     }

Member Function Documentation

◆ getList()

template<class JAttributes_t = JNullType>

const container_type& JDETECTOR::JModuleMapper< JAttributes_t >::getList ( const JObjectID & id ) const

inline

Get list with module data matching given module.

Parameters

id	module identifier

Returns: module data

Definition at line 245 of file JModuleMapper.hh.

     {
       return zmap[this->getAddress(id).first];
     }

◆ configure()

template<class JAttributes_t = JNullType>

template<class JMatch_t >

void JDETECTOR::JModuleMapper< JAttributes_t >::configure ( JMatch_t match )

inline

Configure this module mapper.

The argument matchrefers to a template which should implement the following operator:

      bool operator()(const JModule& first, const JModule& second);

Parameters

match module matcher

Definition at line 262 of file JModuleMapper.hh.

     {
       const JDetector& detector = this->getReference();
  
       zmap.resize(detector.size());
       
       for (typename std::vector<container_type>::iterator i = zmap.begin(); i != zmap.end(); ++i) {
         i->clear();
       }
  
       for (int i = 0; i != (int) detector.size(); ++i) {
         for (int j = i; ++j != (int) detector.size(); ) {
           if (match(detector[i], detector[j])) {
             zmap[i].push_back(moduleattributes_type(j, detector[i], detector[j]));
             zmap[j].push_back(moduleattributes_type(i, detector[j], detector[i]));
           }
         }
       }
     }

◆ getModuleRouter()

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

inlineinherited

Get module router.

Returns: module router

Definition at line 67 of file JModuleRouter.hh.

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

◆ getAddress()

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

inlineinherited

Get address of module.

Parameters

id	module identifier

Returns: address

Definition at line 79 of file JModuleRouter.hh.

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

◆ getModule()

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

inlineinherited

Get module parameters.

Parameters

id	module identifier

Returns: module parameters

Definition at line 91 of file JModuleRouter.hh.

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

◆ hasModule()

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

inlineinherited

Has module.

Parameters

id	module identifier

Returns: true if module present; else false

Definition at line 103 of file JModuleRouter.hh.

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

◆ getIndex()

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

inlineinherited

Get index of module.

Parameters

id	module identifier

Returns: index

Definition at line 115 of file JModuleRouter.hh.

     {
       return getAddress(id).first;
     }

◆ hasPMT()

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

inlineinherited

Has PMT.

Parameters

id	PMT identifier

Returns: true if PMT present; else false

Definition at line 127 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

inlineinherited

Get PMT parameters.

Parameters

id	PMT identifier

Returns: PMT parameters

Definition at line 139 of file JModuleRouter.hh.

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

◆ getUTMPosition()

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

inlineinherited

Get UTM position of given module identifier.

Parameters

id	module identifier

Returns: UTM position

Definition at line 151 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

◆ zmap

template<class JAttributes_t = JNullType>

std::vector<container_type> JDETECTOR::JModuleMapper< JAttributes_t >::zmap

protected

Definition at line 284 of file JModuleMapper.hh.

◆ router

JTOOLS::JRouter<JModuleAddress> JDETECTOR::JModuleRouter::router

privateinherited

Definition at line 157 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:

JModuleMapper.hh

Public Types

Public Member Functions

Protected Attributes

Private Types

Private Attributes

Detailed Description

template<class JAttributes_t = JNullType> class JDETECTOR::JModuleMapper< JAttributes_t >

Member Typedef Documentation

◆ moduleattributes_type

◆ container_type

◆ JReference_t

◆ const_iterator

Constructor & Destructor Documentation

◆ JModuleMapper() [1/4]

◆ JModuleMapper() [2/4]

◆ JModuleMapper() [3/4]

◆ JModuleMapper() [4/4]

Member Function Documentation

◆ getList()

◆ configure()

◆ 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

◆ zmap

◆ router

◆ __object

template<class JAttributes_t = JNullType>
class JDETECTOR::JModuleMapper< JAttributes_t >