Author: fdesbois Date: 2012-09-20 14:45:28 +0200 (Thu, 20 Sep 2012) New Revision: 585 Url: http://forge.codelutin.com/repositories/revision/sammoa/585 Log: fixes #1455 : end model doc Modified: trunk/src/site/rst/model.rst Modified: trunk/src/site/rst/model.rst =================================================================== --- trunk/src/site/rst/model.rst 2012-09-18 17:04:54 UTC (rev 584) +++ trunk/src/site/rst/model.rst 2012-09-20 12:45:28 UTC (rev 585) @@ -310,7 +310,8 @@ *<<entity>>* Observateur participant à une campagne et positionné sur le plan de vol à une -position dans l'avion. +position dans l'avion. Voir `importer les observateurs +<import-export.html#bservateurs-csv>`_ . +----------------------+----------------------------------+--------------------+----------------+ | Nom | Description | Type | Contraintes | @@ -450,6 +451,107 @@ coordonnées géographiques. A chaque changement de conditions d'observations, un nouveau parcours est créé. ++----------------------+----------------------------------+--------------------+----------------+ +| Nom | Description | Type | Contraintes | ++======================+==================================+====================+================+ +| beginTime | Temps auquel a été commencé | Date | required | +| | le parcours | (seconds) | | ++----------------------+----------------------------------+--------------------+----------------+ +| effortNumber | Numéro d'effort (pour un LEG | Integer | | +| | uniquement) incrémenté par | | | +| | rapport au vol | | | ++----------------------+----------------------------------+--------------------+----------------+ +| distance | ?? | double | | ++----------------------+----------------------------------+--------------------+----------------+ +| seaState | Code pour l'état de la mer | int | min = 0 | +| | selon l'échelle de Beaufort | | max = 5 | ++----------------------+----------------------------------+--------------------+----------------+ +| swell | Houle (0 pas de houle < 2 houle | int | min = 0 | +| | gênante) | | max = 2 | ++----------------------+----------------------------------+--------------------+----------------+ +| turbidity | Turbidité/transparence de l'eau | int | values = [0,1, | +| | (0 eau claire < 2 eau turbide, | | 2,9] | +| | 9 turbidité inconnue) | | | ++----------------------+----------------------------------+--------------------+----------------+ +| cloudCover | Couverture nuaugeuse défini par | int | min = 0 | +| | le système des octats (0 pour | | max = 8 | +| | dégagé < 8 pour complètement | | | +| | couvert) | | | ++----------------------+----------------------------------+--------------------+----------------+ +| skyGlint | Réflexion des nuages | int | min = 0 | ++----------------------+----------------------------------+--------------------+----------------+ +| glareFrom | Début de la zone d'éblouissement | Integer | min = 0 | +| | en degré (le nez de l'avion 0°) | | max = 360 | ++----------------------+----------------------------------+--------------------+----------------+ +| glareTo | Fin de la zone d'éblouissement | Integer | min = 0 | +| | en degré (le nez de l'avion 0°) | | max = 360 | ++----------------------+----------------------------------+--------------------+----------------+ +| glareUnder | Eblouissement sous l'avion | boolean | | ++----------------------+----------------------------------+--------------------+----------------+ +| glareSeverity | Intensité d'éblouissement (0 | int | min = 0 | +| | aucun éblouissement < 3 | | max = 3 | +| | éblouissement fort) | | | ++----------------------+----------------------------------+--------------------+----------------+ +| subjectiveConditions | Détectabilité. Estimation des | String | regex = | +| | observateurs en fonction des | | "$[EGMP]{2}^" | +| | autres paramètres si les | | | +| | conditions sont bonnes ou non. | | | +| | Il s'agit de deux lettres, une | | | +| | pour le côté gauche et une pour | | | +| | le côté droit. | | | +| | (E excellentes, G bonnes, M | | | +| | moyennes et P pauvres). | | | ++----------------------+----------------------------------+--------------------+----------------+ +| unexpectedRight | Commentaire sur les observations | String | | +| | à droite. Généralement utilisé | | | +| | pour compter le nombre d'exocet | | | +| | ou de méduse. | | | ++----------------------+----------------------------------+--------------------+----------------+ +| unexpectedLeft | Commentaire sur les observations | String | | +| | à gauche. Généralement utilisé | | | +| | pour compter le nombre d'exocet | | | +| | ou de méduse. | | | ++----------------------+----------------------------------+--------------------+----------------+ +| comment | Commentaires sur le parcours | String | | ++----------------------+----------------------------------+--------------------+----------------+ +| valid | Indique si le parcours a été | boolean | | +| | validé ou non | | | ++----------------------+----------------------------------+--------------------+----------------+ +| deleted | Indique si le parcours a été | boolean | | +| | marque comme supprimé ou non | | | ++----------------------+----------------------------------+--------------------+----------------+ +| flight | Vol auquel est rattaché ce | Flight_ | required | +| | parcours | | | ++----------------------+----------------------------------+--------------------+----------------+ +| routeType | Type de parcours | RouteType_ | required | ++----------------------+----------------------------------+--------------------+----------------+ +| transectFlight | Transect référence sur lequel | TransectFlight_ | | +| | est effectué l'effort d' | | | +| | observation pour un parcours de | | | +| | type LEG | | | ++----------------------+----------------------------------+--------------------+----------------+ +| circleBackCause | Observation source pour un | Observation_ | | +| | parcours de type CIRCLE_BACK | | | ++----------------------+----------------------------------+--------------------+----------------+ +| observerPosition | Ensemble des positions des | Collection of | | +| | observateurs sur ce parcours. | ObserverPosition_ | | +| | Le premier LEG sur un transect | | | +| | débutera avec le prévisionnel | | | +| | des positions d'observateur | | | +| | depuis un TransectFlight_ | | | +| | Il peut y avoir une position | | | +| | sans observateur. Le nombre de | | | +| | position est conditionné par le | | | +| | type de plate-forme de l'avion. | | | ++----------------------+----------------------------------+--------------------+----------------+ + +Autres règles de validation : + +- Il ne peut y avoir deux parcours à la suite avec le même type pour la même heure +- Il ne peut y avoir deux parcours à la suite avec le même type et les même conditions d'observations + (seaState, swell, turbidity, cloudCover, skyGlint, glareFrom, glareTo, glareUnder, + glareSeverity, subjectiveConditions, observerPosition) + RouteType --------- @@ -493,22 +595,86 @@ *<<entity>>* -Secteur géographique sur lequel l'effort est effectué. +Secteur géographique sur lequel l'effort est effectué. Voir `importer les strates +<import-export.html#fichier-de-strate-dbf>`_ . ++----------------------+----------------------------------+--------------------+----------------+ +| Nom | Description | Type | Contraintes | ++======================+==================================+====================+================+ +| sectorNumber | Numéro de secteur | int | naturalId | ++----------------------+----------------------------------+--------------------+----------------+ +| campaign | Campagne rattachée à ce secteur | Campaign_ | naturalId | ++----------------------+----------------------------------+--------------------+----------------+ +| name | Nom du secteur | String | | ++----------------------+----------------------------------+--------------------+----------------+ +| localCreation | Indique si la création de | boolean | | +| | l'entité a été faites depuis | | | +| | l'interface de l'application | | | +| | (différent d'un import) | | | ++----------------------+----------------------------------+--------------------+----------------+ + Species ------- *<<entity>>* -Espèce observée. +Espèce observée. Voir `importer les espèces +<import-export.html#especes-csv>`_ . ++----------------------+----------------------------------+--------------------+----------------+ +| Nom | Description | Type | Contraintes | ++======================+==================================+====================+================+ +| code | Code de l'espèce | String | naturalId | ++----------------------+----------------------------------+--------------------+----------------+ +| region | Région rattachée à cette espèce | Region_ | naturalId | ++----------------------+----------------------------------+--------------------+----------------+ +| commonName | Nom commun de l'espèce | String | | ++----------------------+----------------------------------+--------------------+----------------+ +| latinName | Nom scientifique de l'espèce | String | | ++----------------------+----------------------------------+--------------------+----------------+ +| groupName | Nom du group auquel appartient | String | | +| | cette espèce | | | ++----------------------+----------------------------------+--------------------+----------------+ +| family | Famille de l'espèce | String | | ++----------------------+----------------------------------+--------------------+----------------+ +| type | Type d'espèce | String | | ++----------------------+----------------------------------+--------------------+----------------+ +| localCreation | Indique si la création de | boolean | | +| | l'entité a été faites depuis | | | +| | l'interface de l'application | | | +| | (différent d'un import) | | | ++----------------------+----------------------------------+--------------------+----------------+ + Strate ------ *<<entity>>* -Strate géographique sur laquelle l'effort est effectué. +Strate géographique sur laquelle l'effort est effectué. Voir `importer les strates +<import-export.html#fichier-de-strate-dbf>`_ . ++----------------------+----------------------------------+--------------------+----------------+ +| Nom | Description | Type | Contraintes | ++======================+==================================+====================+================+ +| sector | Secteur rattachée à cette strate | Sector_ | naturalId | ++----------------------+----------------------------------+--------------------+----------------+ +| strateType | Type de strate | StrateType_ | naturalId | ++----------------------+----------------------------------+--------------------+----------------+ +| code | Code de la strate. | String | | +| | Utilisation du numéro de secteur | | | +| | et du code du type de strate. | | | +| | Ex: sectorNumber = 1, | | | +| | strateTypeCode = 'C' => | | | +| | code = "C1" | | | ++----------------------+----------------------------------+--------------------+----------------+ +| name | Nom usuel de la strate | String | | ++----------------------+----------------------------------+--------------------+----------------+ +| localCreation | Indique si la création de | boolean | | +| | l'entité a été faites depuis | | | +| | l'interface de l'application | | | +| | (différent d'un import) | | | ++----------------------+----------------------------------+--------------------+----------------+ + StrateType ---------- @@ -516,13 +682,89 @@ Type de strate possible (côtière, pente, néritique, océanique). ++----------------------+----------------------------------+ +| Valeur | Description | ++======================+==================================+ +| COAST | Côtière. code = 'C' | ++----------------------+----------------------------------+ +| NERITIC | Néritique. code = 'N' | ++----------------------+----------------------------------+ +| SLOPE | Pente. code = 'P' | ++----------------------+----------------------------------+ +| OCEANIC | Océanique. code = 'O' | ++----------------------+----------------------------------+ + Transect -------- *<<entity>>* Segment géographique sur lequel doit être effectué l'effort d'observation. +Voir `importer les transects +<import-export.html#fichier-de-transect-dbf>`_ . ++----------------------+----------------------------------+--------------------+----------------+ +| Nom | Description | Type | Contraintes | ++======================+==================================+====================+================+ +| name | Nom du transect. | String | naturalId | +| | Utilisation du code de la strate | | | +| | et d'un numéro incrémenté sur | | | +| | deux chiffres. | | | | +| | strate. Ex: strateCode = "C1" | | | +| | => name = "C1/01" ou "C1/24" | | | ++----------------------+----------------------------------+--------------------+----------------+ +| strate | Strate sur laquelle se situe ce | Strate_ | naturalId | +| | transect | | | ++----------------------+----------------------------------+--------------------+----------------+ +| length | Longueur du transect en mètres | Double | | ++----------------------+----------------------------------+--------------------+----------------+ +| startX | Coordonnée géographique X du | Double | | +| | début du transect | | | ++----------------------+----------------------------------+--------------------+----------------+ +| startY | Coordonnée géographique Y du | Double | | +| | début du transect | | | ++----------------------+----------------------------------+--------------------+----------------+ +| endX | Coordonnée géographique X de | Double | | +| | fin du transect | | | ++----------------------+----------------------------------+--------------------+----------------+ +| endY | Coordonnée géographique Y de | Double | | +| | fin de transect | | | ++----------------------+----------------------------------+--------------------+----------------+ +| localCreation | Indique si la création de | boolean | | +| | l'entité a été faites depuis | | | +| | l'interface de l'application | | | +| | (différent d'un import) | | | ++----------------------+----------------------------------+--------------------+----------------+ +| nbTimes | Nombre de fois sur lequel a été | int | | +| | effectué le transect. Ce nombre | | | +| | est incrémenté en fonction du | | | +| | numéro de passage | | | +| | (*crossingNumber*) d'un nouveau | | | +| | TransectFlight_. Le numéro de | | | +| | passage est modifié manuellement | | | +| | par l'utilisateur. Le nombre de | | | +| | TransectFlight_ rattaché à ce | | | +| | transect depuis la base peut | | | +| | être différent, car d'anciens | | | +| | vols ayant un lien avec ce | | | +| | transect ont pu être supprimés | | | +| | de la base. | | | ++----------------------+----------------------------------+--------------------+----------------+ +| graphicIndex | Index de l'objet graphique | Integer | | +| | depuis le fichier SHP importé. | | | +| | Il permet de faire correspondre | | | +| | les méta-données avec sa | | | +| | représentation graphique. Il | | | +| | s'agit en fait de l'index de la | | | +| | ligne de transect dans le | | | +| | fichier DBF importé. | | | +| | Cette propriété peut être vide | | | +| | si aucune correspondance | | | +| | graphique n'est disponible dans | | | +| | le cas d'un nouveau transect | | | +| | créé depuis l'application. | | | ++----------------------+----------------------------------+--------------------+----------------+ + TransectFlight -------------- @@ -531,4 +773,34 @@ Segment géographique prévu (et potentiellement réalisé) pour un vol donné. Chaque parcours de type LEG représentant un effort d'observation est obligatoirement associé à un transect du plan de vol. L'ensemble de ces -segments représente un plan de vol avec une numérotation représentant l'ordre. \ No newline at end of file +segments représente un plan de vol avec une numérotation représentant l'ordre. + ++----------------------+----------------------------------+--------------------+----------------+ +| Nom | Description | Type | Contraintes | ++======================+==================================+====================+================+ +| transect | Numéro d'observation incrémenté | Transect_ | required | +| | par rapport au vol | | | ++----------------------+----------------------------------+--------------------+----------------+ +| crossingNumber | Numéro de passage sur le | int | | +| | transect. Incrémentée depuis | | | +| | le nombre de fois sur le | | | +| | transect (*nbTimes*) où modifié | | | +| | manuellement. Dans ce cas, le | | | +| | nombre de fois du transect est | | | +| | mis à jour pour le prochain | | | +| | incrément | | | ++----------------------+----------------------------------+--------------------+----------------+ +| valid | Indique si le transect a été | boolean | | +| | validé ou non | | | ++----------------------+----------------------------------+--------------------+----------------+ +| deleted | Indique si le transect a été | boolean | | +| | marqué comme supprimé ou non | | | ++----------------------+----------------------------------+--------------------+----------------+ +| observerPosition | Ensemble des positions des | Collection of | | +| | observateurs prévues pour ce | ObserverPosition_ | | +| | transect. | | | +| | Il peut y avoir une position | | | +| | sans observateur. Le nombre de | | | +| | position est conditionné par le | | | +| | type de plate-forme de l'avion. | | | ++----------------------+----------------------------------+--------------------+----------------+ \ No newline at end of file