Basic time unit for IOVSvc. More...

#include <IOVTime.h>

Collaboration diagram for IOVTime:

Classes
class	SortByRunEvent
	Predicate. More...
class	SortByTimeStamp
	Predicate. More...

Public Member Functions
	IOVTime ()
	IOVTime (uint64_t timestamp)
	IOVTime (uint32_t run, uint32_t event)
	IOVTime (uint32_t run, uint32_t event, uint64_t timestamp)
	IOVTime (const EventIDBase &eid)
void	setTimestamp (uint64_t timestamp) noexcept
void	setRETime (uint64_t time) noexcept
void	setRunEvent (uint32_t run, uint32_t event) noexcept
void	reset () noexcept
uint32_t	run () const noexcept
uint32_t	event () const noexcept
uint64_t	re_time () const noexcept
uint64_t	timestamp () const noexcept
bool	isValid () const noexcept
bool	isTimestamp () const noexcept
bool	isRunEvent () const noexcept
bool	isBoth () const noexcept
	operator std::string () const
	operator EventIDBase () const

Static Public Attributes
static constexpr uint32_t	MINRUN = std::numeric_limits<uint32_t>::min()
static constexpr uint32_t	MAXRUN = (std::numeric_limits<uint32_t>::max() >> 1)
static constexpr uint32_t	MINEVENT = std::numeric_limits<uint32_t>::min()
static constexpr uint32_t	MAXEVENT = (std::numeric_limits<uint32_t>::max())
static constexpr uint64_t	MAXRETIME =( ((uint64_t) IOVTime::MAXRUN << 32) + IOVTime::MAXEVENT )
static constexpr uint64_t	UNDEFRETIME = std::numeric_limits<uint64_t>::max()
static constexpr uint64_t	MINTIMESTAMP = std::numeric_limits<uint64_t>::min()
static constexpr uint64_t	MAXTIMESTAMP = (std::numeric_limits<uint64_t>::max() >> 1)
static constexpr uint64_t	UNDEFTIMESTAMP = std::numeric_limits<uint64_t>::max()

Private Types
enum	IOVTime_type { UNDEF = 0 , TIMESTAMP , RUN_EVT , BOTH }

Private Attributes
IOVTime_type	m_status
uint64_t	m_time
uint64_t	m_timestamp

Friends
bool	operator< (const IOVTime &lhs, const IOVTime &rhs)
bool	operator> (const IOVTime &lhs, const IOVTime &rhs)
bool	operator== (const IOVTime &lhs, const IOVTime &rhs)
bool	operator!= (const IOVTime &lhs, const IOVTime &rhs)
bool	operator>= (const IOVTime &lhs, const IOVTime &rhs)
bool	operator<= (const IOVTime &lhs, const IOVTime &rhs)
std::ostream &	operator<< (std::ostream &os, const IOVTime &rhs)
MsgStream &	operator<< (MsgStream &os, const IOVTime &rhs)

Detailed Description

Basic time unit for IOVSvc.

Hold time as a combination of run and event numbers

Definition at line 33 of file IOVTime.h.

Member Enumeration Documentation

◆ IOVTime_type

enum IOVTime::IOVTime_type

private

Enumerator
UNDEF
TIMESTAMP
RUN_EVT
BOTH

Definition at line 36 of file IOVTime.h.

                    {
    UNDEF = 0,
    TIMESTAMP,
    RUN_EVT,
    BOTH
  };

Constructor & Destructor Documentation

◆ IOVTime() [1/5]

IOVTime::IOVTime ( )

inline

Definition at line 91 of file IOVTime.h.

91 : m_status(IOVTime::UNDEF), m_time(UNDEFRETIME),

92 m_timestamp(UNDEFTIMESTAMP){};

IOVTime::UNDEFTIMESTAMP

static constexpr uint64_t UNDEFTIMESTAMP

Definition IOVTime.h:59

IOVTime::UNDEFRETIME

static constexpr uint64_t UNDEFRETIME

Definition IOVTime.h:54

IOVTime::m_status

IOVTime_type m_status

Definition IOVTime.h:132

IOVTime::m_time

uint64_t m_time

Definition IOVTime.h:133

IOVTime::m_timestamp

uint64_t m_timestamp

Definition IOVTime.h:134

◆ IOVTime() [2/5]

IOVTime::IOVTime ( uint64_t timestamp )

inlineexplicit

Definition at line 93 of file IOVTime.h.

93 : m_status(IOVTime::TIMESTAMP),

94 m_time(IOVTime::UNDEFRETIME), m_timestamp(timestamp){};

IOVTime::timestamp

uint64_t timestamp() const noexcept

Definition IOVTime.h:108

◆ IOVTime() [3/5]

IOVTime::IOVTime	(	uint32_t	run,
		uint32_t	event )

explicit

Definition at line 26 of file IOVTime.cxx.

                                            :
  m_status(IOVTime::RUN_EVT),
  m_timestamp(IOVTime::UNDEFTIMESTAMP)
{
  m_time =  ( (uint64_t) run << 32) + event;
}

◆ IOVTime() [4/5]

IOVTime::IOVTime	(	uint32_t	run,
		uint32_t	event,
		uint64_t	timestamp )

explicit

Definition at line 35 of file IOVTime.cxx.

                        :  
  m_status(IOVTime::BOTH), m_timestamp(time)
{
  m_time =  ( (uint64_t) run << 32) + event;
}

◆ IOVTime() [5/5]

IOVTime::IOVTime ( const EventIDBase & eid )

Definition at line 44 of file IOVTime.cxx.

{
  m_time = 0;
  m_timestamp = eid.time_stamp()*1000000000LL + eid.time_stamp_ns_offset();
 
  if (eid.isRunEvent()) {
    m_time = ( (uint64_t) eid.run_number() << 32) + eid.event_number();
    if (eid.isTimeStamp()) {
      m_status = IOVTime::BOTH;
    } else {
      m_status = IOVTime::RUN_EVT;
    }
  } else if (eid.isLumiEvent()) {
    m_time = ( (uint64_t) eid.lumi_block() << 32) + eid.event_number();
    if (eid.isTimeStamp()) {
      m_status = IOVTime::BOTH;
    } else {
      m_status = IOVTime::RUN_EVT;
    }
  } else {
    m_status = IOVTime::TIMESTAMP;
  }
 
}

Member Function Documentation

◆ event()

uint32_t IOVTime::event ( ) const

inlinenoexcept

Definition at line 106 of file IOVTime.h.

106{ return static_cast<uint32_t> (m_time & 0xFFFFFFFF); }

xAOD::uint32_t

setEventNumber uint32_t

Definition EventInfo_v1.cxx:127

◆ isBoth()

bool IOVTime::isBoth ( ) const

inlinenoexcept

Definition at line 115 of file IOVTime.h.

115{ return (m_status == IOVTime::BOTH) ? 1 : 0; }

◆ isRunEvent()

bool IOVTime::isRunEvent ( ) const

inlinenoexcept

Definition at line 113 of file IOVTime.h.

113 { return (m_status == IOVTime::RUN_EVT ||

114 m_status == IOVTime::BOTH) ? 1 : 0; }

◆ isTimestamp()

bool IOVTime::isTimestamp ( ) const

inlinenoexcept

Definition at line 111 of file IOVTime.h.

111 { return (m_status == IOVTime::TIMESTAMP ||

112 m_status== IOVTime::BOTH) ? 1 : 0; }

◆ isValid()

bool IOVTime::isValid ( ) const

noexcept

Definition at line 117 of file IOVTime.cxx.

                                {
 
  // Cannot have BOTH undefined
  if (m_timestamp == IOVTime::UNDEFTIMESTAMP && 
      m_time == IOVTime::UNDEFRETIME) {
      return 0 ;
  }
  
  // Check run/event to be < max
  if (m_timestamp == IOVTime::UNDEFTIMESTAMP) {
      // event() can never be more than MAXEVENT, by construction.
      if ( run() > IOVTime::MAXRUN /*|| event() > IOVTime::MAXEVENT*/ ) {
      return 0;
      }
  }
      
  // Check time < max
  if (m_time == IOVTime::UNDEFRETIME) {
      if ( m_timestamp > IOVTime::MAXTIMESTAMP ) {
      return 0;
      }
  }
 
  if (m_timestamp != IOVTime::UNDEFTIMESTAMP &&
      m_time      != IOVTime::UNDEFRETIME) {
      // May have both timestamp and run/event set 
      // event() can never be more than MAXEVENT, by construction.
      if ( run() > IOVTime::MAXRUN /*|| event() > IOVTime::MAXEVENT*/ ) {
      return 0;
      }
      if ( m_timestamp > IOVTime::MAXTIMESTAMP ) {
      return 0;
      }
  }
  
  return 1;
 
}

◆ operator EventIDBase()

IOVTime::operator EventIDBase ( ) const

Definition at line 170 of file IOVTime.cxx.

                                    {
  if (isBoth()) {
    return EventIDBase(run(),EventIDBase::UNDEFEVT,
               std::min(timestamp()/1000000000LL,(unsigned long long)(std::numeric_limits<unsigned int>::max()-1)),timestamp()%1000000000LL,
                       event());
  } else if (isTimestamp()) {
    return EventIDBase(EventIDBase::UNDEFNUM,EventIDBase::UNDEFEVT,
               std::min(timestamp()/1000000000LL,(unsigned long long)(std::numeric_limits<unsigned int>::max()-1)),timestamp()%1000000000LL);
  } else if (isRunEvent()) {
    return EventIDBase(run(),EventIDBase::UNDEFEVT,
                       EventIDBase::UNDEFNUM,0,
                       event());
  } else {
    return EventIDBase();
  }
}

◆ operator std::string()

IOVTime::operator std::string ( ) const

Definition at line 156 of file IOVTime.cxx.

                                   {
  std::ostringstream os;
  os << "[";
  if (isRunEvent()) {
      os << (m_time>>32) << "," << ( m_time & 0xFFFFFFFF );
  }
  if (isTimestamp()) {
     if (isRunEvent()) os << ":";
     os << m_timestamp;
  }
  os << "]";
  return os.str();
}

◆ re_time()

uint64_t IOVTime::re_time ( ) const

inlinenoexcept

Definition at line 107 of file IOVTime.h.

107{ return m_time; }

◆ reset()

void IOVTime::reset ( )

noexcept

Definition at line 108 of file IOVTime.cxx.

                        {
  m_status = IOVTime::UNDEF;
  m_time = IOVTime::UNDEFRETIME;
  m_timestamp = IOVTime::UNDEFTIMESTAMP;
}

◆ run()

uint32_t IOVTime::run ( ) const

inlinenoexcept

Definition at line 105 of file IOVTime.h.

105{ return static_cast<uint32_t> (m_time>>32); }

◆ setRETime()

void IOVTime::setRETime ( uint64_t time )

noexcept

Definition at line 84 of file IOVTime.cxx.

                                           {
  if (isTimestamp()) { 
    m_status = IOVTime::BOTH;
  } else {
    m_status = IOVTime::RUN_EVT;
  }
  m_time = time;
}

◆ setRunEvent()

void IOVTime::setRunEvent	(	uint32_t	run,
		uint32_t	event )

noexcept

Definition at line 96 of file IOVTime.cxx.

                                                            {
  if (isTimestamp()) { 
    m_status = IOVTime::BOTH;
  } else {
    m_status = IOVTime::RUN_EVT;
  }
  m_time =  ( (uint64_t) run << 32) + event;
}

◆ setTimestamp()

void IOVTime::setTimestamp ( uint64_t timestamp )

noexcept

Definition at line 72 of file IOVTime.cxx.

                                                   {
  if (isRunEvent()) { 
    m_status = IOVTime::BOTH;
  } else {
    m_status = IOVTime::TIMESTAMP;
  }
  m_timestamp = timestamp;
}

◆ timestamp()

uint64_t IOVTime::timestamp ( ) const

inlinenoexcept

Definition at line 108 of file IOVTime.h.

108{ return m_timestamp; }

◆ operator!=

bool operator!=	(	const IOVTime &	lhs,
		const IOVTime &	rhs )

friend

Definition at line 158 of file IOVTime.h.

                                                                        {
  return !(lhs == rhs) ;
}

◆ operator<

bool operator<	(	const IOVTime &	lhs,
		const IOVTime &	rhs )

friend

Definition at line 137 of file IOVTime.h.

                                                                       {
  if (lhs.isTimestamp() && rhs.isTimestamp()) {
    return lhs.m_timestamp < rhs.m_timestamp;
  } else {
    return lhs.m_time < rhs.m_time;
  }
}

◆ operator<< [1/2]

MsgStream & operator<<	(	MsgStream &	os,
		const IOVTime &	rhs )

friend

Definition at line 187 of file IOVTime.cxx.

                                                           {
  os << (std::string) rhs;
  return os;
}

◆ operator<< [2/2]

std::ostream & operator<<	(	std::ostream &	os,
		const IOVTime &	rhs )

friend

Definition at line 192 of file IOVTime.cxx.

                                                             {
  os << (std::string) rhs;
  return os;
}

◆ operator<=

bool operator<=	(	const IOVTime &	lhs,
		const IOVTime &	rhs )

friend

Definition at line 164 of file IOVTime.h.

                                                                        {
  return !( lhs > rhs );
}

◆ operator==

bool operator==	(	const IOVTime &	lhs,
		const IOVTime &	rhs )

friend

Definition at line 151 of file IOVTime.h.

                                                                        {
  if (lhs.isTimestamp() && rhs.isTimestamp()) {
    return lhs.m_timestamp == rhs.m_timestamp;
  } else {
    return lhs.m_time == rhs.m_time;
  }
}

◆ operator>

bool operator>	(	const IOVTime &	lhs,
		const IOVTime &	rhs )

friend

Definition at line 144 of file IOVTime.h.

                                                                       {
  if (lhs.isTimestamp() && rhs.isTimestamp()) {
    return lhs.m_timestamp > rhs.m_timestamp;
  } else {
    return lhs.m_time > rhs.m_time;
  }
}

◆ operator>=

bool operator>=	(	const IOVTime &	lhs,
		const IOVTime &	rhs )

friend

Definition at line 161 of file IOVTime.h.

                                                                        {
  return !( lhs < rhs );
}

Member Data Documentation

◆ m_status

IOVTime_type IOVTime::m_status

private

Definition at line 132 of file IOVTime.h.

◆ m_time

uint64_t IOVTime::m_time

private

Definition at line 133 of file IOVTime.h.

◆ m_timestamp

uint64_t IOVTime::m_timestamp

private

Definition at line 134 of file IOVTime.h.

◆ MAXEVENT

uint32_t IOVTime::MAXEVENT = (std::numeric_limits<uint32_t>::max())

staticconstexpr

Definition at line 51 of file IOVTime.h.

◆ MAXRETIME

uint64_t IOVTime::MAXRETIME =( ((uint64_t) IOVTime::MAXRUN << 32) + IOVTime::MAXEVENT )

staticconstexpr

Definition at line 53 of file IOVTime.h.

◆ MAXRUN

uint32_t IOVTime::MAXRUN = (std::numeric_limits<uint32_t>::max() >> 1)

staticconstexpr

Definition at line 48 of file IOVTime.h.

◆ MAXTIMESTAMP

uint64_t IOVTime::MAXTIMESTAMP = (std::numeric_limits<uint64_t>::max() >> 1)

staticconstexpr

Definition at line 58 of file IOVTime.h.

◆ MINEVENT

uint32_t IOVTime::MINEVENT = std::numeric_limits<uint32_t>::min()

staticconstexpr

Definition at line 50 of file IOVTime.h.

◆ MINRUN

uint32_t IOVTime::MINRUN = std::numeric_limits<uint32_t>::min()

staticconstexpr

Definition at line 44 of file IOVTime.h.

◆ MINTIMESTAMP

uint64_t IOVTime::MINTIMESTAMP = std::numeric_limits<uint64_t>::min()

staticconstexpr

Definition at line 56 of file IOVTime.h.

◆ UNDEFRETIME

uint64_t IOVTime::UNDEFRETIME = std::numeric_limits<uint64_t>::max()

staticconstexpr

Definition at line 54 of file IOVTime.h.

◆ UNDEFTIMESTAMP

uint64_t IOVTime::UNDEFTIMESTAMP = std::numeric_limits<uint64_t>::max()

staticconstexpr

Definition at line 59 of file IOVTime.h.

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

Classes

Public Member Functions

Static Public Attributes

Private Types

Private Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ IOVTime_type

Constructor & Destructor Documentation

◆ IOVTime() [1/5]

◆ IOVTime() [2/5]

◆ IOVTime() [3/5]

◆ IOVTime() [4/5]

◆ IOVTime() [5/5]

Member Function Documentation

◆ event()

◆ isBoth()

◆ isRunEvent()

◆ isTimestamp()

◆ isValid()

◆ operator EventIDBase()

◆ operator std::string()

◆ re_time()

◆ reset()

◆ run()

◆ setRETime()

◆ setRunEvent()

◆ setTimestamp()

◆ timestamp()

Friends And Related Symbol Documentation

◆ operator!=

◆ operator<

◆ operator<< [1/2]

◆ operator<< [2/2]

◆ operator<=

◆ operator==

◆ operator>

◆ operator>=

Member Data Documentation

◆ m_status

◆ m_time

◆ m_timestamp

◆ MAXEVENT

◆ MAXRETIME

◆ MAXRUN

◆ MAXTIMESTAMP

◆ MINEVENT

◆ MINRUN

◆ MINTIMESTAMP

◆ UNDEFRETIME

◆ UNDEFTIMESTAMP