Structure to provide information about properties or preferences. More...

#include "parameter.hh"

Public Member Functions
bool	has (const String &key) const

String	fetch (const String &key) const

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

String	ident () const

String	label () const

String	nick () const

String	unit () const

String	hints () const

String	blurb () const

String	descr () const

String	group () const

Value	initial () const

bool	has_hint (const String &hint) const

ChoiceS	choices () const

const StringS	metadata () const

MinMaxStep	range () const
	Min, max, stepping for double ranges.

bool	is_numeric () const

bool	is_choice () const

bool	is_text () const

double	normalize (double val) const

double	rescale (double t) const

Value	constrain (const Value &value) const

double	dconstrain (const Value &value) const

void	initialsync (const Value &v)

	Parameter (const Param &)

	Parameter (const Parameter &)=default

Parameter &	operator= (const Parameter &)=default

String	value_to_text (const Value &value) const

Value	value_from_text (const String &text) 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.

Definition at line 49 of file parameter.hh.

Constructor & Destructor Documentation

◆ Parameter()

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

Definition at line 331 of file parameter.cc.

Member Function Documentation

◆ blurb()

String Ase::Parameter::blurb ( ) const

Definition at line 59 of file parameter.hh.

◆ choices()

ChoiceS Ase::Parameter::choices ( ) const

Definition at line 124 of file parameter.cc.

◆ constrain()

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

Definition at line 202 of file parameter.cc.

◆ construct_hints()

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

static

Definition at line 57 of file parameter.cc.

◆ dconstrain()

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

Definition at line 223 of file parameter.cc.

◆ descr()

String Ase::Parameter::descr ( ) const

Definition at line 60 of file parameter.hh.

◆ fetch()

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

Definition at line 94 of file parameter.cc.

◆ group()

String Ase::Parameter::group ( ) const

Definition at line 61 of file parameter.hh.

◆ has()

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

Definition at line 88 of file parameter.cc.

◆ has_hint()

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

Definition at line 149 of file parameter.cc.

◆ hints()

String Ase::Parameter::hints ( ) const

Definition at line 58 of file parameter.hh.

◆ ident()

String Ase::Parameter::ident ( ) const

Definition at line 54 of file parameter.hh.

◆ initial()

Value Ase::Parameter::initial ( ) const

Definition at line 62 of file parameter.hh.

◆ initialsync()

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

Definition at line 143 of file parameter.cc.

◆ is_choice()

bool Ase::Parameter::is_choice ( ) const

Definition at line 68 of file parameter.hh.

◆ is_numeric()

bool Ase::Parameter::is_numeric ( ) const

Definition at line 134 of file parameter.cc.

◆ is_text()

bool Ase::Parameter::is_text ( ) const

Definition at line 69 of file parameter.hh.

◆ label()

String Ase::Parameter::label ( ) const

Definition at line 55 of file parameter.hh.

◆ match_choice()

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

static

Definition at line 182 of file parameter.cc.

◆ metadata()

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

Definition at line 65 of file parameter.hh.

◆ nick()

String Ase::Parameter::nick ( ) const

Definition at line 79 of file parameter.cc.

◆ normalize()

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

Definition at line 162 of file parameter.cc.

◆ range()

MinMaxStep Ase::Parameter::range ( ) const

Min, max, stepping for double ranges.

Definition at line 113 of file parameter.cc.

◆ rescale()

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

Definition at line 173 of file parameter.cc.

◆ store()

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

Definition at line 101 of file parameter.cc.

◆ unit()

String Ase::Parameter::unit ( ) const

Definition at line 57 of file parameter.hh.

◆ value_from_text()

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

Definition at line 409 of file parameter.cc.

◆ value_to_text()

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

Definition at line 375 of file parameter.cc.

Member Data Documentation

◆ cident

CString Ase::Parameter::cident

Definition at line 50 of file parameter.hh.

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

ase/parameter.hh
ase/parameter.cc

Public Member Functions

Static Public Member Functions

Public Attributes