#include <VP1EventProd.h>

Inheritance diagram for VP1EventProd:

Collaboration diagram for VP1EventProd:

Public Member Functions
	VP1EventProd (const std::string &name, ISvcLocator *pSvcLocator)
	~VP1EventProd ()
StatusCode	initialize ()
StatusCode	execute ()
StatusCode	finalize ()
void	handle (const Incident &inc)
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
Gaudi::Property< bool >	m_isOnline {this, "IsOnline", false, "If running at point 1"}
ServiceHandle< IOnlineEventDisplaysSvc >	m_onlineEDsvc {this, "OnlineEventDisplaysSvc", "Online Event Displays Service"}
unsigned long	m_runNumber
unsigned long long	m_eventNumber
unsigned long	m_timeStamp
std::string	m_humanTimestamp
std::string	m_outputFileType
bool	m_removeTempInputFiles
std::string	m_inputPoolFile
std::string	m_destinationDir
bool	m_createDestinationDir
int	m_maxProducedFiles
int	m_nEvent
DataObjIDColl	m_extendedExtraObjects
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Definition at line 32 of file VP1EventProd.h.

Member Typedef Documentation

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< Algorithm > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ VP1EventProd()

VP1EventProd::VP1EventProd	(	const std::string &	name,
		ISvcLocator *	pSvcLocator )

Definition at line 26 of file VP1EventProd.cxx.

                                                                        :
  AthAlgorithm(name, svcLocator),
  m_runNumber(0),
  m_eventNumber(0),
  m_timeStamp(0),
  m_humanTimestamp(""),
  m_nEvent(0)
{
  declareProperty("InputPoolFile", m_inputPoolFile="");
  declareProperty("DestinationDirectory", m_destinationDir="."); // produce files in the run directory by default
  declareProperty("ForceCreateDestinationDirectory", m_createDestinationDir=true); // force creation of new output folder
  declareProperty("MaxNumberOfFiles", m_maxProducedFiles=-1);     // keep N event files in the run directory. Default is '-1' that means ALL.
  declareProperty("OutputFileTypeLabel", m_outputFileType="");        // put a label at the end of the output file, stating its file type
  declareProperty("RemoveTempInputFiles", m_removeTempInputFiles=true);        // remove the temp input file, i.e. the single-event files produced by the Athena job (HITS, ESD, ...) and which are then copied to files called "vp1_...pool.root"
 
  // Note: you cannot initialize a VP1FileUtils instance here, because otherwise it would take the default properties only.
 
}

◆ ~VP1EventProd()

VP1EventProd::~VP1EventProd ( )

Definition at line 45 of file VP1EventProd.cxx.

46{

47}

Member Function Documentation

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T, V, H > &	hndl,
		const SG::VarHandleKeyType &	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

◆ declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

◆ detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Algorithm > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

95{ return m_detStore; }

AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Algorithm > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

85{ return m_evtStore; }

AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ execute()

StatusCode VP1EventProd::execute ( )

Definition at line 73 of file VP1EventProd.cxx.

{
  ATH_MSG_DEBUG(" in execute(). Nothing to do here...");
 
  return StatusCode::SUCCESS;
}

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

◆ extraOutputDeps()

const DataObjIDColl & AthAlgorithm::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 50 of file AthAlgorithm.cxx.

{
  // If we didn't find any symlinks to add, just return the collection
  // from the base class.  Otherwise, return the extended collection.
  if (!m_extendedExtraObjects.empty()) {
    return m_extendedExtraObjects;
  }
  return Algorithm::extraOutputDeps();
}

◆ finalize()

StatusCode VP1EventProd::finalize ( )

Definition at line 80 of file VP1EventProd.cxx.

{
  ATH_MSG_DEBUG("in finalize() ");
 
  // handle the output of the last event
  if(m_nEvent) {
 
    --m_nEvent; // since we don't use another call to handle() to process the last event, we need to revert the counter by one, otherwise the wrong file is looked for
 
    ATH_MSG_DEBUG("--> Input POOL file: " << m_inputPoolFile);
 
    std::ostringstream ostri;
    ostri << m_inputPoolFile << "._" << std::setw(4) << std::setfill('0') << m_nEvent;
 
    std::string inputFileName = ostri.str();
    ATH_MSG_DEBUG("copying the input file: '"<< inputFileName << "'...");
    ATH_MSG_DEBUG("VP1 alg event number: " << m_eventNumber);
    try {
 
        /* clean the output directory if m_maxProducedFiles == 0
         * or keep up to 'm_maxProducedFiles' output files
         */
        VP1FileUtilities fileUtil(".", m_maxProducedFiles, m_destinationDir, m_createDestinationDir, m_removeTempInputFiles); // inputDir, fileLimit, outputDir, forceMakeOutputDir, removeInputFile
 
        if (m_outputFileType != "")
            fileUtil.produceNewFile(inputFileName, m_runNumber, m_eventNumber, m_timeStamp, m_humanTimestamp+"."+m_outputFileType); // with UNIX and human-readable timestamp
        else
            fileUtil.produceNewFile(inputFileName, m_runNumber, m_eventNumber, m_timeStamp, m_humanTimestamp); // with UNIX timestamp
    }
    catch(std::runtime_error& err) {
      ATH_MSG_WARNING("Exception caught: " << err.what());
      ATH_MSG_WARNING("In finalize() -- Unable to produce new VP1 event file");
    }
  }
 
  return StatusCode::SUCCESS;
}

◆ handle()

void VP1EventProd::handle ( const Incident & inc )

Definition at line 120 of file VP1EventProd.cxx.

{
  ATH_MSG_DEBUG("in handle()... ");
  ATH_MSG_DEBUG("Handling incident '" << inc.type() << "'");
 
  // Let VP1FileUtilities handle the output of the previous event.
  // Skip this if m_nEvent == 0,
  // because the processing of the event is not completed, yet;
  // and the input file is not created at this stage, yet.
  // Basically we run the code below while in event_2, to get the processed file for event_1
  if(m_nEvent) {
 
   unsigned  int nLastFile = m_nEvent - 1; // we copy the file produced while processing the previous event, so we need a file number of (current - 1)
 
    ATH_MSG_DEBUG("--> Input POOL file: " << m_inputPoolFile);
    std::ostringstream ostri;
    ostri << m_inputPoolFile << "._" << std::setw(4) << std::setfill('0') << nLastFile;
 
    std::string inputFileName = ostri.str();
    ATH_MSG_DEBUG("copying the input file: '"<< inputFileName << "'...");
 
    try {
 
        /* clean the output directory if m_maxProducedFiles == 0
         * or keep up to 'm_maxProducedFiles' output files
         */
        VP1FileUtilities fileUtil(".", m_maxProducedFiles, m_destinationDir, m_createDestinationDir, m_removeTempInputFiles); // inputDir, fileLimit, outputDir, forceMakeOutputDir, removeInputFile
 
        if (m_outputFileType != "")
            fileUtil.produceNewFile(ostri.str(), m_runNumber, m_eventNumber, m_timeStamp, m_humanTimestamp+"."+m_outputFileType); // with UNIX and human-readable timestamp
        else
            fileUtil.produceNewFile(ostri.str(), m_runNumber, m_eventNumber, m_timeStamp, m_humanTimestamp); // with UNIX timestamp
 
    }
    catch(std::runtime_error& err) {
      ATH_MSG_WARNING("Exception caught: " << err.what());
      ATH_MSG_WARNING("In handle() -- Unable to produce new VP1 event file");
    }
  }
 
 
  /*
   * -------------------------------------------------------------------
   * === NOTE!!! ===
   *
   * AFTER having processed the file from the previous event,
   * we now update the run number and event number for the current event
   * --------------------------------------------------------------------
   */
 
  // increment event count
  m_nEvent++;
 
  // Update run_number/event_number/time_stamp
  const EventContext& context = getContext();
  m_eventNumber = context.eventID().event_number();
  m_runNumber = context.eventID().run_number();
  m_timeStamp = context.eventID().time_stamp();
 
  ATH_MSG_DEBUG(" Got run number = " << m_runNumber
          << ", event number = " << m_eventNumber
          << ", UNIX timestamp = " << m_timeStamp);
 
  time_t t_timestamp = m_timeStamp;
  struct tm ltm;
  localtime_r(&t_timestamp, &ltm);
 
  // print various components of tm structure.
  ATH_MSG_DEBUG("Year: "<< 1900 + ltm.tm_year
          << " - " << "Month: "<< 1 + ltm.tm_mon<< " - "  // tm_mon is in the range [0, 11], so 1 must be added to get real months
          << "Day: "<<  ltm.tm_mday
          << " - " "Time: "<< ltm.tm_hour << ":" << ltm.tm_min << ":" << ltm.tm_sec << "CEST"
         );
 
  std::ostringstream ostri;
  ostri  << 1900 + ltm.tm_year
          << "-" << 1 + ltm.tm_mon  // tm_mon is in the range [0, 11], so 1 must be added to get real months
          << "-" << ltm.tm_mday
          << "T" << ltm.tm_hour << "-" << ltm.tm_min << "-" << ltm.tm_sec << "CEST";
 
  m_humanTimestamp = ostri.str();
  ATH_MSG_DEBUG("'human readable' timestamp: " << m_humanTimestamp);
 
  if(m_isOnline){
    m_destinationDir = m_onlineEDsvc->getEntireOutputStr();
  }
  ATH_MSG_DEBUG("Destination Directory: " << m_destinationDir);
 
}

◆ initialize()

StatusCode VP1EventProd::initialize ( )

Definition at line 49 of file VP1EventProd.cxx.

{
  ATH_MSG_DEBUG(" in initialize() ");
 
  StatusCode result = StatusCode::SUCCESS;
 
  // use the incident service to register a handle
  SmartIF<IIncidentSvc> incsvc{service("IncidentSvc")};
 
  if(!incsvc)
    ATH_MSG_WARNING("Unable to get IncidentSvc!");
  else
    incsvc->addListener(this, "BeginEvent", 0);
 
   if(m_isOnline){
    if( m_onlineEDsvc.retrieve().isFailure()){
      ATH_MSG_ERROR("Could not locate the online event displays service");
      return StatusCode::FAILURE;
    }
   }
 
  return result;
}

◆ inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Algorithm > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ msg()

MsgStream & AthCommonMsg< Algorithm >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msgLvl()

bool AthCommonMsg< Algorithm >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

◆ outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Algorithm > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ renounce()

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > AthCommonDataStore< AthCommonMsg< Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ sysInitialize()

StatusCode AthAlgorithm::sysInitialize ( )

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Algorithm > >.

Reimplemented in AthAnalysisAlgorithm, AthFilterAlgorithm, AthHistogramAlgorithm, and PyAthena::Alg.

Definition at line 66 of file AthAlgorithm.cxx.

                                       {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<Algorithm>>::sysInitialize();
 
  if (sc.isFailure()) {
    return sc;
  }
  ServiceHandle<ICondSvc> cs("CondSvc",name());
  for (auto h : outputHandles()) {
    if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
      // do this inside the loop so we don't create the CondSvc until needed
      if ( cs.retrieve().isFailure() ) {
        ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
        return StatusCode::SUCCESS;
      }
      if (cs->regHandle(this,*h).isFailure()) {
        sc = StatusCode::FAILURE;
        ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                      << " with CondSvc");
      }
    }
  }
  return sc;
}

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Algorithm > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

◆ m_createDestinationDir

bool VP1EventProd::m_createDestinationDir

private

Definition at line 62 of file VP1EventProd.h.

◆ m_destinationDir

std::string VP1EventProd::m_destinationDir

private

Definition at line 61 of file VP1EventProd.h.

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_eventNumber

unsigned long long VP1EventProd::m_eventNumber

private

Definition at line 52 of file VP1EventProd.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_extendedExtraObjects

DataObjIDColl AthAlgorithm::m_extendedExtraObjects

privateinherited

Definition at line 79 of file AthAlgorithm.h.

◆ m_humanTimestamp

std::string VP1EventProd::m_humanTimestamp

private

Definition at line 55 of file VP1EventProd.h.

◆ m_inputPoolFile

std::string VP1EventProd::m_inputPoolFile

private

Definition at line 60 of file VP1EventProd.h.

◆ m_isOnline

Gaudi::Property<bool> VP1EventProd::m_isOnline {this, "IsOnline", false, "If running at point 1"}

private

Definition at line 47 of file VP1EventProd.h.

47{this, "IsOnline", false, "If running at point 1"};

◆ m_maxProducedFiles

int VP1EventProd::m_maxProducedFiles

private

Definition at line 63 of file VP1EventProd.h.

◆ m_nEvent

int VP1EventProd::m_nEvent

private

Definition at line 64 of file VP1EventProd.h.

◆ m_onlineEDsvc

ServiceHandle<IOnlineEventDisplaysSvc> VP1EventProd::m_onlineEDsvc {this, "OnlineEventDisplaysSvc", "Online Event Displays Service"}

private

Definition at line 48 of file VP1EventProd.h.

48{this, "OnlineEventDisplaysSvc", "Online Event Displays Service"};

◆ m_outputFileType

std::string VP1EventProd::m_outputFileType

private

Definition at line 56 of file VP1EventProd.h.

◆ m_removeTempInputFiles

bool VP1EventProd::m_removeTempInputFiles

private

Definition at line 57 of file VP1EventProd.h.

◆ m_runNumber

unsigned long VP1EventProd::m_runNumber

private

Definition at line 51 of file VP1EventProd.h.

◆ m_timeStamp

unsigned long VP1EventProd::m_timeStamp

private

Definition at line 54 of file VP1EventProd.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< Algorithm > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

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

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ VP1EventProd()

◆ ~VP1EventProd()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ finalize()

◆ handle()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_createDestinationDir

◆ m_destinationDir

◆ m_detStore

◆ m_eventNumber

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_humanTimestamp

◆ m_inputPoolFile

◆ m_isOnline

◆ m_maxProducedFiles

◆ m_nEvent

◆ m_onlineEDsvc

◆ m_outputFileType

◆ m_removeTempInputFiles

◆ m_runNumber

◆ m_timeStamp

◆ m_varHandleArraysDeclared

◆ m_vhka