Skip to main content

ProfileGeneric

Struct ProfileGeneric 

Source
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: u32

Implementations§

Source§

impl ProfileGeneric

Source

pub fn new(config: ProfileGenericConfig) -> Self

Builds a new ProfileGeneric object from its configuration.

§Arguments
  • config - Configuration used to build the object.
§Returns

A new ProfileGeneric structure.

Source

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.
Source

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.
Source

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.

Source

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

Source§

fn clone(&self) -> ProfileGeneric

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ProfileGeneric

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for ProfileGeneric

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl InterfaceClass for ProfileGeneric

Source§

fn class_id(&self) -> u16

Returns the class id (class_id) as defined in IEC 62056-6-2.
Source§

fn version(&self) -> u8

Returns the class version.
Source§

fn logical_name(&self) -> &ObisCode

Returns the object’s logical name (OBIS code).
Source§

fn attributes(&self) -> Vec<(u8, CosemDataType)>

Returns the class attributes as (attribute_id, value) pairs.
Source§

fn methods(&self) -> Vec<(u8, String)>

Returns the class methods as (method_id, name) pairs.
Source§

fn serialize_ber(&self, buf: &mut Vec<u8>) -> Result<(), BerError>

Serializes the object into BER. Read more
Source§

fn deserialize_ber(&mut self, data: &[u8]) -> Result<(), BerError>

Deserializes the object from BER data. Read more
Source§

fn set_attribute( &mut self, attribute_id: u8, value: CosemDataType, ) -> Result<(), String>

Writes the value of a writable attribute. The default implementation rejects the write; classes with writable attributes override it. Read more
Source§

fn invoke_method( &mut self, method_id: u8, params: Option<CosemDataType>, ) -> Result<CosemDataType, String>

Invokes the object method with the given id. Read more
Source§

fn as_any(&self) -> &dyn Any

Returns the object as dyn Any for dynamic downcasting.
Source§

impl Serialize for ProfileGeneric

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more