Struct ParameterDescriptor 

pub struct ParameterDescriptor {
    pub name: String<nros_params::::types::ParameterDescriptor::{constant#0}>,
    pub param_type: ParameterType,
    pub description: String<nros_params::::types::ParameterDescriptor::{constant#1}>,
    pub read_only: bool,
    pub dynamic_typing: bool,
    pub range: ParameterRange,
}

Parameter descriptor containing metadata

Describes a parameter including its type, constraints, and documentation.

Fields

name: String<nros_params::::types::ParameterDescriptor::{constant#0}>

Parameter name

param_type: ParameterType

Parameter type

description: String<nros_params::::types::ParameterDescriptor::{constant#1}>

Human-readable description

read_only: bool

Whether the parameter is read-only

dynamic_typing: bool

Whether the parameter type can change dynamically

range: ParameterRange

Range constraints

Implementations

impl ParameterDescriptor

pub fn new(name: &str, param_type: ParameterType) -> Option<ParameterDescriptor>

Create a new parameter descriptor

pub fn with_description(self, desc: &str) -> ParameterDescriptor

Set the description

pub fn with_read_only(self, read_only: bool) -> ParameterDescriptor

Set read-only flag

pub fn with_dynamic_typing(self, dynamic: bool) -> ParameterDescriptor

Set dynamic typing flag

pub fn with_integer_range( self, min: i64, max: i64, step: i64, ) -> ParameterDescriptor

Set integer range constraints

pub fn with_float_range( self, min: f64, max: f64, step: f64, ) -> ParameterDescriptor

Set floating point range constraints

pub fn validate_range(&self, value: &ParameterValue) -> bool

Check if a value satisfies the range constraints

Trait Implementations

impl Clone for ParameterDescriptor

fn clone(&self) -> ParameterDescriptor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParameterDescriptor

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

Formats the value using the given formatter.