Description of an operation

Contents

The description of an operation contains:

· a "Description" chapter

· collaborations

· state machines

· activity graphs

The "Description" chapter

This chapter contains:

· the syntax of the operation

· the redefinition of the operation

· "summary" and "description" notes

· the list of tagged values

· stereotypes

· the list of constraints

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

· the list of parameters in syntactic form and their tagged values (with their "description" notes)

· the return parameters and tagged values (with their "summary" notes)

· pre-conditions

· post-conditions

Generating the syntax

The syntax of an operation contains:

· the visibility (public, protected, private)

· the "abstract" keyword if the operation is abstract

· the "final" keyword if the operation is final

· the "class" keyword if the operation is "class"

· the name of the operation

· the syntax of the parameters

· the syntax of the return parameter

Generating a parameter's syntax

The syntax of a parameter contains:

· the parameter name

· the default value

· the passing mode (in, out, inout)

· the size if the parameter is a set

· the name of the class which types the parameter (if the class is a class modeled in Objecteering, a hypertext link towards the file which describes this class is inserted)

Example

Figure 33. Example of generating an operation