Index

Classes

Name Description

Name	Description
`ACDCTerminal`	An electrical connection point (AC or DC) to a piece of conducting equipment. Terminals are connected at physical connection points called connectivity nodes.
`ACLineSegment`	A wire or combination of wires, with consistent electrical characteristics, building a single electrical system, used to carry alternating current between points in the power system. For symmetrical, transposed three phase lines, it is sufficient to use attributes of the line segment, which describe impedances and admittances for the entire length of the segment. Additionally impedances can be computed by using length and associated per length impedances. The BaseVoltage at the two ends of ACLineSegments in a Line shall have the same BaseVoltage.nominalVoltage. However, boundary lines may have slightly different BaseVoltage.nominalVoltages and variation is allowed. Larger voltage difference in general requires use of an equivalent branch.
`BaseVoltage`	Defines a system base voltage which is referenced.
`BasicIntervalSchedule`	Schedule of values at points in time.
`Bay`	A collection of power system resources (within a given substation) including conducting equipment, protection relays, measurements, and telemetry. A bay typically represents a physical grouping related to modularization of equipment.
`Breaker`	A mechanical switching device capable of making, carrying, and breaking currents under normal circuit conditions and also making, carrying for a specified time, and breaking currents under specified abnormal circuit conditions e.g. those of short circuit.
`BusbarSection`	A conductor, or group of conductors, with negligible impedance, that serve to connect other conducting equipment within a single substation. Voltage measurements are typically obtained from voltage transformers that are connected to busbar sections. A bus bar section may have many physical terminals but for analysis is modelled with exactly one logical terminal.
`ConductingEquipment`	The parts of the AC power system that are designed to carry current or that are conductively connected through terminals.
`Conductor`	Combination of conducting material with consistent electrical characteristics, building a single electrical system, used to carry current between points in the power system.
`ConnectivityNode`	Connectivity nodes are points where terminals of AC conducting equipment are connected together with zero impedance.
`ConnectivityNodeContainer`	A base class for all objects that may contain connectivity nodes or topological nodes.
`Connector`	A conductor, or group of conductors, with negligible impedance, that serve to connect other conducting equipment within a single substation and are modelled with a single logical terminal.
`DayType`	Group of similar days. For example it could be used to represent weekdays, weekend, or holidays.
`Disconnector`	A manually operated or motor operated mechanical switching device used for changing the connections in a circuit, or for isolating a circuit or equipment from a source of power. It is required to open or close circuits when negligible current is broken or made.
`EnergyArea`	Describes an area having energy production or consumption. Specializations are intended to support the load allocation function as typically required in energy management systems or planning studies to allocate hypothesized load levels to individual load points for power flow analysis. Often the energy area can be linked to both measured and forecast load levels.
`EnergyConnection`	A connection of energy generation or consumption on the power system model.
`EnergyConsumer`	Generic user of energy - a point of consumption on the power system model. EnergyConsumer.pfixed, .qfixed, .pfixedPct and .qfixedPct have meaning only if there is no LoadResponseCharacteristic associated with EnergyConsumer or if LoadResponseCharacteristic.exponentModel is set to False.
`Equipment`	The parts of a power system that are physical devices, electronic or mechanical.
`EquipmentContainer`	A modelling construct to provide a root class for containing equipment.
`Fuse`	An overcurrent protective device with a circuit opening fusible part that is heated and severed by the passage of overcurrent through it. A fuse is considered a switching device because it breaks current.
`GeographicalRegion`	A geographical region of a power system network model.
`IdentifiedObject`	This is a root class to provide common identification for all classes needing identification and naming attributes.
`Line`	Contains equipment beyond a substation belonging to a power transmission line.
`LoadArea`	The class is the root or first level in a hierarchical structure for grouping of loads for the purpose of load flow load scaling.
`LoadBreakSwitch`	A mechanical switching device capable of making, carrying, and breaking currents under normal operating conditions.
`LoadGroup`	The class is the third level in a hierarchical structure for grouping of loads for the purpose of load flow load scaling.
`NonConformLoad`	NonConformLoad represents loads that do not follow a daily load change pattern and whose changes are not correlated with the daily load change pattern.
`NonConformLoadGroup`	Loads that do not follow a daily and seasonal load variation pattern.
`NonConformLoadSchedule`	An active power (Y1-axis) and reactive power (Y2-axis) schedule (curves) versus time (X-axis) for non-conforming loads, e.g., large industrial load or power station service (where modelled).
`PowerSystemResource`	A power system resource (PSR) can be an item of equipment such as a switch, an equipment container containing many individual items of equipment such as a substation, or an organisational entity such as sub-control area. Power system resources can have measurements associated.
`PowerTransformer`	An electrical device consisting of two or more coupled windings, with or without a magnetic core, for introducing mutual coupling between electric circuits. Transformers can be used to control voltage and phase shift (active power flow). A power transformer may be composed of separate transformer tanks that need not be identical. A power transformer can be modelled with or without tanks and is intended for use in both balanced and unbalanced representations. A power transformer typically has two terminals, but may have one (grounding), three or more terminals. The inherited association ConductingEquipment.BaseVoltage should not be used. The association from TransformerEnd to BaseVoltage should be used instead.
`PowerTransformerEnd`	A PowerTransformerEnd is associated with each Terminal of a PowerTransformer. The impedance values r, r0, x, and x0 of a PowerTransformerEnd represents a star equivalent as follows. 1) for a two Terminal PowerTransformer the high voltage (TransformerEnd.endNumber=1) PowerTransformerEnd has non zero values on r, r0, x, and x0 while the low voltage (TransformerEnd.endNumber=2) PowerTransformerEnd has zero values for r, r0, x, and x0. Parameters are always provided, even if the PowerTransformerEnds have the same rated voltage. In this case, the parameters are provided at the PowerTransformerEnd which has TransformerEnd.endNumber equal to 1. 2) for a three Terminal PowerTransformer the three PowerTransformerEnds represent a star equivalent with each leg in the star represented by r, r0, x, and x0 values. 3) For a three Terminal transformer each PowerTransformerEnd shall have g, g0, b and b0 values corresponding to the no load losses distributed on the three PowerTransformerEnds. The total no load loss shunt impedances may also be placed at one of the PowerTransformerEnds, preferably the end numbered 1, having the shunt values on end 1. This is the preferred way. 4) for a PowerTransformer with more than three Terminals the PowerTransformerEnd impedance values cannot be used. Instead use the TransformerMeshImpedance or split the transformer into multiple PowerTransformers. Each PowerTransformerEnd must be contained by a PowerTransformer. Because a PowerTransformerEnd (or any other object) can not be contained by more than one parent, a PowerTransformerEnd can not have an association to an EquipmentContainer (Substation, VoltageLevel, etc).
`ProtectedSwitch`	A ProtectedSwitch is a switching device that can be operated by ProtectionEquipment.
`RatioTapChanger`	A tap changer that changes the voltage ratio impacting the voltage magnitude but not the phase angle across the transformer. Angle sign convention (general): Positive value indicates a positive phase shift from the winding where the tap is located to the other winding (for a two-winding transformer).
`RegularIntervalSchedule`	The schedule has time points where the time between them is constant.
`RegularTimePoint`	Time point for a schedule where the time between the consecutive points is constant.
`Season`	A specified time period of the year.
`SeasonDayTypeSchedule`	A time schedule covering a 24 hour period, with curve data for a specific type of season and day.
`SubGeographicalRegion`	A subset of a geographical region of a power system network model.
`SubLoadArea`	The class is the second level in a hierarchical structure for grouping of loads for the purpose of load flow load scaling.
`Substation`	A collection of equipment for purposes other than generation or utilization, through which electric energy in bulk is passed for the purposes of switching or modifying its characteristics.
`Switch`	A generic device designed to close, or open, or both, one or more electric circuits. All switches are two terminal devices including grounding switches. The ACDCTerminal.connected at the two sides of the switch shall not be considered for assessing switch connectivity, i.e. only Switch.open, .normalOpen and .locked are relevant.
`TapChanger`	Mechanism for changing transformer winding tap positions.
`Terminal`	An AC electrical connection point to a piece of conducting equipment. Terminals are connected at physical connection points called connectivity nodes.
`TransformerEnd`	A conducting connection point of a power transformer. It corresponds to a physical transformer winding terminal. In earlier CIM versions, the TransformerWinding class served a similar purpose, but this class is more flexible because it associates to terminal but is not a specialization of ConductingEquipment.
`VoltageLevel`	A collection of equipment at one common system voltage forming a switchgear. The equipment typically consists of breakers, busbars, instrumentation, control, regulation and protection devices as well as assemblies of all these.

ACDCTerminal

An electrical connection point (AC or DC) to a piece of conducting equipment. Terminals are connected at physical connection points called connectivity nodes.

ACLineSegment

A wire or combination of wires, with consistent electrical characteristics, building a single electrical system, used to carry alternating current between points in the power system. For symmetrical, transposed three phase lines, it is sufficient to use attributes of the line segment, which describe impedances and admittances for the entire length of the segment. Additionally impedances can be computed by using length and associated per length impedances. The BaseVoltage at the two ends of ACLineSegments in a Line shall have the same BaseVoltage.nominalVoltage. However, boundary lines may have slightly different BaseVoltage.nominalVoltages and variation is allowed. Larger voltage difference in general requires use of an equivalent branch.

BaseVoltage

Defines a system base voltage which is referenced.

BasicIntervalSchedule

Schedule of values at points in time.

Bay

A collection of power system resources (within a given substation) including conducting equipment, protection relays, measurements, and telemetry. A bay typically represents a physical grouping related to modularization of equipment.

Breaker

A mechanical switching device capable of making, carrying, and breaking currents under normal circuit conditions and also making, carrying for a specified time, and breaking currents under specified abnormal circuit conditions e.g. those of short circuit.

BusbarSection

A conductor, or group of conductors, with negligible impedance, that serve to connect other conducting equipment within a single substation. Voltage measurements are typically obtained from voltage transformers that are connected to busbar sections. A bus bar section may have many physical terminals but for analysis is modelled with exactly one logical terminal.

ConductingEquipment

The parts of the AC power system that are designed to carry current or that are conductively connected through terminals.

Conductor

Combination of conducting material with consistent electrical characteristics, building a single electrical system, used to carry current between points in the power system.

ConnectivityNode

Connectivity nodes are points where terminals of AC conducting equipment are connected together with zero impedance.

ConnectivityNodeContainer

A base class for all objects that may contain connectivity nodes or topological nodes.

Connector

A conductor, or group of conductors, with negligible impedance, that serve to connect other conducting equipment within a single substation and are modelled with a single logical terminal.

DayType

Group of similar days. For example it could be used to represent weekdays, weekend, or holidays.

Disconnector

A manually operated or motor operated mechanical switching device used for changing the connections in a circuit, or for isolating a circuit or equipment from a source of power. It is required to open or close circuits when negligible current is broken or made.

EnergyArea

Describes an area having energy production or consumption. Specializations are intended to support the load allocation function as typically required in energy management systems or planning studies to allocate hypothesized load levels to individual load points for power flow analysis. Often the energy area can be linked to both measured and forecast load levels.

EnergyConnection

A connection of energy generation or consumption on the power system model.

EnergyConsumer

Generic user of energy - a point of consumption on the power system model. EnergyConsumer.pfixed, .qfixed, .pfixedPct and .qfixedPct have meaning only if there is no LoadResponseCharacteristic associated with EnergyConsumer or if LoadResponseCharacteristic.exponentModel is set to False.

Equipment

The parts of a power system that are physical devices, electronic or mechanical.

EquipmentContainer

A modelling construct to provide a root class for containing equipment.

Fuse

An overcurrent protective device with a circuit opening fusible part that is heated and severed by the passage of overcurrent through it. A fuse is considered a switching device because it breaks current.

GeographicalRegion

A geographical region of a power system network model.

IdentifiedObject

This is a root class to provide common identification for all classes needing identification and naming attributes.

Line

Contains equipment beyond a substation belonging to a power transmission line.

LoadArea

The class is the root or first level in a hierarchical structure for grouping of loads for the purpose of load flow load scaling.

LoadBreakSwitch

A mechanical switching device capable of making, carrying, and breaking currents under normal operating conditions.

LoadGroup

The class is the third level in a hierarchical structure for grouping of loads for the purpose of load flow load scaling.

NonConformLoad

NonConformLoad represents loads that do not follow a daily load change pattern and whose changes are not correlated with the daily load change pattern.

NonConformLoadGroup

Loads that do not follow a daily and seasonal load variation pattern.

NonConformLoadSchedule

An active power (Y1-axis) and reactive power (Y2-axis) schedule (curves) versus time (X-axis) for non-conforming loads, e.g., large industrial load or power station service (where modelled).

PowerSystemResource

A power system resource (PSR) can be an item of equipment such as a switch, an equipment container containing many individual items of equipment such as a substation, or an organisational entity such as sub-control area. Power system resources can have measurements associated.

PowerTransformer

An electrical device consisting of two or more coupled windings, with or without a magnetic core, for introducing mutual coupling between electric circuits. Transformers can be used to control voltage and phase shift (active power flow). A power transformer may be composed of separate transformer tanks that need not be identical. A power transformer can be modelled with or without tanks and is intended for use in both balanced and unbalanced representations. A power transformer typically has two terminals, but may have one (grounding), three or more terminals. The inherited association ConductingEquipment.BaseVoltage should not be used. The association from TransformerEnd to BaseVoltage should be used instead.

PowerTransformerEnd

A PowerTransformerEnd is associated with each Terminal of a PowerTransformer. The impedance values r, r0, x, and x0 of a PowerTransformerEnd represents a star equivalent as follows. 1) for a two Terminal PowerTransformer the high voltage (TransformerEnd.endNumber=1) PowerTransformerEnd has non zero values on r, r0, x, and x0 while the low voltage (TransformerEnd.endNumber=2) PowerTransformerEnd has zero values for r, r0, x, and x0. Parameters are always provided, even if the PowerTransformerEnds have the same rated voltage. In this case, the parameters are provided at the PowerTransformerEnd which has TransformerEnd.endNumber equal to 1. 2) for a three Terminal PowerTransformer the three PowerTransformerEnds represent a star equivalent with each leg in the star represented by r, r0, x, and x0 values. 3) For a three Terminal transformer each PowerTransformerEnd shall have g, g0, b and b0 values corresponding to the no load losses distributed on the three PowerTransformerEnds. The total no load loss shunt impedances may also be placed at one of the PowerTransformerEnds, preferably the end numbered 1, having the shunt values on end 1. This is the preferred way. 4) for a PowerTransformer with more than three Terminals the PowerTransformerEnd impedance values cannot be used. Instead use the TransformerMeshImpedance or split the transformer into multiple PowerTransformers. Each PowerTransformerEnd must be contained by a PowerTransformer. Because a PowerTransformerEnd (or any other object) can not be contained by more than one parent, a PowerTransformerEnd can not have an association to an EquipmentContainer (Substation, VoltageLevel, etc).

ProtectedSwitch

A ProtectedSwitch is a switching device that can be operated by ProtectionEquipment.

RatioTapChanger

A tap changer that changes the voltage ratio impacting the voltage magnitude but not the phase angle across the transformer.

Angle sign convention (general): Positive value indicates a positive phase shift from the winding where the tap is located to the other winding (for a two-winding transformer).

RegularIntervalSchedule

The schedule has time points where the time between them is constant.

RegularTimePoint

Time point for a schedule where the time between the consecutive points is constant.

Season

A specified time period of the year.

SeasonDayTypeSchedule

A time schedule covering a 24 hour period, with curve data for a specific type of season and day.

SubGeographicalRegion

A subset of a geographical region of a power system network model.

SubLoadArea

The class is the second level in a hierarchical structure for grouping of loads for the purpose of load flow load scaling.

Substation

A collection of equipment for purposes other than generation or utilization, through which electric energy in bulk is passed for the purposes of switching or modifying its characteristics.

Switch

A generic device designed to close, or open, or both, one or more electric circuits. All switches are two terminal devices including grounding switches. The ACDCTerminal.connected at the two sides of the switch shall not be considered for assessing switch connectivity, i.e. only Switch.open, .normalOpen and .locked are relevant.

TapChanger

Mechanism for changing transformer winding tap positions.

Terminal

An AC electrical connection point to a piece of conducting equipment. Terminals are connected at physical connection points called connectivity nodes.

TransformerEnd

A conducting connection point of a power transformer. It corresponds to a physical transformer winding terminal. In earlier CIM versions, the TransformerWinding class served a similar purpose, but this class is more flexible because it associates to terminal but is not a specialization of ConductingEquipment.

VoltageLevel

A collection of equipment at one common system voltage forming a switchgear. The equipment typically consists of breakers, busbars, instrumentation, control, regulation and protection devices as well as assemblies of all these.

Types

CIM data types

Name Description

Name	Description
`ActivePower`	Product of RMS value of the voltage and the RMS value of the in-phase component of the current.
`ApparentPower`	Product of the RMS value of the voltage and the RMS value of the current.
`Conductance`	Factor by which voltage must be multiplied to give corresponding power lost from a circuit. Real part of admittance.
`CurrentFlow`	Electrical current with sign convention: positive flow is out of the conducting equipment into the connectivity node. Can be both AC and DC.
`Length`	Unit of length. It shall be a positive value or zero.
`PerCent`	Percentage on a defined base. For example, specify as 100 to indicate at the defined base.
`Reactance`	Reactance (imaginary part of impedance), at rated frequency.
`ReactivePower`	Product of RMS value of the voltage and the RMS value of the quadrature component of the current.
`Resistance`	Resistance (real part of impedance).
`Seconds`	Time, in seconds.
`Susceptance`	Imaginary part of admittance.
`Voltage`	Electrical voltage, can be both AC and DC.

ActivePower

Product of RMS value of the voltage and the RMS value of the in-phase component of the current.

ApparentPower

Product of the RMS value of the voltage and the RMS value of the current.

Conductance

Factor by which voltage must be multiplied to give corresponding power lost from a circuit. Real part of admittance.

CurrentFlow

Electrical current with sign convention: positive flow is out of the conducting equipment into the connectivity node. Can be both AC and DC.

Length

Unit of length. It shall be a positive value or zero.

PerCent

Percentage on a defined base. For example, specify as 100 to indicate at the defined base.