Package jmri
@DefaultAnnotation({})
package jmri
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:Note: The class diagram below has been trimmed to not show some redundant (to a superpackage of a superpackage) or patterned (connecting a .configurexml package by convention) to make it more readable.
- See Also:
-
ClassDescriptionThis interface extends
IdTagto include a locomotive address.Provide access to the hardware DCC decoder programming capability.Get access to availableProgrammerobjects.Represent an analog I/O on the layout.Is the value an absolute value or a relative value?Interface for obtaining AnalogIOs.A lightweight class that provides a methods to retrieve the current JMRI application name and icon.Represent an Audio, a place to store or control sound information.Specific Exception class used by Audio objects.Locate an Audio object representing some specific audio information.An audio manager that only returns audio sources.Interface for calculating an average meter value for a meter.BasicRosterEntry represents a single element in a locomotive roster, including information on how to locate it from decoder information.Represent a NamedBean (such as a Turnout) and specific desired setting for it.Represents a particular piece of track, more informally a "Block".Basic implementation of a BlockManager.Defines a permission based on a boolean.Implementation of NamedBeanPropertyDescriptor for true/false properties.Provides standard access for resource bundles in a package.Interface for a Cab Signal Object, describing the state of the track ahead relative to a locomotive with a given address.Allow notification of changes to the cab signal list.Interface for CabSignal Manager objects, which provide access to the existing CabSignals and allows for creation and destruction.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.Leaf of a CatalogTree.Locate a CatalogTree object representing some specific information.Node of a CatalogTree.A category of something.ClockControl defines an interface for control of hardware Fast ClocksThis is an extension of a reporter device that is capable of collecting multiple reports in a collection.Provide a DCC command station's basic ability: Sending DCC packets to the rails.Specialization of TurnoutOperation to contain common properties and methods for concrete subclasses.A Conditional is layout control logic, consisting of a logical expression and an action.The consequent of the antecedent of the conditional proposition.Interface for obtaining ConditionalsThe variable used in the antecedent (the 'if' part) of the Conditional.Provide load/store capabilities for general configuration.Interface for a Consist Object, describing one or more cooperatively-operating locomotives.Allow notification of delayed consisting errors.Allow notification of changes to the consist list.Interface for Consist Manager objects, which provide access to the existing Consists and allows for creation and destruction.A listener that listens to whether the manager is enabled or disabled.Interface for marking a Meter as a Current meter.Encapsulate information for a DCC Locomotive Decoder Address.Provide DCC-specific extensions to Throttle interface.Represent a digital I/O on the layout.Interface that indicates that a class has aDisposable.dispose()method that can be called without arguments.Represent an EntryPoint to a Section of track.EnumPermission<E extends Enum<?>>Defines a permission based on an enum.ExpectedState<T,S> Record an object and its expected state within a specific scenario.Provide access to fast clock capabilities in hardware or software.Get access to availableProgrammerobjects.Interface for obtaining AverageMeters.IdTag is a pre-parsed representation of an identification message from the layout.Connect to an IdTag This file is part of JMRI.Locate an IdTag object representing a specific IdTag.Interface providing initialization of specific objects by default.Provides methods for locating various interface implementations.Interface indicating that the InstanceManager can create an object of this type when needed by a request.Provide a hint to theInstanceManagerthat this object needs have additional initialization performed after the InstanceManager initially creates it.Annotation denoting that a method or constructor may be called on any thread.Annotation denoting that a method or constructor must be called on the GUI (i.e.Annotation denoting that a method or constructor must be called on the layout thread.Base for JMRI-specific exceptions.Represent a single visible Light on the physical layout.Each LightControl object is linked to a specific Light, and provides one of the controls available for switching the Light ON/OFF in response to time or events occurring on the layout.Interface for obtaining Lights.Interface for generic Locomotive Address.A Logix is a group of Conditionals that monitor one or more conditions (internal or on the layout).Interface for obtaining LogixsBasic interface for access to named, managed objects.Manager.ManagerDataEvent<E extends NamedBean>Define an event that encapsulates changes to a list.Manager.ManagerDataListener<E extends NamedBean>Intended to be equivalent toListDataListenerwithout introducing a Swing dependency into core JMRI.Code the validity (including just as a prefix) of a proposed name string.Represent a Memory, a place to store values.Locate a Memory object representing some specific information.Meta data concerning the JMRI application.Interface for displaying (and controlling where appropriate) Current, Voltage, and other status data from the layout.Interface for obtaining Meters.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.Provides common services for classes representing objects on the layout, and allows a common form of access by their Managers.Parent class for a set of classes that describe if a user name or system name is a bad name.Display options forNamedBean.getDisplayName(DisplayOptions).NamedBeanHandle<T extends NamedBean>Utility class for managing access to a NamedBean.Instance for controlling the issuing of NamedBeanHandles.Describes metadata about a given property key for a NamedBean.This is a data structure to pass usage information from getUsageReport() requests back to the calling object.Interface that indicates that a Manager class capable of providing the next system name after the name of a given NamedBean.Utilities for coding/decoding NMRA S&RP DCC packets.NoFeedBackTurnoutOperation class - specialization of TurnoutOperation to provide automatic retry for a turnout with no feedback.Represents a particular set of NamedBean (usually turnout) settings to put a path through trackwork to a Block.Defines a permission.Factory class for Permission classes.A manager for permissions.Listener for when the JMRI user login and logout.The owner of permissions.Permissions for the Programmers.Standard permissions.A value of a permission.Implements a common way that a Reporter that supports having a Physical Location can report that location to querying objects.Provide controls for layout power.Allow notification of the completion of programming operations.Provide access to the hardware DCC decoder programming capability.A configurator for this programmer.Base for exceptions indicating problems inProgrammeroperations.Denote a single programming mode.Represents a failure to read when programming.Represents a failure to write when programming.ProvidingManager<E extends NamedBean>ProxyManager<B extends NamedBean>Interface for Managers of NamedBeans that are proxies for a collection of Managers for the same type of NamedBean.Generates an NMRA packet containing the correct payload to enable or disable pushbutton lockout.RailCom represents a RailCom enabled decoder that might be fitted to a specific piece of rolling stock to uniquely identify it.
RailCom is a registered trademark of Lenz GmbH.Locate a RailCom Object representing a specific RailCom Enabled device.
RailCom is a registered trademark of Lenz GmbH.RawTurnoutOperation class - specialization of TurnoutOperation to provide automatic retry for a turnout with no feedback by sending raw NMRA commands to the turnout.Reference<E>A reference to an object.A reference to an object where the object must not be null.This interface specifies that an object provides a report value suitable for display in an on-screen reporter.Represent a device that can report identification information.Locate a Reporter object representing some specific device on the layout.A role in the permission system.Routes represent a collection of Turnouts that may be set at the same time.Interface for obtaining Routes.Define the characteristics of a layout scale.Create a list of layout scale objects and provide retrieval methods.Sections represent a group of one or more connected Blocks that may be allocated to a train traveling in a given direction.Basic Implementation of a SectionManager.Implementation of NamedBeanPropertyDescriptor for multiple choice properties.General input device representation.Interface for controlling sensors.SensorTurnoutOperation class - specialization of TurnoutOperation to provide automatic retry for a turnout with explicit feedback from sensor(s).Manage tasks to be completed when the program shuts down normally.Execute a specific task before the program terminates.Represent a single signal, either inSignalHeadorSignalMastform.Access to signal appearance information.Signal Groups are used to represent European subsidary signals that would be sited with a signal mast.Interface for obtaining information about signal groups.Represent a single signal head.Interface for obtaining signal heads.Represent a signal mast.Generic interface for Signal Mast Logic.Interface for obtaining signal masts.A SignalSystem defines a signalling system by representing the properties of various signal aspects it contains.Interface for obtaining information about signal systems.DCC Speed Step Mode.Represent an string I/O on the layout.Interface for obtaining StringIOs.Lightweight interface denoting that a system is active, and provide general information.A Throttle object can be manipulated to change the speed, direction and functions of a single locomotive.A listener interface for a class requesting a DccThrottle from the ThrottleManager.A decision type requested from ThrottleManager to ThrottleListener, or decision made from ThrottleListener to ThrottleManagerInterface for allocatingThrottleobjects.Provide access to clock capabilities in hardware or software.Defines what to do with the fast clock when JMRI starts up.Thrown to indicate that a Timebase can't handle a particular rate setting that's been requested.Provide access to basic functions of a clock face, that displays time in some particular way.A Transit is a group of Sections representing a specified path through a layout.Implementation of a Transit ManagerThis class holds information and options for a Section when assigned to a Transit.This class holds information and options for a Action to be applied when an automated train enters, exits, or is inside of a Section in a Transit.Represent a Turnout on the layout.Locate a Turnout object representing some specific turnout on the layout.Framework for automating reliable turnout operation.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.Some (not much) common machinery for the concrete turnout operator classes.Exception thrown when the turnout's operator has changed while the operator is running.An user in the permission system.Interface for the User Preferences Manager.Interface forNamedBeanindicating that the bean may control more than one output.Represent a single visible Variable Light on the physical layout.Interface for obtaining VariableLights.Defines a simple place to get the JMRI version string.Interface for marking a Meter as a Voltage meter.