Struct Ase::Parameter

ClassList > Ase > Parameter

Structure to provide information about properties or preferences.

• #include <parameter.hh>

Public Attributes

Type	Name
CString	cident

Public Functions

Type	Name
	Parameter () = default
	Parameter (const Param & initparam)
	Parameter (const Parameter &) = default
String	blurb () const
ChoiceS	choices () const
Value	constrain (const Value & value) const
double	dconstrain (const Value & value) const
String	descr () const
String	fetch (const String & key) const
String	group () const
bool	has (const String & key) const
bool	has_hint (const String & hint) const
String	hints () const
String	ident () const
Value	initial () const
void	initialsync (const Value & v)
bool	is_choice () const
bool	is_numeric () const
bool	is_text () const
String	label () const
const StringS	metadata () const
String	nick () const
double	normalize (double val) const
Parameter &	operator= (const Parameter &) = default
MinMaxStep	range () const Min, max, stepping for double ranges.
double	rescale (double t) const
void	store (const String & key, const String & value)
String	unit () const
Value	value_from_text (const String & text) const
String	value_to_text (const Value & value) const

Public Static Functions

Type	Name
String	construct_hints (const String & hints, const String & more, double pmin=0, double pmax=0)
size_t	match_choice (const ChoiceS & choices, const String & text)

Public Attributes Documentation

variable cident

CString Ase::Parameter::cident;

---

Public Functions Documentation

function Parameter [1/3]

Ase::Parameter::Parameter () = default

---

function Parameter [2/3]

Ase::Parameter::Parameter (
    const Param & initparam
) 

---

function Parameter [3/3]

Ase::Parameter::Parameter (
    const Parameter &
) = default

---

function blurb

inline String Ase::Parameter::blurb () const

---

function choices

ChoiceS Ase::Parameter::choices () const

---

function constrain

Value Ase::Parameter::constrain (
    const Value & value
) const

---

function dconstrain

double Ase::Parameter::dconstrain (
    const Value & value
) const

---

function descr

inline String Ase::Parameter::descr () const

---

function fetch

String Ase::Parameter::fetch (
    const String & key
) const

---

function group

inline String Ase::Parameter::group () const

---

function has

bool Ase::Parameter::has (
    const String & key
) const

---

function has_hint

bool Ase::Parameter::has_hint (
    const String & hint
) const

---

function hints

inline String Ase::Parameter::hints () const

---

function ident

inline String Ase::Parameter::ident () const

---

function initial

inline Value Ase::Parameter::initial () const

---

function initialsync

void Ase::Parameter::initialsync (
    const Value & v
) 

---

function is_choice

inline bool Ase::Parameter::is_choice () const

---

function is_numeric

bool Ase::Parameter::is_numeric () const

---

function is_text

inline bool Ase::Parameter::is_text () const

---

function label

inline String Ase::Parameter::label () const

---

function metadata

inline const StringS Ase::Parameter::metadata () const

---

function nick

String Ase::Parameter::nick () const

---

function normalize

double Ase::Parameter::normalize (
    double val
) const

---

function operator=

Parameter & Ase::Parameter::operator= (
    const Parameter &
) = default

---

function range

MinMaxStep Ase::Parameter::range () const

---

function rescale

double Ase::Parameter::rescale (
    double t
) const

---

function store

void Ase::Parameter::store (
    const String & key,
    const String & value
) 

---

function unit

inline String Ase::Parameter::unit () const

---

function value_from_text

Value Ase::Parameter::value_from_text (
    const String & text
) const

---

function value_to_text

String Ase::Parameter::value_to_text (
    const Value & value
) const

---

Public Static Functions Documentation

function construct_hints

static String Ase::Parameter::construct_hints (
    const String & hints,
    const String & more,
    double pmin=0,
    double pmax=0
) 

---

function match_choice

static size_t Ase::Parameter::match_choice (
    const ChoiceS & choices,
    const String & text
) 

---

---

The documentation for this class was generated from the following file /__w/anklang/anklang/ase/parameter.hh