Struct industrial_io::channel::Channel

pub struct Channel { /* private fields */ }

An Industrial I/O Device Channel

Implementations

impl Channel

pub fn name(&self) -> Option<String>

Retrieves the name of the channel (e.g. vccint)

pub fn id(&self) -> Option<String>

@brief Retrieve the channel ID (e.g. voltage0)

pub fn is_scan_element(&self) -> bool

Determines if the channel is a scan element

A scan element is a channel that can generate samples (for an input channel) or receive samples (for an output channel) after being enabled.

pub fn num_attrs(&self) -> usize

Gets the number of context-specific attributes

pub fn get_attr(&self, idx: usize) -> Result<String>

Gets the channel-specific attribute at the index

pub fn attr_read_bool(&self, attr: &str) -> Result<bool>

Reads a channel-specific attribute as a boolean attr The name of the attribute

pub fn attr_read_int(&self, attr: &str) -> Result<i64>

Reads a channel-specific attribute as an integer (i64)

attr The name of the attribute

pub fn attr_read_float(&self, attr: &str) -> Result<f64>

Reads a channel-specific attribute as a floating-point (f64) number

attr The name of the attribute

pub fn attr_write_bool(&self, attr: &str, val: bool) -> Result<()>

Writes a channel-specific attribute as a boolean

attr The name of the attribute val The value to write

pub fn attr_write_int(&self, attr: &str, val: i64) -> Result<()>

Writes a channel-specific attribute as an integer (i64)

attr The name of the attribute val The value to write

pub fn attr_write_float(&self, attr: &str, val: f64) -> Result<()>

Writes a channel-specific attribute as a floating-point (f64) number

attr The name of the attribute val The value to write

pub fn attrs(&self) -> AttrIterator<'_>

Gets an iterator for the attributes of the channel

pub fn enable(&mut self)

Enable the channel

Before creating a buffer, at least one channel of the device must be enabled.

pub fn disable(&mut self)

Disables the channel

pub fn is_enabled(&self) -> bool

Determines if the channel is enabled