pub struct AnalogValueObject { /* private fields */ }Expand description
BACnet Analog Value object.
Implementations§
Source§impl AnalogValueObject
impl AnalogValueObject
Sourcepub fn set_audit_policy(&mut self, policy: ObjectAuditPolicy)
pub fn set_audit_policy(&mut self, policy: ObjectAuditPolicy)
Provision independently optional Audit properties before registration. Raw object configuration bypasses server notification ownership; use BACnetServer::write_local or WP/WPM for live property mutations.
Sourcepub fn new(
instance: u32,
name: impl Into<String>,
units: u32,
) -> Result<Self, Error>
pub fn new( instance: u32, name: impl Into<String>, units: u32, ) -> Result<Self, Error>
Create a new Analog Value object with a commandable Present_Value.
Sourcepub fn with_access(
instance: u32,
name: impl Into<String>,
units: u32,
access: PresentValueAccess,
) -> Result<Self, Error>
pub fn with_access( instance: u32, name: impl Into<String>, units: u32, access: PresentValueAccess, ) -> Result<Self, Error>
Create a new Analog Value object whose Present_Value is written as access says.
Build with application-owned Tags storage and the requested Present_Value access.
Saved Tags override configured Tags only while Self::set_profile
provisions the row. Loaded data must satisfy the shared Tags rules and
the opt-in 1 MiB snapshot limit.
Sourcepub fn set_profile(&mut self, profile: ObjectProfile) -> Result<(), Error>
pub fn set_profile(&mut self, profile: ObjectProfile) -> Result<(), Error>
Provision independent optional Tags, Profile_Location and Profile_Name rows before registration, in every Present_Value access mode. Tags is writable; the text rows are network read-only. Invalid configuration leaves the previous profile and its attached storage unchanged.
Sourcepub fn wait_for_tag_saves(&self)
pub fn wait_for_tag_saves(&self)
Wait for queued save attempts to finish; writes report their own outcomes. This is not a success receipt. Unstaged synchronous writes block their caller.
Sourcepub fn set_value_source_tracking(&mut self, enabled: bool)
pub fn set_value_source_tracking(&mut self, enabled: bool)
Track the source of a noncommandable Present_Value (Clause 19.5, #1552), provisioned before registration like the audit policy.
On, the object serves Value_Source: the last writer, network or
local, which alone may then correct it. A write must name its writer
(write_property_from), and an application update through
set_present_value_internal leaves no source (NONE). A commandable
object always tracks its sources through Priority_Array, so this
changes nothing on one.
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_min_pres_value(&mut self, value: f32)
pub fn set_min_pres_value(&mut self, value: f32)
Set minimum engineering-bound metadata; this is not a reliability fault limit.
Sourcepub fn set_max_pres_value(&mut self, value: f32)
pub fn set_max_pres_value(&mut self, value: f32)
Set maximum engineering-bound metadata; this is not a reliability fault limit.
Sourcepub fn configure_fault_out_of_range(
&mut self,
low: f32,
high: f32,
) -> Result<(), Error>
pub fn configure_fault_out_of_range( &mut self, low: f32, high: f32, ) -> Result<(), Error>
Configure the optional object-owned FAULT_OUT_OF_RANGE algorithm.
Both limits become readable together. Equal limits are valid; non-finite limits and a low limit greater than the high limit are rejected without changing the prior configuration.
Sourcepub fn set_relinquish_default(&mut self, value: f32) -> Result<(), Error>
pub fn set_relinquish_default(&mut self, value: f32) -> Result<(), Error>
Set the Relinquish_Default (#270).
Validated the same way a commanded Present_Value is (finite Real); after the store, Present_Value is resolved anew from the priority array so an empty array falls back to the new default immediately.
Trait Implementations§
Source§impl BACnetObject for AnalogValueObject
impl BACnetObject for AnalogValueObject
Source§fn is_createable(&self) -> bool
fn is_createable(&self) -> bool
AnalogValue is NOT createable: handle_create_object has no branch for
it, so PICS must not advertise createability the runtime rejects.
Source§fn object_identifier(&self) -> ObjectIdentifier
fn object_identifier(&self) -> ObjectIdentifier
Source§fn object_name(&self) -> &str
fn object_name(&self) -> &str
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>
Source§fn write_property_from(
&mut self,
property: PropertyIdentifier,
array_index: Option<u32>,
value: PropertyValue,
priority: Option<u8>,
origin: &CommandOrigin,
) -> Result<(), Error>
fn write_property_from( &mut self, property: PropertyIdentifier, array_index: Option<u32>, value: PropertyValue, priority: Option<u8>, origin: &CommandOrigin, ) -> Result<(), Error>
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>
Source§fn property_metadata(&self) -> Cow<'_, [PropertyMetadata]>
fn property_metadata(&self) -> Cow<'_, [PropertyMetadata]>
Source§fn property_list(&self) -> Cow<'static, [PropertyIdentifier]>
fn property_list(&self) -> Cow<'static, [PropertyIdentifier]>
Source§fn supports_cov(&self) -> bool
fn supports_cov(&self) -> bool
Source§fn cov_increment(&self) -> Option<f64>
fn cov_increment(&self) -> Option<f64>
Source§fn evaluate_intrinsic_reporting(&mut self) -> Option<TransitionOutcome>
fn evaluate_intrinsic_reporting(&mut self) -> Option<TransitionOutcome>
Source§fn tick_intrinsic_reporting(&mut self) -> Option<TransitionOutcome>
fn tick_intrinsic_reporting(&mut self) -> Option<TransitionOutcome>
Time_Delay countdown for a pending transition. Read moreSource§fn acknowledge_alarm(
&mut self,
transition_bit: EventTransitionBits,
) -> Result<(), Error>
fn acknowledge_alarm( &mut self, transition_bit: EventTransitionBits, ) -> Result<(), Error>
transition_bit flags in acked_transitions.
Returns Ok(()) if the object supports event detection, Err otherwise.Source§fn set_reliability_internal(
&mut self,
reliability: Reliability,
) -> Result<(), Error>
fn set_reliability_internal( &mut self, reliability: Reliability, ) -> Result<(), Error>
Reliability value. Read moreSource§fn set_present_value_internal(
&mut self,
value: PropertyValue,
) -> Result<(), Error>
fn set_present_value_internal( &mut self, value: PropertyValue, ) -> Result<(), Error>
Present_Value supplied by the local application. Read moreSource§fn set_present_value_from_internal(
&mut self,
value: PropertyValue,
origin: &CommandOrigin,
) -> Result<(), Error>
fn set_present_value_from_internal( &mut self, value: PropertyValue, origin: &CommandOrigin, ) -> Result<(), Error>
Source§fn evaluate_reliability_internal(
&mut self,
) -> Result<ReliabilityEvaluation, Error>
fn evaluate_reliability_internal( &mut self, ) -> Result<ReliabilityEvaluation, Error>
Reliability. Read moreSource§fn is_writable_property(&self, property: PropertyIdentifier) -> bool
fn is_writable_property(&self, property: PropertyIdentifier) -> bool
property for this object. Read moreSource§fn is_array_property(&self, property: PropertyIdentifier) -> bool
fn is_array_property(&self, property: PropertyIdentifier) -> bool
property accepts an array index on this object. Read moreSource§fn is_list_property(&self, property: PropertyIdentifier) -> bool
fn is_list_property(&self, property: PropertyIdentifier) -> bool
property is a BACnetLIST on this object. Read moreSource§fn creation_only_properties(&self) -> &'static [PropertyIdentifier]
fn creation_only_properties(&self) -> &'static [PropertyIdentifier]
Source§fn initialize_property(
&mut self,
_property: PropertyIdentifier,
_value: PropertyValue,
) -> Result<(), Error>
fn initialize_property( &mut self, _property: PropertyIdentifier, _value: PropertyValue, ) -> Result<(), Error>
Self::creation_only_properties, written whole. Read moreSource§fn is_deleteable(&self) -> bool
fn is_deleteable(&self) -> bool
Source§fn required_properties(&self) -> Cow<'static, [PropertyIdentifier]>
fn required_properties(&self) -> Cow<'static, [PropertyIdentifier]>
Source§fn supports_subscribe_cov_property(&self) -> bool
fn supports_subscribe_cov_property(&self) -> bool
Source§fn supports_cov_property(&self, property: PropertyIdentifier) -> bool
fn supports_cov_property(&self, property: PropertyIdentifier) -> bool
Source§fn cov_reported_properties(&self) -> &'static [CovReportedProperty]
fn cov_reported_properties(&self) -> &'static [CovReportedProperty]
Source§fn set_overridden(&mut self, _overridden: bool)
fn set_overridden(&mut self, _overridden: bool)
Source§fn tick_schedule(
&mut self,
_today: SpecificDate,
_time: Time,
_calendar_active: &dyn Fn(ObjectIdentifier) -> bool,
) -> Option<ScheduleWrite>
fn tick_schedule( &mut self, _today: SpecificDate, _time: Time, _calendar_active: &dyn Fn(ObjectIdentifier) -> bool, ) -> Option<ScheduleWrite>
Source§fn take_owed_schedule_writes(&mut self) -> Vec<ScheduleWrite>
fn take_owed_schedule_writes(&mut self) -> Vec<ScheduleWrite>
Source§fn complete_schedule_write(
&mut self,
_write: &ScheduleWrite,
_outcomes: &[ScheduleTargetOutcome],
) -> bool
fn complete_schedule_write( &mut self, _write: &ScheduleWrite, _outcomes: &[ScheduleTargetOutcome], ) -> bool
write, one of this schedule’s writes:
outcomes holds one entry per member of write.references, in order. Read moreSource§fn retry_refusals_naming(
&self,
_target: ObjectIdentifier,
) -> Option<ScheduleWrite>
fn retry_refusals_naming( &self, _target: ObjectIdentifier, ) -> Option<ScheduleWrite>
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.Source§fn apply_life_safety_operation(
&mut self,
_operation: LifeSafetyOperation,
) -> Result<LifeSafetyOperationOutcome, Error>
fn apply_life_safety_operation( &mut self, _operation: LifeSafetyOperation, ) -> Result<LifeSafetyOperationOutcome, Error>
Source§fn set_life_safety_operation_expected_internal(
&mut self,
_operation: LifeSafetyOperation,
) -> Result<(), Error>
fn set_life_safety_operation_expected_internal( &mut self, _operation: LifeSafetyOperation, ) -> Result<(), Error>
Source§fn set_event_state_internal(&mut self, _state: EventState) -> Result<(), Error>
fn set_event_state_internal(&mut self, _state: EventState) -> Result<(), Error>
Event_State transition. Read moreSource§fn enrollment_eval_state_internal(&self) -> Option<EventEnrollmentEvalState>
fn enrollment_eval_state_internal(&self) -> Option<EventEnrollmentEvalState>
Source§fn set_enrollment_eval_state_internal(
&mut self,
_state: EventEnrollmentEvalState,
) -> Result<(), Error>
fn set_enrollment_eval_state_internal( &mut self, _state: EventEnrollmentEvalState, ) -> Result<(), Error>
Source§fn enrollment_eval_source_internal(
&self,
) -> Option<Option<EventEnrollmentMonitoredSource>>
fn enrollment_eval_source_internal( &self, ) -> Option<Option<EventEnrollmentMonitoredSource>>
Source§fn set_enrollment_eval_source_internal(
&mut self,
_source: Option<EventEnrollmentMonitoredSource>,
) -> Result<(), Error>
fn set_enrollment_eval_source_internal( &mut self, _source: Option<EventEnrollmentMonitoredSource>, ) -> Result<(), Error>
Source§fn set_acked_transitions_internal(
&mut self,
_transition_bit: EventTransitionBits,
_acknowledged: bool,
) -> Result<(), Error>
fn set_acked_transitions_internal( &mut self, _transition_bit: EventTransitionBits, _acknowledged: bool, ) -> Result<(), Error>
Acked_Transitions bit on a received event-state
transition. Read moreSource§fn set_tracking_value_internal(
&mut self,
_value: PropertyValue,
) -> Result<(), Error>
fn set_tracking_value_internal( &mut self, _value: PropertyValue, ) -> Result<(), Error>
Tracking_Value the local application derived. Read moreSource§fn report_access_input_internal(
&mut self,
_input: AccessControlInput,
) -> Result<(), Error>
fn report_access_input_internal( &mut self, _input: AccessControlInput, ) -> Result<(), Error>
AccessControlInput. Read more