{
  "$schema": "http://json-schema.org/schema#",
  "$id": "https://smart-data-models.github.io/data-models.OpenChannelManagement/SluiceGate/schema.json",
  "modelTags": "FIWARE4WATER",
  "$schemaVersion": "0.0.1",
  "modelTags": "FIWARE4WATER",
  "title": "Open Channel Management - SluiceGate ",
  "description": "This entity contains a harmonised description of a generic Sluice Gate made for Raw-Water (Open Channels) System Management domain.",
  "type": "object",
  "allOf": [
    {
      "$ref": "https://smart-data-models.github.io/data-models/common-schema.json#/definitions/Location-Commons"
    },
    {
      "$ref": "https://smart-data-models.github.io/data-models/common-schema.json#/definitions/GSMA-Commons"
    },
    {
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "SluiceGate"
          ],
          "description": "Property. NGSI-LD Entity Type. It has to be SluiceGate."
        },
        "tag": {
          "$ref": "https://smart-data-models.github.io/data-models/common-schema.json#/definitions/tag"
        },
        "gateWidth": {
          "type": "number",
          "minimum": 0,
          "description": "Property. The width of the sluice gate. Units: 'meters'."
        },
        "gateOpening": {
          "type": "number",
          "minimum": 0,
          "description": "Property. The height of gate opening."
        },
        "gateBottomElevation": {
          "type": "number",
          "minimum": 0,
          "description": "Property. Elevation of the bottom (crest) of the gate."
        },
        "gateDischargeCoefficient": {
          "type": "number",
          "minimum": 0,
          "description": "Property. Discharge coefficient of the gate that accounts for energy losses as water passes under the gate."
        },
        "orificeDischargeCoefficient": {
          "type": "number",
          "minimum": 0,
          "description": "Property. Orifice discharge coefficient that accounts for energy losses as water passes under the gate, and the downstream tailwater increases so that the gate is no longer flowing freely."
        },
        "waterDischarge": {
          "type": "number",
          "minimum": 0,
          "description": "Property. The discharge that passes the weir (Q)."
        },
        "headDifference": {
          "type": "number",
          "minimum": 0,
          "description": "Property. The difference between the upstream depth and the depth just downstream."
        },
        "flowType": {
          "type": "string",
          "enum": [
            "Free-Flow",
            "Overflow",
            "Submerged-Flow"
          ],
          "description": "Property. It defines the flow conditions in the gate. It takes the values: 'Overflow' (upstream water level exceeds the weir crest level), 'Free-Flow' (water level is lower than gate edge), 'Submerged Flow' (the rate of flow passing through the gate is regulated by the opening of the gate). Enum:'Overflow, Free-Flow, Submerged-Flow'."
        },
        "upstreamEndControlPoint": {
          "anyOf": [
            {
              "type": "string",
              "minLength": 1,
              "maxLength": 256,
              "pattern": "^[\\w\\-\\.\\{\\}\\$\\+\\*\\[\\]`|~^@!,:\\\\]+$",
              "description": "Property. Identifier format of any NGSI entity"
            },
            {
              "type": "string",
              "format": "uri",
              "description": "Property. Identifier format of any NGSI entity"
            }
          ],
          "description": "Relationship. A relationship indicating the ID of an entity of type Cross Section, representing a cross section just upstream of the sluice gate."
        },
        "downstreamEndControlPoint": {
          "anyOf": [
            {
              "type": "string",
              "minLength": 1,
              "maxLength": 256,
              "pattern": "^[\\w\\-\\.\\{\\}\\$\\+\\*\\[\\]`|~^@!,:\\\\]+$",
              "description": "Property. Identifier format of any NGSI entity"
            },
            {
              "type": "string",
              "format": "uri",
              "description": "Property. Identifier format of any NGSI entity"
            }
          ],
          "description": "Relationship. A relationship indicating the ID of an entity of type Cross Section, representing a cross section just downstream of the sluice gate."
        },
        "upstreamControlPoint": {
          "anyOf": [
            {
              "type": "string",
              "minLength": 1,
              "maxLength": 256,
              "pattern": "^[\\w\\-\\.\\{\\}\\$\\+\\*\\[\\]`|~^@!,:\\\\]+$",
              "description": "Property. Identifier format of any NGSI entity"
            },
            {
              "type": "string",
              "format": "uri",
              "description": "Property. Identifier format of any NGSI entity"
            }
          ],
          "description": "Relationship. A relationship indicating the ID of an entity of type Cross Section, representing a cross section in a distance where the flow conditions are permanent, upstream of the sluice gate."
        },
        "downstreamControlPoint": {
          "anyOf": [
            {
              "type": "string",
              "minLength": 1,
              "maxLength": 256,
              "pattern": "^[\\w\\-\\.\\{\\}\\$\\+\\*\\[\\]`|~^@!,:\\\\]+$",
              "description": "Property. Identifier format of any NGSI entity"
            },
            {
              "type": "string",
              "format": "uri",
              "description": "Property. Identifier format of any NGSI entity"
            }
          ],
          "description": "Relationship. A relationship indicating the ID of an entity of type Cross Section, representing a cross section in a distance where the flow conditions are permanent, downstream of the sluice gate."
        },
        "observedBy": {
          "anyOf": [
            {
              "type": "string",
              "minLength": 1,
              "maxLength": 256,
              "pattern": "^[\\w\\-\\.\\{\\}\\$\\+\\*\\[\\]`|~^@!,:\\\\]+$",
              "description": "Property. Identifier format of any NGSI entity"
            },
            {
              "type": "string",
              "format": "uri",
              "description": "Property. Identifier format of any NGSI entity"
            }
          ],
          "description": "Relationship. A relationship to the ID of the device that monitors raw-water properties. Model:'https://smart-data-models.github.io/dataModel.Device/device-schema.json'"
        },
        "curveDischargeCoefficient": {
          "anyOf": [
            {
              "type": "string",
              "minLength": 1,
              "maxLength": 256,
              "pattern": "^[\\w\\-\\.\\{\\}\\$\\+\\*\\[\\]`|~^@!,:\\\\]+$",
              "description": "Property. Identifier format of any NGSI entity"
            },
            {
              "type": "string",
              "format": "uri",
              "description": "Property. Identifier format of any NGSI entity"
            }
          ],
          "description": "Relationship. The URI of an OpenChannelCurve entity that represents the Discharge Coefficient (C) as a function of relative weir opening (weir opening (a) over upstream depth(H)), C over a/H."
        }
      }
    }
  ],
  "required": [
    "id",
    "type",
    "location"
  ]
}