IBM
Contents Index Previous Next



Drawing Area


In the Organizer's drawing area, the files in the system and their structure are presented graphically using icons.

Presentation Modes

The Organizer can present the system information in two different ways graphically:

The user can change the amount of information and the way it is presented in the drawing area with the menu choice View Options in the View menu. See "View Options" on page 106 for more information.

Figure 10 : Indented list mode

Figure 11 : Vertical tree mode

Chapters

The chapter concept can be used to define a collection of documents. There are no restrictions on what kind of documents that may be placed in a certain chapter, or on the order of documents in a chapter; this is for the user to decide. Chapters can further be used to structure a print-out of the system included in the Organizer view. More information about this can be found in "Advanced Print Facilities" on page 357 in chapter 5, Printing Documents and Diagrams.

A chapter has a name, and possibly a number. A chapter is shown as a thick horizontal line in the drawing area, together with its number and name. A chapter symbol can be placed inside a Module, as well as inside an SDL diagram structure and a TTCN Module structure.

In addition to the line icon, it is possible to have the Organizer show the text "Chapter" ahead of the number and name; see "Icon Names and Types" on page 56.

Chapter Levels

A chapter has an associated chapter level, ranging from 0 to 4, which is reflected in the numbering of the chapter:

Numbered chapters are auto-numbered by the Organizer. The initial number for the first chapter in the drawing area can be specified. The initial level of a chapter is specified when the chapter is created, but can later be changed.

Chapter Introduction Text

A chapter can be associated with a text, which can be regarded as an introduction text to the chapter. When the chapter is included in a print-out, this text will be inserted on a separate page corresponding to the position of the chapter symbol.

The text is saved in a text file, which the chapter symbol is connected to.

Default Chapters

There is a default set of unnumbered chapters, known as the basic Organizer view, intended for different kinds of documents. This view appears when creating a new system file and contains the following chapters:

The intended use of these default chapters is described below. The default set of chapters can be changed by editing the preference Organizer*Areas.

Chapter Analysis Model

The Analysis Model chapter is intended for documents used in a system's analysis, such as Object Model and State Chart diagrams, text requirement documents, MSC, HMSC and SDL requirement diagrams, etc.

Chapter Used Files

The Used Files chapter is intended for documents that are not generated but are used, included, or imported by other documents in other chapters. Such documents may be C/C++ header files, etc.

Chapter SDL System Structure

The SDL System Structure chapter is intended for the SDL diagram structure that normally is the primary information managed by the Organizer. The diagram structure contains a strictly hierarchical view of one or more root diagrams and their substructures. Most often only one diagram structure is used (a system) with one or more package or macro structures present as separate roots in the system. A characteristic of these diagrams is that they are directly involved in the analysis/code generation process. Multiple system roots are allowed, mainly to support the possibility of running communicating simulators with graphical trace.

Chapter TTCN Test Specification

The TTCN Test Specification chapter is intended for TTCN documents used for test specifications.

Chapter Other Documents

The Other Documents chapter is intended for documents that do not fit into any of the other chapters. It may contain SDL, MSC, and HMSC diagrams, text documents, etc. that are not directly part of an SDL system and that are not related to the other document structures in the Organizer.

Structure Icons

A few special icons in the Organizer are used for showing how document icons are structured, and for specifying where they are stored in the file system by default.

In addition to the icon, it is possible to have the Organizer show the type of the structure icon textually; see "Icon Names and Types" on page 56.

Different operations are applicable to different types of icons. Double-clicking an icon is described in "Double Clicks" on page 57, and associated popup menus are described in "Pop-Up Menus" on page 171.

System File

The name of the system file. This system file could be managed as a control unit (CM group) to allow revision control of the system file in a multiuser environment.

Link File

The name of the link file.

Control Unit File

This icon designates a control unit whose contents have not yet been resolved.

Source Directory

The name of the source directory.

Target Directory

The name of the target directory.

Header File

The name of the header definition file. Note that it is possible to connect a text file to this symbol, i.e. the symbol can act as a plain text symbol.

Footer File

The name of the footer definition file. Note that it is possible to connect a text file to this symbol, i.e. the symbol can act as a plain text symbol.

Chapter

A chapter in the drawing area. A chapter can have a number and a name and may be connected to a text file.

Module

Another way to define a collection of documents, within a chapter. A module has a name but no associated file name.

More

Indicates that a number of documents are hidden in the document structure (see "Hide" on page 106). The text associated with the icon indicates the number of hidden (additional) documents, e.g. "5 More".

Bookmark

Quick access to a place in an SDL Suite diagram or document via an SDT reference or to a place on the Web via a URL.

Document Icons

To visualize the different types of documents that are present in the user's system, a large number of graphical icons are used. A unique icon is provided for every document type that is commonly used in a system. In particular, each SDL diagram type (except packages, systems, macro definitions and operators) already have a given icon (the reference symbol specified in the Z.100 recommendation).

In addition to the icon, it is possible to have the Organizer show the type of the document textually; see "Icon Names and Types" on page 56.

Different operations are applicable to different types of icons. Double clicking an icon is described in "Double Clicks" on page 57, and associated popup menus are described in "Pop-Up Menus" on page 171.

Icon Types

The list below shows the icons that may be part of a system display in the Organizer:

Object Model Diagram icons

Object Model

State Chart

SDL Diagram icons

Package

System

Block

Substructure

Process

Service

Procedure

Macro

System type

Block type

Process type

Service type

Operator

SDL Overview

MSC Diagram icons

MSC

HMSC

Text Document icons

ASN.1 Text

Build Script (see "Build Scripts" on page 2644 in chapter 56, The Cadvanced/Cbasic SDL to C Compiler)

C Header

C Import Specification

C++ Import Specification

Plain Text. Note that connecting a plain text symbol to an external synonym file (*.syn) has a special meaning. See "Update Visibility" on page 102, "Include Expression" on page 2017 in chapter 43, Using the SDL Editor and "Supplying Values of External Synonyms" on page 2242 in chapter 50, Simulating a System.

Test Script. Used by Organizer>Tools>Simulator Test to execute test cases (in the form of input history scripts *.cui) in the simulator.

SDL PR

Word Text

TTCN Document icons

Modular Test Suite

Module

Package

Test Suite

Flat View

SDL Instance icons

System instance

Block instance

Process instance

Service instance

SDL Dashed icons

Block

Process

Service

Other icons

The icon for an association or a dependency is a dashed version of the icon of the referenced document. The example to the left shows an association referencing an MSC icon.

Generic Document

Tau Workspace / Tau Project

Rhapsody Project

Index icon, representing a generated cross reference file that can be viewed in the Index Viewer.

Page (used for SDL, HMSC, State Chart, and OM diagrams)

Diagram and Document Icon States

The diagram and document icons can have different background colors indicating the state of the information entity associated with the icon. If the icon state is anything else than normal, additional information about the corresponding file is provided in the Status Bar when the icon is selected.

Normal

The normal state of the icon. Information is not modified.

All diagram and document icon types can be normal. This is also the background color used by all non-diagram/document icons.

Invalid

The connected file does not exist or is not a diagram file of the correct type. This state is only possible when connected to a file.

All diagram and document icons can be invalid.

For more information on invalid icons, see "Open" on page 60 and "The Drives Section" on page 193.

Mismatch

The SDL diagram is not referenced in the diagram file where this diagram is referenced in the Organizer, i.e. there is a SDL diagram structure mismatch between the system file and the diagram files.

This state is only possible when connected to a file. Mismatched diagrams that are unconnected are removed from the diagram structure in the Organizer.

SDL diagram icons that are not root diagrams can be mismatched.

The reason for a mismatch is that the reference symbol in the parent diagram states a diagram name different than the kernel heading in the mismatched SDL diagram.

For more information on mismatches, see "Open" on page 60 and "No Save" on page 64.

Dirty

The associated information entity is modified, but not yet saved. This state is only possible when connected to a file.

All diagram and document icons can be dirty.

Ordering

The order of root documents in a chapter is not fixed and can be changed by the user; see "Move Down" on page 183 and "Move Up" on page 183. Moving documents in the Organizer is also used for two other purposes:

However, the order in which "child" icon types to a "parent" icon appear is fixed according to the following:

  1. Page icons
  2. Association icons
  3. Dependency icons
  4. SDL Instance icons
  5. SDL Dashed icons
  6. Child diagram and document icons

The ordering of page icons is specified in the appropriate editor for the diagram/document type (see "SDL Page Order" on page 1854 in chapter 43, Using the SDL Editor, or "Diagrams and Pages" on page 1626 in chapter 39, Using Diagram Editors). The ordering of association icons, dependency icons, SDL instance icons and SDL dashed icons is fixed and cannot be changed by the user. The ordering of child diagram and document icons can also be changed.

Icon Names and Types

The names of chapters, modules and documents in the Organizer are always shown to the right of the icon.

It is possible to show the type of each icon, i.e. a text of the form "System file", "Chapter", "Module", "Object Model", "Block", etc., directly to the right of the icon (ahead of the name). For SDL diagrams, it is also possible to show the virtuality of the diagram. Both these options are available from the menu choice View Options in the View menu. See "View Options" on page 106 for more information.

If the document is not opened in an editor, the icon text is presented in a normal, plain type face. If the document is opened in an editor, the text is presented in bold face.

Double Clicks

To double click on an icon invokes a default action on the information type that the icon represents.

The menu choices and operations corresponding to the double clicks are:

Type of icon Menu choice / operation

Diagram and document icons

Edit on the selected diagram/document itself

Page icons

Edit on the selected page in the associated diagram/document

Association and Dependency icons

Edit on the diagram the link points to

SDL Instance icons and SDL Dashed icons

SDL > Type Viewer

The corresponding symbol becomes selected in the Type Viewer. A double-click on the symbol in the type viewer shows and selects the symbol in the parent SDL diagram.

Source Directory and Target Directory icons

Set Directories

System File icon

Configuration > Group File

Link File icon

Link > Link Manager

Header File and Footer File icons

Edit on the connected text file

Chapter icon

Edit on the chapter, i.e. brings up the Edit Chapter dialog for that symbol

Module icon

Edit on the module, i.e. brings up the Edit dialog for that symbol

More icon

Show Sub Symbols

Bookmark icon

Edit on the bookmark, i.e. navigate to the place specified by the associated SDT reference or URL.


http://www.ibm.com/rational
Contents Index Previous Next