Identifier Class Reference

#include <Identifier.h>

Public Types
typedef Identifier	id_type
typedef unsigned int	value_type
typedef unsigned int	size_type
typedef Identifier	id_type
typedef unsigned int	value_type
typedef unsigned int	size_type

Public Member Functions
	Identifier ()
	Default constructor.
	Identifier (value_type value)
	Constructor from value_type.
	Identifier (const Identifier &other)
	Copy constructor.
Identifier &	operator= (value_type value)
	Assignment operator.
Identifier &	operator|= (value_type value)
	Bitwise operations.
Identifier &	operator&= (value_type value)
void	set (const std::string &id)
	build from a string form - hexadecimal
void	clear ()
	Reset to invalid state.
	operator value_type (void) const
value_type	get_value () 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	is_valid () const
	Check if id is in a valid state.
std::string	getString () const
	Provide a string form of the identifier - hexadecimal.
void	show () const
	Print out in hex form.
	Identifier ()
	Default constructor.
	Identifier (value_type value)
	Constructor from value_type.
	Identifier (const Identifier &other)
	Copy constructor.
Identifier &	operator= (value_type value)
	Assignment operator.
Identifier &	operator|= (value_type value)
	Bitwise operations.
Identifier &	operator&= (value_type value)
void	set (const std::string &id)
	build from a string form - hexadecimal
void	clear ()
	Reset to invalid state.
	operator value_type (void) const
value_type	get_value () 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	is_valid () const
	Check if id is in a valid state.
std::string	getString () const
	Provide a string form of the identifier - hexadecimal.
void	show () const
	Print out in hex form.

Detailed Description

---

Identifier is a simple type-safe 32 bit unsigned integer. An Identifier relies on other classes to encode and decode its information.

The default constructor created an Identifier an invalid state which can be check with the "is_valid" method to allow some error checking.

---

Definition at line 20 of file DetectorDescription/Identifier/Identifier-00-02-17/Identifier/Identifier.h.

Member Typedef Documentation

id_type [1/2]

typedef Identifier Identifier::id_type

---

Define public typedefs

Definition at line 26 of file DetectorDescription/Identifier/Identifier-00-02-17/Identifier/Identifier.h.

id_type [2/2]

typedef Identifier Identifier::id_type

---

Define public typedefs

Definition at line 26 of file InstallArea/include/Identifier/Identifier/Identifier.h.

size_type [1/2]

typedef unsigned int Identifier::size_type

Definition at line 28 of file DetectorDescription/Identifier/Identifier-00-02-17/Identifier/Identifier.h.

size_type [2/2]

typedef unsigned int Identifier::size_type

Definition at line 28 of file InstallArea/include/Identifier/Identifier/Identifier.h.

value_type [1/2]

typedef unsigned int Identifier::value_type

Definition at line 27 of file DetectorDescription/Identifier/Identifier-00-02-17/Identifier/Identifier.h.

value_type [2/2]

typedef unsigned int Identifier::value_type

Definition at line 27 of file InstallArea/include/Identifier/Identifier/Identifier.h.

Constructor & Destructor Documentation

Identifier() [1/6]

Identifier::Identifier ( )

inline

Default constructor.

---

Constructors

Definition at line 110 of file DetectorDescription/Identifier/Identifier-00-02-17/Identifier/Identifier.h.

    : m_id(max_value)
{}

Identifier() [2/6]

Identifier::Identifier ( value_type  value )

inlineexplicit

Constructor from value_type.

Definition at line 121 of file DetectorDescription/Identifier/Identifier-00-02-17/Identifier/Identifier.h.

    : m_id(value)
{
}

Identifier() [3/6]

Identifier::Identifier ( const Identifier &  other )

inline

Copy constructor.

Definition at line 115 of file DetectorDescription/Identifier/Identifier-00-02-17/Identifier/Identifier.h.

    : m_id(other.get_value())
{
}

Identifier() [4/6]

Identifier::Identifier

(

)

Default constructor.

---

Constructors

Identifier() [5/6]

Identifier::Identifier ( value_type  value )

explicit

Constructor from value_type.

Identifier() [6/6]

Identifier::Identifier

(

const Identifier &

other

)

Copy constructor.

Member Function Documentation

clear() [1/2]

void Identifier::clear ( )

inline

Reset to invalid state.

Definition at line 152 of file DetectorDescription/Identifier/Identifier-00-02-17/Identifier/Identifier.h.

{
    m_id = max_value;
}

Referenced by RecEmcCluster::Clear(), RecEmcShower::Clear(), RecEmcTofHit::Clear(), BhabhaPreSelect::execute(), DigammaPreSelect::execute(), EmcRecNeighbor::GetNeighbors(), EmcRecNeighbor::GetNextNeighbors(), RecEmcDigit::RecEmcDigit(), and RecEmcHit::RecEmcHit().

clear() [2/2]

void Identifier::clear

(

)

Reset to invalid state.

get_value() [1/2]

Identifier::value_type Identifier::get_value ( ) const

inline

Definition at line 163 of file DetectorDescription/Identifier/Identifier-00-02-17/Identifier/Identifier.h.

{
    return (m_id);
}

Referenced by MdcTrack::storeTrack(), TofRawDataProvider::tofDataMapFull(), and TofRawDataProvider::tofDataMapOnlineMode().

get_value() [2/2]

value_type Identifier::get_value

(

)

const

getString() [1/2]

std::string Identifier::getString

(

)

const

Provide a string form of the identifier - hexadecimal.

---

Utilities

Definition at line 17 of file Identifier.cxx.

{
   std::string result;
   char temp[20];
   
   sprintf (temp, "0x%x", (unsigned int)m_id);
   result += temp;
   result.insert(2,10-result.length(),'0');
   
   return (result);
}

Referenced by operator<<().

getString() [2/2]

std::string Identifier::getString

(

)

const

Provide a string form of the identifier - hexadecimal.

---

Utilities

is_valid() [1/2]

bool Identifier::is_valid ( ) const

inline

Check if id is in a valid state.

---

Error management

Definition at line 198 of file DetectorDescription/Identifier/Identifier-00-02-17/Identifier/Identifier.h.

{
    return (!(max_value == m_id));
}

Referenced by EmcRec::execute().

is_valid() [2/2]

bool Identifier::is_valid

(

)

const

Check if id is in a valid state.

---

Error management

operator value_type() [1/2]

Identifier::operator Identifier::value_type ( void  ) const

inline

---

Accessors

Get the value

Definition at line 158 of file DetectorDescription/Identifier/Identifier-00-02-17/Identifier/Identifier.h.

{
    return (m_id);
}

operator value_type() [2/2]

Identifier::operator value_type

(

void

)

const

---

Accessors

Get the value

operator!=() [1/2]

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

inline

Definition at line 178 of file DetectorDescription/Identifier/Identifier-00-02-17/Identifier/Identifier.h.

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

operator!=() [2/2]

bool Identifier::operator!=

(

const Identifier &

other

)

const

operator&=() [1/2]

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

inline

Definition at line 145 of file DetectorDescription/Identifier/Identifier-00-02-17/Identifier/Identifier.h.

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

operator&=() [2/2]

Identifier & Identifier::operator&=

(

value_type

value

)

operator<() [1/2]

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

inline

Definition at line 184 of file DetectorDescription/Identifier/Identifier-00-02-17/Identifier/Identifier.h.

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

operator<() [2/2]

bool Identifier::operator<

(

const Identifier &

other

)

const

operator=() [1/2]

Identifier & Identifier::operator= ( value_type  value )

inline

Assignment operator.

---

Modifications

Definition at line 131 of file DetectorDescription/Identifier/Identifier-00-02-17/Identifier/Identifier.h.

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

operator=() [2/2]

Identifier & Identifier::operator=

(

value_type

value

)

Assignment operator.

---

Modifications

operator==() [1/2]

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

inline

---

Comparison operators

Definition at line 171 of file DetectorDescription/Identifier/Identifier-00-02-17/Identifier/Identifier.h.

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

operator==() [2/2]

bool Identifier::operator==

(

const Identifier &

other

)

const

---

Comparison operators

operator>() [1/2]

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

inline

Definition at line 192 of file DetectorDescription/Identifier/Identifier-00-02-17/Identifier/Identifier.h.

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

operator>() [2/2]

bool Identifier::operator>

(

const Identifier &

other

)

const

operator|=() [1/2]

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

inline

Bitwise operations.

Definition at line 138 of file DetectorDescription/Identifier/Identifier-00-02-17/Identifier/Identifier.h.

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

operator|=() [2/2]

Identifier & Identifier::operator|=

(

value_type

value

)

Bitwise operations.

set() [1/2]

void Identifier::set

(

const std::string &

id

)

build from a string form - hexadecimal

Definition at line 10 of file Identifier.cxx.

{
  sscanf (id.c_str(), "0x%x", &m_id);
}

set() [2/2]

void Identifier::set

(

const std::string &

id

)

build from a string form - hexadecimal

show() [1/2]

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();
}

show() [2/2]

void Identifier::show

(

)

const

Print out in hex form.

---

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

• DetectorDescription/Identifier/Identifier-00-02-17/Identifier/Identifier.h
• InstallArea/include/Identifier/Identifier/Identifier.h
• Identifier.cxx