index.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
	<META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=utf-8">
	<TITLE>OpenLCB: Java Prototypes Directory</TITLE>
	<META NAME="GENERATOR" CONTENT="OpenOffice.org 3.3  (Unix)">
	<META NAME="CREATED" CONTENT="0;0">
	<META NAME="CHANGEDBY" CONTENT="Bob Jacobsen">
	<META NAME="CHANGED" CONTENT="20120526;17152200">
	<META NAME="CHANGEDBY" CONTENT="Bob Jacobsen">
	<!-- $Id$ -->
	<STYLE TYPE="text/css">
	<!--
		H2.cjk { font-family: "SimSun" }
		H2.ctl { font-family: "Lucida Sans" }
		H3.cjk { font-family: "SimSun" }
		H3.ctl { font-family: "Lucida Sans" }
	-->
	</STYLE>
</HEAD>
<BODY LANG="en-US" DIR="LTR">
<H1><IMG SRC="../../web/logo-ajs-dph.png" NAME="OpenLCB" ALIGN=RIGHT WIDTH=344 HEIGHT=142 BORDER=0>OpenLCB
Proposal Java Prototypes Directory</H1>
<P>This directory contains prototype implementation(s) in Java of the
proposed OpenLCB™ specification.
</P>
<P>These are primarily intended for testing proposed algorithms, not
as a first implementation for use.
</P>
<P><A HREF="BlueGoldApplet.html">Applet demonstration</A> of
Blue/Gold configuration.
</P>
<P><A HREF="ConfigDemoApplet.html">Applet demonstration</A> of
configuration tool loading from <A HREF="sample2.xml">sample node
XML</A>.
</P>
<P>Major subdirectories:</P>
<DL>
	<DT><A HREF="src">src</A>
	</DT><DD>
	Contains OpenLCB source in the org.openlcb package, and source for
	OpenLCB CAN wire protocol in the org.openlcb.can package. The
	<a href="http://javadoc.io/doc/org.openlcb/openlcb">JavaDocs are available online</a>.</DD><DT>
	<A HREF="test">test</A>
	</DT><DD STYLE="margin-bottom: 0.5cm">
	contains test code of several types in subpackages:
	</DD></DL>
<UL>
	<LI><DD STYLE="margin-bottom: 0.5cm">
	org.openlcb – unit tests for the implementation code</DD><LI><DD STYLE="margin-bottom: 0.5cm">
	tools – various non-OpenLCB implementation for testing, including
	a small CAN segment simulator</DD><LI><DD STYLE="margin-bottom: 0.5cm">
	scenarios – tests of operation of multiple OpenLCB classes
	simulating various OpenLCB use scenarios</DD></UL>
<P>For example, <A HREF="test/scenarios/TwoBusesFiltered.java">test/scenarios/TwoBusesFiltered.java</A>
contains a scenario where two OpenLCB CAN segments are connected via
a TCP/IP link and filtering gateways. The OpenLCB implementation is
tested to make sure that P/C event reports are properly routed to
nodes needing them, event reports are not routed when not needed,
etc.</P>
<H2 CLASS="western">Building and Running</H2>
<P>Java 1.5 and Ant are the standard way to build and run this code.</P>
<PRE STYLE="margin-bottom: 0.5cm">ant run</PRE><P>
will do any needed compilations and run the complete set of tests
using the JUnit GUI.</P>
<P>To create JavaDocs in the doc/ directory,
</P>
<PRE STYLE="margin-bottom: 0.5cm">ant javadoc</PRE><P>
(The JavaDocs are kept in SVN so they can be easily
accessed
<a href="doc">from the web</a>.)</P>
<P>To create an openlcb.jar file containing the currently compiled
OpenLCB library code, and an openlcb-demo.jar file that also contains
the test and demo code, do</P>
<PRE STYLE="margin-bottom: 0.5cm">ant jars</PRE><P>
Creates the openlcb.jar and openlcb-demo.jar files from scratch,
including doing the “clean” step.</P>
<H3 CLASS="western">Prerequisites</H3>
<P>The main OpenLCB library has no pre-requisite libraries.</P>
<P>The test code uses JUnit and JDOM via lib/junit.jar and
jdom-2.0.5.jar or lib/jdom.jar respectively.</P>
<H3 CLASS="western">Packaging and Versioning</H3>
<P>For use in applications, we provide versioned Jar files containing
parts of this prototype:</P>
<P>openlcb.jar – contains the org.openlcb service classes, does not
include test or demo classes</P>
<P>openlcb-demo.jar – contains the demo code, including applets</P>
<P>Version summary information is kept in SVN and on a <A HREF="versions.html">separate
page</A>.</P>
<H2 CLASS="western">License</H2>
<P>All of the software in this directory and linked from this page is
copyrighted by its authors. You many only use it subject to its
<A HREF="../../../Licensing.html">license</A>.</P>
<P><BR><BR>
</P>
</BODY>
</HTML>