skip_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 skip data record processing module.
 *
 */

#ifndef DPP_SKIP_MODULE_H
#define DPP_SKIP_MODULE_H 1

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

namespace dpp {

  class skip_module
    : public base_module
  {
  public:

    enum mode_type
      {
        SKIP_MODE_INVALID  = 0,
        SKIP_MODE_INTERVAL = 1,
        MODE_DEFAULT = SKIP_MODE_INTERVAL
      };

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

    virtual ~skip_module();

    virtual void initialize(const ::datatools::properties & /* config_ */,
                            datatools::service_manager & /* service_mgr_ */,
                            dpp::module_handle_dict_type & /* modules_map_ */);

    virtual void reset();

    virtual process_status process(::datatools::things & /* data_ */);

    struct module_entry
    {
      std::string        label;
      module_handle_type handle;
    };

    int get_first() const;

    int get_last() const;

    bool is_inverted() const;

    void set_first_last(int first_,
                        int last_,
                        bool inverted_ = false);

    void set_first_number(int first_,
                          int number_,
                          bool inverted_ = false);

  protected:

    void _set_defaults();

  private:

    module_entry       _module_;   
    int                _counter_;  
    int                _first_; 
    int                _last_; 
    bool               _inverted_; 

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

  };

}  // end of namespace dpp

#endif // DPP_SKIP_MODULE_H

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