Package jmri.jmrix.rps
Class PollingFile
- java.lang.Object
-
- jmri.jmrit.XmlFile
-
- jmri.jmrix.rps.PollingFile
-
public class PollingFile extends XmlFile
Persist RPS polling information.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class jmri.jmrit.XmlFile
XmlFile.Validate
-
-
Field Summary
Fields Modifier and Type Field Description (package private) org.jdom2.Document
doc
(package private) org.jdom2.Element
root
-
Fields inherited from class jmri.jmrit.XmlFile
dtdLocation, xsltLocation
-
-
Constructor Summary
Constructors Constructor Description PollingFile()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static java.lang.String
defaultFilename()
static java.lang.String
defaultLocation()
void
getPollValues()
void
getTransmitters(Engine engine)
Get the transmitters from the file.void
loadFile(java.io.File f)
Read in the file, and make available for examination.void
prepare()
Initialize for writing information.void
setPoll()
void
setTransmitter(int r)
void
store(java.io.File file)
-
Methods inherited from class jmri.jmrit.XmlFile
addDefaultInfo, backupFileName, checkFile, createFileNameWithDate, dumpElement, findFile, getBuilder, getDefaultDtdLocation, getDefaultValidate, getDtdLocation, getProcessingInstructionHRef, getProcessingInstructionType, getRoot, getValidate, makeBackupFile, makeBackupFile, newDocument, newDocument, revertBackupFile, rootFromFile, rootFromInputStream, rootFromName, rootFromURL, setDefaultDtdLocation, setDefaultValidate, setDtdLocation, setValidate, userFileChooser, userFileChooser, writeXML, xmlDir
-
-
-
-
Constructor Detail
-
PollingFile
public PollingFile()
-
-
Method Detail
-
prepare
public void prepare()
Initialize for writing information.This is followed by multiple "set" calls, then a "store"
-
setPoll
public void setPoll()
-
setTransmitter
public void setTransmitter(int r)
-
store
public void store(java.io.File file) throws java.io.IOException
- Throws:
java.io.IOException
-
loadFile
public void loadFile(java.io.File f) throws org.jdom2.JDOMException, java.io.IOException
Read in the file, and make available for examination.- Parameters:
f
- the file to load.- Throws:
org.jdom2.JDOMException
- other errors.java.io.IOException
- error accessing file.
-
getPollValues
public void getPollValues()
-
getTransmitters
public void getTransmitters(Engine engine)
Get the transmitters from the file.- Parameters:
engine
- a single engine.
-
defaultLocation
public static java.lang.String defaultLocation()
-
defaultFilename
public static java.lang.String defaultFilename()
-
-