Struct LiftObject 

pub struct LiftObject { /* private fields */ }

BACnet Lift object — represents a single lift/elevator car.

The object serves the rows of its table (Clause 12.59, Table 12-77) that it implements, each with its table datatype. The per-door arrays (Car_Door_Status, Landing_Door_Status, Assigned_Landing_Calls, Making_Car_Call, Registered_Car_Call and Car_Door_Command) hold one element per car door and always have the same size, as Clause 12.59 requires. They, and Car_Assigned_Direction, Car_Door_Zone, Car_Mode, Next_Stopping_Floor and Car_Drive_Status, are set by the application in service and take WriteProperty only while Out_Of_Service is TRUE.

Implementations

impl LiftObject

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

Create a new Lift object with the given number of floors.

Floor text is initialized to “Floor 1”, “Floor 2”, etc. The car stands at floor 1 with one door, whose status is UNKNOWN and which reports no landing doors, calls or door command, and Car_Load is 0.0 percent. Car_Assigned_Direction, Car_Mode and Car_Drive_Status start UNKNOWN, Car_Door_Zone FALSE and Next_Stopping_Floor 1.

pub fn elevator_group(&self) -> ObjectIdentifier

The Elevator Group object served as Elevator_Group. Until the application sets one it names instance 4194303, the reference Clauses 12.59 and 12.60 use when no Elevator Group lists this lift.

pub fn set_elevator_group(&mut self, oid: ObjectIdentifier) -> Result<(), Error>

Set which Elevator Group counts this lift among its Group_Members.

Elevator_Group is read-only over the network, so this is the only way to change it. A reference to any other object type is refused with VALUE_OUT_OF_RANGE and the property is left unchanged.

pub fn group_id(&self) -> u8

The identification number of the group, served as Group_ID.

pub fn set_group_id(&mut self, group_id: u8)

Set the identification number of the group of the lift.

Group_ID is an Unsigned8 that is read-only over the network, so this is the only way to change it.

pub fn installation_id(&self) -> u8

The identification number of the lift, served as Installation_ID.

pub fn set_installation_id(&mut self, installation_id: u8)

Set the identification number of the lift within its group.

Installation_ID is an Unsigned8 that is read-only over the network, so this is the only way to change it.

pub fn energy_meter_ref(&self) -> &BACnetDeviceObjectReference

The reference served as Energy_Meter_Ref. Until the application sets one it is uninitialized: Accumulator instance 4194303 with no device.

pub fn set_energy_meter_ref( &mut self, reference: BACnetDeviceObjectReference, ) -> Result<(), Error>

Point Energy_Meter_Ref at the meter object that totals the energy used by this lift.

Energy_Meter_Ref is read-only over the network, so this is the only way to change it. The object must be an Accumulator, Pulse Converter, Analog Input, Analog Value, Large Analog Value, Integer Value, Positive Integer Value or proprietary object type (128 to 1023), and a device, when given, a Device object; anything else is refused with VALUE_OUT_OF_RANGE and the property is left unchanged.

While the reference names an instance other than 4194303, Energy_Meter reads 0.0 (Clauses 12.59 and 12.60): setting it zeroes the reading, and a write of any other value is refused with VALUE_OUT_OF_RANGE. A reference to instance 4194303 clears it, and Energy_Meter then takes writes again, starting from 0.0.

pub fn car_door_status(&self) -> &[DoorStatus]

The status of each car door, served as Car_Door_Status.

pub fn set_car_door_status( &mut self, status: Vec<DoorStatus>, ) -> Result<(), Error>

Set the status of each car door, one element per door.

Its size is the number of car doors, so a list of a different size changes that number, and the other per-door arrays follow: a removed door’s elements are dropped, and an added door starts with no landing doors, no assigned or registered calls, a Making_Car_Call of 0 and a Car_Door_Command of NONE. A WriteProperty, accepted only while Out_Of_Service is TRUE, can’t change the size, so this is the only way to. A status outside BACnetDoorStatus (a reserved value, or one above 65535) is refused with VALUE_OUT_OF_RANGE and nothing changes.

pub fn landing_door_status(&self) -> &[BACnetLandingDoorStatus]

The landing doors of each car door, served as Landing_Door_Status.

pub fn set_landing_door_status( &mut self, status: Vec<BACnetLandingDoorStatus>, ) -> Result<(), Error>

Set the landing doors of each car door, one element per car door.

A list whose size differs from Car_Door_Status, or a landing door status outside BACnetDoorStatus, is refused with VALUE_OUT_OF_RANGE and the property is left unchanged. A WriteProperty, accepted only while Out_Of_Service is TRUE, follows the same rules.

pub fn assigned_landing_calls(&self) -> &[BACnetAssignedLandingCalls]

The landing calls assigned to each car door, served as Assigned_Landing_Calls.

pub fn set_assigned_landing_calls( &mut self, calls: Vec<BACnetAssignedLandingCalls>, ) -> Result<(), Error>

Set the landing calls assigned to each car door, one element per car door.

A list whose size differs from Car_Door_Status, or a call whose direction is outside BACnetLiftCarDirection, is refused with VALUE_OUT_OF_RANGE and the property is left unchanged. A WriteProperty, accepted only while Out_Of_Service is TRUE, follows the same rules.

pub fn making_car_call(&self) -> &[u8]

The last car call made for each car door, served as Making_Car_Call: a universal floor number, or 0 when no call has been made.

pub fn set_making_car_call(&mut self, floors: Vec<u8>) -> Result<(), Error>

Set the last car call made for each car door, one element per car door.

A list whose size differs from Car_Door_Status is refused with VALUE_OUT_OF_RANGE and the property is left unchanged. A WriteProperty, accepted only while Out_Of_Service is TRUE, follows the same rule.

pub fn registered_car_call(&self) -> &[BACnetLiftCarCallList]

The floors with a car call registered for each car door, served as Registered_Car_Call.

pub fn set_registered_car_call( &mut self, calls: Vec<BACnetLiftCarCallList>, ) -> Result<(), Error>

Set the floors with a car call registered for each car door, one element per car door.

A list whose size differs from Car_Door_Status is refused with VALUE_OUT_OF_RANGE and the property is left unchanged. A WriteProperty, accepted only while Out_Of_Service is TRUE, follows the same rule.

pub fn car_door_command(&self) -> &[LiftCarDoorCommand]

The pending command of each car door, served as Car_Door_Command.

pub fn set_car_door_command( &mut self, commands: Vec<LiftCarDoorCommand>, ) -> Result<(), Error>

Set the pending command of each car door, one element per car door, for instance back to NONE once a command has run.

A list whose size differs from Car_Door_Status, or a command other than NONE, OPEN or CLOSE, is refused with VALUE_OUT_OF_RANGE and the property is left unchanged. A WriteProperty, accepted only while Out_Of_Service is TRUE, follows the same rules.

pub fn car_assigned_direction(&self) -> LiftCarDirection

The direction the car is assigned to move, served as Car_Assigned_Direction.

pub fn set_car_assigned_direction( &mut self, direction: LiftCarDirection, ) -> Result<(), Error>

Set the direction the car is assigned to move.

A direction outside BACnetLiftCarDirection is refused with VALUE_OUT_OF_RANGE and the property is left unchanged.

pub fn car_door_zone(&self) -> bool

Whether the car sits in its door zone, served as Car_Door_Zone.

pub fn set_car_door_zone(&mut self, in_zone: bool)

Set whether the car sits in its door zone, close enough to a landing that its doors may begin to open.

pub fn car_mode(&self) -> LiftCarMode

The car’s operating mode, served as Car_Mode.

pub fn set_car_mode(&mut self, mode: LiftCarMode) -> Result<(), Error>

Set the car’s operating mode.

A mode outside BACnetLiftCarMode is refused with VALUE_OUT_OF_RANGE and the property is left unchanged.

pub fn next_stopping_floor(&self) -> u8

The floor of the car’s next stop (universal numbering), served as Next_Stopping_Floor.

pub fn set_next_stopping_floor(&mut self, floor: u8)

Set the floor of the car’s next stop, or, while it stands still, the floor it is at.

pub fn car_drive_status(&self) -> LiftCarDriveStatus

The state of the car’s motor drive, served as Car_Drive_Status.

pub fn set_car_drive_status( &mut self, status: LiftCarDriveStatus, ) -> Result<(), Error>

Set the state of the car’s motor drive.

A status outside BACnetLiftCarDriveStatus is refused with VALUE_OUT_OF_RANGE and the property is left unchanged.

pub fn car_load_units(&self) -> EngineeringUnits

The units of Car_Load, served as Car_Load_Units.

pub fn set_car_load_units( &mut self, units: EngineeringUnits, ) -> Result<(), Error>

Set the units Car_Load is measured in. A new Lift uses PERCENT.

Car_Load_Units is read-only over the network. A value above 65535, outside BACnetEngineeringUnits, is refused with VALUE_OUT_OF_RANGE and the property is left unchanged.

Trait Implementations

impl BACnetObject for LiftObject

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