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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addPropertyChangeListener(java.beans.PropertyChangeListener l)
void
deleteAttribute(java.lang.String key)
java.lang.String
getAttribute(java.lang.String key)
java.lang.String[]
getAttributeList()
java.lang.String
getDccAddress()
DccLocoAddress
getDccLocoAddress()
java.lang.String
getId()
int
getMaxSpeedPCT()
java.lang.String
getShuntingFunction()
boolean
isLongAddress()
boolean
isOpen()
void
putAttribute(java.lang.String key, java.lang.String value)
void
removePropertyChangeListener(java.beans.PropertyChangeListener l)
void
setOpen(boolean boo)
org.jdom2.Element
store()
Create an XML element to represent this Entry.java.lang.String
titleString()
java.lang.String
toString()
-
-
-
Method Detail
-
getId
java.lang.String getId()
-
getDccAddress
java.lang.String getDccAddress()
-
isLongAddress
boolean isLongAddress()
-
getDccLocoAddress
DccLocoAddress getDccLocoAddress()
-
getShuntingFunction
java.lang.String getShuntingFunction()
-
setOpen
void setOpen(boolean boo)
-
isOpen
boolean isOpen()
-
putAttribute
void putAttribute(java.lang.String key, java.lang.String value)
-
getAttribute
java.lang.String getAttribute(java.lang.String key)
-
deleteAttribute
void deleteAttribute(java.lang.String key)
-
getAttributeList
java.lang.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
java.lang.String titleString()
-
toString
java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
addPropertyChangeListener
void addPropertyChangeListener(java.beans.PropertyChangeListener l)
-
removePropertyChangeListener
void removePropertyChangeListener(java.beans.PropertyChangeListener l)
-
-