UserActionToolBase.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2017 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef G4ATLASTOOLS_USERACTIONTOOLBASE_H
#define G4ATLASTOOLS_USERACTIONTOOLBASE_H
 
// System includes
#include <memory>
 
// Framework includes
#include "AthenaBaseComps/AthAlgTool.h"
#include <GaudiKernel/StatusCode.h>
 
// G4Atlas includes
#include "G4AtlasInterfaces/IUserActionTool.h"
#include "HitManagement/HitCollectionMap.h"
 
// Local includes
#include "ThreadSpecificUserAction.h"
 
 
namespace G4UA
{

  template <class ActionType>
  class UserActionToolBase : public extends<AthAlgTool, IUserActionTool>
  {
 
    public:

      UserActionToolBase(const std::string& type, const std::string& name,
                         const IInterface* parent)
        : base_class(type, name, parent)
      {}

      virtual StatusCode
      fillUserAction(G4AtlasUserActions& actionLists) override final
      {
        auto myAction = makeAndFillAction(actionLists);
        if(myAction == nullptr) {
          ATH_MSG_ERROR( "Failed to construct user action in " << name() );
          return StatusCode::FAILURE;
        }
        m_actions.set( std::move(myAction) );
        return StatusCode::SUCCESS;
      }

    StatusCode BeginOfAthenaEvent(HitCollectionMap&) override {return StatusCode::SUCCESS;};
    StatusCode EndOfAthenaEvent(HitCollectionMap&) override {return StatusCode::SUCCESS;};
 
    protected:

      virtual std::unique_ptr<ActionType>
      makeAndFillAction(G4AtlasUserActions& actionLists) = 0;

      ThreadSpecificUserAction<ActionType> m_actions;
 
  }; // UserActionToolBase
 
} // namespace G4UA
 
#endif // G4ATLASTOOLS_USERACTIONTOOLBASE_H