dummy_module.h

Go to the documentation of this file.

/* Author(s)     : Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date : 2011-06-19
 * Last modified : 2013-12-13
 *
 * Copyright (C) 2011-2013 Francois Mauger <mauger@lpccaen.in2p3.fr>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or (at
 * your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 *
 *
 * Description:
 *
 *   A dummy data processing module.
 *
 */

#ifndef DPP_DUMMY_MODULE_H
#define DPP_DUMMY_MODULE_H 1

// Standard library:
#include <string>

// This project:
#include <dpp/base_module.h>

namespace dpp {


  class dummy_module
    : public base_module
  {
  public:

    static const std::string & default_gp_label();
    static const std::string & default_flag_name();

    void set_flag_name(const std::string & flag_name_);

    const std::string & get_flag_name() const;

    void set_GP_label(const std::string & gp_label_);

    const std::string & get_GP_label() const;

    dummy_module(datatools::logger::priority = datatools::logger::PRIO_FATAL);

    virtual ~dummy_module();

    virtual void initialize(const datatools::properties & properties_,
                            datatools::service_manager & srv_mgr_,
                            module_handle_dict_type & mod_dict_);

    virtual void reset();

    virtual process_status process(datatools::things & data_record_);

  private:

    std::string _GP_label_;  
    std::string _flag_name_; 

    // Macro to automate the registration of the module :
    DPP_MODULE_REGISTRATION_INTERFACE(dummy_module)

  };

}  // end of namespace dpp

#endif // DPP_DUMMY_MODULE_H

// Local Variables: --
// mode: c++ --
// c-file-style: "gnu" --
// tab-width: 2 --
// End: --