Skip to content

spec.md

Latest commit

 

History

History
130 lines (97 loc) · 5.22 KB

spec.md

File metadata and controls

130 lines (97 loc) · 5.22 KB

Junction

Description

This entity contains an harmonised description of a generic junction made for the Water Network Management domain. This entity is primarily associated with the water network management vertical and related IoT applications.

Data Model

A JSON Schema corresponding to this data model can be found here

NGSI-LD common Properties

  • id: Unique identifier.

  • type: Entity type. It must be equal to Junction.

  • modifiedAt: Last update timestamp of this entity.

    • Attribute type: Property. DateTime
    • Read-Only. Automatically generated.

  • createdAt: Entity's creation timestamp.

    • Attribute type: Property. DateTime
    • Read-Only. Automatically generated.

  • location : Location of Junction represented by a GeoJSON geometry.

Junction Entity Properties

  • elevation : The elevation above some common reference of the junction

    • Attribute type: Property. Number
    • Attribute unit: All units are accepted in CEFACT code
    • Attribute unit Example: Metre
    • CEFACT unitCode: MTR
    • Attribute metadata Properties:
      • {{metadata Property name}} : {{Metadata Property Description}}
    • Mondatory

  • tag : An optional text string used to assign the junction to a category, such as a pressure zone

    • Attribute type: Property.Text
    • Optional

  • description : An optional text that describes other significant information about the junction

    • Attribute type: Property.Text
    • Optional

  • initialQuality : Water quality level at the junction at the start of the simulation

    • Attribute type: Property. Number
    • Attribute unit: All units are accepted in CEFACT code
    • Attribute unit Example: mg/L
    • CEFACT unitCode: M1
    • Attribute metadata Properties:
      • {{metadata Property name}} : {{Metadata Property Description}}
    • Optional

  • emitterCoefficient : Discharge coefficient for emitter (sprinkler or nozzle) placed at junction

    • Attribute type: Property. Number
    • Attribute unit: All units are accepted in CEFACT code
    • Attribute unit Example: square metre per second
    • CEFACT unitCode: S4
    • Attribute metadata Properties:
      • {{metadata Property name}} : {{Metadata Property Description}}
    • Optional

  • demandCategory : Allows base demands and time patterns to be assigned to other categories of users at the junction

    • Attribute type: Property.Text
    • baseDemand: A sub-property.
    • demandPattern: A sub-Relationship
    • Optional

  • base demande : Baseline or average demand for the category. A sub-property of the Property demandCategory

    • Attribute type: Property. Number
    • Attribute unit: All units are accepted in CEFACT code
    • Attribute unit Example: cubic metre per second
    • CEFACT unitCode: MQS
    • Optional

  • sourceCategory : Description of the quality of source flow entering the network at a specific node

    • Attribute type: Property.Text
    • sourceType: A sub-property.
    • sourceQuality:A sub-property.
    • sourcePattern: A sub-Relationship.
    • Optional

  • sourceType : A sub-property of the Property sourceCategory

    • Attribute type: Property.Text
    • Values Restricted to : "CONCEN", "MASS", "FLOWPACED" and "SETPOINT"
    • Optional

  • sourceQuality : Baseline or average concentration (or mass flow rate) of source. A sub-property of the Property sourceCategory

    • Attribute type: Property. Number
    • Attribute unit: All units are accepted in CEFACT code
    • Attribute unit Example: mg/L
    • CEFACT unitCode: M1
    • Optional

Junction Entity Relationships

  • demandPattern: A relationship to the pattern pf the demandCategory property

    • Attribute type: Relationship. Reference to an entity of type Pattern
    • Attribute metadata Properties:
      • {{metadata Property name}} : {{Metadata Property Description}}
    • Optional

  • sourcePattern : A relationship to the pattern pf the sourceCategory property

    • Attribute type: Relationship. Reference to an entity of type Pattern
    • Attribute metadata Properties:
      • {{metadata Property name}} : {{Metadata Property Description}}
    • Optional

Note: JSON Schemas are intended to capture the data type and associated constraints of the different Attributes, regardless their final representation format in NGS-LD.

LD Example

A full example is presented here.

Use it with a real service

T.B.D.

Open Issues