mdflib 0.2.1

Rust bindings for mdflib
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270

//! ChannelConversion wrapper for mdflib IChannelConversion
//!
//! A channel conversion is a formula that is used to convert the raw value of a
//! channel to a physical value. This module provides access to the conversion's
//! parameters, such as the formula, unit, and range.

use crate::error::Result;
use crate::metadata::{MetaData, MetaDataRef};
use mdflib_sys as ffi;
use std::ffi::{CStr, CString};
use std::marker::PhantomData;
use std::ops::Deref;
use std::os::raw::c_char;

/// Represents an immutable reference to a channel conversion in an MDF file.
#[derive(Debug, Clone, Copy)]
pub struct ChannelConversionRef<'a> {
    pub(crate) inner: *const ffi::IChannelConversion,
    _marker: PhantomData<&'a ()>,
}

impl std::fmt::Display for ChannelConversionRef<'_> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(
            f,
            "ChannelConversion {{ index: {}, name: {}, description: {}, unit: {}, type: {}, precision_used: {}, precision: {}, range_used: {}, range_min: {}, range_max: {}, flags: {}, formula: {} }}",
            self.get_index(),
            self.get_name(),
            self.get_description(),
            self.get_unit(),
            self.get_type(),
            self.is_precision_used(),
            self.get_precision(),
            self.is_range_used(),
            self.get_range_min(),
            self.get_range_max(),
            self.get_flags(),
            self.get_formula()
        )
    }
}

impl<'a> ChannelConversionRef<'a> {
    #[allow(dead_code)]
    pub(crate) fn new(inner: *const ffi::IChannelConversion) -> Self {
        Self {
            inner,
            _marker: PhantomData,
        }
    }

    /// Gets the index of the channel conversion.
    pub fn get_index(&self) -> u64 {
        unsafe { ffi::ChannelConversionGetIndex(self.inner) }
    }

    /// Gets the name of the channel conversion.
    pub fn get_name(&self) -> String {
        unsafe {
            let mut len = ffi::ChannelConversionGetName(self.inner, std::ptr::null_mut(), 0);
            if len == 0 {
                return String::new();
            }
            len += 1; // For null terminator
            let mut buf = vec![0 as c_char; len as usize];
            ffi::ChannelConversionGetName(self.inner, buf.as_mut_ptr(), len);
            CStr::from_ptr(buf.as_ptr()).to_string_lossy().into_owned()
        }
    }

    /// Gets the description of the channel conversion.
    pub fn get_description(&self) -> String {
        unsafe {
            let mut len = ffi::ChannelConversionGetDescription(self.inner, std::ptr::null_mut(), 0);
            if len == 0 {
                return String::new();
            }
            len += 1; // For null terminator
            let mut buf = vec![0 as c_char; len as usize];
            ffi::ChannelConversionGetDescription(self.inner, buf.as_mut_ptr(), len);
            CStr::from_ptr(buf.as_ptr()).to_string_lossy().into_owned()
        }
    }

    /// Gets the unit of the channel conversion.
    pub fn get_unit(&self) -> String {
        unsafe {
            let mut len = ffi::ChannelConversionGetUnit(self.inner, std::ptr::null_mut(), 0);
            if len == 0 {
                return String::new();
            }
            len += 1; // For null terminator
            let mut buf = vec![0 as c_char; len as usize];
            ffi::ChannelConversionGetUnit(self.inner, buf.as_mut_ptr(), len);
            CStr::from_ptr(buf.as_ptr()).to_string_lossy().into_owned()
        }
    }

    /// Gets the type of the channel conversion.
    pub fn get_type(&self) -> u8 {
        unsafe { ffi::ChannelConversionGetType(self.inner) }
    }

    /// Gets whether precision is used.
    pub fn is_precision_used(&self) -> bool {
        unsafe { ffi::ChannelConversionIsPrecisionUsed(self.inner) }
    }

    /// Gets the precision.
    pub fn get_precision(&self) -> u8 {
        unsafe { ffi::ChannelConversionGetPrecision(self.inner) }
    }

    /// Gets whether range is used.
    pub fn is_range_used(&self) -> bool {
        unsafe { ffi::ChannelConversionIsRangeUsed(self.inner) }
    }

    /// Gets the range minimum.
    pub fn get_range_min(&self) -> f64 {
        unsafe { ffi::ChannelConversionGetRangeMin(self.inner) }
    }

    /// Gets the range maximum.
    pub fn get_range_max(&self) -> f64 {
        unsafe { ffi::ChannelConversionGetRangeMax(self.inner) }
    }

    /// Gets the flags.
    pub fn get_flags(&self) -> u16 {
        unsafe { ffi::ChannelConversionGetFlags(self.inner) }
    }

    /// Gets the formula.
    pub fn get_formula(&self) -> String {
        unsafe {
            let mut len = ffi::ChannelConversionGetFormula(self.inner, std::ptr::null_mut(), 0);
            if len == 0 {
                return String::new();
            }
            len += 1; // For null terminator
            let mut buf = vec![0 as c_char; len as usize];
            ffi::ChannelConversionGetFormula(self.inner, buf.as_mut_ptr(), len);
            CStr::from_ptr(buf.as_ptr()).to_string_lossy().into_owned()
        }
    }

    /// Gets a parameter as a double.
    pub fn get_parameter_as_double(&self, index: u16) -> f64 {
        unsafe { ffi::ChannelConversionGetParameterAsDouble(self.inner, index) }
    }

    /// Gets a parameter as a uint64.
    pub fn get_parameter_as_uint64(&self, index: u16) -> u64 {
        unsafe { ffi::ChannelConversionGetParameterAsUInt64(self.inner, index) }
    }

    /// Gets the metadata.
    pub fn get_metadata(&self) -> Option<MetaDataRef<'a>> {
        unsafe {
            let metadata = ffi::ChannelConversionGetMetaData(self.inner);
            if metadata.is_null() {
                None
            } else {
                Some(MetaDataRef::new(metadata))
            }
        }
    }
}

/// Represents a mutable channel conversion in an MDF file.
#[derive(Debug)]
pub struct ChannelConversion<'a> {
    pub(crate) inner: *mut ffi::IChannelConversion,
    inner_ref: ChannelConversionRef<'a>,
}

impl<'a> ChannelConversion<'a> {
    #[allow(dead_code)]
    pub(crate) fn new(inner: *mut ffi::IChannelConversion) -> Self {
        Self {
            inner,
            inner_ref: ChannelConversionRef::new(inner),
        }
    }

    /// Sets the name of the channel conversion.
    pub fn set_name(&mut self, name: &str) -> Result<()> {
        let c_name = CString::new(name)?;
        unsafe {
            ffi::ChannelConversionSetName(self.inner, c_name.as_ptr());
        }
        Ok(())
    }

    /// Sets the description of the channel conversion.
    pub fn set_description(&mut self, description: &str) -> Result<()> {
        let c_description = CString::new(description)?;
        unsafe {
            ffi::ChannelConversionSetDescription(self.inner, c_description.as_ptr());
        }
        Ok(())
    }

    /// Sets the unit of the channel conversion.
    pub fn set_unit(&mut self, unit: &str) -> Result<()> {
        let c_unit = CString::new(unit)?;
        unsafe {
            ffi::ChannelConversionSetUnit(self.inner, c_unit.as_ptr());
        }
        Ok(())
    }

    /// Sets the type of the channel conversion.
    pub fn set_type(&mut self, conversion_type: u8) {
        unsafe {
            ffi::ChannelConversionSetType(self.inner, conversion_type);
        }
    }

    /// Sets the range.
    pub fn set_range(&mut self, min: f64, max: f64) {
        unsafe {
            ffi::ChannelConversionSetRange(self.inner, min, max);
        }
    }

    /// Sets the formula.
    pub fn set_formula(&mut self, formula: &str) -> Result<()> {
        let c_formula = CString::new(formula)?;
        unsafe {
            ffi::ChannelConversionSetFormula(self.inner, c_formula.as_ptr());
        }
        Ok(())
    }

    /// Sets a parameter as a double.
    pub fn set_parameter_as_double(&mut self, index: u16, parameter: f64) {
        unsafe {
            ffi::ChannelConversionSetParameterAsDouble(self.inner, index, parameter);
        }
    }

    /// Sets a parameter as a uint64.
    pub fn set_parameter_as_uint64(&mut self, index: u16, parameter: u64) {
        unsafe {
            ffi::ChannelConversionSetParameterAsUInt64(self.inner, index, parameter);
        }
    }

    /// Creates metadata for the channel conversion.
    pub fn create_metadata(&mut self) -> Option<MetaData<'a>> {
        unsafe {
            let metadata = ffi::ChannelConversionCreateMetaData(self.inner);
            if metadata.is_null() {
                None
            } else {
                Some(MetaData::new(metadata))
            }
        }
    }
}

impl<'a> Deref for ChannelConversion<'a> {
    type Target = ChannelConversionRef<'a>;

    fn deref(&self) -> &Self::Target {
        &self.inner_ref
    }
}