Struct robotics_signals::sensors::magnetic_field::MagneticField
source · [−]#[repr(C)]pub struct MagneticField {
pub header: Header,
pub magnetic_field: Vector3,
pub magnetic_field_covariance: [f64; 9],
}Fields
header: Headertimestamp is the time the field was measured frame_id is the location and orientation of the field measurement
magnetic_field: Vector3x, y, and z components of the field vector in Tesla If your sensor does not output 3 axes, put NaNs in the components not reported.
magnetic_field_covariance: [f64; 9]Row major about x, y, z axes 0 is interpreted as variance unknown
Implementations
sourceimpl MagneticField
impl MagneticField
sourcepub fn create_topic_with_name(
participant: &DdsParticipant,
name: &str,
maybe_qos: Option<DdsQos>,
maybe_listener: Option<DdsListener>
) -> Result<DdsTopic<Self>, DDSError>
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 createdname- The name of the topicmaybe_qos- A QoS structure for this topic. The Qos is optionalmaybe_listener- A listener to use on this topic. The listener is optional
sourcepub fn create_topic(
participant: &DdsParticipant,
maybe_topic_prefix: Option<&str>,
maybe_qos: Option<DdsQos>,
maybe_listener: Option<DdsListener>
) -> Result<DdsTopic<Self>, DDSError>
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 createdmaybe_topic_prefix- An additional prefix to be added to the topic name. This can be Nonemaybe_qos- A QoS structure for this topic. The Qos is optionalmaybe_listener- A listener to use on this topic. The listener is optional
sourcepub fn create_sample_buffer(len: usize) -> SampleBuffer<MagneticField>
pub fn create_sample_buffer(len: usize) -> SampleBuffer<MagneticField>
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.