{
    "$schema": "http://json-schema.org/schema#",
    "$id": "https://smart-data-models.github.io/data-models.OpenChannelManagement/Spillway/schema.json",
    "$schemaVersion": "0.0.1",
    "modelTags": "FIWARE4WATER",
    "title": "Open Channel Management - Spillway",
    "description": "This entity contains a harmonised description for a generic Spillway made for Raw-Water (Open Channels) System Management domain. Spillway represents a junction-type object, controlling the release of water from a dam or regulation structure downstream.",
    "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": [
                        "Spillway"
                    ],
                    "description": "Property. NGSI Entity Type. It has to be Spillway"
                },
                "tag": {
                    "$ref": "https://smart-data-models.github.io/data-models/common-schema.json#/definitions/tag"
                },
                "spillwayType": {
                    "type": "string",
                    "description": "Property. The type of the spillway. In the case of \u201cSpecified Spillway\u201d, only \u201cElevation \u2013 discharge\u201d curve is required. Enum:'Broad-Crested, Ogee, Sharp-Crested, Specified Spillway'",
                    "enum": [
                        "Broad-Crested",
                        "Ogee",
                        "Sharp-Crested",
                        "Specified Spillway"
                    ]
                },
                "crestElevation": {
                    "type": "number",
                    "minimum": 0,
                    "description": "Property. The crest elevation of the Spillway. Required only for 'Broad-Crested', 'Ogee' and 'Sharp-Crested'. Units:'meters'"
                },
                "crestLength": {
                    "type": "number",
                    "minimum": 0,
                    "description": "Property. The length of the Spillway equals to the total length through which water passes. Required only for 'Broad-Crested', 'Ogee' and 'Sharp-Crested'. Units:'meters'"
                },
                "spillwayWidth": {
                    "type": "number",
                    "minimum": 0,
                    "description": "Property. The width of the spillway (m). Only for 'Broad-Crested' type. Units:'meters'"
                },
                "numberAbutments": {
                    "type": "number",
                    "minimum": 0,
                    "description": "Property. The number of abutments of an ogee spillway. Only for 'Ogee' type"
                },
                "apronElevation": {
                    "type": "number",
                    "minimum": 0,
                    "description": "Property. The elevation at the bottom of the ogee spillway structure (P), just upstream of the spillway"
                },
                "apronLength": {
                    "type": "number",
                    "minimum": 0,
                    "description": "Property. The total length of the spillway bottom. Units:'meters'"
                },
                "dischargeCoefficient": {
                    "type": "number",
                    "minimum": 0,
                    "description": "Property. The discharge coefficient for energy losses as water enters, flows and exits the spillway. Units:'m^0.5/s'"
                },
                "designHead": {
                    "type": "number",
                    "minimum": 0,
                    "description": "Property. The total upstream energy head for which the spillway is designed (Ho) for 'Ogee Spillway'. Units:'meters'"
                },
                "designDischarge": {
                    "type": "number",
                    "minimum": 0,
                    "description": "Property. The design discharge (Qo) of the Spillway. Units: 'm^3/s'"
                },
                "designDischargeCoefficient": {
                    "type": "number",
                    "minimum": 0,
                    "description": "Property. The discharge coefficient (Co) for energy losses for the design discharge (Ho)"
                },
                "maxFloodElevation": {
                    "type": "number",
                    "minimum": 0,
                    "description": "Property. The maximum elevation of water that can pass the spillway"
                },
                "waterDischarge": {
                    "type": "number",
                    "minimum": 0,
                    "description": "Property. The discharge over the spillway (Q). Units: 'm^3/s'"
                },
                "controlCrossSection": {
                    "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, indicating the cross section that controls the flow over the Spillway"
                },
                "curveElevationDischarge": {
                    "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 discharge (Q) as a function of water elevation (H)"
                },
                "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 upstream head (H) and spillway geometry. For instance, discharge coefficient as a function of upstream head over spillway width (C-H/L), or C/Co-H/Ho"
                },
                "curveDesignDischargeCoefficient": {
                    "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 design discharge coefficient (Co) as a function of apron Elevation over design upstream head (Co-P/Ho)"
                }
            }
        }
    ],
    "required": [
        "id",
        "location"
    ]
}