EquivalentEquipment

Type: object

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

Type: object

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

Type: array

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

No Additional Items

Each item of this array must be:

Type: object

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

Type: boolean

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

Type: enum (of string)

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

Must be one of:

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

Type: integer

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

Type: string

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

Type: string

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

Type: string

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

Type: string

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

Type: array

State variable for status.

No Additional Items

Each item of this array must be:

Type: object

State variable for status.

Type: boolean

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

Type: enum (of string)

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

Must be one of:

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

Type: object or number

Maximum active power of the injection.

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

nan

Must be one of:

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

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

nan

Must be one of:

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

Type: number Default: null

nan

Type: object or number

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

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

nan

Same definition as unit

Type: number Default: null

nan

Type: object or number

Minimum active power of the injection.

Same definition as EquivalentInjection.maxP

Type: object or number

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

Same definition as EquivalentInjection.maxQ

Type: object or number

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

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

nan

Same definition as unit

Type: number Default: null

nan

Type: object or number

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

Same definition as EquivalentInjection.r

Type: object or number

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

Same definition as EquivalentInjection.r

Type: boolean

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

Type: boolean

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

Type: object or number

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

Type: object or number

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

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

nan

Same definition as unit

Type: number Default: null

nan

Type: object or number

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

Same definition as EquivalentInjection.x

Type: object or number

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

Same definition as EquivalentInjection.x

Type: string

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

Type: object or number

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

Same definition as EquivalentInjection.maxP

Type: object or number

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

Same definition as EquivalentInjection.maxQ

Type: boolean

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

Type: boolean

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

Type: boolean

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

Type: boolean

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

Type: string

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

Type: string

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

Type: string

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

Type: object

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

Type: array

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

No Additional Items

Each item of this array must be:

Type: object

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

Same definition as Terminal

Type: array

State variable for status.

No Additional Items

Each item of this array must be:

Type: string

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

Type: object

nan

Type: enum (of string) Default: null

nan

Must be one of:

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

Type: number Default: null

nan

Type: object or number

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

Same definition as EquivalentInjection.r

Type: object or number

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

Same definition as EquivalentInjection.r

Type: object or number

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

Same definition as EquivalentInjection.x

Type: object or number

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

Same definition as EquivalentInjection.x

Type: object or number

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

Same definition as EquivalentInjection.r

Type: object or number

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

Same definition as EquivalentInjection.r

Type: object or number

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

Same definition as EquivalentInjection.x

Type: object or number

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

Same definition as EquivalentInjection.x

Type: object or number

Positive sequence series resistance of the reduced branch.

Same definition as EquivalentInjection.r

Type: object or number

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

Same definition as EquivalentInjection.r

Type: object or number

Positive sequence series reactance of the reduced branch.

Same definition as EquivalentInjection.x

Type: object or number

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

Same definition as EquivalentInjection.x

Type: object or number

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

Same definition as EquivalentInjection.r

Type: object or number

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

Same definition as EquivalentInjection.r

Type: object or number

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

Same definition as EquivalentInjection.x

Type: object or number

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

Same definition as EquivalentInjection.x

Type: boolean

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

Type: boolean

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

Type: boolean

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

Type: boolean

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

Type: string

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

Type: string

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

Type: string

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

Type: object

The class represents equivalent shunts.

Type: array

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

No Additional Items

Each item of this array must be:

Type: object

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

Same definition as Terminal

Type: array

State variable for status.

No Additional Items

Each item of this array must be:

Type: boolean

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

Type: boolean

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

Type: boolean

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

Type: object or number

Positive sequence shunt susceptance.

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

nan

Same definition as multiplier

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

nan

Same definition as unit

Type: number Default: null

nan

Type: object or number

Positive sequence shunt conductance.

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

nan

Same definition as multiplier

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

nan

Same definition as unit

Type: number Default: null

nan

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.