byucc.jhdl.base
Interface HardwareInterface

All Known Subinterfaces:

WriteableHardwareInterface

All Known Implementing Classes:

GenericBoard, Tbone

public interface HardwareInterface

This interface marks a circuit that can be executed in hardware.

Method Summary

StateObject	getHardwareState(ExternallyUpdateable[] eCells, LargeExternallyUpdateable[] leCells, Checkpointable[] cCells) Returns the hardware state
java.lang.String	getModuleName() Returns the hardware module name
void	stepHardwareClock(int cycles) Steps the hardware clock

Method Detail

getModuleName

public java.lang.String getModuleName()

Returns the hardware module name

Returns:

the name of the hardware

stepHardwareClock

public void stepHardwareClock(int cycles)

Steps the hardware clock

Parameters:

cycles - How many cycles to clock

getHardwareState

public StateObject getHardwareState(ExternallyUpdateable[] eCells,
                                    LargeExternallyUpdateable[] leCells,
                                    Checkpointable[] cCells)

Returns the hardware state

Parameters:

eCells - the ExternallyUpdateable cells to look at

leCells - the LargeExternallyUpdateable cells to look at

cCells - the Checkpointable cells to look at

Returns:

the hardware state