src/modules/Dummy/DummyModule.hpp

Definition of [Dummy] module. More…

Namespaces

Name
allpix
Helper class to hold support layers for a detector model.

Classes

Name
class allpix::DummyModule
Module which serves as a demonstrator and wireframe for new modules.

Detailed Description

Definition of [Dummy] module.

Copyright: Copyright (c) 2017-2024 CERN and the Allpix Squared authors. This software is distributed under the terms of the MIT License, copied verbatim in the file “LICENSE.md”. In applying this license, CERN does not waive the privileges and immunities granted to it by virtue of its status as an Intergovernmental Organization or submit itself to any jurisdiction. SPDX-License-Identifier: MIT

Contains minimal dummy module to use as a start for the development of your own module

Please refer to the User Manual for more details on the different files of a module and the methods of the module class..

Source code


#include <string>

#include "core/config/Configuration.hpp"
#include "core/geometry/GeometryManager.hpp"
#include "core/messenger/Messenger.hpp"
#include "core/module/Event.hpp"
#include "core/module/Module.hpp"

#include "objects/PixelHit.hpp"

namespace allpix {
    class DummyModule : public Module {
    public:
        DummyModule(Configuration& config, Messenger* messenger, GeometryManager* geo_manager);

        void initialize() override;

        void run(Event* event) override;

        void finalize() override;

    private:
        // Pointers to the central geometry manager and the messenger for interaction with the framework core:
        GeometryManager* geo_manager_;
        Messenger* messenger_;

        // A local module member variable which is set on the constructor and only read during runtime:
        int setting_{};
    };
} // namespace allpix

Updated on 2025-02-27 at 14:14:46 +0000