Spur Klassenreferenz

Auf den Spuren bewegen sich die Fahrzeuge. Mehr ...

#include <Spur.h>

Zusammengehörigkeiten von Spur:

[Legende]Aufstellung aller Elemente

Öffentliche Methoden
void	abmelden (Fahrzeug *fahrzeug)
	Meldet ein Fahrzeug von der Spur ab --> dieses Fahrzeug faehrt nun auf einer anderen Spur.
void	anmelden (Fahrzeug *fahrzeug)
	Meldet ein Fahrzeug auf der Spur an --> dieses Fahrzeug faehrt nun auf der Spur.
void	clear ()
	Setzt die Spur auf Standardwerte.
int	gibAbbiegerichtung ()
	Gibt die Abbiegerichtung der Spur.
int	gibAnzahlAbgefahrenerFahrzeuge (int typ=0)
	gibt Anzahl der von der Spur abgefahrenen Fahrzeuge zurueck. Die Statistik wird dann wieder auf 0 gesetzt.
int	gibAnzahlFahrzeuge ()
	gibt Anzahl der auf der Spur befindlichen Fahrzeuge zurueck, oder wenn Parameter angegeben wurden, die Anzahl der Fahrzeuge eines Types, die bisher ueber die Spur in eine bestimmte Richtung gefahren sind.
int	gibAusrichtung ()
	Gibt die Ausrichtung einer Spur zurueck.
int	gibEndzustand ()
	gibt den Zustand am Ende der Spur zurueck Gibt zurueck, was am Ende der Spur fuer ein Zustand herrscht. Zum Beispiel Ampel rot (anhalten wegen Hinderniss) oder Ampel gruen (ungehinderte Fahrt).
long int	gibId ()
	Liefert die ID der Spur.
Koordinaten	gibKoordinaten ()
	Gibt die Koordinaten der Spur zurueck.
double	gibLaenge ()
	Liefert die Laenger der Spur.
Fahrzeug *	gibLetztes ()
	Liefert das letzte Fahrzeug in der Spur.
double	gibMaximaleGeschwindigkeit ()
	Liefert die lokale Hoechstgeschwindigkeit auf der Spur.
long int	gibNachfolgerId (int richtung)
	Setzt die ID einer nachfolgender Spur.
Spur *	gibNaechsteSpur (int richtung)
	Gibt die nachfolgende Spur in Richtung richtung.
int	gibRichtung ()
	Gibt die Richtung einer Spur zurueck.
Fahrzeug *	gibVorgaenger (Fahrzeug *fahrzeug)
	Liefert den Vorgaenger eines Fahrzeuges in der Spur zurueck.
double	gibWahrscheinlichkeit (int richtung)
	gibt wahrscheinlichkeit fuer das Befahren der naechsten Spur zurueck Gibt zurueck, wie grosz die Wahrscheinlichkeit ist, dass auf dieser Spur gefahren wird. Existiert die Spur nicht, wird die Wahrscheinlichkeit auf 0 gesetzt.
bool	istGelb ()
	Gibt an, ob die Ampel am Ende der Spur auf Gelb steht.
bool	istGruen ()
	Gibt an, ob die Ampel am Ende der Spur auf Gruen steht.
bool	istRot ()
	Gibt an, ob die Ampel am Ende der Spur auf Rot steht.
bool	istSackgasse ()
	Gibt an, ob die Spur eine Sackgasse ist.
void	setzeAbbiegerichtung (int abbiegerichtung)
	Setzt die Abbiegerichtung der Spur.
void	setzeAusrichtung (int ausrichtung)
	Setzt die Ausrichtung der Spur.
void	setzeGelb ()
	Setzt die Ampel am Ende der Spur auf Gelb.
void	setzeGruen ()
	Setzt die Ampel am Ende der Spur auf Gruen.
void	setzeKoordinaten (Koordinaten koordinaten)
	Setzt die Koordinaten der Spur.
void	setzeNaechstesVerbindungselement (int richtung, long int id, double wahrscheinlichkeit)
	Setzt die ID einer nachfolgender Spur.
void	setzeNaechstesVerbindungselement (Spur *spur, int richtung, double wahrscheinlichkeit)
	knuepft neues Spurenelement am Ende an
void	setzeRichtung (int richtung)
	Setzt die Richtung der Spur.
void	setzeRot ()
	Setzt die Ampel am Ende der Spur auf Rot.
void	setzeSackgasse ()
	Am Ende der Spur schliesst keine weitere Spur an.
	Spur (long int id, double laenge, int maximalGeschwindigkeit)
	ueberladener Konstruktor der Klasse Spur mit Einrichten der Spureigenschaften
	Spur ()
	Default-Konstruktor der Klasse Spur.

---

Ausführliche Beschreibung

Auf den Spuren bewegen sich die Fahrzeuge.

Definiert in Zeile 20 der Datei Spur.h.

---

Beschreibung der Konstruktoren und Destruktoren

Spur::Spur (   )

Default-Konstruktor der Klasse Spur. Autor: Nico Schroeder Definiert in Zeile 17 der Datei Spur.cpp. Benutzt clear().

Spur::Spur (  long int  id, double  laenge, int  maximalGeschwindigkeit )

ueberladener Konstruktor der Klasse Spur mit Einrichten der Spureigenschaften Autor: Nico Schroeder Parameter: id  Die ID der Spur zum besseren wiederfinden laenge  Die Laenge der anzulegenden Spur. maximalGeschwindigkeit  Die maximale Geschwindigkeit, mit der die Fahrzeuge auf der Spur fahren duerfen. Definiert in Zeile 32 der Datei Spur.cpp. Benutzt clear().

---

Dokumentation der Elementfunktionen

void Spur::abmelden (  Fahrzeug *  fahrzeug  )

Meldet ein Fahrzeug von der Spur ab --> dieses Fahrzeug faehrt nun auf einer anderen Spur. Autor: Nico Schroeder Parameter: fahrzeug  Dieses Fahrzeug abmelden Ausnahmebehandlung: Fehler*  Wird das Fahrzeug nicht in der Liste gefunden, wird eine Fehlermeldung generiert. Definiert in Zeile 200 der Datei Spur.cpp. Benutzt ListenDaten::gibId() und Fahrzeug::gibTyp(). Wird benutzt von Fahrzeug::aufraeumen().

void Spur::anmelden (  Fahrzeug *  fahrzeug  )

Meldet ein Fahrzeug auf der Spur an --> dieses Fahrzeug faehrt nun auf der Spur. Autor: Nico Schroeder Parameter: fahrzeug  Dieses Fahrzeug anmelden Ausnahmebehandlung: Fehler*  Falls zu viele Fahrzeuge (>1000) auf der Spur fahren sollen, wird ein Fehler geworfen. Definiert in Zeile 179 der Datei Spur.cpp.

void Spur::clear (   )

Setzt die Spur auf Standardwerte. Autor: Nico Schroeder Definiert in Zeile 336 der Datei Spur.cpp. Wird benutzt von Spur().

int Spur::gibAbbiegerichtung (   )

Gibt die Abbiegerichtung der Spur. Autor: Nico Schroeder Rückgabe: Die Abbiegerichtung der Spur Definiert in Zeile 550 der Datei Spur.cpp. Wird benutzt von GLWireframe::zeichneSpur().

int Spur::gibAnzahlAbgefahrenerFahrzeuge (  int  typ = 0  )

gibt Anzahl der von der Spur abgefahrenen Fahrzeuge zurueck. Die Statistik wird dann wieder auf 0 gesetzt. Autor: Nico Schroeder Parameter: typ  Fahrzeugtyp, welcher interessiert (0 fuer alle Typen) Rückgabe: Anzahl der Fahrzeuge Ausnahmebehandlung: Fehler*  Einen Fehler. Definiert in Zeile 62 der Datei Spur.cpp.

int Spur::gibAnzahlFahrzeuge (   )

gibt Anzahl der auf der Spur befindlichen Fahrzeuge zurueck, oder wenn Parameter angegeben wurden, die Anzahl der Fahrzeuge eines Types, die bisher ueber die Spur in eine bestimmte Richtung gefahren sind. Autor: Nico Schroeder Rückgabe: Anzahl der Fahrzeuge auf der Spur Definiert in Zeile 48 der Datei Spur.cpp.

int Spur::gibAusrichtung (   )

Gibt die Ausrichtung einer Spur zurueck. Autor: Nico Schroeder Rückgabe: Die Ausrichtung als HOR oder VER Definiert in Zeile 502 der Datei Spur.cpp. Wird benutzt von GLWireframe::zeichneFahrzeug(), GLWireframe::zeichneHaltelinie(), GLWireframe::zeichneSpur() und GLWireframe::zeichneSpurverbindung().

int Spur::gibEndzustand (   )

gibt den Zustand am Ende der Spur zurueck Gibt zurueck, was am Ende der Spur fuer ein Zustand herrscht. Zum Beispiel Ampel rot (anhalten wegen Hinderniss) oder Ampel gruen (ungehinderte Fahrt). Autor: Andreas Richter Rückgabe: Gibt den Endzustand als int zurueck. Definiert in Zeile 93 der Datei Spur.cpp. Wird benutzt von istGelb(), istGruen(), istRot(), istSackgasse() und GLWireframe::zeichneHaltelinie().

long int Spur::gibId (   )

Liefert die ID der Spur. Autor: Nico Schroeder Rückgabe: Die ID der Spur. Definiert in Zeile 292 der Datei Spur.cpp. Wird benutzt von Kreuzung::exportieren().

Koordinaten Spur::gibKoordinaten (   )

Gibt die Koordinaten der Spur zurueck. Autor: Nico Schroeder Rückgabe: Die Koordinaten der Spur Definiert in Zeile 478 der Datei Spur.cpp. Wird benutzt von GLWireframe::erzeugeParameter(), GLWireframe::zeichneFahrzeug(), GLWireframe::zeichneHaltelinie(), GLWireframe::zeichneKreuzung(), GLWireframe::zeichneSpur() und GLWireframe::zeichneSpurverbindung().

double Spur::gibLaenge (   )

Liefert die Laenger der Spur. Autor: Nico Schroeder Rückgabe: Die Laenge in m. Definiert in Zeile 240 der Datei Spur.cpp. Wird benutzt von GLWireframe::zeichneHaltelinie(), GLWireframe::zeichneKreuzung(), GLWireframe::zeichneSpur() und GLWireframe::zeichneSpurverbindung().

Fahrzeug * Spur::gibLetztes (   )

Liefert das letzte Fahrzeug in der Spur. Autor: Nico Schroeder Rückgabe: Die ID des Vorgaengers oder 0, wenn fahrzeugId das erste und/oder einzigste Fahrzeug ist. Definiert in Zeile 275 der Datei Spur.cpp.

double Spur::gibMaximaleGeschwindigkeit (   )

Liefert die lokale Hoechstgeschwindigkeit auf der Spur. Autor: Nico Schroeder Rückgabe: Die maximale Geschwindigkeit. Definiert in Zeile 325 der Datei Spur.cpp. Wird benutzt von Fahrzeug::fahren().

long int Spur::gibNachfolgerId (  int  richtung  )

Setzt die ID einer nachfolgender Spur. Autor: Nico Schroeder Rückgabe: Die gewuenschte ID Ausnahmebehandlung: Fehler*  Soll eine ID fuer eine nicht existente Richtung gesetzt werden, wird ein Fehler geworfen. Definiert in Zeile 583 der Datei Spur.cpp. Wird benutzt von SzenarioParser::parseXml().

Spur * Spur::gibNaechsteSpur (  int  richtung  )

Gibt die nachfolgende Spur in Richtung richtung. Autor: Nico Schroeder Parameter: richtung  Die gewuenschte Spurrichtung. Ausnahmebehandlung: Fehler*  Ist der Parameter ausserhalb der zulaessigen Grenzen, wird ein Fehler geworfen. Definiert in Zeile 306 der Datei Spur.cpp.

int Spur::gibRichtung (   )

Gibt die Richtung einer Spur zurueck. Autor: Nico Schroeder Rückgabe: Die Ausrichtung als RTOL, LTOR, DOWN oder UP Definiert in Zeile 526 der Datei Spur.cpp. Wird benutzt von GLWireframe::zeichneFahrzeug(), GLWireframe::zeichneHaltelinie(), GLWireframe::zeichneSpur() und GLWireframe::zeichneSpurverbindung().

Fahrzeug * Spur::gibVorgaenger (  Fahrzeug *  fahrzeug  )

Liefert den Vorgaenger eines Fahrzeuges in der Spur zurueck. Autor: Nico Schroeder Parameter: fahrzeug  Das Fahrzeuges, fuer welches die Ueberpruefung erfolgen soll. Rückgabe: Der Vorgaenger oder 0, wenn fahrzeug das erste und/oder einzigste Fahrzeug in der Spur ist. Definiert in Zeile 253 der Datei Spur.cpp. Benutzt ListenDaten::gibId().

double Spur::gibWahrscheinlichkeit (  int  richtung  )

gibt wahrscheinlichkeit fuer das Befahren der naechsten Spur zurueck Gibt zurueck, wie grosz die Wahrscheinlichkeit ist, dass auf dieser Spur gefahren wird. Existiert die Spur nicht, wird die Wahrscheinlichkeit auf 0 gesetzt. Autor: Nico Schroeder Parameter: richtung  Flag fuer gewuenschte Richtung Rückgabe: Liefert die Wahrscheinlichkeit zurueck, mit der auf der nszchsten Spur gefahren wird Ausnahmebehandlung: Fehler*  Existiert eine Richtung nicht, wird ein Fehler geworfen. Definiert in Zeile 158 der Datei Spur.cpp. Wird benutzt von SzenarioParser::parseXml().

bool Spur::istGelb (   )

Gibt an, ob die Ampel am Ende der Spur auf Gelb steht. Autor: Nico Schroeder Rückgabe: Wahr, wenn Ampel Gelb ist, sonst Falsch. Definiert in Zeile 431 der Datei Spur.cpp. Benutzt gibEndzustand(). Wird benutzt von Fahrzeug::fahren().

bool Spur::istGruen (   )

Gibt an, ob die Ampel am Ende der Spur auf Gruen steht. Autor: Nico Schroeder Rückgabe: Wahr, wenn Ampel Gruen ist, sonst Falsch. Definiert in Zeile 415 der Datei Spur.cpp. Benutzt gibEndzustand(). Wird benutzt von Fahrzeug::fahren().

bool Spur::istRot (   )

Gibt an, ob die Ampel am Ende der Spur auf Rot steht. Autor: Nico Schroeder Rückgabe: Wahr, wenn Ampel Rot ist, sonst Falsch. Definiert in Zeile 447 der Datei Spur.cpp. Benutzt gibEndzustand(). Wird benutzt von Fahrzeug::fahren().

bool Spur::istSackgasse (   )

Gibt an, ob die Spur eine Sackgasse ist. Autor: Nico Schroeder Rückgabe: Wahr, wenn die Spur eine Sackgasse ist, sonst Falsch. Definiert in Zeile 463 der Datei Spur.cpp. Benutzt gibEndzustand(). Wird benutzt von Fahrzeug::fahren().

void Spur::setzeAbbiegerichtung (  int  abbiegerichtung  )

Setzt die Abbiegerichtung der Spur. Autor: Nico Schroeder Parameter: abbiegerichtung  Die neue Abbiegerichtung Ausnahmebehandlung: Fehler*  Wenn die Abbiegerichtung ausserhalb zulaessiger Paramet ist, wird ein Fehler geworfen. Definiert in Zeile 563 der Datei Spur.cpp. Wird benutzt von setzeNaechstesVerbindungselement().

void Spur::setzeAusrichtung (  int  ausrichtung  )

Setzt die Ausrichtung der Spur. Autor: Nico Schroeder Parameter: ausrichtung  Die neue Ausrichtung Definiert in Zeile 514 der Datei Spur.cpp. Wird benutzt von StructureParser::startElement().

void Spur::setzeGelb (   )

Setzt die Ampel am Ende der Spur auf Gelb. Autor: Nico Schroeder Definiert in Zeile 380 der Datei Spur.cpp.

void Spur::setzeGruen (   )

Setzt die Ampel am Ende der Spur auf Gruen. Autor: Nico Schroeder Definiert in Zeile 369 der Datei Spur.cpp. Wird benutzt von setzeNaechstesVerbindungselement().

void Spur::setzeKoordinaten (  Koordinaten  koordinaten  )

Setzt die Koordinaten der Spur. Autor: Nico Schroeder Parameter: koordinaten  Die neuen Koordinaten Definiert in Zeile 490 der Datei Spur.cpp. Wird benutzt von StructureParser::startElement().

void Spur::setzeNaechstesVerbindungselement (  int  richtung, long int  id, double  wahrscheinlichkeit )

Setzt die ID einer nachfolgender Spur. Autor: Nico Schroeder Parameter: richtung  gibt die Richtung an ( 1 = links | 2 = gerade aus | 3 = rechts ) id  Die ID der nachfolgenden Spur wahrscheinlichkeit  Die Wahrscheinlichkeit mit der diese Spur (id) als naechstes befahren wird Ausnahmebehandlung: Fehler*  Soll eine ID fuer eine nicht existente Richtung gesetzt werden, wird ein Fehler geworfen. Definiert in Zeile 604 der Datei Spur.cpp.

void Spur::setzeNaechstesVerbindungselement (  Spur *  spur, int  richtung, double  wahrscheinlichkeit )

knuepft neues Spurenelement am Ende an Autor: Nico Schroeder Parameter: *spur  Gibt die anzuhaengende Spur an richtung  gibt die Richtung an ( 1 = links | 2 = gerade aus | 3 = rechts ) wahrscheinlichkeit  Setzt den Wahrscheinlichkeitswert fuer diese Spur (als p= 0 ... 1) Ausnahmebehandlung: Fehler*  Soll eine nicht existente Wahrscheinlichkeit oder eine Wahrscheinlichkeit fuer eine nicht existente Richtung gesetzt werden, wird ein Fehler geworfen. Definiert in Zeile 132 der Datei Spur.cpp. Benutzt setzeAbbiegerichtung() und setzeGruen(). Wird benutzt von SzenarioParser::parseXml() und StructureParser::startElement().

void Spur::setzeRichtung (  int  richtung  )

Setzt die Richtung der Spur. Autor: Nico Schroeder Parameter: richtung  Die neue Richtung Definiert in Zeile 538 der Datei Spur.cpp. Wird benutzt von StructureParser::startElement().

void Spur::setzeRot (   )

Setzt die Ampel am Ende der Spur auf Rot. Autor: Nico Schroeder Definiert in Zeile 391 der Datei Spur.cpp.

void Spur::setzeSackgasse (   )

Am Ende der Spur schliesst keine weitere Spur an. Autor: Nico Schroeder Definiert in Zeile 402 der Datei Spur.cpp.

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Dateien:

• /Users/Shared/TraffSpot/Spur.h
• /Users/Shared/TraffSpot/Spur.cpp

---