5.5 Report templates

KISSsoft has a template for each calculation module in which the form and content are already assigned. These templates can be changed using any Text Editor or with the KISSsoft Report Viewer. In this way every calculation can be formatted and output customised to a specific user requirements.

5.5.1 Storage und Designations

Every report template is stored in directory <KISSDIR>. User specified designations have the Structure MMMMlsz.rpt that summarise the following dimensions:

Examples

5.5.2 Scope of Reports

The Scope, e.g. length, of the report can be defined in the Menu Report ⇒ Settings on a scale from 1 to 9 where 9 represents the complete data set and 1 for a short summary. In the report template there exists a digit at the beginning of each line between 1 and 9. This digit defines (independently of the previously mentioned setting) whether the line should be read or not.

Example: If a report length of length 5 (middle) has been chosen then all lines of the report template with 1, 2, 3, 4 or 5 at the beginning are read. Lines with 6, 7, 8 and 9 are not read.

5.5.3 Formatting

Report templates as well as completed reports are text files containing Microsoft Windows labels. Please process your reports only in Windows programs to avoid complications with symbols.

The following directions and key words are defined in the report format:

• Text that should be given out
• Comment that should not be given out
• Designations and formats of calculation variables.
• Conditional branches (IF ELSE END)
• Repeatitions (FOR-Loop)

5.5.3.1 Text formatting

KISSsoft reports are normally generated in RTF-Format. RTF recognises the following text formats:

5.5.3.2 Comments

Comment lines begin with //. Comments are ignored when generating a report.

Example

// I have changed the report text here on 13.12.95, hm
Tip diameter mm : %10.2f {sheave[0].da}

In this case, only the second line will be given out.

5.5.3.3 Calculation variables

No variables can be defined by the user (other than those used for FOR-Loop which can be named by the user and whose values can be entered; see Chapter 5.5.3.5).

Replacement character

The file type and format of a variable is given by a Replacement character:

• %i stands for a whole number
• %f stands for a floating point number
• %ν₁.ν₂f stands for a formatted floating point number with ν₁ places in total (inc. digits and decimals) and ν₂ decimal places
• %s stands for a left-justified character string (Text)
• %ns stands for a right-justified character string in a n-symbol long field (n is a whole number).

The data types must match the data types used in the program. The value will be given out exactly in the position where the replacement character stands. The Syntax of the formatting corresponds to the C/C++-Standard.

Examples:

• %10.2f is a right-justified floating point number with 10 places in the field and 2 decimal places.
• %i is a whole, unformatted number.
• %30s is a right-justified character string in a 30 symbol long field (if the number 30 was to be removed, the string would be left-justified).

Counter-Example:

• %8.2i is an invalid format because a whole number has no decimal places.
• %10f2 gives a floating point with 10 positions in its field, but the 2 decimal places are ignored and the number 2 is given as text. Floating point numbers are normally given to 6 decimal places.

Variables

The variable which should be actually given must be behind the replacement character in the same line. The variable is marked in curly brackets. If these brackets are removed then the variable name will be given as normal text.

Important: The number of the replacement characters must match the number of bracket pairings {}.

Example:

%f {sheave[0].d} gives a value for the variable sheave[0].d in the position %f as a floating point with 6 decimal places.

Basic Calculations – Output of Altered Variables

In the report, variables can be issued differently. They can be multiplied or divided as well as factors can be added or subtracted. This function is also valid in the arguments of the IF- or FOR-conditions.

Similarly, the two functions grad and rad are available for conversion into degree or radiant respectively.

angle %3.2f {grad(angle)}

Variables can be combined with each other, like {sheave[0].d-sheave[1].d}. More than two variables can be used also. Values with signs have to be put in brackets, e.g. {ZR[0].NL*(1e-6)}.

You can use the functions you find in table 5.2.

---

Function Meaning sin(angle) Sinus of angle in radians cos(angle) Cosinus of angle in radians tan(angle) Tangens of angle in radians asin(val) Arcussinus of val, returns radians acos(val) Arcuscosinus of val, returns radians atan(val) Arcustangens of val, returns radians abs(val) |val| exp(val) eval log(val) returns x in ex = val log10(val) returns x in 10x = val sqr(val) val2 sqrt(val) returns pow(x;y) returns xy sgn(val) returns sgn2(val) returns grad(angle) Conversion from radians to degree rad(angle) Conversion from degree to radians mm_in(val) returns val∕25.4 celsius_f(val) returns val + 32 min(ν1; …,ν5) returns minimum of ν1,…,ν5 max(ν1; …,ν5) returns maximum of ν1,…,ν5 and(ν1; ν2) binary and function or(ν1; ν2) binary or function xor(ν1; ν2) binary exclusive or function AND(ν1; …,ν5) logical and function OR(ν1; …; ν5) logical or function NOT(val) returns LESS(ν1; ν2) returns EQUAL(ν1; ν2) returns GREATER(ν1; ν2) returns Table 5.2: Possible functions in for calculations in the report.

---

5.5.3.4 Interrogation of Condition IF ELSE END

The interrogation of condition enables you to issue certain values or text only if a certain condition is fulfilled. The following conditions are supported:

This condition has to be written as follows:

IF (Condition) {Var}
Case 1
ELSE
Case 2
END;

Example:

IF (%i==0) {Zst.kXmnFlag}
Addendum modified      no
ELSE
Addendum modified      yes
END;

If variable Zst.kXmnFlag is 0, the first text is issued, if it is not 0, the second. Any amount of lines can stand between IF, ELSE and END. Every branch beginning on IF has to be closed by END; (Please note the semicolon after END!). The key word ELSE is optional, it reverses the condition. Branches can be interlaced up to level 9.

Example of a Simple Branch

IF (%i==1) {ZP[0].Fuss.ZFFmeth}
Calculation of the tooth form factor after method: B
END;

If variable ZP[0].Fuss.ZFFmeth is 1, a text is issued, otherwise not.

Example of Interlacing Branches

If variable z092k.vp is equal or smaller than 2.7, text 1 is issued. If not, the program checks whether z092k.vp is smaller than 12. If this is true, text 2 is issued. If it is not true, the program checks whether z092k.vp is smaller than 34. If this is true, text 3 is issued, otherwise text 4.

5.5.3.5 Loops FOR

In the KISSsoft report generator, FOR-loops can be entered, too. Within a FOR-loop a counting variable is counted up and down. You can employ up to 10 interlaced constructs.

A loop is constructed as follows:

FOR varname=%i TO %i BY %i DO {Initial value}{Final value} {Step}
// Access to variable with #varname oder $varname
...
END FOR;

• Instead of %i or %f there can also be fixed numbers (static FOR-Loop):

  FOR varname=0 TO 10 BY 1 DO
  ...
  END FOR;

• or intermingled:

  FOR varname=5 TO %i BY -1 DO {Final value}
  ...
  END FOR;

• Each FOR-Loop has to be paired with a closing END FOR; (inc. Semi-colon). Each defined counter variable (varname) inside the loop can be addressed with #varname.
• You can choose negative steps (for example -1), but never can you choose 0. The step width must always be defined.
• The #varname-condition can be used for the definition of a variable. For example:

  Number of teeth: %3.2f {ZR[#varname].z}

• The $varname-condition can be used as a character for the issue of the variable value. 0 is A, 1 is B etc. For example:

  FOR quer=0 TO 3 BY 1 DO
  Cross section $quer-$quer : %8.2f {Qu[#quer].sStatic}
  END FOR;

Example of a Simple Loop

FOR i=0 TO 10 BY 1 DO
phase number #i $i
END FOR;

This is issued as:

phase number 0 A
phase number 1 B
phase number 2 C
phase number 3 D
phase number 4 E
phase number 5 F
phase number 6 G
phase number 7 H
phase number 8 I
phase number 9 J
phase number 10 K

Within a loop, you can use any counter variables for all functions, arrays included.