cimoxide-validation 0.6.0

SHACL validation of CGMES datasets against the ENTSO-E profile constraints
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

use cimmodel::CimDataset;
use super::Fields;
use crate::Violation;

/// The rules of this profile's constraint files that read another profile's
/// data, run on the merged dataset (`super::across_groups`).
/// The CsConverter ranges read SSH's operating mode.
pub fn validate_across(dataset: &CimDataset) -> Vec<Violation> {
    check_cs_converter_state_value_range(dataset)
}

pub fn validate(dataset: &CimDataset) -> Vec<Violation> {
    let mut v = Vec::new();
    v.extend(check_topological_island_count(dataset));
    v
}

fn check_cs_converter_state_value_range(dataset: &CimDataset) -> Vec<Violation> {
    let mut v = Vec::new();
    const RECTIFIER: &str = "CsOperatingModeKind.rectifier";
    const INVERTER:  &str = "CsOperatingModeKind.inverter";

    for mrid in dataset.by_type.get("CsConverter").into_iter().flatten() {
        let entry = &dataset.entries[mrid];
        let obj = match Fields::of_class(entry, "CsConverter") {
            Some(o) => o, None => continue,
        };
        let mode = match obj.enumeration("CsConverter.operatingMode") { Some(r) => r, None => continue };

        if mode == RECTIFIER {
            // The SPARQL binds `$this $PATH ?value`: an absent value is not
            // a violation.
            if obj.f64("CsConverter.alpha").is_some_and(|alpha| !(10.0..=18.0).contains(&alpha)) {
                v.push(Violation {
                    object_id:   mrid.clone(),
                    rule_id:     "svu:CsConverter.alpha-valueRangeTypical".into(),
                    name:        "C:301:SV:CsConverter.alpha:valueRangeTypical".into(),
                    class:       "CsConverter".into(),
                    property:    "CsConverter.alpha".into(),
                    message:     "The alpha value is outside typical range (10-18 degrees) for a rectifier.".into(),
                    severity:    "sh:Warning".into(),
                    description: String::new(),
                });
            }
        } else if mode == INVERTER
            && obj.f64("CsConverter.gamma").is_some_and(|gamma| !(17.0..=20.0).contains(&gamma))
        {
            v.push(Violation {
                object_id:   mrid.clone(),
                rule_id:     "svu:CsConverter.gamma-valueRangeTypical".into(),
                name:        "C:301:SV:CsConverter.gamma:valueRangeTypical".into(),
                class:       "CsConverter".into(),
                property:    "CsConverter.gamma".into(),
                message:     "The gamma value is outside typical range (17-20 degrees) for an inverter.".into(),
                severity:    "sh:Warning".into(),
                description: String::new(),
            });
        }
    }
    v
}

fn check_topological_island_count(dataset: &CimDataset) -> Vec<Violation> {
    let count = dataset.by_type.get("TopologicalIsland").map_or(0, |v| v.len());
    if count == 0 {
        vec![Violation {
            object_id:   "global".into(),
            rule_id:     "sv456:TopologicalIsland-instance".into(),
            name:        "C:456:SV:TopologicalIsland:instance".into(),
            class:       "TopologicalIsland".into(),
            property:    "^rdf:type".into(),
            message:     "No TopologicalIsland instantiated.".into(),
            severity:    "sh:Violation".into(),
            description: String::new(),
        }]
    } else {
        Vec::new()
    }
}