Skip to content

Struct Ase::Param

ClassList > Ase > Param

Structured initializer for Parameter .

  • #include <parameter.hh>

Public Types

Type Name
typedef ParamExtraVals ExtraVals
typedef ParamInitialVal InitialVal

Public Attributes

Type Name
ExtraVals extras
Min, max, stepping for double ranges or array of choices to select from.
String hints
Hints for parameter handling.
String ident
Identifier used for serialization (can be derived from untranslated label).
InitialVal initial = = 0
Initial value for float, int, choice types.
String label
Preferred user interface name.
StringS metadata
Array of "key=value" pairs.
String nick
Abbreviated user interface name, usually not more than 6 characters.
String unit
Units of the values within range.

Public Static Attributes

Type Name
const String STANDARD = = ":r:w:S:G:"
const String STORAGE = = ":r:w:S:"

Public Functions

Type Name
String fetch (const String & key) const
void store (const String & key, const String & v)

Public Types Documentation

typedef ExtraVals

using Ase::Param::ExtraVals =  ParamExtraVals;

typedef InitialVal

using Ase::Param::InitialVal =  ParamInitialVal;

Public Attributes Documentation

variable extras

ExtraVals Ase::Param::extras;

variable hints

String Ase::Param::hints;

variable ident

String Ase::Param::ident;

variable initial

InitialVal Ase::Param::initial;

variable label

String Ase::Param::label;

variable metadata

StringS Ase::Param::metadata;

variable nick

String Ase::Param::nick;

variable unit

String Ase::Param::unit;

Public Static Attributes Documentation

variable STANDARD

const String Ase::Param::STANDARD;

variable STORAGE

const String Ase::Param::STORAGE;

Public Functions Documentation

function fetch

inline String Ase::Param::fetch (
    const String & key
) const

function store

inline void Ase::Param::store (
    const String & key,
    const String & v
) 


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