@bentley/substation-symbols-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-symbols-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/SubstationSymbols.ecschema.json

@@ -0,0 +1 @@
+{"$schema":"https://dev.bentley.com/json_schemas/ec/32/ecschema","name":"SubstationSymbols","version":"01.00.05","alias":"subsym","label":"SubstationSymbols","description":"This schema contains classes used for Substation Design.","references":[{"name":"BisCore","version":"01.00.26"},{"name":"PowerSystemResourcesPhysical","version":"01.00.01"},{"name":"SubstationPhysical","version":"01.00.05"},{"name":"SubstationDrawing","version":"01.00.05"},{"name":"CoreCustomAttributes","version":"01.00.05"},{"name":"BisCustomAttributes","version":"01.00.00"}],"customAttributes":[{"className":"CoreCustomAttributes.ProductionStatus","SupportedUse":"NotForProduction"},{"className":"BisCustomAttributes.SchemaLayerInfo","Value":"Application"}],"items":{"SymbolDrawingAffinity":{"schemaItemType":"Enumeration","type":"int","isStrict":true,"enumerators":[{"name":"Schematic","value":0,"label":"Schematic Drawing"},{"name":"Layout","value":1,"label":"Layout Drawing"},{"name":"Wire","value":2,"label":"Wire Drawing"},{"name":"SingleLine","value":3,"label":"Single Line Drawing"}]},"ElectricalEquipmentDefinition":{"schemaItemType":"EntityClass","label":"Electrical Equipment Definition","description":"Represents the Functional, 2D Graphical, 3D Physical and Connection data associated with an Electrical Equipment or Device.","baseClass":"BisCore.DefinitionElement","properties":[{"name":"PhysicalClassName","type":"PrimitiveProperty","description":"Fully Qualified Class-Name of the Equipment's Physical Class.","typeName":"string"},{"name":"FunctionalClassName","type":"PrimitiveProperty","description":"Fully Qualified Class-Name of the Equipment's Functional Class.","typeName":"string"},{"name":"PhysicalType","type":"NavigationProperty","description":"Reference to the Equipment's Physical Type Class.","relationshipName":"SubstationSymbols.PhysicalTypeReference","direction":"Forward"}]},"PhysicalTypeReference":{"schemaItemType":"RelationshipClass","modifier":"None","strength":"Referencing","strengthDirection":"Backward","source":{"multiplicity":"(1..1)","roleLabel":"refers to","polymorphic":true,"abstractConstraint":"SubstationSymbols.ElectricalEquipmentDefinition","constraintClasses":["SubstationSymbols.ElectricalEquipmentDefinition"]},"target":{"multiplicity":"(0..1)","roleLabel":"is referred by","polymorphic":true,"abstractConstraint":"PowerSystemResourcesPhysical.EquipmentPhysicalType","constraintClasses":["PowerSystemResourcesPhysical.EquipmentPhysicalType"]}},"EquipmentSymbolsPhysicalType":{"schemaItemType":"EntityClass","label":"Equipment Symbols Physical Type","description":"Represents the Physical Type that stores the name of the physical class to be instanced when an electrical equipment is placed. Further the physical type has a reference to the recipe of the graphical elements that need to instanced. These graphical elements represent the physical geometry of the equipment. Can also a shared set of properties whose values vary per-type of an ElectricalPhysicalType.","baseClass":"PowerSystemResourcesPhysical.EquipmentPhysicalType"},"StructureSymbolsPhysicalType":{"schemaItemType":"EntityClass","label":"Structure Symbols Physical Type","description":"Represents the Physical Type that stores the name of the physical class to be instanced when an electrical equipment is placed. Further the physical type has a reference to the recipe of the graphical elements that need to instanced. These graphical elements represent the physical geometry of the equipment. Can also a shared set of properties whose values vary per-type of an ElectricalPhysicalType.","baseClass":"PowerSystemResourcesPhysical.StructurePhysicalType"},"FoundationSymbolsPhysicalType":{"schemaItemType":"EntityClass","label":"Foundation Symbols Physical Type","description":"Represents the Physical Type that stores the name of the physical class to be instanced when an electrical equipment is placed. Further the physical type has a reference to the recipe of the graphical elements that need to instanced. These graphical elements represent the physical geometry of the equipment. Can also a shared set of properties whose values vary per-type of an ElectricalPhysicalType.","baseClass":"PowerSystemResourcesPhysical.FoundationPhysicalType"},"SubstationSymbolsPhysicalType":{"schemaItemType":"EntityClass","label":"Substation Symbols Physical Type","description":"Represents the Physical Type that stores the name of the physical class to be instanced when an electrical equipment is placed. Further the physical type has a reference to the recipe of the graphical elements that need to instanced. These graphical elements represent the physical geometry of the equipment. Can also a shared set of properties whose values vary per-type of an ElectricalPhysicalType.","baseClass":"SubstationPhysical.SubstationPhysicalType"},"EquipmentDefinitionRefersToSymbol":{"schemaItemType":"RelationshipClass","modifier":"None","baseClass":"BisCore.ElementRefersToElements","properties":[{"name":"DrawingAffinity","type":"PrimitiveProperty","description":"The Drawing affinity of the Equipment Definition's Symbol reference","label":"Symbol Drawing Affinity","typeName":"SubstationSymbols.SymbolDrawingAffinity"}],"strength":"Referencing","strengthDirection":"Forward","source":{"multiplicity":"(0..*)","roleLabel":"refers to","polymorphic":true,"abstractConstraint":"SubstationSymbols.ElectricalEquipmentDefinition","constraintClasses":["SubstationSymbols.ElectricalEquipmentDefinition"]},"target":{"multiplicity":"(0..*)","roleLabel":"is referred by","polymorphic":true,"abstractConstraint":"SubstationDrawing.ElectricalSingleSymbolDefinition","constraintClasses":["SubstationDrawing.ElectricalSingleSymbolDefinition"]}}}}

package/SubstationSymbols.ecschema.xml

@@ -0,0 +1,63 @@
+<?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="SubstationSymbols" version="01.00.05" alias="subsym" displayLabel="SubstationSymbols" description="This schema contains classes used for Substation Design.">
+  <ECSchemaReference name="BisCore" version="01.00.25" alias="bis" />
+  <ECSchemaReference name="PowerSystemResourcesPhysical" version="01.00.01" alias="psrp" />
+  <ECSchemaReference name="SubstationPhysical" version="01.00.05" alias="subphy" />
+  <ECSchemaReference name="SubstationDrawing" version="01.00.05" alias="subdwg" />
+  <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>  
+  <ECEnumeration typeName="SymbolDrawingAffinity" backingTypeName="int" isStrict="true">
+    <ECEnumerator name="Schematic" value="0" displayLabel="Schematic Drawing" />
+    <ECEnumerator name="Layout" value="1" displayLabel="Layout Drawing" />
+    <ECEnumerator name="Wire" value="2" displayLabel="Wire Drawing" />
+    <ECEnumerator name="SingleLine" value="3" displayLabel="Single Line Drawing" />
+  </ECEnumeration>
+  <ECEntityClass typeName="ElectricalEquipmentDefinition" displayLabel="Electrical Equipment Definition" description="Represents the Functional, 2D Graphical, 3D Physical and Connection data associated with an Electrical Equipment or Device." modifier="None">
+    <BaseClass>bis:DefinitionElement</BaseClass>
+    <ECProperty propertyName="PhysicalClassName" description="Fully Qualified Class-Name of the Equipment's Physical Class."   typeName="string" />
+    <ECProperty propertyName="FunctionalClassName" description="Fully Qualified Class-Name of the Equipment's Functional Class."   typeName="string" />
+    <ECNavigationProperty propertyName="PhysicalType" description="Reference to the Equipment's Physical Type Class."   relationshipName="PhysicalTypeReference" direction="Forward" />
+  </ECEntityClass>
+  <ECRelationshipClass typeName="PhysicalTypeReference" modifier="None" strength="Referencing" strengthDirection="Backward">
+    <Source polymorphic="true" roleLabel="refers to" multiplicity="(1..1)" abstractConstraint="ElectricalEquipmentDefinition">
+      <Class class="ElectricalEquipmentDefinition" />
+    </Source>
+    <Target polymorphic="true" roleLabel="is referred by" multiplicity="(0..1)" abstractConstraint="psrp:EquipmentPhysicalType">
+      <Class class="psrp:EquipmentPhysicalType" />
+    </Target>
+  </ECRelationshipClass>
+  <ECEntityClass typeName="EquipmentSymbolsPhysicalType" displayLabel="Equipment Symbols Physical Type" description="Represents the Physical Type that stores the name of the physical class to be instanced when an electrical equipment is placed. Further the physical type has a reference to the recipe of the graphical elements that need to instanced. These graphical elements represent the physical geometry of the equipment. Can also a shared set of properties whose values vary per-type of an ElectricalPhysicalType." modifier="None">
+    <BaseClass>psrp:EquipmentPhysicalType</BaseClass>
+  </ECEntityClass>
+  <ECEntityClass typeName="StructureSymbolsPhysicalType" displayLabel="Structure Symbols Physical Type" description="Represents the Physical Type that stores the name of the physical class to be instanced when an electrical equipment is placed. Further the physical type has a reference to the recipe of the graphical elements that need to instanced. These graphical elements represent the physical geometry of the equipment. Can also a shared set of properties whose values vary per-type of an ElectricalPhysicalType." modifier="None">
+    <BaseClass>psrp:StructurePhysicalType</BaseClass>
+  </ECEntityClass>
+  <ECEntityClass typeName="FoundationSymbolsPhysicalType" displayLabel="Foundation Symbols Physical Type" description="Represents the Physical Type that stores the name of the physical class to be instanced when an electrical equipment is placed. Further the physical type has a reference to the recipe of the graphical elements that need to instanced. These graphical elements represent the physical geometry of the equipment. Can also a shared set of properties whose values vary per-type of an ElectricalPhysicalType." modifier="None">
+    <BaseClass>psrp:FoundationPhysicalType</BaseClass>
+  </ECEntityClass>
+  <ECEntityClass typeName="SubstationSymbolsPhysicalType" displayLabel="Substation Symbols Physical Type" description="Represents the Physical Type that stores the name of the physical class to be instanced when an electrical equipment is placed. Further the physical type has a reference to the recipe of the graphical elements that need to instanced. These graphical elements represent the physical geometry of the equipment. Can also a shared set of properties whose values vary per-type of an ElectricalPhysicalType." modifier="None">
+    <BaseClass>subphy:SubstationPhysicalType</BaseClass>
+  </ECEntityClass>
+  <ECRelationshipClass typeName="EquipmentDefinitionRefersToSymbol" modifier="None" strength="Referencing" strengthDirection="Forward">
+    <BaseClass>bis:ElementRefersToElements</BaseClass>
+    <ECProperty propertyName="DrawingAffinity" description="The Drawing affinity of the Equipment Definition's Symbol reference" displayLabel="Symbol Drawing Affinity"   typeName="SymbolDrawingAffinity" />
+    <Source polymorphic="true" roleLabel="refers to" multiplicity="(0..*)" abstractConstraint="ElectricalEquipmentDefinition">
+      <Class class="ElectricalEquipmentDefinition" />
+    </Source>
+    <Target polymorphic="true" roleLabel="is referred by" multiplicity="(0..*)" abstractConstraint="subdwg:ElectricalSingleSymbolDefinition">
+      <Class class="subdwg:ElectricalSingleSymbolDefinition" />
+    </Target>
+  </ECRelationshipClass>
+</ECSchema>

package/package.json

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