Struct ScheduleObject 

pub struct ScheduleObject { /* private fields */ }

BACnet Schedule object.

Stores schedule configuration. The application is responsible for evaluating the weekly/exception schedule and calling set_present_value(). Present_Value data type matches schedule_default.

Implementations

impl ScheduleObject

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

pub fn set_present_value(&mut self, value: PropertyValue)

Application sets this based on schedule evaluation.

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

Set the description string.

pub fn set_weekly_schedule( &mut self, day_index: usize, entries: Vec<BACnetTimeValue>, )

Set time-value entries for a given day (0=Monday .. 6=Sunday).

pub fn add_exception(&mut self, event: BACnetSpecialEvent)

Append a special event to the exception schedule.

pub fn set_effective_period(&mut self, period: BACnetDateRange)

Set the effective period for this schedule.

pub fn add_object_property_reference( &mut self, r: BACnetObjectPropertyReference, )

Append an object property reference to the list.

pub fn present_value(&self) -> &PropertyValue

Read the current present_value.

pub fn evaluate(&self, day_of_week: u8, hour: u8, minute: u8) -> PropertyValue

Evaluate the schedule for the given day and time.

Returns the current effective value (from exception, weekly, or default). day_of_week: 0=Monday .. 6=Sunday.

Trait Implementations

impl BACnetObject for ScheduleObject

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_list(&self) -> Cow<'static, [PropertyIdentifier]>

List all properties this object supports.

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 (Clause 12.24).

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

List the REQUIRED properties for this object type.

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

COV increment for this object (analog objects only).

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

Evaluate intrinsic reporting after a present_value change.

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.

fn add_trend_record(&mut self, _record: BACnetLogRecord)

Add a trend log record (only meaningful for TrendLog / TrendLogMultiple).