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

// SPDX-License-Identifier: EPL-2.0
//! TraCI Route domain scope.

use crate::{
    client::TraciClient,
    constants::*,
    error::TraciError,
    storage::Storage,
    types::{ContextSubscriptionResults, SubscriptionResults},
};

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

impl RouteScope {
    crate::impl_scope_accessors!();

    pub fn get_id_list(&self, client: &mut TraciClient) -> Result<Vec<String>, TraciError> {
        client.create_command(CMD_GET_ROUTE_VARIABLE, TRACI_ID_LIST, "", None);
        client.process_get(CMD_GET_ROUTE_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_ROUTE_VARIABLE, ID_COUNT, "", None);
        client.process_get(CMD_GET_ROUTE_VARIABLE, Some(TYPE_INTEGER))?;
        client.read_int_from_input()
    }

    pub fn get_parameter(&self, client: &mut TraciClient, route_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_ROUTE_VARIABLE, VAR_PARAMETER, route_id, Some(&add));
        client.process_get(CMD_GET_ROUTE_VARIABLE, Some(TYPE_STRING))?;
        client.read_string_from_input()
    }

    pub fn set_parameter(&self, client: &mut TraciClient, route_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_ROUTE_VARIABLE, VAR_PARAMETER, route_id, Some(&add));
        client.process_set(CMD_SET_ROUTE_VARIABLE)?;
        Ok(())
    }

    /// Return the list of edge IDs comprising this route.
    pub fn get_edges(&self, client: &mut TraciClient, route_id: &str) -> Result<Vec<String>, TraciError> {
        client.create_command(CMD_GET_ROUTE_VARIABLE, VAR_EDGES, route_id, None);
        client.process_get(CMD_GET_ROUTE_VARIABLE, Some(TYPE_STRINGLIST))?;
        client.read_string_list_from_input()
    }

    /// Add a new route to the simulation.
    pub fn add(&self, client: &mut TraciClient, route_id: &str, edges: &[String]) -> Result<(), TraciError> {
        let mut add = Storage::new();
        add.write_u8(TYPE_STRINGLIST);
        add.write_string_list(edges);
        client.create_command(CMD_SET_ROUTE_VARIABLE, ADD, route_id, Some(&add));
        client.process_set(CMD_SET_ROUTE_VARIABLE)?;
        Ok(())
    }

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

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