REPORT
This call produces a tree report for the items in a list represented by the variablelist
to a depth of 5 in the hierarchy. The report is included in the output file.The output from the Reports tool contains formatting commands applicable to the format processor attached to the template. If no formatter is specified, the Reports tool cannot be invoked and the Documentor generates an error message.Each of the predefined reports is invoked for a list of elements. The input parameter that represents this list is denoted by a variable name that must be of typelist
of
one of the Statemate element types. This variable, along with all other identifier names used in the calling sequence, must be declared in an appropriate declaration section. For example:VARIABLE
LIST OF ACTIVITY ac_list;The identifierac_list
can be assigned a list of activities and then be included in a statement that generates a property report, as follows:stm_rpt_dictionary (ac_list,...);
The report is generated for each item in the list represented by theac_list
variable.A number of arguments are used to define the parameters for each report. Some are called “single-character string arguments,” which are used to indicate restricted parameter choices. Consider the following interface report statementstm_rpt_interface (elist, ’A’, ...);
The value of the second argument,A
, indicates that the interface report should be of typeactivities
; specifying anM
for this parameter would indicate that the report should be generated formodules
.The single-character string arguments can be more than one character, but only the first character of the string is actually passed to the Reports tool. If a non-valid character is passed to the Reports tool, the report is not generated and an error status code is returned.Some of the arguments are Boolean and are evaluated asTRUE
orFALSE
to indicate whether some parameter is set. For example, consider the following property report statement:stm_rpt_dictionary (elist, true, ...);
The Boolean constanttrue
indicates that the long description will be included in the report.
●
●
●
●
●
●
●
●
●