pub struct LoopObject { /* private fields */ }Expand description
BACnet Loop object — PID control loop configuration and state.
Implementations§
Source§impl LoopObject
impl LoopObject
pub fn new( instance: u32, name: impl Into<String>, output_units: u32, ) -> Result<Self, Error>
Sourcepub fn set_present_value(&mut self, value: f32)
pub fn set_present_value(&mut self, value: f32)
Application sets the current output value after PID computation.
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 set_controlled_variable_reference(
&mut self,
r: BACnetObjectPropertyReference,
)
pub fn set_controlled_variable_reference( &mut self, r: BACnetObjectPropertyReference, )
Set the controlled variable reference (the object whose present value is being controlled by this loop).
Sourcepub fn set_manipulated_variable_reference(
&mut self,
r: BACnetObjectPropertyReference,
)
pub fn set_manipulated_variable_reference( &mut self, r: BACnetObjectPropertyReference, )
Set the manipulated variable reference (the object that the loop output drives to achieve the setpoint).
Sourcepub fn set_setpoint_reference(&mut self, r: BACnetObjectPropertyReference)
pub fn set_setpoint_reference(&mut self, r: BACnetObjectPropertyReference)
Set the setpoint reference (an alternative way to supply the setpoint
from another object’s property instead of the inline SETPOINT value).
Trait Implementations§
Source§impl BACnetObject for LoopObject
impl BACnetObject for LoopObject
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 LoopObject
impl RefUnwindSafe for LoopObject
impl Send for LoopObject
impl Sync for LoopObject
impl Unpin for LoopObject
impl UnsafeUnpin for LoopObject
impl UnwindSafe for LoopObject
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