Trait nicompiler_backend::device::BaseDevice

source ·

pub trait BaseDevice {
Show 35 methods    // Required methods
    fn channels(&self) -> &HashMap<String, Channel>;
    fn name(&self) -> &str;
    fn task_type(&self) -> TaskType;
    fn samp_rate(&self) -> f64;
    fn samp_clk_src(&self) -> Option<&str>;
    fn trig_line(&self) -> Option<&str>;
    fn export_trig(&self) -> Option<bool>;
    fn ref_clk_line(&self) -> Option<&str>;
    fn export_ref_clk(&self) -> Option<bool>;
    fn ref_clk_rate(&self) -> Option<f64>;
    fn channels_(&mut self) -> &mut HashMap<String, Channel>;
    fn samp_clk_src_(&mut self) -> &mut Option<String>;
    fn trig_line_(&mut self) -> &mut Option<String>;
    fn export_trig_(&mut self) -> &mut Option<bool>;
    fn ref_clk_line_(&mut self) -> &mut Option<String>;
    fn export_ref_clk_(&mut self) -> &mut Option<bool>;
    fn ref_clk_rate_(&mut self) -> &mut Option<f64>;

    // Provided methods
    fn cfg_samp_clk_src(&mut self, src: &str) { ... }
    fn cfg_trig(&mut self, trig_line: &str, export_trig: bool) { ... }
    fn cfg_ref_clk(
        &mut self,
        ref_clk_line: &str,
        ref_clk_rate: f64,
        export_ref_clk: bool
    ) { ... }
    fn editable_channels(&self) -> Vec<&Channel> { ... }
    fn editable_channels_(&mut self) -> Vec<&mut Channel> { ... }
    fn add_channel(&mut self, name: &str) { ... }
    fn is_compiled(&self) -> bool { ... }
    fn is_edited(&self) -> bool { ... }
    fn is_fresh_compiled(&self) -> bool { ... }
    fn clear_edit_cache(&mut self) { ... }
    fn clear_compile_cache(&mut self) { ... }
    fn compile(&mut self, stop_pos: usize) { ... }
    fn compiled_channels(
        &self,
        require_streamable: bool,
        require_editable: bool
    ) -> Vec<&Channel> { ... }
    fn compiled_stop_time(&self) -> f64 { ... }
    fn edit_stop_time(&self) -> f64 { ... }
    fn fill_signal_nsamps(
        &self,
        start_pos: usize,
        end_pos: usize,
        nsamps: usize,
        buffer: &mut Array2<f64>,
        require_streamable: bool,
        require_editable: bool
    ) { ... }
    fn calc_signal_nsamps(
        &self,
        start_pos: usize,
        end_pos: usize,
        nsamps: usize,
        require_streamable: bool,
        require_editable: bool
    ) -> Array2<f64> { ... }
    fn unique_port_numbers(&self) -> Vec<usize> { ... }
}

Expand description

The BaseDevice trait defines the fundamental operations and attributes of a National Instruments (NI) device.

This trait abstracts the common functionalities that an NI device should possess, regardless of its specific hardware details or task type. Implementers of this trait will have access to core functionalities like channel management, device status checks, signal compilation, and more.

Typical Use

A type implementing BaseDevice is primarily used to interact with the associated NI hardware, manage its channels, and perform operations like signal generation, editing, and compilation.

Trait Methods and Their Functionality:

Field methods: These provide direct access to the properties of a device, such as its channels, physical name, sampling rate, and various configuration parameters.
Synchronization configuration: Customize the synchronization behavior of devices via BaseDevice::cfg_trig, BaseDevice::cfg_ref_clk, BaseDevice::cfg_samp_clk_src. See Device for more details.
Channel management: Methods like BaseDevice::editable_channels, BaseDevice::editable_channels_, and BaseDevice::add_channel allow for the retrieval and manipulation of channels associated with the device.
Device status checks: Methods like BaseDevice::is_compiled, BaseDevice::is_edited, and BaseDevice::is_fresh_compiled enable checking the compilation and editing status of the device’s channels.
Cache operations: The methods BaseDevice::clear_edit_cache and BaseDevice::clear_compile_cache are used to clear the edit and compile caches of the device’s channels, respectively.
Compilation: The BaseDevice::compile method takes care of the signal compilation process for the device’s channels. For Digital Output (DO) channels, it provides additional functionality to merge line channels into port channels.
Signal generation: The BaseDevice::fill_signal_nsamps and BaseDevice::calc_signal_nsamps methods are central to signal generation, allowing for the sampling of float-point values from compiled instructions based on various criteria.
Utility functions: Methods like BaseDevice::unique_port_numbers offer utility functionalities specific to certain task types, aiding in operations like identifying unique ports in Digital Output (DO) devices.

Implementing `BaseDevice`:

When creating a new type that represents an NI device, implementing this trait ensures that the type has all the necessary methods and behaviors typical of NI devices. Implementers can then extend or override these methods as necessary to provide device-specific behavior or optimizations.

Trait nicompiler_backend::device::BaseDevice

Required Methods§

fn channels(&self) -> &HashMap<String, Channel>

fn name(&self) -> &str

fn task_type(&self) -> TaskType

fn samp_rate(&self) -> f64

fn samp_clk_src(&self) -> Option<&str>

fn trig_line(&self) -> Option<&str>

fn export_trig(&self) -> Option<bool>

fn ref_clk_line(&self) -> Option<&str>

fn export_ref_clk(&self) -> Option<bool>

fn ref_clk_rate(&self) -> Option<f64>

fn channels_(&mut self) -> &mut HashMap<String, Channel>

fn samp_clk_src_(&mut self) -> &mut Option<String>

fn trig_line_(&mut self) -> &mut Option<String>

fn export_trig_(&mut self) -> &mut Option<bool>

fn ref_clk_line_(&mut self) -> &mut Option<String>

fn export_ref_clk_(&mut self) -> &mut Option<bool>

fn ref_clk_rate_(&mut self) -> &mut Option<f64>

Provided Methods§

fn cfg_samp_clk_src(&mut self, src: &str)

fn cfg_trig(&mut self, trig_line: &str, export_trig: bool)

fn cfg_ref_clk( &mut self, ref_clk_line: &str, ref_clk_rate: f64, export_ref_clk: bool )

fn editable_channels(&self) -> Vec<&Channel>

fn editable_channels_(&mut self) -> Vec<&mut Channel>

fn add_channel(&mut self, name: &str)

fn is_compiled(&self) -> bool

fn is_edited(&self) -> bool

fn is_fresh_compiled(&self) -> bool

fn clear_edit_cache(&mut self)

fn clear_compile_cache(&mut self)

fn compile(&mut self, stop_pos: usize)

fn compiled_channels( &self, require_streamable: bool, require_editable: bool ) -> Vec<&Channel>

fn compiled_stop_time(&self) -> f64

fn edit_stop_time(&self) -> f64

fn fill_signal_nsamps( &self, start_pos: usize, end_pos: usize, nsamps: usize, buffer: &mut Array2<f64>, require_streamable: bool, require_editable: bool )

fn calc_signal_nsamps( &self, start_pos: usize, end_pos: usize, nsamps: usize, require_streamable: bool, require_editable: bool ) -> Array2<f64>

fn unique_port_numbers(&self) -> Vec<usize>

Implementors§

impl BaseDevice for Device