Struct DaqConfig 

pub struct DaqConfig {
    pub api: DaqApiDescriptor,
    pub device_name: String,
    pub inchannel_config: Vec<DaqChannel>,
    pub outchannel_config: Vec<DaqChannel>,
    pub dtype: DataType,
    pub digitalHighPassCutOn: Flt,
    pub sampleRateIndex: usize,
    pub framesPerBlockIndex: usize,
    pub monitorOutput: bool,
}

Configuration of a device.

Fields

api: DaqApiDescriptor

The API

device_name: String

Device name. Should match when starting a stream

inchannel_config: Vec<DaqChannel>

Configuration of the input channels

outchannel_config: Vec<DaqChannel>

Configuration of the output channels

dtype: DataType

The data type to use

digitalHighPassCutOn: Flt

Whether to apply a digital high pass on the input. <= 0 means disabled. > 0 means, the value specifies the cut-on frequency for the first order high pass filter.

sampleRateIndex: usize

The index to use in the list of possible sample rates

framesPerBlockIndex: usize

The index to use in the list of possible frames per block

monitorOutput: bool

Used when output channels should be monitored, i.e. reverse-looped back as input channels.

Implementations

impl DaqConfig

pub fn numberEnabledInChannels(&self) -> usize

Returns the total number of channels that appear in a running input stream.

pub fn numberEnabledOutChannels(&self) -> usize

Returns the total number of channels that appear in a running output stream.

pub fn sampleRate(&self, dev: &DeviceInfo) -> Flt

Provide samplerate, based on device and specified sample rate index

pub fn framesPerBlock(&self, dev: &DeviceInfo) -> usize

Provide samplerate, based on device and specified sample rate index

pub fn enabledInChannels(&self) -> Vec<DaqChannel>

Returns vec of channel configuration for enabled input channels only

pub fn enabledInchannelsList(&self) -> Vec<usize>

Returns a list of enabled input channel numbers as indices in the list of all input channels (enabled and not)

pub fn enabledOutChannels(&self) -> Vec<DaqChannel>

Returns vec of channel configuration for enabled output channels only

pub fn highestEnabledInChannel(&self) -> Option<usize>

Returns the channel number of the highest enabled input channel, if any.

pub fn highestEnabledOutChannel(&self) -> Option<usize>

Returns the channel number of the highest enabled output channel, if any.

pub fn setAllOutputEnabled(&mut self, enabled: bool)

Change state of all output channels, enables them all, or disables them all.

impl DaqConfig

pub fn newFromDeviceInfo(devinfo: &DeviceInfo) -> DaqConfig

Creates a new default device configuration for a given device as specified with the DeviceInfo descriptor.

pub fn serialize_TOML(&self, writer: &mut dyn Write) -> Result<()>

Serialize DaqConfig object to TOML.

Args

• writer: Output writer, can be file or string, or anything that is std::io::Write

pub fn deserialize_TOML<T>(reader: &mut T) -> Result<DaqConfig>

where T: Read,

Deserialize structure from TOML data

Args

• reader: implements the Read trait, from which we read the data.

pub fn deserialize_TOML_str(st: &str) -> Result<DaqConfig>

Deserialize from TOML string

Args

• st: string containing TOML data.

pub fn serialize_TOML_file(&self, file: &PathBuf) -> Result<()>

Write this configuration to a TOML file.

Args

• file: Name of file to write to

Trait Implementations

impl Clone for DaqConfig

fn clone(&self) -> DaqConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DaqConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DaqConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'py> IntoPyObject<'py> for DaqConfig

type Target = DaqConfig

The Python output type

type Output = Bound<'py, <DaqConfig as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PartialEq for DaqConfig

fn eq(&self, other: &DaqConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PyClass for DaqConfig

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for DaqConfig

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<DaqConfig>

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn doc(py: Python<'_>) -> PyResult<&'static CStr>

Rendered class doc

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl<'a, 'py> PyFunctionArgument<'a, 'py, false> for &'a DaqConfig

type Holder = Option<PyRef<'py, DaqConfig>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'a mut Self::Holder, ) -> PyResult<Self>

impl<'a, 'py> PyFunctionArgument<'a, 'py, false> for &'a mut DaqConfig

type Holder = Option<PyRefMut<'py, DaqConfig>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'a mut Self::Holder, ) -> PyResult<Self>

impl PyMethods<DaqConfig> for PyClassImplCollector<DaqConfig>

fn py_methods(self) -> &'static PyClassItems

impl PyStubType for DaqConfig

fn type_output() -> TypeInfo

The type to be used in the output signature, i.e. return type of the Python function or methods.

fn type_input() -> TypeInfo

The type to be used in the input signature, i.e. the arguments of the Python function or methods.

impl PyTypeInfo for DaqConfig

const NAME: &'static str = "DaqConfig"

Class name.

const MODULE: Option<&'static str> = ::core::option::Option::None

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl Serialize for DaqConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl DerefToPyAny for DaqConfig

impl StructuralPartialEq for DaqConfig