Enumeration type name prefix#

Enumeration literal prefix check

Description#

Checks if the values of a given Enumeration are prefixed with its name

The rule parameter describes a suffix to remove from the enumeration name. Default value is Type.

This enforces compliance with a specific modeling standard by ensuring that all names start with the same prefix.

The rule registers to enumeration values. It raises a violation when the name of a value does not start with the expected prefix.

Message: Enumeration literal does not start with <prefix> (Value of <enum_name>)

The prefix is computed by reading the enumeration name and removing the rule parameter value from its end.

E.g.: in an enumeration called AutopilotModeType, values are expected to start with AutopilotMode.

Rename the offending enumeration value.

N/A.