Software documentation

Development tools

Structure

Techniques and Standards

How To

Functional Info

Background Info

JMRI: Introduction to JMRI Library Structure

Because we expect to have different interfaces in the jmrix package, the JMRI tools don't directly create the interface objects they need. Rather, they ask for instances of interfaces. For interfaces in the jmri package, which might be implemented by lots of different layout types, jmri.InstanceManager satisfies these requests.

More information on how things (e.g. objects representing items on the layout) are named is available on a separate page.

More specifically:

jmri
Contains interfaces and base class implementations for the common JMRI objects. This is the basic interface to the overall JMRI library and its capabilities.
Code in the jmri package should depend on no other JMRI code, though it may depend on externals (log4j, etc.)
apps
Separate from the jmri package tree, this contains application classes and base classes that can use jmri, jmrit, and jmrix classes, along with anything else. By having this here, we break the dependency between jmrix and jmrit classes (somebody has to create the general and system-specific tool objects for an application; that dependency is from the apps package)
jmrit
Contains commonly useful tools and extensions.
It can depend on jmri.* and externals. It must not depend on jmrix.*
jmrix
Contains code that is specific to a particular external system. This includes implementations of jmri interfaces that are specific to a system, plus system-specific tools (in the long run, those could certainly be separated).
jmrix can depend on jmri and externals, but not jmrit.
util
General service classes that are _not_ user level tools.
managers
Abstract and default implementations of the various JMRI type managers, e.g. the concrete classes from the InstanceManager. It's a historical accident that these have a package of their own, rather than being rolled into jmri.implementations.
implementations
Abstract and default implementations of the jmri objects; no system specific or Swing code allowed here. These are in a separate package, rather than in jmri itself, to make the jmri package simpler to understand for people who just want to use the library.

Extensive use of Factory pattern via objects we call "Manager" objects.

Example: a Turnout

Turnouts involve:

To get a specific Turnout instance that represents something on the layout, you make a request of a TurnoutManager. This is also an interface, with a similar implementation pattern.