angular_range.h

Go to the documentation of this file.

/* Author(s) :    Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2016-03-09
 * Last modified: 2016-03-09
 *
 * License:
 *
 * Description:
 *
 *   Angular range
 *
 * History:
 *
 */

#ifndef GEOMTOOLS_ANGULAR_RANGE_H
#define GEOMTOOLS_ANGULAR_RANGE_H 1

// Standard library:
#include <string>

// Third party:
// - Bayeux/datatools:
#include <datatools/properties.h>
#include <datatools/i_tree_dump.h>
#include <datatools/i_serializable.h>
#include <datatools/object_configuration_description.h>
#include <datatools/ocd_macros.h>

namespace geomtools {

  class angular_range :
    public datatools::i_serializable,
    public datatools::i_tree_dumpable
  {
  public:

    enum range_type {
      RANGE_TYPE_INVALID   = -1, 
      RANGE_TYPE_POLAR     =  0, 
      RANGE_TYPE_AZIMUTHAL =  1  
    };

    static std::string type_to_label(range_type rt_);

    static range_type label_to_type(const std::string &);

    static double min_start_angle(range_type);

    static double max_start_angle(range_type);

    explicit angular_range(range_type rt_ = RANGE_TYPE_INVALID);

    explicit angular_range(const std::string & type_label_);

    angular_range(range_type rt_, double start_angle_, double delta_angle_);

    bool has_type() const;

    void set_type(range_type);

    range_type get_type() const;

    bool is_polar() const;

    bool is_azimuthal() const;

    double get_min_start_angle() const;

    double get_max_start_angle() const;

    bool has_start_angle() const;

    void set_start_angle(double);

    double get_start_angle() const;

    bool has_delta_angle() const;

    void set_delta_angle(double);

    double get_delta_angle() const;

    bool is_partial() const;

    void set_partial_angles(double start_angle_, double delta_angle_);

    void reset_partial_angles();

    double get_first_angle() const;

    double get_last_angle() const;

    double get_angle_spread() const;

    bool contains(double angle_, double tolerance_ = 0.0, bool strict_range_ = false) const;

    bool is_valid() const;

    void invalidate();

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

    void reset();

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

    static void init_ocd(datatools::object_configuration_description &,
                               const std::string & prefix_ = "");

    class iterator :  public datatools::i_tree_dumpable {
    public:

      iterator(const angular_range & ar_, unsigned int nsteps_ = 36);

      unsigned int get_nsamples() const;

      int get_current_step() const;

      double get_current_angle() const;

      bool is_at_first() const;

      bool is_at_last() const;

      bool is_finished() const;

      void set_first();

      void set_last();

      void set_finished();

      void step();

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

      double operator*() const;

      iterator operator++();

      bool operator!() const;

    private:

      const angular_range & _ref_; 
      unsigned int _nsamples_; 
      double _step_angle_; 
      unsigned int _current_step_; 
      double _current_angle_; 

    };

  protected:

    void _set_defaults();

  private:

    range_type _type_;        
    double     _start_angle_; 
    double     _delta_angle_; 

    // Serialization interface:
    DATATOOLS_SERIALIZATION_DECLARATION()

  };

} // end of namespace geomtools

#ifdef __clang__
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wunused-local-typedef"
#endif
#include <boost/serialization/export.hpp>
#ifdef __clang__
#pragma clang diagnostic pop
#endif
BOOST_CLASS_EXPORT_KEY2(geomtools::angular_range, "geomtools::angular_range")

// @param geomtools::angular_range the name the class with registered OCD support
DOCD_CLASS_DECLARATION(geomtools::angular_range)

#endif // GEOMTOOLS_ANGULAR_RANGE_H

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