pub struct AlertEnrollmentObject {
pub present_value: ObjectIdentifier,
pub event_detection_enable: bool,
pub event_enable: u8,
pub notification_class: u32,
/* private fields */
}Expand description
BACnet AlertEnrollment object (type 52).
Provides the Alert Enrollment property surface from ASHRAE 135-2020 Table
12-61. Present_Value identifies the object that last provided an alert;
recording that source does not itself evaluate or generate an event.
Fields§
§present_value: ObjectIdentifierObject that last provided an alert.
event_detection_enable: boolWhether event detection is enabled.
Prefer Self::set_event_detection_enable so disabling also clears
stored event state. This field remains public for compatibility;
property reads and internal transition hooks still enforce the
disabled-state invariant after a direct assignment. Re-enable through
the setter as well: a direct FALSE-to-TRUE assignment cannot run the
reset and may expose state stored before the direct disable.
event_enable: u8Event enable bits: 3-bit (TO_OFFNORMAL, TO_FAULT, TO_NORMAL).
notification_class: u32Notification class number.
Implementations§
Source§impl AlertEnrollmentObject
impl AlertEnrollmentObject
Sourcepub fn new(
instance: u32,
name: impl Into<String>,
initial_source: ObjectIdentifier,
) -> Result<Self, Error>
pub fn new( instance: u32, name: impl Into<String>, initial_source: ObjectIdentifier, ) -> Result<Self, Error>
Create a new AlertEnrollment object with the object that most recently provided an alert.
Sourcepub fn record_alert_source(&mut self, source: ObjectIdentifier)
pub fn record_alert_source(&mut self, source: ObjectIdentifier)
Record the object that most recently provided an alert.
This source-ownership hook updates only Present_Value; it does not
evaluate an alert, change event/acknowledgement history, or generate a
notification.
Sourcepub fn set_event_detection_enable(&mut self, enabled: bool)
pub fn set_event_detection_enable(&mut self, enabled: bool)
Enable or disable event detection.
Disabling applies the Clause 13.2.2.1 initial conditions immediately.
Trait Implementations§
Source§impl BACnetObject for AlertEnrollmentObject
impl BACnetObject for AlertEnrollmentObject
Source§fn object_identifier(&self) -> ObjectIdentifier
fn object_identifier(&self) -> ObjectIdentifier
Source§fn object_name(&self) -> &str
fn object_name(&self) -> &str
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>
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>
Source§fn set_event_state_internal(&mut self, state: EventState) -> Result<(), Error>
fn set_event_state_internal(&mut self, state: EventState) -> Result<(), Error>
Event_State transition. Read moreSource§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>
Acked_Transitions bit on a received event-state
transition. Read moreSource§fn is_writable_property(&self, property: PropertyIdentifier) -> bool
fn is_writable_property(&self, property: PropertyIdentifier) -> bool
Source§fn property_metadata(&self) -> Cow<'_, [PropertyMetadata]>
fn property_metadata(&self) -> Cow<'_, [PropertyMetadata]>
Source§fn property_list(&self) -> Cow<'static, [PropertyIdentifier]>
fn property_list(&self) -> Cow<'static, [PropertyIdentifier]>
Source§fn is_array_property(&self, property: PropertyIdentifier) -> bool
fn is_array_property(&self, property: PropertyIdentifier) -> bool
property accepts an array index on this object. Read moreSource§fn is_createable(&self) -> bool
fn is_createable(&self) -> bool
Source§fn is_deleteable(&self) -> bool
fn is_deleteable(&self) -> bool
Source§fn required_properties(&self) -> Cow<'static, [PropertyIdentifier]>
fn required_properties(&self) -> Cow<'static, [PropertyIdentifier]>
Source§fn supports_cov(&self) -> bool
fn supports_cov(&self) -> bool
Source§fn supports_cov_property(&self, property: PropertyIdentifier) -> bool
fn supports_cov_property(&self, property: PropertyIdentifier) -> bool
Source§fn cov_increment(&self) -> Option<f32>
fn cov_increment(&self) -> Option<f32>
Source§fn set_overridden(&mut self, _overridden: bool)
fn set_overridden(&mut self, _overridden: bool)
Source§fn evaluate_intrinsic_reporting(&mut self) -> Option<TransitionOutcome>
fn evaluate_intrinsic_reporting(&mut self) -> Option<TransitionOutcome>
Source§fn tick_intrinsic_reporting(&mut self) -> Option<TransitionOutcome>
fn tick_intrinsic_reporting(&mut self) -> Option<TransitionOutcome>
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)>)>
Source§fn acknowledge_alarm(&mut self, _transition_bit: u8) -> Result<(), Error>
fn acknowledge_alarm(&mut self, _transition_bit: u8) -> Result<(), Error>
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>
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>
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>
Source§fn enrollment_eval_state_internal(&self) -> Option<EventEnrollmentEvalState>
fn enrollment_eval_state_internal(&self) -> Option<EventEnrollmentEvalState>
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>
Source§fn enrollment_eval_source_internal(
&self,
) -> Option<Option<EventEnrollmentMonitoredSource>>
fn enrollment_eval_source_internal( &self, ) -> Option<Option<EventEnrollmentMonitoredSource>>
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>
Source§fn evaluate_reliability_internal(
&mut self,
) -> Result<ReliabilityEvaluation, Error>
fn evaluate_reliability_internal( &mut self, ) -> Result<ReliabilityEvaluation, Error>
Reliability. Read moreSource§fn set_reliability_internal(&mut self, _reliability: u32) -> Result<(), Error>
fn set_reliability_internal(&mut self, _reliability: u32) -> Result<(), Error>
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>
Present_Value supplied by an Input’s application. Read more