DistributionSystems Schema

Alias: dsys

Version: 1.0.1

A schema for defining distribution systems.

This schema contains classes for physical modeling of distribution systems - networks designed to receive, store, maintain, distribute, or control the flow of a distribution media. The primary goal of this schema, however, is not to model network connectivity but to model physical properties of elements participating in a distribution system and their physical connections or connection points.

A BIS DistributionSystem consists of IDistributionElements, which can be either IDistributionFlowElements that direct flow, IDistributionControlElements that control IDistributionFlowElements, or IDistributionSensorElements, which make observations relevant to the DistributionSystem.

A given bis:PhysicalElement can implement more that one of IDistributionFlowElement, IDistributionControlElement, and IDistributionFlowElement.

Connection point information will be added in subsequent versions of the schema.

Class and Instance Diagrams

Table of contents

Entity Classes

DistributionSystem (Distribution System) EntityClass

A network designed to receive, store, maintain, distribute, or control the flow of a distribution media.

Base Class: BisCore:PhysicalSystem

Inherited properties
Name Description Type Extended Type
Model The bis:Model that contains this bis:Element. navigation
LastMod The last modified time of the bis:Element. This is maintained by the core framework and should not be set directly by applications. dateTime
CodeSpec The CodeSpec property identifies the bis:CodeSpec used to generate and validate the code value for this bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. navigation
CodeScope The CodeScope property identifies the bis:Element that provides the uniqueness scope for the code value. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. navigation
CodeValue The CodeValue property stores a human-readable real-world identifier of the Entity represented by the bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. string
UserLabel An optional friendly name given by the user (as opposed to the formal name stored in the CodeValue property). string
Parent The parent bis:Element that owns this bis:Element. navigation
FederationGuid The GUID used to federate this bis:Element across repositories. binary BeGuid
JsonProperties A string property that users and/or applications can use to persist ad hoc JSON values. string Json
AggregatingSystem The aggregator of this sub-system within the System hierarchy. navigation

Mixins

IDistributionControlElement (Distribution Control Element) Abstract Mixin

An interface that can be mixed-into a bis:PhysicalElement to indicate that it is an IDistributionElement that controls other elements of a distribution system.

Base Class: DistributionSystems:IDistributionElement

Applies To: PhysicalElement

IDistributionElement (Distribution Element) Abstract Mixin

An interface that can be mixed-into a bis:PhysicalElement to indicate that it can be a member of a DistributionSystem.

Base Class: BisCore:IParentElement

Applies To: PhysicalElement

IDistributionFlowElement (Distribution Flow Element) Abstract Mixin

An interface that can be mixed-into a bis:PhysicalElement to indicate that it is an IDistributionElement that facilitates the distribution of energy or matter, such as air, water or power.

Base Class: DistributionSystems:IDistributionElement

Applies To: PhysicalElement

IDistributionSensorElement (Distribution Sensor Element) Abstract Mixin

An interface that can be mixed-into a bis:PhysicalElement to indicate that it is an IDistributionElement that observes conditions that affect a distribution system.

Base Class: DistributionSystems:IDistributionElement

Applies To: PhysicalElement

Relationship Classes

DistributionSystemGroupsDistributionElements (Distribution System Groups Distribution Elements) RelationshipClass

A relationship used to identify the dsys:IDistributionElements that are members of a DistributionSystem.

Base Class: BisCore:PhysicalSystemGroupsMembers

Strength: Referencing

Strength Direction: Forward

Source

Is Polymorphic: true

Role Label: groups

Multiplicity: (0..*)

Constraint Classes:

Target

Is Polymorphic: true

Role Label: is grouped by

Multiplicity: (0..*)

Constraint Classes:

Last Updated: 21 November, 2022