Helper class implementation to instantiate the templated IdentifierHashTable class. More...

#include <MdtTubeInChamberIdFields.h>

Inheritance diagram for MdtTubeInChamberIdFields:

Collaboration diagram for MdtTubeInChamberIdFields:

Public Types
enum	{ kTubeField = 0, kLayerField = 1, kMultilayerField = 2 }
	enum the identifier fiels More...

typedef IdHashTableHelper< 3, MdtTubeId, MdtTubeHash >	BaseClass
	define type BaseClasse More...

enum
	N is the number of fields to use from the identifier. More...

typedef MdtTubeId	IdentifierType
	define type IdentifierType More...

typedef MdtTubeHash	HashType
	define type HashType More...

typedef MdtTubeHash	ValueType
	needed for MultiDimArray<> instantiation More...

Public Member Functions
void	setAll (const MdtTubeId &id)
	Set identifier and also the fields (using the internal helper). More...

void	setAll (int fields[3])
	Set fields and also the identifier (using the internal helper) More...

const IdentifierType &	getId () const
	Get the identifier. More...

void	setId (const IdentifierType &id)
	Set (only) the identifier. More...

int	operator[] (unsigned int fieldIndex) const
	Return the value encoded in field. More...

void	setField (int index, int value)
	Set field at index to value. More...

void	setFields (int fields[N])
	Set fields from array. More...

Static Public Member Functions
static void	setDefaults (const IdentifierType &defId, const HashType &defHash)
	Set the default (invalid) values for identifier and hash. More...

static bool	isValid (const IdentifierType &)

static HashType	defaultHash ()
	Returns default (=invalid) hash. More...

static IdentifierType	defaultIdentifier ()
	Return default (=invalid) identifier. More...

static ValueType	defaultValue ()
	Return default hash. More...

Private Attributes
IdentifierType	m_id

int	m_fields [N]

Static Private Attributes
static IdentifierType	s_defaultId

static HashType	s_defaultHash

Detailed Description

Helper class implementation to instantiate the templated IdentifierHashTable class.

The template parameter T is an external IdentifierHelper class to encode/decode the fields in the identifier.

Definition at line 28 of file MdtTubeInChamberIdFields.h.

Member Typedef Documentation

◆ BaseClass

typedef IdHashTableHelper<3,MdtTubeId,MdtTubeHash> MdtTubeInChamberIdFields::BaseClass

define type BaseClasse

Definition at line 38 of file MdtTubeInChamberIdFields.h.

◆ HashType

typedef MdtTubeHash IdHashTableHelper< N, MdtTubeId , MdtTubeHash >::HashType

inherited

define type HashType

Definition at line 42 of file IdHashTableHelper.h.

◆ IdentifierType

typedef MdtTubeId IdHashTableHelper< N, MdtTubeId , MdtTubeHash >::IdentifierType

inherited

define type IdentifierType

Definition at line 40 of file IdHashTableHelper.h.

◆ ValueType

typedef MdtTubeHash IdHashTableHelper< N, MdtTubeId , MdtTubeHash >::ValueType

inherited

needed for MultiDimArray<> instantiation

Definition at line 44 of file IdHashTableHelper.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

inherited

N is the number of fields to use from the identifier.

NMAX is just to make sure we get unsigned int type of enum.

Definition at line 38 of file IdHashTableHelper.h.

73 :

74 //

◆ anonymous enum

anonymous enum

enum the identifier fiels

Enumerator
kTubeField
kLayerField
kMultilayerField

Definition at line 40 of file MdtTubeInChamberIdFields.h.

Member Function Documentation

◆ defaultHash()

IdHashTableHelper< N, MdtTubeId , MdtTubeHash >::HashType IdHashTableHelper< N, MdtTubeId , MdtTubeHash >::defaultHash

inlinestaticinherited

Returns default (=invalid) hash.

Definition at line 75 of file IdHashTableHelper.h.

                                           {
    return s_defaultHash;
 }

◆ defaultIdentifier()

IdHashTableHelper< N, MdtTubeId , MdtTubeHash >::IdentifierType IdHashTableHelper< N, MdtTubeId , MdtTubeHash >::defaultIdentifier

inlinestaticinherited

Return default (=invalid) identifier.

Definition at line 77 of file IdHashTableHelper.h.

                                                 {
    return s_defaultId;
 }

◆ defaultValue()

IdHashTableHelper< N, MdtTubeId , MdtTubeHash >::ValueType IdHashTableHelper< N, MdtTubeId , MdtTubeHash >::defaultValue

inlinestaticinherited

Return default hash.

Needed for class MultiDimArray.

Definition at line 79 of file IdHashTableHelper.h.

                                            {
    return defaultHash();
 }

◆ getId()

const IdHashTableHelper< N, MdtTubeId , MdtTubeHash >::IdentifierType & IdHashTableHelper< N, MdtTubeId , MdtTubeHash >::getId

inlineinherited

Get the identifier.

Definition at line 57 of file IdHashTableHelper.h.

                                           {
    return m_id;
 }

◆ isValid()

bool IdHashTableHelper< N, MdtTubeId , MdtTubeHash >::isValid ( const IdentifierType & id )

inlinestaticinherited

Definition at line 73 of file IdHashTableHelper.h.

                                                                             {
   return id != s_defaultId;
 }

◆ operator[]()

int IdHashTableHelper< N, MdtTubeId , MdtTubeHash >::operator[] ( unsigned int fieldIndex ) const

inlineinherited

Return the value encoded in field.

No range check!

Definition at line 61 of file IdHashTableHelper.h.

                                                                               {
    return m_fields[index];
 }

◆ setAll() [1/2]

void MdtTubeInChamberIdFields::setAll ( const MdtTubeId & id )

inline

Set identifier and also the fields (using the internal helper).

Definition at line 47 of file MdtTubeInChamberIdFields.h.

                                                                   {
    BaseClass::setId( id );
    BaseClass::setField( kMultilayerField, id.multilayer() );
    BaseClass::setField( kLayerField,      id.layer()      );
    BaseClass::setField( kTubeField,       id.tube()       );
 }

◆ setAll() [2/2]

void MdtTubeInChamberIdFields::setAll ( int fields[3] )

inline

Set fields and also the identifier (using the internal helper)

Definition at line 41 of file MdtTubeInChamberIdFields.h.

                                                             {
    BaseClass::setFields( fields );
    MdtTubeId id( fields[kMultilayerField], fields[kLayerField], fields[kTubeField] );
    BaseClass::setId( id );
 }

◆ setDefaults()

void IdHashTableHelper< N, MdtTubeId , MdtTubeHash >::setDefaults	(	const IdentifierType &	defId,
		const HashType &	defHash
	)

inlinestaticinherited

Set the default (invalid) values for identifier and hash.

Must be called (once per type T) if the default constructors of HashType or IdentifierType do not give a well defined (invalid!) value. This is typically the case for built-in types.

Definition at line 70 of file IdHashTableHelper.h.

                                                                   {
    s_defaultId   = defId;
    s_defaultHash = defHash;
 }

◆ setField()

void IdHashTableHelper< N, MdtTubeId , MdtTubeHash >::setField	(	int	index,
		int	value
	)

inlineinherited

Set field at index to value.

No range check!

Definition at line 63 of file IdHashTableHelper.h.

                                                                          {
    m_fields[index] = value;
 }

◆ setFields()

void IdHashTableHelper< N, MdtTubeId , MdtTubeHash >::setFields ( int fields[N] )

inlineinherited

Set fields from array.

Definition at line 65 of file IdHashTableHelper.h.

                                                                    {
    for ( unsigned int i = 0; i < N; ++i ) m_fields[i] = fields[i];
 }

◆ setId()

void IdHashTableHelper< N, MdtTubeId , MdtTubeHash >::setId ( const IdentifierType & id )

inlineinherited

Set (only) the identifier.

Definition at line 59 of file IdHashTableHelper.h.

                                                                                                    {
    m_id = id;
 }

Member Data Documentation

◆ m_fields

int IdHashTableHelper< N, MdtTubeId , MdtTubeHash >::m_fields[N]

privateinherited

Definition at line 85 of file IdHashTableHelper.h.

◆ m_id

IdentifierType IdHashTableHelper< N, MdtTubeId , MdtTubeHash >::m_id

privateinherited

Definition at line 84 of file IdHashTableHelper.h.

◆ s_defaultHash

IdHashTableHelper< N, MdtTubeId , MdtTubeHash >::HashType IdHashTableHelper< N, MdtTubeId , MdtTubeHash >::s_defaultHash

staticprivateinherited

Definition at line 90 of file IdHashTableHelper.h.

◆ s_defaultId

IdHashTableHelper< N, MdtTubeId , MdtTubeHash >::IdentifierType IdHashTableHelper< N, MdtTubeId , MdtTubeHash >::s_defaultId

staticprivateinherited

Definition at line 89 of file IdHashTableHelper.h.

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

MdtTubeInChamberIdFields.h

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ BaseClass

◆ HashType

◆ IdentifierType

◆ ValueType

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

Member Function Documentation

◆ defaultHash()

◆ defaultIdentifier()

◆ defaultValue()

◆ getId()

◆ isValid()

◆ operator[]()

◆ setAll() [1/2]

◆ setAll() [2/2]

◆ setDefaults()

◆ setField()

◆ setFields()

◆ setId()

Member Data Documentation

◆ m_fields

◆ m_id

◆ s_defaultHash

◆ s_defaultId