Appendix A - Conventions Used in This Textbook

Summary

For improved readability, certain conventions are used in this book. These are the naming conventions used in this book and the conventions for message sequence numbering on interaction diagrams.

NAMING CONVENTIONS USED IN THIS BOOK

For improved readability, the conventions used for depicting names of classes, objects, and so on in the figures are sometimes different from the conventions used for the same names in the text. In the figures, examples are shown in Times New Roman font. In the body of the text, however, examples are shown in a different font to distinguish them from the regular Cambria Math font. Some specific additional conventions used in the book vary depending on the phase of the project. For example, the conventions for capitalization are different in the analysis model (which is less formal) than in the design model (which is more formal).

REQUIREMENTS MODELING

In both figures and text, use cases are shown with initial uppercase and spaces in multiword names – for example, Cook Food.

ANALYSIS MODELING

The naming conventions for the analysis model are as follows.

CLASSES

Classes are shown with an uppercase initial letter. In the figures, there are no spaces in multiword names – for example, HeatingElement. In the text, however, spacing is introduced to improve the readability – for example, Heating Element.

Attributes are shown with a lowercase initial letter – for example, weight. For multiword attributes, there are no spaces between the words in figures, but spaces are introduced in the text. The first word of the multiword name has an initial lowercase letter; subsequent words have an initial uppercase letter – for example, sensorValue in figures and sensor Value in text.

The type of the attribute has an initial uppercase letter – for example, Boolean, Integer, or Real.

OBJECTS

An object may be depicted in various ways, in particular as:

1. • An individual named object. In this case, the first letter of the first word is lowercase, and subsequent words have an uppercase first letter. In figures, the objects appear as, for example, aWarningAlarm and anotherWarningAlarm. In the text, these objects appear as a Warning Alarm and another Warning Alarm.