Description of a class or an interface

 

Contents

The description of a class contains:

·         a "Description" chapter

·         an "Examples" chapter

·         collaborations

·         state machines

·         activity graphs

·         operations

·         classes (only in HTML)

·         interfaces (only in HTML)

 

Note:      Interfaces are generated in exactly the same way as classes.  However, the main title of an interface generation is  "Interface <className>" instead of "Class <className>".

 

 

The "Description" chapter

This chapter contains:

·         the name of the owner

·         the "summary" and "description" notes

·         the list of tagged values

·         stereotypes

·         the list of constraints

·         the list of parent classes (with their "summary" notes)

·         the list of classes used (with their "summary" notes)

·         class diagrams (with their "description" notes)

·         invariants

·         the list of implemented interfaces (with their "summary" notes)

·         the list of enumerates (with their "description" notes)

·         the list of types (with their "description" notes)

·         the list of received dataflows (with their "description" notes)

·         the list of sent dataflows (with their "description" notes)

·         the list of operations in syntactical form (with their "summary" notes)

·         the list of roles in syntactical form (with their "description" notes)

·         the list of attributes in syntactical form (with their "description" notes)

·         the list of classes (with their "summary" notes)

·         the list of interfaces (with their "summary" notes)

·         the list of collaborations (with their "description" notes)

·         the list of state machines (with their "description" notes)

 

 

The "Examples" chapter

This chapter contains:

·         a "Description" chapter, allowing you to display the list of instances (with their "summary" notes) and object diagrams (with their "description" notes)

·         instances

 

 

Example

 

Figure 26. Example of class generation

 

 

Generating an association

The description of an association role contains:

·         syntax

·         tagged values

·         description notes

 

The syntax of an association role contains:

·         the name of the association

·         the minimum and maximum multiplicity of the two links

·         the names of the roles of the two links

·         the name of the destination class (if the class is a class modeled in Objecteering, a hypertext link towards the file describing this class is inserted.)

 

Figure 27. Example of the generation of an association