pub struct EventLogObject { /* private fields */ }Expand description
BACnet EventLog object.
Ring buffer of timestamped event log records. The application calls
add_record() to log event data. Resident records retain the legacy shared
Rust BACnetLogRecord shape; Event Log projection remains family-specific.
Implementations§
Source§impl EventLogObject
impl EventLogObject
Sourcepub fn new(
instance: u32,
name: impl Into<String>,
buffer_size: u32,
) -> Result<Self, Error>
pub fn new( instance: u32, name: impl Into<String>, buffer_size: u32, ) -> Result<Self, Error>
Create a new EventLog object.
Sourcepub fn add_record(&mut self, record: BACnetLogRecord)
pub fn add_record(&mut self, record: BACnetLogRecord)
Add a BACnetLogRecord to the event log buffer.
Sourcepub fn records(&self) -> &VecDeque<BACnetLogRecord>
pub fn records(&self) -> &VecDeque<BACnetLogRecord>
Get the current buffer contents.
Sourcepub fn set_description(&mut self, desc: impl Into<String>)
pub fn set_description(&mut self, desc: impl Into<String>)
Set the description string.
Trait Implementations§
Source§impl BACnetObject for EventLogObject
impl BACnetObject for EventLogObject
Source§fn object_identifier(&self) -> ObjectIdentifier
fn object_identifier(&self) -> ObjectIdentifier
The object’s identifier (type + instance).
Source§fn object_name(&self) -> &str
fn object_name(&self) -> &str
The object’s name.
Source§fn read_property(
&self,
property: PropertyIdentifier,
array_index: Option<u32>,
) -> Result<PropertyValue, Error>
fn read_property( &self, property: PropertyIdentifier, array_index: Option<u32>, ) -> Result<PropertyValue, Error>
Read a property value.
Source§fn write_property(
&mut self,
property: PropertyIdentifier,
_array_index: Option<u32>,
value: PropertyValue,
_priority: Option<u8>,
) -> Result<(), Error>
fn write_property( &mut self, property: PropertyIdentifier, _array_index: Option<u32>, value: PropertyValue, _priority: Option<u8>, ) -> Result<(), Error>
Write a property value. Read more
Source§fn property_list(&self) -> Cow<'static, [PropertyIdentifier]>
fn property_list(&self) -> Cow<'static, [PropertyIdentifier]>
List all properties this object supports in the legacy projection. Read more
Source§fn is_writable_property(&self, property: PropertyIdentifier) -> bool
fn is_writable_property(&self, property: PropertyIdentifier) -> bool
Source§fn log_record_identities_internal(&self) -> Option<Vec<LogRecordIdentity>>
fn log_record_identities_internal(&self) -> Option<Vec<LogRecordIdentity>>
Return stable identities aligned with this object’s resident log records. Read more
Source§fn property_metadata(&self) -> Cow<'_, [PropertyMetadata]>
fn property_metadata(&self) -> Cow<'_, [PropertyMetadata]>
Return canonical metadata for this object’s effective property rows. Read more
Source§fn is_array_property(&self, property: PropertyIdentifier) -> bool
fn is_array_property(&self, property: PropertyIdentifier) -> bool
Whether
property accepts an array index on this object. Read moreSource§fn is_createable(&self) -> bool
fn is_createable(&self) -> bool
Whether this object type can be created at runtime via CreateObject. Read more
Source§fn is_deleteable(&self) -> bool
fn is_deleteable(&self) -> bool
Whether this object type can be deleted at runtime via DeleteObject. Read more
Source§fn required_properties(&self) -> Cow<'static, [PropertyIdentifier]>
fn required_properties(&self) -> Cow<'static, [PropertyIdentifier]>
List the REQUIRED properties for this object type. Read more
Source§fn supports_cov(&self) -> bool
fn supports_cov(&self) -> bool
Whether this object type supports COV notifications. Read more
Source§fn supports_cov_property(&self, property: PropertyIdentifier) -> bool
fn supports_cov_property(&self, property: PropertyIdentifier) -> bool
Whether a readable property supports property-specific COV. Read more
Source§fn cov_increment(&self) -> Option<f32>
fn cov_increment(&self) -> Option<f32>
COV increment for this object (analog objects only). Read more
Source§fn set_overridden(&mut self, _overridden: bool)
fn set_overridden(&mut self, _overridden: bool)
Set the OVERRIDDEN bit in StatusFlags. Read more
Source§fn evaluate_intrinsic_reporting(&mut self) -> Option<TransitionOutcome>
fn evaluate_intrinsic_reporting(&mut self) -> Option<TransitionOutcome>
Evaluate intrinsic reporting after a present_value change. Read more
Source§fn tick_intrinsic_reporting(&mut self) -> Option<TransitionOutcome>
fn tick_intrinsic_reporting(&mut self) -> Option<TransitionOutcome>
Advance the
Time_Delay countdown for a pending transition. Read moreSource§fn tick_schedule(
&mut self,
_day_of_week: u8,
_hour: u8,
_minute: u8,
) -> Option<(PropertyValue, Vec<(ObjectIdentifier, u32)>)>
fn tick_schedule( &mut self, _day_of_week: u8, _hour: u8, _minute: u8, ) -> Option<(PropertyValue, Vec<(ObjectIdentifier, u32)>)>
Evaluate this object’s schedule for the given time. Read more
Source§fn acknowledge_alarm(&mut self, _transition_bit: u8) -> Result<(), Error>
fn acknowledge_alarm(&mut self, _transition_bit: u8) -> Result<(), Error>
Acknowledge an alarm transition. Sets the corresponding bit in acked_transitions.
Returns Ok(()) if the object supports event detection, Err otherwise.
Source§fn apply_life_safety_operation(
&mut self,
_operation: LifeSafetyOperation,
) -> Result<LifeSafetyOperationEffect, Error>
fn apply_life_safety_operation( &mut self, _operation: LifeSafetyOperation, ) -> Result<LifeSafetyOperationEffect, Error>
Apply a LifeSafetyOperation atomically to this object. Read more
Source§fn apply_life_safety_operation_detailed(
&mut self,
operation: LifeSafetyOperation,
) -> Result<LifeSafetyOperationOutcome, Error>
fn apply_life_safety_operation_detailed( &mut self, operation: LifeSafetyOperation, ) -> Result<LifeSafetyOperationOutcome, Error>
Apply a LifeSafetyOperation and report exact known property deltas. Read more
Source§fn set_life_safety_operation_expected_internal(
&mut self,
_operation: LifeSafetyOperation,
) -> Result<(), Error>
fn set_life_safety_operation_expected_internal( &mut self, _operation: LifeSafetyOperation, ) -> Result<(), Error>
Set the next LifeSafetyOperation expected by trusted local logic. Read more
Source§fn set_event_state_internal(&mut self, _state: EventState) -> Result<(), Error>
fn set_event_state_internal(&mut self, _state: EventState) -> Result<(), Error>
Apply an internally-detected
Event_State transition. Read moreSource§fn enrollment_eval_state_internal(&self) -> Option<EventEnrollmentEvalState>
fn enrollment_eval_state_internal(&self) -> Option<EventEnrollmentEvalState>
Snapshot this object’s Event Enrollment evaluation state, if it models one. Read more
Source§fn set_enrollment_eval_state_internal(
&mut self,
_state: EventEnrollmentEvalState,
) -> Result<(), Error>
fn set_enrollment_eval_state_internal( &mut self, _state: EventEnrollmentEvalState, ) -> Result<(), Error>
Store this object’s Event Enrollment evaluation state. Read more
Source§fn enrollment_eval_source_internal(
&self,
) -> Option<Option<EventEnrollmentMonitoredSource>>
fn enrollment_eval_source_internal( &self, ) -> Option<Option<EventEnrollmentMonitoredSource>>
Snapshot the monitored source that owns Event Enrollment private state. Read more
Source§fn set_enrollment_eval_source_internal(
&mut self,
_source: Option<EventEnrollmentMonitoredSource>,
) -> Result<(), Error>
fn set_enrollment_eval_source_internal( &mut self, _source: Option<EventEnrollmentMonitoredSource>, ) -> Result<(), Error>
Store or clear the monitored source that owns Event Enrollment state.
Source§fn set_acked_transitions_internal(
&mut self,
_transition_bit: u8,
_acknowledged: bool,
) -> Result<(), Error>
fn set_acked_transitions_internal( &mut self, _transition_bit: u8, _acknowledged: bool, ) -> Result<(), Error>
Set or clear one
Acked_Transitions bit on a received event-state
transition. Read moreSource§fn evaluate_reliability_internal(
&mut self,
) -> Result<ReliabilityEvaluation, Error>
fn evaluate_reliability_internal( &mut self, ) -> Result<ReliabilityEvaluation, Error>
Evaluate and, when necessary, mutate this object’s
Reliability. Read moreSource§fn set_reliability_internal(&mut self, _reliability: u32) -> Result<(), Error>
fn set_reliability_internal(&mut self, _reliability: u32) -> Result<(), Error>
Apply an internally-derived
Reliability value. Read moreSource§fn set_present_value_internal(
&mut self,
_value: PropertyValue,
) -> Result<(), Error>
fn set_present_value_internal( &mut self, _value: PropertyValue, ) -> Result<(), Error>
Apply the logical
Present_Value supplied by an Input’s application. Read moreSource§fn audit_log_storage_internal(&self) -> Option<&dyn AuditLogStorage>
fn audit_log_storage_internal(&self) -> Option<&dyn AuditLogStorage>
Borrow this object’s Audit Log query storage, if it has any. Read more
Source§fn audit_log_notification_sink_internal(
&mut self,
) -> Option<&mut dyn AuditLogNotificationSink>
fn audit_log_notification_sink_internal( &mut self, ) -> Option<&mut dyn AuditLogNotificationSink>
Mutably borrow this object’s Audit notification receiver capability. Read more
Source§fn file_storage_internal(&self) -> Option<&dyn FileStorage>
fn file_storage_internal(&self) -> Option<&dyn FileStorage>
Borrow this object’s File storage, if it has any. Read more
Source§fn file_storage_internal_mut(&mut self) -> Option<&mut dyn FileStorage>
fn file_storage_internal_mut(&mut self) -> Option<&mut dyn FileStorage>
Mutably borrow this object’s File storage, if it has any. Read more
Source§fn add_trend_record(&mut self, _record: BACnetLogRecord)
fn add_trend_record(&mut self, _record: BACnetLogRecord)
Add a trend log record (only meaningful for TrendLog / TrendLogMultiple). Read more
Auto Trait Implementations§
impl !RefUnwindSafe for EventLogObject
impl !UnwindSafe for EventLogObject
impl Freeze for EventLogObject
impl Send for EventLogObject
impl Sync for EventLogObject
impl Unpin for EventLogObject
impl UnsafeUnpin for EventLogObject
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more