redispatch-xml 0.5.0

Redispatch 2.0 XML/XSD format parsing and validation for the German electricity grid (CIM/ENTSO-E-based, per BDEW specifications)
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

pub mod acknowledgement;
pub mod activation;
pub mod kaskade;
pub mod kostenblatt;
pub mod network_constraint;
pub mod planned_resource_schedule;
pub mod stammdaten;
pub mod status_request;
pub mod unavailability;

pub use acknowledgement::AcknowledgementDocument;
pub use activation::ActivationDocument;
pub use kaskade::Kaskade;
pub use kostenblatt::Kostenblatt;
pub use network_constraint::NetworkConstraintDocument;
pub use planned_resource_schedule::PlannedResourceScheduleDocument;
pub use stammdaten::Stammdaten;
pub use status_request::StatusRequestMarketDocument;
pub use unavailability::UnavailabilityMarketDocument;

/// The set of all supported Redispatch 2.0 document types.
///
/// Used by [`crate::detect`] to identify the type of a document
/// from its root element name, and as the variant discriminant for
/// [`crate::Document`].
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum DocumentType {
    /// `ActivationDocument` (ACO/ACR/AAR).
    Activation,
    /// `PlannedResourceScheduleDocument`.
    PlannedResourceSchedule,
    /// `AcknowledgementDocument`.
    Acknowledgement,
    /// `Stammdaten`.
    Stammdaten,
    /// `StatusRequest_MarketDocument`.
    StatusRequest,
    /// `Unavailability_MarketDocument`.
    Unavailability,
    /// `Kaskade`.
    Kaskade,
    /// `NetworkConstraintDocument`.
    NetworkConstraint,
    /// `Kostenblatt`.
    Kostenblatt,
}

impl DocumentType {
    /// Return the XML root element name for this document type.
    pub fn root_element_name(self) -> &'static str {
        match self {
            Self::Activation => "ActivationDocument",
            Self::PlannedResourceSchedule => "PlannedResourceScheduleDocument",
            Self::Acknowledgement => "AcknowledgementDocument",
            Self::Stammdaten => "Stammdaten",
            Self::StatusRequest => "StatusRequest_MarketDocument",
            Self::Unavailability => "Unavailability_MarketDocument",
            Self::Kaskade => "Kaskade",
            Self::NetworkConstraint => "NetworkConstraintDocument",
            Self::Kostenblatt => "Kostenblatt",
        }
    }

    /// Return the expected XML namespace URI for this document type, if any.
    pub fn expected_namespace(self) -> Option<&'static str> {
        match self {
            Self::Activation => Some(activation::NAMESPACE),
            Self::StatusRequest => Some(status_request::NAMESPACE),
            Self::Unavailability | Self::Kaskade => Some(kaskade::NAMESPACE),
            Self::Stammdaten => Some("urn:kwep_stammdaten:1:0"),
            _ => None,
        }
    }

    /// Attempt to identify the document type from the root element local name.
    ///
    /// Returns `None` if the name is not a recognised Redispatch 2.0 root
    /// element.
    pub fn from_root_element(name: &str) -> Option<Self> {
        match name {
            "ActivationDocument" => Some(Self::Activation),
            "PlannedResourceScheduleDocument" => Some(Self::PlannedResourceSchedule),
            "AcknowledgementDocument" => Some(Self::Acknowledgement),
            "Stammdaten" => Some(Self::Stammdaten),
            "StatusRequest_MarketDocument" => Some(Self::StatusRequest),
            "Unavailability_MarketDocument" => Some(Self::Unavailability),
            "Kaskade" => Some(Self::Kaskade),
            "NetworkConstraintDocument" => Some(Self::NetworkConstraint),
            "Kostenblatt" => Some(Self::Kostenblatt),
            _ => None,
        }
    }
}