Parameter

#include "parameter.hh"

Public Member Functions
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
	Parameter ()=default
	Parameter (const Param &)
	Parameter (const Parameter &)=default
MinMaxStep	range () const
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

Static Public Member Functions
static String	construct_hints (const String &hints, const String &more, double pmin=0, double pmax=0)
static size_t	match_choice (const ChoiceS &choices, const String &text)

Public Attributes
CString	cident

Detailed Description

Structure to provide information about properties or preferences.

Constructor & Destructor Documentation

Parameter() [1/3]

Parameter ( )

default

Parameter() [2/3]

Parameter

(

const Param &

initparam

)

Parameter() [3/3]

Parameter ( const Parameter & )

default

Member Function Documentation

has()

bool has

(

const String &

key

)

const

fetch()

String fetch

(

const String &

key

)

const

store()

void store	(	const String &	key,
		const String &	value
	)

ident()

String ident

(

)

const

label()

String label

(

)

const

nick()

String nick

(

)

const

unit()

String unit

(

)

const

hints()

String hints

(

)

const

blurb()

String blurb

(

)

const

descr()

String descr

(

)

const

group()

String group

(

)

const

initial()

Value initial

(

)

const

has_hint()

bool has_hint

(

const String &

hint

)

const

choices()

ChoiceS choices

(

)

const

metadata()

const StringS metadata

(

)

const

range()

MinMaxStep range

(

)

const

Min, max, stepping for double ranges.

is_numeric()

bool is_numeric

(

)

const

is_choice()

bool is_choice

(

)

const

is_text()

bool is_text

(

)

const

normalize()

double normalize

(

double

val

)

const

rescale()

double rescale

(

double

t

)

const

constrain()

Value constrain

(

const Value &

value

)

const

dconstrain()

double dconstrain

(

const Value &

value

)

const

initialsync()

void initialsync

(

const Value &

v

)

operator=()

Parameter & operator= ( const Parameter & )

default

value_to_text()

String value_to_text

(

const Value &

value

)

const

value_from_text()

Value value_from_text

(

const String &

text

)

const

construct_hints()

String construct_hints ( const String & hints, const String & more, double pmin = 0, double pmax = 0 )

static

match_choice()

size_t match_choice ( const ChoiceS & choices, const String & text )

static

Member Data Documentation

cident

CString cident