traci-rs 0.2.0

Pure Rust client library for the SUMO TraCI protocol
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
// SPDX-License-Identifier: EPL-2.0
//! TraCI Person domain scope.

use crate::{
    client::TraciClient,
    constants::*,
    error::TraciError,
    storage::Storage,
    types::{
        ContextSubscriptionResults, SubscriptionResults, TraciColor, TraciPosition, TraciStage,
    },
    scopes::simulation::read_traci_stage,
};

/// Scope for interacting with SUMO person objects.
#[derive(Debug, Default)]
pub struct PersonScope {
    pub subscription_results: SubscriptionResults,
    pub context_subscription_results: ContextSubscriptionResults,
}

impl PersonScope {
    crate::impl_scope_accessors!();

    pub fn get_id_list(&self, client: &mut TraciClient) -> Result<Vec<String>, TraciError> {
        client.create_command(CMD_GET_PERSON_VARIABLE, TRACI_ID_LIST, "", None);
        client.process_get(CMD_GET_PERSON_VARIABLE, Some(TYPE_STRINGLIST))?;
        client.read_string_list_from_input()
    }

    pub fn get_id_count(&self, client: &mut TraciClient) -> Result<i32, TraciError> {
        client.create_command(CMD_GET_PERSON_VARIABLE, ID_COUNT, "", None);
        client.process_get(CMD_GET_PERSON_VARIABLE, Some(TYPE_INTEGER))?;
        client.read_int_from_input()
    }

    pub fn get_parameter(&self, client: &mut TraciClient, person_id: &str, key: &str) -> Result<String, TraciError> {
        let mut add = Storage::new();
        add.write_u8(TYPE_STRING);
        add.write_string(key);
        client.create_command(CMD_GET_PERSON_VARIABLE, VAR_PARAMETER, person_id, Some(&add));
        client.process_get(CMD_GET_PERSON_VARIABLE, Some(TYPE_STRING))?;
        client.read_string_from_input()
    }

    pub fn set_parameter(&self, client: &mut TraciClient, person_id: &str, key: &str, value: &str) -> Result<(), TraciError> {
        let mut add = Storage::new();
        add.write_u8(TYPE_COMPOUND);
        add.write_i32(2);
        add.write_u8(TYPE_STRING);
        add.write_string(key);
        add.write_u8(TYPE_STRING);
        add.write_string(value);
        client.create_command(CMD_SET_PERSON_VARIABLE, VAR_PARAMETER, person_id, Some(&add));
        client.process_set(CMD_SET_PERSON_VARIABLE)?;
        Ok(())
    }

    // -----------------------------------------------------------------------
    // Getters
    // -----------------------------------------------------------------------

    pub fn get_speed(&self, client: &mut TraciClient, person_id: &str) -> Result<f64, TraciError> {
        client.create_command(CMD_GET_PERSON_VARIABLE, VAR_SPEED, person_id, None);
        client.process_get(CMD_GET_PERSON_VARIABLE, Some(TYPE_DOUBLE))?;
        client.read_double_from_input()
    }

    pub fn get_position(&self, client: &mut TraciClient, person_id: &str) -> Result<TraciPosition, TraciError> {
        client.create_command(CMD_GET_PERSON_VARIABLE, VAR_POSITION, person_id, None);
        client.process_get(CMD_GET_PERSON_VARIABLE, Some(POSITION_2D))?;
        client.read_pos_2d_from_input()
    }

    pub fn get_position3d(&self, client: &mut TraciClient, person_id: &str) -> Result<TraciPosition, TraciError> {
        client.create_command(CMD_GET_PERSON_VARIABLE, VAR_POSITION3D, person_id, None);
        client.process_get(CMD_GET_PERSON_VARIABLE, Some(POSITION_3D))?;
        client.read_pos_3d_from_input()
    }

    pub fn get_angle(&self, client: &mut TraciClient, person_id: &str) -> Result<f64, TraciError> {
        client.create_command(CMD_GET_PERSON_VARIABLE, VAR_ANGLE, person_id, None);
        client.process_get(CMD_GET_PERSON_VARIABLE, Some(TYPE_DOUBLE))?;
        client.read_double_from_input()
    }

    pub fn get_slope(&self, client: &mut TraciClient, person_id: &str) -> Result<f64, TraciError> {
        client.create_command(CMD_GET_PERSON_VARIABLE, VAR_SLOPE, person_id, None);
        client.process_get(CMD_GET_PERSON_VARIABLE, Some(TYPE_DOUBLE))?;
        client.read_double_from_input()
    }

    pub fn get_lane_position(&self, client: &mut TraciClient, person_id: &str) -> Result<f64, TraciError> {
        client.create_command(CMD_GET_PERSON_VARIABLE, VAR_LANEPOSITION, person_id, None);
        client.process_get(CMD_GET_PERSON_VARIABLE, Some(TYPE_DOUBLE))?;
        client.read_double_from_input()
    }

    pub fn get_color(&self, client: &mut TraciClient, person_id: &str) -> Result<TraciColor, TraciError> {
        client.create_command(CMD_GET_PERSON_VARIABLE, VAR_COLOR, person_id, None);
        client.process_get(CMD_GET_PERSON_VARIABLE, Some(TYPE_COLOR))?;
        client.read_color_from_input()
    }

    pub fn get_length(&self, client: &mut TraciClient, person_id: &str) -> Result<f64, TraciError> {
        client.create_command(CMD_GET_PERSON_VARIABLE, VAR_LENGTH, person_id, None);
        client.process_get(CMD_GET_PERSON_VARIABLE, Some(TYPE_DOUBLE))?;
        client.read_double_from_input()
    }

    pub fn get_road_id(&self, client: &mut TraciClient, person_id: &str) -> Result<String, TraciError> {
        client.create_command(CMD_GET_PERSON_VARIABLE, VAR_ROAD_ID, person_id, None);
        client.process_get(CMD_GET_PERSON_VARIABLE, Some(TYPE_STRING))?;
        client.read_string_from_input()
    }

    pub fn get_lane_id(&self, client: &mut TraciClient, person_id: &str) -> Result<String, TraciError> {
        client.create_command(CMD_GET_PERSON_VARIABLE, VAR_LANE_ID, person_id, None);
        client.process_get(CMD_GET_PERSON_VARIABLE, Some(TYPE_STRING))?;
        client.read_string_from_input()
    }

    pub fn get_type_id(&self, client: &mut TraciClient, person_id: &str) -> Result<String, TraciError> {
        client.create_command(CMD_GET_PERSON_VARIABLE, VAR_TYPE, person_id, None);
        client.process_get(CMD_GET_PERSON_VARIABLE, Some(TYPE_STRING))?;
        client.read_string_from_input()
    }

    pub fn get_speed_factor(&self, client: &mut TraciClient, person_id: &str) -> Result<f64, TraciError> {
        client.create_command(CMD_GET_PERSON_VARIABLE, VAR_SPEED_FACTOR, person_id, None);
        client.process_get(CMD_GET_PERSON_VARIABLE, Some(TYPE_DOUBLE))?;
        client.read_double_from_input()
    }

    pub fn get_waiting_time(&self, client: &mut TraciClient, person_id: &str) -> Result<f64, TraciError> {
        client.create_command(CMD_GET_PERSON_VARIABLE, VAR_WAITING_TIME, person_id, None);
        client.process_get(CMD_GET_PERSON_VARIABLE, Some(TYPE_DOUBLE))?;
        client.read_double_from_input()
    }

    pub fn get_next_edge(&self, client: &mut TraciClient, person_id: &str) -> Result<String, TraciError> {
        client.create_command(CMD_GET_PERSON_VARIABLE, VAR_NEXT_EDGE, person_id, None);
        client.process_get(CMD_GET_PERSON_VARIABLE, Some(TYPE_STRING))?;
        client.read_string_from_input()
    }

    pub fn get_vehicle(&self, client: &mut TraciClient, person_id: &str) -> Result<String, TraciError> {
        client.create_command(CMD_GET_PERSON_VARIABLE, VAR_VEHICLE, person_id, None);
        client.process_get(CMD_GET_PERSON_VARIABLE, Some(TYPE_STRING))?;
        client.read_string_from_input()
    }

    pub fn get_remaining_stages(&self, client: &mut TraciClient, person_id: &str) -> Result<i32, TraciError> {
        client.create_command(CMD_GET_PERSON_VARIABLE, VAR_STAGES_REMAINING, person_id, None);
        client.process_get(CMD_GET_PERSON_VARIABLE, Some(TYPE_INTEGER))?;
        client.read_int_from_input()
    }

    /// Get a specific stage of the person's journey.
    pub fn get_stage(&self, client: &mut TraciClient, person_id: &str, next_stage_index: i32) -> Result<TraciStage, TraciError> {
        let mut add = Storage::new();
        add.write_u8(TYPE_INTEGER);
        add.write_i32(next_stage_index);
        client.create_command(CMD_GET_PERSON_VARIABLE, VAR_STAGE, person_id, Some(&add));
        client.process_get(CMD_GET_PERSON_VARIABLE, Some(TYPE_COMPOUND))?;
        read_traci_stage(client)
    }

    /// Get the edges for a specific stage.
    pub fn get_edges(&self, client: &mut TraciClient, person_id: &str, next_stage_index: i32) -> Result<Vec<String>, TraciError> {
        let mut add = Storage::new();
        add.write_u8(TYPE_INTEGER);
        add.write_i32(next_stage_index);
        client.create_command(CMD_GET_PERSON_VARIABLE, VAR_EDGES, person_id, Some(&add));
        client.process_get(CMD_GET_PERSON_VARIABLE, Some(TYPE_STRINGLIST))?;
        client.read_string_list_from_input()
    }

    // -----------------------------------------------------------------------
    // Setters / commands
    // -----------------------------------------------------------------------

    /// Add a new person to the simulation.
    pub fn add(&self, client: &mut TraciClient, person_id: &str, edge_id: &str, pos: f64, depart: f64, type_id: &str) -> Result<(), TraciError> {
        let mut add = Storage::new();
        add.write_u8(TYPE_COMPOUND);
        add.write_i32(4);
        add.write_u8(TYPE_STRING);
        add.write_string(type_id);
        add.write_u8(TYPE_STRING);
        add.write_string(edge_id);
        add.write_u8(TYPE_DOUBLE);
        add.write_f64(depart);
        add.write_u8(TYPE_DOUBLE);
        add.write_f64(pos);
        client.create_command(CMD_SET_PERSON_VARIABLE, ADD, person_id, Some(&add));
        client.process_set(CMD_SET_PERSON_VARIABLE)?;
        Ok(())
    }

    /// Append a full stage to a person's plan.
    pub fn append_stage(&self, client: &mut TraciClient, person_id: &str, stage: &TraciStage) -> Result<(), TraciError> {
        let mut add = Storage::new();
        add.write_u8(TYPE_COMPOUND);
        add.write_i32(13);
        add.write_u8(TYPE_INTEGER);
        add.write_i32(stage.type_);
        add.write_u8(TYPE_STRING);
        add.write_string(&stage.v_type);
        add.write_u8(TYPE_STRING);
        add.write_string(&stage.line);
        add.write_u8(TYPE_STRING);
        add.write_string(&stage.dest_stop);
        add.write_u8(TYPE_STRINGLIST);
        add.write_i32(stage.edges.len() as i32);
        for e in &stage.edges {
            add.write_string(e);
        }
        add.write_u8(TYPE_DOUBLE);
        add.write_f64(stage.travel_time);
        add.write_u8(TYPE_DOUBLE);
        add.write_f64(stage.cost);
        add.write_u8(TYPE_DOUBLE);
        add.write_f64(stage.length);
        add.write_u8(TYPE_STRING);
        add.write_string(&stage.intended);
        add.write_u8(TYPE_DOUBLE);
        add.write_f64(stage.depart);
        add.write_u8(TYPE_DOUBLE);
        add.write_f64(stage.depart_pos);
        add.write_u8(TYPE_DOUBLE);
        add.write_f64(stage.arrival_pos);
        add.write_u8(TYPE_STRING);
        add.write_string(&stage.description);
        client.create_command(CMD_SET_PERSON_VARIABLE, APPEND_STAGE, person_id, Some(&add));
        client.process_set(CMD_SET_PERSON_VARIABLE)?;
        Ok(())
    }

    /// Append a waiting stage.
    pub fn append_waiting_stage(&self, client: &mut TraciClient, person_id: &str, duration: f64, description: &str, stop_id: &str) -> Result<(), TraciError> {
        let mut add = Storage::new();
        add.write_u8(TYPE_COMPOUND);
        add.write_i32(4);
        add.write_u8(TYPE_INTEGER);
        add.write_i32(STAGE_WAITING as i32);
        add.write_u8(TYPE_DOUBLE);
        add.write_f64(duration);
        add.write_u8(TYPE_STRING);
        add.write_string(description);
        add.write_u8(TYPE_STRING);
        add.write_string(stop_id);
        client.create_command(CMD_SET_PERSON_VARIABLE, APPEND_STAGE, person_id, Some(&add));
        client.process_set(CMD_SET_PERSON_VARIABLE)?;
        Ok(())
    }

    /// Append a walking stage.
    pub fn append_walking_stage(&self, client: &mut TraciClient, person_id: &str, edges: &[String], arrival_pos: f64, duration: f64, speed: f64, stop_id: &str) -> Result<(), TraciError> {
        let mut add = Storage::new();
        add.write_u8(TYPE_COMPOUND);
        add.write_i32(6);
        add.write_u8(TYPE_INTEGER);
        add.write_i32(STAGE_WALKING as i32);
        add.write_u8(TYPE_STRINGLIST);
        add.write_i32(edges.len() as i32);
        for e in edges {
            add.write_string(e);
        }
        add.write_u8(TYPE_DOUBLE);
        add.write_f64(arrival_pos);
        add.write_u8(TYPE_DOUBLE);
        add.write_f64(duration);
        add.write_u8(TYPE_DOUBLE);
        add.write_f64(speed);
        add.write_u8(TYPE_STRING);
        add.write_string(stop_id);
        client.create_command(CMD_SET_PERSON_VARIABLE, APPEND_STAGE, person_id, Some(&add));
        client.process_set(CMD_SET_PERSON_VARIABLE)?;
        Ok(())
    }

    /// Append a driving stage.
    pub fn append_driving_stage(&self, client: &mut TraciClient, person_id: &str, to_edge: &str, lines: &str, stop_id: &str) -> Result<(), TraciError> {
        let mut add = Storage::new();
        add.write_u8(TYPE_COMPOUND);
        add.write_i32(4);
        add.write_u8(TYPE_INTEGER);
        add.write_i32(STAGE_DRIVING as i32);
        add.write_u8(TYPE_STRING);
        add.write_string(to_edge);
        add.write_u8(TYPE_STRING);
        add.write_string(lines);
        add.write_u8(TYPE_STRING);
        add.write_string(stop_id);
        client.create_command(CMD_SET_PERSON_VARIABLE, APPEND_STAGE, person_id, Some(&add));
        client.process_set(CMD_SET_PERSON_VARIABLE)?;
        Ok(())
    }

    /// Remove one stage from a person's plan.
    pub fn remove_stage(&self, client: &mut TraciClient, person_id: &str, next_stage_index: i32) -> Result<(), TraciError> {
        let mut add = Storage::new();
        add.write_u8(TYPE_INTEGER);
        add.write_i32(next_stage_index);
        client.create_command(CMD_SET_PERSON_VARIABLE, REMOVE_STAGE, person_id, Some(&add));
        client.process_set(CMD_SET_PERSON_VARIABLE)?;
        Ok(())
    }

    /// Remove all stages from a person's plan.
    pub fn remove_stages(&self, client: &mut TraciClient, person_id: &str) -> Result<(), TraciError> {
        while self.get_remaining_stages(client, person_id)? > 1 {
            self.remove_stage(client, person_id, 1)?;
        }
        self.remove_stage(client, person_id, 0)
    }

    pub fn reroute_traveltime(&self, client: &mut TraciClient, person_id: &str) -> Result<(), TraciError> {
        let mut add = Storage::new();
        add.write_u8(TYPE_COMPOUND);
        add.write_i32(0);
        client.create_command(CMD_SET_PERSON_VARIABLE, CMD_REROUTE_TRAVELTIME, person_id, Some(&add));
        client.process_set(CMD_SET_PERSON_VARIABLE)?;
        Ok(())
    }

    pub fn move_to(&self, client: &mut TraciClient, person_id: &str, edge_id: &str, position: f64) -> Result<(), TraciError> {
        let mut add = Storage::new();
        add.write_u8(TYPE_COMPOUND);
        add.write_i32(2);
        add.write_u8(TYPE_STRING);
        add.write_string(edge_id);
        add.write_u8(TYPE_DOUBLE);
        add.write_f64(position);
        client.create_command(CMD_SET_PERSON_VARIABLE, VAR_MOVE_TO, person_id, Some(&add));
        client.process_set(CMD_SET_PERSON_VARIABLE)?;
        Ok(())
    }

    pub fn move_to_xy(&self, client: &mut TraciClient, person_id: &str, edge_id: &str, x: f64, y: f64, angle: f64, keep_route: i32) -> Result<(), TraciError> {
        let mut add = Storage::new();
        add.write_u8(TYPE_COMPOUND);
        add.write_i32(5);
        add.write_u8(TYPE_STRING);
        add.write_string(edge_id);
        add.write_u8(TYPE_DOUBLE);
        add.write_f64(x);
        add.write_u8(TYPE_DOUBLE);
        add.write_f64(y);
        add.write_u8(TYPE_DOUBLE);
        add.write_f64(angle);
        add.write_u8(TYPE_BYTE);
        add.write_u8(keep_route as u8);
        client.create_command(CMD_SET_PERSON_VARIABLE, MOVE_TO_XY, person_id, Some(&add));
        client.process_set(CMD_SET_PERSON_VARIABLE)?;
        Ok(())
    }

    pub fn set_speed(&self, client: &mut TraciClient, person_id: &str, speed: f64) -> Result<(), TraciError> {
        let mut add = Storage::new();
        add.write_u8(TYPE_DOUBLE);
        add.write_f64(speed);
        client.create_command(CMD_SET_PERSON_VARIABLE, VAR_SPEED, person_id, Some(&add));
        client.process_set(CMD_SET_PERSON_VARIABLE)?;
        Ok(())
    }

    pub fn set_type(&self, client: &mut TraciClient, person_id: &str, type_id: &str) -> Result<(), TraciError> {
        let mut add = Storage::new();
        add.write_u8(TYPE_STRING);
        add.write_string(type_id);
        client.create_command(CMD_SET_PERSON_VARIABLE, VAR_TYPE, person_id, Some(&add));
        client.process_set(CMD_SET_PERSON_VARIABLE)?;
        Ok(())
    }

    pub fn set_speed_factor(&self, client: &mut TraciClient, person_id: &str, factor: f64) -> Result<(), TraciError> {
        let mut add = Storage::new();
        add.write_u8(TYPE_DOUBLE);
        add.write_f64(factor);
        client.create_command(CMD_SET_PERSON_VARIABLE, VAR_SPEED_FACTOR, person_id, Some(&add));
        client.process_set(CMD_SET_PERSON_VARIABLE)?;
        Ok(())
    }

    pub fn set_length(&self, client: &mut TraciClient, person_id: &str, length: f64) -> Result<(), TraciError> {
        let mut add = Storage::new();
        add.write_u8(TYPE_DOUBLE);
        add.write_f64(length);
        client.create_command(CMD_SET_PERSON_VARIABLE, VAR_LENGTH, person_id, Some(&add));
        client.process_set(CMD_SET_PERSON_VARIABLE)?;
        Ok(())
    }

    pub fn set_width(&self, client: &mut TraciClient, person_id: &str, width: f64) -> Result<(), TraciError> {
        let mut add = Storage::new();
        add.write_u8(TYPE_DOUBLE);
        add.write_f64(width);
        client.create_command(CMD_SET_PERSON_VARIABLE, VAR_WIDTH, person_id, Some(&add));
        client.process_set(CMD_SET_PERSON_VARIABLE)?;
        Ok(())
    }

    pub fn set_height(&self, client: &mut TraciClient, person_id: &str, height: f64) -> Result<(), TraciError> {
        let mut add = Storage::new();
        add.write_u8(TYPE_DOUBLE);
        add.write_f64(height);
        client.create_command(CMD_SET_PERSON_VARIABLE, VAR_HEIGHT, person_id, Some(&add));
        client.process_set(CMD_SET_PERSON_VARIABLE)?;
        Ok(())
    }

    pub fn set_min_gap(&self, client: &mut TraciClient, person_id: &str, min_gap: f64) -> Result<(), TraciError> {
        let mut add = Storage::new();
        add.write_u8(TYPE_DOUBLE);
        add.write_f64(min_gap);
        client.create_command(CMD_SET_PERSON_VARIABLE, VAR_MINGAP, person_id, Some(&add));
        client.process_set(CMD_SET_PERSON_VARIABLE)?;
        Ok(())
    }

    pub fn set_color(&self, client: &mut TraciClient, person_id: &str, c: &TraciColor) -> Result<(), TraciError> {
        let mut add = Storage::new();
        add.write_u8(TYPE_COLOR);
        add.write_u8(c.r);
        add.write_u8(c.g);
        add.write_u8(c.b);
        add.write_u8(c.a);
        client.create_command(CMD_SET_PERSON_VARIABLE, VAR_COLOR, person_id, Some(&add));
        client.process_set(CMD_SET_PERSON_VARIABLE)?;
        Ok(())
    }

    pub fn subscribe(&self, client: &mut TraciClient, person_id: &str, vars: &[u8], begin: f64, end: f64) -> Result<(), TraciError> {
        client.subscribe_object_variable(CMD_SUBSCRIBE_PERSON_VARIABLE, person_id, begin, end, vars)
    }

    pub fn subscribe_context(&self, client: &mut TraciClient, person_id: &str, domain: u8, range: f64, vars: &[u8], begin: f64, end: f64) -> Result<(), TraciError> {
        client.subscribe_object_context(CMD_SUBSCRIBE_PERSON_CONTEXT, person_id, begin, end, domain, range, vars)
    }
}