FREMO Interlocking: Elekdra MR - General Items - Specification

FREMO Interlocking

Elekdra MR -> General Items

23.08.2005

Specification - General

This chapter describes the general items, which are definined within the elekdra projekt.

Programming Language

The development of elekdra is started in Java. In the moment, JRE 1.4 is used. Developers may use JRE 1.5, but the compatibilitys with 1.4 has to be ensured.

Operating System

Because of the use of Java, the OS gets a second priority, but the interlocking system should work at least at Linux- and Windows Systems. Native methods should be placed in independent modules to ensure the portability.

Packages

The whole software has to be placed within one package. The package has to be named "elekdra". Logical blocks should be placed in sub-packages (e.g. elekdra.elements).

Documentation

Coding Documentation has to be done with JavaDoc. Developer Documentation has to be done at this Website.

The Language for Documentation is english. The Documentation can be translated into other languages additionaly.

Sharing

Tho share work, CVS is used. There is an existing repository at Sourceforge.

Hardware

The interface to the hardware should be a different module which communicates with the interlocking via TCP. This has the effect, that all native methods are placed in an independent module.