Struct Parameters 

pub struct Parameters<'a, 's> { /* private fields */ }

Provides access to undeclared parameters in a ParameterServer

This struct is returned by Node::use_undeclared_parameters() and allows for dynamic retrieval of parameter values by name without explicit declaration.

rclrs’s Parameters (phase-515 R8): read AND write, by name. It was UndeclaredParameters, which survives one release as a deprecated alias.

Implementations

impl<'a, 's> Parameters<'a, 's>

pub fn new( server: &'a mut ParameterServer<'s>, node: NodeKey, ) -> Parameters<'a, 's>

pub fn get<T>(&self, name: &str) -> Option<T>

where T: ParameterVariant,

rclrs’s Parameters::get::<T>(name) (phase-515 R8): the value of name as T, or None when it is unset or holds another type.

pub fn set<T>(&mut self, name: &str, value: T) -> Result<(), ParameterError>

where T: ParameterVariant,

rclrs’s Parameters::set(name, value) (phase-515 R8), declaring name if absent. ADOPT-BOUNDED: it takes &mut self where rclrs’s takes &self (this store has no interior mutability; the handle borrows the server mutably), and a value past this node’s compile-time capacity is ParameterError::StringConversion rather than rclrs’s ParameterValueError.

pub fn get_bool(&self, name: &str) -> Option<bool>

Try to get the value of an undeclared boolean parameter

pub fn get_integer(&self, name: &str) -> Option<i64>

Try to get the value of an undeclared integer parameter

pub fn get_double(&self, name: &str) -> Option<f64>

Try to get the value of an undeclared double parameter

pub fn get_string(&self, name: &str) -> Option<&str>

Try to get the value of an undeclared string parameter

pub fn set_bool( &mut self, name: &str, value: bool, ) -> Result<(), ParameterError>

Set (declaring if absent) an undeclared boolean parameter.

pub fn set_integer( &mut self, name: &str, value: i64, ) -> Result<(), ParameterError>

Set (declaring if absent) an undeclared integer parameter.

pub fn set_double( &mut self, name: &str, value: f64, ) -> Result<(), ParameterError>

Set (declaring if absent) an undeclared double parameter.

pub fn set_string( &mut self, name: &str, value: &str, ) -> Result<(), ParameterError>

Set (declaring if absent) an undeclared string parameter.