Struct aws_sdk_iotfleetwise::types::Actuator

#[non_exhaustive]
pub struct Actuator {
    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 assigned_value: Option<String>,
    pub deprecation_message: Option<String>,
    pub comment: Option<String>,
    pub struct_fully_qualified_name: Option<String>,
}

A signal that represents a vehicle device such as the engine, heater, and door locks. Data from an actuator reports the state of a certain vehicle device.

Updating actuator data can change the state of a device. For example, you can turn on or off the heater by updating its actuator data.

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 actuator. For example, the fully qualified name of an actuator might be Vehicle.Front.Left.Door.Lock.

data_type: NodeDataType

The specified data type of the actuator.

description: Option<String>

A brief description of the actuator.

unit: Option<String>

The scientific unit for the actuator.

allowed_values: Option<Vec<String>>

A list of possible values an actuator can take.

min: Option<f64>

The specified possible minimum value of an actuator.

max: Option<f64>

The specified possible maximum value of an actuator.

assigned_value: Option<String>

👎Deprecated: assignedValue is no longer in use

A specified value for the actuator.

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 the actuator if the data type of the actuator is Struct or StructArray. For example, the struct fully qualified name of an actuator might be Vehicle.Door.LockStruct.

Implementations

impl Actuator

pub fn fully_qualified_name(&self) -> &str

The fully qualified name of the actuator. For example, the fully qualified name of an actuator might be Vehicle.Front.Left.Door.Lock.

pub fn data_type(&self) -> &NodeDataType

The specified data type of the actuator.

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

A brief description of the actuator.

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

The scientific unit for the actuator.

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

A list of possible values an actuator 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 an actuator.

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

The specified possible maximum value of an actuator.

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

👎Deprecated: assignedValue is no longer in use

A specified value for the actuator.

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 the actuator if the data type of the actuator is Struct or StructArray. For example, the struct fully qualified name of an actuator might be Vehicle.Door.LockStruct.

impl Actuator

pub fn builder() -> ActuatorBuilder

Creates a new builder-style object to manufacture Actuator.

Trait Implementations

impl Clone for Actuator

fn clone(&self) -> Actuator

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Actuator

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

Formats the value using the given formatter.

impl PartialEq for Actuator

fn eq(&self, other: &Actuator) -> 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 Actuator