Struct sbp::messages::integrity::msg_acknowledge::MsgAcknowledge

pub struct MsgAcknowledge {
    pub sender_id: Option<u16>,
    pub request_id: u8,
    pub area_id: u32,
    pub response_code: u8,
    pub correction_mask_on_demand: u16,
    pub correction_mask_stream: u16,
    pub solution_id: u8,
}

Acknowledgement message in response to a request for corrections

Fields

sender_id: Option<u16>

The message sender_id

request_id: u8

Echo of the request ID field from the corresponding CRA message, or 255 if no request ID was provided.

area_id: u32

Echo of the Area ID field from the corresponding CRA message.

response_code: u8

Reported status of the request.

correction_mask_on_demand: u16

Contains the message group(s) that will be sent in response from the corresponding CRA correction mask. An echo of the correction mask field from the corresponding CRA message.

correction_mask_stream: u16

For future expansion. Always set to 0.

solution_id: u8

The solution ID of the instance providing the corrections.

Implementations

impl MsgAcknowledge

pub fn response_code(&self) -> Result<ResponseCode, u8>

Gets the ResponseCode stored in the response_code bitfield.

Returns Ok if the bitrange contains a known ResponseCode 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 ResponseCode were added.

pub fn set_response_code(&mut self, response_code: ResponseCode)

Set the bitrange corresponding to the ResponseCode of the response_code bitfield.

pub fn corrections_certificate(&self) -> Result<CorrectionsCertificate, u8>

Gets the CorrectionsCertificate stored in the correction_mask_on_demand bitfield.

Returns Ok if the bitrange contains a known CorrectionsCertificate 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 CorrectionsCertificate were added.

pub fn set_corrections_certificate( &mut self, corrections_certificate: CorrectionsCertificate )

Set the bitrange corresponding to the CorrectionsCertificate of the correction_mask_on_demand bitfield.

pub fn low_rate_messages(&self) -> Result<LowRateMessages, u8>

Gets the LowRateMessages stored in the correction_mask_on_demand bitfield.

Returns Ok if the bitrange contains a known LowRateMessages 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 LowRateMessages were added.

pub fn set_low_rate_messages(&mut self, low_rate_messages: LowRateMessages)

Set the bitrange corresponding to the LowRateMessages of the correction_mask_on_demand bitfield.

pub fn ephemeris(&self) -> Result<Ephemeris, u8>

Gets the Ephemeris stored in the correction_mask_on_demand bitfield.

Returns Ok if the bitrange contains a known Ephemeris 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 Ephemeris were added.

pub fn set_ephemeris(&mut self, ephemeris: Ephemeris)

Set the bitrange corresponding to the Ephemeris of the correction_mask_on_demand bitfield.

pub fn satellite_clock(&self) -> Result<SatelliteClock, u8>

Gets the SatelliteClock stored in the correction_mask_on_demand bitfield.

Returns Ok if the bitrange contains a known SatelliteClock 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 SatelliteClock were added.

pub fn set_satellite_clock(&mut self, satellite_clock: SatelliteClock)

Set the bitrange corresponding to the SatelliteClock of the correction_mask_on_demand bitfield.

pub fn satellite_orbit(&self) -> Result<SatelliteOrbit, u8>

Gets the SatelliteOrbit stored in the correction_mask_on_demand bitfield.

Returns Ok if the bitrange contains a known SatelliteOrbit 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 SatelliteOrbit were added.

pub fn set_satellite_orbit(&mut self, satellite_orbit: SatelliteOrbit)

Set the bitrange corresponding to the SatelliteOrbit of the correction_mask_on_demand bitfield.

pub fn satellite_code_bias(&self) -> Result<SatelliteCodeBias, u8>

Gets the SatelliteCodeBias stored in the correction_mask_on_demand bitfield.

Returns Ok if the bitrange contains a known SatelliteCodeBias 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 SatelliteCodeBias were added.

pub fn set_satellite_code_bias( &mut self, satellite_code_bias: SatelliteCodeBias )

Set the bitrange corresponding to the SatelliteCodeBias of the correction_mask_on_demand bitfield.

pub fn satellite_phase_bias(&self) -> Result<SatellitePhaseBias, u8>

Gets the SatellitePhaseBias stored in the correction_mask_on_demand bitfield.

Returns Ok if the bitrange contains a known SatellitePhaseBias 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 SatellitePhaseBias were added.

pub fn set_satellite_phase_bias( &mut self, satellite_phase_bias: SatellitePhaseBias )

Set the bitrange corresponding to the SatellitePhaseBias of the correction_mask_on_demand bitfield.

pub fn atmospherics(&self) -> Result<Atmospherics, u8>

Gets the Atmospherics stored in the correction_mask_on_demand bitfield.

Returns Ok if the bitrange contains a known Atmospherics 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 Atmospherics were added.

pub fn set_atmospherics(&mut self, atmospherics: Atmospherics)

Set the bitrange corresponding to the Atmospherics of the correction_mask_on_demand bitfield.

pub fn integrity(&self) -> Result<Integrity, u8>

Gets the Integrity stored in the correction_mask_on_demand bitfield.

Returns Ok if the bitrange contains a known Integrity 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 Integrity were added.

pub fn set_integrity(&mut self, integrity: Integrity)

Set the bitrange corresponding to the Integrity of the correction_mask_on_demand bitfield.

pub fn intermediate_certificate(&self) -> Result<IntermediateCertificate, u8>

Gets the IntermediateCertificate stored in the correction_mask_on_demand bitfield.

Returns Ok if the bitrange contains a known IntermediateCertificate 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 IntermediateCertificate were added.

pub fn set_intermediate_certificate( &mut self, intermediate_certificate: IntermediateCertificate )

Set the bitrange corresponding to the IntermediateCertificate of the correction_mask_on_demand bitfield.

pub fn certificate_chain(&self) -> Result<CertificateChain, u8>

Gets the CertificateChain stored in the correction_mask_on_demand bitfield.

Returns Ok if the bitrange contains a known CertificateChain 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 CertificateChain were added.

pub fn set_certificate_chain(&mut self, certificate_chain: CertificateChain)

Set the bitrange corresponding to the CertificateChain of the correction_mask_on_demand bitfield.

Trait Implementations

impl Clone for MsgAcknowledge

fn clone(&self) -> MsgAcknowledge

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ConcreteMessage for MsgAcknowledge

const MESSAGE_TYPE: u16 = 3_026u16

The message type.

const MESSAGE_NAME: &'static str = "MSG_ACKNOWLEDGE"

The message name.

impl Debug for MsgAcknowledge

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MsgAcknowledge

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FriendlyName for MsgAcknowledge

fn friendly_name() -> &'static str

impl From<MsgAcknowledge> for Sbp

fn from(msg: MsgAcknowledge) -> Self

Converts to this type from the input type.

impl PartialEq for MsgAcknowledge

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

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

Get the message name.

fn message_type(&self) -> Option<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.

fn is_valid(&self) -> bool

Tells you if the message is valid or if it is not a valid message and may need to be special cased at certain points.

fn into_valid_msg(self) -> Result<Self, Invalid>

fn gps_time(&self) -> Option<Result<MessageTime, GpsTimeError>>

Get the GPS time associated with the message.

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

Get friendly name associated with the message.

impl Serialize for MsgAcknowledge

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Sbp> for MsgAcknowledge

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.

impl StructuralPartialEq for MsgAcknowledge