Identifier Class Reference

#include <Identifier.h>

Public Types
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)
virtual void	set (const std::string &id)
	build from a string form - hexadecimal
virtual void	clear ()
	Reset to invalid state.
	operator value_type (void) const
value_type	get_value () const
virtual bool	operator== (const Identifier &other) const
virtual bool	operator!= (const Identifier &other) const
virtual bool	operator< (const Identifier &other) const
virtual bool	operator> (const Identifier &other) const
virtual bool	is_valid () const
	Check if id is in a valid state.
virtual std::string	getString () const
	Provide a string form of the identifier - hexadecimal.
virtual 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 Identifier.h.

Member Typedef Documentation

id_type

Identifier Identifier::id_type

---

Define public typedefs

Definition at line 26 of file Identifier.h.

size_type

unsigned int Identifier::size_type

Definition at line 28 of file Identifier.h.

value_type

unsigned int Identifier::value_type

Definition at line 27 of file Identifier.h.

Constructor & Destructor Documentation

Identifier() [1/3]

Identifier::Identifier ( )

inline

Default constructor.

---

Constructors

Definition at line 110 of file Identifier.h.

    : m_id(max_value)
{}

Identifier() [2/3]

Identifier::Identifier ( value_type value )

inlineexplicit

Constructor from value_type.

Definition at line 121 of file Identifier.h.

    : m_id(value)
{
}

Identifier() [3/3]

Identifier::Identifier ( const Identifier & other )

inline

Copy constructor.

Definition at line 115 of file Identifier.h.

    : m_id(other.get_value())
{
}

Member Function Documentation

clear()

void Identifier::clear ( )

inlinevirtual

Reset to invalid state.

Definition at line 152 of file Identifier.h.

{
    m_id = max_value;
}

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

get_value()

Identifier::value_type Identifier::get_value ( ) const

inline

Definition at line 163 of file Identifier.h.

{
    return (m_id);
}

Referenced by BesRawDataWriter::SaveCgemDigits(), MdcTrack::storeTrack(), HoughFinder::storeTracks(), TofRawDataProvider::tofDataMapFull(), TofRawDataProvider::tofDataMapOnlineMode(), and CgemMdcFitAlg::updateTracks().

getString()

std::string Identifier::getString ( ) const

virtual

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<<(), and show().

is_valid()

bool Identifier::is_valid ( ) const

inlinevirtual

Check if id is in a valid state.

---

Error management

Definition at line 198 of file Identifier.h.

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

Referenced by EmcRec::execute().

operator value_type()

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

inline

---

Accessors

Get the value

Definition at line 158 of file Identifier.h.

{
    return (m_id);
}

operator!=()

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

inlinevirtual

Definition at line 178 of file Identifier.h.

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

operator&=()

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

inline

Definition at line 145 of file Identifier.h.

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

operator<()

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

inlinevirtual

Definition at line 184 of file Identifier.h.

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

operator=()

Identifier & Identifier::operator= ( value_type value )

inline

Assignment operator.

---

Modifications

Definition at line 131 of file Identifier.h.

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

operator==()

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

inlinevirtual

---

Comparison operators

Definition at line 171 of file Identifier.h.

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

operator>()

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

inlinevirtual

Definition at line 192 of file Identifier.h.

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

operator|=()

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

inline

Bitwise operations.

Definition at line 138 of file Identifier.h.

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

set()

void Identifier::set ( const std::string & id )

virtual

build from a string form - hexadecimal

Definition at line 10 of file Identifier.cxx.

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

show()

void Identifier::show ( ) const

virtual

Print out in hex form.

Definition at line 30 of file Identifier.cxx.

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

---

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

• Identifier.h
• Identifier.cxx