ITkStripOnlineId Class Reference

#include <ITkStripOnlineId.h>

Collaboration diagram for ITkStripOnlineId:

Public Types
enum	{ INVALID_FIBRE =255 , INVALID_ROD =16777215 , INVALID_ONLINE_ID =0xFFFFFFFF }

Public Member Functions
	ITkStripOnlineId ()=default
	Default constructor produces an invalid serial number.
	ITkStripOnlineId (const std::uint32_t onlineId)
	Construct from uint32.
	ITkStripOnlineId (const std::uint32_t rodId, const std::uint32_t fibre)
	Construct from robId and fibre; a cursory check is made on validity of the input.
std::uint32_t	rod () const
	Return the rod/rob Id.
std::uint32_t	fibre () const
	Return the fibre.
	operator unsigned int () const
	Overload cast to uint.
auto	operator<=> (const ITkStripOnlineId &other) const =default
	Equality etc.
bool	isValid () const

Private Attributes
std::uint32_t	m_onlineId {INVALID_ONLINE_ID}

Friends
std::ostream &	operator<< (std::ostream &os, const ITkStripOnlineId &id)
	representation for debugging, messages

Detailed Description

Definition at line 16 of file ITkStripOnlineId.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
INVALID_FIBRE
INVALID_ROD
INVALID_ONLINE_ID

Definition at line 37 of file ITkStripOnlineId.h.

       {
    INVALID_FIBRE=255, INVALID_ROD=16777215, INVALID_ONLINE_ID=0xFFFFFFFF
  };

Constructor & Destructor Documentation

ITkStripOnlineId() [1/3]

ITkStripOnlineId::ITkStripOnlineId ( )

default

Default constructor produces an invalid serial number.

ITkStripOnlineId() [2/3]

ITkStripOnlineId::ITkStripOnlineId

(

const std::uint32_t

onlineId

)

Construct from uint32.

Definition at line 9 of file ITkStripOnlineId.cxx.

                                                            :m_onlineId(onlineId){
  //nop
}

ITkStripOnlineId() [3/3]

ITkStripOnlineId::ITkStripOnlineId	(	const std::uint32_t	rodId,
		const std::uint32_t	fibre )

Construct from robId and fibre; a cursory check is made on validity of the input.

Definition at line 14 of file ITkStripOnlineId.cxx.

                                                                                  {
    m_onlineId = rodId + (fibre<<24);
}

Member Function Documentation

fibre()

std::uint32_t ITkStripOnlineId::fibre

(

)

const

Return the fibre.

Definition at line 25 of file ITkStripOnlineId.cxx.

                              {
  return m_onlineId>>24;
}

isValid()

bool ITkStripOnlineId::isValid

(

)

const

Definition at line 30 of file ITkStripOnlineId.cxx.

                               {
  return m_onlineId != INVALID_ONLINE_ID;
}

operator unsigned int()

ITkStripOnlineId::operator unsigned int ( ) const

inlineexplicit

Overload cast to uint.

Definition at line 31 of file ITkStripOnlineId.h.

{return m_onlineId;}

operator<=>()

auto ITkStripOnlineId::operator<=> ( const ITkStripOnlineId & other ) const

default

Equality etc.

rod()

std::uint32_t ITkStripOnlineId::rod

(

)

const

Return the rod/rob Id.

Definition at line 19 of file ITkStripOnlineId.cxx.

                            {
  return m_onlineId & 0xFFFFFF;
}

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream & os, const ITkStripOnlineId & id )

friend

representation for debugging, messages

Definition at line 34 of file ITkStripOnlineId.cxx.

                                                                    {
  os<<std::hex<<std::showbase<<id.m_onlineId<<std::dec<<std::noshowbase;
  return os;
}

Member Data Documentation

m_onlineId

std::uint32_t ITkStripOnlineId::m_onlineId {INVALID_ONLINE_ID}

private

Definition at line 41 of file ITkStripOnlineId.h.

{INVALID_ONLINE_ID};

---

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

• ITkStripOnlineId.h
• ITkStripOnlineId.cxx