RegulatingCondEq

Type: object

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

No Additional Properties

Type: object

Hash table of PowerElectronicsConnection objects

No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^.+$
Type: object

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

No Additional Properties

Type: array

Array of Terminal objects

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.

No Additional Properties

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:

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

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

Used in RAVENS Schema to identify the corresponding CIM Object Type of the JSON 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 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.

No Additional Properties

Type: object

nan

No Additional Properties

Type: enum (of string)

nan

Must be one of:

  • "constantPFixedQConstantReactance"
  • "constantPFixedV"
  • "constantPFixedQ"
  • "constantPF"
  • "constantPConstantQCurrentLimited"
  • "constantAdmittance"

Type: object or number

Full energy storage capacity of the battery. The attribute shall be a positive value.

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

nan

Must be one of:

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

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

nan

Must be one of:

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

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: string

Used in RAVENS Schema to identify the corresponding CIM Object Type of the JSON object.

Type: enum (of string)

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

Must be one of:

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

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 photovoltaic device or an aggregation of such devices.

No Additional Properties

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

Used in RAVENS Schema to identify the corresponding CIM Object Type of the JSON 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: 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 wind generating unit that connects to the AC network with power electronics rather than rotating machines or an aggregation of such units.

No Additional Properties

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

Used in RAVENS Schema to identify the corresponding CIM Object Type of the JSON 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: 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

Array of PowerElectronicsConnectionPhase objects

No Additional Items

Each item of this array must be:

Type: object

A single phase of a power electronics connection.

No Additional Properties

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.

Must be one of:

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

Type: string

Used in RAVENS Schema to identify the corresponding CIM Object Type of the JSON object.

Type: object or number

Active power injection. Load sign convention is used, i.e. positive sign means flow into the equipment from the network.

Same definition as PowerElectronicsUnit.maxP

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

Array of SvStatus objects

No Additional Items

Each item of this array must be:

Type: object

State variable for status.

No Additional Properties

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 PowerElectronicsConnectionPhase.phase

Type: string

Used in RAVENS Schema to identify the corresponding CIM Object Type of the JSON 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: 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: object or number

Maximum fault current this device will contribute, in per-unit of rated current, before the converter protection will trip or bypass.

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 PowerElectronicsConnectionPhase.q

Type: object or number

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

Same definition as PowerElectronicsConnectionPhase.q

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 PowerElectronicsUnit.maxP

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 PowerElectronicsConnectionPhase.q

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

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

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.

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

Hash table of StaticVarCompensator objects

No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^.+$
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.

No Additional Properties

Type: string

Pointer to Location object

Type: string

Pointer to SwitchingAction object

Type: string

Pointer to BaseVoltage object

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 PowerElectronicsConnection.ratedU

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 PowerElectronicsConnectionPhase.q

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

Used in RAVENS Schema to identify the corresponding CIM Object Type of the JSON object.

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

Capacitive reactance at maximum capacitive reactive power. Shall always be positive.

Same definition as PowerElectronicsConnection.x

Type: object or number

Inductive reactance at maximum inductive reactive power. Shall always be negative.

Same definition as PowerElectronicsConnection.x

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

Hash table of ExternalNetworkInjection objects

No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^.+$
Type: object

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

No Additional Properties

Type: string

Pointer to SwitchingAction object

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 initial symmetrical short-circuit currents (Ik" max) in A (Ik" = Sk"/(SQRT(3) Un)). Used for short circuit data exchange according to IEC 60909.

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 PowerElectronicsConnectionPhase.q

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 PowerElectronicsConnectionPhase.q

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

Used in RAVENS Schema to identify the corresponding CIM Object Type of the JSON 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: 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 PowerElectronicsUnit.maxP

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 PowerElectronicsConnectionPhase.q

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

Hash table of FrequencyConverter objects

No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^.+$
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.

No Additional Properties

Type: string

Pointer to Location object

Type: string

Pointer to SwitchingAction object

Type: string

Pointer to BaseVoltage 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: 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

Used in RAVENS Schema to identify the corresponding CIM Object Type of the JSON object.

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

Frequency on the AC side.

Type: object or number

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

Same definition as PowerElectronicsUnit.maxP

Type: object or number

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

Same definition as PowerElectronicsConnection.ratedU

Type: object or number

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

Same definition as PowerElectronicsUnit.maxP

Type: object or number

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

Same definition as PowerElectronicsConnection.ratedU

Type: object

Hash table of ShuntCompensator objects

No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^.+$
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: 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.

Same definition as ShuntCompensator
Type: object

A linear shunt compensator has banks or sections with equal admittance values.

No Additional Properties

Type: array

Array of LinearShuntCompensatorPhase objects

No Additional Items

Each item of this array must be:

Type: object

A per phase linear shunt compensator has banks or sections with equal admittance values.

No Additional Properties

Type: string

Used in RAVENS Schema to identify the corresponding CIM Object Type of the JSON object.

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 PowerElectronicsConnectionPhase.phase

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: 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

Pointer to ShuntCompensatorInfo object

Type: array

Array of SvShuntCompensatorSections objects

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.

No Additional Properties

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 PowerElectronicsConnectionPhase.phase

Type: string

Used in RAVENS Schema to identify the corresponding CIM Object Type of the JSON 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: 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.

Type: boolean

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

Type: integer

The maximum number of sections that may be switched in.

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 PowerElectronicsConnection.ratedU

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:

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

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 equipment is enabled to participate in network analysis. If unspecified, the value is assumed to be true.

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 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 non linear shunt compensator has bank or section admittance values that differ. The attributes g, b, g0 and b0 of the associated NonlinearShuntCompensatorPoint describe the total conductance and admittance of a NonlinearShuntCompensatorPoint at a section number specified by NonlinearShuntCompensatorPoint.sectionNumber.

No Additional Properties

Type: array

Array of NonlinearShuntCompensatorPhase objects

No Additional Items

Each item of this array must be:

Type: object

A per phase non linear shunt compensator has bank or section admittance values that differ. The attributes g and b of the associated NonlinearShuntCompensatorPhasePoint describe the total conductance and admittance of a NonlinearShuntCompensatorPhasePoint at a section number specified by NonlinearShuntCompensatorPhasePoint.sectionNumber.

No Additional Properties

Type: string

Used in RAVENS Schema to identify the corresponding CIM Object Type of the JSON object.

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 PowerElectronicsConnectionPhase.phase

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: 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

Used in RAVENS Schema to identify the corresponding CIM Object Type of the JSON 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: 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 ShuntCompensator.aVRDelay

Type: boolean

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

Type: integer

The maximum number of sections that may be switched in.

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 PowerElectronicsConnection.ratedU

Type: integer

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

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 equipment is enabled to participate in network analysis. If unspecified, the value is assumed to be true.

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

Hash table of RotatingMachine objects

No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^.+$
Type: object

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

Type: object

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

Same definition as RotatingMachine
Type: object

An electromechanical device that operates with shaft rotating synchronously with the network. It is a single machine operating either as a generator or synchronous condenser or pump.

No Additional Properties

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

No Additional Properties

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.

No Additional Properties

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

Used in RAVENS Schema to identify the corresponding CIM Object Type of the JSON object.

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 time for the last time point. The value can be a time of day, not a specific date.

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

Array of GenUnitOpCostCurve objects

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.

No Additional Properties

Type: enum (of string)

The style or shape of the curve.

Must be one of:

  • "straightLineYValues"
  • "constantYValue"

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: enum (of string)

Type of turbine.

Must be one of:

  • "francis"
  • "kaplan"
  • "pelton"

Type: object or number

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

Same definition as PowerElectronicsUnit.maxP

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 PowerElectronicsUnit.maxP

Type: object or number

This is the maximum operating active power limit the dispatcher can enter for this unit.

Same definition as PowerElectronicsUnit.maxP

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 PowerElectronicsUnit.maxP

Type: object or number

This is the minimum operating active power limit the dispatcher can enter for this unit.

Same definition as PowerElectronicsUnit.maxP

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 PowerElectronicsUnit.maxP

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 unit's gross rated maximum capacity (book value).
The attribute shall be a positive value.

Same definition as PowerElectronicsUnit.maxP

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 PowerElectronicsUnit.maxP

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 PowerElectronicsUnit.maxP

Type: object or number

The normal maximum rate the generating unit active power output can be lowered by control actions.

Same definition as GeneratingUnit.raiseRampRate

Type: object

The initial startup cost incurred for each start of the GeneratingUnit.

Type: enum (of string) Default: null

nan

Must be one of:

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

Type: object or number

Time it takes to get the unit on-line, from the time that the prime mover mechanical power is applied.

Same definition as ShuntCompensator.aVRDelay

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)

Energy conversion capability for generating.

Must be one of:

  • "generator"
  • "pumpAndGenerator"

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 PowerElectronicsUnit.maxP

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: string

Used in RAVENS Schema to identify the corresponding CIM Object Type of the JSON object.

Type: object or number

The planned unused capacity (spinning reserve) which can be used to support emergency load.

Same definition as PowerElectronicsUnit.maxP

Type: object or number

The planned unused capacity which can be used to support automatic control overruns.

Same definition as PowerElectronicsUnit.maxP

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 PowerElectronicsUnit.maxP

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 PowerElectronicsUnit.maxP

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

Type: object or number

The efficiency of the unit in converting mechanical energy, from the prime mover, into electrical energy.

Same definition as InefficientBatteryUnit.efficiencyDischarge

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 unit control mode.

Must be one of:

  • "setpoint"
  • "pulse"

Type: enum (of string)

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

Must be one of:

  • "onAGC"
  • "unavailable"
  • "offAGC"
  • "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.

No Additional Properties

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: 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 PowerElectronicsUnit.maxP

Type: object or number

The normal maximum rate the generating unit active power output can be lowered by control actions.

Same definition as GeneratingUnit.raiseRampRate

Type: object or number

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

Same definition as PowerElectronicsUnit.maxP

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 PowerElectronicsUnit.maxP

Type: object or number

This is the maximum operating active power limit the dispatcher can enter for this unit.

Same definition as PowerElectronicsUnit.maxP

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 PowerElectronicsUnit.maxP

Type: object or number

This is the minimum operating active power limit the dispatcher can enter for this unit.

Same definition as PowerElectronicsUnit.maxP

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 PowerElectronicsUnit.maxP

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 normal maximum rate the generating unit active power output can be raised by control actions.

Same definition as GeneratingUnit.raiseRampRate

Type: object or number

The unit's gross rated maximum capacity (book value).
The attribute shall be a positive value.

Same definition as PowerElectronicsUnit.maxP

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 PowerElectronicsUnit.maxP

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 PowerElectronicsUnit.maxP

Type: string

Used in RAVENS Schema to identify the corresponding CIM Object Type of the JSON object.

Type: object or number

Time it takes to get the unit on-line, from the time that the prime mover mechanical power is applied.

Same definition as ShuntCompensator.aVRDelay

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

The planned unused capacity (spinning reserve) which can be used to support emergency load.

Same definition as PowerElectronicsUnit.maxP

Type: object or number

The planned unused capacity which can be used to support automatic control overruns.

Same definition as PowerElectronicsUnit.maxP

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 PowerElectronicsUnit.maxP

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 PowerElectronicsUnit.maxP

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

Type: object or number

The efficiency of the unit in converting mechanical energy, from the prime mover, into electrical energy.

Same definition as InefficientBatteryUnit.efficiencyDischarge

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.

Same definition as GeneratingUnit.genControlSource
Type: object

A nuclear generating unit.

No Additional Properties

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: 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 PowerElectronicsUnit.maxP

Type: object or number

The normal maximum rate the generating unit active power output can be lowered by control actions.

Same definition as GeneratingUnit.raiseRampRate

Type: object or number

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

Same definition as PowerElectronicsUnit.maxP

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 PowerElectronicsUnit.maxP

Type: object or number

This is the maximum operating active power limit the dispatcher can enter for this unit.

Same definition as PowerElectronicsUnit.maxP

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 PowerElectronicsUnit.maxP

Type: object or number

This is the minimum operating active power limit the dispatcher can enter for this unit.

Same definition as PowerElectronicsUnit.maxP

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 PowerElectronicsUnit.maxP

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 normal maximum rate the generating unit active power output can be raised by control actions.

Same definition as GeneratingUnit.raiseRampRate

Type: object or number

The unit's gross rated maximum capacity (book value).
The attribute shall be a positive value.

Same definition as PowerElectronicsUnit.maxP

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 PowerElectronicsUnit.maxP

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 PowerElectronicsUnit.maxP

Type: string

Used in RAVENS Schema to identify the corresponding CIM Object Type of the JSON object.

Type: object or number

Time it takes to get the unit on-line, from the time that the prime mover mechanical power is applied.

Same definition as ShuntCompensator.aVRDelay

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

The planned unused capacity (spinning reserve) which can be used to support emergency load.

Same definition as PowerElectronicsUnit.maxP

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 PowerElectronicsUnit.maxP

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 PowerElectronicsUnit.maxP

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

Type: object or number

The efficiency of the unit in converting mechanical energy, from the prime mover, into electrical energy.

Same definition as InefficientBatteryUnit.efficiencyDischarge

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.

Same definition as GeneratingUnit.genControlSource
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.

No Additional Properties

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: 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 PowerElectronicsUnit.maxP

Type: object or number

The normal maximum rate the generating unit active power output can be lowered by control actions.

Same definition as GeneratingUnit.raiseRampRate

Type: object or number

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

Same definition as PowerElectronicsUnit.maxP

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 PowerElectronicsUnit.maxP

Type: object or number

This is the maximum operating active power limit the dispatcher can enter for this unit.

Same definition as PowerElectronicsUnit.maxP

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 PowerElectronicsUnit.maxP

Type: object or number

This is the minimum operating active power limit the dispatcher can enter for this unit.

Same definition as PowerElectronicsUnit.maxP

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 PowerElectronicsUnit.maxP

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 normal maximum rate the generating unit active power output can be raised by control actions.

Same definition as GeneratingUnit.raiseRampRate

Type: object or number

The unit's gross rated maximum capacity (book value).
The attribute shall be a positive value.

Same definition as PowerElectronicsUnit.maxP

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 PowerElectronicsUnit.maxP

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 PowerElectronicsUnit.maxP

Type: string

Used in RAVENS Schema to identify the corresponding CIM Object Type of the JSON object.

Type: object or number

Time it takes to get the unit on-line, from the time that the prime mover mechanical power is applied.

Same definition as ShuntCompensator.aVRDelay

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: enum (of string)

The kind of wind generating unit.

Must be one of:

  • "onshore"
  • "offshore"

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 planned unused capacity (spinning reserve) which can be used to support emergency load.

Same definition as PowerElectronicsUnit.maxP

Type: object or number

The planned unused capacity which can be used to support automatic control overruns.

Same definition as PowerElectronicsUnit.maxP

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 PowerElectronicsUnit.maxP

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 PowerElectronicsUnit.maxP

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

Type: object or number

The efficiency of the unit in converting mechanical energy, from the prime mover, into electrical energy.

Same definition as InefficientBatteryUnit.efficiencyDischarge

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.

Same definition as GeneratingUnit.genControlSource
Type: object

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

No Additional Properties

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: 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 PowerElectronicsUnit.maxP

Type: object or number

The normal maximum rate the generating unit active power output can be lowered by control actions.

Same definition as GeneratingUnit.raiseRampRate

Type: object or number

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

Same definition as PowerElectronicsUnit.maxP

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 PowerElectronicsUnit.maxP

Type: object or number

This is the maximum operating active power limit the dispatcher can enter for this unit.

Same definition as PowerElectronicsUnit.maxP

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 PowerElectronicsUnit.maxP

Type: object or number

This is the minimum operating active power limit the dispatcher can enter for this unit.

Same definition as PowerElectronicsUnit.maxP

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 PowerElectronicsUnit.maxP

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 normal maximum rate the generating unit active power output can be raised by control actions.

Same definition as GeneratingUnit.raiseRampRate

Type: object or number

The unit's gross rated maximum capacity (book value).
The attribute shall be a positive value.

Same definition as PowerElectronicsUnit.maxP

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 PowerElectronicsUnit.maxP

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 PowerElectronicsUnit.maxP

Type: string

Used in RAVENS Schema to identify the corresponding CIM Object Type of the JSON object.

Type: object or number

Time it takes to get the unit on-line, from the time that the prime mover mechanical power is applied.

Same definition as ShuntCompensator.aVRDelay

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

The planned unused capacity (spinning reserve) which can be used to support emergency load.

Same definition as PowerElectronicsUnit.maxP

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 PowerElectronicsUnit.maxP

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 PowerElectronicsUnit.maxP

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

Type: object or number

The efficiency of the unit in converting mechanical energy, from the prime mover, into electrical energy.

Same definition as InefficientBatteryUnit.efficiencyDischarge

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.

Same definition as GeneratingUnit.genControlSource

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 ShuntCompensator.aVRDelay

Type: object or number

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

Same definition as PowerElectronicsConnectionPhase.q

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:

  • "condenser"
  • "generator"
  • "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: object or number

Zero sequence resistance of the synchronous machine.

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-axis subtransient reactance saturated, also known as Xd"sat.

Same definition as PowerElectronicsConnection.maxIFault

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:

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

Type: string

Used in RAVENS Schema to identify the corresponding CIM Object Type of the JSON object.

Type: enum (of string)

Modes that this synchronous machine can operate in.

Must be one of:

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

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: object or number

Zero sequence reactance of the synchronous machine.

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

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 PowerElectronicsConnection.ratedU

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 PowerElectronicsUnit.maxP

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 PowerElectronicsConnectionPhase.q

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

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

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

Same definition as ShuntCompensator.aVRDelay

Type: object or number

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

Same definition as ShuntCompensator.aVRDelay

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 PowerElectronicsConnectionPhase.q

Type: object or number

Active power consumed when in condenser mode operation.

Same definition as PowerElectronicsUnit.maxP

Type: number

Temperature or pressure of coolant medium.

Type: enum (of string)

Method of cooling the machine.

Must be one of:

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

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

A rotating machine whose shaft rotates asynchronously with the electrical field. Also known as an induction machine with no external connection to the rotor windings, e.g. squirrel-cage induction machine.

No Additional Properties

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.

Same definition as RotatingMachine.GeneratingUnit

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: object or number

Nameplate data indicates if the machine is 50 Hz or 60 Hz.

Same definition as FrequencyConverter.frequency

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 PowerElectronicsUnit.maxP

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: object or number

Transient rotor time constant (greater than tppo).

Same definition as ShuntCompensator.aVRDelay

Type: object or number

Sub-transient rotor time constant (greater than 0).

Same definition as ShuntCompensator.aVRDelay

Type: object or number

Transient reactance (unsaturated) (greater than or equal to xpp).

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

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 PowerElectronicsConnection.ratedU

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 PowerElectronicsUnit.maxP

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 PowerElectronicsConnectionPhase.q

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)

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

Must be one of:

  • "motor"
  • "generator"

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

Used in RAVENS Schema to identify the corresponding CIM Object Type of the JSON object.

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.