autosar_data_abstraction/communication/cluster/
mod.rs

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
use crate::{AbstractionElement, AutosarAbstractionError, System};
use autosar_data::{Element, ElementName};

mod can;
mod ethernet;
mod flexray;

pub use can::*;
pub use ethernet::*;
pub use flexray::*;

//##################################################################

/// [`AbstractCluster`] defines the common interface for all supported communication clusters.
pub trait AbstractCluster: AbstractionElement {
    /// Returns the [`System`] the cluster is part of.
    fn system(&self) -> Option<System> {
        if let Ok(model) = self.element().model() {
            let path = self.element().path().ok()?;
            let refs = model.get_references_to(&path);

            if let Some(system) = refs
                .iter()
                .filter_map(autosar_data::WeakElement::upgrade)
                .filter(|elem| elem.element_name() == ElementName::FibexElementRef)
                .filter_map(|elem| elem.named_parent().ok().flatten())
                .find_map(|parent| System::try_from(parent).ok())
            {
                return Some(system);
            }
        }
        None
    }
}

//##################################################################

/// A [`Cluster`] is returned by [`System::clusters`].
/// It can contain any supported communication cluster.
#[derive(Debug, Clone, PartialEq, Eq)]
#[non_exhaustive]
pub enum Cluster {
    /// The Cluster is a [`CanCluster`]
    Can(CanCluster),
    /// The Cluster is an [`EthernetCluster`]
    Ethernet(EthernetCluster),
    /// The Cluster is a [`FlexrayCluster`]
    FlexRay(FlexrayCluster),
    // missing: Lin, TTCAN, J1939, CDD (aka user defined)
}

impl AbstractionElement for Cluster {
    fn element(&self) -> &autosar_data::Element {
        match self {
            Cluster::Can(cancluster) => cancluster.element(),
            Cluster::Ethernet(ethcluster) => ethcluster.element(),
            Cluster::FlexRay(flxcluster) => flxcluster.element(),
        }
    }
}

impl AbstractCluster for Cluster {}

impl TryFrom<Element> for Cluster {
    type Error = AutosarAbstractionError;

    fn try_from(element: Element) -> Result<Self, Self::Error> {
        match element.element_name() {
            ElementName::CanCluster => Ok(CanCluster::try_from(element)?.into()),
            ElementName::EthernetCluster => Ok(EthernetCluster::try_from(element)?.into()),
            ElementName::FlexrayCluster => Ok(FlexrayCluster::try_from(element)?.into()),
            _ => Err(AutosarAbstractionError::ConversionError {
                element,
                dest: "Cluster".to_string(),
            }),
        }
    }
}

impl From<CanCluster> for Cluster {
    fn from(value: CanCluster) -> Self {
        Cluster::Can(value)
    }
}

impl From<EthernetCluster> for Cluster {
    fn from(value: EthernetCluster) -> Self {
        Cluster::Ethernet(value)
    }
}

impl From<FlexrayCluster> for Cluster {
    fn from(value: FlexrayCluster) -> Self {
        Cluster::FlexRay(value)
    }
}

//##################################################################

#[cfg(test)]
mod tests {
    use super::*;
    use crate::ArPackage;
    use autosar_data::{AutosarModel, AutosarVersion};

    #[test]
    fn cluster_system() {
        let model = AutosarModel::new();
        let _file = model.create_file("test.arxml", AutosarVersion::LATEST).unwrap();
        let package = ArPackage::get_or_create(&model, "/Test").unwrap();
        let system = package
            .create_system("System", crate::SystemCategory::EcuExtract)
            .unwrap();
        let settings = CanClusterSettings::default();
        let can_cluster = CanCluster::new("CanCluster", &package, &settings).unwrap();

        assert!(can_cluster.system().is_none());
        system.create_fibex_element_ref(can_cluster.element()).unwrap();
        assert_eq!(can_cluster.system().unwrap(), system);
    }

    #[test]
    fn cluster_conversion() {
        let model = AutosarModel::new();
        let _file = model.create_file("test.arxml", AutosarVersion::LATEST).unwrap();
        let package = ArPackage::get_or_create(&model, "/Test").unwrap();
        let can_settings = CanClusterSettings::default();
        let can_cluster = CanCluster::new("CanCluster", &package, &can_settings).unwrap();
        let ethernet_cluster = EthernetCluster::new("EthernetCluster", &package).unwrap();
        let flexray_settings = FlexrayClusterSettings::default();
        let flexray_cluster = FlexrayCluster::new("FlexrayCluster", &package, &flexray_settings).unwrap();

        let can: Cluster = can_cluster.into();
        let ethernet: Cluster = ethernet_cluster.into();
        let flexray: Cluster = flexray_cluster.into();

        assert_eq!(can.element().item_name().unwrap(), "CanCluster");
        assert_eq!(ethernet.element().item_name().unwrap(), "EthernetCluster");
        assert_eq!(flexray.element().item_name().unwrap(), "FlexrayCluster");
    }
}