AngleType.hpp

#pragma once
 
//OPALS
#include "opals/config.hpp"
#include "opals/String.hpp"
#include "opals/CustomOptionType.hpp"
 
namespace opals
{
  /// \brief  AngleType provides defining angular values in different units (deg, rad, grad and percentage)
  ///
  ///           
  /// \author JO
  /// \date   19.05.2023
  class OPALS_API AngleType : public CustomOptionType<AngleType>
  {
  public:
    AngleType();
    AngleType(const opals::String &rep);
    AngleType(double vale);       ///< set angle in degrees (default)
    virtual ~AngleType();
 
    bool isEmpty() const;
 
    double    getRad() const;       ///< get angle in radiates (0-2*Pi)
    double    getDeg() const;       ///< get angle in degres (0-360)
    double    getGrad() const;      ///< get angle in grads (0-400)
    double    getPerc() const;      ///< get a slope angle in percent (0-infinite)
 
    operator double() const;
 
    void reset();
 
    void setRad(const double& value);
    void setDeg(const double& value);
    void setGrad(const double& value);
    void setPerc(const double& value);
 
    bool operator==(const AngleType &ref) const;
    bool operator!=(const AngleType &ref) const;
 
    static const char* help(bool);
    static const char* syntax();
    static bool exportsPythonType();
 
  private:
      double    angleDeg; ///< internally stores angle value in degrees
  };
}