Anklang C++ API 0.0.0
Loading...
Searching...
No Matches
Param

#include "parameter.hh"

Public Types

usingExtraVals = ParamExtraVals
usingInitialVal = ParamInitialVal

Public Member Functions

Stringfetch (const String &key) const
voidstore (const String &key, const String &v)

Public Attributes

ExtraValsextras
Stringhints
Stringident
InitialValinitial
Stringlabel
StringSmetadata
Stringnick
Stringunit

Static Public Attributes

static const StringSTANDARD
static const StringSTORAGE

Detailed Description

Structured initializer for Parameter.

Member Typedef Documentation

InitialVal

ExtraVals

Member Function Documentation

fetch()

String fetch ( const String & key) const

store()

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

Member Data Documentation

ident

String ident

Identifier used for serialization (can be derived from untranslated label).

label

String label

Preferred user interface name.

nick

String nick

Abbreviated user interface name, usually not more than 6 characters.

initial

InitialVal initial

Initial value for float, int, choice types.

unit

String unit

Units of the values within range.

extras

ExtraVals extras

Min, max, stepping for double ranges or array of choices to select from.

hints

String hints

Hints for parameter handling.

metadata

StringS metadata

Array of "key=value" pairs.

STORAGE

const String STORAGE
static

STANDARD

const String STANDARD
static