Prüfplan#

Der Prüfplan (Validierungsplan) legt fest, welche Anforderungen CityDoctor mit welchen Parametern prüft und welche Objekte in die Prüfung einbezogen werden. Er wird in YAML angegeben und CityDoctor mit dem Parameter -config übergeben (siehe Kommandozeile).

In der grafischen Oberfläche stehen dieselben Einstellungen im Prüfdialog zur Verfügung. Ein Prüfplan kann dort gespeichert und wieder geladen werden; das ist der einfachste Weg, eine gültige Datei zu erzeugen.

Beispiel#

Für die Version 3.12.x und neuere sieht ein Beispiel so aus:

globalParameters:
   numberOfRoundingPlaces: 8
   # in m
   minVertexDistance: 0.0001
   schematronPath: 'checkForSolid.xml' # (1)!
useStreaming: true # (2)!
xmlValidation: false # (3)!
filter: # (4)!
   exclude:
      types:
         - VEGETATION
requirements:
   R_GE_R_TOO_FEW_POINTS:
      enabled: true
   R_GE_R_NOT_CLOSED:
      enabled: true
   R_GE_R_CONSECUTIVE_POINTS_SAME:
      enabled: true
   R_GE_R_SELF_INTERSECTION:
      enabled: true
   R_GE_S_MULTIPLE_CONNECTED_COMPONENTS:
      enabled: true
   R_GE_P_INTERIOR_DISCONNECTED:
      enabled: true
   R_GE_P_INTERSECTING_RINGS:
      enabled: true
   R_GE_P_NON_PLANAR:
      enabled: true
      parameters:
         # one of ("distance", "angle", "both")
         type: distance
         # in m
         distanceTolerance: 0.01
         # in degree
         angleTolerance: 1
   R_GE_P_HOLE_OUTSIDE:
      enabled: true
   R_GE_P_ORIENTATION_RINGS_SAME:
      enabled: true
   R_GE_P_INNER_RINGS_NESTED:
      enabled: true
   R_GE_S_TOO_FEW_POLYGONS:
      enabled: true
   R_GE_S_NOT_CLOSED:
      enabled: true
   R_GE_S_NON_MANIFOLD_EDGE:
      enabled: true
   R_GE_S_POLYGON_WRONG_ORIENTATION:
      enabled: true
   R_GE_S_ALL_POLYGONS_WRONG_ORIENTATION:
      enabled: true
   R_GE_S_NON_MANIFOLD_VERTEX:
      enabled: true
   R_GE_S_SELF_INTERSECTION:
      enabled: true
   R_SE_BS_IS_WALL:
      enabled: false
      parameters:
            lowerAngle: '45'
            upperAngle: '135'
   R_SE_BS_IS_FLOOR:
      enabled: false
   R_SE_BS_GROUND_UNFRAGMENTED:
      enabled: false
   R_SE_BS_IS_GROUND:
      enabled: false
   R_SE_BS_IS_CEILING:
      enabled: false
   R_SE_BS_ROOF_UNFRAGMENTED:
      enabled: false
   R_SE_POLYGON_WITHOUT_SURFACE:
      enabled: false

1. Schematron-Datei zur Prüfung von Attributen. Ein relativer Pfad wird relativ zum Arbeitsverzeichnis von CityDoctor aufgelöst. Existiert die Datei nicht, wird die Schematron-Prüfung mit einer Warnung übersprungen.
2. Der Parameter useStreaming ist ein Schalter, um eine Datei Stück für Stück einzulesen, anstatt erst die komplette Datei zu lesen, bevor die Prüfung stattfindet. Mit dieser Einstellung können auch Dateien > 2 GB ohne große RAM-Anforderungen geprüft werden.
3. Validiert die CityGML-Datei beim Einlesen gegen das XML-Schema.
4. Optional. Schränkt die Prüfung auf bestimmte Objekte ein, siehe Filter.

Aufbau#

Der Prüfplan besteht aus folgenden Einträgen auf oberster Ebene:

Andere Einträge auf oberster Ebene sind nicht zulässig und führen beim Laden der Datei zu einem Fehler. Prüfpläne im Format vor Version 3.12 (mit dem Eintrag checks und Prüf-IDs wie C_GE_R_TOO_FEW_POINTS) werden daher nicht mehr akzeptiert.

Globale Parameter#

Anforderungen#

Jede Anforderung wird unter requirements mit ihrer ID aufgeführt und hat folgende Einträge:

Anforderungen, die im Prüfplan nicht vorkommen, werden nicht geprüft. Ein Prüfplan behält dadurch sein Verhalten, wenn in späteren Versionen von CityDoctor neue Anforderungen hinzukommen. Unbekannte Anforderungs-IDs werden mit einer Warnung im Log gemeldet und ignoriert.

Einige Prüfungen hängen von anderen Prüfungen ab (z. B. setzen die Solid-Prüfungen gültige Polygone voraus). Solche Prüfungen werden automatisch ausgeführt, wenn eine aktivierte Anforderung sie benötigt.

Geometrische Anforderungen#

Die Anforderungen sind unter Geometrische Anforderungen im Detail beschrieben.

Bei R_GE_P_NON_PLANAR wählt der Parameter type das Prüfverfahren:

• distance: Der Abstand jedes Punktes zur Regressionsebene des Polygons darf distanceTolerance nicht überschreiten,
• angle: Das Polygon wird trianguliert; die Normale jedes Dreiecks darf um nicht mehr als angleTolerance von der mittleren Normale abweichen,
• both: Beide Prüfungen werden durchgeführt.

Semantische Anforderungen#

Die Anforderungen sind unter Semantische Anforderungen beschrieben. In der grafischen Oberfläche sind sie standardmäßig deaktiviert.

Filter#

Mit dem optionalen Eintrag filter können Objekte in die Prüfung eingeschlossen oder von ihr ausgeschlossen werden. Filter wirken auf Top-Level-Features (z. B. Gebäude, Brücken); herausgefilterte Objekte werden nicht geprüft.

filter:
   include:
      types:
         - BUILDING
         - BRIDGE
      ids:
         - DEBW_0010001aBcD
   exclude:
      ids:
         - DEBW_0010001xYz
         - 'UUID_.*'

Die Filter werden wie folgt ausgewertet:

1. Enthält include mindestens einen Eintrag, wird ein Objekt nur geprüft, wenn es mindestens einem der aufgeführten Typen oder einer der IDs entspricht. Ohne include werden alle Objekte geprüft.
2. Ein Objekt, das einem Eintrag unter exclude entspricht, wird nicht geprüft, auch wenn es unter include eingeschlossen ist.

Verfügbare Feature-Typen:

Die Einträge unter ids sind reguläre Ausdrücke (Java-Syntax), die auf die vollständige GML-ID des Objekts passen müssen; Groß- und Kleinschreibung wird nicht unterschieden. Beispiele:

Standardkonfiguration#

Wird auf der Kommandozeile kein Prüfplan angegeben, verwendet CityDoctor eine Standardkonfiguration, in der alle Anforderungen mit ihren Standardparametern aktiviert sind. Details sind unter Kommandozeile beschrieben.