open_dis_rust/simulation_management/
data_query_pdu.rs

1//     open-dis-rust - Rust implementation of the IEEE 1278.1-2012 Distributed Interactive
2//                     Simulation (DIS) application protocol
3//     Copyright (C) 2023 Cameron Howell
4//
5//     Licensed under the BSD 2-Clause License
6
7use crate::common::{
8    dis_error::DISError,
9    entity_id::EntityId,
10    pdu::Pdu,
11    pdu_header::{PduHeader, PduType, ProtocolFamily},
12};
13use bytes::{Buf, BufMut, BytesMut};
14use std::any::Any;
15
16#[derive(Copy, Clone, Debug)]
17/// Implemented according to IEEE 1278.1-2012 §7.5.9
18pub struct DataQueryPdu {
19    pub pdu_header: PduHeader,
20    pub originating_entity_id: EntityId,
21    pub receiving_entity_id: EntityId,
22    pub request_id: u32,
23    pub time_interval: u32,
24    pub number_of_fixed_datum_records: u32,
25    pub number_of_variable_datum_records: u32,
26    pub fixed_datum_records: u64,
27    pub variable_datum_records: u64,
28}
29
30impl Default for DataQueryPdu {
31    fn default() -> Self {
32        DataQueryPdu {
33            pdu_header: PduHeader::default(
34                PduType::DataQuery,
35                ProtocolFamily::SimulationManagement,
36                56,
37            ),
38            originating_entity_id: EntityId::default(1),
39            receiving_entity_id: EntityId::default(2),
40            request_id: 0,
41            time_interval: 0,
42            number_of_fixed_datum_records: 0,
43            number_of_variable_datum_records: 0,
44            fixed_datum_records: 0,
45            variable_datum_records: 0,
46        }
47    }
48}
49
50impl Pdu for DataQueryPdu {
51    fn serialize(&mut self, buf: &mut BytesMut) {
52        self.pdu_header.length = u16::try_from(std::mem::size_of_val(self))
53            .expect("The length of the PDU should fit in a u16.");
54        self.pdu_header.serialize(buf);
55        self.originating_entity_id.serialize(buf);
56        self.receiving_entity_id.serialize(buf);
57        buf.put_u32(self.request_id);
58        buf.put_u32(self.time_interval);
59        buf.put_u32(self.number_of_fixed_datum_records);
60        buf.put_u32(self.number_of_variable_datum_records);
61        buf.put_u64(self.fixed_datum_records);
62        buf.put_u64(self.variable_datum_records);
63    }
64
65    fn deserialize(mut buffer: BytesMut) -> Result<Self, DISError>
66    where
67        Self: Sized,
68    {
69        let pdu_header = PduHeader::deserialize(&mut buffer);
70        if pdu_header.pdu_type == PduType::DataQuery {
71            let originating_entity_id = EntityId::deserialize(&mut buffer);
72            let receiving_entity_id = EntityId::deserialize(&mut buffer);
73            let request_id = buffer.get_u32();
74            let time_interval = buffer.get_u32();
75            let number_of_fixed_datum_records = buffer.get_u32();
76            let number_of_variable_datum_records = buffer.get_u32();
77            let mut fixed_datum_records: u64 = 0;
78            for _record in 0..number_of_fixed_datum_records as usize {
79                fixed_datum_records += buffer.get_u64();
80            }
81            let mut variable_datum_records: u64 = 0;
82            for _record in 0..number_of_variable_datum_records as usize {
83                variable_datum_records += buffer.get_u64();
84            }
85
86            Ok(DataQueryPdu {
87                pdu_header,
88                originating_entity_id,
89                receiving_entity_id,
90                request_id,
91                time_interval,
92                number_of_fixed_datum_records,
93                number_of_variable_datum_records,
94                fixed_datum_records,
95                variable_datum_records,
96            })
97        } else {
98            Err(DISError::invalid_header(
99                format!("Expected PDU type DataQuery, got {:?}", pdu_header.pdu_type),
100                None,
101            ))
102        }
103    }
104
105    fn as_any(&self) -> &dyn Any {
106        self
107    }
108
109    fn deserialize_without_header(
110        mut buffer: BytesMut,
111        pdu_header: PduHeader,
112    ) -> Result<Self, DISError>
113    where
114        Self: Sized,
115    {
116        let originating_entity_id = EntityId::deserialize(&mut buffer);
117        let receiving_entity_id = EntityId::deserialize(&mut buffer);
118        let request_id = buffer.get_u32();
119        let time_interval = buffer.get_u32();
120        let number_of_fixed_datum_records = buffer.get_u32();
121        let number_of_variable_datum_records = buffer.get_u32();
122        let mut fixed_datum_records: u64 = 0;
123        for _record in 0..number_of_fixed_datum_records as usize {
124            fixed_datum_records += buffer.get_u64();
125        }
126        let mut variable_datum_records: u64 = 0;
127        for _record in 0..number_of_variable_datum_records as usize {
128            variable_datum_records += buffer.get_u64();
129        }
130
131        Ok(DataQueryPdu {
132            pdu_header,
133            originating_entity_id,
134            receiving_entity_id,
135            request_id,
136            time_interval,
137            number_of_fixed_datum_records,
138            number_of_variable_datum_records,
139            fixed_datum_records,
140            variable_datum_records,
141        })
142    }
143}
144
145#[cfg(test)]
146mod tests {
147    use super::DataQueryPdu;
148    use crate::common::pdu_header::{PduHeader, PduType, ProtocolFamily};
149
150    #[test]
151    fn create_header() {
152        let action_request_pdu = DataQueryPdu::default();
153        let pdu_header = PduHeader::default(
154            PduType::DataQuery,
155            ProtocolFamily::SimulationManagement,
156            448 / 8,
157        );
158
159        assert_eq!(
160            pdu_header.protocol_version,
161            action_request_pdu.pdu_header.protocol_version
162        );
163        assert_eq!(
164            pdu_header.exercise_id,
165            action_request_pdu.pdu_header.exercise_id
166        );
167        assert_eq!(pdu_header.pdu_type, action_request_pdu.pdu_header.pdu_type);
168        assert_eq!(
169            pdu_header.protocol_family,
170            action_request_pdu.pdu_header.protocol_family
171        );
172        assert_eq!(pdu_header.length, action_request_pdu.pdu_header.length);
173        assert_eq!(
174            pdu_header.status_record,
175            action_request_pdu.pdu_header.status_record
176        );
177    }
178}
open_dis_rust/simulation_management/data_query_pdu.rs

open_dis_rust/simulation_management/
data_query_pdu.rs
