Package jmri

Interface BasicRosterEntry

All Known Implementing Classes:

RosterEntry

public interface BasicRosterEntry

BasicRosterEntry represents a single element in a locomotive roster, including information on how to locate it from decoder information.

This interface is to allow access to the Basic details of a Roster entry.

Primarily this only deals as a method to provide other packages with access to the information rather than being able set or create items. However access to set and get Attributes is allowed so that attributes like running duration can be recorded, with the store option also available.

This interface should probably be called RosterEntry, but this would result in another class with the same name; refactoring of that class would be a big job and would potentially cause issue with users scripts etc.

For Full read/write and creation of RosterEntries use the @link jmri.jmrit.roster.RosterEntry

All properties, including the "Attributes", are bound.

See Also:

• RosterEntry

Method Summary

Modifier and Type	Method	Description
void	addPropertyChangeListener(PropertyChangeListener l)
void	deleteAttribute(String key)
String	getAttribute(String key)
String[]	getAttributeList()
String	getDccAddress()
DccLocoAddress	getDccLocoAddress()
String	getId()
int	getMaxSpeedPCT()
String	getShuntingFunction()
boolean	isLongAddress()
boolean	isOpen()
void	putAttribute(String key, String value)
void	removePropertyChangeListener(PropertyChangeListener l)
void	setOpen(boolean boo)
org.jdom2.Element	store()	Create an XML element to represent this Entry.
String	titleString()
String	toString()

Method Details

getId

String getId()

getDccAddress

String getDccAddress()

isLongAddress

boolean isLongAddress()

getDccLocoAddress

DccLocoAddress getDccLocoAddress()

getShuntingFunction

String getShuntingFunction()

setOpen

void setOpen(boolean boo)

isOpen

boolean isOpen()

putAttribute

void putAttribute(String key,
 String value)

getAttribute

String getAttribute(String key)

deleteAttribute

void deleteAttribute(String key)

getAttributeList

String[] getAttributeList()

getMaxSpeedPCT

int getMaxSpeedPCT()

store

org.jdom2.Element store()

Create an XML element to represent this Entry. This member has to remain synchronized with the detailed schema in xml/schema/locomotive-config.xsd.

Returns:

Contents in a JDOM Element

titleString

String titleString()

toString

String toString()

Overrides:

toString in class Object

addPropertyChangeListener

void addPropertyChangeListener(PropertyChangeListener l)

removePropertyChangeListener

void removePropertyChangeListener(PropertyChangeListener l)