OOA/OOD Report Options

The Report Options dialog box is divided into the following areas:

Global Structures, Subsystems, Classes, Order of OO Elements, and Event Trace Diagrams.

By selecting options in these areas you can define the contents of reports. Use the left mouse button to switch the options on and off. Most of the options are only relevant if you are reporting on the whole OOA/OOD model, for example, the Global Structures options. Similarly the Subsystems options are only relevant if you are reporting on the whole model or on Subsystems. When you have selected the options you want, click on OK to use the new settings, or Cancel to exit without making any changes to the settings.


Global Structures

Include hierarchy.  Click on this option to include a hierarchical description of the Subsystems or Classes belonging to each Subsystem. That is, the Export Subsystems or the Export and Internal Classes in each Subsystem.

The hierarchical levels are shown by indentation. Each line is numbered and if multiple-use of information or recursion is found, the line number of the first occurrence is given.

The order of the include hierarchy is at the root alphabetical, but all objects that have a parent Subsystem are listed with their parent.

Subsystem usage hierarchy.  Click on this option to include a hierarchical description of how each Subsystem uses other parts of the OOA/OOD Model. That is Subsystems imported by each Subsystem. This is different from the local usage hierarchy for Subsystems.

The hierarchical levels are shown by indentation. Each line is numbered and if multiple-use of information or recursion is found, the line number of the first occurrence is given.

The order of the usage hierarchy is basically alphabetical (Subsystems then Classes), but each "used" object is listed with the Subsystem that uses it.

Generalizations.  Click on this option to include the Class Generalization Hierarchy, that is the Generalization Tree for the whole OOA/OOD Model.

The hierarchical levels are shown by indentation. Each line is numbered and if multiple-use of information or recursion is found, the line number of the first occurrence is given.

Associations. Click on this option to include the Class Associations and Aggregations list. This is an indented list of all Associations and Aggregations in the OOA/OOD Model.


Subsystems
Click on this option to include a list of Subsystems. The content of the list depends on the sub-options you choose. The list is either alphabetical or hierarchical, depending on the setting of the Order of OO objects option. If you choose hierarchical then the list of Subsystems and Classes is mixed.

The description of each selected Subsystem can contain the following elements.

Diagram.  Click on this option to include the Subsystem or Class Diagram of the Subsystem. The diagram cannot be included in an ASCII format report.

Source Pilot Properties.  Click on this option to include the Source Pilot Properties of the Subsystem, that is the Interface and Body Prologs and the "Suppress Code Generation" setting.

Purpose text.  Click on this option to include the purpose text of the Subsystem.

Usage and include hierarchy.  Click on this option to include the usage and include hierarchies of the Subsystem. The usage hierarchy shows how the Subsystem and its child Subsystems use other parts of the OOA/OOD model. This reflects the use-relationships (Connections) from the Subsystem to other Subsystems in the parent diagram. The include hierarchy shows the Subsystems or Classes belonging to the Subsystem and its child Subsystems. That is, the Export Subsystems or the Export or Internal Classes in each Subsystem.

Contained elements.  Click on this option to show the usage relations between the included Subsystems in Subsystem Diagrams or to show the Associations/Aggregations and Generalizations between included Classes in Class Diagrams.

Annotations. Click on this option to include the Annotations for Subsystems, including the information held in the Source Pilot Information annotation. Empty Annotations are not included.


Classes
Click on this option to include a list of Classes. The content of the list depends on the sub-options you choose. The list is either alphabetical or hierarchical, depending on the setting of the Order of OO objects option. If you choose hierarchical then the Classes are listed with their parent Subsystems, assuming you include the list of Subsystems in the report.

The description of each selected Class can contain the following elements.

Description. Click on this option to include the Class Description. This describes

the Properties of the Class, as defined in the Class Editor. That is, whether the Class is export or internal, transient or persistent, and if the Class is an abstract base Class. If the Class is not abstract it is said to concrete.

the Subsystems that include the Class, that is, the parent Subsystems.

the Subsystems that display the Class, that is, the Subsystems displaying the Class in the diagram as an Export, Internal or Import Class.

the Attributes and Operations of the Class.

Source Pilot Properties. Click on this option to include the Source Pilot Properties of the Class. That is, the list of additional include files for the class header, the list of additional include files for the class body, whether code generation is activated, and if code should be placed in separate files. The Source Pilot Properties are available from the Class Editor.

Relations to other Classes. Click on this option to include a list of the relations (Generalizations, Associations and Aggregations) to other Classes. All of the graphical and textual information describing the relations is included here, for example the multiplicity, access control and storage.

State Transition Diagram. Click on this option to include the State Transition Diagram for the Class. The diagram cannot be included in an ASCII format report.

Instances in Event Trace Diagrams.  Click on this option to include a list of the Class Objects in Event Trace Diagrams.

Annotations. Click on this option to include the Annotations for Classes, including the information held in the Source Pilot Information annotation. Empty Annotations are not included.


Order of OO objects

Click on either Alphabetical or Hierarchical.

If you select "alphabetical" the report will contain an alphabetical list of Subsystems, followed by a list of Classes.

If you select "hierarchical" the order is basically alphabetical, but all Classes and Subsystems are listed with their parent Subsystem.


Event Trace Diagrams
Click on this option to include a list of Event Trace Diagrams. The content of the list depends on the sub-options you choose. The description of each selected Event Trace Diagram can contain the following elements.

Diagram.  Click on this option to include the diagram in the report. The diagram cannot be included in an ASCII format report.

Objects and Messages. Click on this option to include a list of the Objects and Messages in the diagram. The list of Objects includes the name of the Class from which the Object is instantiated. The list of Messages includes the name of the Operation that implements the Message.

Annotations. Click on this option to include the Annotations for Event Trace Diagrams. Empty Annotations are not included.