AbsValueOrQuantile Class Reference

AbsValueOrQuantile provides a container to either store an absolute value or a realtive quantile, percentage value. More...

#include "AbsValueOrQuantile.hpp"

+ Inheritance diagram for AbsValueOrQuantile:

Public Member Functions

 AbsValueOrQuantile (const opals::String &rep)
 
 AbsValueOrQuantile (double val, bool isAbsValue=true)
 
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)
 
bool operator== (const AbsValueOrQuantile &ref) const
 
bool operator!= (const AbsValueOrQuantile &ref) const
 

Static Public Member Functions

static const char * help (bool)
 
static const char * syntax ()
 
static bool exportsPythonType ()
 
- Static Public Member Functions inherited from CustomOptionType< AbsValueOrQuantile >
static const char * _help (bool forDoxygen)
 get general help on this type
 
static const char * _syntax ()
 get the syntax used for parsing this type
 
static bool _exportsPythonType ()
 returns true if this type is exposed to Python as a custom type, false otherwise (if it is represented as Python-string)
 

Additional Inherited Members

- Protected Member Functions inherited from CustomOptionType< AbsValueOrQuantile >
 ~CustomOptionType ()
 protected, must be derived from
 

Detailed Description

AbsValueOrQuantile provides a container to either store an absolute value or a realtive quantile, percentage value.

Author
JO
Date
17.03.2022