Struct Illuminance 

#[repr(C)]
pub struct Illuminance {
    pub header: Header,
    pub illuminance: f64,
    pub variance: f64,
}

Single photometric illuminance measurement. Light should be assumed to be measured along the sensor’s x-axis (the area of detection is the y-z plane). The illuminance should have a 0 or positive value and be received with the sensor’s +X axis pointing toward the light source.

Photometric illuminance is the measure of the human eye’s sensitivity of the intensity of light encountering or passing through a surface.

All other Photometric and Radiometric measurements should not use this message. This message cannot represent:

• Luminous intensity (candela/light source output)
• Luminance (nits/light output per area)
• Irradiance (watt/area), etc.

Fields

header: Header

frame_id is the location and direction of the reading

illuminance: f64

Measurement of the Photometric Illuminance in Lux.

variance: f64

0 is interpreted as variance unknown

Implementations

impl Illuminance

pub fn create_topic_with_name( participant: &DdsParticipant, name: &str, maybe_qos: Option<DdsQos>, maybe_listener: Option<DdsListener>, ) -> Result<DdsTopic<Self>, DDSError>

Create a topic using of this Type specifying the topic name

Arguments

• participant - The participant handle onto which this topic should be created
• name - The name of the topic
• maybe_qos - A QoS structure for this topic. The Qos is optional
• maybe_listener - A listener to use on this topic. The listener is optional

pub fn create_topic( participant: &DdsParticipant, maybe_topic_prefix: Option<&str>, maybe_qos: Option<DdsQos>, maybe_listener: Option<DdsListener>, ) -> Result<DdsTopic<Self>, DDSError>

Create a topic of this Type using the default topic name. The default topic name is provided by the Self::topic_name function.

Arguments

• participant - The participant handle onto which this topic should be created
• maybe_topic_prefix - An additional prefix to be added to the topic name. This can be None
• maybe_qos - A QoS structure for this topic. The Qos is optional
• maybe_listener - A listener to use on this topic. The listener is optional

pub fn create_sample_buffer(len: usize) -> SampleBuffer<Illuminance>

Create a sample buffer for storing an array of samples You can pass the sample buffer into a read to read multiple samples. Multiple samples are useful when you have one or more keys in your topic structure. Each value of the key will result in the storage of another sample.

Trait Implementations

impl<'de> Deserialize<'de> for Illuminance

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Illuminance

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TopicType for Illuminance

fn key_cdr(&self) -> Vec<u8>

return the cdr encoding for the key. The encoded string includes the four byte encapsulation string.

fn is_fixed_size() -> bool

fn has_key() -> bool

fn force_md5_keyhash() -> bool

fn hash(&self, basehash: u32) -> u32

fn typename() -> CString

The type name for this topic

fn topic_name(maybe_prefix: Option<&str>) -> String

The default topic_name to use when creating a topic of this type. The default implementation uses ‘/’ instead of ‘::’ to form a unix like path. A prefix can optionally be added