Struct AccessZoneObject 

pub struct AccessZoneObject { /* private fields */ }

BACnet Access Zone object (type 36).

Represents a physical zone or area controlled by access points. Table 12-37 has neither Present_Value nor Access_Doors, so the object serves neither (#1064).

The zone counts occupancy (#1284): Occupancy_State follows Occupancy_Count, the occupancy limits and Occupancy_Count_Enable, and a client adjusts the count through Adjust_Value. The module zone_occupancy has the rules.

The zone reports intrinsically on Occupancy_State with the CHANGE_OF_STATE algorithm (Clause 12.32; #1305): Event_State goes OFFNORMAL once Occupancy_State has stayed in Alarm_Values for Time_Delay seconds and back to NORMAL once it has stayed out of them for Time_Delay_Normal, and a Reliability other than NO_FAULT_DETECTED puts it in FAULT. The event rows are served and written through ChangeOfStateReporting, and the server sends the notifications to the Notification Class recipients. Alarm_Values never holds NORMAL, the state with no limit crossed: listed, it would put the zone in alarm whenever its count sat inside its limits (#1401).

Entry_Points and Exit_Points list the Access Points leading into and out of the zone as BACnetDeviceObjectReference values (Clauses 12.32.23 and 12.32.24; #1306), set by the application and read-only over the network.

While Out_Of_Service is TRUE a client can simulate Occupancy_Count and Reliability by writing them, and the zone’s own values come back on the return to service (Table 12-37 footnote 1; #1247). The module zone_out_of_service has the details.

Implementations

impl AccessZoneObject

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

Create a new Access Zone object.

pub fn set_entry_points( &mut self, points: impl IntoIterator<Item = impl Into<BACnetDeviceObjectReference>>, ) -> Result<(), Error>

Set Entry_Points, the Access Points leading into the zone (Clause 12.32.23). A reference with no device identifier names an object in this device.

Each reference has to name an Access Point object, and its device identifier, when given, a Device object (#1285); a list breaking either rule is refused with VALUE_OUT_OF_RANGE and the points set before are kept. The list is read-only over the network.

pub fn set_exit_points( &mut self, points: impl IntoIterator<Item = impl Into<BACnetDeviceObjectReference>>, ) -> Result<(), Error>

Set Exit_Points, the Access Points leading out of the zone (Clause 12.32.24), with the checks Self::set_entry_points makes.

pub fn set_alarm_values( &mut self, states: impl IntoIterator<Item = AccessZoneOccupancyState>, ) -> Result<(), Error>

Set Alarm_Values, the occupancy states the zone reports as offnormal (Clause 12.32.27). NORMAL, or a value outside the BACnetAccessZoneOccupancyState production, named or proprietary (64 to 65535), is refused with VALUE_OUT_OF_RANGE naming the element, and the values set before are kept. Clients can write the list too, as they can the zone’s other event configuration (Time_Delay, Notification_Class, Event_Enable and the rest), and meet the same checks.

pub fn set_occupancy_count(&mut self, count: u64)

Record the zone’s occupancy count, as the application’s counting works it out (Clause 12.32.11). Over the network Occupancy_Count takes writes only while Out_Of_Service is TRUE; meanwhile the client’s simulated count keeps being served, and this one takes over on the return to service. While counting is off the count stays zero and the call changes nothing.

pub fn set_occupancy_count_enable(&mut self, enabled: bool)

Set Occupancy_Count_Enable (Clause 12.32.12), read-only over the network. Turning counting off zeroes Occupancy_Count, the count set aside while out of service and Adjust_Value, and Occupancy_State reads DISABLED until counting is turned on again, starting from zero.

pub fn set_occupancy_limits( &mut self, lower: u64, upper: u64, ) -> Result<(), Error>

Set Occupancy_Lower_Limit and Occupancy_Upper_Limit together, zero meaning no limit (Clauses 12.32.14 and 12.32.15). Both are read-only over the network. A nonzero upper limit at or below the lower one is refused with VALUE_OUT_OF_RANGE and both limits are kept.

pub fn occupancy_state(&self) -> AccessZoneOccupancyState

Occupancy_State as served: DISABLED while counting is off, else the served count against the limits (Clause 12.32.6).

Trait Implementations

impl BACnetObject for AccessZoneObject

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

The Reliability the zone’s fault detection works out. Like the other Reliability carriers, the zone refuses it with WRITE_ACCESS_DENIED while Out_Of_Service is TRUE, so a client’s simulated value stays served; the return to service brings back the value from before. A value outside the BACnetReliability production is refused with VALUE_OUT_OF_RANGE.

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 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 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 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_writable_property(&self, property: PropertyIdentifier) -> bool

Whether a property write route can accept property for this object.

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 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 acknowledge_alarm( &mut self, _transition_bit: EventTransitionBits, ) -> Result<(), Error>

Acknowledge an alarm transition. Sets the transition_bit flags in acked_transitions. Returns Ok(()) if the object supports event detection, Err otherwise.

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 set_event_state_internal(&mut self, _state: EventState) -> Result<(), Error>

Apply an internally-detected Event_State transition.

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

Snapshot this object’s Event Enrollment evaluation state, if it models one.

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

Store this object’s Event Enrollment evaluation state.

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 set_acked_transitions_internal( &mut self, _transition_bit: EventTransitionBits, _acknowledged: bool, ) -> Result<(), Error>

Set or clear one Acked_Transitions bit on a received event-state transition.

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

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

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.