There is a set of routines that generate and write Rational Statemate predefined reports of the Reports tool, such as Tree, Property, Interface, and so on. The output contains commands for a word processor that is determined by one of the input arguments. There are different calling sequences for each type of report; the following is the general form:
In this syntax:
●
|
report_name —One of the predefined report types, such as tree .
|
●
|
file_name —A string that includes the file into which the output is written.
|
●
|
wp —A string that includes the word processor name whose commands are included in the output. The possible values for this parameter are: troff , nroff , and interleaf .
|
●
|
append —A Boolean value which when true indicates that the output is appended to the contents of the output file. This parameter also determines whether or not a page header is omitted.
|
●
|
with_header —A Boolean value which when true indicates that the set-up commands of the work processor is included in the output. These commands usually appear only once in a file to be processed by the word processor.
|
●
|
p_width —The width of the output page in characters. For Interleaf, the width is given in inches.
|
●
|
p_height - The length of the output pages in lines. For Interleaf, the length is given in inches.
|
For example, the following sequence produces a tree report:
The tree reportis produced for all elements in elist
, to a depth of 5
in the hierarchy.