DeviceUnit (Modell(-bau-)basierte Eisenbahnsteuerung)

java.lang.Object
- de.morknet.mrw.base.NamedElement
- - de.morknet.mrw.base.DeviceUnit

All Implemented Interfaces:

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

Direct Known Subclasses:

Abschnitt, Gleisteil, Lampe, Signal
```
public abstract class DeviceUnit
extends NamedElement
implements java.lang.Comparable<DeviceUnit>
```
Diese Basisklasse verwaltet ein schaltbares Gerät. Ein solches Gerät können Weichen, Signale und Gleisabschnitte sein.

Author:

smork

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`count` Die Gesamtzahl der benötigten IO-Pins am Mikrocontroller.
`protected int`	`ctrl_id` Die Mikrocontroller-ID.
`protected int`	`elapsed` Die verstrichene Gesamtzeit an Schaltticks im Mikrocontroller.
`protected int`	`elapsedCount` Die Zahl der Schaltaufträge.
`protected int`	`pin` Der Startpin, ab der sich dieses Gerät am Mikrocontroller befindet.
`protected int`	`unit_no` Die Gerätenummer.

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

Constructor Summary

Constructors
Constructor and Description

DeviceUnit(Modell modell, java.lang.String name)
Dieser Konstruktur initialisiert dieses Gerät in ein Modell und benennt es.

Constructors
Constructor and Description
`DeviceUnit(Modell modell, java.lang.String name)` Dieser Konstruktur initialisiert dieses Gerät in ein Modell und benennt es.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addCommand(Batch batch)` Diese Methode fügt einen Schaltauftrag einem Verarbeitungsstapel hinzu
`protected void`	`addData(MrwMessage msg)` Diese Methode fügt einem Schaltauftrag Daten hinzu.
`void`	`addElapsed(int elapsed)` Diese Methode fügt dem Gerät eine Schaltzeit hinzu.
`protected void`	`addPinConfig(MrwMessage msg)` Diese Methode fügt einer Konfigurations-Meldung die IO-Pin-Belegung bei.
`void`	`clearBatchElement()` Diese Methode markiert diesem Gerät, dass die Kommandoverarbeitung abgeschlossen wurde.
`int`	`compareTo(DeviceUnit unit)` Diese Vergleichsmethode sorgt dafür, dass Geräte gemäß ihrer ansteigenden Pin-Konfiguration sortiert werden.
`abstract MrwMessage`	`createConfigMessage()` Diese abstrakte Methode definiert das erzeugen einer Konfigurationsmeldung.
`protected MrwMessage`	`createMsg()` Diese Methode erzeugt eine CAN-Meldung und initialisiert diese mit den IDs dieses Geräts.
`boolean`	`equals(java.lang.Object arg0)`
`static DeviceUnit`	`findDeviceUnit(int id)` Diese Methode sucht ein Gerät an Hand ihrer ID.
`BatchElement`	`getBatchElement()` Diese Methode gibt im Falle einer ausstehenden Kommandoverarbeitung das damit verbundene `BatchElement` zurück.
`protected abstract Command`	`getCommand()` Diese abstrakte Methode gibt das Schaltkommando zurück.
`int`	`getDeviceUnitNumber()` Diese Methode gibt die Gerätenummer zurück.
`int`	`getMicroControllerId()` Diese Methode gibt die Microcontroller-ID zurück.
`Modell`	`getModell()` Gibt das Modell dieses Abschnitts zurück.
`double`	`getSwitchTime(double quantum)` Diese Methode gibt die durchschnittliche Schaltzeit zurück.
`int`	`hashCode()`
`boolean`	`isProcessing()` Diese Methode meldet zurück, ob ein Kommando zur Verarbeitung verschickt wurde.
`void`	`setBatchElement(BatchElement element)` Diese Methode weist ein `BatchElement` diesem Gerät zu.
`void`	`setMicroControllerId(int ctrl_id, int unit_no)` Diese Methode definiert für dieses Gerät die Controller-ID und die Gerätenummer.
`void`	`setPinConfiguration(int pin, int count)` Diese Methode definiert den Startpin und die Anzahl der benötigten IO-Pins.

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, toString, wait, wait, wait

- Field Detail
  - ctrl_id
```
protected int ctrl_id
```
    Die Mikrocontroller-ID. In einer CAN-Message ist das die Standard-ID.
  - unit_no
```
protected int unit_no
```
    Die Gerätenummer. In einer CAN-Message ist das die Extended-ID.
  - pin
```
protected int pin
```
    Der Startpin, ab der sich dieses Gerät am Mikrocontroller befindet.
  - count
```
protected int count
```
    Die Gesamtzahl der benötigten IO-Pins am Mikrocontroller.
  - elapsed
```
protected int elapsed
```
    Die verstrichene Gesamtzeit an Schaltticks im Mikrocontroller.
  - elapsedCount
```
protected int elapsedCount
```
    Die Zahl der Schaltaufträge. Zusammen mit elapsed kann daraus die durchschnittliche Schaltzeit berechnet werden.
- Constructor Detail
  - DeviceUnit
```
public DeviceUnit(Modell modell,
          java.lang.String name)
```
    Dieser Konstruktur initialisiert dieses Gerät in ein Modell und benennt es.
    
    Parameters:
    modell - Das Modell, zu dem dieses Gerät gehört.
    name - Der Name dieses Geräts.
- Method Detail
  - getCommand
```
protected abstract Command getCommand()
```
    Diese abstrakte Methode gibt das Schaltkommando zurück.
    
    Returns:
    Das Schaltkommando passend zu diesem Gerät.
  - createConfigMessage
```
public abstract MrwMessage createConfigMessage()
```
    Diese abstrakte Methode definiert das erzeugen einer Konfigurationsmeldung.
    
    Returns:
    Die Konfigurationsmeldung.
    See Also:
    MrwMessage
  - setMicroControllerId
```
public final void setMicroControllerId(int ctrl_id,
                        int unit_no)
```
    Diese Methode definiert für dieses Gerät die Controller-ID und die Gerätenummer.
    
    Parameters:
    ctrl_id - Die zu setzende Controller-ID.
    unit_no - Die zu setzende Gerätenummer.
  - getMicroControllerId
```
public final int getMicroControllerId()
```
    Diese Methode gibt die Microcontroller-ID zurück.
    
    Returns:
    Die Microcontroller-ID-
  - getDeviceUnitNumber
```
public final int getDeviceUnitNumber()
```
    Diese Methode gibt die Gerätenummer zurück.
    
    Returns:
    Die Gerätenummer.
  - getModell
```
public Modell getModell()
```
    Gibt das Modell dieses Abschnitts zurück.
    
    Returns:
    Das Modell dieser Anlage.
  - findDeviceUnit
```
public static final DeviceUnit findDeviceUnit(int id)
```
    Diese Methode sucht ein Gerät an Hand ihrer ID. Die ID setzt sich aus Controller-ID und Gerätenummer zusammen.
    
    Parameters:
    id - Die Geräte-ID.
    
    Returns:
    Das gefundene Gerät.
  - setPinConfiguration
```
public final void setPinConfiguration(int pin,
                       int count)
```
    Diese Methode definiert den Startpin und die Anzahl der benötigten IO-Pins.
    
    Parameters:
    pin - Der Startpin, ab dem der Mikrocontroller dieses Gerät verwaltet.
    count - Die Zahl der benötigten IO-Pins.
  - createMsg
```
protected MrwMessage createMsg()
```
    Diese Methode erzeugt eine CAN-Meldung und initialisiert diese mit den IDs dieses Geräts.
    
    Returns:
    Die geräteabhängig erzeugte CAN-Meldung.
    See Also:
    MrwMessage
  - addPinConfig
```
protected void addPinConfig(MrwMessage msg)
```
    Diese Methode fügt einer Konfigurations-Meldung die IO-Pin-Belegung bei.
    
    Parameters:
    msg -
  - addData
```
protected void addData(MrwMessage msg)
```
    Diese Methode fügt einem Schaltauftrag Daten hinzu. Je nach Gerät wird diese Methode überladen und daher in dieser Basisimplementierung leer.
    
    Parameters:
    msg - Die CAN-Meldung, der Daten hinzugefügt werden sollen.
  - addCommand
```
public final void addCommand(Batch batch)
```
    Diese Methode fügt einen Schaltauftrag einem Verarbeitungsstapel hinzu
    
    Parameters:
    batch - Der Kommandostapel.
  - addElapsed
```
public final void addElapsed(int elapsed)
```
    Diese Methode fügt dem Gerät eine Schaltzeit hinzu. So können durchschnittliche Schaltzeiten ermittelt werden.
    
    Parameters:
    elapsed - Die hinzuzufügende Schaltzeit als Zeitquantum. Dieses Zeitquantum entspricht der Periodendauer eines Timerinterrupts auf dem Mikrocontroller. Ist dieses Quantum 0, wird es nicht registriert.
  - getSwitchTime
```
public final double getSwitchTime(double quantum)
```
    Diese Methode gibt die durchschnittliche Schaltzeit zurück.
    
    Parameters:
    quantum - Das Timerquantum, dass der Berechnung zugrunde liegt.
    
    Returns:
    Die absolute durchschnittliche Schaltzeit in Sekunden.
  - compareTo
```
public final int compareTo(DeviceUnit unit)
```
    Diese Vergleichsmethode sorgt dafür, dass Geräte gemäß ihrer ansteigenden Pin-Konfiguration sortiert werden. Das macht das Debuggen der Gerätekonfiguration leichter.
    
    Specified by:
    
    compareTo in interface java.lang.Comparable<DeviceUnit>
    
    Parameters:
    unit - Das zu vergleichende Gerät.
  - equals
```
public boolean equals(java.lang.Object arg0)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - setBatchElement
```
public final void setBatchElement(BatchElement element)
```
    Diese Methode weist ein BatchElement diesem Gerät zu. Damit wird signalisiert, dass ein Kommando verschickt wurde. Das BatchElement darf nicht null sein, ansonsten wird eine UndefinedBatchElementException geworfen.
    
    Parameters:
    element - Das mit dem Gerät verbundene BatchElement mit dem verschickten Kommando.
    
    Throws:
    
    UndefinedBatchElementException - Falls das BatchElement null war.
    
    BatchElementDefinedException - Falls schon ein BatchElement vorher definiert war.
  - clearBatchElement
```
public void clearBatchElement()
```
    Diese Methode markiert diesem Gerät, dass die Kommandoverarbeitung abgeschlossen wurde. Das BatchElement wird ausgetragen.
  - isProcessing
```
public boolean isProcessing()
```
    Diese Methode meldet zurück, ob ein Kommando zur Verarbeitung verschickt wurde.
    
    Returns:
    Zustand, ob ein Kommando zur Verarbeitung verschickt wurde und die Ausführung noch aussteht.
  - getBatchElement
```
public BatchElement getBatchElement()
```
    Diese Methode gibt im Falle einer ausstehenden Kommandoverarbeitung das damit verbundene BatchElement zurück. Ist keine Kommandoverarbeitung ausstehend, wird eine UndefinedBatchElementException geworfen.
    
    Returns:
    Das mit einer ausstehenden Kommandoverarbeitung verbundene BatchElement.

Class DeviceUnit

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

ctrl_id

unit_no

pin

count

elapsed

elapsedCount

Constructor Detail

DeviceUnit

Method Detail

getCommand

createConfigMessage

setMicroControllerId

getMicroControllerId

getDeviceUnitNumber

getModell

findDeviceUnit

setPinConfiguration

createMsg

addPinConfig

addData

addCommand

addElapsed

getSwitchTime

compareTo

equals

hashCode

setBatchElement

clearBatchElement

isProcessing

getBatchElement