edu.berkeley.fleet.api
Class Dock

Object
  extended by Dock

public abstract class Dock
extends Object

A dock on a ship

Constructor Summary
Dock(Ship ship)
           
 
Method Summary
 BitVector getConstant(String constantName)
          get a constant associated with a dock; returns null if none found
abstract  Destination getDataDestination()
          the data destination of this dock
abstract  Destination getInstructionDestination()
          the instruction destination of this dock
abstract  int getInstructionFifoSize()
          The maximum number of instructions we can put in the Dock instruction fifo, or Integer.MAX_VALUE if unbounded; note that this does not include the epilogue fifo -- that can be determined with getInstructionDestination().getFifoLength()
abstract  String getName()
          the descriptive name of this dock (relative to its ship)
abstract  Path getPath(Destination dest, BitVector signal)
          returns the Path from this dock to dest, carrying the signal specified or none if null
 Ship getShip()
          return the Ship to which this Dock belongs
abstract  boolean isInputDock()
          returns true if this is an input dock
abstract  boolean isOutputDock()
          returns true if this is an output dock
 String toString()
           
 
Methods inherited from class Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Dock

public Dock(Ship ship)
Method Detail

getShip

public Ship getShip()
return the Ship to which this Dock belongs

getName

public abstract String getName()
the descriptive name of this dock (relative to its ship)

isInputDock

public abstract boolean isInputDock()
returns true if this is an input dock

isOutputDock

public abstract boolean isOutputDock()
returns true if this is an output dock

getPath

public abstract Path getPath(Destination dest,
                             BitVector signal)
returns the Path from this dock to dest, carrying the signal specified or none if null

getDataDestination

public abstract Destination getDataDestination()
the data destination of this dock

getInstructionDestination

public abstract Destination getInstructionDestination()
the instruction destination of this dock

getInstructionFifoSize

public abstract int getInstructionFifoSize()
The maximum number of instructions we can put in the Dock instruction fifo, or Integer.MAX_VALUE if unbounded; note that this does not include the epilogue fifo -- that can be determined with getInstructionDestination().getFifoLength()

getConstant

public BitVector getConstant(String constantName)
get a constant associated with a dock; returns null if none found

toString

public String toString()
Overrides:
toString in class Object