Project

General

Profile

CIM Issues #5049

Inconsistent naming for p,q,r,x and others

Added by Herbert Falk over 2 years ago. Updated about 2 months ago.

Status:
Closed
Priority:
Normal
Author/Contact Info:
Todd Viegut
Base Release:
CIM17
Solution to be Applied To:
CIM18v10
Solution Version:
CIM18v10
Solution Applied By:
Chavdar Ivanov
Completion Date:
02/04/2024
CIM Keywords:
Breaking Change:
No
Breaking Change Description:
CIM Impacted Groups:
WG13
Requestor:
Standard(s):
Version:
Clause:
Sub-Clause:
Paragraph:
Table:
Originally Closed in Version:
Origination Date:
01/14/2020
Origination ID:
13_303
Originally Assigned To:

Description

Per CDV country comments CH_78, SE6, SE75 & NO71 for 301 Ed7:

Within the DCGround class the attribute 'r' (i.e. resistance to ground.) should be renamed to resistance so as to be consistent in other areas of the CIM such as in DCLineSegment.resistance.

There are two schools on attribute naming.

Short alias names relating to quantity names is commonly used, e.g.
  • P - active power
    . Q - reactive power
    . r - resistance
    . x - reactance
    . etc.

Verbose names describing the quantity:
. activePower
. reactivePower
. resistance
. reactance
. etc

Both are used but the alias naming is more common for p, q, r, x etc.

Having different attribute names for the same quantity increase complexity in implementations as more names must be handled for the same quantity, e.g. EnergySource.activePower and RotatingMachine.p


Proposed Solution

Proposal to rename to resistance was discussed for inclusion in CIM18.

Note that these may be breaking changes and thus why deferred to CIM 18.

It was strongly suggested that we add to our modeling guidelines guide that the same name should be used for attributes that represent the same information across all CIM classes.


Decision

14-Jan-2020 Decision to apply the proposed resolution when revving to CIM18

Oslo, 14 Jun 2023
Apply the changes following the decision in issue #6202


Release Notes

This issue is closed and no changes were applied following the final decision in ticket 6202.

Also available in: Atom PDF