org.vishia.fpga.testutil

Class TestSignalRecorderSet

java.lang.Object

org.vishia.fpga.testutil.TestSignalRecorderSet

public class TestSignalRecorderSet
extends java.lang.Object

This is a container class for some TestSignalRecorder for horizontal test signal outputs. Any module can have one or more TestSignalRecorder implementations. This class summarize all module recorders in a List container to need one simple calls for the test signal recording and output.

Field Summary

Fields

Modifier and Type	Field and Description
private int	lenCurr
private java.util.List<TestSignalRecorder>	recs

Constructor Summary

Constructors

Constructor and Description
TestSignalRecorderSet()

Method Summary

Modifier and Type	Method and Description
void	addSignals(int time) Add all signals to all recorders and equalizes the line length.
void	clean() Cleans all buffers in the recorders.
java.lang.StringBuilder	getLine(java.lang.String id)
void	output(java.lang.Appendable out) Outputs the lines of all registered registerRecorder(TestSignalRecorder).
void	registerRecorder(TestSignalRecorder rec) Add one recorder (usual inside a module) to this set.

Methods inherited from class java.lang.Object

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

Field Detail

recs

private java.util.List<TestSignalRecorder> recs

lenCurr

private int lenCurr

Constructor Detail

TestSignalRecorderSet

public TestSignalRecorderSet()

Method Detail

registerRecorder

public void registerRecorder(TestSignalRecorder rec)

Add one recorder (usual inside a module) to this set. Note: You can immediately instantiate the recorder on this call using example/pattern:

 this.outH = new TestSignalRecorderSet();
 this.outH.addRecorder(this.fpga.ref.ct.new TestSignals("ct"));
 

Parameters:

rec - the recorder in the module.

clean

public void clean()

Cleans all buffers in the recorders. Write only the start line information for new recording. It calls the overridden TestSignalRecorder.clean() for all registered instances with registerRecorder(TestSignalRecorder).

addSignals

public void addSignals(int time)
                throws java.io.IOException

Add all signals to all recorders and equalizes the line length. It calls the overridden TestSignalRecorder#addSignals(int, boolean) for all registered instances and regards successfully adding signals of a previos recorder to force add on following ones setting bAdd = true (second argument of TestSignalRecorderSet()addSignals(int).
After successful adding TestSignalRecorder.endSignals(int) is set for all recorders so that all lines have the same length determined by the highest return value of TestSignalRecorder#addSignals(int, boolean). It means the column position in all lines for the time related next information is the same. Expect lines which are not regarded in the zAdd return value. See example on TestSignalRecorder#addSignals(int, boolean).

Throws:

java.io.IOException

output

public void output(java.lang.Appendable out)
            throws java.io.IOException

Outputs the lines of all registered registerRecorder(TestSignalRecorder). This should be the last action of a test run. This operation can be called more as one time for different output channels, for example output to System.out and to a file.

Parameters:

out - Any appendable, for example System.out or an opened file

Throws:

java.io.IOException

getLine

public java.lang.StringBuilder getLine(java.lang.String id)