Package jmri.jmrix

Interfaces and implementations for system-specific code.

See:
Description

Interface Summary

AbstractMRListener	Interface (perhaps eventually abstract base) for Message/Reply protocol Listeners
ConnectionConfig	Definition of objects to handle configuring a layout connection.
ConnectionTypeList	Definition of objects to handle configuring a layout connection.
DccCommandStation	Defines standard operations for Dcc command stations.
Message	Basic interface for messages to and from the layout hardware
NetworkPortAdapter	Enables basic setup of a network interface for a jmrix implementation.
PortAdapter	Enables basic setup of a interface for a jmrix implementation.
SerialPortAdapter	Enables basic setup of a serial interface for a jmrix implementation.

Class Summary

AbstractConnectionConfig	Abstract base class for common implementation of the ConnectionConfig
AbstractConsistManager	An Abstract Consist Manager on top of which system specific consist managers can be built.
AbstractMessage	Add description of class here.
AbstractMonFrame	Abstact base class for Frames displaying communications monitor information
AbstractMonPane	Abstact base class for JPanels displaying communications monitor information
AbstractMRMessage	Abstract base class for messages in a message/reply protocol.
AbstractMRNodeTrafficController	Abstract Traffic Controller base class for those implementations that track a set of nodes.
AbstractMRReply	Abstract base class for replies in a message/reply protocol.
AbstractMRTrafficController	Abstract base for TrafficControllers in a Message/Reply protocol.
AbstractMRTrafficController.RcvNotifier	Internal class to remember the Reply object and destination listener with a reply is received.
AbstractMRTrafficController.XmtNotifier	Internal class to remember the Message object and destination listener when a message is queued for notification.
AbstractNetworkConnectionConfig	Abstract base class for common implementation of the ConnectionConfig
AbstractNetworkPortAdapter	Deprecated.
AbstractNetworkPortController	Enables basic setup of a network client interface for a jmrix implementation.
AbstractNode	Basic implementation of a node for JMRI protocol support.
AbstractPortController	Provide an abstract base for *PortController classes.
AbstractProgrammer	Common implementations for the Programmer interface.
AbstractSerialConnectionConfig	Abstract base class for common implementation of the ConnectionConfig
AbstractSerialPortController	Provide an abstract base for *PortController classes.
AbstractSimulatorConnectionConfig	Abstract base class for common implementation of the Simulator ConnectionConfig Currently uses the serial adapter, but this will change to the simulator adapter in due course.
AbstractThrottle	An abstract implementation of DccThrottle.
AbstractThrottleManager	Abstract implementation of a ThrottleManager.
AbstractThrottleManager.Addresses	This subClass, keeps track of which loco address have been requested and by whom, it primarily uses a increment count to keep track of all the the Addresses in use as not all external code will have been refactored over to use the new disposeThrottle.
ActiveSystemFlag	Lightweight class to check if a system is active.
ActiveSystemsMenu	Create a "Systems" menu containing as submenus the JMRI system-specific menus for available systems.
ConnectionStatus	Interface for classes that wish to get notification when the connection to the layout changes.
DCCManufacturerList	Maintains lists equipment manufacturers that JMRI Supports.
JmrixConfigPane	Provide GUI to configure communications links.
NetMessage	Represents a single general command or response.
NetworkPortFrame	Abstract base Frame to open and configure a NetworkPortAdapeter
OtherConnectionTypeList	Returns a list of valid Connection Types
SerialPortFrame	Abstract base Frame to open and configure a SerialPortAdapter
SystemConnectionMemo	Lightweight abstract class to denote that a system is active, and provide general information.
SystemsMenu	Provide a "Systems" menu containing the Jmri system-specific tools in submenus.

Exception Summary

NetworkConfigException	Represents a failure during the configuration of a serial port, typically via a NetworkPortAdapter interface.
SerialConfigException	Represents a failure during the configuration of a serial port, typically via a SerialPortAdapter interface.

Package jmri.jmrix Description

Interfaces and implementations for system-specific code.

This package provides a few interfaces and abstract implementations for the system-specific code, and serves as the parent to the system-specific packages.

We intend that this will still compile and run with any of the system-specific subpackages missing. And that might even work.

Most of the system specific code is organized as follows:

• PortController classes handle the connection to the serial port or other communications link. That code is usually in the "SsssPortController" class in the "ssss.serialdriver" package
• TrafficController classes handle the sequencing and scheduling of messages and replies through a port. The intention is that a particular system use one (or few) traffic controllers with perhaps multiple port controllers for different connections
• System-specific tools are generally given their own sub-package under the system package