de.bsvrz.kex.isis.isis
Interface BisInterface

All Superinterfaces:
de.bsvrz.sys.funclib.bitctrl.modell.netz.NetzInterface
All Known Implementing Classes:
AbstractBIS, EreignisTypBaustelleAnlegen

public interface BisInterface
extends de.bsvrz.sys.funclib.bitctrl.modell.netz.NetzInterface

Legt das Interface zu einem BaustellenInformationsSystem (BIS) fest. Über eine Klasse, die dieses Interface implementiert, können bestehende Baustelleninformationssysteme an die AK-VRZ Software angebunden werden.

Version:
$Revision: 144 $ / $Date: 2006-12-14 01:04:03 +0100 (Do, 14 Dez 2006) $ / ($Author: HCK $)
Author:
inovat, innovative systeme - verkehr - tunnel - technik, Hans Christian Kniß (HCK)

Nested Class Summary
static class BisInterface.BaustellenZustand
          Aufzählungstyp für die möglichen Zustände einer Baustelle (siehe Datenkatalog Attributtyp: att.statusBaustelle).
static class BisInterface.BisKommunikationsStatus
          Aufzählungstyp für den Kommunikationsstatus des BisInterface.
 
Nested classes/interfaces inherited from interface de.bsvrz.sys.funclib.bitctrl.modell.netz.NetzInterface
de.bsvrz.sys.funclib.bitctrl.modell.netz.NetzInterface.ASBStationierungsRichtung, de.bsvrz.sys.funclib.bitctrl.modell.netz.NetzInterface.FahrtRichtung
 
Method Summary
 void addKommunikationsStatusListener(BisKommunikationsStatusListener listener)
          Registriert einen Listener (Beobachterklasse), der über den aktuellen Status der Kommunikation des BIS-Interfaces informiert werden soll.
 long erzeugeBaustelle(String pid, String name, String info, long vonZeitpunkt, long dauer, OrtsReferenzStrassenSegmentUndOffsetInterface ortsReferenz, long laenge, BisInterface.BaustellenZustand baustellenZustand, int engpassKapazitaet, BaustellenVerantwortlicherInterface baustellenVerantwortlicher)
          Erzeugt ein neues Baustellenobjekt (typ.baustelle) auf Seiten der VRZ.
 BaustellenVerantwortlicherInterface erzeugeBaustellenVerantwortlichen(String firma, String nameBaustellenVerantwortlicher, String telefonBaustellenVerantwortlicher, String telefonFirma, String telefonMobilBaustellenVerantwortlicher)
          Erzeugt einen Baustellenverantwortlichen, der einer Baustelle zugeordnet wird.
 OrtsReferenzStrasseUndBetriebsKilometerInterface erzeugeOrtsReferenz(StrasseInterface strasse, de.bsvrz.sys.funclib.bitctrl.modell.netz.NetzInterface.FahrtRichtung fahrtRichtung, long betriebsKilometer, int blockNummer)
          Erstellt eine Ortsreferenz, bei dem die Ortsangabe über eine Straße und den Betriebskilometer dargestellt wird.
 OrtsReferenzStrassenSegmentUndOffsetInterface erzeugeOrtsReferenz(String pidStrassenSegment, long startOffset)
          Erstellt ein OrtsreferenzObjekt, bei dem die Ortsangabe über ein StraßenSegment und den Offset vom Anfang des StraßenSegments dargestellt wird.
 OrtsReferenzAsbStationierungInterface erzeugeOrtsReferenz(String anfangsKnoten, String endKnoten, de.bsvrz.sys.funclib.bitctrl.modell.netz.NetzInterface.ASBStationierungsRichtung stationierungsRichtung, long stationierung)
          Erstellt eine Ortsreferenzen, bei dem die Ortsangabe über das ASB-Stationierungssystem angegeben wird (Anfangs- und Endpunkt (Netzknoten bzw.
 BaustelleInterface getBaustelle(long baustellenId)
          Liefert das Baustellenobjekt mit der zugehörigen ID.
 StrasseInterface getStrasse(String strassenPid)
          Liefert ein Straßenobjekt zu einer PID.
 StrasseInterface[] getStrassen(int strassenTyp, int strassenNummer, String zusatz)
          Gibt eine Menge von Straßen des VRZ-Systems zurück, die bestimmten Kriterien genügen.
 void loescheBaustelle(long baustellenId)
          Löscht das übergebene Baustellenobjekt auf der VRZ.
 void removeKommunikationsStatusListener(BisKommunikationsStatusListener listener)
          Löscht die Registrierung eines Listener (Beobachterklasse), der über addKommunikationsStatusListener(BisKommunikationsStatusListener) registirert wurde.
 

Method Detail

addKommunikationsStatusListener

void addKommunikationsStatusListener(BisKommunikationsStatusListener listener)
Registriert einen Listener (Beobachterklasse), der über den aktuellen Status der Kommunikation des BIS-Interfaces informiert werden soll.

Parameters:
listener - Beaobachterklasse, die das BisKommunikationsStatusListener Interface implemtiert hat.

erzeugeBaustelle

long erzeugeBaustelle(String pid,
                      String name,
                      String info,
                      long vonZeitpunkt,
                      long dauer,
                      OrtsReferenzStrassenSegmentUndOffsetInterface ortsReferenz,
                      long laenge,
                      BisInterface.BaustellenZustand baustellenZustand,
                      int engpassKapazitaet,
                      BaustellenVerantwortlicherInterface baustellenVerantwortlicher)
                      throws BisInterfaceException
Erzeugt ein neues Baustellenobjekt (typ.baustelle) auf Seiten der VRZ.

Parameters:
pid - Pid der zu erzeugenden Baustelle (weltweit eindeutige PermanenteID) oder null, falls die PID automatisch vergeben werden soll.
name - Name der Baustelle oder null, falls der Name automatisch vergeben werden soll.
info - Informationstext zur Baustelle oder null, falls der Infotext automatisch vergeben werden soll.
vonZeitpunkt - Zeitpunkt des Baustellenbeginns (in ms seit dem 1.1.1970 UTC).
dauer - Dauer der Baustelle (in ms).
ortsReferenz - Ortsreferenzobjekt (StraßenSegments mit Offset), auf der die Baustelle beginnt.
laenge - Länge des Baustelle stromabwärts in Metern.
baustellenZustand - Zustand der Baustelle.
engpassKapazitaet - Restkapazität während der Gültigkeitsdauer der Baustelle in Fz/h.
baustellenVerantwortlicher - Angaben zum Baustellenverantwortlichen eines Baustellenobjekts.
Returns:
Die Id des erzeugten Baustellenobjekts oder -1, wenn kein Baustellenobjekt angelegt werden konnte.
Throws:
BisInterfaceException - wenn die Baustelle nicht angelegt werden kann

erzeugeBaustellenVerantwortlichen

BaustellenVerantwortlicherInterface erzeugeBaustellenVerantwortlichen(String firma,
                                                                      String nameBaustellenVerantwortlicher,
                                                                      String telefonBaustellenVerantwortlicher,
                                                                      String telefonFirma,
                                                                      String telefonMobilBaustellenVerantwortlicher)
Erzeugt einen Baustellenverantwortlichen, der einer Baustelle zugeordnet wird.

Parameters:
firma - Name der verantwortlichen Firma.
nameBaustellenVerantwortlicher - Name des Baustellenverantwortlichen.
telefonBaustellenVerantwortlicher - Telefonnummer des Baustellenverantwortlichen.
telefonFirma - Telefonnummer der verantwortlichen Firma.
telefonMobilBaustellenVerantwortlicher - Handynummer des Baustellenverantwortlichen.
Returns:
Der Baustellenverantwortliche.

erzeugeOrtsReferenz

OrtsReferenzStrasseUndBetriebsKilometerInterface erzeugeOrtsReferenz(StrasseInterface strasse,
                                                                     de.bsvrz.sys.funclib.bitctrl.modell.netz.NetzInterface.FahrtRichtung fahrtRichtung,
                                                                     long betriebsKilometer,
                                                                     int blockNummer)
                                                                     throws BisInterfaceException
Erstellt eine Ortsreferenz, bei dem die Ortsangabe über eine Straße und den Betriebskilometer dargestellt wird.

Parameters:
strasse - Straße, auf der die OrtReferenz liegt.
fahrtRichtung - Fahrtrichtung der Straße, auf der die Ortsreferenz liegt.
betriebsKilometer - Betriebskilometer auf der Straße, auf der die Ortsreferenz liegt.
blockNummer - Blocknummer des Betriebskilometers.
Returns:
Ortsreferenz, bei dem die Ortsangabe über eine Straße und den Betriebskilometer dargestellt wird.
Throws:
BisInterfaceException - wenn keine Abbildung möglich ist.

erzeugeOrtsReferenz

OrtsReferenzStrassenSegmentUndOffsetInterface erzeugeOrtsReferenz(String pidStrassenSegment,
                                                                  long startOffset)
                                                                  throws BisInterfaceException
Erstellt ein OrtsreferenzObjekt, bei dem die Ortsangabe über ein StraßenSegment und den Offset vom Anfang des StraßenSegments dargestellt wird.

Parameters:
pidStrassenSegment - Pid des StraßenSegments gemäß Konfiguration
startOffset - Offset vom Anfang des StraßenSegments
Returns:
Ortsreferenz, bei dem die Ortsangabe über ein StraßenSegment und den Offset vom Anfang des StraßenSegments dargestellt wird.
Throws:
BisInterfaceException - wenn keine Abbildung möglich ist.

erzeugeOrtsReferenz

OrtsReferenzAsbStationierungInterface erzeugeOrtsReferenz(String anfangsKnoten,
                                                          String endKnoten,
                                                          de.bsvrz.sys.funclib.bitctrl.modell.netz.NetzInterface.ASBStationierungsRichtung stationierungsRichtung,
                                                          long stationierung)
                                                          throws BisInterfaceException
Erstellt eine Ortsreferenzen, bei dem die Ortsangabe über das ASB-Stationierungssystem angegeben wird (Anfangs- und Endpunkt (Netzknoten bzw. Nullpunkt), Stationierung im Wertebereich von 0 bis zugewiesene Länge sowie Angabe der Richtung)

Parameters:
anfangsKnoten - Anfangsknoten der ASB Stationierung. Anfangsknoten mit eindeutiger Kennung (Anfangsnullpunkt) des Teilabschnittes oder Astes. Die Nullpunktbezeichung hat die Form TTTTnnnB, wobei TTTT die vierstellige TK25-Blattnummer und nnn die dreistellige laufende Nummer ist, die zusammen die bundesweit eindeutige Netzknotennummer darstellen. Durch die Kennung B (ein Zeichen) wird zusätzlich der Nullpunkt des Abschnitts oder Astes eindeutig festgelegt. Eine nicht vorhandene Kennung wird als o(hne) eingetragen.
endKnoten - Endknoten der ASB Stationierung. Endknoten mit eindeutiger Kennung (Endnullpunkt) des Teilabschnittes oder Astes. Die Nullpunktbezeichung hat die Form TTTTnnnB, wobei TTTT die vierstellige TK25-Blattnummer und nnn die dreistellige laufende Nummer ist, die zusammen die bundesweit eindeutige Netzknotennummer darstellen. Durch die Kennung B (ein Zeichen) wird zusätzlich der Nullpunkt des Abschnitts oder Astes eindeutig festgelegt. Eine nicht vorhandene Kennung wird als o(hne) eingetragen.
stationierungsRichtung - Stationierungsrichtung für den ASB Abschnitt.
stationierung - Stationierung (in Metern) auf dem ASB Abschnitt.
Returns:
Ortsreferenz, bei dem die Ortsangabe über das ASB-Stationierungssystem angegeben wird (Anfangs- und Endpunkt (Netzknoten bzw. Nullpunkt) sowie der Stationierung im Wertebereich von 0 bis zugewiesene Länge sowie der Richtung).
Throws:
BisInterfaceException - wenn keine Abbildung möglich ist.

getBaustelle

BaustelleInterface getBaustelle(long baustellenId)
Liefert das Baustellenobjekt mit der zugehörigen ID.

Parameters:
baustellenId - Id der Baustelle, die bei erzeugeBaustelle(java.lang.String, java.lang.String, java.lang.String, long, long, de.bsvrz.kex.isis.isis.OrtsReferenzStrassenSegmentUndOffsetInterface, long, de.bsvrz.kex.isis.isis.BisInterface.BaustellenZustand, int, de.bsvrz.kex.isis.isis.BaustellenVerantwortlicherInterface) zurückgegeben wurde.
Returns:
Baustellenobjekt (BaustelleInterface), über die Baustelleneigenschaften abgerufen werden können.

getStrasse

StrasseInterface getStrasse(String strassenPid)
                            throws BisInterfaceException
Liefert ein Straßenobjekt zu einer PID.

Parameters:
strassenPid - Pid des Straßenobjekts im DatKat.

Die Pid einer Straße hat folgenden Aufbau: Richtlinie für die Vergabe der Pid: strasse.typ.nummer.zusatz.LocCode' mit

'strasse': fester Prefix.

'typ': Typ der Straße (erster Buchstabe der Spalte ROADNUMBER der LCL).

'nummer': Nummer der Straße (Ziffernkombination des Eintrags in der Spalte ROADNUMBER der LCL im Anschluss an den Typ).

'zusatz': Optional, falls vorhanden. Zusatzbezeichnung für die Straße (eventuell vorhandene zusätzliche Zeichen des Eintrags in der Spalte ROADNUMBER der LCL im Anschluss an die Straßennummer).

'LocCode': Referenz auf das Linienelement gemäß LCL, welches die Straße repräsentiert (PID der Linienreferenz hat die Form tmclc.xxxxx, mit xxxxx gleich Location Code des Linienelements, 5-stellig mit führenden Nullen).

Existiert für eine Location keine Linienlocation, so wird als PID der Wert strasse.S.0.tmclcl.00000 verwendet.

Beispiele für gültige PID einerStraße:

strasse.L.150.a.tmclc.39886

strasse.A.562.tmclc.07145

'Richtlinie für die Vergabe des Namens: Bezeichung von AnschlussVon bis AnschlussBis (Zusatzinfo)' mit

'Bezeichnung': Eintrag der Spalte ROADNUMBER der LCL.

'AnschlussVon': Eintrag der Spalte FIRST_NAME der LCL.

'AnschlussBis': Eintrag der Spalte SECOND_NAME der LCL.

'Zusatzinfo': Optional, wenn nicht leer. Eintrag der Spalte ROAD_NAME der LCL.

Beispiele für gültige Namen einerStraße:

L150a von Brühl-Nord nach Köln-Godorf

A562 von Bonn-Rheinaue nach Bonn-Ost (Abzweig Bonn Süd)

Returns:
Straßenobjekt (StrasseInterface) mit der entsprechenden Pid oder null, wenn die PID nicht existiert.
Throws:
BisInterfaceException - wenn die Straßssen nicht aus dem VRZ-System ausgelesen werden konnten.

getStrassen

StrasseInterface[] getStrassen(int strassenTyp,
                               int strassenNummer,
                               String zusatz)
                               throws BisInterfaceException
Gibt eine Menge von Straßen des VRZ-Systems zurück, die bestimmten Kriterien genügen.

Parameters:
strassenTyp - Der Typ der Straße. Folgende Werte sind zulässig:

SonstigeStraße 0
Autobahn 1
Bundesstraße 2
Landstraße 3
Kreisstraße 4
Stadtstraße 5
Hauptverkehrsstraße 6
Sammelstraße 7
Anliegerstraße 8

Beispiel: Für die L128a ist der Typ die 3.

strassenNummer - Straßennummer der Straße. Beispiel: Bei der L128a also die 128.
zusatz - Zusatz zur Straßennummer der Straße. Beispiel: Bei der L128a also "a".
Returns:
Alle Straßenobjekte (StrasseInterface), die auf die entsprechenden Angaben passen, oder leeres Array, wenn keine Straßenobjekte gefunden werden.
Throws:
BisInterfaceException - wenn die Straßssen nicht aus dem VRZ-System ausgelesen werden konnten.

loescheBaustelle

void loescheBaustelle(long baustellenId)
                      throws BisInterfaceException
Löscht das übergebene Baustellenobjekt auf der VRZ. Die Baustelle bleibt für Auswertungen auf Seiten der VRZ weiterhin erhalten.

Parameters:
baustellenId - Id der Baustelle, die bei erzeugeBaustelle(java.lang.String, java.lang.String, java.lang.String, long, long, de.bsvrz.kex.isis.isis.OrtsReferenzStrassenSegmentUndOffsetInterface, long, de.bsvrz.kex.isis.isis.BisInterface.BaustellenZustand, int, de.bsvrz.kex.isis.isis.BaustellenVerantwortlicherInterface) zurückgegeben wurde.
Throws:
BisInterfaceException - wenn die Baustelle mit der angegebenen ID nicht existiert oder wenn die Baustelle im VRZ-System nicht ordnungsgemäß gelöscht werden konnte.

removeKommunikationsStatusListener

void removeKommunikationsStatusListener(BisKommunikationsStatusListener listener)
Löscht die Registrierung eines Listener (Beobachterklasse), der über addKommunikationsStatusListener(BisKommunikationsStatusListener) registirert wurde.

Parameters:
listener - Beaobachterklasse, die nicht weiter über den Kommunikationsstatus informiert werden will.