jmri
Interface LogixManager

All Superinterfaces:

Manager

All Known Implementing Classes:

DefaultLogixManager

public interface LogixManager
extends Manager

Interface for obtaining Logixs

This doesn't have a "new" method, since Logixs are separately implemented, instead of being system-specific.

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:

Dave Duchamp Copyright (C) 2007

Method Summary

void	activateAllLogixs() Activate all Logixs that are not currently active This method is called after a configuration file is loaded.
Logix	createNewLogix(String systemName, String userName) Method to create a new Logix if the Logix does not exist Returns null if a Logix with the same systemName or userName already exists, or if there is trouble creating a new Logix.
void	deleteLogix(Logix x) Delete Logix by removing it from the manager.
void	dispose() Free resources when no longer used.
Logix	getBySystemName(String s)
Logix	getByUserName(String s)
Logix	getLogix(String name) Locate via user name, then system name if needed.
List	getSystemNameList() Get a list of all Logix system names.
void	setLoadDisabled(boolean s) Support for loading Logixs in a disabled state to debug loops

Methods inherited from interface jmri.Manager

addPropertyChangeListener, deregister, makeSystemName, register, removePropertyChangeListener, systemLetter, typeLetter

Method Detail

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

createNewLogix

Logix createNewLogix(String systemName,
                     String userName)

Method to create a new Logix if the Logix does not exist Returns null if a Logix with the same systemName or userName already exists, or if there is trouble creating a new Logix.

getLogix

Logix getLogix(String name)

Locate via user name, then system name if needed. Does not create a new one if nothing found

Parameters:

name -

Returns:

null if no match found

getByUserName

Logix getByUserName(String s)

getBySystemName

Logix getBySystemName(String s)

activateAllLogixs

void activateAllLogixs()

Activate all Logixs that are not currently active This method is called after a configuration file is loaded.

getSystemNameList

List getSystemNameList()

Get a list of all Logix system names.

Specified by:

getSystemNameList in interface Manager

deleteLogix

void deleteLogix(Logix x)

Delete Logix by removing it from the manager. The Logix must first be deactivated so it stops processing.

setLoadDisabled

void setLoadDisabled(boolean s)

Support for loading Logixs in a disabled state to debug loops