Struct ParamDescriptor 

pub struct ParamDescriptor {
    pub id: &'static str,
    pub label: &'static str,
    pub kind: ParamKind,
    pub apply: ParamApply,
    pub format: ParamFormat,
}

A parameter a model declares.

Fields

id: &'static str

Stable name that --set and a spec file match on, and that results record.

label: &'static str

Name the Parameters panel shows.

kind: ParamKind

Type, bounds and default.

apply: ParamApply

Whether an edit reaches the running simulation or waits for a rebuild.

format: ParamFormat

Display format of the value.

Implementations

impl ParamDescriptor

pub fn on_reload(self) -> Self

Marks the parameter ParamApply::OnReload. A parameter is live by default.

pub fn percent(self) -> Self

Marks the parameter as a fraction displayed as a percentage, ParamFormat::Percent.

pub fn is_live(&self) -> bool

Returns whether an edit reaches a running state.

Trait Implementations

impl Clone for ParamDescriptor

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ParamDescriptor

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.