pub struct UndeclaredParameters<'a, 's> { /* private fields */ }Expand description
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 calls this type Parameters; the capability is the same (read AND write,
by name), only the name differs. A ported file rarely names the type — it binds
what use_undeclared_parameters() returns — so the edit is a use line.
Implementations§
Source§impl<'a, 's> UndeclaredParameters<'a, 's>
impl<'a, 's> UndeclaredParameters<'a, 's>
pub fn new(server: &'a mut ParameterServer<'s>, node: NodeKey) -> Self
Sourcepub fn get_bool(&self, name: &str) -> Option<bool>
pub fn get_bool(&self, name: &str) -> Option<bool>
Try to get the value of an undeclared boolean parameter
Sourcepub fn get_integer(&self, name: &str) -> Option<i64>
pub fn get_integer(&self, name: &str) -> Option<i64>
Try to get the value of an undeclared integer parameter
Sourcepub fn get_double(&self, name: &str) -> Option<f64>
pub fn get_double(&self, name: &str) -> Option<f64>
Try to get the value of an undeclared double parameter
Sourcepub fn get_string(&self, name: &str) -> Option<&str>
pub fn get_string(&self, name: &str) -> Option<&str>
Try to get the value of an undeclared string parameter
Sourcepub fn set_bool(
&mut self,
name: &str,
value: bool,
) -> Result<(), ParameterError>
pub fn set_bool( &mut self, name: &str, value: bool, ) -> Result<(), ParameterError>
Set (declaring if absent) an undeclared boolean parameter.
Sourcepub fn set_integer(
&mut self,
name: &str,
value: i64,
) -> Result<(), ParameterError>
pub fn set_integer( &mut self, name: &str, value: i64, ) -> Result<(), ParameterError>
Set (declaring if absent) an undeclared integer parameter.
Sourcepub fn set_double(
&mut self,
name: &str,
value: f64,
) -> Result<(), ParameterError>
pub fn set_double( &mut self, name: &str, value: f64, ) -> Result<(), ParameterError>
Set (declaring if absent) an undeclared double parameter.
Sourcepub fn set_string(
&mut self,
name: &str,
value: &str,
) -> Result<(), ParameterError>
pub fn set_string( &mut self, name: &str, value: &str, ) -> Result<(), ParameterError>
Set (declaring if absent) an undeclared string parameter.