geom_id.h

Go to the documentation of this file.

/* Author (s):     Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2010-02-08
 * Last modified: 2013-05-30
 *
 * License:
 *
 * Description:
 *
 *   Geometry ID
 *
 * A geometry ID is composed of two parts:
 * - the 'type' is an integer representing the category of geometry object
 *   each type object in a geometry setup has an unique category, thus a unique TYPE integer
 * - the 'address' is a list of integers representing the path to the object located in
 *   the hierarchy tree of the setup.
 *
 * History:
 *
 */

#ifndef GEOMTOOLS_GEOM_ID_H
#define GEOMTOOLS_GEOM_ID_H 1

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

// Third party:
// - Boost:
#include <boost/cstdint.hpp>
// - Bayeux/datatools :
#include <datatools/i_serializable.h>
#include <datatools/reflection_interface.h>

// This project :
#include <geomtools/geomtools_config.h>

namespace geomtools {

  class geom_id : public datatools::i_serializable
  {
  public:

    static const uint32_t INVALID_TYPE          = 0xFFFFFFFF;
    static const uint32_t INVALID_ADDRESS       = 0xFFFFFFFF;
    static const uint32_t ANY_ADDRESS           = 0xFFFFFFFE;
    static const uint32_t DEFAULT_ADDRESS_DEPTH = 10;
    static const uint32_t UNIVERSE_TYPE         = 0;
    static const uint32_t WORLD_TYPE            = geom_id::UNIVERSE_TYPE;

    static const char IO_ID_OPEN;
    static const char IO_ID_SEPARATOR;
    static const char IO_ADDRESS_SEPARATOR;
    static const char IO_TYPE_INVALID;
    static const char IO_ADDRESS_INVALID;
    static const char IO_ID_CLOSE;
    static const char IO_ADDRESS_ANY;

    bool is_type (uint32_t) const;

    uint32_t get_type () const;

    void set_type (uint32_t);

    void set_depth (uint32_t depth_);

    uint32_t get_depth () const;

    uint32_t get (int) const;

    void set (int, uint32_t val_);

    void set_any (int);

    void set_invalid (int);

    bool is_invalid (int) const;

    bool is_any (int) const;

    void set_address (uint32_t si0_,
                      uint32_t si1_ = INVALID_ADDRESS,
                      uint32_t si2_ = INVALID_ADDRESS,
                      uint32_t si3_ = INVALID_ADDRESS,
                      uint32_t si4_ = INVALID_ADDRESS,
                      uint32_t si5_ = INVALID_ADDRESS,
                      uint32_t si6_ = INVALID_ADDRESS,
                      uint32_t si7_ = INVALID_ADDRESS,
                      uint32_t si8_ = INVALID_ADDRESS,
                      uint32_t si9_ = INVALID_ADDRESS);

    void reset_address ();

    geom_id ();

    geom_id (uint32_t type_,
             uint32_t si0_);

    geom_id (uint32_t type_,
             uint32_t si0_,
             uint32_t si1_);

    geom_id (uint32_t type_,
             uint32_t si0_,
             uint32_t si1_,
             uint32_t si2_);

    geom_id (uint32_t type_,
             uint32_t si0_,
             uint32_t si1_,
             uint32_t si2_,
             uint32_t si3_);

    geom_id (uint32_t type_,
             uint32_t si0_,
             uint32_t si1_,
             uint32_t si2_,
             uint32_t si3_,
             uint32_t si4_,
             uint32_t si5_ = INVALID_ADDRESS,
             uint32_t si6_ = INVALID_ADDRESS,
             uint32_t si7_ = INVALID_ADDRESS,
             uint32_t si8_ = INVALID_ADDRESS,
             uint32_t si9_ = INVALID_ADDRESS);

    virtual ~geom_id ();

    void reset ();

    void invalidate ();

    bool is_valid () const;

    bool is_complete () const;

    void extract_to (geom_id & target_) const;

    void extract_from (const geom_id & source_);

    void inherits_from (const geom_id & source_);

    bool match_impl (const geom_id & id_, bool exact_) const;

    bool match (const geom_id & id_, bool exact_ = false) const;

    static bool match (const geom_id & id1_, const geom_id & id2_,
                       bool exact_ = false);

    static int compare (const geom_id & id1_, const geom_id & id2_);

    bool operator== (const geom_id & id_) const;

    bool operator!= (const geom_id & id_) const;

    bool operator< (const geom_id & id_) const;

    bool operator<= (const geom_id & id_) const;

    bool operator>= (const geom_id & id_) const;

    bool operator> (const geom_id & id_) const;

    friend std::ostream & operator<< (std::ostream & out_, const geom_id & id_);

    friend std::istream & operator>> (std::istream & in_, geom_id & id_);

    void make (int type_, int depth_);

    static void make (geom_id & id_, int type_, int depth_);

    static bool sub_id_comp (uint32_t si1_, uint32_t si2_);

  private:

    uint32_t              _type_;      
    std::vector<uint32_t> _addresses_; 

    DATATOOLS_SERIALIZATION_DECLARATION()

    
    DR_CLASS_RTTI()

  };

} // end of namespace geomtools

#include <boost/serialization/export.hpp>
BOOST_CLASS_EXPORT_KEY2(geomtools::geom_id, "geomtools::geom_id")

//#warning Activate reflection layer for the geomtools::geom_id class
// Activate reflection layer for the geomtools::geom_id class :
DR_CLASS_INIT(::geomtools::geom_id)

// Class version:
#include <boost/serialization/version.hpp>
BOOST_CLASS_VERSION(geomtools::geom_id, 1)

#endif // GEOMTOOLS_GEOM_ID_H

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