Skip to content

Commit 3f207c4

Browse files
JieXiong9119JieXiong9119
authored
Merge pull request #394 from BuildingSync/deprecate/egridregioncode
Deprecate eGRIDRegionCode
2 parents d6fb40e + c495761 commit 3f207c4

File tree

3 files changed

+72
-40
lines changed

3 files changed

+72
-40
lines changed

‎BuildingSync.xsd

Lines changed: 43 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -454,7 +454,7 @@
454454
</xs:annotation>
455455
</xs:element>
456456
<xs:element ref="auc:ClimateZoneType" minOccurs="0" maxOccurs="1"/>
457-
<xs:element ref="auc:eGRIDRegionCode" minOccurs="0"/>
457+
<xs:element ref="auc:eGRIDSubregionCodes" minOccurs="0"/>
458458
<xs:choice>
459459
<xs:sequence>
460460
<xs:element ref="auc:WeatherDataStationID" minOccurs="0"/>
@@ -503,7 +503,7 @@
503503
</xs:annotation>
504504
</xs:element>
505505
<xs:element ref="auc:ClimateZoneType" minOccurs="0" maxOccurs="1"/>
506-
<xs:element ref="auc:eGRIDRegionCode" minOccurs="0"/>
506+
<xs:element ref="auc:eGRIDSubregionCodes" minOccurs="0"/>
507507
<xs:choice>
508508
<xs:sequence>
509509
<xs:element ref="auc:WeatherDataStationID" minOccurs="0"/>
@@ -14565,42 +14565,49 @@
1456514565
</xs:sequence>
1456614566
</xs:complexType>
1456714567
</xs:element>
14568-
<xs:element name="eGRIDRegionCode">
14568+
<xs:element name="eGRIDSubregionCodes">
1456914569
<xs:annotation>
14570-
<xs:documentation>The eGRID (Emissions and Generation Resource Database) region code associated with the data being described. WARNING: Element MORE was a typo and will be removed, use MROE.</xs:documentation>
14570+
<xs:documentation>The eGRID (Emissions and Generation Resource Database) subregion codes associated with the data being described.</xs:documentation>
1457114571
</xs:annotation>
14572-
<xs:simpleType>
14573-
<xs:restriction base="xs:string">
14574-
<xs:enumeration value="AKGD"/>
14575-
<xs:enumeration value="AKMS"/>
14576-
<xs:enumeration value="AZNM"/>
14577-
<xs:enumeration value="CAMX"/>
14578-
<xs:enumeration value="ERCT"/>
14579-
<xs:enumeration value="FRCC"/>
14580-
<xs:enumeration value="HIMS"/>
14581-
<xs:enumeration value="HIOA"/>
14582-
<xs:enumeration value="MROE"/>
14583-
<xs:enumeration value="MROW"/>
14584-
<xs:enumeration value="NEWE"/>
14585-
<xs:enumeration value="NWPP"/>
14586-
<xs:enumeration value="NYCW"/>
14587-
<xs:enumeration value="NYLI"/>
14588-
<xs:enumeration value="NYUP"/>
14589-
<xs:enumeration value="PRMS"/>
14590-
<xs:enumeration value="RFCE"/>
14591-
<xs:enumeration value="RFCM"/>
14592-
<xs:enumeration value="RFCW"/>
14593-
<xs:enumeration value="RMPA"/>
14594-
<xs:enumeration value="SPNO"/>
14595-
<xs:enumeration value="SPSO"/>
14596-
<xs:enumeration value="SRMV"/>
14597-
<xs:enumeration value="SRMW"/>
14598-
<xs:enumeration value="SRSO"/>
14599-
<xs:enumeration value="SRTV"/>
14600-
<xs:enumeration value="SRVC"/>
14601-
<xs:enumeration value="Other"/>
14602-
</xs:restriction>
14603-
</xs:simpleType>
14572+
<xs:complexType>
14573+
<xs:sequence>
14574+
<xs:element name="eGRIDSubregionCode">
14575+
<xs:simpleType>
14576+
<xs:restriction base="xs:string">
14577+
<xs:enumeration value="AKGD"/>
14578+
<xs:enumeration value="AKMS"/>
14579+
<xs:enumeration value="AZNM"/>
14580+
<xs:enumeration value="CAMX"/>
14581+
<xs:enumeration value="ERCT"/>
14582+
<xs:enumeration value="FRCC"/>
14583+
<xs:enumeration value="HIMS"/>
14584+
<xs:enumeration value="HIOA"/>
14585+
<xs:enumeration value="MORE"/>
14586+
<xs:enumeration value="MROE"/>
14587+
<xs:enumeration value="MROW"/>
14588+
<xs:enumeration value="NEWE"/>
14589+
<xs:enumeration value="NWPP"/>
14590+
<xs:enumeration value="NYCW"/>
14591+
<xs:enumeration value="NYLI"/>
14592+
<xs:enumeration value="NYUP"/>
14593+
<xs:enumeration value="PRMS"/>
14594+
<xs:enumeration value="RFCE"/>
14595+
<xs:enumeration value="RFCM"/>
14596+
<xs:enumeration value="RFCW"/>
14597+
<xs:enumeration value="RMPA"/>
14598+
<xs:enumeration value="SPNO"/>
14599+
<xs:enumeration value="SPSO"/>
14600+
<xs:enumeration value="SRMV"/>
14601+
<xs:enumeration value="SRMW"/>
14602+
<xs:enumeration value="SRSO"/>
14603+
<xs:enumeration value="SRTV"/>
14604+
<xs:enumeration value="SRVC"/>
14605+
<xs:enumeration value="Other"/>
14606+
</xs:restriction>
14607+
</xs:simpleType>
14608+
</xs:element>
14609+
</xs:sequence>
14610+
</xs:complexType>
1460414611
</xs:element>
1460514612
<xs:element name="WeatherDataStationID">
1460614613
<xs:annotation>

‎proposals/2021/Deprecate eGRIDRegionCode.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Deprecate eGRIDRegionCode
2+
3+
## Overview
4+
5+
This proposal is to remove the element `auc:eGRIDRegionCode` and deprecate the choice of `auc:eGRIDRegionCode` reference under `auc:Site` and `auc:Building`.
6+
7+
## Justification
8+
9+
The element `auc:eGRIDSubregionCodes` was added in [#387](https://github.com/BuildingSync/schema/pull/387) to replace the function of `auc:eGRIDRegionCode` and allow multiple eGRID Subregion Codes with the `auc:Site` and/or `auc:Building`. `auc:eGRIDSubregionCodes` and `auc:eGRIDRegionCode` are currently options of the `auc:choice` element under both `auc:Site` and `auc:Building`. In version 3.0, we will deprecate `auc:eGRIDRegionCode`.
10+
11+
## Implementation
12+
13+
We will remove the element and choice of `auc:eGRIDRegionCode`, and make `auc:eGRIDSubregionCodes` direct child under `auc:Site` and `auc:Building`.
14+
15+
## References

‎translation/v2_to_v3.xsl

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,10 @@ Version: 0.1.0
5050
<xsl:copy>Insulate attic hatch</xsl:copy>
5151
</xsl:template>
5252
<!-- 3. Map enumeration "MORE" to "MROE" under auc:eGRIDRegionCode -->
53-
<xsl:template match="auc:eGRIDRegionCode/auc:MeasureName[. = 'MORE']">
54-
<xsl:copy>MROE</xsl:copy>
53+
<xsl:template match="auc:eGRIDRegionCode[. = 'MORE']">
54+
<xsl:element name="auc:eGRIDSubregionCodes">
55+
<auc:eGRIDSubregionCode>MROE</auc:eGRIDSubregionCode>
56+
</xsl:element>
5557
</xsl:template>
5658
<!-- 4. Map enumeration "Convert to Cleaner Fuels" to "Convert to cleaner fuels" under auc:BoilerPlantImprovements -->
5759
<xsl:template match="auc:BoilerPlantImprovements/auc:MeasureName[. = 'Convert to Cleaner Fuels']">
@@ -99,7 +101,7 @@ Version: 0.1.0
99101
</xsl:element>
100102
</xsl:template>
101103

102-
<!-- Systems and other components -->
104+
<!-- Systems and general components -->
103105

104106
<!-- 1. Deprecate auc:Capacity and auc:CapacityUnits under auc:Delivery -->
105107
<xsl:template match="auc:Delivery/auc:Capacity">
@@ -148,17 +150,25 @@ Version: 0.1.0
148150
<xsl:copy-of select="."/>
149151
</xsl:element>
150152
</xsl:template>
151-
152153
<!-- Transform auc:WindowID element under auc:Side to auc:WindowIDs/auc:WindowID element -->
153154
<xsl:template match="auc:WindowID">
154155
<xsl:element name="auc:WindowIDs">
155156
<xsl:copy-of select="."/>
156157
</xsl:element>
157158
</xsl:template>
159+
<!-- Transform auc:DoorID element under auc:Side to auc:DoorIDs/auc:DoorID element -->
158160
<xsl:template match="auc:DoorID">
159161
<xsl:element name="auc:DoorIDs">
160162
<xsl:copy-of select="."/>
161163
</xsl:element>
162164
</xsl:template>
165+
<!-- 6. Transform auc:eGRIDRegionCode element to auc:eGRIDSubregionCodes/auc:eGRIDSubregionCode element -->
166+
<xsl:template match="auc:eGRIDRegionCode">
167+
<xsl:element name="auc:eGRIDSubregionCodes">
168+
<xsl:element name="auc:eGRIDSubregionCode">
169+
<xsl:apply-templates/>
170+
</xsl:element>
171+
</xsl:element>
172+
</xsl:template>
163173

164174
</xsl:stylesheet>

0 commit comments

Comments
 (0)