Struct NodeMap 

pub struct NodeMap { /* private fields */ }

Runtime nodemap built from an XmlModel capable of reading and writing feature values via a RegisterIo transport.

Implementations

impl NodeMap

pub fn version(&self) -> &str

Return the schema version string associated with the XML description.

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

Fetch a node by name for inspection.

pub fn node_names(&self) -> impl Iterator<Item = &str>

Return an iterator over all node names in the map.

pub fn dependents(&self, name: &str) -> &[String]

Return the list of nodes that should be invalidated when name changes.

Returns an empty slice if the node has no dependents.

pub fn categories(&self) -> Vec<(&str, &[String])>

Return all category nodes as (name, children) pairs.

pub fn nodes_at_visibility(&self, level: Visibility) -> Vec<&str>

Return names of nodes visible at the given level or below.

A node with Visibility::Expert is visible at level Expert and Guru, but not at Beginner.

pub fn try_from_xml(model: XmlModel) -> Result<Self, GenApiError>

Construct a NodeMap from an XmlModel, validating SwissKnife expressions.

pub fn get_integer( &self, name: &str, io: &dyn RegisterIo, ) -> Result<i64, GenApiError>

Read an integer feature value using the provided transport.

pub fn set_integer( &mut self, name: &str, value: i64, io: &dyn RegisterIo, ) -> Result<(), GenApiError>

Write an integer feature and update dependent caches.

pub fn get_float( &self, name: &str, io: &dyn RegisterIo, ) -> Result<f64, GenApiError>

Read a floating point feature.

pub fn set_float( &mut self, name: &str, value: f64, io: &dyn RegisterIo, ) -> Result<(), GenApiError>

Write a floating point feature using the scale/offset conversion.

pub fn get_enum( &self, name: &str, io: &dyn RegisterIo, ) -> Result<String, GenApiError>

Read an enumeration feature returning the symbolic entry name.

pub fn set_enum( &mut self, name: &str, entry: &str, io: &dyn RegisterIo, ) -> Result<(), GenApiError>

Write an enumeration entry.

pub fn enum_entries(&self, name: &str) -> Result<Vec<String>, GenApiError>

List the available entry names for an enumeration feature.

pub fn get_bool( &self, name: &str, io: &dyn RegisterIo, ) -> Result<bool, GenApiError>

Read a boolean feature.

pub fn set_bool( &mut self, name: &str, value: bool, io: &dyn RegisterIo, ) -> Result<(), GenApiError>

Write a boolean feature.

pub fn exec_command( &mut self, name: &str, io: &dyn RegisterIo, ) -> Result<(), GenApiError>

Execute a command feature by writing a value to the command register.

pub fn get_converter( &self, name: &str, io: &dyn RegisterIo, ) -> Result<f64, GenApiError>

Read a Converter feature value (float) using the provided transport.

pub fn get_int_converter( &self, name: &str, io: &dyn RegisterIo, ) -> Result<i64, GenApiError>

Read an IntConverter feature value (integer) using the provided transport.

pub fn get_string( &self, name: &str, io: &dyn RegisterIo, ) -> Result<String, GenApiError>

Read a String feature value using the provided transport.

pub fn set_string( &self, name: &str, value: &str, io: &dyn RegisterIo, ) -> Result<(), GenApiError>

Write a String feature value using the provided transport.

Trait Implementations

impl Debug for NodeMap

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

Formats the value using the given formatter.

impl From<XmlModel> for NodeMap

fn from(model: XmlModel) -> Self

Converts to this type from the input type.