Abstract base type for Property implementations with Parameter meta data. More...

#include "properties.hh"

Inheritance diagram for Ase::ParameterProperty:

Public Member Functions
String	ident () const override
	Unique name (per owner) of this Property.

String	label () const override
	Preferred user interface name.

String	nick () const override
	Abbreviated user interface name, usually not more than 6 characters.

String	unit () const override
	Units of the values within range.

double	get_min () const override
	Get the minimum property value, converted to double.

double	get_max () const override
	Get the maximum property value, converted to double.

double	get_step () const override
	Get the property value stepping, converted to double.

bool	is_numeric () const override
	Whether the property settings can be represented as a floating point number.

ChoiceS	choices () const override
	Enumerate choices for choosable properties.

void	reset () override
	Assign default as normalized property value.

double	get_normalized () const override
	Get the normalized property value, converted to double.

bool	set_normalized (double v) override
	Set the normalized property value as double.

String	get_text () const override
	Get the current property value, converted to a text String.

bool	set_text (String txt) override
	Set the current property value as a text String.

Value	get_value () const override=0
	Get the native property value.

bool	set_value (const Value &v) override=0
	Set the native property value.

double	get_double () const

ParameterC	parameter () const

Value	initial () const

MinMaxStep	range () const

Public Member Functions inherited from Ase::EmittableImpl
ASE_USE_RESULT Connection	on_event (const String &eventselector, const EventHandler &eventhandler) override

void	emit_event (const String &type, const String &detail, const ValueR fields={}) override

void	emit_notify (const String &detail) override
	Emit `notify:detail`, multiple notifications maybe coalesced if a CoalesceNotifies instance exists.

Public Member Functions inherited from Ase::Emittable
void	js_trigger (const String &eventselector, JsTrigger callback)

Public Member Functions inherited from std::enable_shared_from_this< SharedBase >
T	enable_shared_from_this (T... args)

T	operator= (T... args)

T	shared_from_this (T... args)

T	weak_from_this (T... args)

T	~enable_shared_from_this (T... args)

Public Member Functions inherited from Ase::Property
virtual String	get_name () const

virtual void	set_name (const String &n)

virtual void	set_metadata (const StringS &md)

String	hints () const
	Hints for parameter handling (metadata).

String	blurb () const
	Short description for user interface tooltips (metadata).

String	descr () const
	Elaborate description, e.g. for help dialogs (metadata).

String	group () const
	Group name for parameters of similar function (metadata).

Protected Member Functions
StringS	get_metadata () const override

Protected Attributes
ParameterC	parameter_

Additional Inherited Members
Public Attributes inherited from Ase::Emittable
const EventHandler &	eventhandler

Public Attributes inherited from Ase::Property
Member<&Property::get_name,&Property::set_name >	name

Member<&Property::get_value,&Property::set_value >	value

Member<&Property::get_metadata,&Property::set_metadata >	metadata

Detailed Description

Abstract base type for Property implementations with Parameter meta data.

Definition at line 12 of file properties.hh.

Member Function Documentation

◆ choices()

ChoiceS Ase::ParameterProperty::choices ( ) const

overridevirtual

Enumerate choices for choosable properties.

Implements Ase::Property.

Reimplemented in Ase::PropertyImpl.

Definition at line 25 of file properties.hh.

◆ get_double()

double Ase::ParameterProperty::get_double ( ) const

Definition at line 33 of file properties.hh.

◆ get_max()

double Ase::ParameterProperty::get_max ( ) const

overridevirtual

Get the maximum property value, converted to double.

Implements Ase::Property.

Definition at line 22 of file properties.hh.

◆ get_metadata()

StringS Ase::ParameterProperty::get_metadata ( ) const

overrideprotectedvirtual

Implements Ase::Property.

Definition at line 15 of file properties.hh.

◆ get_min()

double Ase::ParameterProperty::get_min ( ) const

overridevirtual

Get the minimum property value, converted to double.

Implements Ase::Property.

Definition at line 21 of file properties.hh.

◆ get_normalized()

double Ase::ParameterProperty::get_normalized ( ) const

overridevirtual

Get the normalized property value, converted to double.

Implements Ase::Property.

Definition at line 27 of file properties.hh.

References is_numeric().

◆ get_step()

double Ase::ParameterProperty::get_step ( ) const

overridevirtual

Get the property value stepping, converted to double.

Implements Ase::Property.

Definition at line 23 of file properties.hh.

◆ get_text()

String Ase::ParameterProperty::get_text ( ) const

overridevirtual

Get the current property value, converted to a text String.

Implements Ase::Property.

Definition at line 29 of file properties.hh.

References get_value().

◆ get_value()

Value Ase::ParameterProperty::get_value ( ) const

overridepure virtual

Get the native property value.

Implements Ase::Property.

Implemented in Ase::Preference, and Ase::PropertyImpl.

Referenced by get_text(), and set_value().

◆ ident()

String Ase::ParameterProperty::ident ( ) const

overridevirtual

Unique name (per owner) of this Property.

Implements Ase::Property.

Definition at line 17 of file properties.hh.

◆ initial()

Value Ase::ParameterProperty::initial ( ) const

Definition at line 35 of file properties.hh.

◆ is_numeric()

bool Ase::ParameterProperty::is_numeric ( ) const

overridevirtual

Whether the property settings can be represented as a floating point number.

Implements Ase::Property.

Definition at line 24 of file properties.hh.

Referenced by get_normalized(), set_normalized(), and set_value().

◆ label()

String Ase::ParameterProperty::label ( ) const

overridevirtual

Preferred user interface name.

Implements Ase::Property.

Definition at line 18 of file properties.hh.

◆ nick()

String Ase::ParameterProperty::nick ( ) const

overridevirtual

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

Implements Ase::Property.

Definition at line 19 of file properties.hh.

◆ parameter()

ParameterC Ase::ParameterProperty::parameter ( ) const

Definition at line 34 of file properties.hh.

◆ range()

MinMaxStep Ase::ParameterProperty::range ( ) const

Definition at line 36 of file properties.hh.

◆ reset()

void Ase::ParameterProperty::reset ( )

overridevirtual

Assign default as normalized property value.

Implements Ase::Property.

Definition at line 26 of file properties.hh.

References set_value().

◆ set_normalized()

bool Ase::ParameterProperty::set_normalized ( double v )

overridevirtual

Set the normalized property value as double.

Implements Ase::Property.

Definition at line 28 of file properties.hh.

References is_numeric(), and set_value().

◆ set_text()

bool Ase::ParameterProperty::set_text ( String v )

overridevirtual

Set the current property value as a text String.

Implements Ase::Property.

Definition at line 30 of file properties.hh.

References std::string::empty(), and set_value().

◆ set_value()

bool Ase::ParameterProperty::set_value ( const Value & v )

overridepure virtual

Set the native property value.

Implements Ase::Property.

Implemented in Ase::Preference, and Ase::PropertyImpl.

References Ase::Value::as_double(), get_value(), and is_numeric().

Referenced by reset(), set_normalized(), and set_text().

◆ unit()

String Ase::ParameterProperty::unit ( ) const

overridevirtual

Units of the values within range.

Implements Ase::Property.

Definition at line 20 of file properties.hh.

Member Data Documentation

◆ parameter_

ParameterC Ase::ParameterProperty::parameter_

protected

Definition at line 14 of file properties.hh.

The documentation for this class was generated from the following file:

ase/properties.hh

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ choices()

◆ get_double()

◆ get_max()

◆ get_metadata()

◆ get_min()

◆ get_normalized()

◆ get_step()

◆ get_text()

◆ get_value()

◆ ident()

◆ initial()

◆ is_numeric()

◆ label()

◆ nick()

◆ parameter()

◆ range()

◆ reset()

◆ set_normalized()

◆ set_text()

◆ set_value()

◆ unit()

Member Data Documentation

◆ parameter_