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
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

use serde::{Deserialize, Serialize};

use crate::documents::activation::{ControlZoneRef, ResourceObjectRef};
use crate::documents::planned_resource_schedule::GridElementCodingScheme;
use crate::types::{
    AttrV, AttrVWithScheme, Direction, DocumentId, DocumentVersion, MarketParticipantId,
    MarketRoleType, MeasureUnit, Period, TimeInterval, UtcDateTime,
};

// ── DocumentType ──────────────────────────────────────────────────────────────

/// `DocumentType` for `NetworkConstraintDocument` (always `B15`).
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub enum NcdDocType {
    /// Network constraint document.
    #[serde(rename = "B15")]
    NetworkConstraint,
}

/// `ProcessType` for `NetworkConstraintDocument` (always `A14`).
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub enum NcdProcessType {
    /// Forecast.
    #[serde(rename = "A14")]
    Forecast,
}

/// `BusinessType` for `NetworkConstraintTimeSeries`.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub enum NcdBusinessType {
    /// Dispatchable production (eligible resource).
    #[serde(rename = "A77")]
    ProductionDispatchable,
    /// Network element constraint.
    #[serde(rename = "B59")]
    NetworkElement,
}

/// Status codes for `NetworkConstraintTimeSeries`.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub enum NcdStatus {
    /// Activated.
    #[serde(rename = "A07")]
    Activated,
    /// Planned.
    #[serde(rename = "A36")]
    Planned,
    /// Demand.
    #[serde(rename = "Z06")]
    Demand,
}

/// Optional document withdrawal status.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct NcdDocStatus {
    /// Withdrawal code (only `"A13"` used).
    #[serde(rename = "@v")]
    pub v: String,
}

// ── NetworkConstraintTimeSeries ───────────────────────────────────────────────

/// A single constraint time series within a `NetworkConstraintDocument`.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct NetworkConstraintTimeSeries {
    /// Unique time-series identifier (max 35 chars).
    #[serde(rename = "TimeSeriesIdentification")]
    pub time_series_identification: AttrV<DocumentId>,
    /// Business type: dispatchable production (`A77`) or network element (`B59`).
    #[serde(rename = "BusinessType")]
    pub business_type: AttrV<NcdBusinessType>,
    /// Direction: up (`A01`) or down (`A02`).
    #[serde(rename = "Direction")]
    pub direction: AttrV<Direction>,
    /// Control zone where the resource / element is located.
    #[serde(rename = "ConnectingArea")]
    pub connecting_area: ControlZoneRef,
    /// Resource object identifier (BDEW resource code, NDE scheme).
    #[serde(rename = "ResourceObject")]
    pub resource_object: ResourceObjectRef,
    /// Grid element EIC or resource code.
    #[serde(rename = "GridElement")]
    pub grid_element: AttrVWithScheme<String, GridElementCodingScheme>,
    /// Physical unit of quantity values.
    #[serde(rename = "MeasurementUnit")]
    pub measurement_unit: AttrV<MeasureUnit>,
    /// Optional activation status.
    #[serde(rename = "Status", default, skip_serializing_if = "Option::is_none")]
    pub status: Option<AttrV<NcdStatus>>,
    /// Quarter-hour constraint data for the delivery day.
    #[serde(rename = "Period")]
    pub period: Period,
}

// ── NetworkConstraintDocument ─────────────────────────────────────────────────

/// `NetworkConstraintDocument` — grid congestion constraint data submitted
/// by TSOs to resource providers' NB.
///
/// XSD version: 1.1b (2025-04-01)  
/// No XML namespace.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename = "NetworkConstraintDocument")]
pub struct NetworkConstraintDocument {
    /// Unique document identifier (max 35 chars).
    #[serde(rename = "DocumentIdentification")]
    pub document_identification: AttrV<DocumentId>,
    /// Document version number (1–999).
    #[serde(rename = "DocumentVersion")]
    pub document_version: AttrV<DocumentVersion>,
    /// Document type (always `B15`).
    #[serde(rename = "DocumentType")]
    pub document_type: AttrV<NcdDocType>,
    /// Process type (always `A14`).
    #[serde(rename = "ProcessType")]
    pub process_type: AttrV<NcdProcessType>,
    /// Sender's market participant identifier.
    #[serde(rename = "SenderIdentification")]
    pub sender_identification: AttrVWithScheme<MarketParticipantId>,
    /// Sender's market role.
    #[serde(rename = "SenderRole")]
    pub sender_role: AttrV<MarketRoleType>,
    /// Receiver's market participant identifier.
    #[serde(rename = "ReceiverIdentification")]
    pub receiver_identification: AttrVWithScheme<MarketParticipantId>,
    /// Receiver's market role.
    #[serde(rename = "ReceiverRole")]
    pub receiver_role: AttrV<MarketRoleType>,
    /// Document creation timestamp (UTC, second precision).
    #[serde(rename = "DocumentDateTime")]
    pub document_date_time: AttrV<UtcDateTime>,
    /// Delivery period covered (UTC interval).
    #[serde(rename = "TimePeriodCovered")]
    pub time_period_covered: AttrV<TimeInterval>,
    /// Optional withdrawal status.
    #[serde(rename = "DocStatus", default, skip_serializing_if = "Option::is_none")]
    pub doc_status: Option<NcdDocStatus>,
    /// Network constraint time series (0+; absent when `doc_status` is set).
    #[serde(
        rename = "NetworkConstraintTimeSeries",
        default,
        skip_serializing_if = "Vec::is_empty"
    )]
    pub time_series: Vec<NetworkConstraintTimeSeries>,
}