Project

General

Profile

CIM Issues #6632

update definition of deprecated

Added by Svein Olsen 12 months ago. Updated 3 months ago.

Status:
Closed
Priority:
Normal
Author/Contact Info:
Svein Olsen
Base Release:
CIM18v12
Solution to be Applied To:
CIM18v12
Solution Version:
CIM18v12
Solution Applied By:
Chavdar Ivanov
Completion Date:
09/04/2024
CIM Keywords:
61970-Core
Breaking Change:
No
Breaking Change Description:
CIM Impacted Groups:
WG13, WG14, WG16, WG21
Requestor:
Standard(s):

61970-301

Version:
Clause:
Sub-Clause:
Paragraph:
4.7.5
Table:
Originally Closed in Version:
Origination Date:
Origination ID:
Originally Assigned To:

Description

IEC 61970-301 defines <<deprecated>> as:
“4.7.5 Deprecations
The CIM model may at times contain packages, classes, attributes, or associations that have been identified as deprecated. These items will be noted in the documentation or with a UML stereotype of “deprecated”. A deprecated item is retained in the present version of the model, but is expected to be removed from future versions. An item that has not been deprecated is not guaranteed to be retained in future versions, but using an item marked as deprecated should be avoided if possible."

Proposed Solution

Propose to add the following to the definition of deprecated:
"One reason for deprecating a class, attribute or association rather than removing it, could be to allow for the use of the item in an updated profile that is updated with non-breaking changes. New profile should not use any deprecated items."

Decision

2024-03-11: Discussed in the hybrid meeting:
The text: "An item that has not been deprecated is not guaranteed to be retained in future versions, but using an item marked as deprecated should be avoided if possible." is replaced with
"An item can be removed without being tagged as deprecated in a previous version. One reason for deprecating a class, attribute or association rather than removing it, could be to allow for the use of the item a new version of an existing profile that is updated with non-breaking changes. New profile should not use any deprecated items."

The new text is:
“4.7.5 Deprecations

The CIM model may at times contain packages, classes, attributes, or associations that have been identified as deprecated. These items will be noted in the documentation or with a UML stereotype of “deprecated”. A deprecated item is retained in the present version of the model, but is expected to be removed from future versions. An item can be removed without being tagged as deprecated in a previous version. One reason for deprecating a class, attribute or association rather than removing it, could be to allow for the use of the item a new version of an existing profile that is updated with non-breaking changes. New profile should not use any deprecated items"

Release Notes

The following text was added in the 61970-301 Ed8.

"The CIM model may at times contain packages, classes, attributes, or associations that have been identified as deprecated. These items will be noted in the documentation or with a UML stereotype of “deprecated”. A deprecated item is retained in the present version of the model but is expected to be removed from future versions. An item can be removed without being tagged as deprecated in a previous version. One reason for deprecating a class, attribute or association rather than removing it, could be to allow for the use of the item a new version of an existing profile that is updated with non-breaking changes. New profile should not use any deprecated items."

Also available in: Atom PDF