de.morknet.mrw.base

Class Gleisteil

java.lang.Object

de.morknet.mrw.base.NamedElement

de.morknet.mrw.base.DeviceUnit

de.morknet.mrw.base.Gleisteil

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DeviceUnit>

Direct Known Subclasses:

Gleis, Verzweigung

public abstract class Gleisteil
extends DeviceUnit

Diese abstrakte Klasse repräsentiert ein Gleisteil. Ein Gleisteil kann sein:

• Ein Gleis
• Eine Verzweigung (also Weiche oder DKW)

Author:

sm

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	aIsHigh Flag, ob Gleisverbindung a in Zählrichtung zeigt.
protected java.util.List<Gleisteil>	backward Die Liste der banachbarten Gleisteile entgegen Zählrichtung.
protected java.util.List<Gleisteil>	forward Die Liste der benachbarten Gleisteile in Zährichtung.
protected org.apache.commons.logging.Log	log Das Log, in das Meldungen geschrieben werden.
protected Route	route Die Fahrstraße zu der dieses Gleisteil gehört.
protected Abschnitt	segment Der Gleisabschnitt zu dem dieses Gleisteil gehört.

Fields inherited from class de.morknet.mrw.base.DeviceUnit

count, ctrl_id, elapsed, elapsedCount, pin, unit_no

Fields inherited from class de.morknet.mrw.base.NamedElement

name

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Gleisteil(Abschnitt abschnitt, java.lang.String name, boolean aIsHigh)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	aIsHigh() Diese Methode gibt zurück, ob der Gleisverbindung "a" in Zählrichtung gerichtet ist.
Gruppe	getGruppe() Diese Methode gibt die Betriebsgruppe zu diesem Gleisabschnitt zurück.
Route	getRoute() Diese Methode gibt die zu diesem Gleisteil definierte Fahrstraße zurück.
java.util.List<Gleisteil>	getRouting(boolean direction) Diese Methode gibt abhängig von der geforderten Gleisrichtung bzgl. der Zählrichtung die benachbarten Gleisteile zurück.
Abschnitt	getSegment() Diese Methode gibt den Gleisabschnitt zu diesem Gleisabschnitt zurück.
protected abstract boolean	hasTrackElement(Gleisteil gt) Diese Methode überprüft, ob das angegebenene Gleisteil direkt mit diesem hier verbunden ist.
abstract boolean	isBranch() Diese Methode ermittelt, ob es sich bei diesem Gleisteil um eine Verzweigung handelt.
protected abstract boolean	isDirectionCorrect(Gleisteil gt, boolean isDirection) Diese Methode überprüft, ob die Zählrichtung des angegebenen Gleisteils mit diesem hier übereinstimmt.
boolean	isFree() Diese Methode gibt die Gleisbelegung zum dazugehörigen Gleisabschnitt zurück.
boolean	isLocked() Diese Methode gibt den Verriegelungszustand dieses Gleisteils zurück.
void	lock() Diese Methode verriegelt dieses Gleisteil.
void	setRoute(Route route) Diese Methode setzt für dieses Gleisteil die dazugehörige Fahrstraße.
java.lang.String	toString() Diese Methode gibt das Gleisteil als Klartext zurück.
abstract void	turn(Batch batch, Gleisteil prev, Gleisteil next) Diese Methode ermittelt das Kommando, um eine Verzweigung in die richtige Lage abhängig von den benachbarten Gleisteilen zu bringen.
abstract int	validate() Diese Methode überprüft die benachbarten Gleisteile auf Plausibilität.

Methods inherited from class de.morknet.mrw.base.DeviceUnit

addCommand, addData, addElapsed, addPinConfig, clearBatchElement, compareTo, createConfigMessage, createMsg, equals, findDeviceUnit, getBatchElement, getCommand, getDeviceUnitNumber, getMicroControllerId, getModell, getSwitchTime, hashCode, isProcessing, setBatchElement, setMicroControllerId, setPinConfiguration

Methods inherited from class de.morknet.mrw.base.NamedElement

getLayoutInfo, getLogX, getLogY, getName, parseLayoutInfo, setLogX, setLogY

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

log

protected final org.apache.commons.logging.Log log

Das Log, in das Meldungen geschrieben werden.

segment

protected final Abschnitt segment

Der Gleisabschnitt zu dem dieses Gleisteil gehört.

aIsHigh

protected final boolean aIsHigh

Flag, ob Gleisverbindung a in Zählrichtung zeigt.

route

protected volatile Route route

Die Fahrstraße zu der dieses Gleisteil gehört.

forward

protected final java.util.List<Gleisteil> forward

Die Liste der benachbarten Gleisteile in Zährichtung.

backward

protected final java.util.List<Gleisteil> backward

Die Liste der banachbarten Gleisteile entgegen Zählrichtung.

Constructor Detail

Gleisteil

protected Gleisteil(Abschnitt abschnitt,
         java.lang.String name,
         boolean aIsHigh)

Method Detail

validate

public abstract int validate()

Diese Methode überprüft die benachbarten Gleisteile auf Plausibilität.

Returns:

Erfolg, wenn die Plausibilität in Ordnung ist.

hasTrackElement

protected abstract boolean hasTrackElement(Gleisteil gt)

Diese Methode überprüft, ob das angegebenene Gleisteil direkt mit diesem hier verbunden ist.

Parameters:

gt - Das auf Nachbarschaft zu überprüfende Gleisteil.

Returns:

True, falls das Gleisteil benachbart ist.

isDirectionCorrect

protected abstract boolean isDirectionCorrect(Gleisteil gt,
                         boolean isDirection)

Diese Methode überprüft, ob die Zählrichtung des angegebenen Gleisteils mit diesem hier übereinstimmt.

Parameters:

gt - Das zu überprüfende Gleisteil.

isDirection - Die zu überprüfende Fahrtrichtung.

Returns:

Das Ergebnis.

turn

public abstract void turn(Batch batch,
        Gleisteil prev,
        Gleisteil next)

Diese Methode ermittelt das Kommando, um eine Verzweigung in die richtige Lage abhängig von den benachbarten Gleisteilen zu bringen. Das resultierende Schaltkommando wird in den Batch eingetragen.

Parameters:

batch - Der Batch für den Schaltauftrag.

prev - Das vorhergehende Gleisteil.

next - Das nachfolgende Gleisteil.

isBranch

public abstract boolean isBranch()

Diese Methode ermittelt, ob es sich bei diesem Gleisteil um eine Verzweigung handelt.

Returns:

Flag, ob es eine Verzweigung ist.

getRouting

public java.util.List<Gleisteil> getRouting(boolean direction)

Diese Methode gibt abhängig von der geforderten Gleisrichtung bzgl. der Zählrichtung die benachbarten Gleisteile zurück.

Parameters:

direction - Die geforderte Richtung relativ zur Zählrichtung.

Returns:

Die benachbarten Gleisteile relativ zur geforderten Zählrichtung.

isFree

public boolean isFree()

Diese Methode gibt die Gleisbelegung zum dazugehörigen Gleisabschnitt zurück.

Returns:

Der Gleisbesetztzustand.

getSegment

public Abschnitt getSegment()

Diese Methode gibt den Gleisabschnitt zu diesem Gleisabschnitt zurück.

Returns:

Der zu diesem Gleisteil gehörende Gleisabschnitt.

getGruppe

public Gruppe getGruppe()

Diese Methode gibt die Betriebsgruppe zu diesem Gleisabschnitt zurück.

Returns:

Der zu diesem Gleisteil gehörende Betriebsgruppe.

getRoute

public Route getRoute()

Diese Methode gibt die zu diesem Gleisteil definierte Fahrstraße zurück.

Returns:

Die Fahrstraße, die dieses Gleisteil benutzt.

setRoute

public void setRoute(Route route)

Diese Methode setzt für dieses Gleisteil die dazugehörige Fahrstraße. Wird die Fahrstraße entfernt, wird automatisch dieses Gleisteil entriegelt.

Parameters:

route - Die zu setzende Fahrstraße.

isLocked

public boolean isLocked()

Diese Methode gibt den Verriegelungszustand dieses Gleisteils zurück. Wenn das Gleisteil verriegelt ist, ohne dass eine Fahrstraße definiert wurde, wird eine LockWithoutRouteException geworfen.

Returns:

Der Verriegelungszustand

Throws:

LockWithoutRouteException - Wenn dieses Gleisteil verriegelt ist, ohne dass eine Fahrstraße definiert wurde. In diesem Fall wird die Verriegelung aufgehoben.

lock

public void lock()

Diese Methode verriegelt dieses Gleisteil. Jede externe Zustandsänderung (z.B. manuelle Weichenschaltun) führt zu einer Auflösung der Fahrstraße.

Throws:

LockWithoutRouteException - Wenn versucht wird, dieses Gleisteil zu verriegeln ohne dass eine Fahrstraße definiert war.

aIsHigh

public final boolean aIsHigh()

Diese Methode gibt zurück, ob der Gleisverbindung "a" in Zählrichtung gerichtet ist.

Returns:

Die Zählrichtung an Gleisverbindung "a".

toString

public java.lang.String toString()

Diese Methode gibt das Gleisteil als Klartext zurück.

Overrides:

toString in class java.lang.Object

Returns:

Der Klartext dieses Gleisteils.