art::EventAuxiliary Class Reference

#include "EventAuxiliary.h"

Public Types
enum	ExperimentType {   Any = 0, Align = 1, Calib = 2, Cosmic = 3,   Data = 4, Mc = 5, Raw = 6, Test = 7 }

Public Member Functions
	EventAuxiliary ()
	EventAuxiliary (EventID const &theId, Timestamp const &theTime, bool isReal, ExperimentType eType=Any, ProcessHistoryID const &phid={})
Timestamp const &	time () const noexcept
EventID const &	id () const noexcept
EventID const &	eventID () const noexcept
RunID const &	runID () const noexcept
SubRunID const &	subRunID () const noexcept
RunNumber_t	run () const noexcept
SubRunNumber_t	subRun () const noexcept
EventNumber_t	event () const noexcept
bool	isRealData () const noexcept
EventAuxiliary::ExperimentType	experimentType () const noexcept
bool	operator== (EventAuxiliary const &other) const noexcept
void	write (std::ostream &os) const
ProcessHistoryID const &	processHistoryID () const noexcept
void	setProcessHistoryID (ProcessHistoryID const &)

Static Public Attributes
static constexpr BranchType	branch_type = InEvent

Private Attributes
ProcessHistoryID	processHistoryID_ {}
EventID	id_ {}
Timestamp	time_ {}
bool	isRealData_ {false}
ExperimentType	experimentType_ {Any}

Detailed Description

Definition at line 13 of file EventAuxiliary.h.

Member Enumeration Documentation

enum art::EventAuxiliary::ExperimentType

Enumerator
Any
Align
Calib
Cosmic
Data
Mc
Raw
Test

Definition at line 16 of file EventAuxiliary.h.

                        {
      Any = 0,
      Align = 1,
      Calib = 2,
      Cosmic = 3,
      Data = 4,
      Mc = 5,
      Raw = 6,
      Test = 7
    };

Constructor & Destructor Documentation

art::EventAuxiliary::EventAuxiliary ( )

default

art::EventAuxiliary::EventAuxiliary	(	EventID const &	theId,
		Timestamp const &	theTime,
		bool	isReal,
		ExperimentType	eType = Any,
		ProcessHistoryID const &	phid = {}
	)

Definition at line 10 of file EventAuxiliary.cc.

References experimentType_, id_, isRealData_, and time_.

    : processHistoryID_{phid}
    , id_{theId}
    , time_{theTime}
    , isRealData_{isReal}
    , experimentType_{eType}
  {}

Member Function Documentation

EventNumber_t art::EventAuxiliary::event ( ) const

noexcept

Definition at line 65 of file EventAuxiliary.cc.

References art::EventID::event(), and id_.

  {
    return id_.event();
  }

EventID const & art::EventAuxiliary::eventID ( ) const

noexcept

Definition at line 35 of file EventAuxiliary.cc.

References id().

  {
    return id();
  }

EventAuxiliary::ExperimentType art::EventAuxiliary::experimentType ( ) const

noexcept

Definition at line 77 of file EventAuxiliary.cc.

References experimentType_.

Referenced by art::EventPrincipal::ExperimentType().

  {
    return experimentType_;
  }

EventID const & art::EventAuxiliary::id ( ) const

noexcept

Definition at line 29 of file EventAuxiliary.cc.

References id_.

Referenced by art::EventPrincipal::event(), art::EventPrincipal::eventID(), eventID(), rndm::NuRandomServiceHelper::ArtState::eventID(), art::EventPrincipal::run(), and art::EventPrincipal::subRun().

  {
    return id_;
  }

bool art::EventAuxiliary::isRealData ( ) const

noexcept

Definition at line 71 of file EventAuxiliary.cc.

References isRealData_.

Referenced by rndm::NuRandomServiceHelper::ArtState::getEventSeedInputData(), and art::EventPrincipal::isReal().

  {
    return isRealData_;
  }

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

noexcept

Definition at line 83 of file EventAuxiliary.cc.

References experimentType_, id_, isRealData_, fhicl::other, and time_.

  {
    return (id_ == other.id_) && (time_ == other.time_) &&
           (isRealData_ == other.isRealData_) &&
           (experimentType_ == other.experimentType_);
  }

ProcessHistoryID const & art::EventAuxiliary::processHistoryID ( ) const

noexcept

Definition at line 97 of file EventAuxiliary.cc.

References processHistoryID_.

Referenced by art::EventPrincipal::EventPrincipal().

  {
    return processHistoryID_;
  }

RunNumber_t art::EventAuxiliary::run ( ) const

noexcept

Definition at line 53 of file EventAuxiliary.cc.

References id_, and art::EventID::run().

  {
    return id_.run();
  }

RunID const & art::EventAuxiliary::runID ( ) const

noexcept

Definition at line 41 of file EventAuxiliary.cc.

References id_, and art::EventID::runID().

  {
    return id_.runID();
  }

void art::EventAuxiliary::setProcessHistoryID

(

ProcessHistoryID const &

phid

)

Definition at line 103 of file EventAuxiliary.cc.

References processHistoryID_.

Referenced by art::EventPrincipal::refreshProcessHistoryID().

  {
    processHistoryID_ = phid;
  }

SubRunNumber_t art::EventAuxiliary::subRun ( ) const

noexcept

Definition at line 59 of file EventAuxiliary.cc.

References id_, and art::EventID::subRun().

  {
    return id_.subRun();
  }

SubRunID const & art::EventAuxiliary::subRunID ( ) const

noexcept

Definition at line 47 of file EventAuxiliary.cc.

References id_, and art::EventID::subRunID().

  {
    return id_.subRunID();
  }

Timestamp const & art::EventAuxiliary::time ( ) const

noexcept

Definition at line 23 of file EventAuxiliary.cc.

References time_.

Referenced by rndm::NuRandomServiceHelper::ArtState::getEventSeedInputData(), and art::EventPrincipal::time().

  {
    return time_;
  }

void art::EventAuxiliary::write

(

std::ostream &

os

)

const

Definition at line 91 of file EventAuxiliary.cc.

References id_.

Referenced by art::operator<<().

  {
    os << id_ << '\n';
  }

Member Data Documentation

constexpr BranchType art::EventAuxiliary::branch_type = InEvent

static

Definition at line 15 of file EventAuxiliary.h.

ExperimentType art::EventAuxiliary::experimentType_ {Any}

private

Definition at line 58 of file EventAuxiliary.h.

Referenced by EventAuxiliary(), experimentType(), and operator==().

EventID art::EventAuxiliary::id_ {}

private

Definition at line 55 of file EventAuxiliary.h.

Referenced by event(), EventAuxiliary(), id(), operator==(), run(), runID(), subRun(), subRunID(), and write().

bool art::EventAuxiliary::isRealData_ {false}

private

Definition at line 57 of file EventAuxiliary.h.

Referenced by EventAuxiliary(), isRealData(), and operator==().

ProcessHistoryID art::EventAuxiliary::processHistoryID_ {}

private

Definition at line 53 of file EventAuxiliary.h.

Referenced by processHistoryID(), and setProcessHistoryID().

Timestamp art::EventAuxiliary::time_ {}

private

Definition at line 56 of file EventAuxiliary.h.

Referenced by EventAuxiliary(), operator==(), and time().

---

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

• canvas/Persistency/Provenance/EventAuxiliary.h
• canvas/Persistency/Provenance/EventAuxiliary.cc