org.knowrob.report_card.Generator Class Reference

List of all members.

Static Public Member Functions
static void	main (String[] args)
static String	rc (String tempPath, String trialID, String[] arguments)
static String	section (String tempPath, String section, String[] arguments)
Static Private Member Functions
static String	escapeLatexSpecialCharacters (String laText)
static String[]	latexTheStrings (String[] strings)
static String	resolveRelativePath (String strRelativePath)
Static Private Attributes
static File	sourceDir
static File	template

---

Detailed Description

Definition at line 42 of file Generator.java.

---

Member Function Documentation

static String org.knowrob.report_card.Generator.escapeLatexSpecialCharacters

(

String

laText

)

[inline, static, private]

Escapes LaTeX special characters: \ { } _ ^ # & $ % ~.

Parameters:

laText

String to be escaped

Returns:

Escaped string

Definition at line 109 of file Generator.java.

static String [] org.knowrob.report_card.Generator.latexTheStrings

(

String[]

strings

)

[inline, static, private]

Escape LaTeX special characters in all strings of the array.

Parameters:

strings

Unescaped strings

Returns:

Escaped strings

Definition at line 91 of file Generator.java.

static void org.knowrob.report_card.Generator.main

(

String[]

args

)

[inline, static]

Write hello message and check whether JLR library is accessible.

Parameters:

args	main method parameters - not used

Definition at line 55 of file Generator.java.

static String org.knowrob.report_card.Generator.rc	(	String	tempPath,
		String	trialID,
		String[]	arguments
	)		[inline, static]

Generate a report card with given sections inside specified temporary directory.

Parameters:

tempPath	Absolute path to the report card temporary directory
trialID	Trial identifier extracted from log file
arguments	Values to be substituted in the LaTeX template - absolute paths to report sections in particular

Returns:

Absolute path to the created report card

Definition at line 137 of file Generator.java.

static String org.knowrob.report_card.Generator.resolveRelativePath

(

String

strRelativePath

)

[inline, static, private]

Resolves a relative package path. Paths like `package://my_package/models` are resolved into the absolute path of the package `my_package`, plus `/models` appended.

Parameters:

strRelativePath

A package path to be unwinded

Returns:

System specific absolute path to indicated package component

Definition at line 70 of file Generator.java.

static String org.knowrob.report_card.Generator.section	(	String	tempPath,
		String	section,
		String[]	arguments
	)		[inline, static]

Generate a *simplistic flavour* report card with given substitutions in specified temporary directory.

Parameters:

fileName	Absolute path to the report card temporary directory
arguments	Values to be substituted in the LaTeX template

Returns:

Absolute path to the created report card

Definition at line 203 of file Generator.java.

---

Member Data Documentation

File org.knowrob.report_card.Generator.sourceDir [static, private]

Initial value:

 new File(resolveRelativePath("package://" +
    "report_card/report_card/tex_templates"))

Definition at line 45 of file Generator.java.

File org.knowrob.report_card.Generator.template [static, private]

Initial value:

 new File(sourceDir.getAbsolutePath() +
    File.separator + "reportCard.tex")

Definition at line 47 of file Generator.java.

---

The documentation for this class was generated from the following file:

• Generator.java