rndm::NuRandomServiceHelper::ArtState Class Reference

Describe the current state of art processing, as understood by the NuRandomService. More...

#include "ArtState.h"

Public Types
enum	state_type {   unDefined, inServiceConstructor, inModuleConstructor, inBeginRun,   inModuleBeginRun, inEvent, inModuleEvent, inEndJob,   inOther }
using	EventInfo_t = art::EventAuxiliary

Public Member Functions
	ArtState (state_type start_state=unDefined)
EventSeedInputData	getEventSeedInputData () const
void	set_state (state_type astate)
	Records the status of ART. More...
state_type	transit_to (state_type astate)
	Records the new status of ART and returns the old one. More...
void	reset_state ()
	Resets the status to "something else" (inOther) More...
void	set_event (art::Event const &evt)
	Records the specified event ID. More...
void	reset_event ()
	Records the status of ART. More...
void	set_module (art::ModuleDescription const &desc)
	Records the specified module description. More...
void	reset_module ()
	Records the status of ART. More...
void	set_process_name (std::string pn)
	Records the status of ART. More...
void	set_process_name (art::ModuleDescription const &currentModuleDesc)
	Records the status of ART. More...
state_type	state () const
	Getters. More...
std::string	stateName () const
	Getters. More...
art::EventID const &	eventID () const
	Getters. More...
EventInfo_t const &	eventInfo () const
	Getters. More...
art::ModuleDescription const &	moduleDesc () const
	Getters. More...
std::string	moduleLabel () const
	Getters. More...
std::string	processName () const
	Getters. More...

Static Public Member Functions
static std::string	stateName (state_type state)

Protected Attributes
state_type	artState
	current state of the art More...
EventInfo_t	lastEvent
art::ModuleDescription	lastModule
std::string	procName

Detailed Description

Describe the current state of art processing, as understood by the NuRandomService.

Definition at line 32 of file ArtState.h.

Member Typedef Documentation

using rndm::NuRandomServiceHelper::ArtState::EventInfo_t = art::EventAuxiliary

Definition at line 46 of file ArtState.h.

Member Enumeration Documentation

enum rndm::NuRandomServiceHelper::ArtState::state_type

Enumerator
unDefined	not assigned yet
inServiceConstructor	in service construction phase
inModuleConstructor	in module construction phase
inBeginRun	in begin of run phase
inModuleBeginRun	in begin of run for a module
inEvent	in event phase
inModuleEvent	in event processing by a module
inEndJob	in end job
inOther	none of the above

Definition at line 34 of file ArtState.h.

                   {
        unDefined,             
        inServiceConstructor,  
        inModuleConstructor,   
        inBeginRun,            
        inModuleBeginRun,      
        inEvent,               
        inModuleEvent,         
        inEndJob,              
        inOther                
      } state_type; 

Constructor & Destructor Documentation

rndm::NuRandomServiceHelper::ArtState::ArtState ( state_type  start_state = unDefined )

inline

Definition at line 49 of file ArtState.h.

References artState, and set_state().

        : artState(start_state)
        , lastEvent()
        , lastModule()
        , procName()
        {}

Member Function Documentation

art::EventID const& rndm::NuRandomServiceHelper::ArtState::eventID ( ) const

inline

Getters.

Definition at line 116 of file ArtState.h.

References art::EventAuxiliary::id(), and lastEvent.

Referenced by getEventSeedInputData().

{ return lastEvent.id(); }

EventInfo_t const& rndm::NuRandomServiceHelper::ArtState::eventInfo ( ) const

inline

Getters.

Definition at line 118 of file ArtState.h.

References lastEvent.

Referenced by getEventSeedInputData().

{ return lastEvent; }

EventSeedInputData rndm::NuRandomServiceHelper::ArtState::getEventSeedInputData ( ) const

inline

Definition at line 128 of file ArtState.h.

References art::EventID::event(), eventID(), eventInfo(), rndm::NuRandomServiceHelper::EventSeedInputData::eventNumber, art::Timestamp::invalidTimestamp(), rndm::NuRandomServiceHelper::EventSeedInputData::isData, art::EventAuxiliary::isRealData(), rndm::NuRandomServiceHelper::EventSeedInputData::isTimeValid, moduleDesc(), rndm::NuRandomServiceHelper::EventSeedInputData::moduleLabel, moduleLabel(), art::ModuleDescription::moduleName(), rndm::NuRandomServiceHelper::EventSeedInputData::moduleType, rndm::NuRandomServiceHelper::EventSeedInputData::processName, processName(), art::EventID::run(), rndm::NuRandomServiceHelper::EventSeedInputData::runNumber, art::EventID::subRun(), rndm::NuRandomServiceHelper::EventSeedInputData::subRunNumber, rndm::NuRandomServiceHelper::EventSeedInputData::time, art::EventAuxiliary::time(), and art::Timestamp::value().

Referenced by rndm::NuRandomService::reseedInstance().

        {
          EventSeedInputData data;
          data.runNumber = eventID().run();
          data.subRunNumber = eventID().subRun();
          data.eventNumber = eventID().event();
          
          data.time = eventInfo().time().value();
          data.isTimeValid
            = (eventInfo().time() != art::Timestamp::invalidTimestamp());
          
          data.isData = eventInfo().isRealData();
          
          data.processName = processName();
          data.moduleType = moduleDesc().moduleName();
          data.moduleLabel = moduleLabel();
          
          return data;
        } // getEventSeedInputData()

art::ModuleDescription const& rndm::NuRandomServiceHelper::ArtState::moduleDesc ( ) const

inline

Getters.

Definition at line 120 of file ArtState.h.

References lastModule.

Referenced by getEventSeedInputData().

{ return lastModule; }

std::string rndm::NuRandomServiceHelper::ArtState::moduleLabel ( ) const

inline

Getters.

Definition at line 122 of file ArtState.h.

References lastModule, and art::ModuleDescription::moduleLabel().

Referenced by getEventSeedInputData(), rndm::NuRandomService::qualify_engine_label(), and rndm::NuRandomService::reseedModule().

{ return lastModule.moduleLabel(); }

std::string rndm::NuRandomServiceHelper::ArtState::processName ( ) const

inline

Getters.

Definition at line 124 of file ArtState.h.

References procName.

Referenced by getEventSeedInputData().

{ return procName; }

void rndm::NuRandomServiceHelper::ArtState::reset_event ( )

inline

Records the status of ART.

Definition at line 83 of file ArtState.h.

References lastEvent.

Referenced by rndm::NuRandomService::postProcessEvent().

{ lastEvent = EventInfo_t(); }

void rndm::NuRandomServiceHelper::ArtState::reset_module ( )

inline

Records the status of ART.

Definition at line 91 of file ArtState.h.

References lastModule.

Referenced by rndm::NuRandomService::postModule().

{ lastModule = art::ModuleDescription(); }

void rndm::NuRandomServiceHelper::ArtState::reset_state ( )

inline

Resets the status to "something else" (inOther)

Definition at line 74 of file ArtState.h.

References inOther, and transit_to().

Referenced by rndm::NuRandomService::postModule(), rndm::NuRandomService::postModuleBeginRun(), rndm::NuRandomService::postModuleConstruction(), rndm::NuRandomService::postModuleEndJob(), and rndm::NuRandomService::postProcessEvent().

{ transit_to(inOther); }

void rndm::NuRandomServiceHelper::ArtState::set_event ( art::Event const &  evt )

inline

Records the specified event ID.

Definition at line 77 of file ArtState.h.

References art::Event::experimentType(), art::Event::id(), art::Event::isRealData(), lastEvent, and art::Event::time().

Referenced by rndm::NuRandomService::preProcessEvent().

        {
          lastEvent = {
            evt.id(), evt.time(), evt.isRealData(), evt.experimentType()
            };
        } // set_event()

void rndm::NuRandomServiceHelper::ArtState::set_module ( art::ModuleDescription const &  desc )

inline

Records the specified module description.

Definition at line 86 of file ArtState.h.

References lastModule, and set_process_name().

Referenced by rndm::NuRandomService::preModule(), rndm::NuRandomService::preModuleBeginRun(), rndm::NuRandomService::preModuleConstruction(), and rndm::NuRandomService::preModuleEndJob().

        {
          lastModule = desc;
          set_process_name(desc);
        }

void rndm::NuRandomServiceHelper::ArtState::set_process_name ( std::string  pn )

inline

Records the status of ART.

Definition at line 93 of file ArtState.h.

References procName.

Referenced by set_module().

{ procName = pn; }

void rndm::NuRandomServiceHelper::ArtState::set_process_name ( art::ModuleDescription const &  currentModuleDesc )

inline

Records the status of ART.

Definition at line 94 of file ArtState.h.

References art::errors::LogicError, art::ModuleDescription::processName(), and procName.

        {
          if (!procName.empty()
            && (procName != currentModuleDesc.processName()))
          {
            throw art::Exception(art::errors::LogicError)
              << "Process name changed from '" << procName << "' to '"
              << currentModuleDesc.processName() << "'?!?";
          }
          procName = currentModuleDesc.processName();
        } // set_process_name()

void rndm::NuRandomServiceHelper::ArtState::set_state ( state_type  astate )

inline

Records the status of ART.

Definition at line 60 of file ArtState.h.

Referenced by ArtState(), and transit_to().

{ artState = astate; }

state_type rndm::NuRandomServiceHelper::ArtState::state ( ) const

inline

Getters.

Definition at line 112 of file ArtState.h.

References artState.

Referenced by rndm::NuRandomService::ensureValidState(), stateName(), and transit_to().

{ return artState; }

std::string rndm::NuRandomServiceHelper::ArtState::stateName ( ) const

inline

Getters.

Definition at line 114 of file ArtState.h.

References state(), and stateName().

Referenced by stateName(), and transit_to().

{ return stateName(state()); }

static std::string rndm::NuRandomServiceHelper::ArtState::stateName ( state_type  state )

inlinestatic

Definition at line 149 of file ArtState.h.

References inBeginRun, inEndJob, inEvent, inModuleBeginRun, inModuleConstructor, inModuleEvent, inOther, inServiceConstructor, art::errors::LogicError, and unDefined.

        {
          switch (state) {
            case unDefined:            return "(not assigned yet)";
            case inServiceConstructor: return "service construction";
            case inModuleConstructor:  return "module construction";
            case inBeginRun:           return "begin of run";
            case inModuleBeginRun:     return "begin of run for module";
            case inEvent:              return "event preparation";
            case inModuleEvent:        return "event processing by a module";
            case inEndJob:             return "end job";
            case inOther:              return "unidentified";
          } // switch
          throw art::Exception(art::errors::LogicError)
            << "artext::NuRandomServiceHelper::ArtState::stateName: unknown state #"
            << ((int) state) << "\n";
        } // stateName()

state_type rndm::NuRandomServiceHelper::ArtState::transit_to ( state_type  astate )

inline

Records the new status of ART and returns the old one.

Definition at line 63 of file ArtState.h.

References LOG_DEBUG, set_state(), state(), and stateName().

Referenced by rndm::NuRandomService::preModule(), rndm::NuRandomService::preModuleBeginRun(), rndm::NuRandomService::preModuleConstruction(), rndm::NuRandomService::preModuleEndJob(), rndm::NuRandomService::preProcessEvent(), and reset_state().

        {
          state_type old_state = state();
          set_state(astate);
          LOG_DEBUG("ArtState")
            << "NuRandomService::ArtState: transition from "
            << stateName(old_state) << " to " << stateName();
          return old_state;
        } // transit_to()

Member Data Documentation

state_type rndm::NuRandomServiceHelper::ArtState::artState

protected

current state of the art

Definition at line 168 of file ArtState.h.

Referenced by ArtState(), and state().

EventInfo_t rndm::NuRandomServiceHelper::ArtState::lastEvent

protected

Definition at line 170 of file ArtState.h.

Referenced by eventID(), eventInfo(), reset_event(), and set_event().

art::ModuleDescription rndm::NuRandomServiceHelper::ArtState::lastModule

protected

Definition at line 171 of file ArtState.h.

Referenced by moduleDesc(), moduleLabel(), reset_module(), and set_module().

std::string rndm::NuRandomServiceHelper::ArtState::procName

protected

Definition at line 172 of file ArtState.h.

Referenced by processName(), and set_process_name().

---

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

• nutools/RandomUtils/ArtState.h