Määritykset

Toiminnon määritykset on tallennettu tiedostoon IntegrityChecks.xml. Asetustiedosto määritetään ympäristömuuttujalla INTEGRITYCHECK_SETTINGS_FILE.

Tiedosto on jaettu ryhmiin (IntegrityChecksGroup), joita on oletusarvoisesti 2: Tarkistukset ja Korjaukset. Kunkin ryhmän alla on useita tarkastuksia (IntegrityCheck).

Yksittäinen tarkistus (Integrity) sisältää päätasolla seuraavat määritykset:

name:

Tarkistuksen yksilöllinen nimi, jolla siihen viitataan mm. näppäilykomennossa

description :

Kuvaus, joka näkyy käyttöliittymässä

toolTip :

Vihje, joka näytetään kun käyttäjä laittaa kursorin tarkistuksen päälle käyttöliittymässä

readFeaturesToMemory (true/false):

Luetaanko kohteet ensin muistiin. Parantaa suoritusykyä, mutta lisää muistin käyttöä. Isommilla aineistoilla voi johtaa muistin loppumiseen

type :

Ei pakollinen määritys. Jos arvona on ”Keyin”, kyseessä on tarkistus, joka käynnistyy näppäilykomentona. Tällöin tulee olla määritettynä myös parametri KeyinCommand, jonka arvoksi tulee tarkistuksen näppäilykomento.

confirm:

Ei pakollinen. Arvo voi olla true/false. Jos arvo on true, kysytään käyttäjältä varmistus ennen kuin tarkistus suoritetaan. Muutoin varmistusta ei kysytä.

Jos tarkistuksen (Integrity) tyyppi ei ole ”Keyin”, voi sen sisällä on erilaisia lohkoja

Parameters

Parameters-lohko sisältää tarkistuksen parametrit. Parametreja voi olla 0 – n kpl. Esim.

name:

Parametrin yksilöllinen nimi yksittäisen tarkistuksen sisällä

description:

Parametrin kuvaus, joka näkyy käyttöliittymässä

toolTip:

Ei pakollinen. Vihje, joka näytetään kun käyttäjä laittaa kursorin parametrin päälle käyttöliittymässä

FeatureSets

FeatureSets-lohkossa määritellään mitä kohdejoukkoja käsitellään. Kohdejoukkoja voi olla 0 – n kpl. Kohteiden nimissä voi käyttää *-merkkiä korvaamaan useampaa kirjainta ja ?-merkkiä korvaamaan yhtä kirjainta.

Esim:

Esimerkissä kohdejoukkoja on 2, Rajat ja Rajamerkit. Kummallekin kohdejoukolle on määritetty käsiteltävät kohteet.

Actions

Actions-lohkossa määritellään 0 – n kpl toimintoja. Esim. :

Actions-lohkolla on määritykset:

featureSet:

Kohdejoukon nimi. Kohdejoukkoon kuuluvat kohteet käsitellään

allowScanRef:

Määrittää etsitäänkö kohteita referenssitiedostoista. Arvo voi olla true/false (isoilla ja pienillä kirjaimilla ei merkitystä). Määritys ei ole pakollinen. Jos määritys puuttuu, käytetään oletusarvoa false.

Action-lohkossa määritetään toiminnon tyyppi (type). Tällä hetkellä vain CExpression-tyyppi on tuettu. Lisäksi määritellään toimintoon kuuluvat funktiot:

StartFunction:

Toiminnon aloitusfunktio

CheckFunction:

Tarkistusfunktio, jossa määrityksenä featureSet ja allowScanRef

EndFunction:

Lopetusfunktio, jota kutsutaan lopuksi