pfc::ui::ParameterMetadata< T > Struct Template Reference

Metadata for a single model parameter. More...

#include <parameter_metadata.hpp>

Collaboration diagram for pfc::ui::ParameterMetadata< T >:

Classes
class	Builder
	Builder pattern for fluent parameter construction. More...

Public Member Functions
std::optional< std::string >	validate (T value) const
	Validate a parameter value against constraints.
std::string	format_info () const
	Format parameter info for error messages.

Static Public Member Functions
static Builder	builder ()
	Start building parameter metadata.

Public Attributes
std::string	name
	Parameter name (as in config file)
std::string	description
	Human-readable description.
bool	required = false
	Must be present in config?
std::optional< T >	min_value
	Minimum valid value (inclusive)
std::optional< T >	max_value
	Maximum valid value (inclusive)
std::optional< T >	typical_value
	Typical/recommended value.
std::optional< T >	default_value
	Default if not specified.
std::string	physical_units
	Physical units (e.g., "K", "m/s")
std::string	category
	Parameter category (e.g., "Thermodynamics")

Detailed Description

template<typename T>
struct pfc::ui::ParameterMetadata< T >

Metadata for a single model parameter.

Contains all information needed to validate, document, and provide helpful error messages for a parameter.

Template Parameters

T	Parameter type (double, int, etc.)

Member Function Documentation

format_info()

template<typename T >

std::string pfc::ui::ParameterMetadata< T >::format_info ( ) const

inline

Format parameter info for error messages.

Returns

Multi-line string describing the parameter

validate()

template<typename T >

std::optional< std::string > pfc::ui::ParameterMetadata< T >::validate ( T  value ) const

inline

Validate a parameter value against constraints.

Checks if value satisfies min/max bounds.

Parameters

value

Value to validate

Returns

Error message if invalid, empty optional if valid

---

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

• openpfc/ui/parameter_metadata.hpp