HelloAlg Class Reference

#include <HelloAlg.h>

Inheritance diagram for HelloAlg:

Collaboration diagram for HelloAlg:

Public Member Functions
	HelloAlg (const std::string &name, ISvcLocator *pSvcLocator)
virtual StatusCode	initialize () override
virtual StatusCode	execute () override
virtual StatusCode	finalize () 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 std::map< std::string, std::string >	Dict_t
typedef std::vector< std::vector< double > >	Matrix_t
typedef std::vector< std::pair< double, double > >	Table_t
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< int >	m_myInt {this, "MyInt", 0, "An Integer"}
Gaudi::Property< bool >	m_myBool {this, "MyBool", false, "A Bool"}
Gaudi::Property< double >	m_myDouble {this, "MyDouble", 0., "A Double"}
Gaudi::Property< std::vector< std::string > >	m_myStringVec
Gaudi::Property< Dict_t >	m_myDict {this, "MyDict", {}, "A little dictionary"}
Gaudi::Property< Matrix_t >	m_myMatrix
Table_t	m_myTable
ToolHandle< IHelloTool >	m_myPrivateHelloTool
PublicToolHandle< IHelloTool >	m_myPublicHelloTool
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 19 of file HelloAlg.h.

Member Typedef Documentation

Dict_t

typedef std::map<std::string, std::string> HelloAlg::Dict_t

private

Definition at line 36 of file HelloAlg.h.

Matrix_t

typedef std::vector<std::vector<double> > HelloAlg::Matrix_t

private

Definition at line 39 of file HelloAlg.h.

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Table_t

typedef std::vector<std::pair<double, double> > HelloAlg::Table_t

private

Definition at line 44 of file HelloAlg.h.

Constructor & Destructor Documentation

HelloAlg()

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

Definition at line 9 of file HelloAlg.cxx.

    : AthAlgorithm(name, pSvcLocator), m_myTable() {
 
  // override some default values (headers are preferred)
  m_myDict["Bonjour"] = "Guten Tag";
  m_myDict["Good Morning"] = "Bonjour";
  m_myDict["one"] = "uno";
 
  // legacy way of properties (headers are preferred)
  declareProperty("MyTable", m_myTable, "A table of <double,double>");
  // some default values
  m_myTable.push_back(std::make_pair(1., 1.));
  m_myTable.push_back(std::make_pair(2., 2. * 2.));
  m_myTable.push_back(std::make_pair(3., 3. * 3.));
}

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.

{ return m_detStore; }

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.

{ return m_evtStore; }

execute()

StatusCode HelloAlg::execute ( )

overridevirtual

Definition at line 72 of file HelloAlg.cxx.

                             {
  // Print where you are if needed (should never be INFO)
  ATH_MSG_DEBUG("execute()");
 
  // Print out the different levels of messages
  ATH_MSG_DEBUG("A DEBUG message");
  ATH_MSG_INFO("An INFO message");
  ATH_MSG_WARNING("A WARNING message");
  ATH_MSG_ERROR("An ERROR message");
  ATH_MSG_FATAL("A FATAL error message");
 
  // Let publicly declared tool say something
  ATH_MSG_INFO("Let the tool " << m_myPublicHelloTool.propertyName()
                               << " say something:");
  ATH_CHECK(m_myPublicHelloTool->saySomething());
 
  // Let privately declared tool say something
  ATH_MSG_INFO("Let the tool " << m_myPrivateHelloTool.propertyName()
                               << " say something:");
  ATH_CHECK(m_myPrivateHelloTool->saySomething());
 
  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 HelloAlg::finalize ( )

overridevirtual

Definition at line 96 of file HelloAlg.cxx.

                              {
  // Just an example: if there is nothing to be done do not re-implement finalize
  ATH_MSG_DEBUG("finalize()");
 
  return StatusCode::SUCCESS;
}

initialize()

StatusCode HelloAlg::initialize ( )

overridevirtual

Definition at line 25 of file HelloAlg.cxx.

                                {
 
  // Print out the property values
  ATH_MSG_INFO("  MyInt =    " << m_myInt.value() << endmsg
                               << "  MyBool =   " << m_myBool.value() << endmsg
                               << "  MyDouble = " << m_myDouble.value());
 
  for (size_t i = 0; i < m_myStringVec.size(); i++) {
    ATH_MSG_INFO("  MyStringVec[" << i << "] = " << m_myStringVec[i]);
  }
 
  for (const auto &[key, value] : m_myDict) {
    ATH_MSG_INFO("  MyDict['" << key << "'] = '" << value << "'");
  }
  for (const auto &[key, value] : m_myTable) {
    ATH_MSG_INFO("  MyTable['" << key << "'] = '" << value << "'");
  }
  for (size_t row = 0; row < m_myMatrix.size(); row++) {
    msg(MSG::INFO) << "  MyMatrix[" << row << "] = [ ";
    for (double value : m_myMatrix[row]) {
      msg() << value << " ";
    }
    msg() << "]" << endmsg;
  }
 
  ATH_MSG_INFO("  " << m_myPrivateHelloTool.propertyName() << " = "
                    << m_myPrivateHelloTool.type() << endmsg << "  "
                    << m_myPublicHelloTool.propertyName() << " = "
                    << m_myPublicHelloTool.type());
 
  // Part 3: Retrieve the tools using the ToolHandles
  if (m_myPrivateHelloTool.retrieve().isFailure()) {
    ATH_MSG_FATAL(m_myPrivateHelloTool.propertyName()
                  << ": Failed to retrieve tool "
                  << m_myPrivateHelloTool.type());
    return StatusCode::FAILURE;
  } else {
    ATH_MSG_INFO(m_myPrivateHelloTool.propertyName()
                 << ": Retrieved tool " << m_myPrivateHelloTool.type());
  }
 
  // or just use ATH_CHECK to be less verbose
  ATH_CHECK(m_myPublicHelloTool.retrieve());
 
  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.

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_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_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_myBool

Gaudi::Property<bool> HelloAlg::m_myBool {this, "MyBool", false, "A Bool"}

private

Definition at line 30 of file HelloAlg.h.

{this, "MyBool", false, "A Bool"};

m_myDict

Gaudi::Property<Dict_t> HelloAlg::m_myDict {this, "MyDict", {}, "A little dictionary"}

private

Definition at line 37 of file HelloAlg.h.

{this, "MyDict", {}, "A little dictionary"};

m_myDouble

Gaudi::Property<double> HelloAlg::m_myDouble {this, "MyDouble", 0., "A Double"}

private

Definition at line 31 of file HelloAlg.h.

{this, "MyDouble", 0., "A Double"};

m_myInt

Gaudi::Property<int> HelloAlg::m_myInt {this, "MyInt", 0, "An Integer"}

private

Definition at line 29 of file HelloAlg.h.

{this, "MyInt", 0, "An Integer"};

m_myMatrix

Gaudi::Property<Matrix_t> HelloAlg::m_myMatrix

private

Initial value:

{
      this, "MyMatrix", {}, "A matrix of doubles"}

Definition at line 40 of file HelloAlg.h.

                                    {
      this, "MyMatrix", {}, "A matrix of doubles"};

m_myPrivateHelloTool

ToolHandle<IHelloTool> HelloAlg::m_myPrivateHelloTool

private

Initial value:

{
      this, "MyPrivateHelloTool", "HelloTool", "private IHelloTool"}

Definition at line 48 of file HelloAlg.h.

                                             {
      this, "MyPrivateHelloTool", "HelloTool", "private IHelloTool"};

m_myPublicHelloTool

PublicToolHandle<IHelloTool> HelloAlg::m_myPublicHelloTool

private

Initial value:

{
      this, "MyPublicHelloTool", "HelloTool", "public, shared IHelloTool"}

Definition at line 51 of file HelloAlg.h.

                                                  {
      this, "MyPublicHelloTool", "HelloTool", "public, shared IHelloTool"};

m_myStringVec

Gaudi::Property<std::vector<std::string> > HelloAlg::m_myStringVec

private

Initial value:

{
      this, "MyStringVec", {}, "an entire vector of strings"}

Definition at line 33 of file HelloAlg.h.

                                                   {
      this, "MyStringVec", {}, "an entire vector of strings"};

m_myTable

Table_t HelloAlg::m_myTable

private

Definition at line 45 of file HelloAlg.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:

• HelloAlg.h
• HelloAlg.cxx