5.2. Format pliku IPK

Plik konfiguracyjny IPK jest pojedynczym dokumentem XML 1.0, zgodnym ze schematem RelaxNG umieszczonym w pliku resources/dtd/ipk-params.rng (lokalizacja pliku względem głównego katalogu SZARP), używającym przestrzeni nazw o identyfikatorze http://www.praterm.com.pl/SZARP/ipk. Więcej informacji można znaleźć:

Wspomniany schemat RelaxNG zawiera szczegółowy opis składni IPK, w tym poszczególnych elementów i atrybutów, ich dopuszczalnych wartości. Plik ten jest źródłem informacji nadrzędnym w stosunku do tej dokumentacji i odzwierciedla stan aktualny, który może być różny od opisanego w tej dokumentacji w przypadku opóźnień w uzupełnianiu dokumentacji.

5.2.1. Struktura pliku

Struktura pliku odpowiada fizycznej strukturze systemu, w szczególności zawiera dane o parametrach w takiej kolejności, w jakiej przychodzą one ze sterowników (wynika to właściwie ze sposobu działania programu parcook). Dane z poszczególnych sterowników są pogrupowane. Oddzielnie zgrupowane są parametry definiowalne przeglądającego oraz parametry definiowalne parcooka, które nie są redefinicjami istniejących fizycznie parametrów. Ogólna struktura wygląda więc następująco:

<params>
    <device>
       Opis parametrów ze sterownika 1
       ...
    </device>
    <device>
       Opis parametrów ze sterownika 2
       ...
    </device>
    ....
    <defined>
    	Opis parametrów definiowalnych (parcooka)
	...
    </defined>
    <drawdefinable>
    	Opis parametrów definiowalnych (przeglądającego)
	...
    </drawdefinable>
    <boilers>
    	Opis konfiguracji kotłów dla programu analiza
	...
    </boilers>
</params>

Na początku pliku znajduje się deklaracja XML, może ona także zawierać informację o kodowaniu. Nazwy, atrybuty i zawartości elementów, a także ewentualne komentarze muszą być zapisane w podanym kodowaniu. Jeśli kodowanie nie jest podane, przyjmuje się Unicode (UTF-8 lub UTF-16). W dowolnym miejscu w pliku mogą znajdować się XML-owe komentarze.