Skip to content

Deprecate eGRIDRegionCode #394

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Sep 29, 2021
Merged

Deprecate eGRIDRegionCode #394

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
aa74a90
Create proposal and implement
JieXiong9119 Sep 9, 2021
d4f97e6
Merge branch 'develop-v3' into deprecate/egridregioncode
JieXiong9119 Sep 28, 2021
2b2b89f
Update v2_to_v3.xsl
JieXiong9119 Sep 28, 2021
006b9e1
Update v2_to_v3.xsl
JieXiong9119 Sep 28, 2021
c495761
Correct comment in v2_to_v3.xsl
JieXiong9119 Sep 29, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 43 additions & 36 deletions BuildingSync.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -454,7 +454,7 @@
</xs:annotation>
</xs:element>
<xs:element ref="auc:ClimateZoneType" minOccurs="0" maxOccurs="1"/>
<xs:element ref="auc:eGRIDRegionCode" minOccurs="0"/>
<xs:element ref="auc:eGRIDSubregionCodes" minOccurs="0"/>
<xs:choice>
<xs:sequence>
<xs:element ref="auc:WeatherDataStationID" minOccurs="0"/>
Expand Down Expand Up @@ -503,7 +503,7 @@
</xs:annotation>
</xs:element>
<xs:element ref="auc:ClimateZoneType" minOccurs="0" maxOccurs="1"/>
<xs:element ref="auc:eGRIDRegionCode" minOccurs="0"/>
<xs:element ref="auc:eGRIDSubregionCodes" minOccurs="0"/>
<xs:choice>
<xs:sequence>
<xs:element ref="auc:WeatherDataStationID" minOccurs="0"/>
Expand Down Expand Up @@ -14565,42 +14565,49 @@
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="eGRIDRegionCode">
<xs:element name="eGRIDSubregionCodes">
<xs:annotation>
<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>
<xs:documentation>The eGRID (Emissions and Generation Resource Database) subregion codes associated with the data being described.</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="AKGD"/>
<xs:enumeration value="AKMS"/>
<xs:enumeration value="AZNM"/>
<xs:enumeration value="CAMX"/>
<xs:enumeration value="ERCT"/>
<xs:enumeration value="FRCC"/>
<xs:enumeration value="HIMS"/>
<xs:enumeration value="HIOA"/>
<xs:enumeration value="MROE"/>
<xs:enumeration value="MROW"/>
<xs:enumeration value="NEWE"/>
<xs:enumeration value="NWPP"/>
<xs:enumeration value="NYCW"/>
<xs:enumeration value="NYLI"/>
<xs:enumeration value="NYUP"/>
<xs:enumeration value="PRMS"/>
<xs:enumeration value="RFCE"/>
<xs:enumeration value="RFCM"/>
<xs:enumeration value="RFCW"/>
<xs:enumeration value="RMPA"/>
<xs:enumeration value="SPNO"/>
<xs:enumeration value="SPSO"/>
<xs:enumeration value="SRMV"/>
<xs:enumeration value="SRMW"/>
<xs:enumeration value="SRSO"/>
<xs:enumeration value="SRTV"/>
<xs:enumeration value="SRVC"/>
<xs:enumeration value="Other"/>
</xs:restriction>
</xs:simpleType>
<xs:complexType>
<xs:sequence>
<xs:element name="eGRIDSubregionCode">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="AKGD"/>
<xs:enumeration value="AKMS"/>
<xs:enumeration value="AZNM"/>
<xs:enumeration value="CAMX"/>
<xs:enumeration value="ERCT"/>
<xs:enumeration value="FRCC"/>
<xs:enumeration value="HIMS"/>
<xs:enumeration value="HIOA"/>
<xs:enumeration value="MORE"/>
<xs:enumeration value="MROE"/>
<xs:enumeration value="MROW"/>
<xs:enumeration value="NEWE"/>
<xs:enumeration value="NWPP"/>
<xs:enumeration value="NYCW"/>
<xs:enumeration value="NYLI"/>
<xs:enumeration value="NYUP"/>
<xs:enumeration value="PRMS"/>
<xs:enumeration value="RFCE"/>
<xs:enumeration value="RFCM"/>
<xs:enumeration value="RFCW"/>
<xs:enumeration value="RMPA"/>
<xs:enumeration value="SPNO"/>
<xs:enumeration value="SPSO"/>
<xs:enumeration value="SRMV"/>
<xs:enumeration value="SRMW"/>
<xs:enumeration value="SRSO"/>
<xs:enumeration value="SRTV"/>
<xs:enumeration value="SRVC"/>
<xs:enumeration value="Other"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="WeatherDataStationID">
<xs:annotation>
Expand Down
15 changes: 15 additions & 0 deletions proposals/2021/Deprecate eGRIDRegionCode.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Deprecate eGRIDRegionCode

## Overview

This proposal is to remove the element `auc:eGRIDRegionCode` and deprecate the choice of `auc:eGRIDRegionCode` reference under `auc:Site` and `auc:Building`.

## Justification

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

## Implementation

We will remove the element and choice of `auc:eGRIDRegionCode`, and make `auc:eGRIDSubregionCodes` direct child under `auc:Site` and `auc:Building`.

## References
18 changes: 14 additions & 4 deletions translation/v2_to_v3.xsl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,10 @@ Version: 0.1.0
<xsl:copy>Insulate attic hatch</xsl:copy>
</xsl:template>
<!-- 3. Map enumeration "MORE" to "MROE" under auc:eGRIDRegionCode -->
<xsl:template match="auc:eGRIDRegionCode/auc:MeasureName[. = 'MORE']">
<xsl:copy>MROE</xsl:copy>
<xsl:template match="auc:eGRIDRegionCode[. = 'MORE']">
<xsl:element name="auc:eGRIDSubregionCodes">
<auc:eGRIDSubregionCode>MROE</auc:eGRIDSubregionCode>
</xsl:element>
</xsl:template>
<!-- 4. Map enumeration "Convert to Cleaner Fuels" to "Convert to cleaner fuels" under auc:BoilerPlantImprovements -->
<xsl:template match="auc:BoilerPlantImprovements/auc:MeasureName[. = 'Convert to Cleaner Fuels']">
Expand Down Expand Up @@ -99,7 +101,7 @@ Version: 0.1.0
</xsl:element>
</xsl:template>

<!-- Systems and other components -->
<!-- Systems and general components -->

<!-- 1. Deprecate auc:Capacity and auc:CapacityUnits under auc:Delivery -->
<xsl:template match="auc:Delivery/auc:Capacity">
Expand Down Expand Up @@ -148,17 +150,25 @@ Version: 0.1.0
<xsl:copy-of select="."/>
</xsl:element>
</xsl:template>

<!-- Transform auc:WindowID element under auc:Side to auc:WindowIDs/auc:WindowID element -->
<xsl:template match="auc:WindowID">
<xsl:element name="auc:WindowIDs">
<xsl:copy-of select="."/>
</xsl:element>
</xsl:template>
<!-- Transform auc:DoorID element under auc:Side to auc:DoorIDs/auc:DoorID element -->
<xsl:template match="auc:DoorID">
<xsl:element name="auc:DoorIDs">
<xsl:copy-of select="."/>
</xsl:element>
</xsl:template>
<!-- 6. Transform auc:eGRIDRegionCode element to auc:eGRIDSubregionCodes/auc:eGRIDSubregionCode element -->
<xsl:template match="auc:eGRIDRegionCode">
<xsl:element name="auc:eGRIDSubregionCodes">
<xsl:element name="auc:eGRIDSubregionCode">
<xsl:apply-templates/>
</xsl:element>
</xsl:element>
</xsl:template>

</xsl:stylesheet>