Entropy Piano Tuner  1.1.3 (documentation not yet complete)
An open-source experimental software for piano tuning by entropy minimization
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Types | Public Member Functions | Private Attributes | List of all members
AlgorithmParameter Class Reference

#include <algorithmparameter.h>

Public Types

enum  Type { TYPE_DOUBLE, TYPE_INT, TYPE_LIST }
 
using StringParameterList = std::vector< std::pair< std::string, std::string > >
 

Public Member Functions

 AlgorithmParameter (const std::string &id, const std::string &label, const std::string &description, double defaultValue, double minValue, double maxValue, int precision=-1)
 
 AlgorithmParameter (const std::string &id, const std::string &label, const std::string &description, int defaultValue, int minValue, int maxValue)
 
 AlgorithmParameter (const std::string &id, const std::string &label, const std::string &description, const std::string &defaultValue, const StringParameterList &list)
 
 ~AlgorithmParameter ()
 
const std::string & getID () const
 
const std::string & getLabel () const
 
const std::string & getDescription () const
 
Type getType () const
 
double getDoubleDefaultValue () const
 
double getDoubleMinValue () const
 
double getDoubleMaxValue () const
 
int getDoublePrecision () const
 
int getIntDefaultValue () const
 
int getIntMinValue () const
 
int getIntMaxValue () const
 
const std::string & getStringDefaultValue () const
 
const StringParameterList & getStringList () const
 

Private Attributes

const Type mParameterType
 
const std::string mID
 
const std::string mLabel
 
const std::string mDescription
 
const double mDoubleDefaultValue = 0
 
const double mDoubleMinValue = 0
 
const double mDoubleMaxValue = 0
 
const int mDoublePrecision = 1
 
const int mIntDefaultValue = 0
 
const int mIntMinValue = 0
 
const int mIntMaxValue = 0
 
const std::string mStringDefaultValue
 
const StringParameterList mStringList
 

Detailed Description

Definition at line 26 of file algorithmparameter.h.

Member Typedef Documentation

using AlgorithmParameter::StringParameterList = std::vector<std::pair<std::string, std::string> >

Definition at line 29 of file algorithmparameter.h.

Member Enumeration Documentation

enum AlgorithmParameter::Type
Enumerator
TYPE_DOUBLE 
TYPE_INT 
TYPE_LIST 

Definition at line 31 of file algorithmparameter.h.

Constructor & Destructor Documentation

AlgorithmParameter::AlgorithmParameter ( const std::string &  id,
const std::string &  label,
const std::string &  description,
double  defaultValue,
double  minValue,
double  maxValue,
int  precision = -1 
)

Definition at line 22 of file algorithmparameter.cpp.

AlgorithmParameter::AlgorithmParameter ( const std::string &  id,
const std::string &  label,
const std::string &  description,
int  defaultValue,
int  minValue,
int  maxValue 
)

Definition at line 40 of file algorithmparameter.cpp.

AlgorithmParameter::AlgorithmParameter ( const std::string &  id,
const std::string &  label,
const std::string &  description,
const std::string &  defaultValue,
const StringParameterList &  list 
)

Definition at line 56 of file algorithmparameter.cpp.

AlgorithmParameter::~AlgorithmParameter ( )

Definition at line 70 of file algorithmparameter.cpp.

Member Function Documentation

const std::string& AlgorithmParameter::getDescription ( ) const
inline

Definition at line 66 of file algorithmparameter.h.

double AlgorithmParameter::getDoubleDefaultValue ( ) const
inline

Definition at line 69 of file algorithmparameter.h.

double AlgorithmParameter::getDoubleMaxValue ( ) const
inline

Definition at line 71 of file algorithmparameter.h.

double AlgorithmParameter::getDoubleMinValue ( ) const
inline

Definition at line 70 of file algorithmparameter.h.

int AlgorithmParameter::getDoublePrecision ( ) const
inline

Definition at line 72 of file algorithmparameter.h.

const std::string& AlgorithmParameter::getID ( ) const
inline

Definition at line 64 of file algorithmparameter.h.

int AlgorithmParameter::getIntDefaultValue ( ) const
inline

Definition at line 74 of file algorithmparameter.h.

int AlgorithmParameter::getIntMaxValue ( ) const
inline

Definition at line 76 of file algorithmparameter.h.

int AlgorithmParameter::getIntMinValue ( ) const
inline

Definition at line 75 of file algorithmparameter.h.

const std::string& AlgorithmParameter::getLabel ( ) const
inline

Definition at line 65 of file algorithmparameter.h.

const std::string& AlgorithmParameter::getStringDefaultValue ( ) const
inline

Definition at line 78 of file algorithmparameter.h.

const StringParameterList& AlgorithmParameter::getStringList ( ) const
inline

Definition at line 79 of file algorithmparameter.h.

Type AlgorithmParameter::getType ( ) const
inline

Definition at line 67 of file algorithmparameter.h.

Member Data Documentation

const std::string AlgorithmParameter::mDescription
private

Definition at line 86 of file algorithmparameter.h.

const double AlgorithmParameter::mDoubleDefaultValue = 0
private

Definition at line 88 of file algorithmparameter.h.

const double AlgorithmParameter::mDoubleMaxValue = 0
private

Definition at line 90 of file algorithmparameter.h.

const double AlgorithmParameter::mDoubleMinValue = 0
private

Definition at line 89 of file algorithmparameter.h.

const int AlgorithmParameter::mDoublePrecision = 1
private

Definition at line 91 of file algorithmparameter.h.

const std::string AlgorithmParameter::mID
private

Definition at line 83 of file algorithmparameter.h.

const int AlgorithmParameter::mIntDefaultValue = 0
private

Definition at line 93 of file algorithmparameter.h.

const int AlgorithmParameter::mIntMaxValue = 0
private

Definition at line 95 of file algorithmparameter.h.

const int AlgorithmParameter::mIntMinValue = 0
private

Definition at line 94 of file algorithmparameter.h.

const std::string AlgorithmParameter::mLabel
private

Definition at line 85 of file algorithmparameter.h.

const Type AlgorithmParameter::mParameterType
private

Definition at line 82 of file algorithmparameter.h.

const std::string AlgorithmParameter::mStringDefaultValue
private

Definition at line 97 of file algorithmparameter.h.

const StringParameterList AlgorithmParameter::mStringList
private

Definition at line 98 of file algorithmparameter.h.

The documentation for this class was generated from the following files: