.. index:: single: CE or diagram nature

CE or diagram nature
####################

.. rule::
   :filename: llr_or_net_nature.py
   :class: LLROrNetNature
   :id: id_0097
   :reference: TRA_REQ_002
   :tags: llr_or_net

   CE must have a design annotation

Description
===========
The Contributing Elements (CE) shall have an annotation 'DesignElement' with a property 'Nature'.
Parameter: '-t': Name of the note type (e.g.: '-t DesignElement')

.. end_description

The parameter allows defining an alternate note type name, with the following syntax:
``-t <note type name>`` (default value: ``-t DesignElement``).

This rules applies to the following elements:

* Equation set
* Text diagram
* Graphical diagram without equation sets
* State
* Transition

Rationale
=========
The note type ``DesignElement`` is expected to be designed so that the property ``Nature``
is taken into account when exporting the SCADE Contributing Elements (CE) through SCADE ALM Gateway.

* The export is easier to specify: all the CE, regardless their nature.
* The analysis of the traceability matrices is made easier by filtering the matrices with respect to this property.

Verification
============
The rule registers to the CE and raises a violation when a CE does not have a note of the specified type.

Message: ``the Contributing Element shall have an annotation <note type name>``

Resolution
==========
Create the note instance.

Notes:

* Make sure the annotation rules are specified correctly with respect to the Scade model elements considered as CE.
* Use the script ``CreateDefaultNotes.tcl`` to create all the missing note instances,
  accordingly to the annotation rules of the ``aty`` file.

Customization
=============
This rule is already a customization of the rule :ref:`CE Nature <RuleLLRNature>`.

Refer to the documentation of the instantiation of a rule for details.

.. seealso::
   * `ESEG-EN-072 SCADE Traceability`
   * :ref:`traceability`
   * Instantiation of a rule