pub struct ProfileGeneric {
version: u8,
logical_name: ObisCode,
buffer: Vec<Choice>,
capture_objects: Vec<(Arc<dyn InterfaceClass + Send + Sync>, u8)>,
capture_objects_value: Option<CosemDataType>,
capture_period: u32,
sort_method: SortMethod,
sort_object: Option<CaptureObjectDefinition>,
entries_in_use: u32,
profile_entries: u32,
}Expand description
ProfileGeneric interface class (class_id = 7, version = 1) for storing data
profiles such as load profiles or event logs, per IEC 62056-6-2 §4.3.6 in the
spodes-rs library.
Supports capturing data from the specified objects and their attributes.
Fields§
§version: u8§logical_name: ObisCode§buffer: Vec<Choice>§capture_objects: Vec<(Arc<dyn InterfaceClass + Send + Sync>, u8)>§capture_objects_value: Option<CosemDataType>When set via SET, overrides the Arc-based capture_objects for GET.
capture_period: u32§sort_method: SortMethod§sort_object: Option<CaptureObjectDefinition>§entries_in_use: u32§profile_entries: u32Implementations§
Source§impl ProfileGeneric
impl ProfileGeneric
Sourcepub fn new(config: ProfileGenericConfig) -> Self
pub fn new(config: ProfileGenericConfig) -> Self
Sourcefn reset(&mut self) -> CosemDataType
fn reset(&mut self) -> CosemDataType
Resets the profile buffer, clearing all entries.
§Returns
Ok(CosemDataType::Null)- If the reset succeeded.Err(String)- If an error occurred.
Sourcefn capture(&mut self) -> Result<CosemDataType, String>
fn capture(&mut self) -> Result<CosemDataType, String>
Captures a new entry into the profile buffer, reading the attribute values
from the objects listed in capture_objects.
An entry holds only the values of the captured objects (a timestamp, if
needed, is provided by a Clock object included in capture_objects). For
an unsorted profile the buffer behaves as a FIFO: when full, the oldest
entry is evicted (IEC 62056-6-2, §5.2.1.2.5).
§Returns
Ok(CosemDataType::Null)- If the capture succeeded.Err(String)- If a captured object’s attribute is not found.
Sourcefn get_buffer_by_range(&self, _params: Option<CosemDataType>) -> CosemDataType
fn get_buffer_by_range(&self, _params: Option<CosemDataType>) -> CosemDataType
Method 3 (version 0 only): get_buffer_by_range — returns the buffer
entries whose sort value falls within a range (IEC 62056-6-2 §5.2.1.2.3).
Full range filtering requires evaluating the sort object of each entry; that ordering logic is not modelled here, so this returns the whole buffer as a best effort.
Sourcefn get_buffer_by_index(
&self,
params: Option<CosemDataType>,
) -> Result<CosemDataType, String>
fn get_buffer_by_index( &self, params: Option<CosemDataType>, ) -> Result<CosemDataType, String>
Method 4 (version 0 only): get_buffer_by_index — returns the buffer
entries in the 1-based inclusive range [from_entry, to_entry]
(IEC 62056-6-2 §5.2.1.2.4).
The parameter is structure { from_entry: double-long-unsigned, to_entry: double-long-unsigned, .. }; when it is absent, the whole
buffer is returned.
Trait Implementations§
Source§impl Clone for ProfileGeneric
impl Clone for ProfileGeneric
Source§fn clone(&self) -> ProfileGeneric
fn clone(&self) -> ProfileGeneric
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for ProfileGeneric
impl Debug for ProfileGeneric
Source§impl<'de> Deserialize<'de> for ProfileGeneric
impl<'de> Deserialize<'de> for ProfileGeneric
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Source§impl InterfaceClass for ProfileGeneric
impl InterfaceClass for ProfileGeneric
Source§fn logical_name(&self) -> &ObisCode
fn logical_name(&self) -> &ObisCode
Source§fn attributes(&self) -> Vec<(u8, CosemDataType)>
fn attributes(&self) -> Vec<(u8, CosemDataType)>
(attribute_id, value) pairs.