art::ScheduleID Class Reference

#include "ScheduleID.h"

Public Types
using	size_type = id_type

Public Member Functions
constexpr	ScheduleID ()=default
	ScheduleID (id_type id)
constexpr bool	isValid () const
constexpr id_type	id () const
ScheduleID	next () const
bool	operator== (ScheduleID const &other) const
bool	operator< (ScheduleID const &other) const

Static Public Member Functions
static ScheduleID	first ()
static ScheduleID	last ()

Private Types
using	id_type = uint16_t

Static Private Member Functions
static constexpr id_type	min_id_ ()
static constexpr id_type	max_id_ ()
static constexpr id_type	invalid_id_ ()

Private Attributes
id_type	id_ {invalid_id_()}

Detailed Description

Definition at line 20 of file ScheduleID.h.

Member Typedef Documentation

using art::ScheduleID::id_type = uint16_t

private

Definition at line 22 of file ScheduleID.h.

using art::ScheduleID::size_type = id_type

Definition at line 27 of file ScheduleID.h.

Constructor & Destructor Documentation

constexpr art::ScheduleID::ScheduleID ( )

default

Referenced by next().

art::ScheduleID::ScheduleID ( id_type  id )

inlineexplicit

Definition at line 57 of file ScheduleID.h.

References max_id_().

  : id_{(id < min_id_() || id > max_id_()) ?
          throw std::out_of_range("art::ScheduleID: Invalid initializer.") :
          id}
{}

Member Function Documentation

art::ScheduleID art::ScheduleID::first ( )

inlinestatic

Definition at line 82 of file ScheduleID.h.

References min_id_().

Referenced by art::EventProcessor::initSchedules_(), art::EventProcessor::invokePostBeginJobWorkers_(), art::TimeTracker::postEventProcessing(), art::TimeTracker::postEventReading(), art::TimeTracker::preEventProcessing(), art::TimeTracker::preEventReading(), art::MemoryTracker::prePathProcessing(), art::TimeTracker::prePathProcessing(), art::RandomNumberSaver::produce(), art::MemoryTracker::recordEventData(), art::MemoryTracker::recordModuleData(), art::MemoryTracker::recordOtherData(), art::TimeTracker::recordTime(), art::detail::ServiceWrapper< T, art::ServiceScope::PER_SCHEDULE >::ServiceWrapper(), and art::TimeTracker::startTime().

{
  return ScheduleID{min_id_()};
}

constexpr art::ScheduleID::id_type art::ScheduleID::id ( ) const

inline

Definition at line 70 of file ScheduleID.h.

References id_.

Referenced by art::RandomNumberGenerator::accessSnapshot_(), art::LocalSignal< STYPE, ResultType(Args...)>::clear(), art::LocalSignal< STYPE, ResultType(Args...)>::invoke(), art::TimeTracker::postEventProcessing(), art::TimeTracker::postEventReading(), art::TimeTracker::preEventProcessing(), art::TimeTracker::preEventReading(), art::MemoryTracker::prePathProcessing(), art::TimeTracker::prePathProcessing(), art::MemoryTracker::recordEventData(), art::MemoryTracker::recordModuleData(), art::MemoryTracker::recordOtherData(), art::TimeTracker::recordTime(), art::TimeTracker::startTime(), and art::LocalSignal< STYPE, ResultType(Args...)>::watch().

{
  return id_;
}

constexpr art::ScheduleID::id_type art::ScheduleID::invalid_id_ ( )

inlinestaticprivate

Definition at line 118 of file ScheduleID.h.

References max.

Referenced by isValid(), and max_id_().

{
  return std::numeric_limits<id_type>::max();
}

constexpr bool art::ScheduleID::isValid ( ) const

inline

Definition at line 64 of file ScheduleID.h.

References id_, and invalid_id_().

{
  return !(id_ == invalid_id_());
}

art::ScheduleID art::ScheduleID::last ( )

inlinestatic

Definition at line 88 of file ScheduleID.h.

References max_id_().

{
  return ScheduleID{max_id_()};
}

constexpr art::ScheduleID::id_type art::ScheduleID::max_id_ ( )

inlinestaticprivate

Definition at line 112 of file ScheduleID.h.

References invalid_id_().

Referenced by last(), and ScheduleID().

{
  return invalid_id_() - 1;
}

constexpr art::ScheduleID::id_type art::ScheduleID::min_id_ ( )

inlinestaticprivate

Definition at line 106 of file ScheduleID.h.

References min.

Referenced by first().

{
  return std::numeric_limits<id_type>::min();
}

art::ScheduleID art::ScheduleID::next ( ) const

inline

Definition at line 76 of file ScheduleID.h.

References id_, and ScheduleID().

{
  return ScheduleID(id_ + 1);
}

bool art::ScheduleID::operator< ( ScheduleID const &  other ) const

inline

Definition at line 100 of file ScheduleID.h.

References id_.

{
  return id_ < other.id_;
}

bool art::ScheduleID::operator== ( ScheduleID const &  other ) const

inline

Definition at line 94 of file ScheduleID.h.

References id_.

{
  return id_ == other.id_;
}

Member Data Documentation

id_type art::ScheduleID::id_ {invalid_id_()}

private

Definition at line 54 of file ScheduleID.h.

Referenced by id(), isValid(), next(), operator<(), and operator==().

---

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

• art/Utilities/ScheduleID.h