smart_id_locator.h

Go to the documentation of this file.

/* Author(s):     Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2010-05-30
 * Last modified: 2010-05-30
 *
 * License:
 *
 * Description:
 *   A smart geometry locator based on a geom_map and optimized for fast search
 *
 * History:
 *
 */

#ifndef GEOMTOOLS_SMART_ID_LOCATOR_H
#define GEOMTOOLS_SMART_ID_LOCATOR_H 1

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

// Third party:
// - Boost:
#include <boost/cstdint.hpp>

// This project:
#include <geomtools/i_locator.h>
#include <geomtools/id_selector.h>

namespace geomtools {

  class geom_map;

  class smart_id_locator : public i_locator
  {
  public:

    enum mode_type {
      MODE_INVALID = 0,
      MODE_LAST    = 1,
      MODE_DEFAULT = MODE_LAST
    };

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

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

    bool is_initialized () const;

    void set_gmap (const geom_map & gmap_);

    smart_id_locator ();

    smart_id_locator (const geom_map & gmap_);

    smart_id_locator (const geom_map & gmap_,
                      uint32_t type_,
                      int mode_ = MODE_DEFAULT);

    smart_id_locator (const geom_map & gmap_,
                      const std::string & rules_,
                      int mode_ = MODE_DEFAULT);

    virtual ~smart_id_locator ();

    void initialize (uint32_t type_, int mode_ = MODE_DEFAULT);

    void initialize (const std::string & selection_rules_, int mode_ = MODE_DEFAULT);

    void reset ();

    const std::list<const geom_info *> & get_ginfos () const;

    virtual bool validate_id (const geom_id & id_) const;

    virtual const geom_info & get_geom_info (const geom_id & id_) const;

    virtual const geom_id & get_geom_id (const vector_3d & world_position_,
                                         int type_ = geom_id::INVALID_TYPE,
                                         double tolerance_ = GEOMTOOLS_PROPER_TOLERANCE) const;

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

    void dump(std::ostream & out_ = std::clog) const;

    void print_infos(std::ostream & out_) const;

  protected:

    void _construct ();

  private:

    datatools::logger::priority _logging_priority_; 
    bool              _initialized_; 
    int               _mode_;        
    uint32_t          _type_;        
    id_selector       _idsel_;       
    const geom_map *  _gmap_;        

    // Optimization data
    std::list<const geom_info *> _ginfos_; 
    const geom_info * _last_found_;        

  };

} // end of namespace geomtools

#endif // GEOMTOOLS_SMART_ID_LOCATOR_H

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