Marking Elements as Deprecated

In model-driven development, it's common to retain legacy elements for backward compatibility, while indicating that they should not be used for new development. The Deprecated checkbox allows you to clearly mark such elements in your model.

The Deprecated checkbox, available in the Properties view, allows you to:

• Indicate that an element is outdated.
• Prevent use in future implementations.
• Retain the element in the model for compatibility with existing code.

When set, Model RealTime stores this metadata in the model file, that is .emx file, and may reflect the deprecation in generated code.

How to Mark an Element as Deprecated

Follow the steps below to mark an element as deprecated:

1. Select the Model Element

   • In the Project Explorer, locate and select the element you wish to modify.

2. Open the Properties View

   • With the element selected, open the Properties view.
   • Navigate to the C++ General tab.

3. Enable the Deprecated Flag

   • Locate the "Deprecated" checkbox.
   • Check the box to mark the element as deprecated.
   • To remove the deprecated status, uncheck the box.

4. Save the Model

   • Save your changes to apply them to the model file.

Result in the Model File (.emx)

When an attribute is marked as deprecated, the following entry is added to the .emx file:

<CppPropertySets:GeneralAttributeProperties deprecated="true"/>

When the "Deprecated" property is unset or unchecked and reverted to default, the above entry is removed. This keeps the model file clean and minimizes unnecessary differences in version control.