Package jmri

Provides basic interfaces and certain core implementations for the JMRI layout management concepts.

See:
Description

Interface Summary

Audio	Represent an Audio, a place to store or control sound information.
AudioManager	Locate an Audio object representing some specific audio information.
CatalogTree	Represents a CatalogTree, a tree displaying a taxonomy - e.g. a file system directory, or an index of references or a table of contents built according to the user's taxonomy.
CatalogTreeManager	Locate a CatalogTree object representing some specific information.
ClockControl	ClockControl defines an interface for control of hardware Fast Clocks Each hardware system that has a hardware Fast Clock implementation must supply a module that implements this interface.
CommandStation	Represents a DCC command station.
Conditional	A Conditional is layout control logic, consisting of a logical expression and an action.
ConditionalAction	The consequent of the antecedent of the conditional proposition.
ConditionalManager	Interface for obtaining Conditionals This doesn't have a "new" method, since Conditionals are separately implemented, instead of being system-specific.
ConfigureManager	Provide load/store capabilities for general configuration.
Consist	Interface for a Consist Object, describing one or more cooperatively-operating locomotives.
ConsistListener	Allow notification of delayed consisting errors.
ConsistManager	Interface for Consist Manager objects, which provide access to the existing Consists and allows for creation and destruction.
DccThrottle	Provide DCC-specific extensions to Throttle interface.
FastClock	Provide access to fast clock capabilities in hardware or software.
Light	Represent a single visible Light on the physical layout.
LightManager	Interface for obtaining Lights.
LocoAddress	Inteface for generic Locomotive Address.
Logix	A Logix is a group of Conditionals that monitor one or more conditions (internal or on the layout).
LogixManager	Interface for obtaining Logixs This doesn't have a "new" method, since Logixs are separately implemented, instead of being system-specific.
Manager	Basic interface for access to named, managed objects.
Memory	Represent a Memory, a place to store values.
MemoryManager	Locate a Memory object representing some specific information.
ModifiedFlag	Tags objects that remember whether they've been modified and need to be (optionally) stored, for example before the program terminates or when a window closes.
NamedBean	Provides common services for classes representing objects on the layout, and allows a common form of access by their Managers.
PowerManager	Provide controls for layout power.
ProgListener	Allow notification of the completion of programming operations.
Programmer	Provide access to the hardware DCC decoder programming capability.
ProgrammerManager	Get access to available Programmer objects.
Reporter	Represent a device that can report identification information.
ReporterManager	Locate a Reporter object representing some specific device on the layout.
Route	Routes represent a collection of Turnouts that may be set at the same time.
RouteManager	Interface for obtaining Routes This doesn't have a "new" method, since Routes are separately implemented, instead of being system-specific.
Sensor	General input device representation.
SensorManager	Interface for controlling sensors.
ShutDownManager	Manage tasks to be completed when the program shuts down normally.
ShutDownTask	Execute a specific task before the program terminates.
SignalHead	Represent a single signal head.
SignalHeadManager	Interface for obtaining signal heads.
Throttle	A Throttle object can be manipulated to change the speed, direction and functions of a single locomotive.
ThrottleListener	A listener interface for a class requesting a DccThrottle from the ThrottleManager.
ThrottleManager	Interface for allocating Throttle objects.
Timebase	Provide access to clock capabilities in hardware or software.
TimeDisplay	Provide access to basic functions of a clock face, that displays time in some particular way.
Turnout	Represent a Turnout on the layout.
TurnoutManager	Locate a Turnout object representing some specific turnout on the layout.

Class Summary

Address
BeanSetting	Represent a Named Bean (e.g.
Block	Represents a particular piece of track, more informally a "Block".
BlockManager	Basic Implementation of a BlockManager.
CommonTurnoutOperation	CommonTurnoutOperation class - specialization of TurnoutOperation to contain common properties and methods for concrete subclasses
ConditionalVariable	ConditionalVariable.java The variable used in the antecedent (the 'if' part) of the Conditional.
DccConsist	This is the Default DCC consist.
DccConsistManager
DccLocoAddress	Encapsulate information for a DCC Locomotive Decoder Address.
EntryPoint	Represent an EntryPoint to a Section of track.
GuiLafConfigPane	Provide GUI to configure Swing GUI LAF defaults Provides GUI configuration for SWING LAF by displaying radiobuttons for each LAF implementation available.
InstanceManager	Provides static members for locating various interface implementations.
JmriPlugin	Method for invoking user code at startup time.
NmraPacket	Utilities for coding/decoding NMRA S&RP DCC packets.
NoFeedbackTurnoutOperation	NoFeedBackTurnoutOperation class - specialization of TurnoutOperation to provide automatic retry for a turnout with no feedback
Path	Represents a particular set of NamedBean (usually turnout) settings to put a path through trackwork to a Block.
PushbuttonPacket	Generates an NMRA packet containing the correct payload to enable or disable pushbutton lockout.
RawTurnoutOperation	RawTurnoutOperation class - specialization of TurnoutOperation to provide automatic retry for a turnout with no feedback by sending raw NMRA commands to the turnout.
Scale	Provide values and methods related to layout scale.
Section	Sections represent a group of one or more connected Blocks that may be allocated to one or more trains travelling in a given direction.
SectionManager	Basic Implementation of a SectionManager.
SensorAddress
SensorTurnoutOperation	SensorTurnoutOperation class - specialization of TurnoutOperation to provide automatic retry for a turnout with explicit feedback from sensor(s)
Transit	Class providing the basic implementation of a Transit.
TransitManager	Implementation of a Transit Manager This doesn't need an interface, since Transits are globaly implemented, instead of being system-specific.
TransitSection	This class holds information and options for a Section when assigned to a Transit.
TurnoutAddress
TurnoutOperation	Framework for automating reliable turnout operation.
TurnoutOperationManager	class to look after the collection of TurnoutOperation subclasses Unlike the other xxxManager, this does not inherit from AbstractManager since the resources it deals with are not DCC system resources but rather purely internal state
TurnoutOperator	Some (not much) common machinery for the concrete turnout operator classes.
Version	Defines a simple place to get the JMRI version string.

Exception Summary

AudioException	Specific Exception class used by Audio objects.
JmriException	Base for JMRI-specific exceptions.
ProgrammerException	Base for exceptions indicating problems in Programmer operations.
ProgReadException	Represents a failure to read when programming.
ProgWriteException	Represents a failure to write when programming.
TimebaseRateException	Thrown to indicate that a Timebase can't handle a particular rate setting that's been requested.

Package jmri Description

Provides basic interfaces and certain core implementations for the JMRI layout management concepts.

Related Documentation

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

• JMRI project overview page
• JMRI project technical info

See Also:

jmri.managers, jmri.implementation