include/k4Interface/ISimG4GflashTool.h

0001 /*
0002  * Copyright (c) 2014-2024 Key4hep-Project.
0003  *
0004  * This file is part of Key4hep.
0005  * See https://key4hep.github.io/key4hep-doc/ for further info.
0006  *
0007  * Licensed under the Apache License, Version 2.0 (the "License");
0008  * you may not use this file except in compliance with the License.
0009  * You may obtain a copy of the License at
0010  *
0011  *     http://www.apache.org/licenses/LICENSE-2.0
0012  *
0013  * Unless required by applicable law or agreed to in writing, software
0014  * distributed under the License is distributed on an "AS IS" BASIS,
0015  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
0016  * See the License for the specific language governing permissions and
0017  * limitations under the License.
0018  */
0019 #ifndef SIMG4INTERFACE_ISIMG4GFLASHTOOL_H
0020 #define SIMG4INTERFACE_ISIMG4GFLASHTOOL_H
0021
0022 // Gaudi
0023 #include "GaudiKernel/IAlgTool.h"
0024
0025 // Geant
0026 #include "GVFlashShowerParameterisation.hh"
0027
0028 /** @class ISimG4GflashTool SimG4Interface/SimG4Interface/ISimG4GflashTool.h ISimG4GflashTool.h
0029  *
0030  *  Interface to the Gflash parametrisation tool.
0031  *  It returns the parametrisation that should be attached to the GFlashShowerModel.
0032  *
0033  *  @author Anna Zaborowska
0034  */
0035
0036 class ISimG4GflashTool : virtual public IAlgTool {
0037 public:
0038   DeclareInterfaceID(ISimG4GflashTool, 1, 0);
0039
0040   /**  Get the parametrisation
0041    *   @return unique pointer to the parametrisation
0042    */
0043   virtual std::unique_ptr<GVFlashShowerParameterisation> parametrisation() = 0;
0044 };
0045 #endif /* SIMG4INTERFACE_ISIMG4GFLASHTOOL_H */