X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=doc%2Ftoolchain.tex;h=3a6e3dc8b425dc3c07fbe400b39dccf0ea7300b8;hb=710996c40a09cd73cbab740e0842e54da04e4d4b;hp=8c9fd4df7df87be2c18bb80844afe32ed80797ce;hpb=32961a89c48a4c084283c7a8960f457a39f801be;p=fleet.git diff --git a/doc/toolchain.tex b/doc/toolchain.tex index 8c9fd4d..3a6e3dc 100644 --- a/doc/toolchain.tex +++ b/doc/toolchain.tex @@ -173,18 +173,18 @@ types. \begin{verbatim} /** a description of a ship */ -public class ShipDescription implements Iterable { +public class ShipDescription implements Iterable { public String getName(); public Iterable getConstantDescriptions(); - public Iterable getValveDescriptions(); + public Iterable getDockDescriptions(); } /** a description of a valve */ -public class ValveDescription { +public class DockDescription { public String getName(); public boolean isInbox(); public boolean isOutbox(); - public ValveDescription getShortcut(); + public DockDescription getShortcut(); } /** a constant declared by a ship */ @@ -291,8 +291,8 @@ public abstract class Ship { public ShipDescription getShipDescription(); /** return all pumps which feed this ship; order is NOT significant */ - public Iterable getValves(); - public Valve getValve(String s); + public Iterable getDocks(); + public Dock getDock(String s); /** if this is the 4th fifo ship, this method returns 4 */ public int getOrdinal(); @@ -302,17 +302,17 @@ public abstract class Ship { } \end{verbatim} -\subsection{Valve} +\subsection{Dock} \begin{verbatim} -public class Valve { +public class Dock { /** the descriptive name of this pump (relative to its ship) */ public abstract String getName(); - /** return the Ship to which this Valve belongs */ + /** return the Ship to which this Dock belongs */ public abstract Ship getShip(); - /** the maximum number of instructions we can put in the Valve instruction fifo, + /** the maximum number of instructions we can put in the Dock instruction fifo, * or Integer.MAX_VALUE if unbounded */ public abstract int getInstructionFifoLength(); @@ -322,7 +322,7 @@ public class Valve { /** returns true if this is an outbox */ public abstract boolean isOutbox(); - /** return the Valve which is the destination of this Box's shortcut (if any) */ + /** return the Dock which is the destination of this Box's shortcut (if any) */ public Destination getShortcut() { return null; } } \end{verbatim}