Struct EventEnrollmentObject 

pub struct EventEnrollmentObject { /* private fields */ }

BACnet EventEnrollment object.

Provides algorithmic event detection for a referenced object property. The event_parameters are stored as a structured BACnetEventParameter, preserving algorithm alternatives and unknown (vendor/reserved) values across a complete property round trip.

Implementations

impl EventEnrollmentObject

pub fn new( instance: u32, name: impl Into<String>, event_type: EventType, ) -> Result<Self, Error>

Create a new EventEnrollment object whose Event_Type is event_type.

pub fn set_description(&mut self, desc: impl Into<String>)

Set the description string.

pub fn set_object_property_reference( &mut self, reference: Option<BACnetDeviceObjectPropertyReference>, ) -> Result<(), Error>

Set Object_Property_Reference, the property the enrollment monitors, or None for none. The property is read-only over the network. A reference whose object or Device is at the reserved instance 4194303 is the unset form, so it leaves the enrollment without one (#1417).

A reference whose device identifier isn’t a Device object is refused with PROPERTY / VALUE_OUT_OF_RANGE and the reference set before is kept (#1308).

pub fn set_event_parameters(&mut self, params: BACnetEventParameter)

Set the structured event parameters.

pub fn set_fault_parameters(&mut self, fp: Option<FaultParameters>)

Set the fault parameters for this event enrollment.

pub fn set_event_state(&mut self, state: EventState)

Set the event state.

A configuration/seeding helper, not a lifecycle path — the evaluator uses BACnetObject::set_event_state_internal. It honors the same Clause 13.2.2.1 rule: while Event_Detection_Enable is FALSE the object must read NORMAL, so a non-NORMAL seed is ignored rather than silently breaking the invariant. Without this the public API would offer a way around a guard the rest of the object enforces.

pub fn set_notification_class(&mut self, nc: u32)

Set the notification class.

pub fn set_event_enable(&mut self, enable: EventTransitionBits)

Set Event_Enable: the transitions whose notifications are distributed.

Flags outside the three named transitions are dropped.

pub fn set_time_delay_normal(&mut self, delay: Option<u32>)

Set Time_Delay_Normal (the pTimeDelayNormal parameter). None restores the not-configured case, which takes on the Event_Parameters Time_Delay value (Clause 13.3 fallback).

Trait Implementations

impl BACnetObject for EventEnrollmentObject

fn set_event_state_internal(&mut self, state: EventState) -> Result<(), Error>

Internal lifecycle path for the algorithmically-derived Event_State.

The evaluator calls this — not write_property(EVENT_STATE, …) — so the network route (which rejects EVENT_STATE) and the internal lifecycle path are distinct (issue #130). Stores the modeled state verbatim; the only caller is the trusted server evaluator.

Refuses any non-NORMAL state while Event_Detection_Enable is FALSE. Clause 13.2.2.1 prohibits transitions in that case, and the server evaluator already skips such objects — this guard makes the invariant hold by construction rather than by the caller remembering, so a future caller cannot reintroduce the violation.

fn enrollment_eval_state_internal(&self) -> Option<EventEnrollmentEvalState>

Snapshot the pending countdown and algorithm baselines for the server evaluator.

fn set_enrollment_eval_state_internal( &mut self, state: EventEnrollmentEvalState, ) -> Result<(), Error>

Store the enrollment evaluation state. Refused while Event_Detection_Enable is FALSE: Clause 13.2.2.1 freezes the state machine by suspending evaluation, and the reset in the write arm has already returned these fields to their initial condition, so a write arriving while disabled can only be stale.

fn acknowledge_alarm( &mut self, transition_bit: EventTransitionBits, ) -> Result<(), Error>

Acknowledge an alarm transition (the AcknowledgeAlarm service route, Clause 13.9): Clause 13.2.3 sets the bit on the acknowledgment indication — unconditional and idempotent, so a repeated ack succeeds again. A detection-DISABLED enrollment instead refuses with OBJECT/NO_ALARM_CONFIGURED, which Table 13-10 uses for an existing object lacking event-generation support or configuration: it can generate nothing, and Clause 12.12 keeps its Acked_Transitions at the initial condition, which an accepted ack would break. Out_Of_Service does not gate the ack: no clause bars acknowledging a notification already issued while the object is out of service.

fn set_acked_transitions_internal( &mut self, transition_bit: EventTransitionBits, acknowledged: bool, ) -> Result<(), Error>

Clause 13.2.3’s transition-received maintenance of Acked_Transitions: the evaluator resolves Ack_Required from the referenced Notification Class object and this call applies the outcome — clear the bit when ack is required, set it otherwise. Refused while detection is disabled, preserving the same invariant as above: Acked_Transitions must retain its initial value throughout the disabled period.

fn is_writable_property(&self, property: PropertyIdentifier) -> bool

Mirrors the write_property arms above, so PICS reports what dispatch actually accepts.

Enumerated explicitly: the intrinsic-reporting objects accept HIGH_LIMIT, LOW_LIMIT, DEADBAND, LIMIT_ENABLE and TIME_DELAY, none of which an Event Enrollment accepts, because it carries those inside Event_Parameters instead. TIME_DELAY_NORMAL is accepted here as a real (O-coded) property, per Table 12-14.

Event_Detection_Enable is writable even though Table 12-14 codes it R rather than W: Clause 12.1.2 lets implementors accept writes to an R property unless that object’s property description expressly forbids them. Clause 12.12 has no such prohibition; it anticipates setting the value during configuration without mandating that timing. Annex K’s AE-AVM-A BIBB (Table K-17) positively requires a conforming workstation to be able to write this property, so refusing the write would be interoperably hostile.

fn object_identifier(&self) -> ObjectIdentifier

The object’s identifier (type + instance).

fn object_name(&self) -> &str

The object’s name.

fn read_property( &self, property: PropertyIdentifier, array_index: Option<u32>, ) -> Result<PropertyValue, Error>

Read a property value.

fn write_property( &mut self, property: PropertyIdentifier, _array_index: Option<u32>, value: PropertyValue, _priority: Option<u8>, ) -> Result<(), Error>

Write a property value.

fn enrollment_eval_source_internal( &self, ) -> Option<Option<EventEnrollmentMonitoredSource>>

Snapshot the monitored source that owns Event Enrollment private state.

fn set_enrollment_eval_source_internal( &mut self, source: Option<EventEnrollmentMonitoredSource>, ) -> Result<(), Error>

Store or clear the monitored source that owns Event Enrollment state.

fn property_metadata(&self) -> Cow<'_, [PropertyMetadata]>

Return canonical metadata for this object’s effective property rows.

fn property_list(&self) -> Cow<'static, [PropertyIdentifier]>

List all properties this object supports in the legacy projection.

fn write_property_from( &mut self, property: PropertyIdentifier, array_index: Option<u32>, value: PropertyValue, priority: Option<u8>, _origin: &CommandOrigin, ) -> Result<(), Error>

Write with explicit actual command provenance. Standalone callers assert the origin; server boundaries additionally validate ingress or membership. Decorators must forward this hook without discarding the origin. The default preserves custom/unaffected object behavior. First-party source-tracked commands require this hook and deny context-free writing.

fn is_array_property(&self, property: PropertyIdentifier) -> bool

Whether property accepts an array index on this object.

fn is_list_property(&self, property: PropertyIdentifier) -> bool

Whether property is a BACnetLIST on this object.

fn is_createable(&self) -> bool

Whether this object type can be created at runtime via CreateObject.

fn creation_only_properties(&self) -> &'static [PropertyIdentifier]

The properties whose whole value a CreateObject initial value may set on this object although WriteProperty can’t change it afterwards.

fn initialize_property( &mut self, _property: PropertyIdentifier, _value: PropertyValue, ) -> Result<(), Error>

Apply a CreateObject initial value to one of Self::creation_only_properties, written whole.

fn is_deleteable(&self) -> bool

Whether this object type can be deleted at runtime via DeleteObject.

fn required_properties(&self) -> Cow<'static, [PropertyIdentifier]>

List the REQUIRED properties for this object type.

fn supports_cov(&self) -> bool

Whether this object type supports COV notifications.

fn supports_subscribe_cov_property(&self) -> bool

Whether SubscribeCOVProperty and SubscribeCOVPropertyMultiple may monitor this object’s properties.

fn supports_cov_property(&self, property: PropertyIdentifier) -> bool

Whether a readable property supports property-specific COV.

fn cov_increment(&self) -> Option<f64>

COV increment for this object (objects with a COV_Increment property).

fn cov_reported_properties(&self) -> &'static [CovReportedProperty]

Properties a whole-object (SubscribeCOV) notification reports after its leading value and Status_Flags, in report order.

fn set_overridden(&mut self, _overridden: bool)

Set the OVERRIDDEN bit in StatusFlags.

fn evaluate_intrinsic_reporting(&mut self) -> Option<TransitionOutcome>

Evaluate intrinsic reporting after a present_value change.

fn tick_intrinsic_reporting(&mut self) -> Option<TransitionOutcome>

Advance the Time_Delay countdown for a pending transition.

fn tick_schedule( &mut self, _today: SpecificDate, _time: Time, _calendar_active: &dyn Fn(ObjectIdentifier) -> bool, ) -> Option<ScheduleWrite>

Evaluate this object’s schedule at time on today (Clause 12.24.4).

fn take_owed_schedule_writes(&mut self) -> Vec<ScheduleWrite>

Take the writes this schedule owes its targets apart from its calculation, each once, in order: a NULL to every priority slot a change of List_Of_Object_Property_References or Priority_For_Writing left behind (#1088), then the Present_Value owed out of service, for a client’s write (Clause 12.24.14) or a change of those two properties.

fn complete_schedule_write( &mut self, _write: &ScheduleWrite, _outcomes: &[ScheduleTargetOutcome], ) -> bool

Report how each target took write, one of this schedule’s writes: outcomes holds one entry per member of write.references, in order.

fn retry_refusals_naming( &self, _target: ObjectIdentifier, ) -> Option<ScheduleWrite>

The retry of the current value to the references whose last write was refused and that name target, an object just added to the database (#1440), so the refusal can clear without waiting for the next pass. None when no such refusal stands, or when the pass itself would retry nothing: out of service, outside Effective_Period, or with a NULL Present_Value. Only meaningful for Schedule objects; default returns None.

fn apply_life_safety_operation( &mut self, _operation: LifeSafetyOperation, ) -> Result<LifeSafetyOperationOutcome, Error>

Apply a LifeSafetyOperation atomically to this object.

fn set_life_safety_operation_expected_internal( &mut self, _operation: LifeSafetyOperation, ) -> Result<(), Error>

Set the next LifeSafetyOperation expected by trusted local logic.

fn evaluate_reliability_internal( &mut self, ) -> Result<ReliabilityEvaluation, Error>

Evaluate and, when necessary, mutate this object’s Reliability.

fn set_reliability_internal( &mut self, _reliability: Reliability, ) -> Result<(), Error>

Apply an internally-derived Reliability value.

fn set_present_value_internal( &mut self, _value: PropertyValue, ) -> Result<(), Error>

Apply the logical Present_Value supplied by the local application.

fn set_present_value_from_internal( &mut self, value: PropertyValue, _origin: &CommandOrigin, ) -> Result<(), Error>

set_present_value_internal on behalf of origin, the local Device the application runs in.

fn set_tracking_value_internal( &mut self, _value: PropertyValue, ) -> Result<(), Error>

Apply the Tracking_Value the local application derived.

fn report_access_input_internal( &mut self, _input: AccessControlInput, ) -> Result<(), Error>

Apply an input the application reports for an access-control object the server holds (#1132): an Access Point’s access event, a Credential Data Input’s read or an Access Door’s hardware state, each a record whose values change together. See AccessControlInput.

fn set_controlled_variable_value_internal( &mut self, _value: PropertyValue, ) -> Result<(), Error>

Apply the Controlled_Variable_Value measured by the local application.

fn add_averaging_sample_internal( &mut self, _sample: Option<PropertyValue>, ) -> Result<(), Error>

Record one sample for an Averaging object.

fn audit_log_storage_internal(&self) -> Option<&dyn AuditLogStorage>

Borrow this object’s Audit Log query storage, if it has any.

fn audit_log_notification_sink_internal( &mut self, ) -> Option<&mut dyn AuditLogNotificationSink>

Mutably borrow this object’s Audit notification receiver capability.

fn file_storage_internal(&self) -> Option<&dyn FileStorage>

Borrow this object’s File storage, if it has any.

fn file_storage_internal_mut(&mut self) -> Option<&mut dyn FileStorage>

Mutably borrow this object’s File storage, if it has any.

fn log_record_identities_internal(&self) -> Option<Vec<LogRecordIdentity>>

Return stable identities aligned with this object’s resident log records.

fn log_buffer_internal(&self) -> Option<&dyn LogBufferRecords>

Borrow this object’s Log_Buffer records as ReadRange pages them.

fn add_trend_record(&mut self, _record: BACnetLogRecord) -> Result<(), Error>

Submit a trend record to an object’s log lifecycle.

fn add_trend_multiple_record( &mut self, _record: BACnetLogMultipleRecord, ) -> Result<(), Error>

Submit a Trend Log Multiple record, one value per monitored member, to an object’s log lifecycle.

fn add_event_log_record( &mut self, _record: BACnetEventLogRecord, ) -> Result<(), Error>

Submit an Event Log record to an object’s log lifecycle.