jmri
Interface SignalMastLogicManager

All Superinterfaces:

Manager

All Known Implementing Classes:

DefaultSignalMastLogicManager

public interface SignalMastLogicManager
extends Manager

This file is part of JMRI.

JMRI is free software; you can redistribute it and/or modify it under the terms of version 2 of the GNU General Public License as published by the Free Software Foundation. See the "COPYING" file for a copy of this license.

JMRI is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

Author:

Kevin Dickerson Copyright (C) 2011

Field Summary

Fields inherited from interface jmri.Manager

AUDIO, BLOCKBOSS, BLOCKS, CONDITIONALS, IDTAGS, LAYOUTBLOCKS, LIGHTS, LOGIXS, MEMORIES, OBLOCKS, PANELFILES, REPORTERS, ROUTES, SECTIONS, SENSORGROUPS, SENSORS, SIGNALGROUPS, SIGNALHEADS, SIGNALMASTLOGICS, SIGNALMASTS, TIMEBASE, TRANSITS, TURNOUTS, WARRANTS

Method Summary

void	addDestinationMastToLogic(SignalMastLogic src, SignalMast destination)
void	automaticallyDiscoverSignallingPairs() Discover all possible valid source and destination signalmasts past pairs on all layout editor panels.
boolean	checkValidDest(SignalMast sourceMast, SignalMast destMast) This uses the layout editor to check if the destination signalmast is reachable from the source signalmast
void	discoverSignallingDest(SignalMast source, LayoutEditor layout) Discover valid destination signalmasts for a given source signal on a given layout editor panel.
void	dispose() Free resources when no longer used.
ArrayList<SignalMastLogic>	getLogicsByDestination(SignalMast destination) Gather a list of all the signal mast logics, by destination signal mast
long	getSignalLogicDelay()
SignalMastLogic	getSignalMastLogic(SignalMast source)
ArrayList<SignalMastLogic>	getSignalMastLogicList() Returns an arraylist of signalmastlogic
void	initialise() Used to initialise all the signalmast logics. primarily used after loading.
SignalMastLogic	newSignalMastLogic(SignalMast source)
void	removeDestinationMastToLogic(SignalMastLogic src, SignalMast destination)
void	removeSignalMastLogic(SignalMastLogic sml) Completely remove the signalmast logic.
void	removeSignalMastLogic(SignalMastLogic sml, SignalMast dest) Remove a destination mast from the signalmast logic
void	setSignalLogicDelay(long l)

Methods inherited from interface jmri.Manager

addPropertyChangeListener, deregister, getBeanBySystemName, getSystemNameArray, getSystemNameList, getSystemPrefix, getXMLOrder, makeSystemName, register, removePropertyChangeListener, systemLetter, typeLetter

Method Detail

addDestinationMastToLogic

void addDestinationMastToLogic(SignalMastLogic src,
                               SignalMast destination)

automaticallyDiscoverSignallingPairs

void automaticallyDiscoverSignallingPairs()
                                          throws JmriException

Discover all possible valid source and destination signalmasts past pairs on all layout editor panels.

Throws:

JmriException

checkValidDest

boolean checkValidDest(SignalMast sourceMast,
                       SignalMast destMast)
                       throws JmriException

This uses the layout editor to check if the destination signalmast is reachable from the source signalmast

Parameters:

sourceMast - Source SignalMast

destMast - Destination SignalMast

Returns:

true if valid, false if not valid.

Throws:

JmriException

discoverSignallingDest

void discoverSignallingDest(SignalMast source,
                            LayoutEditor layout)
                            throws JmriException

Discover valid destination signalmasts for a given source signal on a given layout editor panel.

Parameters:

source - Source SignalMast

layout - Layout Editor panel to check.

Throws:

JmriException

dispose

void dispose()

Description copied from interface: Manager

Free resources when no longer used. Specifically, remove all references to and from this object, so it can be garbage-collected.

Specified by:

dispose in interface Manager

getLogicsByDestination

ArrayList<SignalMastLogic> getLogicsByDestination(SignalMast destination)

Gather a list of all the signal mast logics, by destination signal mast

getSignalLogicDelay

long getSignalLogicDelay()

getSignalMastLogic

SignalMastLogic getSignalMastLogic(SignalMast source)

getSignalMastLogicList

ArrayList<SignalMastLogic> getSignalMastLogicList()

Returns an arraylist of signalmastlogic

Returns:

An ArrayList of SignalMast logics

initialise

void initialise()

Used to initialise all the signalmast logics. primarily used after loading.

newSignalMastLogic

SignalMastLogic newSignalMastLogic(SignalMast source)

removeDestinationMastToLogic

void removeDestinationMastToLogic(SignalMastLogic src,
                                  SignalMast destination)

removeSignalMastLogic

void removeSignalMastLogic(SignalMastLogic sml,
                           SignalMast dest)

Remove a destination mast from the signalmast logic

Parameters:

sml - The signalmast logic of the source signal

dest - The destination mast

removeSignalMastLogic

void removeSignalMastLogic(SignalMastLogic sml)

Completely remove the signalmast logic.

setSignalLogicDelay

void setSignalLogicDelay(long l)