Struct aws_sdk_iotfleetwise::types::Sensor

#[non_exhaustive]
pub struct Sensor {
    pub fully_qualified_name: String,
    pub data_type: NodeDataType,
    pub description: Option<String>,
    pub unit: Option<String>,
    pub allowed_values: Option<Vec<String>>,
    pub min: Option<f64>,
    pub max: Option<f64>,
    pub deprecation_message: Option<String>,
    pub comment: Option<String>,
    pub struct_fully_qualified_name: Option<String>,
}

An input component that reports the environmental condition of a vehicle.

You can collect data about fluid levels, temperatures, vibrations, or battery voltage from sensors.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

fully_qualified_name: String

The fully qualified name of the sensor. For example, the fully qualified name of a sensor might be Vehicle.Body.Engine.Battery.

data_type: NodeDataType

The specified data type of the sensor.

description: Option<String>

A brief description of a sensor.

unit: Option<String>

The scientific unit of measurement for data collected by the sensor.

allowed_values: Option<Vec<String>>

A list of possible values a sensor can take.

min: Option<f64>

The specified possible minimum value of the sensor.

max: Option<f64>

The specified possible maximum value of the sensor.

deprecation_message: Option<String>

The deprecation message for the node or the branch that was moved or deleted.

comment: Option<String>

A comment in addition to the description.

struct_fully_qualified_name: Option<String>

The fully qualified name of the struct node for a sensor if the data type of the actuator is Struct or StructArray. For example, the struct fully qualified name of a sensor might be Vehicle.ADAS.CameraStruct.

Implementations

impl Sensor

pub fn fully_qualified_name(&self) -> &str

The fully qualified name of the sensor. For example, the fully qualified name of a sensor might be Vehicle.Body.Engine.Battery.

pub fn data_type(&self) -> &NodeDataType

The specified data type of the sensor.

pub fn description(&self) -> Option<&str>

A brief description of a sensor.

pub fn unit(&self) -> Option<&str>

The scientific unit of measurement for data collected by the sensor.

pub fn allowed_values(&self) -> &[String]

A list of possible values a sensor can take.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .allowed_values.is_none().

pub fn min(&self) -> Option<f64>

The specified possible minimum value of the sensor.

pub fn max(&self) -> Option<f64>

The specified possible maximum value of the sensor.

pub fn deprecation_message(&self) -> Option<&str>

The deprecation message for the node or the branch that was moved or deleted.

pub fn comment(&self) -> Option<&str>

A comment in addition to the description.

pub fn struct_fully_qualified_name(&self) -> Option<&str>

The fully qualified name of the struct node for a sensor if the data type of the actuator is Struct or StructArray. For example, the struct fully qualified name of a sensor might be Vehicle.ADAS.CameraStruct.

impl Sensor

pub fn builder() -> SensorBuilder

Creates a new builder-style object to manufacture Sensor.

Trait Implementations

impl Clone for Sensor

fn clone(&self) -> Sensor

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Sensor

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Sensor

fn eq(&self, other: &Sensor) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Sensor