Package jmri.jmrix.rps

Class Engine

java.lang.Object

jmri.jmrix.rps.Engine

All Implemented Interfaces:

ReadingListener

public class Engine
extends Object
implements ReadingListener

Engine does basic computations of RPS system.

Holds all the alignment info. Receivers are indexed by their RPS receiver number in all cases.

Gets a reading from the Distributor and passes back a Measurement

Bound properties:

• vSound - velocity of sound, in whatever units are in use

This class maintains a collection of "Transmitter" objects representing the RPS-equipped rolling stock (usually engines) on the layout. This is an extension to the common Roster, and every entry in this class's collection must be present in the Roster.

Field Summary

Fields

Modifier and Type	Field	Description
protected static Engine	_instance
(package private) String	algorithm
(package private) boolean	bscPoll
(package private) Measurement	lastPoint
(package private) int	pollIndex
(package private) boolean	polling
(package private) int	pollingInterval
(package private) boolean	pollOutstanding
(package private) Thread	pollThread
(package private) PropertyChangeSupport	prop
(package private) Receiver[]	receivers
(package private) boolean	throttlePoll
(package private) ArrayList<Transmitter>	transmitters

Constructor Summary

Constructors

Constructor	Description
Engine()

Method Summary

Modifier and Type	Method	Description
void	addPropertyChangeListener(PropertyChangeListener p)
void	dispose()
String	getAlgorithm()
boolean	getBscPollMode()
boolean	getDirectPollMode()
int	getMaxReceiverNumber()
int	getNumTransmitters()
int	getOffset()
int	getPolledAddress()
String	getPolledID()
boolean	getPolling()
int	getPollingInterval()
Receiver	getReceiver(int i)
javax.vecmath.Point3d	getReceiverPosition(int i)
boolean	getThrottlePollMode()
Transmitter	getTransmitter(int i)
Transmitter	getTransmitterByAddress(int addr)
double	getVSound()
static Engine	instance()
void	loadAlignment(File file)
(package private) void	loadInitialTransmitters()
void	loadPollConfig(File file)
(package private) void	loadValues()
void	notify(Reading r)
void	removePropertyChangeListener(PropertyChangeListener p)
(package private) void	saveLastMeasurement(String id, Measurement m)
(package private) int	selectNextPoll()	The real core of the polling, this selects the next one to poll. -1 means none selected, try again later.
void	setAlgorithm(String algorithm)
void	setBscPollMode()
protected void	setDefaultAlignment()
void	setDirectPollMode()
protected void	setInitialAlignment()
void	setMaxReceiverNumber(int n)	Set the maximum receiver number expected.
(package private) void	setOff(int i)
void	setOffset(int offset)
(package private) void	setOn(int i)
void	setPolling(boolean polling)
void	setPollingInterval(int pollingInterval)
void	setReceiver(int address, Receiver receiver)	Set a particular receiver by address (starting at 1).
void	setReceiverPosition(int i, javax.vecmath.Point3d p)
void	setThrottlePollMode()
void	setVSound(double v)
(package private) void	startPoll()
(package private) void	stopPoll()
void	storeAlignment(File file)
void	storePollConfig(File file)
(package private) void	waitBeforeNextPoll(int pollingInterval)	Wait before sending next poll.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

lastPoint

Measurement lastPoint

receivers

Receiver[] receivers

algorithm

String algorithm

pollingInterval

int pollingInterval

polling

boolean polling

transmitters

ArrayList<Transmitter> transmitters

pollIndex

int pollIndex

bscPoll

boolean bscPoll

throttlePoll

boolean throttlePoll

pollThread

Thread pollThread

pollOutstanding

boolean pollOutstanding

_instance

protected static volatile Engine _instance

prop

PropertyChangeSupport prop

Constructor Details

Engine

public Engine()

Method Details

loadValues

void loadValues()

dispose

public void dispose()

setVSound

public void setVSound(double v)

getVSound

public double getVSound()

setOffset

public void setOffset(int offset)

getOffset

public int getOffset()

setMaxReceiverNumber

public void setMaxReceiverNumber(int n)

Set the maximum receiver number expected.

If the highest value in the hardware is 5, that's what's needed here.

Parameters:

n - max receivers.

getMaxReceiverNumber

public int getMaxReceiverNumber()

setReceiver

public void setReceiver(int address,
 Receiver receiver)

Set a particular receiver by address (starting at 1).

Parameters:

address - the receiver address.

receiver - the receiver.

getReceiver

public Receiver getReceiver(int i)

setReceiverPosition

public void setReceiverPosition(int i,
 javax.vecmath.Point3d p)

getReceiverPosition

public javax.vecmath.Point3d getReceiverPosition(int i)

setAlgorithm

public void setAlgorithm(String algorithm)

getAlgorithm

public String getAlgorithm()

notify

public void notify(Reading r)

Specified by:

notify in interface ReadingListener

saveLastMeasurement

void saveLastMeasurement(String id,
 Measurement m)

storeAlignment

public void storeAlignment(File file)
                    throws IOException

Throws:

IOException

loadAlignment

public void loadAlignment(File file)
                   throws org.jdom2.JDOMException,
IOException

Throws:

org.jdom2.JDOMException

IOException

setInitialAlignment

protected void setInitialAlignment()

setDefaultAlignment

protected void setDefaultAlignment()

setPollingInterval

public void setPollingInterval(int pollingInterval)

getPollingInterval

public int getPollingInterval()

setPolling

public void setPolling(boolean polling)

getPolling

public boolean getPolling()

loadInitialTransmitters

void loadInitialTransmitters()

storePollConfig

public void storePollConfig(File file)
                     throws IOException

Throws:

IOException

loadPollConfig

public void loadPollConfig(File file)
                    throws org.jdom2.JDOMException,
IOException

Throws:

org.jdom2.JDOMException

IOException

getTransmitterByAddress

public Transmitter getTransmitterByAddress(int addr)

getTransmitter

public Transmitter getTransmitter(int i)

getNumTransmitters

public int getNumTransmitters()

getPolledID

public String getPolledID()

getPolledAddress

public int getPolledAddress()

selectNextPoll

int selectNextPoll()

The real core of the polling, this selects the next one to poll. -1 means none selected, try again later.

Returns:

index to poll next

setBscPollMode

public void setBscPollMode()

setDirectPollMode

public void setDirectPollMode()

setThrottlePollMode

public void setThrottlePollMode()

getBscPollMode

public boolean getBscPollMode()

getThrottlePollMode

public boolean getThrottlePollMode()

getDirectPollMode

public boolean getDirectPollMode()

startPoll

void startPoll()

waitBeforeNextPoll

void waitBeforeNextPoll(int pollingInterval)
                 throws InterruptedException

Wait before sending next poll.

Waits specified time, and then checks to see if response has been returned. If not, it waits again (twice) by 1/2 the interval, then finally polls anyway.

Parameters:

pollingInterval - in milliseconds

Throws:

InterruptedException - in theory, but not in practice.

stopPoll

void stopPoll()

setOn

void setOn(int i)

setOff

void setOff(int i)

instance

public static Engine instance()

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener p)

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener p)