User guide

While it is possible to individually reference each rule to add them to a SCADE project, a common practice is to instantiate a selection of rules in one Python script, and then register that script with the project.

This tutorial presents the basic steps to setup such a collection of rules for a SCADE Suite project. Note that a SCADE project may use several collections of rules.

Rules

Browse or search the documentation for the rules you want to use.

For example, consider the following naming rules:

• CamelCaseNaming

• PascalCaseNaming

• UpperCaseNaming

The name of the python module corresponding to a rule is derived from the pythonization of its name and category. The words are lowered and separated with _.

For example, the Python module defining the rule CamelCaseNaming, from the category Naming, is ansys.scade.design_rules.naming.camel_case_naming.

Instantiation

Each rule is implemented as a Python class. Once the rules have been identified, create a Python script that instantiates their classes. This script can be saved anywhere on your file system.

"""Example of rule instantiations."""

from ansys.scade.design_rules.naming.camel_case_naming import CamelCaseNaming
from ansys.scade.design_rules.naming.pascal_case_naming import PascalCaseNaming
from ansys.scade.design_rules.naming.upper_case_naming import UpperCaseNaming

# Instantiate the rules with default values
CamelCaseNaming()
PascalCaseNaming()
UpperCaseNaming()

Customization

The rules have default properties that can be overridden at instantiation. The following properties are available for every rule:

• id

• label

• category

• severity

• description

Refer to the section Rule Class Methods of the SCADE Suite documentation for details. Some rules allow overriding other properties, such as types or parameter. Refer to the Customization section of their documentation for details.

For example:

"""Example of rule instantiations."""

from ansys.scade.design_rules.naming.camel_case_naming import CamelCaseNaming
from ansys.scade.design_rules.naming.pascal_case_naming import PascalCaseNaming
from ansys.scade.design_rules.naming.upper_case_naming import UpperCaseNaming

# Instantiate the rules with custom ids
CamelCaseNaming(id='NAMING_01')
PascalCaseNaming(id='NAMING_02')
UpperCaseNaming(id='NAMING_03')

Rules that depend on metrics provide an additional property, usually metric_id, to specify an alternate metric.

For example:

"""Example of custom metric and rule."""

from ansys.scade.design_rules.metrics.number_of_outgoing_transitions_per_state import (
    NumberOfOutgoingTransitionsPerState,
)
from ansys.scade.design_rules.structure.maximum_outgoing_transitions_per_state import (
    MaximumOutgoingTransitionsPerState,
)

# Instantiation of a metric with a custom id
NumberOfOutgoingTransitionsPerState(id='COUNT_OUT_TRANS')
# Instantiation of a rule based on this metric, with a custom id
MaximumOutgoingTransitionsPerState(id='MAX_OUT_TRANS', metric_id='COUNT_OUT_TRANS')

Registration

Register the script as described in the section Managing Project Metrics and Rules of the SCADE Suite documentation.

Note that Ansys SCADE 2024 R2 can also access rules from installed Python packages.