@bentley/substation-drawing-schema 1.0.5-dev.1

package/LICENSE.md

@@ -0,0 +1,9 @@
+# MIT License
+
+Copyright © 2017-2026 Bentley Systems, Incorporated. All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,9 @@
+# @bentley/substation-drawing-schema
+
+Copyright © Bentley Systems, Incorporated. All rights reserved. See [LICENSE.md](./LICENSE.md) for license terms and full copyright notice.
+
+[iTwin.js](http://itwinjs.org) is an open source platform for creating, querying, modifying, and displaying Infrastructure Digital Twins.
+
+## BIS Schemas
+
+The acronym “BIS” stands for “Base Infrastructure Schemas”. BIS is an “open” and extensible family of schemas that is modularized into Domains. Please go to [iTwinjs.org](https://www.itwinjs.org/bis/) for more information.

package/SubstationDrawing.ecschema.json

@@ -0,0 +1 @@
+{"$schema":"https://dev.bentley.com/json_schemas/ec/32/ecschema","name":"SubstationDrawing","version":"01.00.05","alias":"subdwg","label":"Substation","description":"This schema contains classes used for Substation Design.","references":[{"name":"BisCore","version":"01.00.26"},{"name":"CoreCustomAttributes","version":"01.00.05"},{"name":"BisCustomAttributes","version":"01.00.00"}],"customAttributes":[{"className":"CoreCustomAttributes.ProductionStatus","SupportedUse":"NotForProduction"},{"className":"BisCustomAttributes.SchemaLayerInfo","Value":"Application"}],"items":{"ElectricalGraphicalType2d":{"schemaItemType":"EntityClass","label":"Electrical Graphical Type","description":"Represents the Graphical Type for Electrical Symbols.","baseClass":"BisCore.GraphicalType2d"},"ElectricalSingleSymbolDefinition":{"schemaItemType":"EntityClass","label":"2D Single Symbol","description":"Represents the Graphical and Connection data associated with one 2D Electrical Symbol Definition. A ElectricalSingleSymbolDefinition is represented by a ElectricalSymbolGraphic2d and owns one or more ConnectionPointAspect2d Aspects.","modifier":"Sealed","baseClass":"BisCore.DefinitionElement","properties":[{"name":"DrawingType","type":"NavigationProperty","description":"Reference to the Drawing Type. The Elements in the Type's Recipe's template Model are placed when the users selects to place the Symbol in a Drawing Model","relationshipName":"SubstationDrawing.DrawingTypeReference","direction":"Forward"}]},"DrawingTypeReference":{"schemaItemType":"RelationshipClass","modifier":"None","strength":"Referencing","strengthDirection":"Backward","source":{"multiplicity":"(0..*)","roleLabel":"refers to","polymorphic":true,"constraintClasses":["SubstationDrawing.ElectricalSingleSymbolDefinition"]},"target":{"multiplicity":"(1..1)","roleLabel":"is referred by","polymorphic":true,"constraintClasses":["SubstationDrawing.ElectricalGraphicalType2d"]}},"ElectricalSymbolRecipe":{"schemaItemType":"EntityClass","label":"Symbol Recipe","description":"Represents the Graphics, Anchor points and Property Label data associated with an Equipment's Physical (3D) Definition.","modifier":"Sealed","baseClass":"BisCore.TemplateRecipe2d"},"ElectricalSymbolGraphic2d":{"schemaItemType":"EntityClass","label":"2D Symbol Graphic","description":"Stores the Graphical data associated with one 2D Electrical Symbol. Its (0,0) the insertion point of the Symbol. A ElectricalSymbolGraphic2d Element is used two ways: (1) As the 'graphical aspect' of a 2D Symbol's definition. In this case the ElectricalSymbolGraphic2d is associated with its ElectricalSingleSymbolDefinition thru' is SingleSymbolRecipe. (2) As an instance of 2D Symbol when placed in a Substation Project's Drawing Model. In this case the SymbolGraphics2d is associated with its EquipmentFunctional by the func:DrawingGraphicRepresentsFunctionalElement relationship.","baseClass":"BisCore.DrawingGraphic","properties":[{"name":"ScaleX","type":"PrimitiveProperty","description":"The X-Scale of the Symbol when placed in a Drawing Model","typeName":"double"},{"name":"ScaleY","type":"PrimitiveProperty","description":"The Y-Scale of the Symbol when placed in a Drawing Model","typeName":"double"}]},"ElectricalLineSegment":{"schemaItemType":"EntityClass","label":"Electrical Line Segment","description":"An ElectricalLineSegment Element is a 2D element that connects to either a Symbol or another Segment. One or more connected ElectricalLineSegments may represent a (Functional) ElectricalWire.","baseClass":"BisCore.DrawingGraphic"}}}

package/SubstationDrawing.ecschema.xml

@@ -0,0 +1,47 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- ==================================================================================
+|  * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+|  * See LICENSE.md in the project root for license terms and full copyright notice.
+======================================================================================= -->
+<ECSchema xmlns="http://www.bentley.com/schemas/Bentley.ECXML.3.2" schemaName="SubstationDrawing" version="01.00.05" alias="subdwg" displayLabel="Substation" description="This schema contains classes used for Substation Design.">
+  <ECSchemaReference name="BisCore" version="01.00.25" alias="bis"/>
+  <ECSchemaReference name="CoreCustomAttributes" version="01.00.04" alias="CoreCA" />
+  <ECSchemaReference name="BisCustomAttributes" version="01.00.00" alias="bisCA" />
+  <ECCustomAttributes>
+    <ProductionStatus xmlns="CoreCustomAttributes.01.00.04">
+      <SupportedUse>NotForProduction</SupportedUse>
+    </ProductionStatus>
+    <SchemaLayerInfo xmlns="BisCustomAttributes.01.00.00">
+      <Value>Application</Value>
+    </SchemaLayerInfo>
+  </ECCustomAttributes>
+  <!-- Symbol Graphic Classes -->
+  <ECEntityClass typeName="ElectricalGraphicalType2d" modifier="None" displayLabel="Electrical Graphical Type" description="Represents the Graphical Type for Electrical Symbols.">
+    <BaseClass>bis:GraphicalType2d</BaseClass>
+  </ECEntityClass>
+  <ECEntityClass typeName="ElectricalSingleSymbolDefinition" modifier="Sealed" displayLabel="2D Single Symbol" description="Represents the Graphical and Connection data associated with one 2D Electrical Symbol Definition. A ElectricalSingleSymbolDefinition is represented by a ElectricalSymbolGraphic2d and owns one or more ConnectionPointAspect2d Aspects.">
+    <BaseClass>bis:DefinitionElement</BaseClass>
+    <ECNavigationProperty propertyName="DrawingType" relationshipName="DrawingTypeReference" direction="Forward" description="Reference to the Drawing Type. The Elements in the Type's Recipe's template Model are placed when the users selects to place the Symbol in a Drawing Model"/>
+  </ECEntityClass>
+  <ECEntityClass typeName="ElectricalSymbolRecipe" modifier="Sealed" displayLabel="Symbol Recipe" description="Represents the Graphics, Anchor points and Property Label data associated with an Equipment's Physical (3D) Definition.">
+    <BaseClass>bis:TemplateRecipe2d</BaseClass>
+  </ECEntityClass>
+  <ECEntityClass typeName="ElectricalSymbolGraphic2d" modifier="None" displayLabel="2D Symbol Graphic" description="Stores the Graphical data associated with one 2D Electrical Symbol. Its (0,0) the insertion point of the Symbol. A ElectricalSymbolGraphic2d Element is used two ways: (1) As the 'graphical aspect' of a 2D Symbol's definition. In this case the ElectricalSymbolGraphic2d is associated with its ElectricalSingleSymbolDefinition thru' is SingleSymbolRecipe. (2) As an instance of 2D Symbol when placed in a Substation Project's Drawing Model. In this case the SymbolGraphics2d is associated with its EquipmentFunctional by the func:DrawingGraphicRepresentsFunctionalElement relationship.">
+    <BaseClass>bis:DrawingGraphic</BaseClass>
+    <ECProperty propertyName="ScaleX" typeName="double" description="The X-Scale of the Symbol when placed in a Drawing Model"/>
+    <ECProperty propertyName="ScaleY" typeName="double" description="The Y-Scale of the Symbol when placed in a Drawing Model"/>
+  </ECEntityClass>
+  <!-- Element Classes used when an equipment is 'instanced' in an iModel -->
+  <ECEntityClass typeName="ElectricalLineSegment" modifier="None" displayLabel="Electrical Line Segment" description="An ElectricalLineSegment Element is a 2D element that connects to either a Symbol or another Segment. One or more connected ElectricalLineSegments may represent a (Functional) ElectricalWire.">
+    <BaseClass>bis:DrawingGraphic</BaseClass>
+  </ECEntityClass>
+  <!-- Relationships -->
+  <ECRelationshipClass typeName="DrawingTypeReference" strength="referencing" strengthDirection="Backward" modifier="None">
+    <Source multiplicity="(0..*)" roleLabel="refers to" polymorphic="true">
+      <Class class="ElectricalSingleSymbolDefinition"/>
+    </Source>
+    <Target multiplicity="(1..1)" roleLabel="is referred by" polymorphic="true">
+      <Class class="ElectricalGraphicalType2d"/>
+    </Target>
+  </ECRelationshipClass>  
+</ECSchema>

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@bentley/substation-drawing-schema",
+  "license": "MIT",
+  "version": "1.0.5-dev.1",
+  "homepage": "https://www.itwinjs.org/",
+  "keywords": [
+    "Bentley",
+    "BIS",
+    "iModel"
+  ],
+  "description": "SubstationDrawing BIS Domains",
+  "author": {
+    "name": "Bentley Systems, Inc.",
+    "url": "http://www.bentley.com"
+  },
+  "exports" : {
+     "./SubstationDrawing.ecschema.xml": "./SubstationDrawing.ecschema.xml",
+     "./SubstationDrawing.ecschema.json": "./SubstationDrawing.ecschema.json"
+  }
+}