AbsValueOrQuantile.hpp

#pragma once
 
//OPALS
#include "opals/config.hpp"
#include "opals/String.hpp"
#include "opals/CustomOptionType.hpp"
 
namespace opals
{
  /// \brief  AbsValueOrQuantile provides a container to either store an absolute value or a realtive quantile, percentage value.
  ///
  ///           
  /// \author JO
  /// \date   17.03.2022
  class OPALS_API AbsValueOrQuantile : public CustomOptionType<AbsValueOrQuantile>
  {
  public:
    AbsValueOrQuantile();
    AbsValueOrQuantile(const opals::String &rep);
    AbsValueOrQuantile(double val, bool isAbsValue = true);
    virtual ~AbsValueOrQuantile();
 
    bool isEmpty() const;
    bool isAbsValue() const;
    bool isQuantile() const;
 
    double    getAbsValue() const;        ///< get absolute value
    double    getQuantile() const;        ///< get quantile value
    double    getPercentage() const;      ///< get quantile value as percentage
 
    void reset();
 
    void setAbsValue(const double& value);
    void setQuantile(const double& quantile);
    void setPercentage(const double& percentage);
 
    // output functions
    //String logAbsValueOrQuantile() const;   ///< for xml output
    //String printAttributeDescription() const; ///< for log output (in more readable format)
 
    bool operator==(const AbsValueOrQuantile &ref) const;
    bool operator!=(const AbsValueOrQuantile &ref) const;
 
    static const char* help(bool);
    static const char* syntax();
    static bool exportsPythonType();
 
  private:
      double    absValue;
      double    quantile;
  };
}