Identifier Class Reference

#include <Identifier.h>

Inheritance diagram for Identifier:

Collaboration diagram for Identifier:

Classes
struct	get_compact_func
	A get_compact functional for use in STL algorithms. More...

Public Types
enum	bit_defs_enum { NBITS = sizeof(value_type) * 8, MAX_BIT = (static_cast<value_type>(1) << (NBITS - 1)), ALL_BITS = ~(static_cast<value_type>(0)) }
enum	max_value_type_enum { max_value = ~(static_cast<value_type>(0)) }
using	id_type = Identifier
using	value_type = unsigned long long
using	diff_type = long long
using	size_type = unsigned long long
typedef Long64_t	value_type
typedef enum Identifier::bit_defs_enum	bit_defs
typedef enum Identifier::max_value_type_enum	max_value_type

Public Member Functions
	Identifier ()=default
	Default constructor. More...
Identifier &	operator= (const Identifier32 &old)
	Assignment operators overloads. More...
Identifier &	operator= (value_type value)
Identifier &	operator= (Identifier32::value_type value)
	Assignment to avoid common implicit conversions and shift properly. More...
Identifier &	operator= (int value)
void	set (const std::string &id)
	build from a string form - hexadecimal More...
void	clear ()
	Reset to invalid state. More...
Identifier &	set_literal (value_type value)
	Set literal value. More...
Identifier32	get_identifier32 () const
	Get the 32-bit version Identifier, will be invalid if >32 bits needed. More...
value_type	get_compact () const
	Get the compact id. More...
bool	operator== (const Identifier &other) const =default
auto	operator (const Identifier &other) const
bool	operator== (value_type other) const
	Comparison operators with value_type. More...
bool	operator== (Identifier32::value_type other) const
bool	operator== (int other) const
bool	is_valid () const
	Check if id is in a valid state. More...
std::string	getString () const
	Provide a string form of the identifier - hexadecimal. More...
void	show () const
	Print out in hex form. More...
	Identifier ()
	Identifier (const Identifier &value)=default
	Identifier (value_type value)
	operator value_type () const
Identifier &	operator= (const Identifier &old)=default
Identifier &	operator= (value_type value)
bool	operator== (const Identifier &other) const
bool	operator!= (const Identifier &other) const
bool	operator< (const Identifier &other) const
bool	operator> (const Identifier &other) const
bool	operator<= (const Identifier &other) const
bool	operator>= (const Identifier &other) const
bool	operator== (Identifier::value_type other) const
bool	operator!= (Identifier::value_type other) const
	Identifier (value_type value)
	Identifier (const Identifier32 &other)
	Constructor from Identifier32. More...
	Identifier (Identifier32::value_type value)
	Constructor from 32-bit value_type and int (to avoid common implicit conversions) More...
	Identifier (int value)

Static Public Attributes
static constexpr unsigned int	NBITS = sizeof(value_type) * 8
static constexpr value_type	MAX_BIT = (static_cast<value_type>(1) << (NBITS - 1))
static constexpr value_type	ALL_BITS = ~(static_cast<value_type>(0))

Private Types
enum	max_value_type { max_value = ~(static_cast<value_type>(0)) }

Private Member Functions
Identifier &	operator|= (value_type value)
	Bitwise operations. More...
Identifier &	operator&= (value_type value)
value_type	extract (size_type shift, size_type mask) const
	extract field from identifier (shift first, then mask) More...
value_type	mask_shift (value_type mask, size_type shift) const
	extract field(s) by masking first, then shifting More...
value_type	extract (size_type shift) const
	extract field, no mask More...

Private Attributes
value_type	m_id = max_value
	The only data member. More...

Friends
class	IdDictDictionary
class	IdDictFieldImplementation
class	AtlasDetectorID
class	PixelID

Detailed Description

Definition at line 23 of file DetectorDescription/Identifier/Identifier/Identifier.h.

Member Typedef Documentation

bit_defs

typedef enum Identifier::bit_defs_enum Identifier::bit_defs

diff_type

using Identifier::diff_type = long long

Definition at line 28 of file DetectorDescription/Identifier/Identifier/Identifier.h.

id_type

using Identifier::id_type = Identifier

Definition at line 26 of file DetectorDescription/Identifier/Identifier/Identifier.h.

max_value_type

typedef enum Identifier::max_value_type_enum Identifier::max_value_type

size_type

using Identifier::size_type = unsigned long long

Definition at line 29 of file DetectorDescription/Identifier/Identifier/Identifier.h.

value_type [1/2]

typedef Long64_t Identifier::value_type

Definition at line 18 of file Simulation/ISF/ISF_FastCaloSim/ISF_FastCaloSimParametrization/tools/Identifier/Identifier.h.

value_type [2/2]

using Identifier::value_type = unsigned long long

Definition at line 27 of file DetectorDescription/Identifier/Identifier/Identifier.h.

Member Enumeration Documentation

bit_defs_enum

enum Identifier::bit_defs_enum

Enumerator
NBITS
MAX_BIT
ALL_BITS

Definition at line 20 of file Simulation/ISF/ISF_FastCaloSim/ISF_FastCaloSimParametrization/tools/Identifier/Identifier.h.

  {
    NBITS = sizeof(value_type) * 8, // bits per byte
    MAX_BIT = (static_cast<value_type>(1) << (NBITS - 1)),
    ALL_BITS = ~(static_cast<value_type>(0))
  } bit_defs;

max_value_type

enum Identifier::max_value_type

private

Enumerator
max_value

Definition at line 126 of file DetectorDescription/Identifier/Identifier/Identifier.h.

                       {
      max_value = ~(static_cast<value_type>(0))
    };

max_value_type_enum

enum Identifier::max_value_type_enum

Enumerator
max_value

Definition at line 27 of file Simulation/ISF/ISF_FastCaloSim/ISF_FastCaloSimParametrization/tools/Identifier/Identifier.h.

                                   {
    //max_value = 0xFFFFFFFFFFFFFFFFULL
    max_value = ~(static_cast<value_type>(0))
  } max_value_type;

Constructor & Destructor Documentation

Identifier() [1/8]

Identifier::Identifier ( )

default

Default constructor.

Identifier() [2/8]

Identifier::Identifier ( value_type  value )

explicit

Additional ctors Constructor from value_type

Identifier() [3/8]

Identifier::Identifier

(

const Identifier32 &

other

)

Constructor from Identifier32.

Identifier() [4/8]

Identifier::Identifier ( Identifier32::value_type  value )

explicit

Constructor from 32-bit value_type and int (to avoid common implicit conversions)

Identifier() [5/8]

Identifier::Identifier ( int  value )

explicit

Identifier() [6/8]

Identifier::Identifier ( )

inline

Definition at line 32 of file Simulation/ISF/ISF_FastCaloSim/ISF_FastCaloSimParametrization/tools/Identifier/Identifier.h.

:m_id(max_value) {};

Identifier() [7/8]

Identifier::Identifier ( const Identifier &  value )

default

Identifier() [8/8]

Identifier::Identifier ( value_type  value )

inline

Definition at line 34 of file Simulation/ISF/ISF_FastCaloSim/ISF_FastCaloSimParametrization/tools/Identifier/Identifier.h.

:m_id(value) {};

Member Function Documentation

clear()

void Identifier::clear

(

)

Reset to invalid state.

extract() [1/2]

value_type Identifier::extract ( size_type  shift ) const

private

extract field, no mask

extract() [2/2]

value_type Identifier::extract ( size_type  shift, size_type  mask  ) const

private

extract field from identifier (shift first, then mask)

get_compact()

value_type Identifier::get_compact

(

)

const

Get the compact id.

get_identifier32()

Identifier32 Identifier::get_identifier32

(

)

const

Get the 32-bit version Identifier, will be invalid if >32 bits needed.

getString()

std::string Identifier::getString

(

)

const

Provide a string form of the identifier - hexadecimal.

Definition at line 25 of file Identifier.cxx.

                           {
  return std::format("0x{:0x}", m_id);
}

is_valid()

bool Identifier::is_valid

(

)

const

Check if id is in a valid state.

mask_shift()

value_type Identifier::mask_shift ( value_type  mask, size_type  shift  ) const

private

extract field(s) by masking first, then shifting

operator()

auto Identifier::operator ( const Identifier &  other ) const

inline

Definition at line 90 of file DetectorDescription/Identifier/Identifier/Identifier.h.

{return m_id <=> other.m_id;}

operator value_type()

Identifier::operator value_type ( ) const

inline

Definition at line 36 of file Simulation/ISF/ISF_FastCaloSim/ISF_FastCaloSimParametrization/tools/Identifier/Identifier.h.

{ return m_id; }

operator!=() [1/2]

bool Identifier::operator!= ( const Identifier &  other ) const

inline

Definition at line 41 of file Simulation/ISF/ISF_FastCaloSim/ISF_FastCaloSimParametrization/tools/Identifier/Identifier.h.

{return (m_id != other.m_id);}

operator!=() [2/2]

bool Identifier::operator!= ( Identifier::value_type  other ) const

inline

Definition at line 47 of file Simulation/ISF/ISF_FastCaloSim/ISF_FastCaloSimParametrization/tools/Identifier/Identifier.h.

{return (m_id != other);}

operator&=()

Identifier& Identifier::operator&= ( value_type  value )

private

operator<()

bool Identifier::operator< ( const Identifier &  other ) const

inline

Definition at line 42 of file Simulation/ISF/ISF_FastCaloSim/ISF_FastCaloSimParametrization/tools/Identifier/Identifier.h.

{return (m_id < other.m_id);}

operator<=()

bool Identifier::operator<= ( const Identifier &  other ) const

inline

Definition at line 44 of file Simulation/ISF/ISF_FastCaloSim/ISF_FastCaloSimParametrization/tools/Identifier/Identifier.h.

{return (m_id <= other.m_id);}

operator=() [1/6]

Identifier& Identifier::operator= ( const Identifier &  old )

default

operator=() [2/6]

Identifier& Identifier::operator=

(

const Identifier32 &

old

)

Assignment operators overloads.

operator=() [3/6]

Identifier& Identifier::operator=

(

Identifier32::value_type

value

)

Assignment to avoid common implicit conversions and shift properly.

operator=() [4/6]

Identifier& Identifier::operator=

(

int

value

)

operator=() [5/6]

Identifier& Identifier::operator= ( value_type  value )

inline

Definition at line 39 of file Simulation/ISF/ISF_FastCaloSim/ISF_FastCaloSimParametrization/tools/Identifier/Identifier.h.

{m_id=value;return (*this);};

operator=() [6/6]

Identifier& Identifier::operator=

(

value_type

value

)

operator==() [1/6]

bool Identifier::operator== ( const Identifier &  other ) const

inline

Definition at line 40 of file Simulation/ISF/ISF_FastCaloSim/ISF_FastCaloSimParametrization/tools/Identifier/Identifier.h.

{return (m_id == other.m_id);}

operator==() [2/6]

bool Identifier::operator== ( const Identifier &  other ) const

default

operator==() [3/6]

bool Identifier::operator==

(

Identifier32::value_type

other

)

const

operator==() [4/6]

bool Identifier::operator== ( Identifier::value_type  other ) const

inline

Definition at line 46 of file Simulation/ISF/ISF_FastCaloSim/ISF_FastCaloSimParametrization/tools/Identifier/Identifier.h.

{return (m_id == other);}

operator==() [5/6]

bool Identifier::operator==

(

int

other

)

const

operator==() [6/6]

bool Identifier::operator==

(

value_type

other

)

const

Comparison operators with value_type.

This is a hack, only because GeoAdaptors/GeoMuonHits wants to to compare explicitly with 0 as a test of whether the identifier has been constructed properly. But is_valid() here compares with max_value, not 0, since presumably it is possible to have a zero value - just not in muons.

operator>()

bool Identifier::operator> ( const Identifier &  other ) const

inline

Definition at line 43 of file Simulation/ISF/ISF_FastCaloSim/ISF_FastCaloSimParametrization/tools/Identifier/Identifier.h.

{return (m_id > other.m_id);}

operator>=()

bool Identifier::operator>= ( const Identifier &  other ) const

inline

Definition at line 45 of file Simulation/ISF/ISF_FastCaloSim/ISF_FastCaloSimParametrization/tools/Identifier/Identifier.h.

{return (m_id >= other.m_id);}

operator|=()

Identifier& Identifier::operator|= ( value_type  value )

private

Bitwise operations.

set()

void Identifier::set

(

const std::string &

id

)

build from a string form - hexadecimal

Definition at line 12 of file Identifier.cxx.

                                        {
  const auto start = id.data();
  const auto end = start + id.size();
  static constexpr int base = 16;
  //add 2 to start to get past the Ox prefix.
  const auto [p,ec] = std::from_chars(start+2, end, m_id, base);
  if (ec != std::errc()){
    throw std::runtime_error("Number was not parsed in Identifier::set");
  }
}

set_literal()

Identifier& Identifier::set_literal

(

value_type

value

)

Set literal value.

show()

void Identifier::show

(

)

const

Print out in hex form.

Definition at line 30 of file Identifier.cxx.

                       {
    const Identifier& me = *this;
    std::cout << me.getString();
}

Friends And Related Function Documentation

AtlasDetectorID

friend class AtlasDetectorID

friend

Definition at line 123 of file DetectorDescription/Identifier/Identifier/Identifier.h.

IdDictDictionary

friend class IdDictDictionary

friend

Definition at line 121 of file DetectorDescription/Identifier/Identifier/Identifier.h.

IdDictFieldImplementation

friend class IdDictFieldImplementation

friend

Definition at line 122 of file DetectorDescription/Identifier/Identifier/Identifier.h.

PixelID

friend class PixelID

friend

Definition at line 124 of file DetectorDescription/Identifier/Identifier/Identifier.h.

Member Data Documentation

ALL_BITS

constexpr value_type Identifier::ALL_BITS = ~(static_cast<value_type>(0))

staticconstexpr

Definition at line 33 of file DetectorDescription/Identifier/Identifier/Identifier.h.

m_id

value_type Identifier::m_id = max_value

private

The only data member.

Definition at line 130 of file DetectorDescription/Identifier/Identifier/Identifier.h.

MAX_BIT

constexpr value_type Identifier::MAX_BIT = (static_cast<value_type>(1) << (NBITS - 1))

staticconstexpr

Definition at line 32 of file DetectorDescription/Identifier/Identifier/Identifier.h.

NBITS

constexpr unsigned int Identifier::NBITS = sizeof(value_type) * 8

staticconstexpr

Definition at line 31 of file DetectorDescription/Identifier/Identifier/Identifier.h.

---

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

• DetectorDescription/Identifier/Identifier/Identifier.h
• Identifier.cxx