TimeBurner Class Reference

Reject-all hypo algorithm sleeping for some time and doing nothing else. More...

#include <TimeBurner.h>

Inheritance diagram for TimeBurner:

Collaboration diagram for TimeBurner:

Public Member Functions
	TimeBurner (const std::string &name, ISvcLocator *svcLoc)
	Standard constructor.
virtual StatusCode	initialize () override
virtual StatusCode	execute (const EventContext &eventContext) const override
virtual StatusCode	sysInitialize () override
	initialise this base class
virtual bool	isClonable () const override
	Specify if the algorithm is clonable.
virtual unsigned int	cardinality () const override
	Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant.
virtual StatusCode	sysExecute (const EventContext &ctx) override
	Execute an algorithm.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
virtual bool	filterPassed (const EventContext &ctx) const
virtual void	setFilterPassed (bool state, const EventContext &ctx) const
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

Static Public Member Functions
static StatusCode	runtimeValidation (SG::WriteHandle< TrigCompositeUtils::DecisionContainer > &outputHandle, MsgStream &msg, bool onlyValidateOneStep=true, bool runTwoConversion=false)
	Executes all individual runtime tests.

Protected Member Functions
const SG::ReadHandleKey< TrigCompositeUtils::DecisionContainer > &	decisionInput () const
	methods for derived classes to access handles of the base class input other read/write handles may be implemented by derived classes
const SG::WriteHandleKey< TrigCompositeUtils::DecisionContainer > &	decisionOutput () const
	methods for derived classes to access handles of the base class output other read/write handles may be implemented by derived classes
StatusCode	hypoBaseOutputProcessing (SG::WriteHandle< TrigCompositeUtils::DecisionContainer > &outputHandle, MSG::Level lvl=MSG::DEBUG) const
	Base class function to be called once slice specific code has finished. Handles debug printing and validation.
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
StatusCode	printDebugInformation (SG::WriteHandle< TrigCompositeUtils::DecisionContainer > &outputHandle, MSG::Level lvl) const
	Common base function to print information on chains passed by objects considered in the hypo.
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
Gaudi::Property< unsigned int >	m_sleepTimeMillisec
ToolHandleArray< IAlgTool >	m_hypoTools {this, "HypoTools", {}}
SG::ReadHandleKey< TrigCompositeUtils::DecisionContainer >	m_input { this, "HypoInputDecisions", "UNSPECIFIED_INPUT", "Input Decision (implicit)" }
	input decisions
SG::WriteHandleKey< TrigCompositeUtils::DecisionContainer >	m_output { this, "HypoOutputDecisions", "UNSPECIFIED_OUTPUT", "Ouput Decision" }
	output decisions
Gaudi::Property< bool >	m_runtimeValidation { this, "RuntimeValidation", false, "Enable detailed runtime validation of HypoAlg output, and upstream Decisions." }
	Enabling of detailed validation checks for use during development.
DataObjIDColl	m_extendedExtraObjects
	Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.
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

Runtime validation methods
enum	LogicalFlowCheckMode { kRequireOne , kRequireAll }
static StatusCode	validateHasLinks (const ElementLink< TrigCompositeUtils::DecisionContainer > &dEL, MsgStream &msg)
	Ensure all Decisions have the named ElementLink graph edges which they are required to by spec.
static StatusCode	validateLogicalFlow (const ElementLink< TrigCompositeUtils::DecisionContainer > &dEL, MsgStream &msg, const LogicalFlowCheckMode mode)
	Ensure that all DecisionIDs have propagated correctly from their parent.
static StatusCode	validateDuplicatedDecisionID (const ElementLink< TrigCompositeUtils::DecisionContainer > &dEL, MsgStream &msg)
	Ensure that no space is being wasted by duplicated DecisionIDs in any Decision objects.
static StatusCode	validateDecisionIDs (const ElementLink< TrigCompositeUtils::DecisionContainer > &dEL, MsgStream &msg)
	Ensure that all present IDs correspond to configured chains.
static StatusCode	validateParentLinking (const ElementLink< TrigCompositeUtils::DecisionContainer > &dEL, MsgStream &msg, bool runTwoConversion)
	Ensure that the Decision has at least one valid parent, unless it is a initial Decision from the HLTSeeding.
static StatusCode	recursiveValidateGraph (const ElementLink< TrigCompositeUtils::DecisionContainer > &dEL, MsgStream &msg, bool onlyValidateOneStep, bool runTwoConversion, size_t callDepth, std::set< const TrigCompositeUtils::Decision * > &fullyExploredFrom)
	Execute all checks on one node in the graph, d, then recursive call self on all parent nodes up to L1.
static void	printBangs (MsgStream &msg)
	Print header line.
static void	printErrorHeader (const ElementLink< TrigCompositeUtils::DecisionContainer > &dEL, MsgStream &msg)
	A problem was found, print common output data.

Detailed Description

Reject-all hypo algorithm sleeping for some time and doing nothing else.

Definition at line 15 of file TimeBurner.h.

Member Typedef Documentation

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Enumeration Documentation

LogicalFlowCheckMode

enum HypoBase::LogicalFlowCheckMode

privateinherited

Enumerator
kRequireOne	Require all DecisionIDs to be present in at least one of my parent Decision objects.
kRequireAll

Definition at line 52 of file HypoBase.h.

                            { 
    kRequireOne, 
    kRequireAll //<! Require all DecisionIDs to be present in all of my parent Decision objects
  };

Constructor & Destructor Documentation

TimeBurner()

TimeBurner::TimeBurner	(	const std::string &	name,
		ISvcLocator *	svcLoc )

Standard constructor.

Definition at line 10 of file TimeBurner.cxx.

: ::HypoBase(name, pSvcLocator) {}

Member Function Documentation

cardinality()

unsigned int AthCommonReentrantAlgorithm< Gaudi::Algorithm >::cardinality ( ) const

overridevirtualinherited

Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant.

Override this to return 0 for reentrant algorithms.

Definition at line 75 of file AthCommonReentrantAlgorithm.cxx.

{
  return 0;
}

decisionInput()

const SG::ReadHandleKey< TrigCompositeUtils::DecisionContainer > & HypoBase::decisionInput ( ) const

protectedinherited

methods for derived classes to access handles of the base class input other read/write handles may be implemented by derived classes

Definition at line 18 of file HypoBase.cxx.

                                                                                         {
  return m_input;
}

decisionOutput()

const SG::WriteHandleKey< TrigCompositeUtils::DecisionContainer > & HypoBase::decisionOutput ( ) const

protectedinherited

methods for derived classes to access handles of the base class output other read/write handles may be implemented by derived classes

Definition at line 22 of file HypoBase.cxx.

                                                                                           {
  return m_output;
}

declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Gaudi::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< Gaudi::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< Gaudi::Algorithm > >::detStore ( ) const

inlineinherited

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

Definition at line 95 of file AthCommonDataStore.h.

{ return m_detStore; }

evtStore()

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

inlineinherited

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

Definition at line 85 of file AthCommonDataStore.h.

{ return m_evtStore; }

execute()

StatusCode TimeBurner::execute ( const EventContext & eventContext ) const

overridevirtual

Definition at line 19 of file TimeBurner.cxx.

                                                                     {
  // Create a reject decision
  TrigCompositeUtils::createAndStore(decisionOutput(), eventContext);
 
  std::this_thread::sleep_for(std::chrono::milliseconds(m_sleepTimeMillisec.value()));
 
  return StatusCode::SUCCESS;
}

extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Gaudi::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 & AthCommonReentrantAlgorithm< Gaudi::Algorithm >::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

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

Definition at line 94 of file AthCommonReentrantAlgorithm.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 BaseAlg::extraOutputDeps();
}

filterPassed()

virtual bool AthCommonReentrantAlgorithm< Gaudi::Algorithm >::filterPassed ( const EventContext & ctx ) const

inlinevirtualinherited

Definition at line 96 of file AthCommonReentrantAlgorithm.h.

                                                           {
    return execState( ctx ).filterPassed();
  }

hypoBaseOutputProcessing()

StatusCode HypoBase::hypoBaseOutputProcessing ( SG::WriteHandle< TrigCompositeUtils::DecisionContainer > & outputHandle, MSG::Level lvl = MSG::DEBUG ) const

protectedinherited

Base class function to be called once slice specific code has finished. Handles debug printing and validation.

Definition at line 35 of file HypoBase.cxx.

                                                                                                                {
 
  ATH_CHECK( printDebugInformation(outputHandle, lvl) );
 
  if (m_runtimeValidation) {
    ATH_CHECK( runtimeValidation(outputHandle, msg()) );
  }
 
  return StatusCode::SUCCESS;
}

initialize()

StatusCode TimeBurner::initialize ( )

overridevirtual

Definition at line 13 of file TimeBurner.cxx.

                                  {
  // we don't actually need the HypoTool
  for (auto& tool : m_hypoTools) tool.disable();
  return StatusCode::SUCCESS;
}

inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Gaudi::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.

isClonable()

bool AthCommonReentrantAlgorithm< Gaudi::Algorithm >::isClonable ( ) const

overridevirtualinherited

Specify if the algorithm is clonable.

Reentrant algorithms are clonable.

Reimplemented in InDet::GNNSeedingTrackMaker, InDet::SCT_Clusterization, InDet::SiSPGNNTrackMaker, InDet::SiSPSeededTrackFinder, InDet::SiTrackerSpacePointFinder, ITkPixelCablingAlg, ITkStripCablingAlg, RoIBResultToxAOD, SCT_ByteStreamErrorsTestAlg, SCT_CablingCondAlgFromCoraCool, SCT_CablingCondAlgFromText, SCT_ConditionsParameterTestAlg, SCT_ConditionsSummaryTestAlg, SCT_ConfigurationConditionsTestAlg, SCT_FlaggedConditionTestAlg, SCT_LinkMaskingTestAlg, SCT_MajorityConditionsTestAlg, SCT_ModuleVetoTestAlg, SCT_MonitorConditionsTestAlg, SCT_PrepDataToxAOD, SCT_RawDataToxAOD, SCT_ReadCalibChipDataTestAlg, SCT_ReadCalibDataTestAlg, SCT_RODVetoTestAlg, SCT_SensorsTestAlg, SCT_SiliconConditionsTestAlg, SCT_StripVetoTestAlg, SCT_TdaqEnabledTestAlg, SCT_TestCablingAlg, SCTEventFlagWriter, SCTRawDataProvider, SCTSiLorentzAngleTestAlg, SCTSiPropertiesTestAlg, and Simulation::BeamEffectsAlg.

Definition at line 68 of file AthCommonReentrantAlgorithm.cxx.

{
  // Reentrant algorithms are clonable.
  return true;
}

msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msgLvl()

bool AthCommonMsg< Gaudi::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< Gaudi::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.

printBangs()

void HypoBase::printBangs ( MsgStream & msg )

staticprivateinherited

Print header line.

Definition at line 390 of file HypoBase.cxx.

                                        {
  msg << MSG::ERROR << "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!" << endmsg;
}

printDebugInformation()

StatusCode HypoBase::printDebugInformation ( SG::WriteHandle< TrigCompositeUtils::DecisionContainer > & outputHandle, MSG::Level lvl ) const

privateinherited

Common base function to print information on chains passed by objects considered in the hypo.

Definition at line 406 of file HypoBase.cxx.

                                                                                                             {
  if (msgLvl(lvl)) {
    msg() << lvl;
    msg() << "Exiting with " << outputHandle->size() <<" Decision objects" << endmsg;
    size_t count = 0;
    for (const Decision* d : *outputHandle){
      DecisionIDContainer objDecisions;      
      decisionIDs( d, objDecisions );
      msg() << "Number of positive decisions for Decision object #" << count++ << ": " << objDecisions.size() << endmsg;
      for (const TrigCompositeUtils::DecisionID id : objDecisions ) {
        msg() << " --- Passes: " << HLT::Identifier( id ) << endmsg;
      }  
    }
  }
  return StatusCode::SUCCESS;
}

printErrorHeader()

void HypoBase::printErrorHeader ( const ElementLink< TrigCompositeUtils::DecisionContainer > & dEL, MsgStream & msg )

staticprivateinherited

A problem was found, print common output data.

Definition at line 395 of file HypoBase.cxx.

{
  printBangs(msg);
  msg << MSG::ERROR << "! RUNTIME TRIGGER NAVIGATION VALIDATION ERROR" << endmsg;
  msg << MSG::ERROR << "! Caused by Decision with index:" << (*dEL)->index() << endmsg;
  msg << MSG::ERROR << "! From collection:" << dEL.dataID() << endmsg;
  msg << MSG::ERROR << "! " << **dEL << endmsg;
}

recursiveValidateGraph()

StatusCode HypoBase::recursiveValidateGraph ( const ElementLink< TrigCompositeUtils::DecisionContainer > & dEL, MsgStream & msg, bool onlyValidateOneStep, bool runTwoConversion, size_t callDepth, std::set< const TrigCompositeUtils::Decision * > & fullyExploredFrom )

staticprivateinherited

Execute all checks on one node in the graph, d, then recursive call self on all parent nodes up to L1.

Definition at line 71 of file HypoBase.cxx.

{
  if (onlyValidateOneStep && callDepth > 0) {
    if ((*dEL)->name() == hypoAlgNodeName()) {
      // Validation is called from HypoAlg nodes. So if we have reached the _previous_ HypoAlg node, then we have already
      // validated back from here in the past. Can stop at this point.
      return StatusCode::SUCCESS;
    }
  }
 
  // Check logical flow at this place in the graph 
  if ((*dEL)->name() == hypoAlgNodeName()) {
    // Check that all Hypo Decisions produced here satisfy the more-strict all-parent logical flow 
    if ( validateLogicalFlow(dEL, msg, kRequireAll).isFailure() ) {
      return StatusCode::FAILURE;
    }
  } else {
    // (looser requirement of one-valid-parent-with-decision than we had when we knew that d corresponded to a HypoAlg output)
    if ( validateLogicalFlow(dEL, msg, kRequireOne).isFailure() ) {
      return StatusCode::FAILURE;
    }
  }
 
  // Check my IDs
  if ( validateDecisionIDs(dEL, msg).isFailure() ) {
    return StatusCode::FAILURE;
  }
  if ( validateDuplicatedDecisionID(dEL, msg).isFailure() ) {
    return StatusCode::FAILURE;
  }
 
  // Check my linking
  if( validateParentLinking(dEL, msg, runTwoConversion).isFailure() ) {
    return StatusCode::FAILURE;
  }
  if ( validateHasLinks(dEL, msg).isFailure() ) {
    return StatusCode::FAILURE;
  }
 
  // Continue upstream
  const std::vector<ElementLink<DecisionContainer>> seeds = (*dEL)->objectCollectionLinks<DecisionContainer>(seedString());
  for (const ElementLink<DecisionContainer>& seed : seeds) {
    if (fullyExploredFrom.count( (*seed) ) == 1) {
      continue; // Already fully explored from this seed and up
    }
    if ( not seed.isValid() ) {
      msg << MSG::ERROR << "Invalid seed element link in recursiveValidateGraph" << endmsg;
      return StatusCode::FAILURE;
    }
    if ( recursiveValidateGraph(seed, msg, onlyValidateOneStep, runTwoConversion, callDepth + 1, fullyExploredFrom).isFailure() ) {
      return StatusCode::FAILURE;
    }
  }
 
  fullyExploredFrom.insert( *dEL );
  return StatusCode::SUCCESS;
}

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< Gaudi::Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

runtimeValidation()

StatusCode HypoBase::runtimeValidation ( SG::WriteHandle< TrigCompositeUtils::DecisionContainer > & outputHandle, MsgStream & msg, bool onlyValidateOneStep = true, bool runTwoConversion = false )

staticinherited

Executes all individual runtime tests.

Definition at line 47 of file HypoBase.cxx.

{
  // Detailed checks on the output container of this HypoAlg
  std::set<const Decision*> fullyExploredFrom; // Cache used to avoid exploring regions of the graph more than once
  for (const Decision* d : *outputHandle) {
    const DecisionContainer* dContainer = dynamic_cast<const DecisionContainer*>( d->container() );
    const ElementLink<DecisionContainer> dEL = ElementLink<DecisionContainer>(*dContainer, d->index());
    if (not dEL.isValid()) {
      msg << MSG::ERROR << "Invalid seed element link in recursiveValidateGraph" << endmsg;
      return StatusCode::FAILURE;
    }
    // Check that we can reach L1 along all navigation paths up from each Decision
    // and validate these Decisions on the way up too.
    if (recursiveValidateGraph(dEL, msg, onlyValidateOneStep, runTwoConversion, 0, fullyExploredFrom).isFailure()) {
      return StatusCode::FAILURE;
    } 
  }
  return StatusCode::SUCCESS;
}

setFilterPassed()

virtual void AthCommonReentrantAlgorithm< Gaudi::Algorithm >::setFilterPassed ( bool state, const EventContext & ctx ) const

inlinevirtualinherited

Definition at line 100 of file AthCommonReentrantAlgorithm.h.

                                                                            {
    execState( ctx ).setFilterPassed( state );
  }

sysExecute()

StatusCode AthCommonReentrantAlgorithm< Gaudi::Algorithm >::sysExecute ( const EventContext & ctx )

overridevirtualinherited

Execute an algorithm.

We override this in order to work around an issue with the Algorithm base class storing the event context in a member variable that can cause crashes in MT jobs.

Definition at line 85 of file AthCommonReentrantAlgorithm.cxx.

{
  return BaseAlg::sysExecute (ctx);
}

sysInitialize()

StatusCode HypoBase::sysInitialize ( )

overridevirtualinherited

initialise this base class

Reimplemented from AthCommonReentrantAlgorithm< Gaudi::Algorithm >.

Definition at line 26 of file HypoBase.cxx.

                                   {
  CHECK( AthReentrantAlgorithm::sysInitialize() ); // initialise base class
  CHECK( m_input.initialize() );
  ATH_MSG_DEBUG("HypoBase::sysInitialize() Will consume decision: " << m_input.key() );
  CHECK( m_output.initialize() );
  ATH_MSG_DEBUG("HypoBase::sysInitialize() And produce decision: " << m_output.key() );
  return StatusCode::SUCCESS;
}

sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Gaudi::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< Gaudi::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);
      }
    }
  }

validateDecisionIDs()

StatusCode HypoBase::validateDecisionIDs ( const ElementLink< TrigCompositeUtils::DecisionContainer > & dEL, MsgStream & msg )

staticprivateinherited

Ensure that all present IDs correspond to configured chains.

Definition at line 209 of file HypoBase.cxx.

{
  // All numeric IDs must correspond to a know, configured, HLT chain
  DecisionIDContainer decisionIDSet;
  decisionIDs(*dEL, decisionIDSet);
  for (const DecisionID id : decisionIDSet) {
    const std::string chain = HLT::Identifier( id ).name();
    if (!isChainId(chain) and !isLegId(chain)) {
      printErrorHeader(dEL, msg);
      msg << MSG::ERROR << "! Decision contains an ID which does not correspond to a configured chain or a configured chain-leg: " << HLT::Identifier( id ) << endmsg;
      msg << MSG::ERROR << "! SOLUTION: Locate the producer of the collection, investigate how this bad ID could have been added." << endmsg;
      printBangs(msg);
      return StatusCode::FAILURE;
    }
  }
  return StatusCode::SUCCESS;
}

validateDuplicatedDecisionID()

StatusCode HypoBase::validateDuplicatedDecisionID ( const ElementLink< TrigCompositeUtils::DecisionContainer > & dEL, MsgStream & msg )

staticprivateinherited

Ensure that no space is being wasted by duplicated DecisionIDs in any Decision objects.

Definition at line 229 of file HypoBase.cxx.

{
  // Persistent vector storage does not guarantee against duplicate entries
  DecisionIDContainer decisionIDSet;
  decisionIDs(*dEL, decisionIDSet);
  if (decisionIDSet.size() != (*dEL)->decisions().size()) {
    printErrorHeader(dEL, msg);
    msg << MSG::ERROR << "! Decision contains duplicate DecisionIDs." << endmsg;
    msg << MSG::ERROR << "! SOLUTION: If combining DecisionIDs from multiple parents, de-duplicate the internal std::vector<DecisionID> of 'Decision* d' with:" << endmsg;
    msg << MSG::ERROR << "!   TrigCompositeUtils::insertDecisionIDs(DecisionIDContainer(), d);"  << endmsg;
    printBangs(msg);
    return StatusCode::FAILURE;
  }
  return StatusCode::SUCCESS;
}

validateHasLinks()

StatusCode HypoBase::validateHasLinks ( const ElementLink< TrigCompositeUtils::DecisionContainer > & dEL, MsgStream & msg )

staticprivateinherited

Ensure all Decisions have the named ElementLink graph edges which they are required to by spec.

Definition at line 338 of file HypoBase.cxx.

{
  const std::string& name = (*dEL)->name();
  if (name == hypoAlgNodeName()) {
 
    // Check that I have a "feature"
    if ((*dEL)->hasObjectLink( featureString() )) {
      return StatusCode::SUCCESS;
    }
    printErrorHeader(dEL, msg);
    msg << MSG::ERROR << "! Decision has no '" << featureString() << "' ElementLink." << endmsg;
    msg << MSG::ERROR << "! Every Decision created by a HypoAlg must correspond to some physics object, and be linked to the object." << endmsg;
    msg << MSG::ERROR << "! SOLUTION: Ensure that all produced Decision objects are assigned their feature:" << endmsg;
    msg << MSG::ERROR << "! SOLUTION:    decision->setObjectLink<MY_FEATURE_CONTANER_TYPE>(featureString(), MY_FEATURE_ELEMENT_LINK);" << endmsg;
    printBangs(msg);
    return StatusCode::FAILURE;
 
  } else if (name == inputMakerNodeName()) {
 
    // This requirement is dropped for empty input makers to avoid unnecessary graph clutter.
    bool exempt = false;
    if ((*dEL)->hasDetail<int32_t>("isEmpty") and (*dEL)->getDetail<int32_t>("isEmpty") == 1) {
      exempt = true;
    }
 
    if (not (*dEL)->hasObjectLink( roiString() ) and not exempt) {
      printErrorHeader(dEL, msg);
      msg << MSG::ERROR << "! Decision has no '" << roiString() << "' ElementLink." << endmsg;
      msg << MSG::ERROR << "! Every Decision created by a InputMaker must link to the ROI which reconstruction will run on for that Decision object in this Step." << endmsg;
      msg << MSG::ERROR << "! It can be the FullScan ROI created by the HLTSeeding (FSNOSEED) if no other suitable ROI exists." << endmsg;
      msg << MSG::ERROR << "! SOLUTION: Check the configuration of InputMakerForRoI or EventViewCreatorAlgorithm responsible for creating this Decision Object" << endmsg;
      msg << MSG::ERROR << "! SOLUTION: The algorithm must have an ROITool which must attach an '"<< roiString() <<"' link to each Decision Object" << endmsg;
      printBangs(msg);
    }
 
  } else if (name == hltSeedingNodeName()) {
 
    if (not (*dEL)->hasObjectLink( initialRoIString() )) {
      printErrorHeader(dEL, msg);
      msg << MSG::ERROR << "! Decision has no '" << initialRoIString() << "' ElementLink." << endmsg;
      msg << MSG::ERROR << "! Every Decision created by the HLTSeeding must link to the initial ROI which caused it to be created." << endmsg;
      msg << MSG::ERROR << "! This includes the Decision Object created to represent the Full-Scan/NoSeed (FSNOSEED) ROI." << endmsg;
      msg << MSG::ERROR << "! SOLUTION: Check the configuration of the HLTSeeding tool responsible for creating this Decision Object" << endmsg;
      printBangs(msg);
    }
 
  }
  return StatusCode::SUCCESS;
}

validateLogicalFlow()

StatusCode HypoBase::validateLogicalFlow ( const ElementLink< TrigCompositeUtils::DecisionContainer > & dEL, MsgStream & msg, const LogicalFlowCheckMode mode )

staticprivateinherited

Ensure that all DecisionIDs have propagated correctly from their parent.

Definition at line 247 of file HypoBase.cxx.

{
  // Do not need to validate for L1 Decisions as these have no parents
  if ((*dEL)->name() == hltSeedingNodeName()) {
    return StatusCode::SUCCESS;
  }
 
  // Get all my passed DecisionIDs
  DecisionIDContainer decisionIDSet;
  decisionIDs(*dEL, decisionIDSet);
  const std::vector<ElementLink<DecisionContainer>> seeds = (*dEL)->objectCollectionLinks<DecisionContainer>(seedString());
  for (const DecisionID id : decisionIDSet) {
    // For each chain that I'm passing, check how many of my parents were also passing the chain
    size_t parentsWithDecision = 0;  
    for (const ElementLink<DecisionContainer>& seed : seeds) {
      if ( not seed.isValid() ) {
        msg << MSG::ERROR << "Invalid seed element link in recursiveValidateGraph" << endmsg;
        return StatusCode::FAILURE;
      }
      DecisionIDContainer seedIDSet;
      decisionIDs(*seed, seedIDSet);
      // Id may be a chain-ID (represents a whole chain) or a leg-ID (represents just a single leg of a multi-leg chain)
      // Is ID is in this parent's set of passed IDs?
      // Or, (if ID is a leg-ID) is the chain-ID of leg-ID in the parent's set of passed IDs?
      if (passed(id, seedIDSet) or passed(getIDFromLeg(id).numeric(), seedIDSet)) {
        ++parentsWithDecision;
      }
      else{ // Or, for each of the seed IDs, if the seed ID is a leg-ID, is the seed chain-ID of the seed leg-ID the same as ID?  
        for (auto sid: seedIDSet){
          if (getIDFromLeg(sid).numeric() == id){
            ++parentsWithDecision;
            break;
          }
        }
      }
    }
 
    if (mode == kRequireOne && parentsWithDecision == 0) {
      // InputMakers may merge multiple of their input collections in order to run reconstruction on a common set of ROI (for example)
      // So the DecisionIDs may have come from any one or more of the inputs. But zero is not allowed.
      printErrorHeader(dEL, msg);
      msg << MSG::ERROR << "! This Decision object is not respecting logical flow of DecisionIDs for chain: " << HLT::Identifier( id ) << endmsg;
      msg << MSG::ERROR << "! This chain's DecisionID can not be found in any parents of this Decision object:" << endmsg;
      size_t seed_n = 0;
      for (const ElementLink<DecisionContainer>& seed : seeds) {
        msg << MSG::ERROR << "! Index:" << (*seed)->index() << " from collection:" << seed.dataID() << endmsg;
        msg << MSG::ERROR << "! " << **seed << endmsg;
        DecisionIDContainer objDecisions;      
        decisionIDs(*seed, objDecisions);
        for (const TrigCompositeUtils::DecisionID id : objDecisions ) {
          msg << "! --- Passing in parent #" << seed_n << ": " << HLT::Identifier( id ) << endmsg;
        }
        ++seed_n;
      }
      msg << MSG::ERROR << "! SOLUTION: Ensure that the producer of this Decision object only adds DecisionIDs"
        " which were present in at least one of its parents." << endmsg;
      printBangs(msg);
      return StatusCode::FAILURE;
    } else if (mode == kRequireAll && parentsWithDecision != seeds.size()) {
      // HypoAlgs may form a new physics object from multiple objects in the previous step
      // (think a BPhysics object whose parents are two Decisions which each correspond to a different L1 MU RoI, 
      // both ROI need to be in active state for the chain, if the chain's HypoTool considers the BPhysics object)
      // This case requires *all* of the physics objects which are being combined together to be active for the chain
      // in order to preserve logical flow
      printErrorHeader(dEL, msg);
      msg << MSG::ERROR << "! This Decision object is not respecting logical flow of DecisionIDs for chain: " << HLT::Identifier( id ) << endmsg;
      msg << MSG::ERROR << "! As this Decision object represents the output of a HypoAlg, it must respect logical flow on all " 
        << seeds.size() << " of its parent(s):" << endmsg;
      size_t seed_n = 0;
      for (const ElementLink<DecisionContainer>& seed : seeds) {
        msg << MSG::ERROR << "! Index:" << (*seed)->index() << " from collection:" << seed.dataID() << endmsg;
        msg << MSG::ERROR << "! " << **seed << endmsg;
        DecisionIDContainer objDecisions;      
        decisionIDs(*seed, objDecisions);
        for (const TrigCompositeUtils::DecisionID id : objDecisions ) {
          msg << "! --- Passing in parent #" << seed_n << ": " << HLT::Identifier( id ) << endmsg;
        }
        ++seed_n;
      }
      msg << MSG::ERROR << "! SOLUTION: Ensure that the HypoTool responsible for " << HLT::Identifier( id ) 
        << " in this HypoAlg only runs if this ID is present in all parent decisions." << endmsg;
      printBangs(msg);
      return StatusCode::FAILURE;
    }
  }
  return StatusCode::SUCCESS;
}

validateParentLinking()

StatusCode HypoBase::validateParentLinking ( const ElementLink< TrigCompositeUtils::DecisionContainer > & dEL, MsgStream & msg, bool runTwoConversion )

staticprivateinherited

Ensure that the Decision has at least one valid parent, unless it is a initial Decision from the HLTSeeding.

Definition at line 135 of file HypoBase.cxx.

{
  const std::vector<ElementLink<DecisionContainer>> seeds = (*dEL)->objectCollectionLinks<DecisionContainer>(seedString());
  // All Decision object must have at least one parent, unless they are the initial set of objects created by the HLTSeeding
  const std::string& name = (*dEL)->name();
  if (seeds.size() == 0 && name != hltSeedingNodeName()) {
    printErrorHeader(dEL, msg);
    msg << MSG::ERROR << "! Decision has zero parents. This is only allowed for the initial Decisions created by the HLTSeeding." << endmsg;
    msg << MSG::ERROR << "! SOLUTION: Attach parent Decision(s) with TrigCompositeUtils::linkToPrevious" << endmsg;
    printBangs(msg);
    return StatusCode::FAILURE;
  }
 
  if (name == hltSeedingNodeName()) {
    if (seeds.size() > 0) {
      printErrorHeader(dEL, msg);
       msg << MSG::ERROR << "! Decision has parents. This is not allowed for the initial Decisions created by the HLTSeeding." << endmsg;
       msg << MSG::ERROR << "! SOLUTION: Check HLTSeeding, no where should it be adding a parent link." << endmsg;
      printBangs(msg);
      return StatusCode::FAILURE;
    }
    return StatusCode::SUCCESS;
  }
 
  static const std::set<std::string> expectedParentsFilter = {hypoAlgNodeName(), comboHypoAlgNodeName(), hltSeedingNodeName()};
  static const std::set<std::string> expectedParentsInputMaker = {filterNodeName()};
  static const std::set<std::string> expectedParentsHypoAlg = {inputMakerNodeName()};
  static const std::set<std::string> expectedParentsComboHypoAlg = {hypoAlgNodeName(), inputMakerNodeName(), hltSeedingNodeName()}; // TODO check hltSeedingNodeName(), needed for newJO
  static const std::set<std::string> expectedParentsSummaryFilter = {hypoAlgNodeName(), comboHypoAlgNodeName(), hltSeedingNodeName()};
  static const std::set<std::string> expectedParentsSummaryPassed = {summaryFilterNodeName()};
 
  const std::set<std::string>* expectedParentsPtr = nullptr;
  if (name == filterNodeName()) {
    expectedParentsPtr = &expectedParentsFilter;
  } else if (name == inputMakerNodeName() and !runTwoConversion) {
    expectedParentsPtr = &expectedParentsInputMaker;
  } else if (name == inputMakerNodeName() and runTwoConversion) {
    expectedParentsPtr = &expectedParentsFilter; // We don't have Filter nodes in the R2->R3 conversion
  } else if (name == hypoAlgNodeName()) {
    expectedParentsPtr = &expectedParentsHypoAlg;
  } else if (name == comboHypoAlgNodeName()) {
    expectedParentsPtr = &expectedParentsComboHypoAlg;
  } else if (name == summaryFilterNodeName()) {
    expectedParentsPtr = &expectedParentsSummaryFilter;
  } else if (name == summaryPassNodeName()) {
    expectedParentsPtr = &expectedParentsSummaryPassed;
  } else {
    printErrorHeader(dEL, msg);
    msg << MSG::ERROR << "! Invalid Node name '" << name << "'." << endmsg;
    msg << MSG::ERROR << "! SOLUTION: Find the alg which made a node with this name. Allowed named may be found in TrigCompositeUtils.h, See:'Constant string literals used within the HLT'." << endmsg;
    printBangs(msg);
    return StatusCode::FAILURE;
  }
 
  for (const ElementLink<DecisionContainer>& seed : seeds) {
    if (!expectedParentsPtr->contains( (*seed)->name() )) {
      printErrorHeader(dEL, msg);
      msg << MSG::ERROR << "! Invalid linking from node with name '" << name << "' to one with name '"<< (*seed)->name() << "'." << endmsg;
      msg << MSG::ERROR << "! Allowed seed names are:" << endmsg;
      for (const std::string& allowed : *expectedParentsPtr) {
        msg << MSG::ERROR << "! " << allowed << endmsg;
      }
      msg << MSG::ERROR << "! SOLUTION: Find where this invalid parent was added and correct it." << endmsg;
      printBangs(msg);
      return StatusCode::FAILURE;
    }
  }
 
  return StatusCode::SUCCESS;
}

Member Data Documentation

m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

m_extendedExtraObjects

DataObjIDColl AthCommonReentrantAlgorithm< Gaudi::Algorithm >::m_extendedExtraObjects

privateinherited

Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.

Empty if no symlinks were found.

Definition at line 114 of file AthCommonReentrantAlgorithm.h.

m_hypoTools

ToolHandleArray<IAlgTool> TimeBurner::m_hypoTools {this, "HypoTools", {}}

private

Definition at line 29 of file TimeBurner.h.

{this, "HypoTools", {}};

m_input

SG::ReadHandleKey<TrigCompositeUtils::DecisionContainer> HypoBase::m_input { this, "HypoInputDecisions", "UNSPECIFIED_INPUT", "Input Decision (implicit)" }

privateinherited

input decisions

Definition at line 101 of file HypoBase.h.

{ this, "HypoInputDecisions", "UNSPECIFIED_INPUT", "Input Decision (implicit)" };

m_output

SG::WriteHandleKey<TrigCompositeUtils::DecisionContainer> HypoBase::m_output { this, "HypoOutputDecisions", "UNSPECIFIED_OUTPUT", "Ouput Decision" }

privateinherited

output decisions

Definition at line 103 of file HypoBase.h.

{ this, "HypoOutputDecisions", "UNSPECIFIED_OUTPUT", "Ouput Decision" };

m_runtimeValidation

Gaudi::Property<bool> HypoBase::m_runtimeValidation { this, "RuntimeValidation", false, "Enable detailed runtime validation of HypoAlg output, and upstream Decisions." }

privateinherited

Enabling of detailed validation checks for use during development.

Definition at line 105 of file HypoBase.h.

{ this, "RuntimeValidation", false, "Enable detailed runtime validation of HypoAlg output, and upstream Decisions." };

m_sleepTimeMillisec

Gaudi::Property<unsigned int> TimeBurner::m_sleepTimeMillisec

private

Initial value:

{
      this, "SleepTimeMillisec", 0, "Time to sleep in each execution [ms]"
    }

Definition at line 24 of file TimeBurner.h.

                                                    {
      this, "SleepTimeMillisec", 0, "Time to sleep in each execution [ms]"
    };

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_vhka

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

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

---

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

• TimeBurner.h
• TimeBurner.cxx