Algorithm to count create inputs and expectations to test the eEmMultAlgTool class. More...

#include <eEmMultTestBench.h>

Inheritance diagram for GlobalSim::eEmMultTestBench:

Collaboration diagram for GlobalSim::eEmMultTestBench:

Public Member Functions
	eEmMultTestBench (const std::string &name, ISvcLocator *pSvcLocator)
virtual StatusCode	initialize () override
virtual StatusCode	execute () override
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
std::unique_ptr< TIPword >	TIPword_from_file () const
GlobalSim::IOBitwise::IeEmTOB *	make_tob (const std::string &s) const
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
SG::WriteHandleKey< GlobalSim::IOBitwise::IeEmTOBContainer >	m_eEmTOBContainer_WriteKey
SG::WriteHandleKey< TIPword >	m_TIPword_WriteKey
Gaudi::Property< std::string >	m_tobs_fileName
Gaudi::Property< std::string >	m_TIPword_fileName
std::ifstream	m_tob_stream
std::unique_ptr< std::ifstream >	m_TIPword_stream {nullptr}
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

Algorithm to count create inputs and expectations to test the eEmMultAlgTool class.

Definition at line 41 of file eEmMultTestBench.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

◆ eEmMultTestBench()

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

Definition at line 18 of file eEmMultTestBench.cxx.

                                              :
    AthAlgorithm(name, pSvcLocator) {
  }

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 GlobalSim::eEmMultTestBench::execute ( )

overridevirtual

Definition at line 70 of file eEmMultTestBench.cxx.

                                       {
    ATH_MSG_DEBUG("executing");
 
        
    auto padded_line = std::string();
    auto tobs = std::make_unique<GlobalSim::IOBitwise::IeEmTOBContainer>();
 
    while (true) {
      std::getline(m_tob_stream, padded_line);
      auto line = trim(padded_line);
 
      if(!m_tob_stream) {
    ATH_MSG_ERROR("input stream bad state " << m_tobs_fileName);
    return StatusCode::FAILURE;
      }
           
      if(line == "EOE") {break;}
      
      if (line.starts_with("//")){continue;}
      tobs->push_back(make_tob(line));
 
    }
 
    using WH_TOB = SG::WriteHandle<GlobalSim::IOBitwise::IeEmTOBContainer>;
    auto h_write_tobs = WH_TOB(m_eEmTOBContainer_WriteKey);    
    CHECK(h_write_tobs.record(std::move(tobs)));
 
    auto h_write_TIPword = SG::WriteHandle<TIPword>(m_TIPword_WriteKey);
    auto twp = TIPword_from_file();
    CHECK(h_write_TIPword.record(std::move(twp)));
    
    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();
}

◆ initialize()

StatusCode GlobalSim::eEmMultTestBench::initialize ( )

overridevirtual

Definition at line 23 of file eEmMultTestBench.cxx.

                                           {
    ATH_MSG_DEBUG("initialising");
    CHECK(m_eEmTOBContainer_WriteKey.initialize());
    CHECK( m_TIPword_WriteKey.initialize());
 
    // initialisation is from a file of test vectors
 
    std::string fn = PathResolver::find_file(m_tobs_fileName,
                         "DATAPATH");
    if (fn.empty()) {
      ATH_MSG_FATAL("Failure to find tob file " << m_tobs_fileName
            << " on " << "$DATAPATH");
      return StatusCode::FAILURE;
    }
    
    m_tob_stream = std::ifstream (fn);
 
    if (!m_tob_stream) {
      ATH_MSG_FATAL("Failure to open tob stream " << fn);
      return StatusCode::FAILURE;
    }
      
    if(!m_tob_stream) {
      ATH_MSG_FATAL("Failure to initialise TOB stream " << fn);
      return StatusCode::FAILURE;
    }
 
    fn = PathResolver::find_file(m_TIPword_fileName,
                 "DATAPATH");
    if (fn.empty()) {
      ATH_MSG_FATAL("Failure to find TIP file " << m_TIPword_fileName
            << " on " << "$DATAPATH");
      return StatusCode::FAILURE;
    }
 
    m_TIPword_stream = std::make_unique<std::ifstream> (fn);
    if(!(*m_TIPword_stream)) {
      std::stringstream ss;
      ATH_MSG_FATAL("Failure to initialise TIP word stream " << fn );
      return StatusCode::FAILURE;
    }
 
 
    return StatusCode::SUCCESS;
  }

◆ 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.

◆ make_tob()

IeEmTOB * GlobalSim::eEmMultTestBench::make_tob ( const std::string & s ) const

private

Definition at line 116 of file eEmMultTestBench.cxx.

                                                                {
    ATH_MSG_INFO("in make_tob> line: " <<trimmed_line);
 
    std::stringstream ss(trimmed_line);
    std::string et, eta, phi, RHad, WsTot, REta, seed, UpNotDown, SeedIsMax;
    ss >> et;
 
    const auto& s_et_width = ICommonTOB::s_et_width;
    const auto& s_eta_width = ICommonTOB::s_eta_width;
    const auto& s_phi_width = ICommonTOB::s_phi_width;
 
    auto common = CommonTOB(std::bitset<s_et_width>(et),
                std::bitset<s_eta_width>(eta),
                std::bitset<s_phi_width>(phi));
 
 
    const auto&  s_RHad_width = IeEmTOB::s_RHad_width;
    const auto&  s_REta_width = IeEmTOB::s_REta_width;
    const auto&  s_WsTot_width = IeEmTOB::s_WsTot_width;
    const auto&  s_Seed_width = IeEmTOB::s_Seed_width;
    const auto&  s_UpNotDown_width = IeEmTOB::s_UpNotDown_width;
    const auto&  s_SeedIsMax_width = IeEmTOB::s_SeedIsMax_width;
 
 
    return 
      new eEmTOB(common,
         std::bitset(std::bitset<s_RHad_width>(RHad)),
         std::bitset(std::bitset<s_REta_width>(REta)),
         std::bitset(std::bitset<s_WsTot_width>(WsTot)),
         std::bitset(std::bitset<s_Seed_width>(seed)),
         std::bitset(std::bitset<s_UpNotDown_width>(UpNotDown)),
         std::bitset(std::bitset<s_SeedIsMax_width>(SeedIsMax)));
    
  }

◆ 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.

◆ TIPword_from_file()

std::unique_ptr< TIPword > GlobalSim::eEmMultTestBench::TIPword_from_file ( ) const

private

Definition at line 104 of file eEmMultTestBench.cxx.

                                                                  {
 
    auto line = std::string();
    using TIP = std::bitset<ITIPwriterAlgTool::s_nbits_TIP>;
    std::getline(*m_TIPword_stream, line);
    auto twp =  std::make_unique<TIP>(std::stoul(trim(std::move(line))));
    return twp;
  }

◆ 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_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_eEmTOBContainer_WriteKey

SG::WriteHandleKey<GlobalSim::IOBitwise::IeEmTOBContainer> GlobalSim::eEmMultTestBench::m_eEmTOBContainer_WriteKey

private

Initial value:

{
      this,
      "eEmTOBs",
      "eEmTOBs",
      "Key for GlobalSim eEmTOB container"}

Definition at line 53 of file eEmMultTestBench.h.

                               {
      this,
      "eEmTOBs",
      "eEmTOBs",
      "Key for GlobalSim eEmTOB container"};

◆ 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_TIPword_fileName

Gaudi::Property<std::string> GlobalSim::eEmMultTestBench::m_TIPword_fileName

private

Initial value:

{this,
               "TIPwords_fileName",
               {"GlobalSimulation/eEmMultTest_TIPwords.txt"},
               "name of file with expected TIP words"}

Definition at line 75 of file eEmMultTestBench.h.

                      {this,
               "TIPwords_fileName",
               {"GlobalSimulation/eEmMultTest_TIPwords.txt"},
               "name of file with expected TIP words"};

◆ m_TIPword_stream

std::unique_ptr<std::ifstream> GlobalSim::eEmMultTestBench::m_TIPword_stream {nullptr}

private

Definition at line 84 of file eEmMultTestBench.h.

84{nullptr};

◆ m_TIPword_WriteKey

SG::WriteHandleKey<TIPword> GlobalSim::eEmMultTestBench::m_TIPword_WriteKey

private

Initial value:

{
      this,
      "TIPwordWriteKey",
      "ExpectedTIPwords",
      "key to write out expectations for the TIP word"
    }

Definition at line 61 of file eEmMultTestBench.h.

                       {
      this,
      "TIPwordWriteKey",
      "ExpectedTIPwords",
      "key to write out expectations for the TIP word"
    };

◆ m_tob_stream

std::ifstream GlobalSim::eEmMultTestBench::m_tob_stream

private

Definition at line 83 of file eEmMultTestBench.h.

◆ m_tobs_fileName

Gaudi::Property<std::string> GlobalSim::eEmMultTestBench::m_tobs_fileName

private

Initial value:

{this,
            "tobs_fileName",
            {"GlobalSimulation/eEmMultTest_tobs.txt"},
            "name of file with Global Sim eEmTOB data"}

Definition at line 69 of file eEmMultTestBench.h.

                   {this,
            "tobs_fileName",
            {"GlobalSimulation/eEmMultTest_tobs.txt"},
            "name of file with Global Sim eEmTOB data"};

◆ 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

◆ eEmMultTestBench()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ initialize()

◆ inputHandles()

◆ make_tob()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ TIPword_from_file()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_eEmTOBContainer_WriteKey

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_TIPword_fileName

◆ m_TIPword_stream

◆ m_TIPword_WriteKey

◆ m_tob_stream

◆ m_tobs_fileName

◆ m_varHandleArraysDeclared

◆ m_vhka