Variablen
Auf die nachfolgend aufgeführten Variablen kann nach dem Aufruf von ptInit() lesend(!) zugegriffen werden. Die Variableninhalte dürfen nicht geändert werden da diese von vielen Funktionen der PTraffic-Bibliothek benutzt werden.
In den meisten Fällen ist es nicht nötig und auch nicht sinnvoll auf die Variablen direkt zuzugreifen, da entsprechende Funktionen existieren. Die Wahrschinlichkeit dass sich Variablen in späteren Versionen ändern ist wesentlich größer als dass sich entsprechende Funktionen ändern. Außerdem besteht die Gefahr dass man aus Versehen den Inhalt einer Variable überschreibt und dadurch Fehler entstehen.
Die Inhalte der meisten Variablen für das Beispielprojekt "Musterdorf" können beim Test der Funktion ptInit unter Funktionen_Allgemein_ptInit.htm eingesehen werden.
actLanguage
Typ: string
Die Variable actLanguage enthält das 3-stelliges Kürzel der aktuell eingestellten Sprache. Aktuell werden die Sprachen Deutsch und Englisch unterstützt. Die entsprechenden Kürzel lauten "ger" und "eng".Weitere Sprachen können durch Anpassung der Datei "ptraffic_text.js" hinzugefügt werden.
Statt direkt auf actLanguage zuzugreifen kann die Funktion getLanguage() genutzt werden.
stations[]
Typ: Array von Objekten
In stations sind alle Stationen in alphabetischer Reihenfolge enthalten. Ein Element des Arrays enthält ein Objekt mit den Eigenschaften "ID" und "Station". Mit stations[0].ID wird beispielsweise auf die ID des ersten Elements zugegriffen, Mit stations[3].Station auf den Namen der vierten Station.
Um auf Stationen zuzugreifen können die Funktionen getStationID und getStationName verwendet werden.
stationsByIdArray[]
Typ: Array
Das Array stationsByIdArray enthält für alle Station-ID's den zugehörigen Index des Arrays stations[]. Dabei ist zu beachten dass die niedrigste Station-ID nicht 0 sondern 1 ist. Außerdem kann es vorkommen dass Station-IDs nicht fortlaufend vorhanden sind. Dies ist der Fall wenn nachträglich Stationen gelöscht wurden. Daher ist es nicht ohne weiteres möglich mit einer Schleife alle Elemente des Arrays zu durchlaufen.
Beispiel: Mit stationsByIdArray[4] erhalten wir den Index der Stations-ID 4 des Arrays stations[]. Steht in stationsByIdArray[4] z. B. der Wert 7 können wir mit stations[7].Station auf den Namen der Station zugreifen.
Um über die Station-ID auf den Stationsnamen zuzugreifen kann die Funktion getStationName verwendet werden.
stationsByNameArray[]
Typ: Array
Das Array stationsByNameArray enthält für alle Stations-Namen in alphabetischer Reihenfolge den zugehörigen Index des Arrays stations[].
Beispiel: Mit stationsByNameArray["Hauptbahnhof"] erhalten wir den Index der Station im Array stations[]. Liefert stationsByNameArray["Hauptbahnhof"] z. B. der Wert 7 können wir mit stations[7].ID auf die Station-ID zugreifen.
Um über den Stationsnamen auf die Station-ID zuzugreifen kann die Funktion getStationId verwendet werden.
lines[]
Typ: Array von Objekten
In lines sind alle Linien in alphabetischer Reihenfolge enthalten. Ein Element des Arrays enthält ein Objekt mit den Eigenschaften "ID" und "Line". Mit lines[0].ID wird beispielsweise auf die ID des ersten Elements zugegriffen, Mit lines[3].Line auf den Namen der vierten Linie.
Um auf Linien zuzugreifen können die Funktionen getLineID und getLineName verwendet werden.
linesByIdArray[]
Typ: Array
Das Array linesByIdArray enthält für alle Line-ID's den zugehörigen Index des Arrays lines[]. Dabei ist zu beachten dass die niedrigste Line-ID nicht 0 sondern 1 ist. Außerdem kann es vorkommen dass Line-IDs nicht fortlaufend vorhanden sind. Dies ist der Fall wenn nachträglich Linien gelöscht wurden. Daher ist es nicht ohne weiteres möglich mit einer Schleife alle Elemente des Arrays zu durchlaufen.
Beispiel: Mit linesByIdArray[4] erhalten wir den Index der Line-ID 4 des Arrays lines[]. Steht in linesByIdArray[4] z. B. der Wert 7 können wir mit lines[7].Line auf den Namen der Linie zugreifen.
Um über die Line-ID auf den Linien-Namen zuzugreifen kann die Funktion getLineName verwendet werden.
linesByNameArray[]
Typ: Array
Das Array linesByNameArray enthält für alle Linien-Namen in alphabetischer Reihenfolge den zugehörigen Index des Arrays lines[].
Beispiel: Mit linesByNameArray["Linie 1"] erhalten wir den Index der Station im Array lines[]. Liefert linesByNameArray["Linie 1"] z. B. der Wert 2 können wir mit lines[2].ID auf die Station-ID zugreifen.
Um über den Linien-Name auf die Linien-ID zuzugreifen kann die Funktion getLineId verwendet werden.
lineStations[]
Typ: Array von Objekten
In lineStations werden alle Linienverläufe gespeichert. Dazu enthält das Array Objekte mit den Feldern LineID, Position und StationID. In dieser Reihenfolge ist das Array auch sortiert. Das Feld Position bezeichnet die Position der Station innerhalb der Linie. Wenn im Programm bei einer Linie eine Station 2mal hintereinander angegeben wurde (für Ankunft und Abfahrt) wird dies auch in linestations übernommen.
Statt direkt auf lineStations[] zuzugreifen können folgende Funktionen verwendet werden:
| Funktion | Beschreibung |
|---|---|
| getStationLineIds | Gibt Array mit Linien-ID's der übergebenen Stations-ID zurück. |
| getStationLineNames | Gibt Array mit Linien-Namen der übergebenen Stations-ID zurück. |
| getLineStationIds | Gibt Array mit Station-ID's der übergebenen Linien-ID zurück. |
| getLineStationNames | Gibt Array mit Stations-Namen der übergebenen Linien-ID zurück. |
lineStationsByLineIdArray[][]
Typ: 2-dimensionales Array
Das Array lineStationsByLineIdArray erleichtert den Zugriff auf den Linienverlauf einer bestimmten Linie. Die 1. Dimension enthält die Linien-ID's, die 2. Dimension die Position. Der enthaltene Wert ist der Index des Arrays stations[]. lineStationsByLineIdArray[1][3] liefert beispielsweise den Index der 4. Station der Linie mit der Linien-ID 1 des Array stations[].
Statt direkt auf lineStationsByLineIdArray[] zuzugreifen können folgende Funktionen verwendet werden:
| Funktion | Beschreibung |
|---|---|
| getLineStationIds | Gibt Array mit Station-ID's der übergebenen Linien-ID zurück. |
| getLineStationNames | Gibt Array mit Stations-Namen der übergebenen Linien-ID zurück. |
stationLinesByStationIdArray[][]
Typ: 2-dimensionales Array
Das Array stationLinesByStationIdArray erleichtert den Zugriff auf alle Linien einer bestimmten Station. Die 1. Dimension enthält die Stations-ID's, die 2. Dimension enthält die laufende Nummer beginnend bei 0. Der enthaltene Wert ist der Index des Arrays lines[]. stationLinesByStationIdArray[3][1] liefert beispielsweise den Index der 2. Linie für die Station mit der Station-ID 3.im Array lines[].
Statt direkt auf stationLinesByStationIdArray[] zuzugreifen können folgende Funktionen verwendet werden:
| Funktion | Beschreibung |
|---|---|
| getStationLineIds | Gibt Array mit Linien-ID's der übergebenen Stations-ID zurück. |
| getStationLineNames | Gibt Array mit Linien-Namen der übergebenen Stations-ID zurück. |
dayGroups[]
Typ: Array von Objekten
In dayGroups sind alle Wochentag-Gruppen (Fahrtage) enthalten. Ein Element des Arrays enthält ein Objekt mit folgenden Eigenschaften:
| Name | Bedeutung |
|---|---|
| ID | Eindeutiger Index für Zugriff auf die Tag-Gruppe |
| Group | Name der Wochentag-Gruppe (z. B. "MO-FR") |
| Days | 7-Zeichen-String (ein Zeichen je
Wochentag beginnend bei |
| Text | anzuzeigender Text für die Tag-Gruppe, z. B. "montags - freitags" |
Die Eigenschaften sind äquivalent zur Tabelle daygroups.ptf. Die Sortierung erfolgt nach dem Feld "Days", Mit dayGroups[0].Text wird beispielsweise auf den Text der ersten Wochentag-Gruppe zugegriffen.
Um auf Wochentag-Gruppen zuzugreifen stehen zur Zeit noch keine Funktionen zur Verfügung.
dayGroupsByIdArray[]
Typ: Array
Das Array dayGroupsByIdArray enthält für alle Daygroup-ID's den zugehörigen Index des Arrays dayGroups[]. Dabei ist zu beachten dass die niedrigste Daygroup-ID nicht 0 sondern 1 ist. Außerdem kann es vorkommen dass Daygroup-IDs nicht fortlaufend vorhanden sind. Dies ist der Fall wenn nachträglich Wochentag-Gruppen gelöscht wurden. Daher ist es nicht ohne weiteres möglich mit einer Schleife alle Elemente des Arrays zu durchlaufen.
Beispiel: Mit dayGroupsByIdArray[1] erhalten wir den Index der Daygroup-ID 1 des Arrays dayGroups[]. Steht in dayGroupsByIdArray[1] z. B. der Wert 2 können wir mit dayGroups[2].Text auf den Text für die Wochentag-Gruppe zugreifen.
Um auf Wochentag-Gruppen zuzugreifen stehen zur Zeit noch keine Funktionen zur Verfügung.
lineConnections[]
Typ: Array von Objekten
In lineConnections sind alle vorhandenen Fahrpläne des Projekts eingetragen. Ein Element des Arrays enthält ein Objekt mit folgenden Eigenschaften:
| Name | Bedeutung |
|---|---|
| ID | Lineconnection-ID (eindeutiger Index für Zugriff auf den Fahrplan) |
| LineID | Linien-ID (eindeutiger Index der Linie) |
| DayGroupID | Daygroup-ID (eindeutiger Index der Daygroup) |
| Direction | Richtung (1 oder 2) |
Die Eigenschaften sind äquivalent zur Tabelle line_connections.ptf. Die Sortierung erfolgt nach den Feldern "LineID", "DayGroupID" und "Direction" (in der Reihenfolge). Mit lineConnections[2].Direction wird beispielsweise auf die Richtung des 3. Eintrags des Array lineConnectinos zugegriffen.
Mit der Funktion getLineConnectionId erhält man die LineConnection-ID für die übergebene Linie, Tag-Gruppe und Richtung.
lineConnectionsByIdArray[]
Typ: Array
Das Array lineConnectionsByIdArray ermöglicht den Zugriff mit der LineConnection-ID auf die Felder "LineID", DayGroupID" und "Directions" des Arrays lineConnections[]. Der enthaltene Wert ist der Index des Array lineConnections[]. lineConnectionsByIdArray[3] liefert beispielsweise den Index des Arrays lineConnections mit der LineConnection-ID 3.
Mit der Funktion getLineConnectionId erhält man die LineConnection-ID für die übergebene Linie, Tag-Gruppe und Richtung.
lineConnectionsByLineIdArray[][]
Typ: 2-dimensionales Array
Das Array lineConnectionsByLineIdArray ermöglicht den Zugriff auf alle vorhandenen Fahrpläne einer bestimmten Linie. Die 1. Dimension enthält die Linien-ID's, die 2. Dimension enthält die laufende Nummer beginnend bei 0. Der enthaltene Wert ist der Index des Array lineConnections[].
lineConnectionsByLineIdArray[3][1] liefert beispielsweise den Index des Arrays lineConnections für den 2. vorhandenen Fahrplan für die Linie mit der Linien-ID 3.
Mit der Funktion getLineConnectionId erhält man die LineConnection-ID für die übergebene Linie, Tag-Gruppe und Richtung.
intervals[]
Typ: Array von Objekten
Das Array intervals enthält die Interval-Zeiten für die vorhandenen Fahrpläne. Ein Element des Arrays enthält ein Objekt mit folgenden Eigenschaften:
| Name | Bedeutung |
|---|---|
| ID | Eindeutiger Index für Zugriff auf den Interval-Eintrag. |
| Interval | Interval-Zeit (z. B. „20“ für „fährt alle 20 Minuten“). |
Die Eigenschaften sind äquivalent zur Tabelle intervals.ptf. Die Sortierung erfolgt aufsteigend nach dem Feld "Interval", Mit intervals[0].Intervals wird beispielsweise auf die Intervall-Zeit des ersten Eintrags zugegriffen. Die kleinste mögliche Intervall-ID ist 2 und nicht wie sonst üblich 1.
Um auf die Intervall-Zeit einer bestimmten Intervall-ID zuzugreifen kann die Funktion getInterval genutzt werden.
intervalsByIdArray[]
Typ: Array
Das Array intervalsByIdArray enthält für alle Intervall-ID's den zugehörigen Index des Arrays intervals[]. Dabei ist zu beachten dass die niedrigste Intervall-ID nicht 0 sondern 2 ist. Außerdem kann es vorkommen dass Intervall-IDs nicht fortlaufend vorhanden sind. Dies ist der Fall wenn nachträglich Intervall-Zeiten gelöscht wurden. Daher ist es nicht ohne weiteres möglich mit einer Schleife alle Elemente des Arrays zu durchlaufen.
Beispiel: Mit intervalsByIdArray[4] erhalten wir den Index der Intervall-ID 4 des Arrays intervals[]. Steht in intervalsByIdArray[4] z. B. der Wert 2 können wir mit intervals[2].Interval auf die Intervall-Zeit zugreifen.
Um auf die Intervall-Zeit einer bestimmten Intervall-ID zuzugreifen kann die Funktion getInterval genutzt werden.