Default notes#

Rationale#

SCADE Suite supports the creation of notes on model elements. Notes are structured data that supplement the model.

The policy for creating notes is governed by annotation type files (ATY). These files may include instructions to automatically create default notes whenever new model elements are created. However, if this policy is defined/modified for an already-existing project, SCADE does not retroactively create notes for pre-existing model elements.

Note

For more information on notes and annotation type files, please refer to Annotation Type Files in section 1 of the SCADE Suite Technical Manual - Editor, available on Ansys Help.

Description#

This tool creates default notes for a SCADE Suite model.

It considers the annotability rules of annotation type files specified for a project to create the missing default notes for model elements.

  • Default notes are identified by the property default_note_boolean.

  • The cardinality properties min_card and max_card are ignored.

Usage#

usage: ansys_scade_ps_default_notes [-h] -p <project> [<project> ...]

Ansys SCADE Power Scripts: Create default notes for Scade models

options:
  -h, --help            show this help message and exit
  -p <project> [<project> ...], --projects <project> [<project> ...]
                        SCADE Suite projects

For example:

ansys_scade_ps_default_notes -p MyProject.etp

If you have created new N_Package and Optional note types, and have associated them with the following annotability rule:

package ::= {
    {N_Package T 0 1},
    {Remark F 0 99},
    {Design T 1 1},
    {Optional F 0 1}
}

The command outputs traces as follows:

creating N_Package note for Package::

Limitations#

  • The script does not add missing fields of existing annotations.

  • The script does not remove obsolete annotations/fields.