Package jmri.jmrix.rps

This package contains software specific to the RPS system from NAC Services, Inc.

See:
Description

Interface Summary

Calculator	Describes a specific method of calculating a measurement Information that the algorithm needs, e.g. received positions, etc, should be provided to the actual object via ctor or other initialization.
Constants	Basic constants for the RPS package and subpackages
MeasurementListener	Connect to a source of Measurements
ReadingListener	Connect to a source of Readings

Class Summary

AbstractCalculator	Some helpful implementations and values for Calculators.
ActiveFlag	Provide a flag to indicate that the system provided by this package is active.
Algorithms	Provide central access to the RPS algorithms
Analytic_AAlgorithm	Implementation of RPS location-finding using GPS equations from Sam Storm van Leeuwen , ported to Java by Norris Weimer , and ported to JMRI/RPS by Bob Jacobsen.
Ash1_0Algorithm	Implementation of 1st algorithm for reducing Readings This algorithm was provided by Robert Ashenfelter based in part on the work of Ralph Bucher in his paper "Exact Solution for Three Dimensional Hyperbolic Positioning Algorithm and Synthesizable VHDL Model for Hardware Implementation".
Ash1_1Algorithm	Implementation of version 1.1 algorithm for reducing Readings This algorithm was provided by Robert Ashenfelter based in part on the work of Ralph Bucher in his paper "Exact Solution for Three Dimensional Hyperbolic Positioning Algorithm and Synthesizable VHDL Model for Hardware Implementation".
Ash2_0Algorithm	Implementation of 2nd algorithm for reducing Readings This algorithm was provided by Robert Ashenfelter based in part on the work of Ralph Bucher in his paper "Exact Solution for Three Dimensional Hyperbolic Positioning Algorithm and Synthesizable VHDL Model for Hardware Implementation".
Ash2_1Algorithm	Implementation of 2.1th algorithm for reducing Readings This algorithm was provided by Robert Ashenfelter based in part on the work of Ralph Bucher in his paper "Exact Solution for Three Dimensional Hyperbolic Positioning Algorithm and Synthesizable VHDL Model for Hardware Implementation".
Ash2_2Algorithm	Implementation of 2.1th algorithm for reducing Readings This algorithm was provided by Robert Ashenfelter based in part on the work of Ralph Bucher in his paper "Exact Solution for Three Dimensional Hyperbolic Positioning Algorithm and Synthesizable VHDL Model for Hardware Implementation".
Distributor	Distributes Readings and the Measurements calculated from them.
Engine	Engine does basic computations of RPS system.
InitialAlgorithm	Implementation of 1st algorithm for reducing Readings This algorithm was provided by Robert Ashenfelter based in part on the work of Ralph Bucher in his paper "Exact Solution for Three Dimensional Hyperbolic Positioning Algorithm and Synthesizable VHDL Model for Hardware Implementation".
Measurement	Encodes a single measurement point for RPS Immutable
Model	Model holds RPS representation of layout geometry and logical structure.
PollingFile	Persist RPS polling information
PositionFile	Persist RPS configuration information
Reading	Encodes a single set of input values (a "reading") for RPS.
Receiver	Holds all the state information for a single receiver.
Region	Represent a region in space for the RPS system.
RpsBlock	Create a Block that can control a locomotive within a specific Block based on an RpsSensor.
RpsConnectionTypeList	Returns a list of valid lenz XpressNet Connection Types
RpsMenu	Create a "RPS" menu containing the Jmri RPS-specific tools.
RpsReporter	RPS implementation of the Reporter interface.
RpsReporterManager	RPS implementation of a ReporterManager.
RpsSensor	Extend jmri.AbstractSensor for RPS systems System names are "RSpppp", where ppp is a representation of the region, for example "RS(0,0,0);(1,0,0);(1,1,0);(0,1,0)".
RpsSensorManager	Manage the RPS-specific Sensor implementation.
Transform	Tools for geometric transformations for RPS.
Transmitter	Represents a RPS transmitter, generally a locomotive.

Package jmri.jmrix.rps Description

This package contains software specific to the RPS system from NAC Services, Inc.

Tools are provided to input (and eventually output) several layers of information:

• Raw input (Readings)
• Processed values (Measurements)
• ...

There are several pieces that do the behind the scene operation.

Distributor

There's exactly one of these. It's basic function is to handle all the computations. These include:

1. Hold the alignment and control information
2. Receive Readings
3. Distribute the Readings to anybody interested
4. Compute Measurements from them
5. Distribute the Measurements to whoever is interested

ControlPanel

There can be at most one of these, which can manually update the alignment and control information.

Monitor

Shows the Readings and Measurements as they are produced.

SerialAdapter

Connect (as configured) to a serial port and create Readings for the Distributor

Limitations

1. This provides only one computation at a time (through the Distributor), which is a bit of pain when doing comparative work.
2. The alignment contants are stored in a fixed file location in the JMRI preferences directory.

Related Documentation

For overviews, tutorials, examples, guides, and tool documentation, please see: