Struct sbp::messages::ndb::msg_ndb_event::MsgNdbEvent

pub struct MsgNdbEvent {
    pub sender_id: Option<u16>,
    pub recv_time: u64,
    pub event: u8,
    pub object_type: u8,
    pub result: u8,
    pub data_source: u8,
    pub object_sid: GnssSignal,
    pub src_sid: GnssSignal,
    pub original_sender: u16,
}

Navigation DataBase Event

This message is sent out when an object is stored into NDB. If needed message could also be sent out when fetching an object from NDB.

Fields

sender_id: Option<u16>

The message sender_id

recv_time: u64

HW time in milliseconds.

event: u8

Event type.

object_type: u8

Event object type.

result: u8

Event result.

data_source: u8

Data source for STORE event, reserved for other events.

object_sid: GnssSignal

GNSS signal identifier, If object_type is Ephemeris OR Almanac, sid indicates for which signal the object belongs to. Reserved in other cases.

src_sid: GnssSignal

GNSS signal identifier, If object_type is Almanac, Almanac WN, Iono OR L2C capabilities AND data_source is NDB_DS_RECEIVER sid indicates from which SV data was decoded. Reserved in other cases.

original_sender: u16

A unique identifier of the sending hardware. For v1.0, set to the 2 least significant bytes of the device serial number, valid only if data_source is NDB_DS_SBP. Reserved in case of other data_source.

Implementations

impl MsgNdbEvent

pub fn event_type(&self) -> Result<EventType, u8>

Gets the EventType stored in the event bitfield.

Returns Ok if the bitrange contains a known EventType variant. Otherwise the value of the bitrange is returned as an Err(u8). This may be because of a malformed message, or because new variants of EventType were added.

pub fn set_event_type(&mut self, event_type: EventType)

Set the bitrange corresponding to the EventType of the event bitfield.

pub fn event_object_type(&self) -> Result<EventObjectType, u8>

Gets the EventObjectType stored in the object_type bitfield.

Returns Ok if the bitrange contains a known EventObjectType variant. Otherwise the value of the bitrange is returned as an Err(u8). This may be because of a malformed message, or because new variants of EventObjectType were added.

pub fn set_event_object_type(&mut self, event_object_type: EventObjectType)

Set the bitrange corresponding to the EventObjectType of the object_type bitfield.

pub fn event_result(&self) -> Result<EventResult, u8>

Gets the EventResult stored in the result bitfield.

Returns Ok if the bitrange contains a known EventResult variant. Otherwise the value of the bitrange is returned as an Err(u8). This may be because of a malformed message, or because new variants of EventResult were added.

pub fn set_event_result(&mut self, event_result: EventResult)

Set the bitrange corresponding to the EventResult of the result bitfield.

pub fn data_source(&self) -> Result<DataSource, u8>

Gets the DataSource stored in the data_source bitfield.

Returns Ok if the bitrange contains a known DataSource variant. Otherwise the value of the bitrange is returned as an Err(u8). This may be because of a malformed message, or because new variants of DataSource were added.

pub fn set_data_source(&mut self, data_source: DataSource)

Set the bitrange corresponding to the DataSource of the data_source bitfield.

Trait Implementations

impl Clone for MsgNdbEvent

fn clone(&self) -> MsgNdbEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ConcreteMessage for MsgNdbEvent

const MESSAGE_TYPE: u16 = 1_024u16

The message type.

const MESSAGE_NAME: &'static str = "MSG_NDB_EVENT"

The message name.

impl Debug for MsgNdbEvent

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

Formats the value using the given formatter.

impl From<MsgNdbEvent> for Sbp

fn from(msg: MsgNdbEvent) -> Self

Converts to this type from the input type.

impl SbpMessage for MsgNdbEvent

fn message_name(&self) -> &'static str

Get the message name.

fn message_type(&self) -> u16

Get the message type.

fn sender_id(&self) -> Option<u16>

Get the sender_id if it is set.

fn set_sender_id(&mut self, new_id: u16)

Set the sender id.

fn encoded_len(&self) -> usize

Number of bytes this message will take on the wire.

impl TryFrom<Sbp> for MsgNdbEvent

type Error = TryFromSbpError

The type returned in the event of a conversion error.

fn try_from(msg: Sbp) -> Result<Self, Self::Error>

Performs the conversion.