One knob of one stage. More...

#include <stage_parameters.hpp>

Collaboration diagram for reusex::pipeline::ParameterDescriptor:

[legend]

Public Attributes
std::string	key
	The JSON key run_stage() reads.
ParameterType	type = ParameterType::number
std::string	label
	Short human label for a form field.
std::string	description
	One-line explanation, mirroring the CLI help for the equivalent flag.
ParameterDefault	default_value
std::optional< double >	minimum
	Inclusive bounds, mirroring the CLI's CLI::Range checks where one exists.
std::optional< double >	maximum
bool	presence_sensitive = false
	True when the mere PRESENCE of the key changes behaviour, independently of its value (#214): sending plane_dist_threshold at all pins that threshold and switches off adaptive derivation for it.

Detailed Description

One knob of one stage.

Definition at line 57 of file stage_parameters.hpp.

Member Data Documentation

◆ default_value

ParameterDefault reusex::pipeline::ParameterDescriptor::default_value

Definition at line 67 of file stage_parameters.hpp.

◆ description

std::string reusex::pipeline::ParameterDescriptor::description

One-line explanation, mirroring the CLI help for the equivalent flag.

Definition at line 66 of file stage_parameters.hpp.

◆ key

std::string reusex::pipeline::ParameterDescriptor::key

The JSON key run_stage() reads.

This is the contract; the CLI flag spelling may differ (clouds reads resolution, the CLI calls it -g/--grid).

Definition at line 61 of file stage_parameters.hpp.

◆ label

std::string reusex::pipeline::ParameterDescriptor::label

Short human label for a form field.

Definition at line 64 of file stage_parameters.hpp.

◆ maximum

std::optional<double> reusex::pipeline::ParameterDescriptor::maximum

Definition at line 71 of file stage_parameters.hpp.

◆ minimum

std::optional<double> reusex::pipeline::ParameterDescriptor::minimum

Inclusive bounds, mirroring the CLI's CLI::Range checks where one exists.

Absent means the algorithm imposes no documented bound.

Definition at line 70 of file stage_parameters.hpp.

◆ presence_sensitive

bool reusex::pipeline::ParameterDescriptor::presence_sensitive = false

True when the mere PRESENCE of the key changes behaviour, independently of its value (#214): sending plane_dist_threshold at all pins that threshold and switches off adaptive derivation for it.

A form must therefore omit an untouched key rather than helpfully echoing its default back — that would silently disable adaptivity.

Definition at line 77 of file stage_parameters.hpp.

◆ type

ParameterType reusex::pipeline::ParameterDescriptor::type = ParameterType::number

Definition at line 62 of file stage_parameters.hpp.

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

libs/reusex/include/pipeline/stage_parameters.hpp

Public Attributes