#include <ITkPixelOnlineId.h>

Collaboration diagram for ITkPixelOnlineId:

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

Public Member Functions
	ITkPixelOnlineId ()=default
	Default constructor produces an invalid serial number. More...

	ITkPixelOnlineId (const std::uint32_t onlineId)
	Construct from uint32. More...

	ITkPixelOnlineId (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. More...

std::uint32_t	rod () const
	Return the rod/rob Id. More...

std::uint32_t	fibre () const
	Return the fibre. More...

	operator unsigned int () const
	Overload cast to uint. More...

auto	operator (const ITkPixelOnlineId &other) const =default
	Equality etc. More...

bool	isValid () const

Private Attributes
std::uint32_t	m_onlineId {INVALID_ONLINE_ID}

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

Detailed Description

Definition at line 18 of file ITkPixelOnlineId.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
INVALID_FIBRE
INVALID_ROD
INVALID_ONLINE_ID

Definition at line 39 of file ITkPixelOnlineId.h.

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

Constructor & Destructor Documentation

◆ ITkPixelOnlineId() [1/3]

ITkPixelOnlineId::ITkPixelOnlineId ( )

default

Default constructor produces an invalid serial number.

◆ ITkPixelOnlineId() [2/3]

ITkPixelOnlineId::ITkPixelOnlineId ( const std::uint32_t onlineId )

Construct from uint32.

Definition at line 9 of file ITkPixelOnlineId.cxx.

                                                             :m_onlineId(onlineId){
   //nop
 }

◆ ITkPixelOnlineId() [3/3]

ITkPixelOnlineId::ITkPixelOnlineId	(	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 ITkPixelOnlineId.cxx.

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

Member Function Documentation

◆ fibre()

std::uint32_t ITkPixelOnlineId::fibre ( ) const

Return the fibre.

Definition at line 25 of file ITkPixelOnlineId.cxx.

                               {
   return m_onlineId>>24;
 }

◆ isValid()

bool ITkPixelOnlineId::isValid ( ) const

Definition at line 30 of file ITkPixelOnlineId.cxx.

                                {
   return m_onlineId != INVALID_ONLINE_ID;
 }

◆ operator()

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

default

Equality etc.

◆ operator unsigned int()

ITkPixelOnlineId::operator unsigned int ( ) const

inlineexplicit

Overload cast to uint.

Definition at line 33 of file ITkPixelOnlineId.h.

33 {return m_onlineId;}

◆ rod()

std::uint32_t ITkPixelOnlineId::rod ( ) const

Return the rod/rob Id.

Definition at line 19 of file ITkPixelOnlineId.cxx.

                             {
   return m_onlineId & 0xFFFFFF;
 }

Friends And Related Function Documentation

◆ operator<<

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

friend

representation for debugging, messages

Definition at line 34 of file ITkPixelOnlineId.cxx.

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

Member Data Documentation

◆ m_onlineId

std::uint32_t ITkPixelOnlineId::m_onlineId {INVALID_ONLINE_ID}

private

Definition at line 43 of file ITkPixelOnlineId.h.

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

Public Types

Public Member Functions

Private Attributes

Friends