cut_tools.h

Go to the documentation of this file.

/* Author(s)     : Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date : 2011-06-07
 * Last modified : 2013-03-22
 *
 * 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:
 *
 *   Typedefs for the cut factory/manager.
 *
 * History:
 *
 */

#ifndef CUTS_CUT_TOOLS_H
#define CUTS_CUT_TOOLS_H 1

// Standard library:
#include <iostream>
#include <string>
#include <map>
#include <exception>

// Third party:
// - Boost:
#include <boost/scoped_ptr.hpp>
// - Bayeux/datatools:
#include <datatools/handle.h>
#include <datatools/i_tree_dump.h>
#include <datatools/properties.h>
#include <datatools/bit_mask.h>

namespace datatools {
  // Forward declarations:
  class properties;
  class service_manager;
}

namespace cuts {

  enum selection_result_type {
    SELECTION_INAPPLICABLE = -1, 
    SELECTION_REJECTED     =  0, 
    SELECTION_ACCEPTED     =  1  
  };

  // Forward declarations:
  class i_cut;
  class cut_manager;

  typedef datatools::handle<i_cut> cut_handle_type;

  class cut_entry_type : public datatools::i_tree_dumpable
  {
  public:

    enum status_type {
      STATUS_BLANK       = 0,
      STATUS_CREATED     = datatools::bit_mask::bit00,
      STATUS_INITIALIZED = datatools::bit_mask::bit01
    };

    const datatools::properties & get_cut_config() const;

    datatools::properties & grab_cut_config();

    void set_cut_config(const datatools::properties &);

    const std::string & get_cut_name() const;

    void set_cut_name(const std::string &);

    const std::string & get_cut_id() const;

    void set_ptr(i_cut *);

    void set_cut_id(const std::string &);

    bool has_manager() const;

    void set_manager(cut_manager &);

    void set_blank();

    void set_created();

    void set_initialized();

    void set_uninitialized();

    bool is_created() const;

    bool is_initialized() const;

    cut_entry_type();

    bool has_cut() const;

    const i_cut & get_cut() const;

    i_cut & grab_cut();

    const cut_handle_type & get_cut_handle() const;

    cut_handle_type & grab_cut_handle();

    cut_handle_type & grab_initialized_cut_handle();

    virtual void tree_dump(std::ostream & out_         = std::clog,
                           const std::string & title_  = "",
                           const std::string & indent_ = "",
                           bool inherit_               = false) const;

  private:

    std::string           _cut_name_;   
    std::string           _cut_id_;     
    datatools::properties _cut_config_; 
    uint32_t              _cut_status_; 
    cut_handle_type       _cut_handle_; 
    cut_manager *         _manager_;    

    friend class cut_manager;

  };

  typedef std::map<std::string, cut_entry_type> cut_handle_dict_type;

  typedef std::vector<std::string> ordered_cut_list_type;

} // end of cuts

#endif // CUTS_CUT_TOOLS_H

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