3. Skriptbibliothek UTIL.LIB

3.1. Allgemeines

In der Skriptbibliothek UTIL sind diverse Hilfprozeduren definiert, welche in einer ICS Konfiguration benutzt werden können (z.B. Prozeduren für die Parameterübernahme in Benutzerprozeduren, Umrechnungsfunktionen für Winkel, Formatierungsprozeduren für Datum und Zeit, Hilfsprozeduren für SQL-Strings, etc.). Die Bibliothek wird mit:

|INCL \script\util.lib

in einer ICS Konfiguration verfügbar gemacht.

3.2. Exportierte Prozeduren

ProzedurGRADS_TO_DEGREES ! [r gon][r degree]
BeschreibungRechnet Neugrad (400 Gon) in Altgrad (360 Grad) um.
Beispiel
0.0 GRADS_TO_DEGREES ! [90.0]
ProzedurDEGREES_TO_GRADS ! [r degree][r gon]
BeschreibungRechnet Altgrad (360 Grad) in Neugrad (400 Gon) um.
Beispiel
0.0 DEGREES_TO_GRADS ! [100.0]
ProzedurCOPY ! [o obj][o obj]
BeschreibungErsetzt das oberste Element des Stacks durch eine exakte Kopie.
Beispiel
'hello, world' COPY ! ['hello, world']
ProzedurNEXT_OBJID ! [][s objid]
BeschreibungErzeugt eine eindeutige OBJID.
Beispiel
NEXT_OBJID ! ['4398']
ProzedurLAST_OBJID ! [][s objid]
BeschreibungGibt die letzte mit NEXT_OBJID erzeugte OBJID zurück.
Beispiel
LAST_OBJID ! ['4398']
ProzedurDISPLAY_OBJECT1 ! o object
BeschreibungGibt <objekt> in der Logdatei aus. DISPLAY_OBJECT1 kann in einer Abbildungsvorschrift der INOUT Map verwendet werden.
Beispiel
MAP INOUT
   I1 => DISPLAY_OBJECT1,IN
END_MAP
ProzedurSQL_STRING ! [s string][s sql_string]
BeschreibungWandelt den <string> in einen SQL-String um, d.h. der String wird zwischen Anführungszeichen gesetzt.
Beispiel
'hello, world' SQL_STRING ! [''hello, world'']
ProzedurGET_PARAM ! [][o object]
BeschreibungÜbernimmt einen Parameter mit beliebigem Typ in einer RUN1 Benutzerprozedur. GET_PARAM soll nur angewendet werden, wenn die Benutzerprozedur auch verschiedene Typen verarbeiten soll. Z.B. ist es sinnvoll, dass eine Anzeigeprozedur beliebige Datentypen anzeigen kann. Sonst sollen aber typspezifische Paramterprozeduren benutzt werden (z.B. GET_SPARAM für die übernahme eines String Paramters).
Beispiel
PROCEDURE MyDisplayProcedure1 ! message
   GET_PARAM DISPLAY $
END_PROCEDURE
ProzedurGET_SPARAM ! [][s string]
BeschreibungÜbernimmt einen Parameter vom Typ String in einer RUN1 Benutzerprozedur. Falls der Parameter nicht vom Typ String ist, wird die Konfiguration abgebrochen.
Beispiel
PROCEDURE MyStringProcedure1 ! string
   GET_SPARAM => OUT.Text
   ! ...
   ILOUT_WRITE_OBJECT
END_PROCEDURE
ProzedurGET_IPARAM ! [][i integer]
BeschreibungÜbernimmt einen Parameter vom Typ Integer in einer RUN1 Benutzerprozedur. Falls der Parameter nicht vom Typ Integer ist, wird die Konfiguration abgebrochen.
Beispiel
PROCEDURE MyIntegerProcedure1 ! integer
   GET_IPARAM => OUT.Count
   ! ...
   ILOUT_WRITE_OBJECT
END_PROCEDURE
ProzedurGET_RPARAM ! [][r real]
BeschreibungÜbernimmt einen Parameter vom Typ Real in einer RUN1 Benutzerprozedur. Falls der Parameter nicht vom Typ Real ist, wird die Konfiguration abgebrochen.
Beispiel
PROCEDURE MyRealProcedure1 ! real
   GET_RPARAM => OUT.Area
   ! ...
   ILOUT_WRITE_OBJECT
END_PROCEDURE
ProzedurGET_PPARAM ! [][p point]
BeschreibungÜbernimmt einen Parameter vom Typ Point in einer RUN1 Benutzerprozedur. Falls der Parameter nicht vom Typ Point ist, wird die Konfiguration abgebrochen.
Beispiel
PROCEDURE MyPointProcedure1 ! point
   GET_PPARAM => OUT.Geometry
   ! ...
   ILOUT_WRITE_OBJECT
END_PROCEDURE
ProzedurGET_LPARAM ! [][l line]
BeschreibungÜbernimmt einen Parameter vom Typ Line in einer RUN1 Benutzerprozedur. Falls der Parameter nicht vom Typ Line ist, wird die Konfiguration abgebrochen.
Beispiel
PROCEDURE MyLineProcedure1 ! line
   GET_LPARAM => OUT.Geometry
   ! ...
   ILOUT_WRITE_OBJECT
END_PROCEDURE
ProzedurGET_APARAM ! [][a area]
BeschreibungÜbernimmt einen Parameter vom Typ Area in einer RUN1 Benutzerprozedur. Falls der Parameter nicht vom Typ Area ist, wird die Konfiguration abgebrochen.
Beispiel
PROCEDURE MyLineProcedure1 ! area
   GET_APARAM => OUT.Geometry
   ! ...
   ILOUT_WRITE_OBJECT
END_PROCEDURE