face_identifier.h

Go to the documentation of this file.

/* Author(s):     François Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2015-03-16
 * Last modified: 2016-11-12
 *
 * License: GPL3
 *
 * Description:
 *
 *  The identifier of a face in a simple or composite shape
 *
 */

#ifndef GEOMTOOLS_FACE_IDENTIFIER_H
#define GEOMTOOLS_FACE_IDENTIFIER_H 1

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

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

namespace geomtools {

  class face_identifier
    : public datatools::i_tree_dumpable
  {
  public:

    enum mode_type {
      MODE_FACE_INVALID = 0x0,                             
      MODE_FACE_BITS    = datatools::bit_mask::bit00,      
      MODE_FACE_INDEX   = datatools::bit_mask::bit01,      
      MODE_FACE_ANY     = MODE_FACE_BITS | MODE_FACE_INDEX 
    };

    static const uint32_t FACE_BITS_NONE  = 0x0;        
    static const uint32_t FACE_BITS_ANY   = 0xFFFFFFFF; 

    // Range [0,1,2.... MAX, ANY, NONE]
    static const uint32_t FACE_INDEX_NONE = 0xFFFFFFFF; 
    static const uint32_t FACE_INDEX_MIN  = 0;          
    static const uint32_t FACE_INDEX_MAX  = 0xFFFFFFFD; 
    static const uint32_t FACE_INDEX_ANY  = 0xFFFFFFFE; 

    // Range [0,1,2.... MAX, ANY, NONE]
    static const uint32_t PART_INDEX_NONE = 0xFFFFFFFF; 
    static const uint32_t PART_INDEX_MIN  = 0;          
    static const uint32_t PART_INDEX_DEFAULT = PART_INDEX_MIN; 
    static const uint32_t PART_INDEX_MAX  = 0xFFFFFFFD; 
    static const uint32_t PART_INDEX_ANY  = 0xFFFFFFFE; 

    face_identifier();

    face_identifier(uint32_t face_info_, mode_type mode_ = MODE_FACE_BITS);

    bool is_valid() const;

    bool is_ok() const;

    bool is_unique() const;

    bool is_many() const;

    bool is_none() const;

    void invalidate();

    void reset();

    mode_type get_mode() const;

    bool has_mode() const;

    bool is_face_bits_mode() const;

    bool is_face_index_mode() const;

    uint32_t get_parts_depth() const;

    bool has_parts() const;

    bool has_part(unsigned int depth_) const;

    bool is_invalid_part(unsigned int depth_) const;

    bool is_any_part(unsigned int depth_) const;

    bool match_part(unsigned int depth_, uint32_t part_) const;

    void reset_part(unsigned int depth_);

    void set_any_part(unsigned int depth_);

    void set_any_parts();

    void set_part(unsigned int depth_, uint32_t);

    uint32_t get_part(unsigned int depth_) const;

    void prepend_part(uint32_t part_);

    void append_part(uint32_t part_);

    void append_parts(const std::vector<uint32_t> & parts_);

    bool can_inherit_parts(unsigned int depth_ = 1) const;

    void inherit_parts(face_identifier & fid_, unsigned int depth_ = 1) const;

    const std::vector<uint32_t> & get_parts() const;

    bool is_face_bits_valid() const;

    void set_face_bits_any();

    bool is_face_bits_any() const;

    bool has_face_bits(uint32_t) const;

    bool has_face_bit(uint32_t) const;

    void set_face_bits(uint32_t bits_);

    void set_face_bit(uint32_t bit_);

    uint32_t get_face_bits() const;

    void reset_face_bits();

    bool match_face_bits(uint32_t bits_) const;

    void reset_face_index();

    void set_face_index(uint32_t);

    uint32_t get_face_index() const;

    void set_face_index_any();

    bool is_face_index_any() const;

    bool is_face_index_valid() const;

    bool match_face_index(uint32_t index_) const;

    void to_string(std::string & word_) const;

    std::string to_string() const;

    bool parse(const std::string & from_);

    bool match(const face_identifier & fid_) const;

    static const face_identifier & face_bits_any();

    static const face_identifier & face_index_any();

    static const face_identifier & face_invalid();

    friend std::ostream & operator<<(std::ostream & out_, const face_identifier & face_id_);

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

  protected:

    void _set_defaults();

  private:

    mode_type             _mode_;       
    std::vector<uint32_t> _parts_;      
    uint32_t              _face_bits_;  
    uint32_t              _face_index_; 

  };

} // end of namespace geomtools

#endif // GEOMTOOLS_FACE_IDENTIFIER_H

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