org.vishia.fpga.testutil

Class TestSignalRecorder

java.lang.Object

org.vishia.fpga.testutil.TestSignalRecorder

Direct Known Subclasses:

TestSignalRecorder.Empty, TestSignalRecorder.Time

public abstract class TestSignalRecorder
extends java.lang.Object

A base for a test signal recorder for horizontal time deterministic presentation of states. A proper derivation of this class should be implement in any module. The derivation should define some StringBuilder for output lines. The instantiation of this class should be done in the Test environment, not in the module itself (!).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TestSignalRecorder.Empty With this class a member of TestSignalRecorderSet can be built which produces a separation line.
static class	TestSignalRecorder.Time

Field Summary

Fields

Modifier and Type	Field and Description
static int	lenClean The length of the title of a line, after clean.
protected java.lang.String	moduleName Registered module name to build the line title.
protected int	pos
private java.util.List<java.lang.StringBuilder>	sbs

Constructor Summary

Constructors

Constructor and Description
TestSignalRecorder(java.lang.String moduleName) Each module with several output lines need an instance of this class.

Method Summary

Modifier and Type	Method and Description
int	addSignals(int time) Simple for with bAdd = true, see #addSignals(int, boolean)
abstract int	addSignals(int time, int lenCurr, boolean bAdd) This operation should be implemented to add the necessary signals to all existing lines which are created or cleaned in the overridden clean() and registered with registerLine(StringBuilder, String).
protected static boolean	checkLen(java.lang.StringBuilder sb, int zTime) This operation can be used to decide whether the StringBuilder has place for a new longer information, for example a bus value (hexa).
void	clean() This operation should be overridden in a kind that all buffers should be created and reseted using the registerLine(StringBuilder, String) operation.
protected void	endSignals(int pos) This operation fills all registered StringBuilder to the same length.
java.lang.StringBuilder	getLine(java.lang.String id)
void	output(java.lang.Appendable out) This operation outputs all lines.
protected void	registerLine(java.lang.StringBuilder ob, java.lang.String signaleName) Helper operation to resets one line.
abstract void	registerLines()

Methods inherited from class java.lang.Object

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

Field Detail

lenClean

public static int lenClean

The length of the title of a line, after clean.

moduleName

protected final java.lang.String moduleName

Registered module name to build the line title.

pos

protected int pos

sbs

private java.util.List<java.lang.StringBuilder> sbs

Constructor Detail

TestSignalRecorder

public TestSignalRecorder(java.lang.String moduleName)

Each module with several output lines need an instance of this class.

Parameters:

moduleName - as start for the line.

Method Detail

registerLine

protected void registerLine(java.lang.StringBuilder ob,
                            java.lang.String signaleName)

Helper operation to resets one line.

Parameters:

ob - any of the output buffer

signaleName - the signal name on start of line will be combinded with the module name of the constructor.

clean

public final void clean()

This operation should be overridden in a kind that all buffers should be created and reseted using the registerLine(StringBuilder, String) operation. Example/Template:

registerLines

public abstract void registerLines()

addSignals

public abstract int addSignals(int time,
                               int lenCurr,
                               boolean bAdd)
                        throws java.io.IOException

This operation should be implemented to add the necessary signals to all existing lines which are created or cleaned in the overridden clean() and registered with registerLine(StringBuilder, String). Usage example/pattern:

    (at)Override public int addSignals ( int time, boolean bAdd ) throws IOException {
      BlinkingLedCt mdl = BlinkingLedCt.this;
      int zCurr = this.sbCt.length(); // current length for this time
      int zAdd = 0;                   // >0 then position of new length for this time
      if(mdl.ref.clkDiv.q.ce) {       // because the own states switches only with this ce, the signals should also recorded only then.
        if(mdl.q.ctLow == 1) {        // on this condition
          this.wrCt = 5;              // switch on, write 5 steps info
        }
        if(--this.wrCt >0) {          // if one of the 5 infos shouls be written:
          StringFunctions_C.appendHex(this.sbCtLow, mdl.q.ctLow,4).append(' ');    //append info
          StringFunctions_C.appendHex(this.sbCt, mdl.q.ct,2);                      //append info
          if(checkLen(this.sbtime, zCurr)) {      // add the time information if here is space.
            StringFunctions_C.appendIntPict(this.sbtime, time, "33'331.111.11");   // append time info
          }
          zAdd = this.sbCtLow.length();  //length of buffers for new time determined by the sbCtLow, the longest entry.
        } 
        else if(this.wrCt ==0) {      // end of the 5 steps, append .... as separation
          this.sbCtLow.append("..... ");
          zAdd = this.sbCtLow.length();  //length of buffers for new time determined by the sbCtLow, the longest entry.
        }
      }// if ce
      return zAdd;       // will be used in TestSignalRecorderSet.addSignals(zAdd) to set all lines to this length
    }//addSignals
 

Here signals are only added if the ce of the other module is set. Elsewhere the operation returns 0. This is sensible because signals either changes only with this ce, or they are interesting only in ce steps.
Furthermore not in any step signals are added, only after a trigger value. And then 5 times.
Last not least a time information is added as second or millisecond presentation value.

Parameters:

time - the system time may be used for output

lenCurr - the current length of the StringBuilder lines before adding for this timestamp. This parameter can be used for checkLen(StringBuilder, int).

bAdd - true then other TestSignalsRecorders have added an information in this step time before. This information can be used to decide whether to add. But it depends on the order of registering in TestSignalRecorderSet.registerRecorder(TestSignalRecorder). If you want to use this function, this test generator is subordinate, it accepts the behavior of the recorders before delivered in the return value of this operation. If the return value of all called before addSignals(...) operation is 0, then this value is false on usage of TestSignalRecorderSet.addSignals(int).

Returns:

0 if no signal is added. Elsewhere the length of the longest yet written internal buffer.

Throws:

java.io.IOException

addSignals

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

Simple for with bAdd = true, see #addSignals(int, boolean)

Throws:

java.io.IOException

endSignals

protected void endSignals(int pos)
                   throws java.io.IOException

This operation fills all registered StringBuilder to the same length. It can be called manually, but it is automatically called for all TestSignalRecorder using the TestSignalRecorderSet.addSignals(int).

Throws:

java.io.IOException

checkLen

protected static boolean checkLen(java.lang.StringBuilder sb,
                                  int zTime)

This operation can be used to decide whether the StringBuilder has place for a new longer information, for example a bus value (hexa). See Example in #addSignals(int, boolean)

Parameters:

sb - the StringBuilder should be used for append

zTime - The length of relevant other StringBuilder lines for this time step. It is the length before writing an information to the other StringBuilder in this step time, not the position after writing as used for endSignals(int). It means it should be gathered first before fill any other buffer, see example on #addSignals(int, boolean). If the sb.length() of this StringBuilder is lesser, then firstly the content is padded with spaces to ensure the same position as given for zTime. But this is also done if endSignals(int) was called also for this buffer.

Returns:

true if there is space to add an information. The sb is not longer as zTime, and the last character is a space. false if sb is longer as the zTime position, or it does not contain at least one space for separation on the last position. It means do not write into.

output

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

This operation outputs all lines. Special function: If no lines are registered, an empty line is outputted. This can be used to structure the output.

Parameters:

out -

Throws:

java.io.IOException

getLine

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