vertex_validation.h

Go to the documentation of this file.

/* Author(s) : Xavier Garrido <garrido@lal.in2p3.fr>
 *             Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2014-07-06
 * Last modified: 2014-07-13
 *
 * License: GPL 3.0
 *
 * Description:
 *
 * History:
 *
 */

#ifndef GENVTX_VERTEX_VALIDATION_H
#define GENVTX_VERTEX_VALIDATION_H 1

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

// Third party:
// - Boost:
#include <boost/scoped_ptr.hpp>
// - Bayeux/datatools:
#include <datatools/logger.h>
#include <datatools/i_tree_dump.h>
#include <datatools/object_configuration_description.h>
// - Bayeux/geomtools:
#include <geomtools/utils.h>

namespace datatools {
  // Forward declaration:
  class properties;
}

namespace cuts {
  // Forward declaration:
  class i_cut;
}

namespace geomtools {
  // Forward declarations:
  class logical_volume;
  class geom_info;
  class geom_id;
}

namespace genvtx {

  class vertex_validation : public datatools::i_tree_dumpable
  {
  public:


    class geometry_context {
    public:

      bool has_ginfo() const;

      bool has_gid() const;

      bool has_logical_volume() const;

      bool has_local_candidate_vertex() const;

      bool has_global_candidate_vertex() const;

      const geomtools::geom_info & get_ginfo() const;

      const geomtools::geom_id & get_gid() const;

      const geomtools::logical_volume & get_logical_volume() const;

      void set_ginfo(const geomtools::geom_info &);

      void set_gid(const geomtools::geom_id &);

      void set_logical_volume(const geomtools::logical_volume &);

      const geomtools::vector_3d & get_local_candidate_vertex() const;

      void set_local_candidate_vertex(const geomtools::vector_3d &);

      const geomtools::vector_3d & get_global_candidate_vertex() const;

      void set_global_candidate_vertex(const geomtools::vector_3d &);

      geometry_context();

      void reset();

      bool is_valid() const;

      static datatools::factory_register<cuts::i_cut> & validator_factory_system_register();

    private:

      const geomtools::geom_info * _ginfo_;                   
      const geomtools::geom_id * _gid_;                       
      const geomtools::logical_volume * _log_volume_;         
      const geomtools::vector_3d * _global_candidate_vertex_; 
      geomtools::vector_3d _local_candidate_vertex_;          
    };

    static const size_t DEFAULT_MAX_NUMBER_OF_TRIES = 1000;

    enum validate_status_type {
      VS_UNDEFINED = -1, 
      VS_ACCEPTED  =  0, 
      VS_REJECTED  =  1, 
      VS_MAXTRIES  =  2  
    };

    vertex_validation();

    virtual ~vertex_validation();

    void set_logging_priority(datatools::logger::priority);

    datatools::logger::priority get_logging_priority() const;

    void set_maximum_number_of_tries(const size_t tries_);

    size_t get_maximum_number_of_tries() const;

    bool is_owned_validator() const;

    void set_validator(cuts::i_cut & validator_);

    void set_validator(cuts::i_cut * validator_);

    void reset_validator();

    bool has_validator() const;

    bool is_initialized() const;

    void initialize(const datatools::properties & config_);

    void reset();

    void reset_geometry_context();

    geometry_context & grab_geometry_context();

    const geometry_context & get_geometry_context() const;

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

    validate_status_type validate();

    void reset_number_of_tries();

    size_t get_number_of_tries() const;

    bool is_maximum_number_of_tries_reached() const;

    static void ocd_support(datatools::object_configuration_description &, const std::string & label_ = "");

  private:

    bool                        _initialized_;             //<! Initialization flag
    datatools::logger::priority _logging_;                 //<! Logging priority
    bool                        _owned_validator_;         //<! Flag to own the validator cut (if any)
    cuts::i_cut *               _validator_;               //<! Validator cut
    boost::scoped_ptr<geometry_context> _geo_context_;     //<! Current geometry context
    size_t                      _maximum_number_of_tries_; //<! Maximum number of tries before escaping
    size_t                      _number_of_tries_;         //<! Current number of tries

  };

} // end of namespace genvtx

#endif // GENVTX_VERTEX_VALIDATION_H

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