art::ScheduleID Class Reference

#include "ScheduleID.h"

Public Types
using	id_type = uint16_t
using	size_type = id_type

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

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

Private Types
enum	PremadeTypeFlag { PremadeTypeFlag::First, PremadeTypeFlag::Last }

Private Member Functions
constexpr	ScheduleID (PremadeTypeFlag flag)

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

Private Attributes
id_type	id_ {invalid_id_()}

Friends
template<typename T >
class	PerScheduleContainer

Detailed Description

Definition at line 17 of file ScheduleID.h.

Member Typedef Documentation

using art::ScheduleID::id_type = uint16_t

Definition at line 22 of file ScheduleID.h.

using art::ScheduleID::size_type = id_type

Definition at line 25 of file ScheduleID.h.

Member Enumeration Documentation

enum art::ScheduleID::PremadeTypeFlag

strongprivate

Enumerator
First
Last

Definition at line 28 of file ScheduleID.h.

{ First, Last };

Constructor & Destructor Documentation

constexpr art::ScheduleID::ScheduleID ( )

defaultnoexcept

Referenced by last().

art::ScheduleID::ScheduleID ( id_type  id )

explicit

Definition at line 11 of file ScheduleID.cc.

  {
    // No need to test against min_id_() since that is the smallest
    // possible value already.
    if (id > max_id_()) {
      // Somebody passed us invalid_id_().
      throw out_of_range("ScheduleID: Invalid initializer.");
    }
    id_ = id;
  }

art::ScheduleID::ScheduleID ( ScheduleID const &  )

defaultnoexcept

art::ScheduleID::ScheduleID ( ScheduleID &&  )

defaultnoexcept

constexpr art::ScheduleID::ScheduleID ( PremadeTypeFlag  flag )

inlineprivate

Definition at line 88 of file ScheduleID.h.

References First, max_id_(), and min_id_().

      : id_{(flag == PremadeTypeFlag::First) ? min_id_() : max_id_()}
    {}

Member Function Documentation

static constexpr ScheduleID art::ScheduleID::first ( )

inlinestatic

Definition at line 50 of file ScheduleID.h.

References First.

Referenced by art::EventProcessor::invokePostBeginJobWorkers_(), art::Worker::isUnique(), art::detail::LegacyModule::LegacyModule(), art::EventProcessor::main_schedule(), art::PathManager::makeModules_(), art::MixHelper::MixHelper(), art::OutputWorker::OutputWorker(), art::EventProcessor::setSubRunAuxiliaryRangeSetID(), and art::WorkerT< T >::WorkerT().

    {
      return ScheduleID{PremadeTypeFlag::First};
    }

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

inlinenoexcept

Definition at line 77 of file ScheduleID.h.

References id_, next(), operator<(), operator==(), and fhicl::other.

Referenced by art::PerScheduleContainer< std::unique_ptr< art::EventPrincipal > >::at(), art::RandomNumberGenerator::createEngine(), art::LocalSignal< STYPE, ResultType(Args...)>::invoke(), std::hash< art::ScheduleID >::operator()(), art::operator<<(), art::PerScheduleContainer< std::unique_ptr< art::EventPrincipal > >::operator[](), and art::LocalSignal< STYPE, ResultType(Args...)>::watch().

    {
      return id_;
    }

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

inlinestaticprivatenoexcept

Definition at line 32 of file ScheduleID.h.

Referenced by isValid(), and max_id_().

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

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

inlinenoexcept

Definition at line 71 of file ScheduleID.h.

References id_, and invalid_id_().

Referenced by art::detail::EngineCreator::requireValid().

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

static constexpr ScheduleID art::ScheduleID::last ( )

inlinestatic

Definition at line 55 of file ScheduleID.h.

References Last, operator=(), and ScheduleID().

    {
      return ScheduleID{PremadeTypeFlag::Last};
    }

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

inlinestaticprivatenoexcept

Definition at line 42 of file ScheduleID.h.

References invalid_id_().

Referenced by ScheduleID().

    {
      return invalid_id_() - 1;
    }

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

inlinestaticprivatenoexcept

Definition at line 37 of file ScheduleID.h.

Referenced by ScheduleID().

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

ScheduleID art::ScheduleID::next

(

)

const

Definition at line 23 of file ScheduleID.cc.

Referenced by art::ScheduleIteration::for_each_schedule(), and id().

  {
    return ScheduleID(id_ + 1);
  }

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

noexcept

Definition at line 35 of file ScheduleID.cc.

Referenced by id().

  {
    return id_ < rhs.id_;
  }

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

defaultnoexcept

Referenced by last().

ScheduleID& art::ScheduleID::operator= ( ScheduleID &&  )

defaultnoexcept

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

noexcept

Definition at line 29 of file ScheduleID.cc.

Referenced by id().

  {
    return id_ == rhs.id_;
  }

Friends And Related Function Documentation

template<typename T >

friend class PerScheduleContainer

friend

Definition at line 19 of file ScheduleID.h.

Member Data Documentation

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

private

Definition at line 93 of file ScheduleID.h.

Referenced by id(), and isValid().

---

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

• art/Utilities/ScheduleID.h
• art/Utilities/ScheduleID.cc