byucc.jhdl.apps.Viewers.Waves
Class WavesWireManager

java.lang.Object
  byucc.jhdl.apps.Viewers.Waves.WavesWireManager

All Implemented Interfaces:

Browser, SimulatorCallback, WavesDataInterface

public class WavesWireManager

extends java.lang.Object

implements SimulatorCallback, WavesDataInterface, Browser

WavesWireManager.java This class keeps track of the wires: when wires are added or removed, etc. It also updates the wires at each cycle or step; the data is extracted from the wires and sent to the WavesDataManager. This class also provides some functionality for saving wave data and finding specified cycles for the "Go to cycle" command. This can be used in applications other than jab.

Constructor Summary

WavesWireManager()
Deprecated.

WavesWireManager(JHDLHostWidgetInterface hwi)
Constructs a new WavesWireManager--New constructor, so that this panel can pass the JHDLHostWidgetInterface to its parent to get the call chain ready to be initialized.

Method Summary

boolean	addWatch(Wire toAdd)
boolean	addWatch(Wire toAdd, java.lang.String wireName)
void	closeView() removew all watched wires and SimulatorCallback
WavesDataManager	getWavesDataManager()
boolean	isEmpty()
boolean	isWatched(java.lang.String key)
boolean	removeSelected()
void	removeWatch(java.lang.String wireName)
void	reset()
void	simulatorRefresh(int cycle, int phase) This method is called after each simulation run.
void	simulatorReset() This method will be called after the simulation has been reset.
void	simulatorUpdate(int cycle, int phase) This method is called after each simulation event.
void	update() Updates the data to keep up with the simulator, updated at each step.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WavesWireManager

public WavesWireManager()

Deprecated.

WavesWireManager

public WavesWireManager(JHDLHostWidgetInterface hwi)

Constructs a new WavesWireManager--New constructor, so that this panel can pass the JHDLHostWidgetInterface to its parent to get the call chain ready to be initialized.

Parameters:

hwi - The JHDLHostWidgetInterface this panel will send to its parent.

Method Detail

update

public void update()

Updates the data to keep up with the simulator, updated at each step.

reset

public void reset()

isEmpty

public boolean isEmpty()

addWatch

public boolean addWatch(Wire toAdd)

addWatch

public boolean addWatch(Wire toAdd,
                        java.lang.String wireName)

isWatched

public boolean isWatched(java.lang.String key)

removeSelected

public boolean removeSelected()

removeWatch

public void removeWatch(java.lang.String wireName)

closeView

public void closeView()

removew all watched wires and SimulatorCallback

simulatorRefresh

public void simulatorRefresh(int cycle,
                             int phase)

Description copied from interface: SimulatorCallback

This method is called after each simulation run. A simulation run is a multiple clock/step execution issued by a testbench or jab. For example, if the user types 'cycle 50', this callback method will be called after the completed simulation of all 50 clock cycles. Unlike the simulatorUpdate method, this method will not be called on each simulation event. This method is useful for GUIs or display widgets that only need to be updated once the simulaton has paused.

Specified by:

simulatorRefresh in interface SimulatorCallback

Parameters:

cycle - The current cycle number of the simulator. This value is the same as the value generated by the call HWSystem.getTotalClockCount().

phase - The current phase of the simulator. This value is the same as the value generated by the call HWSystem.getCurrentStepCount().

simulatorUpdate

public void simulatorUpdate(int cycle,
                            int phase)

Description copied from interface: SimulatorCallback

This method is called after each simulation event. The granularity of the event is determined by the specific Simulator within the simulate() method of the Simulator. For the single-clock simulator, this corresponds to each cycle of simulation. For the multi-clock simulator, this corresponds to each step in the clock schedule of the simulator.

Specified by:

simulatorUpdate in interface SimulatorCallback

Parameters:

cycle - The current cycle number of the simulator. This value is the same as the value generated by the call HWSystem.getTotalClockCount().

phase - The current phase of the simulator. This value is the same as the value generated by the call HWSystem.getCurrentStepCount().

simulatorReset

public void simulatorReset()

Description copied from interface: SimulatorCallback

This method will be called after the simulation has been reset. Unlike the initialize method of the Initializeable interface, this method is called after every simulator reset. This method can be used to reset variables associated with watching the progress of a simulation. Note that the cycle and phase number is reset to zero before this call is made.

Specified by:

simulatorReset in interface SimulatorCallback

getWavesDataManager

public WavesDataManager getWavesDataManager()

Specified by:

getWavesDataManager in interface WavesDataInterface