Package hlcd.testing.matlabChecker

Class TesterParameters

java.lang.Object
hlcd.testing.matlabChecker.TesterParameters
public class TesterParameters extends Object
A wrapper class containing the parameters needed to write a Matlab script for testing the program. This is only used in the testing package.
Since:
1.8
Version:
1.0 (February 18th, 2022)
Author:
Maysara Al Jumaily

  • Constructor Summary

    Constructors
    Constructor
    Description
    TesterParameters​(String title, byte minK, byte maxK, byte minN, byte maxN, long runs, long iterations, String path, String newDirectoryName, String scriptName, String extension)
    Initializes the object properties.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getExtension()
    The extension of the files generated (which should be .m)
    long
    getIterations()
    Returns the number of iterations which is the number of tests in a single file.
    byte
    getMaxK()
    Returns the maximum value k can be.
    byte
    getMaxN()
    Returns the maximum value n can be.
    byte
    getMinK()
    Returns the minimum value k can be.
    byte
    getMinN()
    Returns the minimum value n can be.
    String
    getNewDirectoryName()
    Returns the directory name that will be created to store the files generated into.
    String
    getPath()
    Returns the path to write the files to without appending the directory name that will be used.
    long
    getRuns()
    Returns the number of runs which is the same as the number of test files created.
    String
    getScriptName()
    Returns the name of the script file that will execute all the test files.
    String
    getTitle()
    Returns the title of the script that will be written as a comment in the Matlab script.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • TesterParameters

      public TesterParameters​(String title, byte minK, byte maxK, byte minN, byte maxN, long runs, long iterations, String path, String newDirectoryName, String scriptName, String extension)
      Initializes the object properties.
      Parameters:
      title - the title to include in the Matlab file as a comment
      minK - the minimum value \(k\) can be
      maxK - the maximum value \(k\) can be
      minN - the minimum value \(n\) can be
      maxN - the maximum value \(n\) can be
      runs - the number of runs specified (the number of test files generated)
      iterations - the number of tests in a single file generates
      path - the path to store the .m files generated
      newDirectoryName - the name of the directory to create that will be used to store all the files generated
      scriptName - the name of the script that runs all files generated
      extension - the extension of each file generated (it should be ".m")

  • Method Details

    • getPath

      public String getPath()
      Returns the path to write the files to without appending the directory name that will be used.
      Returns:
      the path to write the files to without appending the directory name that will be used

    • getNewDirectoryName

      public String getNewDirectoryName()
      Returns the directory name that will be created to store the files generated into.
      Returns:
      the directory name that will be created to store the files generated into

    • getTitle

      public String getTitle()
      Returns the title of the script that will be written as a comment in the Matlab script.
      Returns:
      the title of the script that will be written as a comment

    • getMinK

      public byte getMinK()
      Returns the minimum value k can be.
      Returns:
      the minimum value k can be

    • getMaxK

      public byte getMaxK()
      Returns the maximum value k can be.
      Returns:
      the maximum value k can be

    • getMinN

      public byte getMinN()
      Returns the minimum value n can be.
      Returns:
      the minimum value n can be

    • getMaxN

      public byte getMaxN()
      Returns the maximum value n can be.
      Returns:
      the maximum value n can be

    • getRuns

      public long getRuns()
      Returns the number of runs which is the same as the number of test files created.
      Returns:
      the number of runs which is the same as the number of test files created

    • getIterations

      public long getIterations()
      Returns the number of iterations which is the number of tests in a single file.
      Returns:
      number of iterations which is the number of tests in a single file

    • getScriptName

      public String getScriptName()
      Returns the name of the script file that will execute all the test files.
      Returns:
      the name of the script file

    • getExtension

      public String getExtension()
      The extension of the files generated (which should be .m)
      Returns:
      the extension of the files generated