Structured initializer for Parameter. More...

#include "parameter.hh"

Public Types
using	InitialVal = ParamInitialVal

using	ExtraVals = ParamExtraVals

Public Member Functions
String	fetch (const String &key) const

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

Public Attributes
String	ident
	Identifier used for serialization (can be derived from untranslated label).

String	label
	Preferred user interface name.

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

InitialVal	initial
	Initial value for float, int, choice types.

String	unit
	Units of the values within range.

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

String	hints
	Hints for parameter handling.

StringS	metadata
	Array of "key=value" pairs.

Static Public Attributes
static const String	STORAGE

static const String	STANDARD

Detailed Description

Structured initializer for Parameter.

Definition at line 31 of file parameter.hh.

Member Typedef Documentation

◆ ExtraVals

using Ase::Param::ExtraVals = ParamExtraVals

Definition at line 33 of file parameter.hh.

◆ InitialVal

using Ase::Param::InitialVal = ParamInitialVal

Definition at line 32 of file parameter.hh.

Member Function Documentation

◆ fetch()

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

Definition at line 15 of file parameter.cc.

◆ store()

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

Definition at line 21 of file parameter.cc.

Member Data Documentation

◆ extras

ExtraVals Ase::Param::extras

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

Definition at line 39 of file parameter.hh.

◆ hints

String Ase::Param::hints

Hints for parameter handling.

Definition at line 40 of file parameter.hh.

◆ ident

String Ase::Param::ident

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

Definition at line 34 of file parameter.hh.

◆ initial

InitialVal Ase::Param::initial

Initial value for float, int, choice types.

Definition at line 37 of file parameter.hh.

◆ label

String Ase::Param::label

Preferred user interface name.

Definition at line 35 of file parameter.hh.

◆ metadata

StringS Ase::Param::metadata

Array of "key=value" pairs.

Definition at line 41 of file parameter.hh.

◆ nick

String Ase::Param::nick

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

Definition at line 36 of file parameter.hh.

◆ STANDARD

const String Ase::Param::STANDARD

static

Definition at line 45 of file parameter.hh.

◆ STORAGE

const String Ase::Param::STORAGE

static

Definition at line 44 of file parameter.hh.

◆ unit

String Ase::Param::unit

Units of the values within range.

Definition at line 38 of file parameter.hh.

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

ase/parameter.hh
ase/parameter.cc

Public Types

Public Member Functions

Public Attributes

Static Public Attributes