EnergyConsumer

Type: object

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

No Additional Properties

AssetInfo_anyOfPointer

Type: object

Pointer to AssetInfo object

AssetInfo_Pointer

Type: string

Pointer to AssetInfo object

Must match regular expression: ^AssetInfo::'(.+)'$

PowerTransformerInfo_Pointer

Type: string

Pointer to PowerTransformerInfo object

Must match regular expression: ^PowerTransformerInfo::'(.+)'$

WireInfo_Pointer

Type: string

Pointer to WireInfo object

Must match regular expression: ^WireInfo::'(.+)'$

SwitchInfo_Pointer

Type: string

Pointer to SwitchInfo object

Must match regular expression: ^SwitchInfo::'(.+)'$

ShuntCompensatorInfo_Pointer

Type: string

Pointer to ShuntCompensatorInfo object

Must match regular expression: ^ShuntCompensatorInfo::'(.+)'$

WireAssemblyInfo_Pointer

Type: string

Pointer to WireAssemblyInfo object

Must match regular expression: ^WireAssemblyInfo::'(.+)'$

TransformerEndInfo_Pointer

Type: string

Pointer to TransformerEndInfo object

Must match regular expression: ^TransformerEndInfo::'(.+)'$

TapChangerInfo_Pointer

Type: string

Pointer to TapChangerInfo object

Must match regular expression: ^TapChangerInfo::'(.+)'$

WireSpacingInfo_Pointer

Type: string

Pointer to WireSpacingInfo object

Must match regular expression: ^WireSpacingInfo::'(.+)'$

TransformerTankInfo_Pointer

Type: string

Pointer to TransformerTankInfo object

Must match regular expression: ^TransformerTankInfo::'(.+)'$

CableInfo_Pointer

Type: string

Pointer to CableInfo object

Must match regular expression: ^CableInfo::'(.+)'$

OverheadWireInfo_Pointer

Type: string

Pointer to OverheadWireInfo object

Must match regular expression: ^OverheadWireInfo::'(.+)'$

ConcentricNeutralCableInfo_Pointer

Type: string

Pointer to ConcentricNeutralCableInfo object

Must match regular expression: ^ConcentricNeutralCableInfo::'(.+)'$

TapeShieldCableInfo_Pointer

Type: string

Pointer to TapeShieldCableInfo object

Must match regular expression: ^TapeShieldCableInfo::'(.+)'$

GenericAction_PointerArray

Type: array of string

Pointers to GenericAction objects

No Additional Items

Each item of this array must be:

GenericAction_Pointer

Type: string

Pointer to GenericAction object

Location_anyOfPointer

Type: object

Pointer to Location object

Location_Pointer

Type: string

Pointer to Location object

Must match regular expression: ^Location::'(.+)'$

ProposedSiteLocation_Pointer

Type: string

Pointer to ProposedSiteLocation object

Must match regular expression: ^ProposedSiteLocation::'(.+)'$

PhaseConnectionDetail

Type: object

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

No Additional Properties

phaseConnection

Type: enum (of string)

nan

Must be one of:

  • "PhaseShuntConnectionKind.Yn"
  • "PhaseShuntConnectionKind.Y"
  • "PhaseShuntConnectionKind.G"
  • "PhaseShuntConnectionKind.I"
  • "PhaseShuntConnectionKind.D"

cimObjectType

Type: enum (of string)

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

Must be one of:

  • "PhaseConnectionDetail"

JumperAction_Pointer

Type: string

Pointer to JumperAction object

Must match regular expression: ^JumperAction::'(.+)'$

Terminal_Array

Type: array

Array of Terminal objects

No Additional Items

Each item of this array must be:

Terminal

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

OperationalLimitSet_PointerArray

Type: array of string

Pointers to OperationalLimitSet objects

No Additional Items

Each item of this array must be:

OperationalLimitSet_Pointer

Type: string

Pointer to OperationalLimitSet object

SvPowerFlow_Array

Type: array

Array of SvPowerFlow objects

No Additional Items

Each item of this array must be:

SvPowerFlow

Type: object

State variable for power flow. Load convention is used for flow direction. This means flow out from the TopologicalNode into the equipment is positive.

No Additional Properties

p

Type: object or number

The active power flow. Load sign convention is used, i.e. positive sign means flow out from a TopologicalNode (bus) into the conducting equipment.

No Additional Properties

UnitSymbol

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

nan

Must be one of:

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

UnitMultiplier

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

nan

Must be one of:

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

phase

Type: enum (of string)

The individual phase of the flow. If unspecified, then assumed to be balanced among phases.

Must be one of:

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

q

Type: object or number

The reactive power flow. Load sign convention is used, i.e. positive sign means flow out from a TopologicalNode (bus) into the conducting equipment.

No Additional Properties

UnitMultiplier

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

nan

Must be one of:

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

UnitSymbol

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

nan

Must be one of:

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

cimObjectType

Type: enum (of string)

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

Must be one of:

  • "SvPowerFlow"

Circuit_Pointer

Type: string

Pointer to Circuit object

Must match regular expression: ^Circuit::'(.+)'$

ConnectivityNode_Pointer

Type: string

Pointer to ConnectivityNode object

Must match regular expression: ^ConnectivityNode::'(.+)'$

TopologicalNode_Pointer

Type: string

Pointer to TopologicalNode object

Must match regular expression: ^TopologicalNode::'(.+)'$

connected

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.

phases

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:

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

sequenceNumber

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.

cimObjectType

Type: enum (of string)

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

Must be one of:

  • "Terminal"

description

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.

aliasName

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.

mRID

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.

name

Type: string

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

BaseVoltage_Pointer

Type: string

Pointer to BaseVoltage object

Must match regular expression: ^BaseVoltage::'(.+)'$

GroundAction_Pointer

Type: string

Pointer to GroundAction object

Must match regular expression: ^GroundAction::'(.+)'$

SvStatus_Array

Type: array

Array of SvStatus objects

No Additional Items

Each item of this array must be:

SvStatus

Type: object

State variable for status.

No Additional Properties

inService

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.

phase

Type: SinglePhaseKind

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

cimObjectType

Type: enum (of string)

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

Must be one of:

  • "SvStatus"

EnergyConnectionProfile_Pointer

Type: string

Pointer to EnergyConnectionProfile object

Must match regular expression: ^EnergyConnectionProfile::'(.+)'$

EnergyConsumerPhase_Array

Type: array

Array of EnergyConsumerPhase objects

No Additional Items

Each item of this array must be:

EnergyConsumerPhase

Type: object

A single phase of an energy consumer.

No Additional Properties

p

Type: ActivePower

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

pfixed

Type: ActivePower

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

pfixedPct

Type: PerCent

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

phase

Type: SinglePhaseKind

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

qfixed

Type: ReactivePower

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

qfixedPct

Type: PerCent

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

q

Type: ReactivePower

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

cimObjectType

Type: enum (of string)

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

Must be one of:

  • "EnergyConsumerPhase"

description

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.

aliasName

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.

mRID

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.

name

Type: string

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

EnergyConsumerSchedule_PointerArray

Type: array of string

Pointers to EnergyConsumerSchedule objects

No Additional Items

Each item of this array must be:

EnergyConsumerSchedule_Pointer

Type: string

Pointer to EnergyConsumerSchedule object

LoadResponseCharacteristic_Pointer

Type: string

Pointer to LoadResponseCharacteristic object

Must match regular expression: ^LoadResponseCharacteristic::'(.+)'$

LoadGroup_anyOfPointer

Type: object

Pointer to LoadGroup object

LoadGroup_Pointer

Type: string

Pointer to LoadGroup object

Must match regular expression: ^LoadGroup::'(.+)'$

OperationalLimitSet_PointerArray

Type: array of string

Pointers to OperationalLimitSet objects

Same definition as ACDCTerminal.OperationalLimitSet

qfixedPct

Type: PerCent

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

aggregate

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.

networkAnalysisEnabled

Type: boolean

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

normallyInService

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.

cimObjectType

Type: enum (of string)

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

Must be one of:

  • "EnergyConsumer"

customerCount

Type: integer

Number of individual customers represented by this demand.

grounded

Type: boolean

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

pfixed

Type: ActivePower

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

pfixedPct

Type: PerCent

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

phaseConnection

Type: PhaseShuntConnectionKind

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

p

Type: ActivePower

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

q

Type: ReactivePower

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

inService

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.

qfixed

Type: ReactivePower

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

description

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.

aliasName

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.

mRID

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.

name

Type: string

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