pub struct CalendarObject { /* private fields */ }Expand description
BACnet Calendar object.
Present_Value is Boolean — true when today matches one of the date_list
entries. The application is responsible for evaluating the date_list and
calling set_present_value().
Implementations§
Source§impl CalendarObject
impl CalendarObject
pub fn new(instance: u32, name: impl Into<String>) -> Result<Self, Error>
Sourcepub fn set_present_value(&mut self, value: bool)
pub fn set_present_value(&mut self, value: bool)
Application sets this based on date-list evaluation.
Sourcepub fn set_description(&mut self, desc: impl Into<String>)
pub fn set_description(&mut self, desc: impl Into<String>)
Set the description string.
Sourcepub fn add_date_entry(&mut self, entry: BACnetCalendarEntry)
pub fn add_date_entry(&mut self, entry: BACnetCalendarEntry)
Append a calendar entry to the date_list.
Sourcepub fn clear_date_list(&mut self)
pub fn clear_date_list(&mut self)
Remove all entries from the date_list.
Trait Implementations§
Source§impl BACnetObject for CalendarObject
impl BACnetObject for CalendarObject
Source§fn object_identifier(&self) -> ObjectIdentifier
fn object_identifier(&self) -> ObjectIdentifier
The object’s identifier (type + instance).
Source§fn object_name(&self) -> &str
fn object_name(&self) -> &str
The object’s name.
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>
Read a property value.
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>
Write a property value.
Source§fn property_list(&self) -> Cow<'static, [PropertyIdentifier]>
fn property_list(&self) -> Cow<'static, [PropertyIdentifier]>
List all properties this object supports.
Source§fn required_properties(&self) -> Cow<'static, [PropertyIdentifier]>
fn required_properties(&self) -> Cow<'static, [PropertyIdentifier]>
List the REQUIRED properties for this object type. Read more
Source§fn cov_increment(&self) -> Option<f32>
fn cov_increment(&self) -> Option<f32>
COV increment for this object (analog objects only). Read more
Source§fn evaluate_intrinsic_reporting(&mut self) -> Option<EventStateChange>
fn evaluate_intrinsic_reporting(&mut self) -> Option<EventStateChange>
Evaluate intrinsic reporting after a present_value change. Read more
Source§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)>)>
Evaluate this object’s schedule for the given time (Clause 12.24). Read more
Source§fn acknowledge_alarm(&mut self, _transition_bit: u8) -> Result<(), Error>
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.
Source§fn add_trend_record(&mut self, _record: BACnetLogRecord)
fn add_trend_record(&mut self, _record: BACnetLogRecord)
Add a trend log record (only meaningful for TrendLog / TrendLogMultiple). Read more
Auto Trait Implementations§
impl Freeze for CalendarObject
impl RefUnwindSafe for CalendarObject
impl Send for CalendarObject
impl Sync for CalendarObject
impl Unpin for CalendarObject
impl UnsafeUnpin for CalendarObject
impl UnwindSafe for CalendarObject
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more