RAVENS Data Model Draft

Type: object

Type: object

Specify the versions of CIM / RAVENS used in this file

Type: object

IEC 61968 version number assigned to this UML model.

Type: string

(const=IEC61968CIM13v09) Form is IEC61968CIMXXvYY[a-z] where XX is the major CIM package version and the YY is the minor version. For example IEC61968CIM10v17a.
The letter on the version number indicates the changes are due to National Committee comments.

Type: string

(const=2016-10-31) Form is YYYY-MM-DD for example for January 5, 2009 it is 2009-01-05.

Type: object

This is the IEC 61970 CIM version number assigned to this UML model.

Type: string

Form is YYYY-MM-DD for example for January 5, 2009 it is 2009-01-05.

Type: string

Form is IEC61970CIMXXvYY where XX is the major CIM package version and the YY is the minor version. For example IEC61970CIM13v18.

Type: object

IEC 62325 version number assigned to this UML model.

Type: string

Form is YYYY-MM-DD for example for January 5, 2009 it is 2009-01-05.

Type: string

Form is IEC62325CIMXXvYY where XX is the major CIM package version and the YY is the minor version. For example IEC62325CIM10v03.

Type: object

nan

Type: object

Defines a system base voltage which is referenced.

Type: object or number

The power system resource's base voltage. Shall be a positive value and not zero.

Type: enum (of string) Default: "none"

nan

Must be one of:

  • "p"
  • "n"
  • "micro"
  • "m"
  • "c"
  • "d"
  • "k"
  • "M"
  • "G"
  • "T"
  • "none"
  • "y"
  • "z"
  • "a"
  • "f"
  • "da"
  • "h"
  • "P"
  • "E"
  • "Z"
  • "Y"

Type: enum (of string) Default: "V"

nan

Must be one of:

  • "none"
  • "m"
  • "kg"
  • "s"
  • "A"
  • "K"
  • "mol"
  • "cd"
  • "deg"
  • "rad"
  • "sr"
  • "Gy"
  • "Bq"
  • "degC"
  • "Sv"
  • "F"
  • "C"
  • "S"
  • "H"
  • "V"
  • "ohm"
  • "J"
  • "N"
  • "Hz"
  • "lx"
  • "lm"
  • "Wb"
  • "T"
  • "W"
  • "Pa"
  • "m2"
  • "m3"
  • "mPers"
  • "mPers2"
  • "m3Pers"
  • "mPerm3"
  • "kgm"
  • "kgPerm3"
  • "WPermK"
  • "JPerK"
  • "ppm"
  • "rotPers"
  • "radPers"
  • "VA"
  • "VAr"
  • "cosPhi"
  • "Vs"
  • "V2"
  • "As"
  • "A2"
  • "A2s"
  • "VAh"
  • "Wh"
  • "VArh"
  • "VPerHz"
  • "HzPers"
  • "character"
  • "charPers"
  • "kgm2"
  • "dB"
  • "WPers"
  • "lPers"
  • "dBm"
  • "h"
  • "min"
  • "Q"
  • "Qh"
  • "ohmm"
  • "APerm"
  • "V2h"
  • "A2h"
  • "Ah"
  • "count"
  • "ft3"
  • "m3Perh"
  • "gal"
  • "Btu"
  • "l"
  • "lPerh"
  • "lPerl"
  • "gPerg"
  • "molPerm3"
  • "molPermol"
  • "molPerkg"
  • "sPers"
  • "HzPerHz"
  • "VPerV"
  • "APerA"
  • "VPerVA"
  • "rev"
  • "kat"
  • "JPerkg"
  • "m3Uncompensated"
  • "m3Compensated"
  • "WPerW"
  • "therm"
  • "onePerm"
  • "m3Perkg"
  • "Pas"
  • "Nm"
  • "NPerm"
  • "radPers2"
  • "WPerm2"
  • "JPerkgK"
  • "JPerm3"
  • "VPerm"
  • "CPerm3"
  • "CPerm2"
  • "FPerm"
  • "HPerm"
  • "JPermol"
  • "JPermolK"
  • "CPerkg"
  • "GyPers"
  • "WPersr"
  • "WPerm2sr"
  • "katPerm3"
  • "d"
  • "anglemin"
  • "anglesec"
  • "ha"
  • "tonne"
  • "bar"
  • "mmHg"
  • "M"
  • "kn"
  • "Vh"
  • "Mx"
  • "G"
  • "Oe"
  • "WPerA"
  • "SPerm"
  • "onePerHz"
  • "VPerVAr"
  • "ohmPerm"
  • "kgPerJ"
  • "JPers"
  • "m2Pers"
  • "JPerm2"
  • "KPers"
  • "PaPers"

Type: number Default: null

nan

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

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

Type: array

State variable for voltage.

No Additional Items

Each item of this array must be:

Type: object

State variable for voltage.

Type: object or number

The voltage angle of the topological node complex voltage with respect to system reference.

Type: object or number

The voltage magnitude at the topological node. The attribute shall be a positive value.

Same definition as BaseVoltage.nominalVoltage

Type: enum (of string)

If specified the voltage is the line to ground voltage of the individual phase. If unspecified, then the voltage is assumed balanced.

Must be one of:

  • "A"
  • "B"
  • "C"
  • "N"
  • "s1"
  • "s2"

Type: array

The SvInjection reports the calculated bus injection minus the sum of the terminal flows. The terminal flow is positive out from the bus (load sign convention) and bus injection has positive flow into the bus. SvInjection may have the remainder after state estimation or slack after power flow calculation.

No Additional Items

Each item of this array must be:

Type: object

The SvInjection reports the calculated bus injection minus the sum of the terminal flows. The terminal flow is positive out from the bus (load sign convention) and bus injection has positive flow into the bus. SvInjection may have the remainder after state estimation or slack after power flow calculation.

Type: object or number

The active power mismatch between calculated injection and initial injection. Positive sign means injection into the TopologicalNode (bus).

Type: object or number

The reactive power mismatch between calculated injection and initial injection. Positive sign means injection into the TopologicalNode (bus).

Type: enum (of string)

The terminal phase at which the connection is applied. If missing, the injection is assumed to be balanced among non-neutral phases.

Same definition as SvVoltage.phase

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

Type: object

A geographical region of a power system network model.

Type: array

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

No Additional Items

Each item of this array must be:

Type: object

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

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

An electrically connected subset of the network. Topological islands can change as the current network state changes, e.g. due to:
- disconnect switches or breakers changing state in a SCADA/EMS.
- manual creation, change or deletion of topological nodes in a planning tool.
Only energised TopologicalNode-s shall be part of the topological island.

Type: array

For a detailed substation model a topological node is a set of connectivity nodes that, in the current network state, are connected together through any type of closed switches, including jumpers. Topological nodes change as the current network state changes (i.e., switches, breakers, etc. change state).
For a planning model, switch statuses are not used to form topological nodes. Instead they are manually created or deleted in a model builder tool. Topological nodes maintained this way are also called "busses".

No Additional Items

Each item of this array must be:

Type: object

For a detailed substation model a topological node is a set of connectivity nodes that, in the current network state, are connected together through any type of closed switches, including jumpers. Topological nodes change as the current network state changes (i.e., switches, breakers, etc. change state).
For a planning model, switch statuses are not used to form topological nodes. Instead they are manually created or deleted in a model builder tool. Topological nodes maintained this way are also called "busses".

Type: object or number

The active power injected into the bus at this location in addition to injections from equipment. Positive sign means injection into the TopologicalNode (bus).
Starting value for a steady state solution.

Same definition as SvInjection.pInjection

Type: object or number

The reactive power injected into the bus at this location in addition to injections from equipment. Positive sign means injection into the TopologicalNode (bus).
Starting value for a steady state solution.

Same definition as SvInjection.qInjection

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

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

Type: object

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.

Type: boolean

Indicates the presence/absence of energy measurements.

Type: boolean

Indicates the presence/absence of active/reactive power measurements.

Type: enum (of string)

Breaker configuration.

Must be one of:

  • "singleBreaker"
  • "breakerAndAHalf"
  • "doubleBreaker"
  • "noBreaker"

Type: enum (of string)

Busbar configuration.

Must be one of:

  • "singleBus"
  • "doubleBus"
  • "mainWithTransfer"
  • "ringBus"

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

A collection of equipment for organizational purposes, used for grouping distribution resources.
The organization a feeder does not necessarily reflect connectivity or current operation state.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

A modelling construct to provide a root class for containment of DC as well as AC equipment. The class differ from the EquipmentContaner for AC in that it may also contain DCNode-s. Hence it can contain both AC and DC equipment.

Type: enum (of string)

The operating mode of an HVDC bipole (bipolar, monopolar metallic return, etc).

Must be one of:

  • "bipolar"
  • "monopolarMetallicReturn"
  • "monopolarGroundReturn"

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

A Plant is a collection of equipment for purposes of generation.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

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

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

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.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

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.

Type: object or number

The bus bar's low voltage limit.
The limit applies to all equipment and nodes contained in a given VoltageLevel. It is not required that it is exchanged in pair with highVoltageLimit. It is preferable to use operational VoltageLimit, which prevails, if present.

Same definition as BaseVoltage.nominalVoltage

Type: object or number

The bus bar's high voltage limit.
The limit applies to all equipment and nodes contained in a given VoltageLevel. It is not required that it is exchanged in pair with lowVoltageLimit. It is preferable to use operational VoltageLimit, which prevails, if present.

Same definition as BaseVoltage.nominalVoltage

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

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.

Type: object

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

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

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

Type: object

A group of loads conforming to an allocation pattern.

Type: array

A curve of load versus time (X-axis) showing the active power values (Y1-axis) and reactive power (Y2-axis) for each unit of the period covered. This curve represents a typical pattern of load over the time period for a given day type and season.

No Additional Items

Each item of this array must be:

Type: object

A curve of load versus time (X-axis) showing the active power values (Y1-axis) and reactive power (Y2-axis) for each unit of the period covered. This curve represents a typical pattern of load over the time period for a given day type and season.

Type: object

A specified time period of the year.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: string

The time for the last time point. The value can be a time of day, not a specific date.

Type: string

The time for the first time point. The value can be a time of day, not a specific date.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

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

Type: array

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).

No Additional Items

Each item of this array must be:

Type: object

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).

Type: string

The time for the last time point. The value can be a time of day, not a specific date.

Type: string

The time for the first time point. The value can be a time of day, not a specific date.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

nan

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: object

nan

Type: enum (of string) Default: null

nan

Must be one of:

  • "AUD"
  • "CHF"
  • "AFN"
  • "AED"
  • "ALL"
  • "AMD"
  • "ANG"
  • "AOA"
  • "ARS"
  • "AWG"
  • "AZN"
  • "BAM"
  • "BBD"
  • "BDT"
  • "BGN"
  • "BHD"
  • "BIF"
  • "BMD"
  • "BND"
  • "BOB"
  • "BOV"
  • "BRL"
  • "BSD"
  • "BTN"
  • "BWP"
  • "BYR"
  • "BZD"
  • "CAD"
  • "CDF"
  • "CLF"
  • "CLP"
  • "CNY"
  • "ZAR"
  • "COP"
  • "COU"
  • "CRC"
  • "CUC"
  • "CUP"
  • "CVE"
  • "CZK"
  • "DJF"
  • "DKK"
  • "DOP"
  • "DZD"
  • "EEK"
  • "EGP"
  • "ERN"
  • "ETB"
  • "EUR"
  • "FJD"
  • "FKP"
  • "GBP"
  • "GEL"
  • "GHS"
  • "GIP"
  • "GMD"
  • "GNF"
  • "GTQ"
  • "GYD"
  • "HKD"
  • "HNL"
  • "HRK"
  • "HTG"
  • "HUF"
  • "IDR"
  • "ILS"
  • "INR"
  • "IQD"
  • "IRR"
  • "ISK"
  • "JMD"
  • "JOD"
  • "JPY"
  • "KES"
  • "KGS"
  • "KHR"
  • "KMF"
  • "KPW"
  • "KRW"
  • "KWD"
  • "KYD"
  • "KZT"
  • "LAK"
  • "LBP"
  • "LKR"
  • "LRD"
  • "LSL"
  • "LTL"
  • "LVL"
  • "LYD"
  • "MAD"
  • "MDL"
  • "MGA"
  • "MKD"
  • "MMK"
  • "MNT"
  • "MOP"
  • "MRO"
  • "MUR"
  • "MVR"
  • "MWK"
  • "MXN"
  • "MYR"
  • "MZN"
  • "NAD"
  • "NGN"
  • "NIO"
  • "NOK"
  • "NPR"
  • "NZD"
  • "OMR"
  • "PAB"
  • "PEN"
  • "PGK"
  • "PHP"
  • "PKR"
  • "PLN"
  • "PYG"
  • "QAR"
  • "RON"
  • "RSD"
  • "RUB"
  • "RWF"
  • "SAR"
  • "SBD"
  • "SCR"
  • "SDG"
  • "SEK"
  • "SGD"
  • "SHP"
  • "SLL"
  • "SOS"
  • "SRD"
  • "STD"
  • "SYP"
  • "SZL"
  • "THB"
  • "TJS"
  • "TMT"
  • "TND"
  • "TOP"
  • "TRY"
  • "TTD"
  • "TWD"
  • "TZS"
  • "UAH"
  • "UGX"
  • "USD"
  • "UYU"
  • "UZS"
  • "VEF"
  • "VND"
  • "VUV"
  • "WST"
  • "XAF"
  • "XCD"
  • "XOF"
  • "XPF"
  • "YER"
  • "ZMK"
  • "ZWL"

Type: number Default: null

nan

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

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.

Type: object

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

Type: object

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

Type: object

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

Type: object

A type of conducting equipment that can regulate a quantity (i.e. voltage or flow) at a specific point in the network.

Type: object

A connection to the AC network for energy production or consumption that uses power electronics rather than rotating machines.

Type: array

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

No Additional Items

Each item of this array must be:

Type: object

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

Type: boolean

The connected status is related to a bus-branch model and the topological node to terminal relation. True implies the terminal is connected to the related topological node and false implies it is not.
In a bus-branch model, the connected status is used to tell if equipment is disconnected without having to change the connectivity described by the topological node to terminal relation. A valid case is that conducting equipment can be connected in one end and open in the other. In particular for an AC line segment, where the reactive line charging can be significant, this is a relevant case.

Type: enum (of string)

Represents the normal network phasing condition. If the attribute is missing, three phases (ABC) shall be assumed, except for terminals of grounding classes (specializations of EarthFaultCompensator, GroundDisconnector, and Ground) which will be assumed to be N. Therefore, phase code ABCN is explicitly declared when needed, e.g. for star point grounding equipment.
The phase code on terminals connecting same ConnectivityNode or same TopologicalNode as well as for equipment between two terminals shall be consistent.

Must be one of:

  • "ABCN"
  • "ABC"
  • "ABN"
  • "ACN"
  • "BCN"
  • "AB"
  • "AC"
  • "BC"
  • "AN"
  • "BN"
  • "CN"
  • "A"
  • "B"
  • "C"
  • "N"
  • "s1N"
  • "s2N"
  • "s12N"
  • "s1"
  • "s2"
  • "s12"
  • "none"
  • "X"
  • "XY"
  • "XN"
  • "XYN"

Type: integer

The orientation of the terminal connections for a multiple terminal conducting equipment. The sequence numbering starts with 1 and additional terminals should follow in increasing order. The first terminal is the "starting point" for a two terminal branch.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

A generating unit or battery or aggregation that connects to the AC network using power electronics rather than rotating machines.

Type: object

An electrochemical energy storage device.

Type: object or number

Amount of energy currently stored. The attribute shall be a positive value or zero and lower than BatteryUnit.ratedE.

Same definition as BatteryUnit.ratedE

Type: boolean

The aggregate flag provides an alternative way of representing an aggregated (equivalent) element. It is applicable in cases when the dedicated classes for equivalent equipment do not have all of the attributes necessary to represent the required level of detail. In case the flag is set to “true” the single instance of equipment represents multiple pieces of equipment that have been modelled together as an aggregate equivalent obtained by a network reduction procedure. Examples would be power transformers or synchronous machines operating in parallel modelled as a single aggregate power transformer or aggregate synchronous machine.
The attribute is not used for EquivalentBranch, EquivalentShunt and EquivalentInjection.

Type: boolean

The equipment is enabled to participate in network analysis. If unspecified, the value is assumed to be true.

Type: boolean

Specifies the availability of the equipment under normal operating conditions. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: enum (of string)

The current state of the battery (charging, full, etc.).

Must be one of:

  • "discharging"
  • "waiting"
  • "full"
  • "empty"
  • "charging"

Type: boolean

Specifies the availability of the equipment. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: object

A photovoltaic device or an aggregation of such devices.

Type: boolean

The aggregate flag provides an alternative way of representing an aggregated (equivalent) element. It is applicable in cases when the dedicated classes for equivalent equipment do not have all of the attributes necessary to represent the required level of detail. In case the flag is set to “true” the single instance of equipment represents multiple pieces of equipment that have been modelled together as an aggregate equivalent obtained by a network reduction procedure. Examples would be power transformers or synchronous machines operating in parallel modelled as a single aggregate power transformer or aggregate synchronous machine.
The attribute is not used for EquivalentBranch, EquivalentShunt and EquivalentInjection.

Type: boolean

The equipment is enabled to participate in network analysis. If unspecified, the value is assumed to be true.

Type: boolean

Specifies the availability of the equipment under normal operating conditions. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: boolean

Specifies the availability of the equipment. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: object

A wind generating unit that connects to the AC network with power electronics rather than rotating machines or an aggregation of such units.

Type: boolean

The aggregate flag provides an alternative way of representing an aggregated (equivalent) element. It is applicable in cases when the dedicated classes for equivalent equipment do not have all of the attributes necessary to represent the required level of detail. In case the flag is set to “true” the single instance of equipment represents multiple pieces of equipment that have been modelled together as an aggregate equivalent obtained by a network reduction procedure. Examples would be power transformers or synchronous machines operating in parallel modelled as a single aggregate power transformer or aggregate synchronous machine.
The attribute is not used for EquivalentBranch, EquivalentShunt and EquivalentInjection.

Type: boolean

Specifies the availability of the equipment under normal operating conditions. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: boolean

Specifies the availability of the equipment. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: array

A single phase of a power electronics connection.

No Additional Items

Each item of this array must be:

Type: object

A single phase of a power electronics connection.

Type: enum (of string)

Phase of this energy producer component. If the energy producer is wye connected, the connection is from the indicated phase to the central ground or neutral point. If the energy producer is delta connected, the phase indicates an energy producer connected from the indicated phase to the next logical non-neutral phase.

Same definition as SvVoltage.phase

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: array

State variable for status.

No Additional Items

Each item of this array must be:

Type: object

State variable for status.

Type: boolean

The in service status as a result of topology processing. It indicates if the equipment is considered as energized by the power flow. It reflects if the equipment is connected within a solvable island. It does not necessarily reflect whether or not the island was solved by the power flow.

Type: enum (of string)

The individual phase status. If the attribute is unspecified, then three phase model is assumed.

Same definition as SvVoltage.phase

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: boolean

Specifies the regulation status of the equipment. True is regulating, false is not regulating.

Type: boolean

The aggregate flag provides an alternative way of representing an aggregated (equivalent) element. It is applicable in cases when the dedicated classes for equivalent equipment do not have all of the attributes necessary to represent the required level of detail. In case the flag is set to “true” the single instance of equipment represents multiple pieces of equipment that have been modelled together as an aggregate equivalent obtained by a network reduction procedure. Examples would be power transformers or synchronous machines operating in parallel modelled as a single aggregate power transformer or aggregate synchronous machine.
The attribute is not used for EquivalentBranch, EquivalentShunt and EquivalentInjection.

Type: boolean

The equipment is enabled to participate in network analysis. If unspecified, the value is assumed to be true.

Type: boolean

Specifies the availability of the equipment under normal operating conditions. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: boolean

Specifies the availability of the equipment. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: object or number

Maximum reactive power limit. This is the maximum (nameplate) limit for the unit.

Same definition as SvInjection.qInjection

Type: object or number

Minimum reactive power limit for the unit. This is the minimum (nameplate) limit for the unit.

Same definition as SvInjection.qInjection

Type: object or number

Active power injection. Load sign convention is used, i.e. positive sign means flow out from a node.
Starting value for a steady state solution.

Same definition as SvInjection.pInjection

Type: object or number

Reactive power injection. Load sign convention is used, i.e. positive sign means flow out from a node.
Starting value for a steady state solution.

Same definition as SvInjection.qInjection

Type: object or number

Equivalent resistance (RG) of generator. RG is considered for the calculation of all currents, except for the calculation of the peak current ip. Used for short circuit data exchange according to IEC 60909.

Type: object or number

Rated voltage (nameplate data, Ur in IEC 60909-0). It is primarily used for short circuit data exchange according to IEC 60909.
The attribute shall be a positive value.

Same definition as BaseVoltage.nominalVoltage

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

A facility for providing variable and controllable shunt reactive power. The SVC typically consists of a stepdown transformer, filter, thyristor-controlled reactor, and thyristor-switched capacitor arms.

The SVC may operate in fixed MVar output mode or in voltage control mode. When in voltage control mode, the output of the SVC will be proportional to the deviation of voltage at the controlled bus from the voltage setpoint. The SVC characteristic slope defines the proportion. If the voltage at the controlled bus is equal to the voltage setpoint, the SVC MVar output is zero.

Type: array

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

No Additional Items

Each item of this array must be:

Type: object

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

Same definition as Terminal

Type: enum (of string)

SVC control mode.

Must be one of:

  • "reactivePower"
  • "voltage"

Type: object or number

The reactive power output of the SVC is proportional to the difference between the voltage at the regulated bus and the voltage setpoint. When the regulated bus voltage is equal to the voltage setpoint, the reactive power output is zero.

Same definition as BaseVoltage.nominalVoltage

Type: boolean

The aggregate flag provides an alternative way of representing an aggregated (equivalent) element. It is applicable in cases when the dedicated classes for equivalent equipment do not have all of the attributes necessary to represent the required level of detail. In case the flag is set to “true” the single instance of equipment represents multiple pieces of equipment that have been modelled together as an aggregate equivalent obtained by a network reduction procedure. Examples would be power transformers or synchronous machines operating in parallel modelled as a single aggregate power transformer or aggregate synchronous machine.
The attribute is not used for EquivalentBranch, EquivalentShunt and EquivalentInjection.

Type: boolean

The equipment is enabled to participate in network analysis. If unspecified, the value is assumed to be true.

Type: boolean

Specifies the regulation status of the equipment. True is regulating, false is not regulating.

Type: object or number

Reactive power injection. Load sign convention is used, i.e. positive sign means flow out from a node.
Starting value for a steady state solution.

Same definition as SvInjection.qInjection

Type: boolean

Specifies the availability of the equipment under normal operating conditions. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: boolean

Specifies the availability of the equipment. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: object or number

The characteristics slope of an SVC defines how the reactive power output changes in proportion to the difference between the regulated bus voltage and the voltage setpoint.
The attribute shall be a positive value or zero.

Type: object

This class represents the external network and it is used for IEC 60909 calculations.

Type: array

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

No Additional Items

Each item of this array must be:

Type: object

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

Same definition as Terminal

Type: object or number

Power Frequency Bias. This is the change in power injection divided by the change in frequency and negated. A positive value of the power frequency bias provides additional power injection upon a drop in frequency.

Type: boolean

Indicates whether initial symmetrical short-circuit current and power have been calculated according to IEC (Ik"). Used only if short circuit calculations are done according to superposition method.

Type: object or number

Maximum reactive power limit. It is used for modelling of infeed for load flow exchange and not for short circuit modelling.

Same definition as SvInjection.qInjection

Type: number

Maximum ratio of zero sequence resistance of Network Feeder to its zero sequence reactance (R(0)/X(0) max). Used for short circuit data exchange according to IEC 60909.

Type: number

Maximum ratio of positive sequence resistance of Network Feeder to its positive sequence reactance (R(1)/X(1) max). Used for short circuit data exchange according to IEC 60909.

Type: number

Maximum ratio of zero sequence impedance to its positive sequence impedance (Z(0)/Z(1) max). Used for short circuit data exchange according to IEC 60909.

Type: object or number

Minimum initial symmetrical short-circuit currents (Ik" min) in A (Ik" = Sk"/(SQRT(3) Un)). Used for short circuit data exchange according to IEC 60909.

Same definition as ExternalNetworkInjection.maxInitialSymShCCurrent

Type: object or number

Minimum reactive power limit. It is used for modelling of infeed for load flow exchange and not for short circuit modelling.

Same definition as SvInjection.qInjection

Type: number

Indicates whether initial symmetrical short-circuit current and power have been calculated according to IEC (Ik"). Used for short circuit data exchange according to IEC 6090.

Type: number

Minimum ratio of positive sequence resistance of Network Feeder to its positive sequence reactance (R(1)/X(1) min). Used for short circuit data exchange according to IEC 60909.

Type: number

Minimum ratio of zero sequence impedance to its positive sequence impedance (Z(0)/Z(1) min). Used for short circuit data exchange according to IEC 60909.

Type: integer

Priority of unit for use as powerflow voltage phase angle reference bus selection. 0 = don t care (default) 1 = highest priority. 2 is less than 1 and so on.

Type: object or number

Voltage factor in pu, which was used to calculate short-circuit current Ik" and power Sk". Used only if short circuit calculations are done according to superposition method.

Same definition as PowerElectronicsConnection.maxIFault

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: boolean

Specifies the regulation status of the equipment. True is regulating, false is not regulating.

Type: object or number

Active power injection. Load sign convention is used, i.e. positive sign means flow out from a node.
Starting value for steady state solutions.

Same definition as SvInjection.pInjection

Type: object or number

Reactive power injection. Load sign convention is used, i.e. positive sign means flow out from a node.
Starting value for steady state solutions.

Same definition as SvInjection.qInjection

Type: boolean

The aggregate flag provides an alternative way of representing an aggregated (equivalent) element. It is applicable in cases when the dedicated classes for equivalent equipment do not have all of the attributes necessary to represent the required level of detail. In case the flag is set to “true” the single instance of equipment represents multiple pieces of equipment that have been modelled together as an aggregate equivalent obtained by a network reduction procedure. Examples would be power transformers or synchronous machines operating in parallel modelled as a single aggregate power transformer or aggregate synchronous machine.
The attribute is not used for EquivalentBranch, EquivalentShunt and EquivalentInjection.

Type: boolean

The equipment is enabled to participate in network analysis. If unspecified, the value is assumed to be true.

Type: boolean

Specifies the availability of the equipment under normal operating conditions. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: boolean

Specifies the availability of the equipment. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

A device to convert from one frequency to another (e.g., frequency F1 to F2) comprises a pair of FrequencyConverter instances. One converts from F1 to DC, the other converts the DC to F2.

Type: array

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

No Additional Items

Each item of this array must be:

Type: object

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

Same definition as Terminal

Type: boolean

The aggregate flag provides an alternative way of representing an aggregated (equivalent) element. It is applicable in cases when the dedicated classes for equivalent equipment do not have all of the attributes necessary to represent the required level of detail. In case the flag is set to “true” the single instance of equipment represents multiple pieces of equipment that have been modelled together as an aggregate equivalent obtained by a network reduction procedure. Examples would be power transformers or synchronous machines operating in parallel modelled as a single aggregate power transformer or aggregate synchronous machine.
The attribute is not used for EquivalentBranch, EquivalentShunt and EquivalentInjection.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: boolean

The equipment is enabled to participate in network analysis. If unspecified, the value is assumed to be true.

Type: boolean

Specifies the regulation status of the equipment. True is regulating, false is not regulating.

Type: boolean

Specifies the availability of the equipment under normal operating conditions. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: boolean

Specifies the availability of the equipment. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: object or number

The maximum active power on the DC side at which the frequency converter should operate.

Same definition as SvInjection.pInjection

Type: object or number

The maximum voltage on the DC side at which the frequency converter should operate.

Same definition as BaseVoltage.nominalVoltage

Type: object or number

The minimum active power on the DC side at which the frequency converter should operate.

Same definition as SvInjection.pInjection

Type: object or number

The minimum voltage on the DC side at which the frequency converter should operate.

Same definition as BaseVoltage.nominalVoltage

Type: object

A shunt capacitor or reactor or switchable bank of shunt capacitors or reactors. A section of a shunt compensator is an individual capacitor or reactor. A negative value for bPerSection indicates that the compensator is a reactor. ShuntCompensator is a single terminal device. Ground is implied.

Type: array

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

No Additional Items

Each item of this array must be:

Type: object

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

Same definition as Terminal

Type: array

Single phase of a multi-phase shunt compensator when its attributes might be different per phase.

No Additional Items

Each item of this array must be:

Type: object

Single phase of a multi-phase shunt compensator when its attributes might be different per phase.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: number

Shunt compensator sections in use. Starting value for steady state solution. The attribute shall be a positive value or zero. Non integer values are allowed to support continuous variables. The reasons for continuous value are to support study cases where no discrete shunt compensators has yet been designed, a solutions where a narrow voltage band force the sections to oscillate or accommodate for a continuous solution as input.
For LinearShuntConpensator the value shall be between zero and ShuntCompensatorPhase.maximumSections. At value zero the shunt compensator conductance and admittance is zero. Linear interpolation of conductance and admittance between the previous and next integer section is applied in case of non-integer values.
For NonlinearShuntCompensator-s shall only be set to one of the NonlinearShuntCompenstorPhasePoint.sectionNumber. There is no interpolation between NonlinearShuntCompenstorPhasePoint-s.

Type: integer

For the capacitor phase, the normal number of sections switched in. The value shall be between zero and ShuntCompensatorPhase.maximumSections.

Type: enum (of string)

Phase of this shunt compensator component. If the shunt compensator is wye connected, the connection is from the indicated phase to the central ground or neutral point. If the shunt compensator is delta connected, the phase indicates a shunt compensator connected from the indicated phase to the next logical non-neutral phase.

Same definition as SvVoltage.phase

Type: array

State variable for the number of sections in service for a shunt compensator.

No Additional Items

Each item of this array must be:

Type: object

State variable for the number of sections in service for a shunt compensator.

Type: number

The number of sections in service as a continuous variable. The attribute shall be a positive value or zero. To get integer value scale with ShuntCompensator.bPerSection.

Type: enum (of string)

The terminal phase at which the connection is applied. If missing, the injection is assumed to be balanced among non-neutral phases.

Same definition as SvVoltage.phase

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: boolean

Specifies the regulation status of the equipment. True is regulating, false is not regulating.

Type: number

Shunt compensator sections in use. Starting value for steady state solution. The attribute shall be a positive value or zero. Non integer values are allowed to support continuous variables. The reasons for continuous value are to support study cases where no discrete shunt compensators has yet been designed, a solutions where a narrow voltage band force the sections to oscillate or accommodate for a continuous solution as input.
For LinearShuntConpensator the value shall be between zero and ShuntCompensator.maximumSections. At value zero the shunt compensator conductance and admittance is zero. Linear interpolation of conductance and admittance between the previous and next integer section is applied in case of non-integer values.
For NonlinearShuntCompensator-s shall only be set to one of the NonlinearShuntCompenstorPoint.sectionNumber. There is no interpolation between NonlinearShuntCompenstorPoint-s.

Type: object or number

An automatic voltage regulation delay (AVRDelay) which is the time delay from a change in voltage to when the capacitor is allowed to change state. This filters out temporary changes in voltage.

Same definition as RegularIntervalSchedule.timeStep

Type: boolean

Used for Yn and Zn connections. True if the neutral is solidly grounded.

Type: object or number

The voltage at which the nominal reactive power may be calculated. This should normally be within 10% of the voltage at which the capacitor is connected to the network.

Same definition as BaseVoltage.nominalVoltage

Type: integer

The normal number of sections switched in. The value shall be between zero and ShuntCompensator.maximumSections.

Type: enum (of string)

The type of phase connection, such as wye or delta.

Must be one of:

  • "D"
  • "Y"
  • "Yn"
  • "I"
  • "G"

Type: integer

The switch on count since the capacitor count was last reset or initialized.

Type: string

The date and time when the capacitor bank was last switched on.

Type: object or number

Voltage sensitivity required for the device to regulate the bus voltage, in voltage/reactive power.

Same definition as StaticVarCompensator.slope

Type: boolean

The aggregate flag provides an alternative way of representing an aggregated (equivalent) element. It is applicable in cases when the dedicated classes for equivalent equipment do not have all of the attributes necessary to represent the required level of detail. In case the flag is set to “true” the single instance of equipment represents multiple pieces of equipment that have been modelled together as an aggregate equivalent obtained by a network reduction procedure. Examples would be power transformers or synchronous machines operating in parallel modelled as a single aggregate power transformer or aggregate synchronous machine.
The attribute is not used for EquivalentBranch, EquivalentShunt and EquivalentInjection.

Type: boolean

Specifies the availability of the equipment under normal operating conditions. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: boolean

The equipment is enabled to participate in network analysis. If unspecified, the value is assumed to be true.

Type: boolean

Specifies the availability of the equipment. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

A rotating machine which may be used as a generator or motor.

Type: array

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

No Additional Items

Each item of this array must be:

Type: object

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

Same definition as Terminal

Type: object

A single or set of synchronous machines for converting mechanical power into alternating-current power. For example, individual machines within a set may be defined for scheduling purposes while a single control signal is derived for the set. In this case there would be a GeneratingUnit for each member of the set and an additional GeneratingUnit corresponding to the set.

Type: object

A generating unit whose prime mover is a hydraulic turbine (e.g., Francis, Pelton, Kaplan).

Type: object

The generating unit's Operator-approved current operating schedule (or plan), typically produced with the aid of unit commitment type analyses. The X-axis represents absolute time. The Y1-axis represents the status (0=off-line and unavailable: 1=available: 2=must run: 3=must run at fixed power value: etc.). The Y2-axis represents the must run fixed power value where required.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: array

Relationship between unit operating cost (Y-axis) and unit output active power (X-axis). The operating cost curve for thermal units is derived from heat input and fuel costs. The operating cost curve for hydro units is derived from water flow rates and equivalent water costs.

No Additional Items

Each item of this array must be:

Type: object

Relationship between unit operating cost (Y-axis) and unit output active power (X-axis). The operating cost curve for thermal units is derived from heat input and fuel costs. The operating cost curve for hydro units is derived from water flow rates and equivalent water costs.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: object or number

Governor Speed Changer Droop. This is the change in generator power output divided by the change in frequency normalized by the nominal power of the generator and the nominal frequency and expressed in percent and negated. A positive value of speed change droop provides additional generator output upon a drop in frequency.

Same definition as InefficientBatteryUnit.efficiencyDischarge

Type: object or number

Default initial active power which is used to store a powerflow result for the initial active power for this unit in this network configuration.

Same definition as SvInjection.pInjection

Type: object or number

Maximum high economic active power limit, that should not exceed the maximum operating active power limit.

Same definition as SvInjection.pInjection

Type: object or number

Maximum allowable spinning reserve. Spinning reserve will never be considered greater than this value regardless of the current operating point.

Same definition as SvInjection.pInjection

Type: object or number

Low economic active power limit that shall be greater than or equal to the minimum operating active power limit.

Same definition as SvInjection.pInjection

Type: object or number

The nominal power of the generating unit. Used to give precise meaning to percentage based attributes such as the governor speed change droop (governorSCD attribute).
The attribute shall be a positive value equal to or less than RotatingMachine.ratedS.

Same definition as SvInjection.pInjection

Type: number

Generating unit economic participation factor. The sum of the participation factors across generating units does not have to sum to one. It is used for representing distributed slack participation factor. The attribute shall be a positive value or zero.

Type: number

Defined as: 1 / ( 1 - Incremental Transmission Loss); with the Incremental Transmission Loss expressed as a plus or minus value. The typical range of penalty factors is (0.9 to 1.1).

Type: object or number

The gross rated minimum generation level which the unit can safely operate at while delivering power to the transmission grid.
The attribute shall be a positive value.

Same definition as SvInjection.pInjection

Type: object or number

The net rated maximum capacity determined by subtracting the auxiliary power used to operate the internal plant machinery from the rated gross maximum capacity.
The attribute shall be a positive value.

Same definition as SvInjection.pInjection

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: boolean

The aggregate flag provides an alternative way of representing an aggregated (equivalent) element. It is applicable in cases when the dedicated classes for equivalent equipment do not have all of the attributes necessary to represent the required level of detail. In case the flag is set to “true” the single instance of equipment represents multiple pieces of equipment that have been modelled together as an aggregate equivalent obtained by a network reduction procedure. Examples would be power transformers or synchronous machines operating in parallel modelled as a single aggregate power transformer or aggregate synchronous machine.
The attribute is not used for EquivalentBranch, EquivalentShunt and EquivalentInjection.

Type: boolean

The equipment is enabled to participate in network analysis. If unspecified, the value is assumed to be true.

Type: boolean

Specifies the availability of the equipment under normal operating conditions. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: boolean

Specifies the availability of the equipment. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: object or number

For dispatchable units, this value represents the economic active power basepoint, for units that are not dispatchable, this value represents the fixed generation value. The value shall be between the operating low and high limits.

Same definition as SvInjection.pInjection

Type: object or number

Unit control error deadband. When a unit's desired active power change is less than this deadband, then no control pulses will be sent to the unit.

Same definition as SvInjection.pInjection

Type: object or number

Unit response rate which specifies the active power change for a control pulse of one second in the most responsive loading level of the unit.

Same definition as GeneratingUnit.lowerRampRate

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: enum (of string)

The source of controls for a generating unit. Defines the control status of the generating unit.

Must be one of:

  • "unavailable"
  • "offAGC"
  • "onAGC"
  • "plantControl"
Type: object

A solar thermal generating unit, connected to the grid by means of a rotating machine. This class does not represent photovoltaic (PV) generation.

Type: object

The generating unit's Operator-approved current operating schedule (or plan), typically produced with the aid of unit commitment type analyses. The X-axis represents absolute time. The Y1-axis represents the status (0=off-line and unavailable: 1=available: 2=must run: 3=must run at fixed power value: etc.). The Y2-axis represents the must run fixed power value where required.

Same definition as GeneratingUnit.GenUnitOpSchedule

Type: array

Relationship between unit operating cost (Y-axis) and unit output active power (X-axis). The operating cost curve for thermal units is derived from heat input and fuel costs. The operating cost curve for hydro units is derived from water flow rates and equivalent water costs.

No Additional Items

Each item of this array must be:

Type: object

Relationship between unit operating cost (Y-axis) and unit output active power (X-axis). The operating cost curve for thermal units is derived from heat input and fuel costs. The operating cost curve for hydro units is derived from water flow rates and equivalent water costs.

Same definition as GenUnitOpCostCurve

Type: object or number

Governor Speed Changer Droop. This is the change in generator power output divided by the change in frequency normalized by the nominal power of the generator and the nominal frequency and expressed in percent and negated. A positive value of speed change droop provides additional generator output upon a drop in frequency.

Same definition as InefficientBatteryUnit.efficiencyDischarge

Type: object or number

Default initial active power which is used to store a powerflow result for the initial active power for this unit in this network configuration.

Same definition as SvInjection.pInjection

Type: object or number

Maximum high economic active power limit, that should not exceed the maximum operating active power limit.

Same definition as SvInjection.pInjection

Type: object or number

Maximum allowable spinning reserve. Spinning reserve will never be considered greater than this value regardless of the current operating point.

Same definition as SvInjection.pInjection

Type: object or number

Low economic active power limit that shall be greater than or equal to the minimum operating active power limit.

Same definition as SvInjection.pInjection

Type: object or number

The nominal power of the generating unit. Used to give precise meaning to percentage based attributes such as the governor speed change droop (governorSCD attribute).
The attribute shall be a positive value equal to or less than RotatingMachine.ratedS.

Same definition as SvInjection.pInjection

Type: number

Generating unit economic participation factor. The sum of the participation factors across generating units does not have to sum to one. It is used for representing distributed slack participation factor. The attribute shall be a positive value or zero.

Type: number

Defined as: 1 / ( 1 - Incremental Transmission Loss); with the Incremental Transmission Loss expressed as a plus or minus value. The typical range of penalty factors is (0.9 to 1.1).

Type: object or number

The gross rated minimum generation level which the unit can safely operate at while delivering power to the transmission grid.
The attribute shall be a positive value.

Same definition as SvInjection.pInjection

Type: object or number

The net rated maximum capacity determined by subtracting the auxiliary power used to operate the internal plant machinery from the rated gross maximum capacity.
The attribute shall be a positive value.

Same definition as SvInjection.pInjection

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: boolean

The aggregate flag provides an alternative way of representing an aggregated (equivalent) element. It is applicable in cases when the dedicated classes for equivalent equipment do not have all of the attributes necessary to represent the required level of detail. In case the flag is set to “true” the single instance of equipment represents multiple pieces of equipment that have been modelled together as an aggregate equivalent obtained by a network reduction procedure. Examples would be power transformers or synchronous machines operating in parallel modelled as a single aggregate power transformer or aggregate synchronous machine.
The attribute is not used for EquivalentBranch, EquivalentShunt and EquivalentInjection.

Type: boolean

The equipment is enabled to participate in network analysis. If unspecified, the value is assumed to be true.

Type: boolean

Specifies the availability of the equipment under normal operating conditions. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: boolean

Specifies the availability of the equipment. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: object or number

For dispatchable units, this value represents the economic active power basepoint, for units that are not dispatchable, this value represents the fixed generation value. The value shall be between the operating low and high limits.

Same definition as SvInjection.pInjection

Type: object or number

Unit control error deadband. When a unit's desired active power change is less than this deadband, then no control pulses will be sent to the unit.

Same definition as SvInjection.pInjection

Type: object or number

Unit response rate which specifies the active power change for a control pulse of one second in the most responsive loading level of the unit.

Same definition as GeneratingUnit.lowerRampRate

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: object

A nuclear generating unit.

Type: object

The generating unit's Operator-approved current operating schedule (or plan), typically produced with the aid of unit commitment type analyses. The X-axis represents absolute time. The Y1-axis represents the status (0=off-line and unavailable: 1=available: 2=must run: 3=must run at fixed power value: etc.). The Y2-axis represents the must run fixed power value where required.

Same definition as GeneratingUnit.GenUnitOpSchedule

Type: array

Relationship between unit operating cost (Y-axis) and unit output active power (X-axis). The operating cost curve for thermal units is derived from heat input and fuel costs. The operating cost curve for hydro units is derived from water flow rates and equivalent water costs.

No Additional Items

Each item of this array must be:

Type: object

Relationship between unit operating cost (Y-axis) and unit output active power (X-axis). The operating cost curve for thermal units is derived from heat input and fuel costs. The operating cost curve for hydro units is derived from water flow rates and equivalent water costs.

Same definition as GenUnitOpCostCurve

Type: object or number

Governor Speed Changer Droop. This is the change in generator power output divided by the change in frequency normalized by the nominal power of the generator and the nominal frequency and expressed in percent and negated. A positive value of speed change droop provides additional generator output upon a drop in frequency.

Same definition as InefficientBatteryUnit.efficiencyDischarge

Type: object or number

Default initial active power which is used to store a powerflow result for the initial active power for this unit in this network configuration.

Same definition as SvInjection.pInjection

Type: object or number

Maximum high economic active power limit, that should not exceed the maximum operating active power limit.

Same definition as SvInjection.pInjection

Type: object or number

Maximum allowable spinning reserve. Spinning reserve will never be considered greater than this value regardless of the current operating point.

Same definition as SvInjection.pInjection

Type: object or number

Low economic active power limit that shall be greater than or equal to the minimum operating active power limit.

Same definition as SvInjection.pInjection

Type: object or number

The nominal power of the generating unit. Used to give precise meaning to percentage based attributes such as the governor speed change droop (governorSCD attribute).
The attribute shall be a positive value equal to or less than RotatingMachine.ratedS.

Same definition as SvInjection.pInjection

Type: number

Generating unit economic participation factor. The sum of the participation factors across generating units does not have to sum to one. It is used for representing distributed slack participation factor. The attribute shall be a positive value or zero.

Type: number

Defined as: 1 / ( 1 - Incremental Transmission Loss); with the Incremental Transmission Loss expressed as a plus or minus value. The typical range of penalty factors is (0.9 to 1.1).

Type: object or number

The gross rated minimum generation level which the unit can safely operate at while delivering power to the transmission grid.
The attribute shall be a positive value.

Same definition as SvInjection.pInjection

Type: object or number

The net rated maximum capacity determined by subtracting the auxiliary power used to operate the internal plant machinery from the rated gross maximum capacity.
The attribute shall be a positive value.

Same definition as SvInjection.pInjection

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: boolean

The aggregate flag provides an alternative way of representing an aggregated (equivalent) element. It is applicable in cases when the dedicated classes for equivalent equipment do not have all of the attributes necessary to represent the required level of detail. In case the flag is set to “true” the single instance of equipment represents multiple pieces of equipment that have been modelled together as an aggregate equivalent obtained by a network reduction procedure. Examples would be power transformers or synchronous machines operating in parallel modelled as a single aggregate power transformer or aggregate synchronous machine.
The attribute is not used for EquivalentBranch, EquivalentShunt and EquivalentInjection.

Type: boolean

The equipment is enabled to participate in network analysis. If unspecified, the value is assumed to be true.

Type: boolean

Specifies the availability of the equipment under normal operating conditions. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: boolean

Specifies the availability of the equipment. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: object or number

For dispatchable units, this value represents the economic active power basepoint, for units that are not dispatchable, this value represents the fixed generation value. The value shall be between the operating low and high limits.

Same definition as SvInjection.pInjection

Type: object or number

Unit control error deadband. When a unit's desired active power change is less than this deadband, then no control pulses will be sent to the unit.

Same definition as SvInjection.pInjection

Type: object or number

Unit response rate which specifies the active power change for a control pulse of one second in the most responsive loading level of the unit.

Same definition as GeneratingUnit.lowerRampRate

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: object

A wind driven generating unit, connected to the grid by means of a rotating machine. May be used to represent a single turbine or an aggregation.

Type: object

The generating unit's Operator-approved current operating schedule (or plan), typically produced with the aid of unit commitment type analyses. The X-axis represents absolute time. The Y1-axis represents the status (0=off-line and unavailable: 1=available: 2=must run: 3=must run at fixed power value: etc.). The Y2-axis represents the must run fixed power value where required.

Same definition as GeneratingUnit.GenUnitOpSchedule

Type: array

Relationship between unit operating cost (Y-axis) and unit output active power (X-axis). The operating cost curve for thermal units is derived from heat input and fuel costs. The operating cost curve for hydro units is derived from water flow rates and equivalent water costs.

No Additional Items

Each item of this array must be:

Type: object

Relationship between unit operating cost (Y-axis) and unit output active power (X-axis). The operating cost curve for thermal units is derived from heat input and fuel costs. The operating cost curve for hydro units is derived from water flow rates and equivalent water costs.

Same definition as GenUnitOpCostCurve

Type: object or number

Governor Speed Changer Droop. This is the change in generator power output divided by the change in frequency normalized by the nominal power of the generator and the nominal frequency and expressed in percent and negated. A positive value of speed change droop provides additional generator output upon a drop in frequency.

Same definition as InefficientBatteryUnit.efficiencyDischarge

Type: object or number

Default initial active power which is used to store a powerflow result for the initial active power for this unit in this network configuration.

Same definition as SvInjection.pInjection

Type: object or number

Maximum high economic active power limit, that should not exceed the maximum operating active power limit.

Same definition as SvInjection.pInjection

Type: object or number

Maximum allowable spinning reserve. Spinning reserve will never be considered greater than this value regardless of the current operating point.

Same definition as SvInjection.pInjection

Type: object or number

Low economic active power limit that shall be greater than or equal to the minimum operating active power limit.

Same definition as SvInjection.pInjection

Type: object or number

The nominal power of the generating unit. Used to give precise meaning to percentage based attributes such as the governor speed change droop (governorSCD attribute).
The attribute shall be a positive value equal to or less than RotatingMachine.ratedS.

Same definition as SvInjection.pInjection

Type: number

Generating unit economic participation factor. The sum of the participation factors across generating units does not have to sum to one. It is used for representing distributed slack participation factor. The attribute shall be a positive value or zero.

Type: number

Defined as: 1 / ( 1 - Incremental Transmission Loss); with the Incremental Transmission Loss expressed as a plus or minus value. The typical range of penalty factors is (0.9 to 1.1).

Type: object or number

The gross rated minimum generation level which the unit can safely operate at while delivering power to the transmission grid.
The attribute shall be a positive value.

Same definition as SvInjection.pInjection

Type: object or number

The net rated maximum capacity determined by subtracting the auxiliary power used to operate the internal plant machinery from the rated gross maximum capacity.
The attribute shall be a positive value.

Same definition as SvInjection.pInjection

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: boolean

The aggregate flag provides an alternative way of representing an aggregated (equivalent) element. It is applicable in cases when the dedicated classes for equivalent equipment do not have all of the attributes necessary to represent the required level of detail. In case the flag is set to “true” the single instance of equipment represents multiple pieces of equipment that have been modelled together as an aggregate equivalent obtained by a network reduction procedure. Examples would be power transformers or synchronous machines operating in parallel modelled as a single aggregate power transformer or aggregate synchronous machine.
The attribute is not used for EquivalentBranch, EquivalentShunt and EquivalentInjection.

Type: boolean

The equipment is enabled to participate in network analysis. If unspecified, the value is assumed to be true.

Type: boolean

Specifies the availability of the equipment under normal operating conditions. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: boolean

Specifies the availability of the equipment. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: object or number

For dispatchable units, this value represents the economic active power basepoint, for units that are not dispatchable, this value represents the fixed generation value. The value shall be between the operating low and high limits.

Same definition as SvInjection.pInjection

Type: object or number

Unit control error deadband. When a unit's desired active power change is less than this deadband, then no control pulses will be sent to the unit.

Same definition as SvInjection.pInjection

Type: object or number

Unit response rate which specifies the active power change for a control pulse of one second in the most responsive loading level of the unit.

Same definition as GeneratingUnit.lowerRampRate

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: object

A generating unit whose prime mover could be a steam turbine, combustion turbine, or diesel engine.

Type: object

The generating unit's Operator-approved current operating schedule (or plan), typically produced with the aid of unit commitment type analyses. The X-axis represents absolute time. The Y1-axis represents the status (0=off-line and unavailable: 1=available: 2=must run: 3=must run at fixed power value: etc.). The Y2-axis represents the must run fixed power value where required.

Same definition as GeneratingUnit.GenUnitOpSchedule

Type: array

Relationship between unit operating cost (Y-axis) and unit output active power (X-axis). The operating cost curve for thermal units is derived from heat input and fuel costs. The operating cost curve for hydro units is derived from water flow rates and equivalent water costs.

No Additional Items

Each item of this array must be:

Type: object

Relationship between unit operating cost (Y-axis) and unit output active power (X-axis). The operating cost curve for thermal units is derived from heat input and fuel costs. The operating cost curve for hydro units is derived from water flow rates and equivalent water costs.

Same definition as GenUnitOpCostCurve

Type: object or number

Governor Speed Changer Droop. This is the change in generator power output divided by the change in frequency normalized by the nominal power of the generator and the nominal frequency and expressed in percent and negated. A positive value of speed change droop provides additional generator output upon a drop in frequency.

Same definition as InefficientBatteryUnit.efficiencyDischarge

Type: object or number

Default initial active power which is used to store a powerflow result for the initial active power for this unit in this network configuration.

Same definition as SvInjection.pInjection

Type: object or number

Maximum high economic active power limit, that should not exceed the maximum operating active power limit.

Same definition as SvInjection.pInjection

Type: object or number

Maximum allowable spinning reserve. Spinning reserve will never be considered greater than this value regardless of the current operating point.

Same definition as SvInjection.pInjection

Type: object or number

Low economic active power limit that shall be greater than or equal to the minimum operating active power limit.

Same definition as SvInjection.pInjection

Type: object or number

The nominal power of the generating unit. Used to give precise meaning to percentage based attributes such as the governor speed change droop (governorSCD attribute).
The attribute shall be a positive value equal to or less than RotatingMachine.ratedS.

Same definition as SvInjection.pInjection

Type: number

Generating unit economic participation factor. The sum of the participation factors across generating units does not have to sum to one. It is used for representing distributed slack participation factor. The attribute shall be a positive value or zero.

Type: number

Defined as: 1 / ( 1 - Incremental Transmission Loss); with the Incremental Transmission Loss expressed as a plus or minus value. The typical range of penalty factors is (0.9 to 1.1).

Type: object or number

The gross rated minimum generation level which the unit can safely operate at while delivering power to the transmission grid.
The attribute shall be a positive value.

Same definition as SvInjection.pInjection

Type: object or number

The net rated maximum capacity determined by subtracting the auxiliary power used to operate the internal plant machinery from the rated gross maximum capacity.
The attribute shall be a positive value.

Same definition as SvInjection.pInjection

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: boolean

The aggregate flag provides an alternative way of representing an aggregated (equivalent) element. It is applicable in cases when the dedicated classes for equivalent equipment do not have all of the attributes necessary to represent the required level of detail. In case the flag is set to “true” the single instance of equipment represents multiple pieces of equipment that have been modelled together as an aggregate equivalent obtained by a network reduction procedure. Examples would be power transformers or synchronous machines operating in parallel modelled as a single aggregate power transformer or aggregate synchronous machine.
The attribute is not used for EquivalentBranch, EquivalentShunt and EquivalentInjection.

Type: boolean

The equipment is enabled to participate in network analysis. If unspecified, the value is assumed to be true.

Type: boolean

Specifies the availability of the equipment under normal operating conditions. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: boolean

Specifies the availability of the equipment. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: object or number

For dispatchable units, this value represents the economic active power basepoint, for units that are not dispatchable, this value represents the fixed generation value. The value shall be between the operating low and high limits.

Same definition as SvInjection.pInjection

Type: object or number

Unit control error deadband. When a unit's desired active power change is less than this deadband, then no control pulses will be sent to the unit.

Same definition as SvInjection.pInjection

Type: object or number

Unit response rate which specifies the active power change for a control pulse of one second in the most responsive loading level of the unit.

Same definition as GeneratingUnit.lowerRampRate

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: object or number

Steady-state short-circuit current (in A for the profile) of generator with compound excitation during 3-phase short circuit.
- Ikk=0: Generator with no compound excitation.
- Ikk<>0: Generator with compound excitation.
Ikk is used to calculate the minimum steady-state short-circuit current for generators with compound excitation.
(4.6.1.2 in IEC 60909-0:2001).
Used only for single fed short circuit on a generator. (4.3.4.2. in IEC 60909-0:2001).

Same definition as ExternalNetworkInjection.maxInitialSymShCCurrent

Type: object or number

Time delay required when switching from Manual to Automatic Voltage Regulation. This value is used in the accelerating power reference frame for powerflow solutions.

Same definition as RegularIntervalSchedule.timeStep

Type: object or number

Maximum reactive power limit. This is the maximum (nameplate) limit for the unit.

Same definition as SvInjection.qInjection

Type: number

Factor to calculate the breaking current (Section 4.5.2.1 in IEC 60909-0).
Used only for single fed short circuit on a generator (Section 4.3.4.2. in IEC 60909-0).

Type: enum (of string)

Current mode of operation.

Must be one of:

  • "generator"
  • "condenser"
  • "motor"

Type: object or number

Part of the coordinated reactive control that comes from this machine. The attribute is used as a participation factor not necessarily summing up to 100% for the participating devices in the control.

Same definition as InefficientBatteryUnit.efficiencyDischarge

Type: object or number

Equivalent resistance (RG) of generator. RG is considered for the calculation of all currents, except for the calculation of the peak current ip. Used for short circuit data exchange according to IEC 60909.

Same definition as PowerElectronicsConnection.r

Type: integer

Priority of unit for use as powerflow voltage phase angle reference bus selection. 0 = don t care (default) 1 = highest priority. 2 is less than 1 and so on.

Type: object or number

Direct-axes saturated synchronous reactance (xdsat); reciprocal of short-circuit ration. Used for short circuit data exchange, only for single fed short circuit on a generator. (4.3.4.2. in IEC 60909-0:2001).

Same definition as PowerElectronicsConnection.maxIFault

Type: object or number

Saturated Direct-axis transient reactance. The attribute is primarily used for short circuit calculations according to ANSI.

Same definition as PowerElectronicsConnection.maxIFault

Type: enum (of string)

Type of rotor, used by short circuit applications, only for single fed short circuit according to IEC 60909.

Must be one of:

  • "salientPole1"
  • "salientPole2"
  • "turboSeries1"
  • "turboSeries2"

Type: boolean

Indicates whether the machine is a converter fed drive. Used for short circuit data exchange according to IEC 60909.

Type: object or number

Efficiency of the asynchronous machine at nominal operation as a percentage. Indicator for converter drive motors. Used for short circuit data exchange according to IEC 60909.

Same definition as InefficientBatteryUnit.efficiencyDischarge

Type: number

Ratio of locked-rotor current to the rated current of the motor (Ia/Ir). Used for short circuit data exchange according to IEC 60909.

Type: enum (of string)

Modes that this synchronous machine can operate in.

Must be one of:

  • "generator"
  • "condenser"
  • "generatorOrCondenser"
  • "motor"
  • "generatorOrMotor"
  • "motorOrCondenser"
  • "generatorOrCondenserOrMotor"

Type: object or number

Range of generator voltage regulation (PG in IEC 60909-0) used for calculation of the impedance correction factor KG defined in IEC 60909-0.
This attribute is used to describe the operating voltage of the generating unit.

Same definition as InefficientBatteryUnit.efficiencyDischarge

Type: integer

Number of pole pairs of stator. Used for short circuit data exchange according to IEC 60909.

Type: object or number

Rated mechanical power (Pr in IEC 60909-0). Used for short circuit data exchange according to IEC 60909.

Same definition as SvInjection.pInjection

Type: boolean

Indicates for converter drive motors if the power can be reversible. Used for short circuit data exchange according to IEC 60909.

Type: number

Locked rotor ratio (R/X). Used for short circuit data exchange according to IEC 60909.

Type: boolean

Specifies the regulation status of the equipment. True is regulating, false is not regulating.

Type: number

Power factor (nameplate data). It is primarily used for short circuit data exchange according to IEC 60909. The attribute cannot be a negative value.

Type: object or number

Nameplate apparent power rating for the unit.
The attribute shall have a positive value.

Same definition as PowerElectronicsConnection.ratedS

Type: object or number

Rated voltage (nameplate data, Ur in IEC 60909-0). It is primarily used for short circuit data exchange according to IEC 60909.
The attribute shall be a positive value.

Same definition as BaseVoltage.nominalVoltage

Type: object or number

Active power injection. Load sign convention is used, i.e. positive sign means flow out from a node.
Starting value for a steady state solution.

Same definition as SvInjection.pInjection

Type: object or number

Reactive power injection. Load sign convention is used, i.e. positive sign means flow out from a node.
Starting value for a steady state solution.

Same definition as SvInjection.qInjection

Type: boolean

The aggregate flag provides an alternative way of representing an aggregated (equivalent) element. It is applicable in cases when the dedicated classes for equivalent equipment do not have all of the attributes necessary to represent the required level of detail. In case the flag is set to “true” the single instance of equipment represents multiple pieces of equipment that have been modelled together as an aggregate equivalent obtained by a network reduction procedure. Examples would be power transformers or synchronous machines operating in parallel modelled as a single aggregate power transformer or aggregate synchronous machine.
The attribute is not used for EquivalentBranch, EquivalentShunt and EquivalentInjection.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: boolean

The equipment is enabled to participate in network analysis. If unspecified, the value is assumed to be true.

Type: boolean

Specifies the availability of the equipment under normal operating conditions. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: enum (of string)

Indicates the type of Asynchronous Machine (motor or generator).

Must be one of:

  • "generator"
  • "motor"

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: boolean

Specifies the availability of the equipment. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: object or number

Time delay required when switching from Automatic Voltage Regulation (AVR) to Manual for a lagging MVAr violation.

Same definition as RegularIntervalSchedule.timeStep

Type: object or number

Time delay required when switching from Automatic Voltage Regulation (AVR) to Manual for a leading MVAr violation.

Same definition as RegularIntervalSchedule.timeStep

Type: object or number

Default base reactive power value. This value represents the initial reactive power that can be used by any application function.

Same definition as SvInjection.qInjection

Type: enum (of string)

Method of cooling the machine.

Must be one of:

  • "air"
  • "hydrogenGas"
  • "water"

Type: boolean

Indicates whether or not the generator is earthed. Used for short circuit data exchange according to IEC 60909.

Type: object or number

Generator star point earthing resistance (Re). Used for short circuit data exchange according to IEC 60909.

Same definition as PowerElectronicsConnection.r

Type: object or number

Generator star point earthing reactance (Xe). Used for short circuit data exchange according to IEC 60909.

Same definition as PowerElectronicsConnection.x

Type: object

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.

Type: object

ConformLoad represent loads that follow a daily load change pattern where the pattern can be used to scale the load with a system load.

Type: array

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

No Additional Items

Each item of this array must be:

Type: object

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

Same definition as Terminal

Type: object

Models the characteristic response of the load demand due to changes in system conditions such as voltage and frequency. It is not related to demand response.
If LoadResponseCharacteristic.exponentModel is True, the exponential voltage or frequency dependent models are specified and used as to calculate active and reactive power components of the load model.
The equations to calculate active and reactive power components of the load model are internal to the power flow calculation, hence they use different quantities depending on the use case of the data exchange.
The equations for exponential voltage dependent load model injected power are:
pInjection= Pnominal* (Voltage/cim:BaseVoltage.nominalVoltage) * cim:LoadResponseCharacteristic.pVoltageExponent
qInjection= Qnominal
(Voltage/cim:BaseVoltage.nominalVoltage) * cim:LoadResponseCharacteristic.qVoltageExponent
Where:
1) * means "multiply" and *
is "raised to power of";
2) Pnominal and Qnominal represent the active power and reactive power at nominal voltage as any load described by the voltage exponential model shall be given at nominal voltage. This means that EnergyConsumer.p and EnergyConsumer.q are at nominal voltage.
3) After power flow is solved:
-pInjection and qInjection correspond to SvPowerflow.p and SvPowerflow.q respectively.
- Voltage corresponds to SvVoltage.v at the TopologicalNode where the load is connected.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: boolean

Indicates the exponential voltage dependency model is to be used. If false, the coefficient model is to be used.
The exponential voltage dependency model consist of the attributes:
- pVoltageExponent
- qVoltageExponent
- pFrequencyExponent
- qFrequencyExponent.
The coefficient model consist of the attributes:
- pConstantImpedance
- pConstantCurrent
- pConstantPower
- qConstantImpedance
- qConstantCurrent
- qConstantPower.
The sum of pConstantImpedance, pConstantCurrent and pConstantPower shall equal 1.
The sum of qConstantImpedance, qConstantCurrent and qConstantPower shall equal 1.

Type: array

A single phase of an energy consumer.

No Additional Items

Each item of this array must be:

Type: object

A single phase of an energy consumer.

Type: object or number

Active power of the load. Load sign convention is used, i.e. positive sign means flow out from a node.
For voltage dependent loads the value is at rated voltage.
Starting value for a steady state solution.

Same definition as SvInjection.pInjection

Type: object or number

Active power of the load that is a fixed quantity. Load sign convention is used, i.e. positive sign means flow out from a node.

Same definition as SvInjection.pInjection

Type: object or number

Fixed active power as per cent of load group fixed active power. Load sign convention is used, i.e. positive sign means flow out from a node.

Same definition as InefficientBatteryUnit.efficiencyDischarge

Type: enum (of string)

Phase of this energy consumer component. If the energy consumer is wye connected, the connection is from the indicated phase to the central ground or neutral point. If the energy consumer is delta connected, the phase indicates an energy consumer connected from the indicated phase to the next logical non-neutral phase.

Same definition as SvVoltage.phase

Type: object or number

Reactive power of the load that is a fixed quantity. Load sign convention is used, i.e. positive sign means flow out from a node.

Same definition as SvInjection.qInjection

Type: object or number

Fixed reactive power as per cent of load group fixed reactive power. Load sign convention is used, i.e. positive sign means flow out from a node.

Same definition as InefficientBatteryUnit.efficiencyDischarge

Type: object or number

Reactive power of the load. Load sign convention is used, i.e. positive sign means flow out from a node.
For voltage dependent loads the value is at rated voltage.
Starting value for a steady state solution.

Same definition as SvInjection.qInjection

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object or number

Active power of the load. Load sign convention is used, i.e. positive sign means flow out from a node.
For voltage dependent loads the value is at rated voltage.
Starting value for a steady state solution.

Same definition as SvInjection.pInjection

Type: boolean

The aggregate flag provides an alternative way of representing an aggregated (equivalent) element. It is applicable in cases when the dedicated classes for equivalent equipment do not have all of the attributes necessary to represent the required level of detail. In case the flag is set to “true” the single instance of equipment represents multiple pieces of equipment that have been modelled together as an aggregate equivalent obtained by a network reduction procedure. Examples would be power transformers or synchronous machines operating in parallel modelled as a single aggregate power transformer or aggregate synchronous machine.
The attribute is not used for EquivalentBranch, EquivalentShunt and EquivalentInjection.

Type: object or number

Reactive power of the load. Load sign convention is used, i.e. positive sign means flow out from a node.
For voltage dependent loads the value is at rated voltage.
Starting value for a steady state solution.

Same definition as SvInjection.qInjection

Type: boolean

The equipment is enabled to participate in network analysis. If unspecified, the value is assumed to be true.

Type: boolean

Specifies the availability of the equipment under normal operating conditions. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: integer

Number of individual customers represented by this demand.

Type: boolean

Used for Yn and Zn connections. True if the neutral is solidly grounded.

Type: object or number

Active power of the load that is a fixed quantity and does not vary as load group value varies. Load sign convention is used, i.e. positive sign means flow out from a node.

Same definition as SvInjection.pInjection

Type: object or number

Fixed active power as a percentage of load group fixed active power. Used to represent the time-varying components. Load sign convention is used, i.e. positive sign means flow out from a node.

Same definition as InefficientBatteryUnit.efficiencyDischarge

Type: object or number

Reactive power of the load that is a fixed quantity and does not vary as load group value varies. Load sign convention is used, i.e. positive sign means flow out from a node.

Same definition as SvInjection.qInjection

Type: object or number

Fixed reactive power as a percentage of load group fixed reactive power. Used to represent the time-varying components. Load sign convention is used, i.e. positive sign means flow out from a node.

Same definition as InefficientBatteryUnit.efficiencyDischarge

Type: boolean

Specifies the availability of the equipment. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

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

Type: array

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

No Additional Items

Each item of this array must be:

Type: object

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

Same definition as Terminal

Type: object

Models the characteristic response of the load demand due to changes in system conditions such as voltage and frequency. It is not related to demand response.
If LoadResponseCharacteristic.exponentModel is True, the exponential voltage or frequency dependent models are specified and used as to calculate active and reactive power components of the load model.
The equations to calculate active and reactive power components of the load model are internal to the power flow calculation, hence they use different quantities depending on the use case of the data exchange.
The equations for exponential voltage dependent load model injected power are:
pInjection= Pnominal* (Voltage/cim:BaseVoltage.nominalVoltage) * cim:LoadResponseCharacteristic.pVoltageExponent
qInjection= Qnominal
(Voltage/cim:BaseVoltage.nominalVoltage) * cim:LoadResponseCharacteristic.qVoltageExponent
Where:
1) * means "multiply" and *
is "raised to power of";
2) Pnominal and Qnominal represent the active power and reactive power at nominal voltage as any load described by the voltage exponential model shall be given at nominal voltage. This means that EnergyConsumer.p and EnergyConsumer.q are at nominal voltage.
3) After power flow is solved:
-pInjection and qInjection correspond to SvPowerflow.p and SvPowerflow.q respectively.
- Voltage corresponds to SvVoltage.v at the TopologicalNode where the load is connected.

Same definition as EnergyConsumer.LoadResponseCharacteristic

Type: object or number

Active power of the load. Load sign convention is used, i.e. positive sign means flow out from a node.
For voltage dependent loads the value is at rated voltage.
Starting value for a steady state solution.

Same definition as SvInjection.pInjection

Type: boolean

The aggregate flag provides an alternative way of representing an aggregated (equivalent) element. It is applicable in cases when the dedicated classes for equivalent equipment do not have all of the attributes necessary to represent the required level of detail. In case the flag is set to “true” the single instance of equipment represents multiple pieces of equipment that have been modelled together as an aggregate equivalent obtained by a network reduction procedure. Examples would be power transformers or synchronous machines operating in parallel modelled as a single aggregate power transformer or aggregate synchronous machine.
The attribute is not used for EquivalentBranch, EquivalentShunt and EquivalentInjection.

Type: object or number

Reactive power of the load. Load sign convention is used, i.e. positive sign means flow out from a node.
For voltage dependent loads the value is at rated voltage.
Starting value for a steady state solution.

Same definition as SvInjection.qInjection

Type: boolean

The equipment is enabled to participate in network analysis. If unspecified, the value is assumed to be true.

Type: boolean

Specifies the availability of the equipment under normal operating conditions. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: integer

Number of individual customers represented by this demand.

Type: boolean

Used for Yn and Zn connections. True if the neutral is solidly grounded.

Type: object or number

Active power of the load that is a fixed quantity and does not vary as load group value varies. Load sign convention is used, i.e. positive sign means flow out from a node.

Same definition as SvInjection.pInjection

Type: object or number

Fixed active power as a percentage of load group fixed active power. Used to represent the time-varying components. Load sign convention is used, i.e. positive sign means flow out from a node.

Same definition as InefficientBatteryUnit.efficiencyDischarge

Type: object or number

Reactive power of the load that is a fixed quantity and does not vary as load group value varies. Load sign convention is used, i.e. positive sign means flow out from a node.

Same definition as SvInjection.qInjection

Type: object or number

Fixed reactive power as a percentage of load group fixed reactive power. Used to represent the time-varying components. Load sign convention is used, i.e. positive sign means flow out from a node.

Same definition as InefficientBatteryUnit.efficiencyDischarge

Type: boolean

Specifies the availability of the equipment. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

A generic equivalent for an energy supplier on a transmission or distribution voltage level.

Type: array

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

No Additional Items

Each item of this array must be:

Type: object

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

Same definition as Terminal

Type: array

Represents the single phase information of an unbalanced energy source.

No Additional Items

Each item of this array must be:

Type: object

Represents the single phase information of an unbalanced energy source.

Type: enum (of string)

Phase of this energy source component. If the energy source wye connected, the connection is from the indicated phase to the central ground or neutral point. If the energy source is delta connected, the phase indicates an energy source connected from the indicated phase to the next logical non-neutral phase.

Same definition as SvVoltage.phase

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object or number

This is the minimum active power that can be produced by the source. Load sign convention is used, i.e. positive sign means flow out from a TopologicalNode (bus) into the conducting equipment.

Same definition as SvInjection.pInjection

Type: object or number

This is the maximum active power that can be produced by the source. Load sign convention is used, i.e. positive sign means flow out from a TopologicalNode (bus) into the conducting equipment.

Same definition as SvInjection.pInjection

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: object or number

High voltage source reactive injection. Load sign convention is used, i.e. positive sign means flow out from a node.
Starting value for steady state solutions.

Same definition as SvInjection.qInjection

Type: boolean

The aggregate flag provides an alternative way of representing an aggregated (equivalent) element. It is applicable in cases when the dedicated classes for equivalent equipment do not have all of the attributes necessary to represent the required level of detail. In case the flag is set to “true” the single instance of equipment represents multiple pieces of equipment that have been modelled together as an aggregate equivalent obtained by a network reduction procedure. Examples would be power transformers or synchronous machines operating in parallel modelled as a single aggregate power transformer or aggregate synchronous machine.
The attribute is not used for EquivalentBranch, EquivalentShunt and EquivalentInjection.

Type: boolean

The equipment is enabled to participate in network analysis. If unspecified, the value is assumed to be true.

Type: boolean

Specifies the availability of the equipment under normal operating conditions. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: boolean

Specifies the availability of the equipment. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: object or number

High voltage source active injection. Load sign convention is used, i.e. positive sign means flow out from a node.
Starting value for steady state solutions.

Same definition as SvInjection.pInjection

Type: object or number

Phase angle of a-phase open circuit used when voltage characteristics need to be imposed at the node associated with the terminal of the energy source, such as when voltages and angles from the transmission level are used as input to the distribution network. The attribute shall be a positive value or zero.

Type: object or number

Phase-to-phase open circuit voltage magnitude used when voltage characteristics need to be imposed at the node associated with the terminal of the energy source, such as when voltages and angles from the transmission level are used as input to the distribution network. The attribute shall be a positive value or zero.

Same definition as BaseVoltage.nominalVoltage

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

A unit with valves for three phases, together with unit control equipment, essential protective and switching devices, DC storage capacitors, phase reactors and auxiliaries, if any, used for conversion.

Type: object

DC side of the voltage source converter (VSC).

Type: array

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

No Additional Items

Each item of this array must be:

Type: object

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

Same definition as Terminal

Type: object or number

The maximum current through a valve. It is converter’s configuration data.

Same definition as ExternalNetworkInjection.maxInitialSymShCCurrent

Type: object or number

Active power at the point of common coupling. Load sign convention is used, i.e. positive sign means flow out from a node.
Starting value for a steady state solution in the case a simplified power flow model is used.

Same definition as SvInjection.pInjection

Type: object or number

Reactive power at the point of common coupling. Load sign convention is used, i.e. positive sign means flow out from a node.
Starting value for a steady state solution in the case a simplified power flow model is used.

Same definition as SvInjection.qInjection

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: object or number

Minimum active power limit. The value is overwritten by values of VsCapabilityCurve, if present.

Same definition as SvInjection.pInjection

Type: boolean

The aggregate flag provides an alternative way of representing an aggregated (equivalent) element. It is applicable in cases when the dedicated classes for equivalent equipment do not have all of the attributes necessary to represent the required level of detail. In case the flag is set to “true” the single instance of equipment represents multiple pieces of equipment that have been modelled together as an aggregate equivalent obtained by a network reduction procedure. Examples would be power transformers or synchronous machines operating in parallel modelled as a single aggregate power transformer or aggregate synchronous machine.
The attribute is not used for EquivalentBranch, EquivalentShunt and EquivalentInjection.

Type: boolean

The equipment is enabled to participate in network analysis. If unspecified, the value is assumed to be true.

Type: object or number

Rated converter DC voltage, also called UdN. The attribute shall be a positive value. It is converter’s configuration data used in power flow. For instance a bipolar HVDC link with value 200 kV has a 400kV difference between the dc lines.

Same definition as BaseVoltage.nominalVoltage

Type: boolean

Specifies the availability of the equipment under normal operating conditions. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: enum (of string)

Kind of control of real power and/or DC voltage.

Must be one of:

  • "pPcc"
  • "udc"
  • "pPccAndUdcDroop"
  • "pPccAndUdcDroopWithCompensation"
  • "pPccAndUdcDroopPilot"
  • "phasePcc"

Type: object or number

Base apparent power of the converter pole. The attribute shall be a positive value.

Same definition as PowerElectronicsConnection.ratedS

Type: object or number

Switching losses, relative to the base apparent power 'baseS'. Refer to poleLossP. The attribute shall be a positive value.

Type: boolean

Specifies the availability of the equipment. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: object or number

Reactive power sharing factor among parallel converters on Uac control. The attribute shall be a positive value or zero.

Same definition as InefficientBatteryUnit.efficiencyDischarge

Type: object or number

Real power injection target in AC grid, at point of common coupling. Load sign convention is used, i.e. positive sign means flow out from a node.

Same definition as SvInjection.pInjection

Type: object or number

Reactive power injection target in AC grid, at point of common coupling. Load sign convention is used, i.e. positive sign means flow out from a node.

Same definition as SvInjection.qInjection

Type: object or number

Target value for DC voltage magnitude. The attribute shall be a positive value.

Same definition as BaseVoltage.nominalVoltage

Type: object or number

Voltage target in AC grid, at point of common coupling. The attribute shall be a positive value.

Same definition as BaseVoltage.nominalVoltage

Type: object or number

Compensation constant. Used to compensate for voltage drop when controlling voltage at a distant bus. The attribute shall be a positive value.

Same definition as PowerElectronicsConnection.r

Type: object or number

Droop constant. The pu value is obtained as D [kV/MW] x Sb / Ubdc. The attribute shall be a positive value.

Same definition as PowerElectronicsConnection.maxIFault

Type: number

The maximum quotient between the AC converter voltage (Uc) and DC voltage (Ud). A factor typically less than 1. It is converter’s configuration data used in power flow.

Type: enum (of string)

Kind of reactive power control.

Must be one of:

  • "reactivePcc"
  • "voltagePcc"
  • "powerFactorPcc"
  • "pulseWidthModulation"

Type: object or number

Valve threshold voltage, also called Uvalve. Forward voltage drop when the valve is conducting. Used in loss calculations, i.e. the switchLoss depend on numberOfValves * valveU0.

Same definition as BaseVoltage.nominalVoltage

Type: object or number

Angle between VsConverter.uv and ACDCConverter.uc. It is converter’s state variable used in power flow. The attribute shall be a positive value or zero.

Same definition as SvVoltage.angle

Type: object or number

Converter DC current, also called Id. It is converter’s state variable, result from power flow.

Same definition as ExternalNetworkInjection.maxInitialSymShCCurrent

Type: object or number

Active power loss in pole at no power transfer. It is converter’s configuration data used in power flow. The attribute shall be a positive value.

Same definition as SvInjection.pInjection

Type: integer

Number of valves in the converter. Used in loss calculations.

Type: object or number

The maximum voltage on the DC side at which the converter should operate. It is converter’s configuration data used in power flow. The attribute shall be a positive value.

Same definition as BaseVoltage.nominalVoltage

Type: number

Power factor target at the AC side, at point of common coupling. The attribute shall be a positive value.

Type: object or number

Phase target at AC side, at point of common coupling. The attribute shall be a positive value.

Same definition as SvVoltage.angle

Type: number

Magnitude of pulse-modulation factor. The attribute shall be a positive value.

Type: object or number

The minimum voltage on the DC side at which the converter should operate. It is converter’s configuration data used in power flow. The attribute shall be a positive value.

Same definition as BaseVoltage.nominalVoltage

Type: object or number

The active power loss at a DC Pole
= idleLoss + switchingLoss|Idc| + resitiveLossIdc^2.
For lossless operation Pdc=Pac.
For rectifier operation with losses Pdc=Pac-lossP.
For inverter operation with losses Pdc=Pac+lossP.
It is converter’s state variable used in power flow. The attribute shall be a positive value.

Same definition as SvInjection.pInjection

Type: object or number

It is converter’s configuration data used in power flow. Refer to poleLossP. The attribute shall be a positive value.

Same definition as PowerElectronicsConnection.r

Type: object or number

Maximum active power limit. The value is overwritten by values of VsCapabilityCurve, if present.

Same definition as SvInjection.pInjection

Type: object or number

Line-to-line converter voltage, the voltage at the AC side of the valve. It is converter’s state variable, result from power flow. The attribute shall be a positive value.

Same definition as BaseVoltage.nominalVoltage

Type: object or number

Converter voltage at the DC side, also called Ud. It is converter’s state variable, result from power flow. The attribute shall be a positive value.

Same definition as BaseVoltage.nominalVoltage

Type: object or number

Line-to-line voltage on the valve side of the converter transformer. It is converter’s state variable, result from power flow. The attribute shall be a positive value.

Same definition as BaseVoltage.nominalVoltage

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

DC side of the current source converter (CSC).
The firing angle controls the dc voltage at the converter, both for rectifier and inverter. The difference between the dc voltages of the rectifier and inverter determines the dc current. The extinction angle is used to limit the dc voltage at the inverter, if needed, and is not used in active power control. The firing angle, transformer tap position and number of connected filters are the primary means to control a current source dc line. Higher level controls are built on top, e.g. dc voltage, dc current and active power. From a steady state perspective it is sufficient to specify the wanted active power transfer (ACDCConverter.targetPpcc) and the control functions will set the dc voltage, dc current, firing angle, transformer tap position and number of connected filters to meet this. Therefore attributes targetAlpha and targetGamma are not applicable in this case.
The reactive power consumed by the converter is a function of the firing angle, transformer tap position and number of connected filter, which can be approximated with half of the active power. The losses is a function of the dc voltage and dc current.
The attributes minAlpha and maxAlpha define the range of firing angles for rectifier operation between which no discrete tap changer action takes place. The range is typically 10-18 degrees.
The attributes minGamma and maxGamma define the range of extinction angles for inverter operation between which no discrete tap changer action takes place. The range is typically 17-20 degrees.

Type: array

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

No Additional Items

Each item of this array must be:

Type: object

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

Same definition as Terminal

Type: object or number

Firing angle that determines the dc voltage at the converter dc terminal. Typical value between 10 degrees and 18 degrees for a rectifier. It is converter’s state variable, result from power flow. The attribute shall be a positive value.

Same definition as SvVoltage.angle

Type: object or number

Extinction angle. It is used to limit the dc voltage at the inverter if needed. Typical value between 17 degrees and 20 degrees for an inverter. It is converter’s state variable, result from power flow. The attribute shall be a positive value.

Same definition as SvVoltage.angle

Type: object or number

Maximum firing angle. It is converter’s configuration data used in power flow. The attribute shall be a positive value.

Same definition as SvVoltage.angle

Type: object or number

Maximum extinction angle. It is converter’s configuration data used in power flow. The attribute shall be a positive value.

Same definition as SvVoltage.angle

Type: object or number

Minimum firing angle. It is converter’s configuration data used in power flow. The attribute shall be a positive value.

Same definition as SvVoltage.angle

Type: object or number

Minimum extinction angle. It is converter’s configuration data used in power flow. The attribute shall be a positive value.

Same definition as SvVoltage.angle

Type: object or number

Target firing angle. It is converter’s control variable used in power flow. It is only applicable for rectifier if continuous tap changer control is used. Allowed values are within the range minAlpha<=targetAlpha<=maxAlpha. The attribute shall be a positive value.

Same definition as SvVoltage.angle

Type: object or number

Target extinction angle. It is converter’s control variable used in power flow. It is only applicable for inverter if continuous tap changer control is used. Allowed values are within the range minGamma<=targetGamma<=maxGamma. The attribute shall be a positive value.

Same definition as SvVoltage.angle

Type: object or number

DC current target value. It is converter’s control variable used in power flow. The attribute shall be a positive value.

Same definition as ExternalNetworkInjection.maxInitialSymShCCurrent

Type: object or number

The minimum direct current (Id) on the DC side at which the converter should operate. It is converter’s configuration data used in power flow. The attribute shall be a positive value.

Same definition as ExternalNetworkInjection.maxInitialSymShCCurrent

Type: enum (of string)

Indicates whether the DC pole is operating as an inverter or as a rectifier. It is converter’s control variable used in power flow.

Must be one of:

  • "inverter"
  • "rectifier"

Type: object or number

Active power at the point of common coupling. Load sign convention is used, i.e. positive sign means flow out from a node.
Starting value for a steady state solution in the case a simplified power flow model is used.

Same definition as SvInjection.pInjection

Type: object or number

Reactive power at the point of common coupling. Load sign convention is used, i.e. positive sign means flow out from a node.
Starting value for a steady state solution in the case a simplified power flow model is used.

Same definition as SvInjection.qInjection

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: object or number

Minimum active power limit. The value is overwritten by values of VsCapabilityCurve, if present.

Same definition as SvInjection.pInjection

Type: boolean

The aggregate flag provides an alternative way of representing an aggregated (equivalent) element. It is applicable in cases when the dedicated classes for equivalent equipment do not have all of the attributes necessary to represent the required level of detail. In case the flag is set to “true” the single instance of equipment represents multiple pieces of equipment that have been modelled together as an aggregate equivalent obtained by a network reduction procedure. Examples would be power transformers or synchronous machines operating in parallel modelled as a single aggregate power transformer or aggregate synchronous machine.
The attribute is not used for EquivalentBranch, EquivalentShunt and EquivalentInjection.

Type: boolean

The equipment is enabled to participate in network analysis. If unspecified, the value is assumed to be true.

Type: boolean

Specifies the availability of the equipment under normal operating conditions. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: object or number

Base apparent power of the converter pole. The attribute shall be a positive value.

Same definition as PowerElectronicsConnection.ratedS

Type: object or number

Switching losses, relative to the base apparent power 'baseS'. Refer to poleLossP. The attribute shall be a positive value.

Same definition as ACDCConverter.switchingLoss

Type: boolean

Specifies the availability of the equipment. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: object or number

Real power injection target in AC grid, at point of common coupling. Load sign convention is used, i.e. positive sign means flow out from a node.

Same definition as SvInjection.pInjection

Type: object or number

Target value for DC voltage magnitude. The attribute shall be a positive value.

Same definition as BaseVoltage.nominalVoltage

Type: object or number

Valve threshold voltage, also called Uvalve. Forward voltage drop when the valve is conducting. Used in loss calculations, i.e. the switchLoss depend on numberOfValves * valveU0.

Same definition as BaseVoltage.nominalVoltage

Type: integer

Number of valves in the converter. Used in loss calculations.

Type: object or number

Converter DC current, also called Id. It is converter’s state variable, result from power flow.

Same definition as ExternalNetworkInjection.maxInitialSymShCCurrent

Type: object or number

Active power loss in pole at no power transfer. It is converter’s configuration data used in power flow. The attribute shall be a positive value.

Same definition as SvInjection.pInjection

Type: object or number

The maximum direct current (Id) on the DC side at which the converter should operate. It is converter’s configuration data use in power flow. The attribute shall be a positive value.

Same definition as ExternalNetworkInjection.maxInitialSymShCCurrent

Type: object or number

The maximum voltage on the DC side at which the converter should operate. It is converter’s configuration data used in power flow. The attribute shall be a positive value.

Same definition as BaseVoltage.nominalVoltage

Type: object or number

The minimum voltage on the DC side at which the converter should operate. It is converter’s configuration data used in power flow. The attribute shall be a positive value.

Same definition as BaseVoltage.nominalVoltage

Type: object or number

The active power loss at a DC Pole
= idleLoss + switchingLoss|Idc| + resitiveLossIdc^2.
For lossless operation Pdc=Pac.
For rectifier operation with losses Pdc=Pac-lossP.
For inverter operation with losses Pdc=Pac+lossP.
It is converter’s state variable used in power flow. The attribute shall be a positive value.

Same definition as SvInjection.pInjection

Type: object or number

Rated converter DC current, also called IdN. The attribute shall be a positive value. It is converter’s configuration data used in power flow.

Same definition as ExternalNetworkInjection.maxInitialSymShCCurrent

Type: object or number

Rated converter DC voltage, also called UdN. The attribute shall be a positive value. It is converter’s configuration data used in power flow. For instance a bipolar HVDC link with value 200 kV has a 400kV difference between the dc lines.

Same definition as BaseVoltage.nominalVoltage

Type: object or number

It is converter’s configuration data used in power flow. Refer to poleLossP. The attribute shall be a positive value.

Same definition as PowerElectronicsConnection.r

Type: object or number

Maximum active power limit. The value is overwritten by values of VsCapabilityCurve, if present.

Same definition as SvInjection.pInjection

Type: object or number

Line-to-line converter voltage, the voltage at the AC side of the valve. It is converter’s state variable, result from power flow. The attribute shall be a positive value.

Same definition as BaseVoltage.nominalVoltage

Type: object or number

Converter voltage at the DC side, also called Ud. It is converter’s state variable, result from power flow. The attribute shall be a positive value.

Same definition as BaseVoltage.nominalVoltage

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: enum (of string)

Kind of active power control.

Must be one of:

  • "activePower"
  • "dcVoltage"
  • "dcCurrent"

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

The class represents equivalent objects that are the result of a network reduction. The class is the base for equivalent objects of different types.

Type: object

This class represents equivalent injections (generation or load). Voltage regulation is allowed only at the point of connection.

Type: array

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

No Additional Items

Each item of this array must be:

Type: object

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

Same definition as Terminal

Type: object or number

Maximum reactive power of the injection. Used for modelling of infeed for load flow exchange. Not used for short circuit modelling. If maxQ and minQ are not used ReactiveCapabilityCurve can be used.

Same definition as SvInjection.qInjection

Type: object or number

Minimum reactive power of the injection. Used for modelling of infeed for load flow exchange. Not used for short circuit modelling. If maxQ and minQ are not used ReactiveCapabilityCurve can be used.

Same definition as SvInjection.qInjection

Type: object or number

Positive sequence resistance. Used to represent Extended-Ward (IEC 60909).
Usage : Extended-Ward is a result of network reduction prior to the data exchange.

Same definition as PowerElectronicsConnection.r

Type: object or number

Zero sequence resistance. Used to represent Extended-Ward (IEC 60909).
Usage : Extended-Ward is a result of network reduction prior to the data exchange.

Same definition as PowerElectronicsConnection.r

Type: object or number

Negative sequence resistance. Used to represent Extended-Ward (IEC 60909).
Usage : Extended-Ward is a result of network reduction prior to the data exchange.

Same definition as PowerElectronicsConnection.r

Type: boolean

Specifies whether or not the EquivalentInjection has the capability to regulate the local voltage. If true the EquivalentInjection can regulate. If false the EquivalentInjection cannot regulate. ReactiveCapabilityCurve can only be associated with EquivalentInjection if the flag is true.

Type: boolean

Specifies the regulation status of the EquivalentInjection. True is regulating. False is not regulating.

Type: object or number

The target voltage for voltage regulation. The attribute shall be a positive value.

Same definition as BaseVoltage.nominalVoltage

Type: object or number

Positive sequence reactance. Used to represent Extended-Ward (IEC 60909).
Usage : Extended-Ward is a result of network reduction prior to the data exchange.

Same definition as PowerElectronicsConnection.x

Type: object or number

Zero sequence reactance. Used to represent Extended-Ward (IEC 60909).
Usage : Extended-Ward is a result of network reduction prior to the data exchange.

Same definition as PowerElectronicsConnection.x

Type: object or number

Negative sequence reactance. Used to represent Extended-Ward (IEC 60909).
Usage : Extended-Ward is a result of network reduction prior to the data exchange.

Same definition as PowerElectronicsConnection.x

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: object or number

Equivalent active power injection. Load sign convention is used, i.e. positive sign means flow out from a node.
Starting value for steady state solutions.

Same definition as SvInjection.pInjection

Type: object or number

Equivalent reactive power injection. Load sign convention is used, i.e. positive sign means flow out from a node.
Starting value for steady state solutions.

Same definition as SvInjection.qInjection

Type: boolean

The aggregate flag provides an alternative way of representing an aggregated (equivalent) element. It is applicable in cases when the dedicated classes for equivalent equipment do not have all of the attributes necessary to represent the required level of detail. In case the flag is set to “true” the single instance of equipment represents multiple pieces of equipment that have been modelled together as an aggregate equivalent obtained by a network reduction procedure. Examples would be power transformers or synchronous machines operating in parallel modelled as a single aggregate power transformer or aggregate synchronous machine.
The attribute is not used for EquivalentBranch, EquivalentShunt and EquivalentInjection.

Type: boolean

The equipment is enabled to participate in network analysis. If unspecified, the value is assumed to be true.

Type: boolean

Specifies the availability of the equipment under normal operating conditions. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: boolean

Specifies the availability of the equipment. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

The class represents equivalent branches. In cases where a transformer phase shift is modelled and the EquivalentBranch is spanning the same nodes, the impedance quantities for the EquivalentBranch shall consider the needed phase shift.

Type: array

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

No Additional Items

Each item of this array must be:

Type: object

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

Same definition as Terminal

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: object or number

Negative sequence series resistance from terminal sequence 1 to terminal sequence 2. Used for short circuit data exchange according to IEC 60909.
EquivalentBranch is a result of network reduction prior to the data exchange.

Same definition as PowerElectronicsConnection.r

Type: object or number

Negative sequence series resistance from terminal sequence 2 to terminal sequence 1. Used for short circuit data exchange according to IEC 60909.
EquivalentBranch is a result of network reduction prior to the data exchange.

Same definition as PowerElectronicsConnection.r

Type: object or number

Negative sequence series reactance from terminal sequence 1 to terminal sequence 2. Used for short circuit data exchange according to IEC 60909.
Usage : EquivalentBranch is a result of network reduction prior to the data exchange.

Same definition as PowerElectronicsConnection.x

Type: object or number

Negative sequence series reactance from terminal sequence 2 to terminal sequence 1. Used for short circuit data exchange according to IEC 60909.
Usage: EquivalentBranch is a result of network reduction prior to the data exchange.

Same definition as PowerElectronicsConnection.x

Type: object or number

Positive sequence series resistance from terminal sequence 1 to terminal sequence 2 . Used for short circuit data exchange according to IEC 60909.
EquivalentBranch is a result of network reduction prior to the data exchange.

Same definition as PowerElectronicsConnection.r

Type: object or number

Positive sequence series resistance from terminal sequence 2 to terminal sequence 1. Used for short circuit data exchange according to IEC 60909.
EquivalentBranch is a result of network reduction prior to the data exchange.

Same definition as PowerElectronicsConnection.r

Type: object or number

Positive sequence series reactance from terminal sequence 1 to terminal sequence 2. Used for short circuit data exchange according to IEC 60909.
Usage : EquivalentBranch is a result of network reduction prior to the data exchange.

Same definition as PowerElectronicsConnection.x

Type: object or number

Positive sequence series reactance from terminal sequence 2 to terminal sequence 1. Used for short circuit data exchange according to IEC 60909.
Usage : EquivalentBranch is a result of network reduction prior to the data exchange.

Same definition as PowerElectronicsConnection.x

Type: object or number

Resistance from terminal sequence 2 to terminal sequence 1 .Used for steady state power flow. This attribute is optional and represent unbalanced network such as off-nominal phase shifter. If only EquivalentBranch.r is given, then EquivalentBranch.r21 is assumed equal to EquivalentBranch.r.
Usage rule : EquivalentBranch is a result of network reduction prior to the data exchange.

Same definition as PowerElectronicsConnection.r

Type: object or number

Reactance from terminal sequence 2 to terminal sequence 1. Used for steady state power flow. This attribute is optional and represents an unbalanced network such as off-nominal phase shifter. If only EquivalentBranch.x is given, then EquivalentBranch.x21 is assumed equal to EquivalentBranch.x.
Usage rule: EquivalentBranch is a result of network reduction prior to the data exchange.

Same definition as PowerElectronicsConnection.x

Type: object or number

Zero sequence series resistance from terminal sequence 1 to terminal sequence 2. Used for short circuit data exchange according to IEC 60909.
EquivalentBranch is a result of network reduction prior to the data exchange.

Same definition as PowerElectronicsConnection.r

Type: object or number

Zero sequence series resistance from terminal sequence 2 to terminal sequence 1. Used for short circuit data exchange according to IEC 60909.
Usage : EquivalentBranch is a result of network reduction prior to the data exchange.

Same definition as PowerElectronicsConnection.r

Type: object or number

Zero sequence series reactance from terminal sequence 1 to terminal sequence 2. Used for short circuit data exchange according to IEC 60909.
Usage : EquivalentBranch is a result of network reduction prior to the data exchange.

Same definition as PowerElectronicsConnection.x

Type: object or number

Zero sequence series reactance from terminal sequence 2 to terminal sequence 1. Used for short circuit data exchange according to IEC 60909.
Usage : EquivalentBranch is a result of network reduction prior to the data exchange.

Same definition as PowerElectronicsConnection.x

Type: boolean

The aggregate flag provides an alternative way of representing an aggregated (equivalent) element. It is applicable in cases when the dedicated classes for equivalent equipment do not have all of the attributes necessary to represent the required level of detail. In case the flag is set to “true” the single instance of equipment represents multiple pieces of equipment that have been modelled together as an aggregate equivalent obtained by a network reduction procedure. Examples would be power transformers or synchronous machines operating in parallel modelled as a single aggregate power transformer or aggregate synchronous machine.
The attribute is not used for EquivalentBranch, EquivalentShunt and EquivalentInjection.

Type: boolean

The equipment is enabled to participate in network analysis. If unspecified, the value is assumed to be true.

Type: boolean

Specifies the availability of the equipment under normal operating conditions. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: boolean

Specifies the availability of the equipment. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

The class represents equivalent shunts.

Type: array

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

No Additional Items

Each item of this array must be:

Type: object

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

Same definition as Terminal

Type: boolean

The aggregate flag provides an alternative way of representing an aggregated (equivalent) element. It is applicable in cases when the dedicated classes for equivalent equipment do not have all of the attributes necessary to represent the required level of detail. In case the flag is set to “true” the single instance of equipment represents multiple pieces of equipment that have been modelled together as an aggregate equivalent obtained by a network reduction procedure. Examples would be power transformers or synchronous machines operating in parallel modelled as a single aggregate power transformer or aggregate synchronous machine.
The attribute is not used for EquivalentBranch, EquivalentShunt and EquivalentInjection.

Type: boolean

The equipment is enabled to participate in network analysis. If unspecified, the value is assumed to be true.

Type: boolean

Specifies the availability of the equipment under normal operating conditions. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: boolean

Specifies the availability of the equipment. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

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.

Type: array

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

No Additional Items

Each item of this array must be:

Type: object

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

Same definition as Terminal

Type: array

State variable for status.

No Additional Items

Each item of this array must be:

Type: object or number

Maximum allowable peak short-circuit current of busbar (Ipmax in IEC 60909-0).
Mechanical limit of the busbar in the substation itself. Used for short circuit data exchange according to IEC 60909.

Same definition as ExternalNetworkInjection.maxInitialSymShCCurrent

Type: boolean

The aggregate flag provides an alternative way of representing an aggregated (equivalent) element. It is applicable in cases when the dedicated classes for equivalent equipment do not have all of the attributes necessary to represent the required level of detail. In case the flag is set to “true” the single instance of equipment represents multiple pieces of equipment that have been modelled together as an aggregate equivalent obtained by a network reduction procedure. Examples would be power transformers or synchronous machines operating in parallel modelled as a single aggregate power transformer or aggregate synchronous machine.
The attribute is not used for EquivalentBranch, EquivalentShunt and EquivalentInjection.

Type: boolean

The equipment is enabled to participate in network analysis. If unspecified, the value is assumed to be true.

Type: boolean

Specifies the availability of the equipment under normal operating conditions. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: boolean

Specifies the availability of the equipment. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

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

Type: object

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.

Type: array

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

No Additional Items

Each item of this array must be:

Type: object

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

Same definition as Terminal

Type: array

Represents a single wire of an alternating current line segment.

No Additional Items

Each item of this array must be:

Type: object

Represents a single wire of an alternating current line segment.

Type: integer

Number designation for this line segment phase. Each line segment phase within a line segment should have a unique sequence number. This is useful for unbalanced modelling to bind the mathematical model (PhaseImpedanceData of PerLengthPhaseImpedance) with the connectivity model (this class) and the physical model (WirePosition) without tight coupling.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: boolean

The aggregate flag provides an alternative way of representing an aggregated (equivalent) element. It is applicable in cases when the dedicated classes for equivalent equipment do not have all of the attributes necessary to represent the required level of detail. In case the flag is set to “true” the single instance of equipment represents multiple pieces of equipment that have been modelled together as an aggregate equivalent obtained by a network reduction procedure. Examples would be power transformers or synchronous machines operating in parallel modelled as a single aggregate power transformer or aggregate synchronous machine.
The attribute is not used for EquivalentBranch, EquivalentShunt and EquivalentInjection.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: boolean

The equipment is enabled to participate in network analysis. If unspecified, the value is assumed to be true.

Type: object or number

Segment length for calculating line section capabilities.

Same definition as HydroGeneratingUnit.dropHeight

Type: boolean

Specifies the availability of the equipment under normal operating conditions. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: boolean

Specifies the availability of the equipment. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: object or number

Zero sequence shunt (charging) susceptance, uniformly distributed, of the entire line section.

Same definition as LinearShuntCompensatorPhase.bPerSection

Type: object or number

Positive sequence shunt (charging) susceptance, uniformly distributed, of the entire line section. This value represents the full charging over the full length of the line.

Same definition as LinearShuntCompensatorPhase.bPerSection

Type: object or number

Zero sequence shunt (charging) conductance, uniformly distributed, of the entire line section.

Same definition as LinearShuntCompensatorPhase.gPerSection

Type: object or number

Positive sequence shunt (charging) conductance, uniformly distributed, of the entire line section.

Same definition as LinearShuntCompensatorPhase.gPerSection

Type: object or number

Positive sequence series resistance of the entire line section.

Same definition as PowerElectronicsConnection.r

Type: object or number

Zero sequence series resistance of the entire line section.

Same definition as PowerElectronicsConnection.r

Type: object or number

Maximum permitted temperature at the end of SC for the calculation of minimum short-circuit currents. Used for short circuit data exchange according to IEC 60909.

Type: object or number

Positive sequence series reactance of the entire line section.

Same definition as PowerElectronicsConnection.x

Type: object or number

Zero sequence series reactance of the entire line section.

Same definition as PowerElectronicsConnection.x

Type: object

A two terminal and power conducting device of negligible impedance and length represented as zero impedance device that can be used to connect auxiliary equipment to its terminals.

Type: array

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

No Additional Items

Each item of this array must be:

Type: object

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

Same definition as Terminal

Type: array

Represents a single wire of an alternating current wire segment.

No Additional Items

Each item of this array must be:

Type: object

Represents a single wire of an alternating current wire segment.

Type: integer

Number designation for this wire segment phase. Each wire segment phase within a wire segment should have a unique sequence number.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: array

State variable for status.

No Additional Items

Each item of this array must be:

Type: boolean

The aggregate flag provides an alternative way of representing an aggregated (equivalent) element. It is applicable in cases when the dedicated classes for equivalent equipment do not have all of the attributes necessary to represent the required level of detail. In case the flag is set to “true” the single instance of equipment represents multiple pieces of equipment that have been modelled together as an aggregate equivalent obtained by a network reduction procedure. Examples would be power transformers or synchronous machines operating in parallel modelled as a single aggregate power transformer or aggregate synchronous machine.
The attribute is not used for EquivalentBranch, EquivalentShunt and EquivalentInjection.

Type: boolean

The equipment is enabled to participate in network analysis. If unspecified, the value is assumed to be true.

Type: boolean

Specifies the availability of the equipment under normal operating conditions. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: boolean

Specifies the availability of the equipment. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: object or number

Segment length for calculating line section capabilities.

Same definition as HydroGeneratingUnit.dropHeight

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

A conducting equipment used to represent a connection to ground which is typically used to compensate earth faults. An earth fault compensator device modelled with a single terminal implies a second terminal solidly connected to ground. If two terminals are modelled, the ground is not assumed and normal connection rules apply.

Type: array

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

No Additional Items

Each item of this array must be:

Type: object

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

Same definition as Terminal

Type: object or number

The nominal reactance. This is the operating point (normally over compensation) that is defined based on the resonance point in the healthy network condition. The impedance is calculated based on nominal voltage divided by position current.

Same definition as PowerElectronicsConnection.x

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: boolean

The aggregate flag provides an alternative way of representing an aggregated (equivalent) element. It is applicable in cases when the dedicated classes for equivalent equipment do not have all of the attributes necessary to represent the required level of detail. In case the flag is set to “true” the single instance of equipment represents multiple pieces of equipment that have been modelled together as an aggregate equivalent obtained by a network reduction procedure. Examples would be power transformers or synchronous machines operating in parallel modelled as a single aggregate power transformer or aggregate synchronous machine.
The attribute is not used for EquivalentBranch, EquivalentShunt and EquivalentInjection.

Type: boolean

The equipment is enabled to participate in network analysis. If unspecified, the value is assumed to be true.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: boolean

Specifies the availability of the equipment under normal operating conditions. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: boolean

Specifies the availability of the equipment. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: enum (of string)

The mode of operation of the Petersen coil.

Must be one of:

  • "fixed"
  • "manual"
  • "automaticPositioning"

Type: object or number

The offset current that the Petersen coil controller is operating from the resonant point. This is normally a fixed amount for which the controller is configured and could be positive or negative. Typically 0 to 60 A depending on voltage and resonance conditions.

Same definition as ExternalNetworkInjection.maxInitialSymShCCurrent

Type: object or number

The control current used to control the Petersen coil also known as the position current. Typically in the range of 20 mA to 200 mA.

Same definition as ExternalNetworkInjection.maxInitialSymShCCurrent

Type: object

A Clamp is a galvanic connection at a line segment where other equipment is connected. A Clamp does not cut the line segment.
A Clamp is ConductingEquipment and has one Terminal with an associated ConnectivityNode. Any other ConductingEquipment can be connected to the Clamp ConnectivityNode.

Type: array

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

No Additional Items

Each item of this array must be:

Type: object

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

Same definition as Terminal

Type: array

State variable for status.

No Additional Items

Each item of this array must be:

Type: boolean

The aggregate flag provides an alternative way of representing an aggregated (equivalent) element. It is applicable in cases when the dedicated classes for equivalent equipment do not have all of the attributes necessary to represent the required level of detail. In case the flag is set to “true” the single instance of equipment represents multiple pieces of equipment that have been modelled together as an aggregate equivalent obtained by a network reduction procedure. Examples would be power transformers or synchronous machines operating in parallel modelled as a single aggregate power transformer or aggregate synchronous machine.
The attribute is not used for EquivalentBranch, EquivalentShunt and EquivalentInjection.

Type: boolean

The equipment is enabled to participate in network analysis. If unspecified, the value is assumed to be true.

Type: object or number

The length to the place where the clamp is located starting from side one of the line segment, i.e. the line segment terminal with sequence number equal to 1.

Same definition as HydroGeneratingUnit.dropHeight

Type: boolean

Specifies the availability of the equipment under normal operating conditions. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: boolean

Specifies the availability of the equipment. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

A Series Compensator is a series capacitor or reactor or an AC transmission line without charging susceptance. It is a two terminal device.

Type: array

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

No Additional Items

Each item of this array must be:

Type: object

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

Same definition as Terminal

Type: array

State variable for status.

No Additional Items

Each item of this array must be:

Type: boolean

The aggregate flag provides an alternative way of representing an aggregated (equivalent) element. It is applicable in cases when the dedicated classes for equivalent equipment do not have all of the attributes necessary to represent the required level of detail. In case the flag is set to “true” the single instance of equipment represents multiple pieces of equipment that have been modelled together as an aggregate equivalent obtained by a network reduction procedure. Examples would be power transformers or synchronous machines operating in parallel modelled as a single aggregate power transformer or aggregate synchronous machine.
The attribute is not used for EquivalentBranch, EquivalentShunt and EquivalentInjection.

Type: boolean

Describe if a metal oxide varistor (mov) for over voltage protection is configured in parallel with the series compensator. It is used for short circuit calculations.

Type: object or number

The maximum current the varistor is designed to handle at specified duration. It is used for short circuit calculations and exchanged only if SeriesCompensator.varistorPresent is true.
The attribute shall be a positive value.

Same definition as ExternalNetworkInjection.maxInitialSymShCCurrent

Type: object or number

The dc voltage at which the varistor starts conducting. It is used for short circuit calculations and exchanged only if SeriesCompensator.varistorPresent is true.

Same definition as BaseVoltage.nominalVoltage

Type: boolean

Specifies the availability of the equipment under normal operating conditions. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: boolean

The equipment is enabled to participate in network analysis. If unspecified, the value is assumed to be true.

Type: boolean

Specifies the availability of the equipment. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

A point where the system is grounded used for connecting conducting equipment to ground. The power system model can have any number of grounds.

Type: array

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

No Additional Items

Each item of this array must be:

Type: object

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

Same definition as Terminal

Type: array

State variable for status.

No Additional Items

Each item of this array must be:

Type: boolean

The aggregate flag provides an alternative way of representing an aggregated (equivalent) element. It is applicable in cases when the dedicated classes for equivalent equipment do not have all of the attributes necessary to represent the required level of detail. In case the flag is set to “true” the single instance of equipment represents multiple pieces of equipment that have been modelled together as an aggregate equivalent obtained by a network reduction procedure. Examples would be power transformers or synchronous machines operating in parallel modelled as a single aggregate power transformer or aggregate synchronous machine.
The attribute is not used for EquivalentBranch, EquivalentShunt and EquivalentInjection.

Type: boolean

The equipment is enabled to participate in network analysis. If unspecified, the value is assumed to be true.

Type: boolean

Specifies the availability of the equipment under normal operating conditions. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: boolean

Specifies the availability of the equipment. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

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.

Type: array

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

No Additional Items

Each item of this array must be:

Type: object

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

Same definition as Terminal

Type: array

State variable for switch.

No Additional Items

Each item of this array must be:

Type: object

State variable for switch.

Type: enum (of string)

The terminal phase at which the connection is applied. If missing, the injection is assumed to be balanced among non-neutral phases.

Same definition as SvVoltage.phase

Type: boolean

The attribute tells if the computed state of the switch is considered open.

Type: array

Single phase of a multi-phase switch when its attributes might be different per phase.

No Additional Items

Each item of this array must be:

Type: object

Single phase of a multi-phase switch when its attributes might be different per phase.

Type: boolean

Used in cases when no Measurement for the status value is present. If the SwitchPhase has a status measurement the Discrete.normalValue is expected to match with this value.

Type: enum (of string)

Phase of this SwitchPhase on the side with terminal sequence number equal to 1. Should be a phase contained in that terminal’s phases attribute.

Same definition as SvVoltage.phase

Type: enum (of string)

Phase of this SwitchPhase on the side with terminal sequence number equal to 2. Should be a phase contained in that terminal’s Terminal.phases attribute.

Same definition as SvVoltage.phase

Type: boolean

The attribute tells if the switch is considered closed when used as input to topology processing.

Type: object or number

The maximum continuous current carrying capacity in amps governed by the device material and construction.
The attribute shall be a positive value.

Same definition as ExternalNetworkInjection.maxInitialSymShCCurrent

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: array

State variable for status.

No Additional Items

Each item of this array must be:

Type: boolean

The attribute tells if the switch is considered open when used as input to topology processing.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: boolean

The aggregate flag provides an alternative way of representing an aggregated (equivalent) element. It is applicable in cases when the dedicated classes for equivalent equipment do not have all of the attributes necessary to represent the required level of detail. In case the flag is set to “true” the single instance of equipment represents multiple pieces of equipment that have been modelled together as an aggregate equivalent obtained by a network reduction procedure. Examples would be power transformers or synchronous machines operating in parallel modelled as a single aggregate power transformer or aggregate synchronous machine.
The attribute is not used for EquivalentBranch, EquivalentShunt and EquivalentInjection.

Type: boolean

The equipment is enabled to participate in network analysis. If unspecified, the value is assumed to be true.

Type: boolean

Specifies the availability of the equipment under normal operating conditions. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: object or number

The length to the place where the cut is located starting from side one of the cut line segment, i.e. the line segment Terminal with sequenceNumber equal to 1.

Same definition as HydroGeneratingUnit.dropHeight

Type: boolean

The attribute is used in cases when no Measurement for the status value is present. If the Switch has a status measurement the Discrete.normalValue is expected to match with the Switch.normalOpen.

Type: boolean

Specifies the availability of the equipment. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: object or number

The maximum continuous current carrying capacity in amps governed by the device material and construction.
The attribute shall be a positive value.

Same definition as ExternalNetworkInjection.maxInitialSymShCCurrent

Type: boolean

Branch is retained in the topological solution. The flow through retained switches will normally be calculated in power flow.

Type: integer

The switch on count since the switch was last reset or initialized.

Type: string

The date and time when the switch was last switched on.

Type: object or number

The maximum fault current a breaking device can break safely under prescribed conditions of use.

Same definition as ExternalNetworkInjection.maxInitialSymShCCurrent

Type: boolean

If true, the switch is locked. The resulting switch state is a combination of locked and Switch.open attributes as follows:

  • locked=true and Switch.open=true. The resulting state is open and locked;
  • locked=false and Switch.open=true. The resulting state is open;
  • locked=false and Switch.open=false. The resulting state is closed.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

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.

Type: array

An assembly of two or more coupled windings that transform electrical power between voltage levels. These windings are bound on a common core and placed in the same tank. Transformer tank can be used to model both single-phase and 3-phase transformers.

No Additional Items

Each item of this array must be:

Type: object

An assembly of two or more coupled windings that transform electrical power between voltage levels. These windings are bound on a common core and placed in the same tank. Transformer tank can be used to model both single-phase and 3-phase transformers.

Type: array

Transformer tank end represents an individual winding for unbalanced models or for transformer tanks connected into a bank (and bank is modelled with the PowerTransformer).

No Additional Items

Each item of this array must be:

Type: object

Transformer tank end represents an individual winding for unbalanced models or for transformer tanks connected into a bank (and bank is modelled with the PowerTransformer).

Type: array

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

No Additional Items

Each item of this array must be:

Type: object

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

Same definition as Terminal

Type: integer

Number for this transformer end, corresponding to the end's order in the power transformer vector group or phase angle clock number. Highest voltage winding should be 1. Each end within a power transformer should have a unique subsequent end number. Note the transformer end number need not match the terminal sequence number.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: boolean

The aggregate flag provides an alternative way of representing an aggregated (equivalent) element. It is applicable in cases when the dedicated classes for equivalent equipment do not have all of the attributes necessary to represent the required level of detail. In case the flag is set to “true” the single instance of equipment represents multiple pieces of equipment that have been modelled together as an aggregate equivalent obtained by a network reduction procedure. Examples would be power transformers or synchronous machines operating in parallel modelled as a single aggregate power transformer or aggregate synchronous machine.
The attribute is not used for EquivalentBranch, EquivalentShunt and EquivalentInjection.

Type: boolean

The equipment is enabled to participate in network analysis. If unspecified, the value is assumed to be true.

Type: boolean

Specifies the availability of the equipment under normal operating conditions. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: boolean

Specifies the availability of the equipment. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: array

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).

No Additional Items

Each item of this array must be:

Type: object

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).

Type: array

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

No Additional Items

Each item of this array must be:

Type: object

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

Same definition as Terminal

Type: object

Transformer mesh impedance (Delta-model) between transformer ends.
The typical case is that this class describes the impedance between two transformer ends pair-wise, i.e. the cardinalities at both transformer end associations are 1. However, in cases where two or more transformer ends are modelled the cardinalities are larger than 1.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: object

Transformer star impedance (Pi-model) that accurately reflects impedance for transformers with 2 or 3 windings. For transformers with 4 or more windings, TransformerMeshImpedance class shall be used.
For transmission networks use PowerTransformerEnd impedances (r, r0, x, x0, b, b0, g and g0).

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: object

The transformer core admittance. Used to specify the core admittance of a transformer in a manner that can be shared among power transformers.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: integer

Terminal voltage phase angle displacement where 360 degrees are represented with clock hours. The valid values are 0 to 11. For example, for the secondary side end of a transformer with vector group code of 'Dyn11', specify the connection kind as wye with neutral and specify the phase angle of the clock as 11. The clock value of the transformer end number specified as 1, is assumed to be zero. Note the transformer end number is not assumed to be the same as the terminal sequence number.

Type: object or number

Resistance (star-model) of the transformer end.
The attribute shall be equal to or greater than zero for non-equivalent transformers.

Same definition as PowerElectronicsConnection.r

Type: object or number

Normal apparent power rating.
The attribute shall be a positive value. For a two-winding transformer the values for the high and low voltage sides shall be identical.

Same definition as PowerElectronicsConnection.ratedS

Type: object or number

Rated voltage: phase-phase for three-phase windings, and either phase-phase or phase-neutral for single-phase windings.
A high voltage side, as given by TransformerEnd.endNumber, shall have a ratedU that is greater than or equal to ratedU for the lower voltage sides.
The attribute shall be a positive value.

Same definition as BaseVoltage.nominalVoltage

Type: integer

Number for this transformer end, corresponding to the end's order in the power transformer vector group or phase angle clock number. Highest voltage winding should be 1. Each end within a power transformer should have a unique subsequent end number. Note the transformer end number need not match the terminal sequence number.

Type: boolean

(for Yn and Zn connections) True if the neutral is solidly grounded.

Type: object or number

(for Yn and Zn connections) Resistance part of neutral impedance where 'grounded' is true.

Same definition as PowerElectronicsConnection.r

Type: object or number

(for Yn and Zn connections) Reactive part of neutral impedance where 'grounded' is true.

Same definition as PowerElectronicsConnection.x

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: array

State variable for status.

No Additional Items

Each item of this array must be:

Type: object or number

The highest operating current (Ib in IEC 60909-0) before short circuit (depends on network configuration and relevant reliability philosophy). It is used for calculation of the impedance correction factor KT defined in IEC 60909-0.

Same definition as ExternalNetworkInjection.maxInitialSymShCCurrent

Type: object or number

The highest operating voltage (Ub in IEC 60909-0) before short circuit. It is used for calculation of the impedance correction factor KT defined in IEC 60909-0. This is worst case voltage on the low side winding (3.7.1 of IEC 60909:2001). Used to define operating conditions.

Same definition as BaseVoltage.nominalVoltage

Type: object or number

The angle of power factor before short circuit (phib in IEC 60909-0). It is used for calculation of the impedance correction factor KT defined in IEC 60909-0. This is the worst case power factor. Used to define operating conditions.

Same definition as SvVoltage.angle

Type: object or number

The minimum operating voltage (uQmin in IEC 60909-0) at the high voltage side (Q side) of the unit transformer of the power station unit. A value well established from long-term operating experience of the system. It is used for calculation of the impedance correction factor KG defined in IEC 60909-0.

Same definition as BaseVoltage.nominalVoltage

Type: boolean

Indicates whether the machine is part of a power station unit. Used for short circuit data exchange according to IEC 60909. It has an impact on how the correction factors are calculated for transformers, since the transformer is not necessarily part of a synchronous machine and generating unit. It is not always possible to derive this information from the model. This is why the attribute is necessary.

Type: boolean

It is used to define if the data (other attributes related to short circuit data exchange) defines long term operational conditions or not. Used for short circuit data exchange according to IEC 60909.

Type: string

Vector group of the transformer for protective relaying, e.g., Dyn1. For unbalanced transformers, this may not be simply determined from the constituent winding connections and phase angle displacements.

The vectorGroup string consists of the following components in the order listed: high voltage winding connection, mid voltage winding connection (for three winding transformers), phase displacement clock number from 0 to 11, low voltage winding connection
phase displacement clock number from 0 to 11. The winding connections are D (delta), Y (wye), YN (wye with neutral), Z (zigzag), ZN (zigzag with neutral), A (auto transformer). Upper case means the high voltage, lower case mid or low. The high voltage winding always has clock position 0 and is not included in the vector group string. Some examples: YNy0 (two winding wye to wye with no phase displacement), YNd11 (two winding wye to delta with 330 degrees phase displacement), YNyn0d5 (three winding transformer wye with neutral high voltage, wye with neutral mid voltage and no phase displacement, delta low voltage with 150 degrees displacement).

Phase displacement is defined as the angular difference between the phasors representing the voltages between the neutral point (real or imaginary) and the corresponding terminals of two windings, a positive sequence voltage system being applied to the high-voltage terminals, following each other in alphabetical sequence if they are lettered, or in numerical sequence if they are numbered: the phasors are assumed to rotate in a counter-clockwise sense.

Type: boolean

The aggregate flag provides an alternative way of representing an aggregated (equivalent) element. It is applicable in cases when the dedicated classes for equivalent equipment do not have all of the attributes necessary to represent the required level of detail. In case the flag is set to “true” the single instance of equipment represents multiple pieces of equipment that have been modelled together as an aggregate equivalent obtained by a network reduction procedure. Examples would be power transformers or synchronous machines operating in parallel modelled as a single aggregate power transformer or aggregate synchronous machine.
The attribute is not used for EquivalentBranch, EquivalentShunt and EquivalentInjection.

Type: boolean

The equipment is enabled to participate in network analysis. If unspecified, the value is assumed to be true.

Type: boolean

Specifies the availability of the equipment under normal operating conditions. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: boolean

Specifies the availability of the equipment. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

Mechanism for changing transformer winding tap positions.

Type: object

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).

Type: array

State variable for transformer tap step.

No Additional Items

Each item of this array must be:

Type: object

State variable for transformer tap step.

Type: number

The floating point tap position. This is not the tap ratio, but rather the tap step position as defined by the related tap changer model and normally is constrained to be within the range of minimum and maximum tap positions.

Type: object

Describes behaviour specific to tap changers, e.g. how the voltage at the end of a line varies with the load level and compensation of the voltage drop by tap adjustment.

Type: object or number

Maximum allowed regulated voltage on the PT secondary, regardless of line drop compensation. Sometimes referred to as first-house protection.

Same definition as BaseVoltage.nominalVoltage

Type: boolean

If true, the line drop compensation is to be applied.

Type: object or number

Line drop compensator resistance setting for normal (forward) power flow.

Same definition as PowerElectronicsConnection.r

Type: object or number

Line drop compensator reactance setting for normal (forward) power flow.

Same definition as PowerElectronicsConnection.x

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: boolean

The regulation is performed in a discrete mode. This applies to equipment with discrete controls, e.g. tap changers and shunt compensators.

Type: enum (of string)

The regulating control mode presently available. This specification allows for determining the kind of regulation without need for obtaining the units from a schedule.

Must be one of:

  • "voltage"
  • "activePower"
  • "reactivePower"
  • "currentFlow"
  • "admittance"
  • "timeScheduled"
  • "temperature"
  • "powerFactor"

Type: enum (of string)

Phase voltage controlling this regulator, measured at regulator location.

Same definition as Terminal.phases

Type: number

This is a deadband used with discrete control to avoid excessive update of controls like tap changers and shunt compensator banks while regulating. The units of those appropriate for the mode. The attribute shall be a positive value or zero. If RegulatingControl.discrete is set to "false", the RegulatingControl.targetDeadband is to be ignored.
Note that for instance, if the targetValue is 100 kV and the targetDeadband is 2 kV the range is from 99 to 101 kV.

Type: number

The target value specified for case input. This value can be used for the target value without the use of schedules. The value has the units appropriate to the mode attribute.

Type: boolean

The flag tells if regulation is enabled.

Type: number

Maximum allowed target value (RegulatingControl.targetValue).

Type: number

Minimum allowed target value (RegulatingControl.targetValue).

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: enum (of string)

Specifies the regulation control mode (voltage or reactive) of the RatioTapChanger.

Must be one of:

  • "volt"
  • "reactive"

Type: integer

Highest possible tap step position, advance from neutral.
The attribute shall be greater than lowStep.

Type: object or number

For an LTC, the delay for initial tap changer operation (first step change).

Same definition as RegularIntervalSchedule.timeStep

Type: integer

Lowest possible tap step position, retard from neutral.

Type: boolean

Specifies whether or not a TapChanger has load tap changing capabilities.

Type: integer

The neutral tap step position for this winding.
The attribute shall be equal to or greater than lowStep and equal or less than highStep.
It is the step position where the voltage is neutralU when the other terminals of the transformer are at the ratedU. If there are other tap changers on the transformer those taps are kept constant at their neutralStep.

Type: object or number

Voltage at which the winding operates at the neutral tap setting. It is the voltage at the terminal of the PowerTransformerEnd associated with the tap changer when all tap changers on the transformer are at their neutralStep position. Normally neutralU of the tap changer is the same as ratedU of the PowerTransformerEnd, but it can differ in special cases such as when the tapping mechanism is separate from the winding more common on lower voltage transformers.
This attribute is not relevant for PhaseTapChangerAsymmetrical, PhaseTapChangerSymmetrical and PhaseTapChangerLinear.

Same definition as BaseVoltage.nominalVoltage

Type: integer

The tap step position used in "normal" network operation for this winding. For a "Fixed" tap changer indicates the current physical tap setting.
The attribute shall be equal to or greater than lowStep and equal to or less than highStep.

Type: boolean

Specifies the regulation status of the equipment. True is regulating, false is not regulating.

Type: object or number

For an LTC, the delay for subsequent tap changer operation (second and later step changes).

Same definition as RegularIntervalSchedule.timeStep

Type: number

Tap changer position.
Starting step for a steady state solution. Non integer values are allowed to support continuous tap variables. The reasons for continuous value are to support study cases where no discrete tap changer has yet been designed, a solution where a narrow voltage band forces the tap step to oscillate or to accommodate for a continuous solution as input.
The attribute shall be equal to or greater than lowStep and equal to or less than highStep.

Type: object or number

Tap step increment, in per cent of rated voltage of the power transformer end, per step position.
When the increment is negative, the voltage decreases when the tap step increases.

Same definition as InefficientBatteryUnit.efficiencyDischarge

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

A transformer phase shifting tap model that controls the phase angle difference across the power transformer and potentially the active power flow through the power transformer. This phase tap model may also impact the voltage magnitude.

Type: array

State variable for transformer tap step.

No Additional Items

Each item of this array must be:

Type: object

Describes behaviour specific to tap changers, e.g. how the voltage at the end of a line varies with the load level and compensation of the voltage drop by tap adjustment.

Same definition as TapChanger.TapChangerControl

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: integer

Highest possible tap step position, advance from neutral.
The attribute shall be greater than lowStep.

Type: object or number

For an LTC, the delay for initial tap changer operation (first step change).

Same definition as RegularIntervalSchedule.timeStep

Type: integer

Lowest possible tap step position, retard from neutral.

Type: boolean

Specifies whether or not a TapChanger has load tap changing capabilities.

Type: integer

The neutral tap step position for this winding.
The attribute shall be equal to or greater than lowStep and equal or less than highStep.
It is the step position where the voltage is neutralU when the other terminals of the transformer are at the ratedU. If there are other tap changers on the transformer those taps are kept constant at their neutralStep.

Type: object or number

Voltage at which the winding operates at the neutral tap setting. It is the voltage at the terminal of the PowerTransformerEnd associated with the tap changer when all tap changers on the transformer are at their neutralStep position. Normally neutralU of the tap changer is the same as ratedU of the PowerTransformerEnd, but it can differ in special cases such as when the tapping mechanism is separate from the winding more common on lower voltage transformers.
This attribute is not relevant for PhaseTapChangerAsymmetrical, PhaseTapChangerSymmetrical and PhaseTapChangerLinear.

Same definition as BaseVoltage.nominalVoltage

Type: integer

The tap step position used in "normal" network operation for this winding. For a "Fixed" tap changer indicates the current physical tap setting.
The attribute shall be equal to or greater than lowStep and equal to or less than highStep.

Type: object or number

The phase angle between the in-phase winding and the out-of -phase winding used for creating phase shift. The out-of-phase winding produces what is known as the difference voltage. Setting this angle to 90 degrees is not the same as a symmetrical transformer. The attribute can only be multiples of 30 degrees. The allowed range is -150 degrees to 150 degrees excluding 0.

Same definition as SvVoltage.angle

Type: object or number

For an LTC, the delay for subsequent tap changer operation (second and later step changes).

Same definition as RegularIntervalSchedule.timeStep

Type: number

Tap changer position.
Starting step for a steady state solution. Non integer values are allowed to support continuous tap variables. The reasons for continuous value are to support study cases where no discrete tap changer has yet been designed, a solution where a narrow voltage band forces the tap step to oscillate or to accommodate for a continuous solution as input.
The attribute shall be equal to or greater than lowStep and equal to or less than highStep.

Type: object or number

The reactance depends on the tap position according to a "u" shaped curve. The maximum reactance (xMax) appears at the low and high tap positions. Depending on the “u” curve the attribute can be either higher or lower than PowerTransformerEnd.x.

Same definition as PowerElectronicsConnection.x

Type: object or number

The voltage step increment on the out of phase winding (the PowerTransformerEnd where the TapChanger is located) specified in percent of rated voltage of the PowerTransformerEnd. A positive value means a positive voltage variation from the Terminal at the PowerTransformerEnd, where the TapChanger is located, into the transformer.
When the increment is negative, the voltage decreases when the tap step increases.

Same definition as InefficientBatteryUnit.efficiencyDischarge

Type: object or number

The reactance depends on the tap position according to a "u" shaped curve. The maximum reactance (xMax) appears at the low and high tap positions. Depending on the “u” curve the attribute can be either higher or lower than PowerTransformerEnd.x.

Same definition as PowerElectronicsConnection.x

Type: object or number

The reactance depend on the tap position according to a "u" shaped curve. The minimum reactance (xMin) appear at the mid tap position. PowerTransformerEnd.x shall be consistent with PhaseTapChangerLinear.xMin and PhaseTapChangerNonLinear.xMin. In case of inconsistency, PowerTransformerEnd.x shall be used.

Same definition as PowerElectronicsConnection.x

Type: object or number

The reactance depends on the tap position according to a "u" shaped curve. The minimum reactance (xMin) appears at the mid tap position. PowerTransformerEnd.x shall be consistent with PhaseTapChangerLinear.xMin and PhaseTapChangerNonLinear.xMin. In case of inconsistency, PowerTransformerEnd.x shall be used.

Same definition as PowerElectronicsConnection.x

Type: boolean

Specifies the regulation status of the equipment. True is regulating, false is not regulating.

Type: object or number

Phase shift per step position. A positive value indicates a positive angle variation from the Terminal at the PowerTransformerEnd, where the TapChanger is located, into the transformer.
The actual phase shift increment might be more accurately computed from the symmetrical or asymmetrical models or a tap step table lookup if those are available.

Same definition as SvVoltage.angle

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

Specifies a set of equipment that works together to control a power system quantity such as voltage or flow.
Remote bus voltage control is possible by specifying the controlled terminal located at some place remote from the controlling equipment.
The specified terminal shall be associated with the connectivity node of the controlled point. The most specific subtype of RegulatingControl shall be used in case such equipment participate in the control, e.g. TapChangerControl for tap changers.
For flow control, load sign convention is used, i.e. positive sign means flow out from a TopologicalNode (bus) into the conducting equipment.
The attribute minAllowedTargetValue and maxAllowedTargetValue are required in the following cases:
- For a power generating module operated in power factor control mode to specify maximum and minimum power factor values;
- Whenever it is necessary to have an off center target voltage for the tap changer regulator. For instance, due to long cables to off shore wind farms and the need to have a simpler setup at the off shore transformer platform, the voltage is controlled from the land at the connection point for the off shore wind farm. Since there usually is a voltage rise along the cable, there is typical and overvoltage of up 3-4 kV compared to the on shore station. Thus in normal operation the tap changer on the on shore station is operated with a target set point, which is in the lower parts of the dead band.
The attributes minAllowedTargetValue and maxAllowedTargetValue are not related to the attribute targetDeadband and thus they are not treated as an alternative of the targetDeadband. They are needed due to limitations in the local substation controller. The attribute targetDeadband is used to prevent the power flow from move the tap position in circles (hunting) that is to be used regardless of the attributes minAllowedTargetValue and maxAllowedTargetValue.

Type: object

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

Same definition as Terminal

Type: object or number

Maximum allowed regulated voltage on the PT secondary, regardless of line drop compensation. Sometimes referred to as first-house protection.

Same definition as BaseVoltage.nominalVoltage

Type: boolean

If true, the line drop compensation is to be applied.

Type: object or number

Line drop compensator resistance setting for normal (forward) power flow.

Same definition as PowerElectronicsConnection.r

Type: object or number

Line drop compensator reactance setting for normal (forward) power flow.

Same definition as PowerElectronicsConnection.x

Type: object or number

Line drop compensator resistance setting for reverse power flow.

Same definition as PowerElectronicsConnection.r

Type: object or number

Line drop compensator reactance setting for reverse power flow.

Same definition as PowerElectronicsConnection.x

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: boolean

The regulation is performed in a discrete mode. This applies to equipment with discrete controls, e.g. tap changers and shunt compensators.

Type: enum (of string)

The regulating control mode presently available. This specification allows for determining the kind of regulation without need for obtaining the units from a schedule.

Same definition as RegulatingControl.mode

Type: enum (of string)

Phase voltage controlling this regulator, measured at regulator location.

Same definition as Terminal.phases

Type: number

This is a deadband used with discrete control to avoid excessive update of controls like tap changers and shunt compensator banks while regulating. The units of those appropriate for the mode. The attribute shall be a positive value or zero. If RegulatingControl.discrete is set to "false", the RegulatingControl.targetDeadband is to be ignored.
Note that for instance, if the targetValue is 100 kV and the targetDeadband is 2 kV the range is from 99 to 101 kV.

Type: number

The target value specified for case input. This value can be used for the target value without the use of schedules. The value has the units appropriate to the mode attribute.

Type: enum (of string)

Specify the multiplier for used for the targetValue.

Same definition as multiplier

Type: boolean

The flag tells if regulation is enabled.

Type: number

Maximum allowed target value (RegulatingControl.targetValue).

Type: number

Minimum allowed target value (RegulatingControl.targetValue).

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

Common type for per-length electrical catalogues describing line parameters.

Type: object

Common type for per-length impedance electrical catalogues.

Type: object

Sequence impedance and admittance parameters per unit length, for transposed lines of 1, 2, or 3 phases. For 1-phase lines, define x=x0=xself. For 2-phase lines, define x=xs-xm and x0=xs+xm.

Type: object or number

Positive sequence shunt (charging) susceptance, per unit of length.

Same definition as PerLengthSequenceImpedance.b0ch

Type: object or number

Positive sequence shunt (charging) conductance, per unit of length.

Same definition as PerLengthSequenceImpedance.g0ch

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

Impedance and admittance parameters per unit length for n-wire unbalanced lines, in matrix form.

Type: array

Impedance and conductance matrix element values.
The diagonal elements are described by the elements having the same toPhase and fromPhase value and the off diagonal elements have different toPhase and fromPhase values. The matrix can also be stored in symmetric lower triangular format using the row and column attributes, which map to ACLineSegmentPhase.sequenceNumber.

No Additional Items

Each item of this array must be:

Type: object

Impedance and conductance matrix element values.
The diagonal elements are described by the elements having the same toPhase and fromPhase value and the off diagonal elements have different toPhase and fromPhase values. The matrix can also be stored in symmetric lower triangular format using the row and column attributes, which map to ACLineSegmentPhase.sequenceNumber.

Type: integer

The matrix element’s row number, in the range 1 to PerLengthPhaseImpedance.conductorCount. Only the lower triangle needs to be stored. This row number matches ACLineSegmentPhase.sequenceNumber.

Type: integer

The matrix element's column number, in the range 1 to row. Only the lower triangle needs to be stored. This column number matches ACLineSegmentPhase.sequenceNumber.

Type: integer

Number of phase, neutral, and other wires retained. Constrains the number of matrix elements and the phase codes that can be used with this matrix.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

Common type for per-length electrical catalogues describing DC line parameters.

Type: object or number

Capacitance per unit of length of the DC line segment; significant for cables only.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

A set of limits associated with equipment. Sets of limits might apply to a specific temperature, or season for example. A set of limits may contain different severities of limit levels that would apply to the same equipment. The set may contain limits of different types such as apparent power and current limits or high and low voltage limits that are logically applied together as a set.

Type: array

A value and normal value associated with a specific kind of limit.
The sub class value and normalValue attributes vary inversely to the associated OperationalLimitType.acceptableDuration (acceptableDuration for short).
If a particular piece of equipment has multiple operational limits of the same kind (apparent power, current, etc.), the limit with the greatest acceptableDuration shall have the smallest limit value and the limit with the smallest acceptableDuration shall have the largest limit value. Note: A large current can only be allowed to flow through a piece of equipment for a short duration without causing damage, but a lesser current can be allowed to flow for a longer duration.

No Additional Items

Each item of this array must be:

Type: array of object

A value and normal value associated with a specific kind of limit.
The sub class value and normalValue attributes vary inversely to the associated OperationalLimitType.acceptableDuration (acceptableDuration for short).
If a particular piece of equipment has multiple operational limits of the same kind (apparent power, current, etc.), the limit with the greatest acceptableDuration shall have the smallest limit value and the limit with the smallest acceptableDuration shall have the largest limit value. Note: A large current can only be allowed to flow through a piece of equipment for a short duration without causing damage, but a lesser current can be allowed to flow for a longer duration.

No Additional Items

Each item of this array must be:


A value and normal value associated with a specific kind of limit.
The sub class value and normalValue attributes vary inversely to the associated OperationalLimitType.acceptableDuration (acceptableDuration for short).
If a particular piece of equipment has multiple operational limits of the same kind (apparent power, current, etc.), the limit with the greatest acceptableDuration shall have the smallest limit value and the limit with the smallest acceptableDuration shall have the largest limit value. Note: A large current can only be allowed to flow through a piece of equipment for a short duration without causing damage, but a lesser current can be allowed to flow for a longer duration.

Type: object

Type: object

The operational meaning of a category of limits.

Type: object or number

The nominal acceptable duration of the limit. Limits are commonly expressed in terms of the time limit for which the limit is normally acceptable. The actual acceptable duration of a specific limit may depend on other local factors such as temperature or wind speed. The attribute has meaning only if the flag isInfiniteDuration is set to false, hence it shall not be exchanged when isInfiniteDuration is set to true.

Same definition as RegularIntervalSchedule.timeStep

Type: boolean

Defines if the operational limit type has infinite duration. If true, the limit has infinite duration. If false, the limit has definite duration which is defined by the attribute acceptableDuration.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: object or number

Limit on voltage. High or low limit nature of the limit depends upon the properties of the operational limit type. The attribute shall be a positive value or zero.

Same definition as BaseVoltage.nominalVoltage

Type: object or number

The normal limit on voltage. High or low limit nature of the limit depends upon the properties of the operational limit type. The attribute shall be a positive value or zero.

Same definition as BaseVoltage.nominalVoltage

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

Type: object or number

The normal value of active power limit. The attribute shall be a positive value or zero.

Same definition as SvInjection.pInjection

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

A multi-purpose curve or functional relationship between an independent variable (X-axis) and dependent (Y-axis) variables.

Type: array

Multi-purpose data points for defining a curve. The use of this generic class is discouraged if a more specific class can be used to specify the X and Y axis values along with their specific data types.

No Additional Items

Each item of this array must be:

Type: object

Multi-purpose data points for defining a curve. The use of this generic class is discouraged if a more specific class can be used to specify the X and Y axis values along with their specific data types.

Type: number

The data value of the X-axis variable, depending on the X-axis units.

Type: number

The data value of the first Y-axis variable, depending on the Y-axis units.

Type: number

The data value of the second Y-axis variable (if present), depending on the Y-axis units.

Type: number

The data value of the third Y-axis variable (if present), depending on the Y-axis units.

Type: enum (of string)

Type of calculation basis used to define the default bid segment curve.

Must be one of:

  • "COST_BASED"
  • "LMP_BASED"
  • "NEGOTIATED"

Type: number

Verifiable O&M Cost ($), Hot Startup

Type: object or number

Low target level limit, below which the reservoir operation will be penalized.

Type: enum (of string) Default: "none"

nan

Same definition as multiplier

Type: enum (of string) Default: "m"

nan

Same definition as unit

Type: number Default: null

nan

Type: object or number

Percentage of Fuel Index Price (gas) for operating above Low Sustained Limit (LSL)

Same definition as InefficientBatteryUnit.efficiencyDischarge

Type: string

To indicate a type used for a default energy bid curve, such as LMP, cost or consultative based.

Type: enum (of string)

Default energy bid adder flag

Must be one of:

  • "YES"
  • "NO"

Type: object or number

Percentage of Fuel Oil Price (FOP) for operating above Low Sustained Limit (LSL)

Same definition as InefficientBatteryUnit.efficiencyDischarge

Type: integer

Interval length.

Type: object or number

The emission content per quantity of fuel burned.

Type: enum (of string) Default: "none"

nan

Same definition as multiplier

Type: enum (of string) Default: "kgPerJ"

nan

Same definition as unit

Type: number Default: null

nan

Type: enum (of string)

The type of emission, which also gives the production rate measurement unit. The y1AxisUnits of the curve contains the unit of measure (e.g. kg) and the emissionType is the type of emission (e.g. sulfur dioxide).

Must be one of:

  • "sulfurDioxide"
  • "carbonDioxide"
  • "nitrogenOxide"
  • "hydrogenSulfide"
  • "chlorine"
  • "carbonDisulfide"

Type: boolean

Flag is set to true when output is expressed in net active power.

Type: string

The date and time of the most recent generating unit shutdown.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: object or number

High target level limit, above which the reservoir operation will be penalized.

Same definition as TargetLevelSchedule.lowLevelLimit

Type: string

The end time and date of the fuel allocation schedule.

Type: string

The start time and date of the fuel allocation schedule.

Type: enum (of string)

The type of fuel, which also indicates the corresponding measurement unit.

Must be one of:

  • "coal"
  • "oil"
  • "gas"
  • "lignite"
  • "hardCoal"
  • "oilShale"
  • "brownCoalLignite"
  • "coalDerivedGas"
  • "peat"
  • "other"

Type: number

The maximum amount of fuel that is allocated for consumption for the scheduled time period.

Type: number

The minimum amount of fuel that is allocated for consumption for the scheduled time period, e.g., based on a "take-or-pay" contract.

Type: enum (of string)

The style or shape of the curve.

Same definition as Curve.curveStyle

Type: enum (of string)

Multiplier for X-axis.

Same definition as multiplier

Type: enum (of string)

The X-axis units of measure.

Same definition as unit

Type: enum (of string)

Multiplier for Y1-axis.

Same definition as multiplier

Type: enum (of string)

The Y1-axis units of measure.

Same definition as unit

Type: enum (of string)

Multiplier for Y2-axis.

Same definition as multiplier

Type: enum (of string)

The Y2-axis units of measure.

Same definition as unit

Type: enum (of string)

Multiplier for Y3-axis.

Same definition as multiplier

Type: enum (of string)

The Y3-axis units of measure.

Same definition as unit

Type: boolean

Flag is set to true when output is expressed in net active power.

Type: number

Verifiable O&M Cost ($), Intermediate Startup

Type: object or number

Percentage of Solid Fuel for operating above Low Sustained Limit (LSL)

Same definition as InefficientBatteryUnit.efficiencyDischarge

Type: number

Verifiable O&M Cost ($/MWh), LSL

Type: enum (of string)

The condition that identifies whether a Generating Resource should be constrained from Ancillary Service provision if its Schedule or Dispatch change across Trading Hours or Trading Intervals requires more than a specified fraction of the duration of the Trading Hour or Trading Interval.

Valid values are Fast/Slow

Must be one of:

  • "SLOW"
  • "FAST"

Type: number

Verifiable O&M Cost ($), Cold Startup

Type: object or number

Power output - auxiliary power multiplier adjustment factor.

Same definition as PowerElectronicsConnection.maxIFault

Type: object or number

Power output - auxiliary power offset adjustment factor.

Same definition as SvInjection.pInjection

Type: object or number

Heat input - efficiency multiplier adjustment factor.

Same definition as PowerElectronicsConnection.maxIFault

Type: string

Wheeling Counter-Resource ID (required when Schedule Type=Wheel).

Type: boolean

Flag is set to true when output is expressed in net active power.

Type: object or number

The startup ramp rate in gross for a unit that is on hot standby.

Same definition as GeneratingUnit.lowerRampRate

Type: object or number

Heat input - offset adjustment factor.

Type: enum (of string) Default: "none"

nan

Same definition as multiplier

Type: enum (of string) Default: "J"

nan

Same definition as unit

Type: number Default: null

nan

Type: boolean

Flag is set to true when output is expressed in net active power.

Type: boolean

To indicate an out-of-market (OOM) schedule.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: enum (of string)

Reserve requirement type that the max and curve apply to. For example, operating reserve, regulation and contingency.

Must be one of:

  • "CONT"
  • "REG"
  • "OPRSV"

Type: object or number

The machine's coolant temperature (e.g., ambient air or stator circulating water).

Same definition as ACLineSegment.shortCircuitEndTemperature

Type: string

Operating date, hour.

Type: enum (of string)

Energy product type.

Must be one of:

  • "LFD"
  • "RD"
  • "NR"
  • "RC"
  • "SR"
  • "EN"
  • "RU"
  • "REG"
  • "LFU"

Type: object or number

The hydrogen coolant pressure.

Type: enum (of string) Default: "Pa"

nan

Same definition as unit

Type: number Default: null

nan

Type: enum (of string)

The type of emission, for example sulfur dioxide (SO2). The y1AxisUnits of the curve contains the unit of measure (e.g. kg) and the emissionType is the type of emission (e.g. sulfur dioxide).

Same definition as EmissionCurve.emissionType

Type: enum (of string)

The source of the emission value.

Must be one of:

  • "measured"
  • "calculated"

Type: boolean

Flag is set to true when output is expressed in net active power.

Type: enum (of string)

How ramp rate is applied (e.g. raise or lower, as when applied to a generation resource)

Must be one of:

  • "LD_PICKUP"
  • "LD_DROP"
  • "OP"
  • "REG"
  • "OP_RES"
  • "INTERTIE"

Type: enum (of string)

To indicate a check out type such as adjusted capacity or dispatch capacity.

Must be one of:

  • "PRE_SCHEDULE"
  • "PRE_HOUR"
  • "AFTER_THE_FACT"

Type: number

Region requirement maximum limit

Type: enum (of string)

condition for the ramp rate

Must be one of:

  • "NORMAL"
  • "BEST"
  • "WORST"
  • "nan"

Type: enum (of string)

Market type.

Must be one of:

  • "DAM"
  • "RUC"
  • "HAM"
  • "RTM"

Type: enum (of string)

Import or export.

Must be one of:

  • "I"
  • "E"

Type: enum (of string)

Schedule type.

Must be one of:

  • "DYN"
  • "FIRM"
  • "NFRM"
  • "WHL"

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

Atomic switching action.

Type: object

Action on energy source as a switching step.

Type: string

Planned date and time of this switching step.

Type: enum (of string)

Phases of the Switching Action

Same definition as Terminal.phases

Type: enum (of string)

Switching action to perform.

Must be one of:

  • "remove"
  • "place"
  • "connect"
  • "disconnect"

Type: string

Date and time when the crew was given the instruction to execute the action; not applicable if the action is performed by operator remote control.

Type: string

Actual date and time of this switching step.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

Control executed as a switching step.

Type: string

Planned date and time of this switching step.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: enum (of string)

Phases of the Switching Action

Same definition as Terminal.phases

Type: string

Date and time when the crew was given the instruction to execute the action; not applicable if the action is performed by operator remote control.

Type: string

Actual date and time of this switching step.

Type: number

The analog value used for the analog control, the raise/lower control and the set point control

Type: integer

The integer value used for the command or the accumulator reset.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

Action on operation tag as a switching step.

Type: string

Planned date and time of this switching step.

Type: enum (of string)

Kind of tag action.

Must be one of:

  • "place"
  • "remove"
  • "verify"

Type: enum (of string)

Phases of the Switching Action

Same definition as Terminal.phases

Type: string

Date and time when the crew was given the instruction to execute the action; not applicable if the action is performed by operator remote control.

Type: string

Actual date and time of this switching step.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

Verification of a switch position or other condition as a switching step

Type: string

Planned date and time of this switching step.

Type: string

Actual date and time of this switching step.

Type: enum (of string)

Phases of the Switching Action

Same definition as Terminal.phases

Type: string

Date and time when the crew was given the instruction to execute the action; not applicable if the action is performed by operator remote control.

Type: string

freeform description of the condition to be verified

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

Measurement taken as a switching step.

Type: string

Planned date and time of this switching step.

Type: enum (of string)

Phases of the Switching Action

Same definition as Terminal.phases

Type: string

Date and time when the crew was given the instruction to execute the action; not applicable if the action is performed by operator remote control.

Type: string

Actual date and time of this switching step.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

Action on clearance document as a switching step.

Type: string

Planned date and time of this switching step.

Type: enum (of string)

Phases of the Switching Action

Same definition as Terminal.phases

Type: enum (of string)

Clearance action to perform.

Must be one of:

  • "release"
  • "update"
  • "issue"

Type: string

Date and time when the crew was given the instruction to execute the action; not applicable if the action is performed by operator remote control.

Type: string

Actual date and time of this switching step.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

An arbitrary switching step.

Type: string

Planned date and time of this switching step.

Type: enum (of string)

Phases of the Switching Action

Same definition as Terminal.phases

Type: string

Date and time when the crew was given the instruction to execute the action; not applicable if the action is performed by operator remote control.

Type: string

Actual date and time of this switching step.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

Action on switch as a switching step.

Type: string

Planned date and time of this switching step.

Type: enum (of string)

Switching action to perform.

Must be one of:

  • "close"
  • "open"
  • "enableReclosing"
  • "disableReclosing"

Type: enum (of string)

Phases of the Switching Action

Same definition as Terminal.phases

Type: string

Date and time when the crew was given the instruction to execute the action; not applicable if the action is performed by operator remote control.

Type: string

Actual date and time of this switching step.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

nan

Type: string

Planned date and time of this switching step.

Type: string

Date and time when the crew was given the instruction to execute the action; not applicable if the action is performed by operator remote control.

Type: string

Actual date and time of this switching step.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

Action on cut as a switching step.

Type: enum (of string)

Switching action to perform.

Same definition as EnergySourceAction.kind

Type: string

Planned date and time of this switching step.

Type: enum (of string)

Phases of the Switching Action

Same definition as Terminal.phases

Type: string

Date and time when the crew was given the instruction to execute the action; not applicable if the action is performed by operator remote control.

Type: string

Actual date and time of this switching step.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

Action on ground as a switching step.

Type: string

Planned date and time of this switching step.

Type: enum (of string)

Phases of the Switching Action

Same definition as Terminal.phases

Type: string

Date and time when the crew was given the instruction to execute the action; not applicable if the action is performed by operator remote control.

Type: enum (of string)

Switching action to perform.

Same definition as EnergySourceAction.kind

Type: string

Actual date and time of this switching step.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

Action on jumper as a switching step.

Type: string

Planned date and time of this switching step.

Type: enum (of string)

Phases of the Switching Action

Same definition as Terminal.phases

Type: string

Date and time when the crew was given the instruction to execute the action; not applicable if the action is performed by operator remote control.

Type: enum (of string)

Switching action to perform.

Same definition as EnergySourceAction.kind

Type: string

Actual date and time of this switching step.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

Action to connect or disconnect the Energy Consumer from its Terminal

Type: string

Planned date and time of this switching step.

Type: enum (of string)

Phases of the Switching Action

Same definition as Terminal.phases

Type: string

Date and time when the crew was given the instruction to execute the action; not applicable if the action is performed by operator remote control.

Type: string

Actual date and time of this switching step.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

Action on Clamp as a switching step

Type: string

Planned date and time of this switching step.

Type: enum (of string)

Switching action to perform

Same definition as EnergySourceAction.kind

Type: enum (of string)

Phases of the Switching Action

Same definition as Terminal.phases

Type: string

Date and time when the crew was given the instruction to execute the action; not applicable if the action is performed by operator remote control.

Type: string

Actual date and time of this switching step.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

Abnormal condition causing current flow through conducting equipment, such as caused by equipment failure or short circuits from objects not typically modelled (for example, a tree falling on a line).

Type: string

Type: array of string
No Additional Items

Each item of this array must be:

Type: string

The date and time at which the fault occurred.

Type: object

Fault impedance. Its usage is described by 'kind'.

Type: object or number Default: null

The resistance of the fault between phases and ground.

Same definition as PowerElectronicsConnection.r

Type: object or number Default: null

The resistance of the fault between phases.

Same definition as PowerElectronicsConnection.r

Type: object or number Default: null

The reactance of the fault between phases and ground.

Same definition as PowerElectronicsConnection.x

Type: object or number Default: null

The reactance of the fault between phases.

Same definition as PowerElectronicsConnection.x

Type: object or number

The length to the place where the fault is located starting from terminal with sequence number 1 of the faulted line segment.

Same definition as HydroGeneratingUnit.dropHeight

Type: enum (of string)

The kind of phase fault.

Must be one of:

  • "lineToGround"
  • "lineToLine"
  • "lineToLineToGround"
  • "lineOpen"

Type: enum (of string)

The phases participating in the fault. The fault connections into these phases are further specified by the type of fault.

Same definition as Terminal.phases

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

The place, scene, or point of something where someone or something has been, is, and/or will be at a given moment in time. It can be defined with one or more position points (coordinates) in a given coordinate system.

Type: array

Set of spatial coordinates that determine a point, defined in the coordinate system specified in 'Location.CoordinateSystem'. Use a single position point instance to describe a point-oriented location. Use a sequence of position points to describe a line-oriented object (physical location of non-point oriented objects like cables or lines), or area of an object (like a substation or a geographical zone - in this case, have first and last position point with the same values).

No Additional Items

Each item of this array must be:

Type: object

Set of spatial coordinates that determine a point, defined in the coordinate system specified in 'Location.CoordinateSystem'. Use a single position point instance to describe a point-oriented location. Use a sequence of position points to describe a line-oriented object (physical location of non-point oriented objects like cables or lines), or area of an object (like a substation or a geographical zone - in this case, have first and last position point with the same values).

Type: string

(if applicable) Z axis position.

Type: integer

Zero-relative sequence number of this group within a series of points; used when there is a need to express disjoint groups of points that are considered to be part of a single location.

Type: integer

Zero-relative sequence number of this point within a series of points.

Type: object

Coordinate reference system.

Type: string

A Uniform Resource Name (URN) for the coordinate reference system (crs) used to define 'Location.PositionPoints'.
An example would be the European Petroleum Survey Group (EPSG) code for a coordinate reference system, defined in URN under the Open Geospatial Consortium (OGC) namespace as: urn:ogc:def:crs:EPSG::XXXX, where XXXX is an EPSG code (a full list of codes can be found at the EPSG Registry web site http://www.epsg-registry.org/). To define the coordinate system as being WGS84 (latitude, longitude) using an EPSG OGC, this attribute would be urn:ogc:def:crs:EPSG::4.3.2.6
A profile should limit this code to a set of allowed URNs agreed to by all sending and receiving parties.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: string

The names of streets at the nearest intersection to work area.

Type: string

Remarks about this location.

Type: string

Name of building where location is.

Type: string

(if applicable) Name, identifier, or description of the subdivision in which work is to occur.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: object

Status of this location.

Type: string Default: null

Status value at 'dateTime'; prior status changes may have been kept in instances of activity records associated with the object to which this status applies.

Type: string Default: null

Reason code or explanation for why an object went to the current status 'value'.

Type: string Default: null

Pertinent information regarding the current 'value', as free form text.

Type: string Default: null

Date and time for which status 'value' applies.

Type: string

Method for the service person to access this usage point location. For example, a description of where to obtain a key if the facility is unmanned and secured.

Type: string

Problems previously encountered when visiting or performing work at this location. Examples include: bad dog, violent customer, verbally abusive occupant, obstructions, safety hazards, etc.

Type: object or number

nan

Type: number Default: null

nan

Type: enum (of string) Default: "m2"

nan

Same definition as unit

Type: object

Electronic address.

Type: string Default: null

World wide web address.

Type: string Default: null

User ID needed to log in, which can be for an individual person, an organisation, a location, etc.

Type: string Default: null

MAC (Media Access Control) address.

Type: string Default: null

Radio address.

Type: string Default: null

Password needed to log in.

Type: string Default: null

Alternate email address.

Type: string Default: null

Address on local area network.

Type: string Default: null

Primary email address.

Type: string

Number of building where location is.

Type: object

Phone number.

Type: string Default: null

Main (local) part of this telephone number.

Type: string Default: null

(if applicable) Prefix used when calling an international number.

Type: string Default: null

Phone number according to International Telecommunication Union (ITU) E.164.

Type: string Default: null

City code.

Type: string Default: null

(if applicable) Extension for this telephone number.

Type: string Default: null

Country code.

Type: string Default: null

(if applicable) Area or region code.

Type: string Default: null

(if applicable) Dial out code, for instance to call outside an enterprise.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Classification by utility's corporate standards and practices, relative to the location itself (e.g., geographical, functional accounting, etc., not a given property that happens to exist at that location).

Type: object

Secondary address of the location. For example, PO Box address may have different ZIP code than that in the 'mainAddress'.

Type: object Default: null

Town detail.

Type: string Default: null

Name of the state or province.

Type: string Default: null

Town code.

Type: string Default: null

Name of the country.

Type: string Default: null

Town name.

Type: string Default: null

Town section. For example, it is common for there to be 36 sections per township.

Type: object Default: null

Street detail.

Type: string Default: null

(if applicable) Third line of a free form address.

Type: string Default: null

Number of the apartment or suite.

Type: string Default: null

The identification by name or number, expressed as text, of the floor in the building as part of this address.

Type: string Default: null

First line of a free form address or some additional address information (for example a mail stop).

Type: string Default: null

(if applicable) In certain cases the physical location of the place of interest does not have a direct point of entry from the street, but may be located inside a larger structure such as a building, complex, office block, apartment, etc.

Type: boolean Default: null

True if this street is within the legal geographical boundaries of the specified town (default).

Type: string Default: null

(if applicable) Utilities often make use of external reference systems, such as those of the town-planner's department or surveyor general's mapping system, that allocate global reference codes to streets.

Type: string Default: null

Prefix to the street name. For example: North, South, East, West.

Type: string Default: null

Type of street. Examples include: street, circle, boulevard, avenue, road, drive, etc.

Type: string Default: null

Name of the street.

Type: string Default: null

(if applicable) Second line of a free form address.

Type: string Default: null

Designator of the specific location on the street.

Type: string Default: null

Suffix to the street name. For example: North, South, East, West.

Type: object Default: null

Status of this address.

Same definition as Location.status

Type: string Default: null

The language in which the address is specified, using ISO 639-1 two digit language code.

Type: string Default: null

Post office box.

Type: string Default: null

Postal code for the address.

Type: string

Problems previously encountered when visiting or performing work on this location. Examples include: bad dog, violent customer, verbally abusive occupant, obstructions, safety hazards, etc.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

Room number of location.

Type: string

(if applicable) Name, identifier, or description of the lot in which work is to occur.

Type: boolean

True if inspection is needed of facilities at this service location. This could be requested by a customer, due to suspected tampering, environmental concerns (e.g., a fire in the vicinity), or to correct incompatible data.

Type: string

(if applicable) Direction that allows field crews to quickly find a given asset. For a given location, such as a street address, this is the relative direction in which to find the asset. For example, a streetlight may be located at the 'NW' (northwest) corner of the customer's site, or a usage point may be located on the second floor of an apartment building.

Type: string

(if applicable) Reference to geographical information source, often external to the utility.

Type: string

(if applicable) Name, identifier, or description of the block in which work is to occur.

Type: object

Additional phone number.

Same definition as Location.phone1

Type: string

Method for the service person to access this service location. For example, a description of where to obtain a key if the facility is unmanned and secured.

Type: object

Main address of the location.

Same definition as Location.secondaryAddress

Type: integer

Floor of location.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

Abstract parent class for all Dynamics function blocks.

Type: object

Abstract parent class for all synchronous and asynchronous machine standard models.

Type: boolean

Function block used indicator.
true = use of function block is enabled
false = use of function block is disabled.

Type: number

Damping torque coefficient (D) (>= 0). A proportionality constant that, when multiplied by the angular velocity of the rotor poles with respect to the magnetic field (frequency), results in the damping torque. This value is often zero when the sources of damping torques (generator damper windings, load damping effects, etc.) are modelled in detail. Typical value = 0.

Type: object or number

Inertia constant of generator or motor and mechanical load (H) (> 0). This is the specification for the stored energy in the rotating mass when operating at rated speed. For a generator, this includes the generator plus all other elements (turbine, exciter) on the same shaft and has units of MW x s. For a motor, it includes the motor plus its mechanical load. Conventional units are PU on the generator MVA base, usually expressed as MW x s / MVA or just s. This value is used in the accelerating power reference frame for operator training simulator solutions. Typical value = 3.

Same definition as RegularIntervalSchedule.timeStep

Type: number

Saturation factor at rated terminal voltage (S1) (>= 0). Not used by simplified model. Defined by defined by S(E1) in the SynchronousMachineSaturationParameters diagram. Typical value = 0,02.

Type: number

Saturation factor at 120% of rated terminal voltage (S12) (>= RotatingMachineDynamics.saturationFactor). Not used by the simplified model, defined by S(E2) in the SynchronousMachineSaturationParameters diagram. Typical value = 0,12.

Type: object or number

Stator (armature) resistance (Rs) (>= 0). Typical value = 0,005.

Same definition as PowerElectronicsConnection.maxIFault

Type: number

Ratio (exciter voltage/generator voltage) of Efd bases of exciter and generator models (> 0). Typical value = 1.

Type: enum (of string)

Excitation base system mode. It should be equal to the value of WLMDV given by the user. WLMDV is the PU ratio between the field voltage and the excitation current: Efd = WLMDV x Ifd. Typical value = ifag.

Must be one of:

  • "ifag"
  • "ifnl"
  • "iffl"

Type: number

Quadrature-axis saturation factor at 120% of rated terminal voltage (S12q) (>= SynchonousMachineDetailed.saturationFactorQAxis). Typical value = 0,12.

Type: number

Quadrature-axis saturation factor at rated terminal voltage (S1q) (>= 0). Typical value = 0,02.

Type: number

Saturation loading correction factor (Ks) (>= 0). Used only by type J model. Typical value = 0.

Type: enum (of string)

Type of synchronous machine model used in dynamic simulation applications.

Must be one of:

  • "subtransient"
  • "subtransientTypeF"
  • "subtransientTypeJ"
  • "subtransientSimplified"
  • "subtransientSimplifiedDirectAxis"

Type: enum (of string)

Type of rotor on physical machine.

Must be one of:

  • "roundRotor"
  • "salientPole"

Type: object or number

Damping time constant for “Canay” reactance (>= 0). Typical value = 0.

Same definition as RegularIntervalSchedule.timeStep

Type: object or number

Direct-axis transient rotor time constant (T'do) (> SynchronousMachineTimeConstantReactance.tppdo). Typical value = 5.

Same definition as RegularIntervalSchedule.timeStep

Type: object or number

Direct-axis subtransient rotor time constant (T''do) (> 0). Typical value = 0,03.

Same definition as RegularIntervalSchedule.timeStep

Type: object or number

Quadrature-axis subtransient rotor time constant (T''qo) (> 0). Typical value = 0,03.

Same definition as RegularIntervalSchedule.timeStep

Type: object or number

Quadrature-axis transient rotor time constant (T'qo) (> SynchronousMachineTimeConstantReactance.tppqo). Typical value = 0,5.

Same definition as RegularIntervalSchedule.timeStep

Type: object or number

Direct-axis subtransient reactance (unsaturated) (X''d) (> RotatingMachineDynamics.statorLeakageReactance). Typical value = 0,2.

Same definition as PowerElectronicsConnection.maxIFault

Type: object or number

Direct-axis synchronous reactance (Xd) (>= SynchronousMachineTimeConstantReactance.xDirectTrans). The quotient of a sustained value of that AC component of armature voltage that is produced by the total direct-axis flux due to direct-axis armature current and the value of the AC component of this current, the machine running at rated speed. Typical value = 1,8.

Same definition as PowerElectronicsConnection.maxIFault

Type: object or number

Direct-axis transient reactance (unsaturated) (X'd) (>= SynchronousMachineTimeConstantReactance.xDirectSubtrans). Typical value = 0,5.

Same definition as PowerElectronicsConnection.maxIFault

Type: object or number

Quadrature-axis subtransient reactance (X''q) (> RotatingMachineDynamics.statorLeakageReactance). Typical value = 0,2.

Same definition as PowerElectronicsConnection.maxIFault

Type: object or number

Quadrature-axis synchronous reactance (Xq) (>= SynchronousMachineTimeConstantReactance.xQuadTrans).
The ratio of the component of reactive armature voltage, due to the quadrature-axis component of armature current, to this component of current, under steady state conditions and at rated frequency. Typical value = 1,6.

Same definition as PowerElectronicsConnection.maxIFault

Type: object or number

Quadrature-axis transient reactance (X'q) (>= SynchronousMachineTimeConstantReactance.xQuadSubtrans). Typical value = 0,3.

Same definition as PowerElectronicsConnection.maxIFault

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: object or number

Transient rotor time constant (T'o) (> AsynchronousMachineTimeConstantReactance.tppo). Typical value = 5.

Same definition as RegularIntervalSchedule.timeStep

Type: object or number

Subtransient rotor time constant (T''o) (> 0). Typical value = 0,03.

Same definition as RegularIntervalSchedule.timeStep

Type: object or number

Transient reactance (unsaturated) (X') (>= AsynchronousMachineTimeConstantReactance.xpp). Typical value = 0,5.

Same definition as PowerElectronicsConnection.maxIFault

Type: object or number

Subtransient reactance (unsaturated) (X'') (> RotatingMachineDynamics.statorLeakageReactance). Typical value = 0,2.

Same definition as PowerElectronicsConnection.maxIFault

Type: object or number

Synchronous reactance (Xs) (>= AsynchronousMachineTimeConstantReactance.xp). Typical value = 1,8.

Same definition as PowerElectronicsConnection.maxIFault

Type: boolean

Behaviour is based on a proprietary model as opposed to a detailed model.
true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes
false = user-defined model is explicitly defined in terms of control blocks and their input and output signals.

Type: boolean

Behaviour is based on a proprietary model as opposed to a detailed model.
true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes
false = user-defined model is explicitly defined in terms of control blocks and their input and output signals.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

Static var compensator whose behaviour is described by reference to a standard model or by definition of a user-defined model.

Type: boolean

Behaviour is based on a proprietary model as opposed to a detailed model.
true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes
false = user-defined model is explicitly defined in terms of control blocks and their input and output signals.

Type: boolean

Function block used indicator.
true = use of function block is enabled
false = use of function block is disabled.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

HVDC whose behaviour is described by reference to a standard model or by definition of a user-defined model.

Type: boolean

Behaviour is based on a proprietary model as opposed to a detailed model.
true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes
false = user-defined model is explicitly defined in terms of control blocks and their input and output signals.

Type: boolean

Behaviour is based on a proprietary model as opposed to a detailed model.
true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes
false = user-defined model is explicitly defined in terms of control blocks and their input and output signals.

Type: boolean

Function block used indicator.
true = use of function block is enabled
false = use of function block is disabled.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

Voltage compensator function block whose behaviour is described by reference to a standard model or by definition of a user-defined model.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: boolean

Behaviour is based on a proprietary model as opposed to a detailed model.
true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes
false = user-defined model is explicitly defined in terms of control blocks and their input and output signals.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: boolean

Function block used indicator.
true = use of function block is enabled
false = use of function block is disabled.

Type: object or number

Resistive component of compensation of a generator (Rc) (>= 0).

Same definition as PowerElectronicsConnection.maxIFault

Type: object or number

Time constant which is used for the combined voltage sensing and compensation signal (Tr) (>= 0).

Same definition as RegularIntervalSchedule.timeStep

Type: object or number

Reactive component of compensation of a generator (Xc) (>= 0).

Same definition as PowerElectronicsConnection.maxIFault

Type: object or number

Time constant which is used for the combined voltage sensing and compensation signal (Tr) (>= 0).

Same definition as RegularIntervalSchedule.timeStep

Type: object

Parent class for different groupings of information collected and managed as a part of a business process. It will frequently contain references to other objects, such as assets, people and power system resources.

Type: object

Document describing details of an active or planned outage in a part of the electrical network.
A non-planned outage may be created upon:
- a breaker trip,
- a fault indicator status change,
- a meter event indicating customer outage,
- a reception of one or more customer trouble calls, or
- an operator command, reflecting information obtained from the field crew.
Outage restoration may be performed using a switching plan which complements the outage information with detailed switching activities, including the relationship to the crew and work.
A planned outage may be created upon:
- a request for service, maintenance or construction work in the field, or
- an operator-defined outage for what-if/contingency network analysis.

Type: object

nan

Type: object

Status of subject matter (e.g., Agreement, Work) this document represents. For status of the document itself, use 'docStatus' attribute.

Same definition as Location.status

Type: string

Free text comment.

Type: object

Status of this document. For status of subject matter this document represents (e.g., Agreement, Work), use 'status' attribute.
Example values for 'docStatus.status' are draft, approved, cancelled, etc.

Same definition as Location.status

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

Name of the author of this document.

Type: enum (of string)

defines the status of the crew as in dispatched or arrived, etc.

Must be one of:

  • "awaitingCrewAssignment"
  • "assigned"
  • "arrived"
  • "enroute"
  • "fieldComplete"

Type: string

This contains an disclaimers the utility would like to place on the data provided to any stakeholder. This may be different for different stakeholders. This should possibly be an attribute under the Organization class but it is placed here for now.

Type: string

Utility-specific classification of this document, according to its corporate standards, practices, and existing IT systems (e.g., for management of assets, maintenance, work, outage, customers, etc.).

Type: string

Document title.

Type: string

a name to denote the community - this could be a name or a code of some kind.

Type: string

Revision number for this document.

Type: integer

the total number of customers that are served in the area (both outaged and not outaged).

Type: object

Estimated outage period for a planned outage. The start of the period is the start of the planned outage and the end of the period corresponds to the end of the planned outage.

Type: string Default: null

End date and time of this interval. The end date and time where the interval is defined up to, but excluded.

Type: string Default: null

Start date and time of this interval. The start date and time is included in the defined interval.

Type: integer

number of customers that have been restored in the area.

Type: string

Date and time that this document was created.

Type: integer

The original number of meters that were affected as reported by the OMS within the utility. That is, this is the total number of meters that were out at the beginning of the outage.

Type: string

Document subject.

Type: string

The reason for the planned outage.

Type: object

Summary counts of service points (customers) affected by this outage.

Type: integer Default: null

Number of critical service (delivery) points affected by an outage.

Type: integer Default: null

Number of all service (delivery) points affected by an outage.

Type: integer

The updated number of meters affected by the outage as reported by the OMS within the utility. It is assumed this number will be updated repeatedly until the full outage is resolved.

Type: string

Date and time this document was last modified. Documents may potentially be modified many times during their lifetime.

Type: object

Actual outage period; end of the period corresponds to the actual restoration time.

Same definition as Outage.estimatedPeriod

Type: enum (of string)

Defines if the outage has been verified or is only estimated

Must be one of:

  • "predicted"
  • "closed"
  • "confirmed"
  • "restored"
  • "partiallyRestored"

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

Document describing the consequence of an unplanned outage in a part of the electrical network. For the purposes of this model, an unplanned outage refers to a state where energy is not delivered; such as, customers out of service, a street light is not served, etc.
A unplanned outage may be created upon:
- impacts the SAIDI calculation
- a breaker trip,
- a fault indicator status change,
- a meter event indicating customer outage,
- a reception of one or more customer trouble calls, or
- an operator command, reflecting information obtained from the field crew.
Outage restoration may be performed using a switching plan which complements the outage information with detailed switching activities, including the relationship to the crew and work.

Type: array of string
No Additional Items

Each item of this array must be:

Type: object

Status of subject matter (e.g., Agreement, Work) this document represents. For status of the document itself, use 'docStatus' attribute.

Same definition as Location.status

Type: string

Free text comment.

Type: object

Status of this document. For status of subject matter this document represents (e.g., Agreement, Work), use 'status' attribute.
Example values for 'docStatus.status' are draft, approved, cancelled, etc.

Same definition as Location.status

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

Name of the author of this document.

Type: enum (of string)

defines the status of the crew as in dispatched or arrived, etc.

Same definition as Outage.statusKind

Type: string

This contains an disclaimers the utility would like to place on the data provided to any stakeholder. This may be different for different stakeholders. This should possibly be an attribute under the Organization class but it is placed here for now.

Type: string

Utility-specific classification of this document, according to its corporate standards, practices, and existing IT systems (e.g., for management of assets, maintenance, work, outage, customers, etc.).

Type: string

Document title.

Type: string

a name to denote the community - this could be a name or a code of some kind.

Type: string

Revision number for this document.

Type: integer

the total number of customers that are served in the area (both outaged and not outaged).

Type: object

Estimated outage period for a planned outage. The start of the period is the start of the planned outage and the end of the period corresponds to the end of the planned outage.

Same definition as Outage.estimatedPeriod

Type: integer

number of customers that have been restored in the area.

Type: string

Date and time that this document was created.

Type: enum (of string)

The possible cause that could be associated with this unplanned outage.

Must be one of:

  • "treeDown"
  • "animal"
  • "lightingStrike"
  • "poleDown"
  • "lineDown"

Type: integer

The original number of meters that were affected as reported by the OMS within the utility. That is, this is the total number of meters that were out at the beginning of the outage.

Type: string

Document subject.

Type: string

Date and time this document was last modified. Documents may potentially be modified many times during their lifetime.

Type: object

Summary counts of service points (customers) affected by this outage.

Same definition as Outage.summary

Type: integer

The updated number of meters affected by the outage as reported by the OMS within the utility. It is assumed this number will be updated repeatedly until the full outage is resolved.

Type: string

The earliest start time of the Outage - as reported by some system or individual

Type: object

Actual outage period; end of the period corresponds to the actual restoration time.

Same definition as Outage.estimatedPeriod

Type: string

The cause of this outage. This is the cause that is used to present to external entities. That is, the cause is weather, equipment failure, etc.
Note: At present, this is a free string text; it could be replaced with an enumeration in the future.

Type: enum (of string)

Defines if the outage has been verified or is only estimated

Same definition as Outage.outageKind

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

Records activity for an entity at a point in time; activity may be for an event that has already occurred or for a planned activity.

Type: array

An environmental event to which one or more forecasts or observations may be tied and which may relate to or affect one or more assets.
This class is intended to be used as a means of grouping forecasts and/or observations and could be used for a variety of purposes, including:

  • to define a 'named' event like Hurricane Katrina and allow the historic (or forecast) values for phenomena and measurements (precipitation, temperature) across time to be associated with it
  • to identify assets that were (or are forecast to be) affected by a phenomenon or set of measurements
No Additional Items

Each item of this array must be:

Type: object

An environmental event to which one or more forecasts or observations may be tied and which may relate to or affect one or more assets.
This class is intended to be used as a means of grouping forecasts and/or observations and could be used for a variety of purposes, including:

  • to define a 'named' event like Hurricane Katrina and allow the historic (or forecast) values for phenomena and measurements (precipitation, temperature) across time to be associated with it
  • to identify assets that were (or are forecast to be) affected by a phenomenon or set of measurements

Type: array

Abstract class (with concrete child classes of Observation and Forecast) that groups phenomenon and/or environmental value sets.

No Additional Items

Each item of this array must be:

Type: object

Abstract class (with concrete child classes of Observation and Forecast) that groups phenomenon and/or environmental value sets.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: object

The interval for which the forecast is valid. For example, a forecast issued now for tomorrow might be valid for the next 2 hours.

Same definition as Outage.estimatedPeriod

Type: string

Type of event resulting in this activity record.

Type: string

Reason for event resulting in this activity record, typically supplied when user initiated.

Type: string

Date and time this activity record has been created (different from the 'status.dateTime', which is the time of a status change of the associated object, if applicable).

Type: string

Severity level of event resulting in this activity record.

Type: object

Information on consequence of event resulting in this activity record.

Same definition as Location.status

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

The actual or forecast characteristics of an environmental phenomenon at a specific point in time (or during a specific time interval) that may have both a center and area/line location.

Type: object

A hydrospheric phenomenon.

Type: number

Tsunami magnitude in the Tsunami Magnitude Scale (Mt). Is greater than zero.

Type: object

The timestamp of the phenomenon as a single point or time interval.

Same definition as Outage.estimatedPeriod

Type: integer

Tsunami intensity on the Papadopoulos-Imamura tsunami intensity scale. Possible values are 1-12, corresponding to I-XII.

Type: object

An atmospheric phenomenon with a base and altitude providing the vertical coverage (combined with the Location to provide three dimensional space).

Type: enum (of string)

The type of the cloud as defined by the CloudKind enumeration.

Must be one of:

  • "nimboStratus"
  • "cumulus"
  • "stratoCumulus"
  • "cirroStratus"
  • "altoStratus"
  • "cirrus"
  • "cumuloNimbus"
  • "altoCumulus"
  • "stratus"
  • "cirroCumulus"
  • "other"
  • "toweringCumulus"

Type: object or number

Particulate density of the ash cloud during the time interval.

Type: object or number

The diameter of the particles during the time interval.

Same definition as HydroGeneratingUnit.dropHeight

Type: integer

Wind Force as classified on the Beaufort Scale (0-12) during the time interval.

Type: object or number

The central pressure of the cyclone during the time interval.

Same definition as ReactiveCapabilityCurve.hydrogenPressure

Type: enum (of string)

Fujita scale (referred to as EF-scale starting in 2007) for the tornado.

Must be one of:

  • "zero"
  • "one"
  • "four"
  • "two"
  • "three"
  • "five"
  • "minusNine"

Type: integer

Strength of tropical cyclone during the time interval, based on Australian Bureau of Meteorology Category System where:
1 - tropical cyclone, with typical gusts over flat land 90-125 km/h
2 - tropical cyclone, with typical gusts over flat land 125-164 km/h
3 - severe tropical cyclone, with typical gusts over flat land 165-224 km/h
4 - severe tropical cyclone, with typical gusts over flat land 225-279 km/h
5 - severe tropical cyclone, with typical gusts over flat land greater than 280 km/h.

Type: object

The timestamp of the phenomenon as a single point or time interval.

Same definition as Outage.estimatedPeriod

Type: object

The base altitude of the phenomenon.

Type: enum (of string) Default: null

nan

Must be one of:

  • "ground"
  • "seaLevel"
  • "centreEarth"

Type: object or number

Width of the tornado during the time interval.

Same definition as HydroGeneratingUnit.dropHeight

Type: object or number

The maximum surface wind speed of the cyclone during the time interval.

Type: integer

The hurricane's category during the time interval, using Saffir-Simpson Hurricane Wind Scale, a 1 to 5 rating based on a hurricane's sustained wind speed.

Type: object

A geospheric phenomenon.

Type: boolean

The polarity of the strike, with T meaning negative. About 90% of all lightning strokes are negative strokes, meaning that they were initiated by a large concentration of negative charge in the cloud-base; this tends to induce an area of positive charge on the ground.

Type: integer

The intensity of the earthquake as defined by the Modified Mercalli Intensity (MMI) scale. Possible values are 1-12, corresponding to I-XII.

Type: object or number

Length of major semi-axis (longest radius) of the error ellipse.

Same definition as HydroGeneratingUnit.dropHeight

Type: object

The timestamp of the phenomenon as a single point or time interval.

Same definition as Outage.estimatedPeriod

Type: object

The depth below the earth's surface of the earthquake's focal point.

Same definition as AtmosphericPhenomenon.base

Type: object or number

The orientation of the major semi- axis in degrees from True North.

Same definition as AtmosphericPhenomenon.direction

Type: object or number

Length of minor semi-axis (shortest radius) of the error ellipse.

Same definition as HydroGeneratingUnit.dropHeight

Type: number

The magnitude of the earthquake as defined on the Moment Magnitude (Mw) scale, which measures the size of earthquakes in terms of the energy released. Must be greater than zero.

Type: object

An extra-terrestrial phenomenon.

Type: object or number

Change in the disturbance - storm time (Dst) index. The size of a geomagnetic storm is classified as:
- moderate ( -50 nT >minimum of Dst > -100 nT)
- intense (-100 nT > minimum Dst > -250 nT) or
- super-storm ( minimum of Dst < -250 nT).

Type: object

The timestamp of the phenomenon as a single point or time interval.

Same definition as Outage.estimatedPeriod

Type: object

Set of attributes of an asset, representing typical datasheet information of a physical device that can be instantiated and shared in different data exchange contexts:
- as attributes of an asset instance (installed or in stock)
- as attributes of an asset model (product by a manufacturer)
- as attributes of a type asset (generic type of an asset as used in designs/extension planning).

Type: object

Switch datasheet information.

Type: boolean

If true, the switch is not ganged (i.e., a switch phase may be operated separately from other phases).

Type: object or number

Gas or air pressure at or below which a low pressure alarm is generated.

Same definition as ReactiveCapabilityCurve.hydrogenPressure

Type: object or number

Rated impulse withstand voltage, also known as BIL (Basic Impulse Level).

Same definition as BaseVoltage.nominalVoltage

Type: boolean

If true, it is a single phase switch.

Type: object or number

Switch rated interrupting time in seconds.

Same definition as RegularIntervalSchedule.timeStep

Type: object or number

Volume of oil in each tank of bulk oil breaker.

Type: enum (of string) Default: "m3"

nan

Same definition as unit

Type: number Default: null

nan

Type: object or number

Weight of gas in each tank of SF6 dead tank breaker.

Type: enum (of string) Default: "g"

nan

Same definition as unit

Type: number Default: null

nan

Type: object or number

The maximum fault current a breaking device can break safely under prescribed conditions of use.

Same definition as ExternalNetworkInjection.maxInitialSymShCCurrent

Type: object or number

Gas or air pressure below which the breaker will not open.

Same definition as ReactiveCapabilityCurve.hydrogenPressure

Type: object or number

Frequency for which switch is rated.

Same definition as FrequencyConverter.frequency

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

Tap changer data.

Type: integer

Highest possible tap step position, advance from neutral.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: object or number

Built-in current transformer primary rating.

Same definition as ExternalNetworkInjection.maxInitialSymShCCurrent

Type: number

Built-in voltage transducer ratio.

Type: object or number

Tap step increment, in per cent of rated voltage, per step position.

Same definition as InefficientBatteryUnit.efficiencyDischarge

Type: object or number

Phase shift per step position.

Same definition as SvVoltage.angle

Type: integer

Lowest possible tap step position, retard from neutral.

Type: object or number

Voltage at which the winding operates at the neutral tap setting.

Same definition as BaseVoltage.nominalVoltage

Type: object or number

Basic Insulation Level (BIL) expressed as the impulse crest voltage of a nominal wave, typically 1.2 X 50 microsecond. This is a measure of the ability of the insulation to withstand very high voltage surges.

Same definition as BaseVoltage.nominalVoltage

Type: number

Built-in current transducer ratio.

Type: boolean

Whether this tap changer has under load tap changing capabilities.

Type: integer

The neutral tap step position for the winding.

Type: object or number

Frequency at which the ratings apply.

Same definition as FrequencyConverter.frequency

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

Wire spacing data that associates multiple wire positions with the line segment, and allows to calculate line segment impedances. Number of phases can be derived from the number of associated wire positions whose phase is not neutral.

Type: array

Identification, spacing and configuration of the wires of a conductor with respect to a structure.

No Additional Items

Each item of this array must be:

Type: object

Identification, spacing and configuration of the wires of a conductor with respect to a structure.

Type: integer

Numbering for wires on a WireSpacingInfo. Neutrals should be numbered last.

Type: object or number

Signed vertical distance from the wire at this position: above ground (positive value) or burial depth below ground (negative value).

Same definition as displacement

Type: object or number

Signed horizontal distance from the wire at this position to a common reference point.

Same definition as displacement

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: integer

Number of wire sub-conductors in the symmetrical bundle (typically between 1 and 4).

Type: boolean

If true, this spacing data describes a cable.

Type: object or number

Distance between wire sub-conductors in a symmetrical bundle.

Same definition as HydroGeneratingUnit.dropHeight

Type: enum (of string)

Usage of the associated wires.

Must be one of:

  • "secondary"
  • "distribution"
  • "transmission"
  • "other"

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

Wire data that can be specified per line segment phase, or for the line segment as a whole in case its phases all have the same wire characteristics.

Type: object

Overhead wire data.

Type: array

Information on a wire carrying a single phase.

No Additional Items

Each item of this array must be:

Type: object

Information on a wire carrying a single phase.

Type: string

Describes the wire gauge or cross section (e.g., 4/0, #2, 336.5).

Type: object or number

(if insulated conductor) Thickness of the insulation.

Same definition as HydroGeneratingUnit.dropHeight

Type: integer

(if used) Number of strands in the steel core.

Type: object or number

Current carrying capacity of the wire under stated thermal conditions.

Same definition as ExternalNetworkInjection.maxInitialSymShCCurrent

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: enum (of string)

Conductor material.

Must be one of:

  • "aluminumAlloy"
  • "aaac"
  • "aluminumSteel"
  • "aluminum"
  • "copper"
  • "aluminumAlloySteel"
  • "other"
  • "acsr"
  • "steel"

Type: object or number

DC resistance per unit length of the conductor at 20 °C.

Same definition as PerLengthSequenceImpedance.r

Type: object or number

AC resistance per unit length of the conductor at 50 °C.

Same definition as PerLengthSequenceImpedance.r

Type: object or number

(if there is a different core material) Radius of the central core.

Same definition as HydroGeneratingUnit.dropHeight

Type: enum (of string)

(if insulated conductor) Material used for insulation.

Must be one of:

  • "highMolecularWeightPolyethylene"
  • "asbestosAndVarnishedCambric"
  • "ethylenePropyleneRubber"
  • "varnishedDacronGlass"
  • "lowCapacitanceRubber"
  • "beltedPilc"
  • "oilPaper"
  • "other"
  • "crosslinkedPolyethylene"
  • "unbeltedPilc"
  • "ozoneResistantRubber"
  • "butyl"
  • "rubber"
  • "varnishedCambricCloth"
  • "treeRetardantCrosslinkedPolyethylene"
  • "siliconRubber"
  • "highPressureFluidFilled"
  • "treeResistantHighMolecularWeightPolyethylene"

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: integer

Number of strands in the conductor.

Type: object or number

AC resistance per unit length of the conductor at 75 °C.

Same definition as PerLengthSequenceImpedance.r

Type: object or number

AC resistance per unit length of the conductor at 25 °C.

Same definition as PerLengthSequenceImpedance.r

Type: object or number

Geometric mean radius. If we replace the conductor by a thin walled tube of radius GMR, then its reactance is identical to the reactance of the actual conductor.

Same definition as HydroGeneratingUnit.dropHeight

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: boolean

True if conductor is insulated.

Type: object

Cable data.

Type: object

Tape shield cable data.

Type: boolean

True if wire strands are extruded in a way to fill the voids in the cable.

Type: string

Describes the wire gauge or cross section (e.g., 4/0, #2, 336.5).

Type: object or number

(if insulated conductor) Thickness of the insulation.

Same definition as HydroGeneratingUnit.dropHeight

Type: integer

(if used) Number of strands in the steel core.

Type: object or number

Current carrying capacity of the wire under stated thermal conditions.

Same definition as ExternalNetworkInjection.maxInitialSymShCCurrent

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: boolean

True if conductor is insulated.

Type: enum (of string)

Kind of outer jacket of this cable.

Must be one of:

  • "insulating"
  • "linearLowDensityPolyethylene"
  • "none"
  • "other"
  • "semiconducting"
  • "pvc"
  • "polyethylene"

Type: object or number

Percentage of the tape shield width that overlaps in each wrap, typically 10% to 25%.

Same definition as InefficientBatteryUnit.efficiencyDischarge

Type: object or number

Diameter over the core, including any semi-con screen; should be the insulating layer's inside diameter.

Same definition as HydroGeneratingUnit.dropHeight

Type: object or number

DC resistance per unit length of the conductor at 20 °C.

Same definition as PerLengthSequenceImpedance.r

Type: object or number

AC resistance per unit length of the conductor at 50 °C.

Same definition as PerLengthSequenceImpedance.r

Type: object or number

(if there is a different core material) Radius of the central core.

Same definition as HydroGeneratingUnit.dropHeight

Type: enum (of string)

(if insulated conductor) Material used for insulation.

Same definition as WireInfo.insulationMaterial

Type: boolean

True if sheath / shield is used as a neutral (i.e., bonded).

Type: enum (of string)

Material of the shield.

Must be one of:

  • "copper"
  • "steel"
  • "aluminum"
  • "lead"
  • "other"

Type: integer

Number of strands in the conductor.

Type: object or number

AC resistance per unit length of the conductor at 75 °C.

Same definition as PerLengthSequenceImpedance.r

Type: object or number

Diameter over the insulating layer, excluding outer screen.

Same definition as HydroGeneratingUnit.dropHeight

Type: enum (of string)

Kind of construction of this cable.

Must be one of:

  • "compacted"
  • "other"
  • "segmental"
  • "compressed"
  • "sector"
  • "solid"
  • "stranded"

Type: object or number

Diameter over the outer screen; should be the shield's inside diameter.

Same definition as HydroGeneratingUnit.dropHeight

Type: object or number

AC resistance per unit length of the conductor at 25 °C.

Same definition as PerLengthSequenceImpedance.r

Type: object or number

Geometric mean radius. If we replace the conductor by a thin walled tube of radius GMR, then its reactance is identical to the reactance of the actual conductor.

Same definition as HydroGeneratingUnit.dropHeight

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

Concentric neutral cable data.

Type: boolean

True if wire strands are extruded in a way to fill the voids in the cable.

Type: string

Describes the wire gauge or cross section (e.g., 4/0, #2, 336.5).

Type: integer

(if used) Number of strands in the steel core.

Type: object or number

Current carrying capacity of the wire under stated thermal conditions.

Same definition as ExternalNetworkInjection.maxInitialSymShCCurrent

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: boolean

True if conductor is insulated.

Type: object or number

DC resistance per unit length of the conductor at 20 °C.

Same definition as PerLengthSequenceImpedance.r

Type: object or number

Diameter over the core, including any semi-con screen; should be the insulating layer's inside diameter.

Same definition as HydroGeneratingUnit.dropHeight

Type: object or number

AC resistance per unit length of the conductor at 50 °C.

Same definition as PerLengthSequenceImpedance.r

Type: object or number

(if there is a different core material) Radius of the central core.

Same definition as HydroGeneratingUnit.dropHeight

Type: enum (of string)

(if insulated conductor) Material used for insulation.

Same definition as WireInfo.insulationMaterial

Type: boolean

True if sheath / shield is used as a neutral (i.e., bonded).

Type: integer

Number of strands in the conductor.

Type: object or number

AC resistance per unit length of the conductor at 75 °C.

Same definition as PerLengthSequenceImpedance.r

Type: object or number

Diameter over the insulating layer, excluding outer screen.

Same definition as HydroGeneratingUnit.dropHeight

Type: object or number

Diameter over the outer screen; should be the shield's inside diameter.

Same definition as HydroGeneratingUnit.dropHeight

Type: object or number

AC resistance per unit length of the conductor at 25 °C.

Same definition as PerLengthSequenceImpedance.r

Type: object or number

Geometric mean radius. If we replace the conductor by a thin walled tube of radius GMR, then its reactance is identical to the reactance of the actual conductor.

Same definition as HydroGeneratingUnit.dropHeight

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

Set of power transformer data, from an equipment library.

Type: array

Set of transformer tank data, from an equipment library.

No Additional Items

Each item of this array must be:

Type: object

Set of transformer tank data, from an equipment library.

Type: array

Transformer end data.

No Additional Items

Each item of this array must be:

Type: object

Transformer end data.

Type: array

No-load test results determine core admittance parameters. They include exciting current and core loss measurements from applying voltage to one winding. The excitation may be positive sequence or zero sequence. The test may be repeated at different voltages to measure saturation.

No Additional Items

Each item of this array must be:

Type: object

No-load test results determine core admittance parameters. They include exciting current and core loss measurements from applying voltage to one winding. The excitation may be positive sequence or zero sequence. The test may be repeated at different voltages to measure saturation.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: array

Short-circuit test results determine mesh impedance parameters. They include load losses and leakage impedances. For three-phase windings, the excitation can be a positive sequence (the default) or a zero sequence. There shall be at least one grounded winding.

No Additional Items

Each item of this array must be:

Type: object

Short-circuit test results determine mesh impedance parameters. They include load losses and leakage impedances. For three-phase windings, the excitation can be a positive sequence (the default) or a zero sequence. There shall be at least one grounded winding.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: integer

Winding phase angle where 360 degrees are represented with clock hours, so the valid values are {0, ..., 11}. For example, to express the second winding in code 'Dyn11', set attributes as follows: 'endNumber'=2, 'connectionKind' = Yn and 'phaseAngleClock' = 11.

Type: object or number

Rated voltage: phase-phase for three-phase windings, and either phase-phase or phase-neutral for single-phase windings.

Same definition as BaseVoltage.nominalVoltage

Type: integer

Number for this transformer end, corresponding to the end's order in the PowerTransformer.vectorGroup attribute. Highest voltage winding should be 1.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

Properties of shunt capacitor, shunt reactor or switchable bank of shunt capacitor or reactor assets.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

Tangible resource of the utility, including power system equipment, various end devices, cabinets, buildings, etc. For electrical network equipment, the role of the asset is defined through PowerSystemResource and its subclasses, defined mainly in the Wires model (refer to IEC61970-301 and model package IEC61970::Wires). Asset description places emphasis on the physical characteristics of the equipment fulfilling that role.

Type: boolean

True if weeds are to be removed around asset.

Type: boolean

If true, there is no physical device. As an example, a virtual meter can be defined to aggregate the consumption for two or more physical meters. Otherwise, this is a physical hardware device.

Type: string

Uniquely tracked commodity (UTC) number.

Type: object or number

Visible height of structure above ground level for overhead construction (e.g., Pole or Tower) or below ground level for an underground vault, manhole, etc. Refer to associated DimensionPropertiesInfo for other types of dimensions.

Same definition as HydroGeneratingUnit.dropHeight

Type: string

Automated meter reading (AMR) system communicating with this com module.

Type: object or number

Direction of this support structure.

Same definition as SvVoltage.angle

Type: object

In use dates for this asset.

Type: string Default: null

Date of most recent asset transition to ready for use state.

Type: string Default: null

Date asset was most recently put in use.

Type: string Default: null

Date of most recent asset transition to not ready for use state.

Type: integer

(if anchor) Number of rods used.

Type: string

Date fumigant was last applied.

Type: integer

Number of circuits in duct bank. Refer to associations between a duct (ConductorAsset) and an ACLineSegment to understand which circuits are in which ducts.

Type: string

Name of fumigant.

Type: enum (of string)

Kind of structure support.

Must be one of:

  • "anchor"
  • "guy"

Type: object or number

Time zone offset relative to GMT for the location of this com module.

Type: enum (of string) Default: "none"

nan

Same definition as multiplier

Type: enum (of string) Default: "min"

nan

Same definition as unit

Type: number Default: null

nan

Type: object or number

Time zone offset relative to GMT for the location of this end device.

Same definition as ComModule.timeZoneOffset

Type: enum (of string)

Current lifecycle state of asset.

Must be one of:

  • "purchased"
  • "received"
  • "manufactured"
  • "retired"
  • "disposedOf"

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: boolean

If true, this is a premises area network (PAN) device.

Type: enum (of string)

Configuration of joint.

Must be one of:

  • "other"
  • "wires1to1"
  • "wires3to1"
  • "wires2to1"

Type: enum (of string)

Material this structure is made of.

Must be one of:

  • "steel"
  • "concrete"
  • "other"
  • "wood"

Type: boolean

True if asset is considered critical for some reason (for example, a pole with critical attachments).

Type: string

Size of this support structure.

Type: string

Meter form designation per ANSI C12.10 or other applicable standard. An alphanumeric designation denoting the circuit arrangement for which the meter is applicable and its specific terminal arrangement.

Type: object or number

Maximum rated voltage of the equipment that can be mounted on/contained within the structure.

Same definition as BaseVoltage.nominalVoltage

Type: object

Information on acceptance test.

Type: string Default: null

Type of test or group of tests that was conducted on 'dateTime'.

Type: string Default: null

Date and time the asset was last tested using the 'type' of test and yielding the current status in 'success' attribute.

Type: boolean Default: null

True if asset has passed acceptance test and may be placed in or is in service. It is set to false if asset is removed from service and is required to be tested again before being placed back in service, possibly in a new location. Since asset may go through multiple tests during its lifecycle, the date of each acceptance test may be recorded in 'Asset.ActivityRecord.status.dateTime'.

Type: object


Lifecycle dates for this asset.

Type: string Default: null

Date current installation was completed, which may not be the same as the in-service date. Asset may have been installed at other locations previously. Ignored if asset is (1) not currently installed (e.g., stored in a depot) or (2) not intended to be installed (e.g., vehicle, tool).

Type: string Default: null

Date the asset was manufactured.

Type: string Default: null

Date when the asset was last removed from service. Ignored if (1) not intended to be in service, or (2) currently in service.

Type: string Default: null

Date the asset is permanently retired from service and may be scheduled for disposal. Ignored if asset is (1) currently in service, or (2) permanently removed from service.

Type: string Default: null

Date the asset was received and first placed into inventory.

Type: string Default: null

Date the asset was purchased. Note that even though an asset may have been purchased, it may not have been received into inventory at the time of purchase.

Type: enum (of string)

(if anchor) Kind of anchor.

Must be one of:

  • "concrete"
  • "rod"
  • "other"
  • "helix"
  • "unknown"
  • "multiHelix"
  • "screw"

Type: enum (of string)

Kind of usage of the vehicle.

Must be one of:

  • "other"
  • "crew"
  • "user"
  • "contractor"

Type: object or number

(if anchor) Length of rod used.

Same definition as HydroGeneratingUnit.dropHeight

Type: string

Installation code.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: enum (of string)

Material used to fill the joint.

Must be one of:

  • "noFillPrefab"
  • "oil"
  • "noVoid"
  • "airNoFilling"
  • "bluefill254"
  • "insoluseal"
  • "epoxy"
  • "other"
  • "petrolatum"
  • "asphaltic"

Type: string

Date weed were last removed.

Type: enum (of string)

Kind of FACTS device.

Must be one of:

  • "tcpar"
  • "tssc"
  • "svc"
  • "tcsc"
  • "tsbr"
  • "upfc"
  • "statcom"
  • "tcvl"

Type: enum (of string)

Indication of whether asset is currently deployed (in use), ready to be put into use or not available for use.

Must be one of:

  • "inUse"
  • "readyForUse"
  • "notReadyForUse"

Type: object or number

Power rating of light.

Same definition as SvInjection.pInjection

Type: enum (of string)

Lamp kind.

Must be one of:

  • "other"
  • "highPressureSodium"
  • "metalHalide"
  • "mercuryVapor"

Type: object

Status of this asset.

Same definition as Location.status

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: string

Lot number for this asset. Even for the same model and version number, many assets are manufactured in lots.

Type: string

Kind of this facility.

Type: enum (of string)

Reason asset retired.

Must be one of:

  • "failed"
  • "excessiveMaintenance"
  • "environmental"
  • "sold"
  • "other"
  • "obsolescence"
  • "facilitiesUpgrade"

Type: enum (of string)

Kind of asset. Used in description of asset components in asset instance templates.

Must be one of:

  • "transformerTank"
  • "breakerTankAssembly"
  • "breakerBulkOilBreaker"
  • "breakerInsulatingStackAssembly"
  • "transformer"
  • "breakerMinimumOilBreaker"
  • "breakerAirBlastBreaker"
  • "other"
  • "breakerSF6LiveTankBreaker"
  • "breakerSF6DeadTankBreaker"

Type: boolean

If true, there is a communicating inverter present.

Type: string

A code used to specify the connection category, e.g. low voltage, where the meter operates.

Type: boolean

If true, autonomous daylight saving time (DST) function is supported.

Type: string

(if applicable) Date the tool was last calibrated.

Type: string

Utility-specific classification of Asset and its subtypes, according to their corporate standards, practices, and existing IT systems (e.g., for management of assets, maintenance, work, outage, customers, etc.).

Type: object or number

Length of arm. Note that a new light may be placed on an existing arm.

Same definition as HydroGeneratingUnit.dropHeight

Type: object or number

Length of this support structure.

Same definition as HydroGeneratingUnit.dropHeight

Type: object or number

Percentage of initial life expectancy that has been lost as of the last life expectancy baseline. Represents
(initial life expectancy - current life expectancy) / initial life expectancy.

Same definition as InefficientBatteryUnit.efficiencyDischarge

Type: string

Serial number of this asset.

Type: string

Condition of asset at last baseline. Examples include new, rebuilt, overhaul required, other. Refer to inspection data for information on the most current condition of the asset.

Type: string

Position of asset or asset component. May often be in relation to other assets or components.

Type: string

The type of insulation around the joint, classified according to the utility's asset management standards and practices.

Type: string

Date and time the last odometer reading was recorded.

Type: object or number

Odometer reading of this vehicle as of the 'odometerReadingDateTime'. Refer to associated ActivityRecords for earlier readings.

Same definition as HydroGeneratingUnit.dropHeight

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

Automated meter reading (AMR) or other communication system responsible for communications to this end device.

Type: object

For proposing Locations for DER installation

Type: array

Set of spatial coordinates that determine a point, defined in the coordinate system specified in 'Location.CoordinateSystem'. Use a single position point instance to describe a point-oriented location. Use a sequence of position points to describe a line-oriented object (physical location of non-point oriented objects like cables or lines), or area of an object (like a substation or a geographical zone - in this case, have first and last position point with the same values).

No Additional Items

Each item of this array must be:

Type: object

Set of spatial coordinates that determine a point, defined in the coordinate system specified in 'Location.CoordinateSystem'. Use a single position point instance to describe a point-oriented location. Use a sequence of position points to describe a line-oriented object (physical location of non-point oriented objects like cables or lines), or area of an object (like a substation or a geographical zone - in this case, have first and last position point with the same values).

Same definition as PositionPoint

Type: string

(if applicable) Reference to geographical information source, often external to the utility.

Type: string

Classification by utility's corporate standards and practices, relative to the location itself (e.g., geographical, functional accounting, etc., not a given property that happens to exist at that location).

Type: object

Secondary address of the location. For example, PO Box address may have different ZIP code than that in the 'mainAddress'.

Same definition as Location.secondaryAddress

Type: object

Additional phone number.

Same definition as Location.phone1

Type: string

(if applicable) Direction that allows field crews to quickly find a given asset. For a given location, such as a street address, this is the relative direction in which to find the asset. For example, a streetlight may be located at the 'NW' (northwest) corner of the customer's site, or a usage point may be located on the second floor of an apartment building.

Type: object

Status of this location.

Same definition as Location.status

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

The fossil fuel consumed by the non-nuclear thermal generating unit. For example, coal, oil, gas, etc. These are the specific fuels that the generating unit can consume.

Type: enum (of string)

The type of fossil fuel, such as coal, oil, or gas.

Same definition as FuelAllocationSchedule.fuelType

Type: object

The cost in terms of heat value for the given type of fuel.

Same definition as ThermalGeneratingUnit.oMCost

Type: object

The cost of fuel used for economic dispatching which includes: fuel cost, transportation cost, and incremental maintenance cost.

Same definition as ThermalGeneratingUnit.oMCost

Type: object or number

The efficiency factor for the fuel (per unit) in terms of the effective energy absorbed.

Same definition as PowerElectronicsConnection.maxIFault

Type: object

Handling and processing cost associated with this fuel.

Same definition as ThermalGeneratingUnit.oMCost

Type: number

The amount of heat per weight (or volume) of the given type of fuel.

Type: object or number

Relative amount of the given type of fuel, when multiple fuels are being consumed.

Same definition as InefficientBatteryUnit.efficiencyDischarge

Type: object or number

The fuel's fraction of pollution credit per unit of heat content.

Same definition as PowerElectronicsConnection.maxIFault

Type: object or number

The active power output level of the unit at which the given type of fuel is switched on. This fuel (e.g., oil) is sometimes used to supplement the base fuel (e.g., coal) at high active power output levels.

Same definition as SvInjection.pInjection

Type: object or number

The active power output level of the unit at which the given type of fuel is switched off. This fuel (e.g., oil) is sometimes used to stabilize the base fuel (e.g., coal) at low active power output levels.

Same definition as SvInjection.pInjection

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

nan

Type: object

Status of subject matter (e.g., Agreement, Work) this document represents. For status of the document itself, use 'docStatus' attribute.

Same definition as Location.status

Type: string

Free text comment.

Type: object

Status of this document. For status of subject matter this document represents (e.g., Agreement, Work), use 'status' attribute.
Example values for 'docStatus.status' are draft, approved, cancelled, etc.

Same definition as Location.status

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

Name of the author of this document.

Type: enum (of string)

defines the status of the crew as in dispatched or arrived, etc.

Same definition as Outage.statusKind

Type: string

This contains an disclaimers the utility would like to place on the data provided to any stakeholder. This may be different for different stakeholders. This should possibly be an attribute under the Organization class but it is placed here for now.

Type: number

nan

Type: string

Utility-specific classification of this document, according to its corporate standards, practices, and existing IT systems (e.g., for management of assets, maintenance, work, outage, customers, etc.).

Type: string

Document title.

Type: string

a name to denote the community - this could be a name or a code of some kind.

Type: string

Revision number for this document.

Type: integer

the total number of customers that are served in the area (both outaged and not outaged).

Type: object

Estimated outage period for a planned outage. The start of the period is the start of the planned outage and the end of the period corresponds to the end of the planned outage.

Same definition as Outage.estimatedPeriod

Type: integer

number of customers that have been restored in the area.

Type: string

Date and time that this document was created.

Type: integer

The original number of meters that were affected as reported by the OMS within the utility. That is, this is the total number of meters that were out at the beginning of the outage.

Type: string

Document subject.

Type: string

Date and time this document was last modified. Documents may potentially be modified many times during their lifetime.

Type: object

Summary counts of service points (customers) affected by this outage.

Same definition as Outage.summary

Type: integer

The updated number of meters affected by the outage as reported by the OMS within the utility. It is assumed this number will be updated repeatedly until the full outage is resolved.

Type: object

Actual outage period; end of the period corresponds to the actual restoration time.

Same definition as Outage.estimatedPeriod

Type: enum (of string)

Defines if the outage has been verified or is only estimated

Same definition as Outage.outageKind

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

nan

Type: object

nan

Type: object

nan

Type: array

nan

No Additional Items

Each item of this array must be:

Type: object

nan

Type: object

nan

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

nan

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

nan

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

nan

Type: array of string
No Additional Items

Each item of this array must be:

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

nan

Type: object

nan

Type: object

nan

Type: array

Multi-purpose data points for defining a curve. The use of this generic class is discouraged if a more specific class can be used to specify the X and Y axis values along with their specific data types.

No Additional Items

Each item of this array must be:

Type: object

Multi-purpose data points for defining a curve. The use of this generic class is discouraged if a more specific class can be used to specify the X and Y axis values along with their specific data types.

Same definition as CurveData

Type: object

nan

Type: array of string
No Additional Items

Each item of this array must be:

Type: object

nan

Type: object

nan

Type: object

nan

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

nan

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

nan

Type: object

nan

Type: enum (of string)

nan

Must be one of:

  • "Minimum"
  • "Maximum"
  • "SeekValue"

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

nan

Type: object

nan

Type: enum (of string)

nan

Must be one of:

  • "overheadLine"
  • "undergroundCable"

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

nan

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

nan

Type: object

nan

Type: object

nan

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

nan

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

nan

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.

Type: object

nan

Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

Type: string

The name is any free human readable and possibly non unique text naming the object.