jmri
Interface ConsistManager

All Known Implementing Classes:

AbstractConsistManager, DccConsistManager, EasyDccConsistManager, XNetConsistManager

public interface ConsistManager

Interface for Consist Manager objects, which provide access to the existing Consists and allows for creation and destruction.

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:

Paul Bender Copyright (C) 2003

Method Summary

boolean	csConsistNeedsSeperateAddress() Does a CS consist require a seperate consist address?
String	decodeErrorCode(int ErrorCode) Translate Error Codes recieved by a consistListener into Strings
void	delConsist(DccLocoAddress address) Remove an old Consist
Consist	getConsist(DccLocoAddress address) Find a Consist with this consist address, and return it.
ArrayList<DccLocoAddress>	getConsistList() Get an ArrayList object containning the string representation of the consist addresses we know about.
boolean	isCommandStationConsistPossible() Does this implementation support Command Station Consists?

Method Detail

getConsist

Consist getConsist(DccLocoAddress address)

Find a Consist with this consist address, and return it. if the Consist doesn't exit, create it.

delConsist

void delConsist(DccLocoAddress address)

Remove an old Consist

isCommandStationConsistPossible

boolean isCommandStationConsistPossible()

Does this implementation support Command Station Consists?

csConsistNeedsSeperateAddress

boolean csConsistNeedsSeperateAddress()

Does a CS consist require a seperate consist address?

getConsistList

ArrayList<DccLocoAddress> getConsistList()

Get an ArrayList object containning the string representation of the consist addresses we know about.

decodeErrorCode

String decodeErrorCode(int ErrorCode)

Translate Error Codes recieved by a consistListener into Strings