id: https://cim.ucaiug.io/ns#TC57CIM
name: TC57CIM
title: TC57CIM
contributors:
- github:bartkl
created_by: https://github.com/bartkl/cim-to-linkml
generation_date: 2026-05-11 20:07:27.468378
license: https://www.apache.org/licenses/LICENSE-2.0.txt
metamodel_version: 1.7.0
imports:
- linkml:types
prefixes:
linkml: https://w3id.org/linkml/
github: https://github.com/
cim: https://cim.ucaiug.io/ns#
default_curi_maps:
- semweb_context
default_prefix: cim
default_range: string
classes:
IEC61970CIMVersion:
class_uri: cim:IEC61970CIMVersion
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970
description: "This is the IEC 61970 CIM version number assigned to this UML model.\r\
\n"
attributes:
date:
slot_uri: cim:IEC61970CIMVersion.date
range: date
required: false
multivalued: false
description: Form is YYYY-MM-DD for example for January 5, 2009 it is 2009-01-05.
version:
slot_uri: cim:IEC61970CIMVersion.version
range: string
required: false
multivalued: false
description: Form is IEC61970CIMXXvYY where XX is the major CIM package version
and the YY is the minor version. For example IEC61970CIM13v18.
VoltagePerReactivePower:
class_uri: cim:VoltagePerReactivePower
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: "Voltage variation with reactive power.\r\n"
attributes:
multiplier:
slot_uri: cim:VoltagePerReactivePower.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:VoltagePerReactivePower.unit
range: UnitSymbol
required: false
multivalued: false
value:
slot_uri: cim:VoltagePerReactivePower.value
range: float
required: false
multivalued: false
Length:
class_uri: cim:Length
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: Unit of length. It shall be a positive value or zero.
attributes:
multiplier:
slot_uri: cim:Length.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:Length.unit
range: UnitSymbol
required: false
multivalued: false
value:
slot_uri: cim:Length.value
range: float
required: false
multivalued: false
ConductancePerLength:
class_uri: cim:ConductancePerLength
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: "Real part of admittance per unit of length.\r\n"
attributes:
multiplier:
slot_uri: cim:ConductancePerLength.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:ConductancePerLength.unit
range: UnitSymbol
required: false
multivalued: false
value:
slot_uri: cim:ConductancePerLength.value
range: float
required: false
multivalued: false
VolumeFlowRate:
class_uri: cim:VolumeFlowRate
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: "Volume per time.\r\n"
attributes:
multiplier:
slot_uri: cim:VolumeFlowRate.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:VolumeFlowRate.unit
range: UnitSymbol
required: false
multivalued: false
value:
slot_uri: cim:VolumeFlowRate.value
range: float
required: false
multivalued: false
TimeInterval:
class_uri: cim:TimeInterval
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: "Interval between two times.\r\n"
attributes:
end:
slot_uri: cim:TimeInterval.end
range: time
required: false
multivalued: false
description: "End time of this interval.\r\n"
start:
slot_uri: cim:TimeInterval.start
range: time
required: false
multivalued: false
description: "Start time of this interval.\r\n"
Volume:
class_uri: cim:Volume
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: "Volume.\r\n"
attributes:
multiplier:
slot_uri: cim:Volume.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:Volume.unit
range: UnitSymbol
required: false
multivalued: false
value:
slot_uri: cim:Volume.value
range: float
required: false
multivalued: false
Voltage:
class_uri: cim:Voltage
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: Electrical voltage, can be both AC and DC.
attributes:
multiplier:
slot_uri: cim:Voltage.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:Voltage.unit
range: UnitSymbol
required: false
multivalued: false
value:
slot_uri: cim:Voltage.value
range: float
required: false
multivalued: false
DateInterval:
class_uri: cim:DateInterval
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: "Interval between two dates.\r\n"
attributes:
end:
slot_uri: cim:DateInterval.end
range: date
required: false
multivalued: false
description: "End date of this interval.\r\n"
start:
slot_uri: cim:DateInterval.start
range: date
required: false
multivalued: false
description: "Start date of this interval.\r\n"
Temperature:
class_uri: cim:Temperature
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: "Value of temperature in degrees Celsius.\r\n"
attributes:
multiplier:
slot_uri: cim:Temperature.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:Temperature.unit
range: UnitSymbol
required: false
multivalued: false
value:
slot_uri: cim:Temperature.value
range: float
required: false
multivalued: false
Admittance:
class_uri: cim:Admittance
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: "Ratio of current to voltage.\r\n"
attributes:
multiplier:
slot_uri: cim:Admittance.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:Admittance.unit
range: UnitSymbol
required: false
multivalued: false
value:
slot_uri: cim:Admittance.value
range: float
required: false
multivalued: false
Impedance:
class_uri: cim:Impedance
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: "Ratio of voltage to current.\r\n"
attributes:
multiplier:
slot_uri: cim:Impedance.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:Impedance.unit
range: UnitSymbol
required: false
multivalued: false
value:
slot_uri: cim:Impedance.value
range: float
required: false
multivalued: false
CostPerVolume:
class_uri: cim:CostPerVolume
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: "Cost per unit volume.\r\n"
attributes:
multiplier:
slot_uri: cim:CostPerVolume.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:CostPerVolume.unit
range: Currency
required: false
multivalued: false
value:
slot_uri: cim:CostPerVolume.value
range: float
required: false
multivalued: false
SusceptancePerLength:
class_uri: cim:SusceptancePerLength
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: "Imaginary part of admittance per unit of length.\r\n"
attributes:
multiplier:
slot_uri: cim:SusceptancePerLength.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:SusceptancePerLength.unit
range: UnitSymbol
required: false
multivalued: false
value:
slot_uri: cim:SusceptancePerLength.value
range: float
required: false
multivalued: false
Money:
class_uri: cim:Money
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: "Amount of money.\r\n"
attributes:
multiplier:
slot_uri: cim:Money.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:Money.unit
range: Currency
required: false
multivalued: false
value:
slot_uri: cim:Money.value
range: double
required: false
multivalued: false
Minutes:
class_uri: cim:Minutes
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: "Time in minutes.\r\n"
attributes:
multiplier:
slot_uri: cim:Minutes.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:Minutes.unit
range: UnitSymbol
required: false
multivalued: false
value:
slot_uri: cim:Minutes.value
range: float
required: false
multivalued: false
FloatQuantity:
class_uri: cim:FloatQuantity
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: Quantity with float value and associated unit information.
attributes:
multiplier:
slot_uri: cim:FloatQuantity.multiplier
range: UnitMultiplier
required: false
multivalued: false
description: Unit multiplier of this quantity.
unit:
slot_uri: cim:FloatQuantity.unit
range: UnitSymbol
required: false
multivalued: false
description: Unit of this quantity.
value:
slot_uri: cim:FloatQuantity.value
range: float
required: false
multivalued: false
description: Value of this quantity.
CostPerEnergyUnit:
class_uri: cim:CostPerEnergyUnit
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: "Cost, in units of currency, per quantity of electrical energy generated.\r\
\n"
attributes:
multiplier:
slot_uri: cim:CostPerEnergyUnit.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:CostPerEnergyUnit.unit
range: Currency
required: false
multivalued: false
value:
slot_uri: cim:CostPerEnergyUnit.value
range: float
required: false
multivalued: false
PerCent:
class_uri: cim:PerCent
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: "Percentage on a defined base. For example, specify as 100 to indicate\
\ at the defined base.\r\n"
attributes:
multiplier:
slot_uri: cim:PerCent.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:PerCent.unit
range: UnitSymbol
required: false
multivalued: false
value:
slot_uri: cim:PerCent.value
range: float
required: false
multivalued: false
description: Normally 0 to 100 on a defined base.
IntegerQuantity:
class_uri: cim:IntegerQuantity
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: Quantity with integer value and associated unit information.
attributes:
multiplier:
slot_uri: cim:IntegerQuantity.multiplier
range: UnitMultiplier
required: false
multivalued: false
description: Unit multiplier of this quantity.
unit:
slot_uri: cim:IntegerQuantity.unit
range: UnitSymbol
required: false
multivalued: false
description: Unit of this quantity.
value:
slot_uri: cim:IntegerQuantity.value
range: integer
required: false
multivalued: false
description: Value of this quantity.
ApparentPower:
class_uri: cim:ApparentPower
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: "Product of the RMS value of the voltage and the RMS value of the\
\ current.\r\n"
attributes:
multiplier:
slot_uri: cim:ApparentPower.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:ApparentPower.unit
range: UnitSymbol
required: false
multivalued: false
value:
slot_uri: cim:ApparentPower.value
range: float
required: false
multivalued: false
WaterLevel:
class_uri: cim:WaterLevel
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: "Reservoir water level referred to a given datum such as mean sea\
\ level.\r\n"
attributes:
multiplier:
slot_uri: cim:WaterLevel.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:WaterLevel.unit
range: UnitSymbol
required: false
multivalued: false
value:
slot_uri: cim:WaterLevel.value
range: float
required: false
multivalued: false
Displacement:
class_uri: cim:Displacement
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: Unit of displacement relative to a reference position, hence can
be negative.
attributes:
multiplier:
slot_uri: cim:Displacement.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:Displacement.unit
range: UnitSymbol
required: false
multivalued: false
value:
slot_uri: cim:Displacement.value
range: float
required: false
multivalued: false
Damping:
class_uri: cim:Damping
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: Per-unit active power variation with frequency referenced on the
system apparent power base. Typical values are in the range 1,0 - 2,0.
attributes:
multiplier:
slot_uri: cim:Damping.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:Damping.unit
range: UnitSymbol
required: false
multivalued: false
value:
slot_uri: cim:Damping.value
range: float
required: false
multivalued: false
Seconds:
class_uri: cim:Seconds
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: "Time, in seconds.\r\n"
attributes:
multiplier:
slot_uri: cim:Seconds.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:Seconds.unit
range: UnitSymbol
required: false
multivalued: false
value:
slot_uri: cim:Seconds.value
range: float
required: false
multivalued: false
description: Time, in seconds
ResistancePerLength:
class_uri: cim:ResistancePerLength
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: "Resistance (real part of impedance) per unit of length.\r\n"
attributes:
multiplier:
slot_uri: cim:ResistancePerLength.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:ResistancePerLength.unit
range: UnitSymbol
required: false
multivalued: false
value:
slot_uri: cim:ResistancePerLength.value
range: float
required: false
multivalued: false
Inductance:
class_uri: cim:Inductance
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: "Inductive part of reactance (imaginary part of impedance), at rated\
\ frequency.\r\n"
attributes:
multiplier:
slot_uri: cim:Inductance.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:Inductance.unit
range: UnitSymbol
required: false
multivalued: false
value:
slot_uri: cim:Inductance.value
range: float
required: false
multivalued: false
AngleDegrees:
class_uri: cim:AngleDegrees
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: "Measurement of angle in degrees.\r\n"
attributes:
multiplier:
slot_uri: cim:AngleDegrees.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:AngleDegrees.unit
range: UnitSymbol
required: false
multivalued: false
value:
slot_uri: cim:AngleDegrees.value
range: float
required: false
multivalued: false
CostRate:
class_uri: cim:CostRate
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: Cost, in units of currency, per elapsed time.
attributes:
multiplier:
slot_uri: cim:CostRate.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:CostRate.unit
range: Currency
required: false
multivalued: false
value:
slot_uri: cim:CostRate.value
range: float
required: false
multivalued: false
Speed:
class_uri: cim:Speed
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: "Distance per unit of time.\r\n"
attributes:
multiplier:
slot_uri: cim:Speed.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:Speed.unit
range: UnitSymbol
required: false
multivalued: false
value:
slot_uri: cim:Speed.value
range: float
required: false
multivalued: false
Capacitance:
class_uri: cim:Capacitance
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: "Capacitive part of reactance (imaginary part of impedance), at rated\
\ frequency.\r\n"
attributes:
multiplier:
slot_uri: cim:Capacitance.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:Capacitance.unit
range: UnitSymbol
required: false
multivalued: false
value:
slot_uri: cim:Capacitance.value
range: float
required: false
multivalued: false
PU:
class_uri: cim:PU
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: "Per Unit - a positive or negative value referred to a defined base.\
\ Values typically range from -10 to +10.\r\n"
attributes:
multiplier:
slot_uri: cim:PU.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:PU.unit
range: UnitSymbol
required: false
multivalued: false
value:
slot_uri: cim:PU.value
range: float
required: false
multivalued: false
Pressure:
class_uri: cim:Pressure
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: Pressure in pascals.
attributes:
multiplier:
slot_uri: cim:Pressure.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:Pressure.unit
range: UnitSymbol
required: false
multivalued: false
value:
slot_uri: cim:Pressure.value
range: float
required: false
multivalued: false
KiloActivePower:
class_uri: cim:KiloActivePower
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: "Active power in kilowatts.\r\n"
attributes:
multiplier:
slot_uri: cim:KiloActivePower.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:KiloActivePower.unit
range: UnitSymbol
required: false
multivalued: false
value:
slot_uri: cim:KiloActivePower.value
range: float
required: false
multivalued: false
ReactivePower:
class_uri: cim:ReactivePower
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: "Product of RMS value of the voltage and the RMS value of the quadrature\
\ component of the current.\r\n"
attributes:
multiplier:
slot_uri: cim:ReactivePower.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:ReactivePower.unit
range: UnitSymbol
required: false
multivalued: false
value:
slot_uri: cim:ReactivePower.value
range: float
required: false
multivalued: false
StringQuantity:
class_uri: cim:StringQuantity
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: Quantity with string value (when it is not important whether it is
an integral or a floating point number) and associated unit information.
attributes:
multiplier:
slot_uri: cim:StringQuantity.multiplier
range: UnitMultiplier
required: false
multivalued: false
description: Unit multiplier of this quantity.
unit:
slot_uri: cim:StringQuantity.unit
range: UnitSymbol
required: false
multivalued: false
description: Unit of this quantity.
value:
slot_uri: cim:StringQuantity.value
range: string
required: false
multivalued: false
description: Value of this quantity.
ActivePowerChangeRate:
class_uri: cim:ActivePowerChangeRate
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: "Rate of change of active power per time.\r\n"
attributes:
multiplier:
slot_uri: cim:ActivePowerChangeRate.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:ActivePowerChangeRate.unit
range: UnitSymbol
required: false
multivalued: false
value:
slot_uri: cim:ActivePowerChangeRate.value
range: float
required: false
multivalued: false
Hours:
class_uri: cim:Hours
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: "Time specified in hours.\r\n"
attributes:
multiplier:
slot_uri: cim:Hours.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:Hours.unit
range: UnitSymbol
required: false
multivalued: false
value:
slot_uri: cim:Hours.value
range: float
required: false
multivalued: false
Conductance:
class_uri: cim:Conductance
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: "Factor by which voltage must be multiplied to give corresponding\
\ power lost from a circuit. Real part of admittance.\r\n"
attributes:
multiplier:
slot_uri: cim:Conductance.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:Conductance.unit
range: UnitSymbol
required: false
multivalued: false
value:
slot_uri: cim:Conductance.value
range: float
required: false
multivalued: false
RotationSpeed:
class_uri: cim:RotationSpeed
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: "Number of revolutions per second.\r\n"
attributes:
multiplier:
slot_uri: cim:RotationSpeed.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:RotationSpeed.unit
range: UnitSymbol
required: false
multivalued: false
value:
slot_uri: cim:RotationSpeed.value
range: float
required: false
multivalued: false
CurrentFlow:
class_uri: cim:CurrentFlow
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: 'Electrical current with sign convention: positive flow is out of
the conducting equipment into the connectivity node. Can be both AC and DC.'
attributes:
multiplier:
slot_uri: cim:CurrentFlow.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:CurrentFlow.unit
range: UnitSymbol
required: false
multivalued: false
value:
slot_uri: cim:CurrentFlow.value
range: float
required: false
multivalued: false
Frequency:
class_uri: cim:Frequency
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: Cycles per second.
attributes:
multiplier:
slot_uri: cim:Frequency.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:Frequency.unit
range: UnitSymbol
required: false
multivalued: false
value:
slot_uri: cim:Frequency.value
range: float
required: false
multivalued: false
DateTimeInterval:
class_uri: cim:DateTimeInterval
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: 'Interval between two date and time points, where the interval includes
the start time but excludes end time. '
attributes:
end:
slot_uri: cim:DateTimeInterval.end
range: date
required: false
multivalued: false
description: End date and time of this interval. The end date and time where
the interval is defined up to, but excluded.
start:
slot_uri: cim:DateTimeInterval.start
range: date
required: false
multivalued: false
description: Start date and time of this interval. The start date and time
is included in the defined interval.
AngleRadians:
class_uri: cim:AngleRadians
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: "Phase angle in radians.\r\n"
attributes:
multiplier:
slot_uri: cim:AngleRadians.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:AngleRadians.unit
range: UnitSymbol
required: false
multivalued: false
value:
slot_uri: cim:AngleRadians.value
range: float
required: false
multivalued: false
ActivePower:
class_uri: cim:ActivePower
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: Product of RMS value of the voltage and the RMS value of the in-phase
component of the current.
attributes:
multiplier:
slot_uri: cim:ActivePower.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:ActivePower.unit
range: UnitSymbol
required: false
multivalued: false
value:
slot_uri: cim:ActivePower.value
range: float
required: false
multivalued: false
ReactancePerLength:
class_uri: cim:ReactancePerLength
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: "Reactance (imaginary part of impedance) per unit of length, at rated\
\ frequency.\r\n"
attributes:
multiplier:
slot_uri: cim:ReactancePerLength.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:ReactancePerLength.unit
range: UnitSymbol
required: false
multivalued: false
value:
slot_uri: cim:ReactancePerLength.value
range: float
required: false
multivalued: false
Resistance:
class_uri: cim:Resistance
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: "Resistance (real part of impedance).\r\n"
attributes:
multiplier:
slot_uri: cim:Resistance.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:Resistance.unit
range: UnitSymbol
required: false
multivalued: false
value:
slot_uri: cim:Resistance.value
range: float
required: false
multivalued: false
Reactance:
class_uri: cim:Reactance
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: "Reactance (imaginary part of impedance), at rated frequency.\r\n"
attributes:
multiplier:
slot_uri: cim:Reactance.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:Reactance.unit
range: UnitSymbol
required: false
multivalued: false
value:
slot_uri: cim:Reactance.value
range: float
required: false
multivalued: false
Susceptance:
class_uri: cim:Susceptance
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: Imaginary part of admittance.
attributes:
multiplier:
slot_uri: cim:Susceptance.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:Susceptance.unit
range: UnitSymbol
required: false
multivalued: false
value:
slot_uri: cim:Susceptance.value
range: float
required: false
multivalued: false
RealEnergy:
class_uri: cim:RealEnergy
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: "Real electrical energy.\r\n"
attributes:
multiplier:
slot_uri: cim:RealEnergy.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:RealEnergy.unit
range: UnitSymbol
required: false
multivalued: false
value:
slot_uri: cim:RealEnergy.value
range: float
required: false
multivalued: false
Classification:
class_uri: cim:Classification
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: Classification of level. Specify as 1..n, with 1 being the most
detailed, highest priority, etc as described on the attribute using this data
type.
attributes:
multiplier:
slot_uri: cim:Classification.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:Classification.unit
range: UnitSymbol
required: false
multivalued: false
value:
slot_uri: cim:Classification.value
range: integer
required: false
multivalued: false
HeatRate:
class_uri: cim:HeatRate
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: Heat generated, in energy per time unit of elapsed time.
attributes:
multiplier:
slot_uri: cim:HeatRate.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:HeatRate.unit
range: UnitSymbol
required: false
multivalued: false
value:
slot_uri: cim:HeatRate.value
range: float
required: false
multivalued: false
Emission:
class_uri: cim:Emission
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: "Quantity of emission per fuel heat content.\r\n"
attributes:
multiplier:
slot_uri: cim:Emission.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:Emission.unit
range: UnitSymbol
required: false
multivalued: false
value:
slot_uri: cim:Emission.value
range: float
required: false
multivalued: false
CostPerHeatUnit:
class_uri: cim:CostPerHeatUnit
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: "Cost, in units of currency, per quantity of heat generated.\r\n"
attributes:
multiplier:
slot_uri: cim:CostPerHeatUnit.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:CostPerHeatUnit.unit
range: Currency
required: false
multivalued: false
value:
slot_uri: cim:CostPerHeatUnit.value
range: float
required: false
multivalued: false
ActivePowerPerFrequency:
class_uri: cim:ActivePowerPerFrequency
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: Active power variation with frequency.
attributes:
multiplier:
slot_uri: cim:ActivePowerPerFrequency.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:ActivePowerPerFrequency.unit
range: UnitSymbol
required: false
multivalued: false
value:
slot_uri: cim:ActivePowerPerFrequency.value
range: float
required: false
multivalued: false
MonthDayInterval:
class_uri: cim:MonthDayInterval
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: Interval between two times specified as month and day.
attributes:
end:
slot_uri: cim:MonthDayInterval.end
range: date
required: false
multivalued: false
description: End time of this interval.
start:
slot_uri: cim:MonthDayInterval.start
range: date
required: false
multivalued: false
description: Start time of this interval.
InductancePerLength:
class_uri: cim:InductancePerLength
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: Inductance per unit of length.
attributes:
multiplier:
slot_uri: cim:InductancePerLength.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:InductancePerLength.unit
range: UnitSymbol
required: false
multivalued: false
value:
slot_uri: cim:InductancePerLength.value
range: float
required: false
multivalued: false
CapacitancePerLength:
class_uri: cim:CapacitancePerLength
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: Capacitance per unit of length.
attributes:
multiplier:
slot_uri: cim:CapacitancePerLength.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:CapacitancePerLength.unit
range: UnitSymbol
required: false
multivalued: false
value:
slot_uri: cim:CapacitancePerLength.value
range: float
required: false
multivalued: false
DecimalQuantity:
class_uri: cim:DecimalQuantity
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: Quantity with decimal value and associated unit or currency information.
attributes:
currency:
slot_uri: cim:DecimalQuantity.currency
range: Currency
required: false
multivalued: false
description: Currency of this quantity.
multiplier:
slot_uri: cim:DecimalQuantity.multiplier
range: UnitMultiplier
required: false
multivalued: false
description: Unit multiplier of this quantity.
unit:
slot_uri: cim:DecimalQuantity.unit
range: UnitSymbol
required: false
multivalued: false
description: Unit of this quantity.
value:
slot_uri: cim:DecimalQuantity.value
range: double
required: false
multivalued: false
description: Value of this quantity.
Area:
class_uri: cim:Area
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: Area.
attributes:
multiplier:
slot_uri: cim:Area.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:Area.unit
range: UnitSymbol
required: false
multivalued: false
value:
slot_uri: cim:Area.value
range: float
required: false
multivalued: false
ActivePowerPerCurrentFlow:
class_uri: cim:ActivePowerPerCurrentFlow
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: Active power variation with current flow.
attributes:
multiplier:
slot_uri: cim:ActivePowerPerCurrentFlow.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:ActivePowerPerCurrentFlow.unit
range: UnitSymbol
required: false
multivalued: false
value:
slot_uri: cim:ActivePowerPerCurrentFlow.value
range: float
required: false
multivalued: false
Mass:
class_uri: cim:Mass
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
description: Mass.
attributes:
multiplier:
slot_uri: cim:Mass.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:Mass.unit
range: UnitSymbol
required: false
multivalued: false
value:
slot_uri: cim:Mass.value
range: float
required: false
multivalued: false
PowerSystemResource:
class_uri: cim:PowerSystemResource
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Core
description: A power system resource (PSR) can be an item of equipment such as
a switch, an equipment container containing many individual items of equipment
such as a substation, or an organisational entity such as sub-control area.
Power system resources can have measurements associated.
attributes:
Controls:
slot_uri: cim:PowerSystemResource.Controls
range: Control
required: false
multivalued: true
description: The controller outputs used to actually govern a regulating device,
e.g. the magnetization of a synchronous machine or capacitor bank breaker
actuator.
Measurements:
slot_uri: cim:PowerSystemResource.Measurements
range: Measurement
required: false
multivalued: true
description: The measurements associated with this power system resource.
PSRType:
slot_uri: cim:PowerSystemResource.PSRType
range: PSRType
required: false
multivalued: false
description: Custom classification for this power system resource.
ConfigurationEvent:
slot_uri: cim:PowerSystemResource.ConfigurationEvent
range: ConfigurationEvent
required: false
multivalued: true
description: All configuration events created for this Power System resource.
ReportingGroup:
slot_uri: cim:PowerSystemResource.ReportingGroup
range: ReportingGroup
required: false
multivalued: true
description: Reporting groups to which this power system resource belongs.
OperatingShare:
slot_uri: cim:PowerSystemResource.OperatingShare
range: OperatingShare
required: false
multivalued: true
description: The operating shares of this power system resource.
AssetDatasheet:
slot_uri: cim:PowerSystemResource.AssetDatasheet
range: AssetInfo
required: false
multivalued: false
description: Datasheet information for this power system resource.
VerificationAction:
slot_uri: cim:PowerSystemResource.VerificationAction
range: VerificationAction
required: false
multivalued: true
description: The verification action that is performed on the power system
resource
Clearances:
slot_uri: cim:PowerSystemResource.Clearances
range: ClearanceDocument
required: false
multivalued: true
description: All clearances applicable to this power system resource.
GenericAction:
slot_uri: cim:PowerSystemResource.GenericAction
range: GenericAction
required: false
multivalued: true
description: The generic action that is performed on the power system resource
PSREvents:
slot_uri: cim:PowerSystemResource.PSREvents
range: PSREvent
required: false
multivalued: true
description: All events associated with this power system resource.
Assets:
slot_uri: cim:PowerSystemResource.Assets
range: Asset
required: false
multivalued: true
description: All assets represented by this power system resource. For example,
multiple conductor assets are electrically modelled as a single AC line
segment.
Location:
slot_uri: cim:PowerSystemResource.Location
range: Location
required: false
multivalued: false
description: Location of this power system resource.
OperationalTags:
slot_uri: cim:PowerSystemResource.OperationalTags
range: OperationalTag
required: false
multivalued: true
description: All operational tags placed on this power system resource.
IdentifiedObject:
class_uri: cim:IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Core
description: This is a root class to provide common identification for all classes
needing identification and naming attributes.
attributes:
aliasName:
slot_uri: cim:IdentifiedObject.aliasName
range: string
required: false
multivalued: false
description: "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.\r\nThe 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.\r\n\r\n"
description:
slot_uri: cim:IdentifiedObject.description
range: string
required: false
multivalued: false
description: 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.
mRID:
slot_uri: cim:IdentifiedObject.mRID
range: string
required: false
multivalued: false
description: "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.\r\nFor 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:
slot_uri: cim:IdentifiedObject.name
range: string
required: false
multivalued: false
description: "The name is any free human readable and possibly non unique\
\ text naming the object.\r\n"
DiagramObjects:
slot_uri: cim:IdentifiedObject.DiagramObjects
range: DiagramObject
required: false
multivalued: true
description: The diagram objects that are associated with the domain object.
InstanceSet:
slot_uri: cim:IdentifiedObject.InstanceSet
range: InstanceSet
required: true
multivalued: false
description: Dataset containing the data objects.
Names:
slot_uri: cim:IdentifiedObject.Names
range: Name
required: false
multivalued: true
description: All names of this identified object.
PropertiesCIMDataObject:
slot_uri: cim:IdentifiedObject.PropertiesCIMDataObject
range: ChangeSetMember
required: false
multivalued: false
description: The single CIM data object in the appropriate dataset context.
TargetingCIMDataObject:
slot_uri: cim:IdentifiedObject.TargetingCIMDataObject
range: ChangeSetMember
required: false
multivalued: true
description: Data objects registered.
Name:
class_uri: cim:Name
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Core
description: "The Name class provides the means to define any number of human\
\ readable names for an object. A name is not to be used for defining\
\ inter-object relationships. For inter-object relationships instead use the\
\ object identification 'mRID'.\r\n"
attributes:
name:
slot_uri: cim:Name.name
range: string
required: false
multivalued: false
description: "Any free text that name the object.\r\n"
NameType:
slot_uri: cim:Name.NameType
range: NameType
required: true
multivalued: false
description: Type of this name.
IdentifiedObject:
slot_uri: cim:Name.IdentifiedObject
range: IdentifiedObject
required: true
multivalued: false
description: Identified object that this name designates.
NameType:
class_uri: cim:NameType
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Core
description: "Type of name. Possible values for attribute 'name' are implementation\
\ dependent but standard profiles may specify types. An enterprise may have\
\ multiple IT systems each having its own local name for the same object, e.g.\
\ a planning system may have different names from an EMS. An object may also\
\ have different names within the same IT system, e.g. localName as defined\
\ in CIM version 14. The definition from CIM14 is:\r\nThe localName is a human\
\ readable name of the object. It is a free text name local to a node in a naming\
\ hierarchy similar to a file directory structure. A power system related naming\
\ hierarchy may be: Substation, VoltageLevel, Equipment etc. Children of the\
\ same parent in such a hierarchy have names that typically are unique among\
\ them.\r\n"
attributes:
description:
slot_uri: cim:NameType.description
range: string
required: false
multivalued: false
description: "Description of the name type.\r\n"
name:
slot_uri: cim:NameType.name
range: string
required: false
multivalued: false
description: "Name of the name type.\r\n"
NameTypeAuthority:
slot_uri: cim:NameType.NameTypeAuthority
range: NameTypeAuthority
required: false
multivalued: false
description: Authority responsible for managing names of this type.
Names:
slot_uri: cim:NameType.Names
range: Name
required: false
multivalued: true
description: All names of this type.
NameTypeAuthority:
class_uri: cim:NameTypeAuthority
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Core
description: "Authority responsible for creation and management of names of a\
\ given type; typically an organization or an enterprise system.\r\n"
attributes:
description:
slot_uri: cim:NameTypeAuthority.description
range: string
required: false
multivalued: false
description: "Description of the name type authority.\r\n"
name:
slot_uri: cim:NameTypeAuthority.name
range: string
required: false
multivalued: false
description: "Name of the name type authority.\r\n"
NameTypes:
slot_uri: cim:NameTypeAuthority.NameTypes
range: NameType
required: false
multivalued: true
description: All name types managed by this authority.
ChangeSetMember:
class_uri: cim:ChangeSetMember
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.Part303.GenericDataSet
description: A CRUD-style data object.
attributes:
Changeset:
slot_uri: cim:ChangeSetMember.Changeset
range: ChangeSet
required: false
multivalued: false
description: Dataset containing the data objects.
PropertiesObject:
slot_uri: cim:ChangeSetMember.PropertiesObject
range: IdentifiedObject
required: false
multivalued: false
description: The CIM object holding the properties of this dataset context. Sometimes
properties are not required and only the reference to the registered object
is required.
TargetObject:
slot_uri: cim:ChangeSetMember.TargetObject
range: IdentifiedObject
required: true
multivalued: false
description: The registered CIM object.
ChangeSet:
class_uri: cim:ChangeSet
is_a: DataSet
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.Part303.GenericDataSet
description: Describes a set of changes that can be applied in different situations. A
given registered target object MRID may only be referenced once by the contained
change set members.
attributes:
NetworkModelProjectChangeVersion:
slot_uri: cim:ChangeSet.NetworkModelProjectChangeVersion
range: NetworkModelProjectChangeVersion
required: false
multivalued: true
description: The project of the details of model changes.
IncrementalDatasetArg:
slot_uri: cim:ChangeSet.IncrementalDatasetArg
range: IncrementalDatasetArg
required: false
multivalued: true
ChangeSetMember:
slot_uri: cim:ChangeSet.ChangeSetMember
range: ChangeSetMember
required: false
multivalued: true
description: Data objects contained in the dataset.
NMProjectStage:
slot_uri: cim:ChangeSet.NMProjectStage
range: NetworkModelProjectStage
required: false
multivalued: false
DataSet:
class_uri: cim:DataSet
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.Part303.GenericDataSet
description: "A generic container of a version of instance data. The MRID can\
\ be used in an audit trail, not in reusable script intended to work with new\
\ versions of data.\r\nA dataset could be serialized multiple times and in multiple\
\ technologies, yet retain the same identity."
attributes:
description:
slot_uri: cim:DataSet.description
range: string
required: false
multivalued: false
description: 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.
mRID:
slot_uri: cim:DataSet.mRID
range: string
required: false
multivalued: false
description: "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.\r\nFor CIMXML data files in RDF syntax\
\ conforming to IEC 61970-552 Edition 1, the mRID is mapped to rdf:ID or\
\ rdf:about attributes that identify CIM object elements.\r\n"
name:
slot_uri: cim:DataSet.name
range: string
required: false
multivalued: false
description: "The name is any free human readable and possibly non unique\
\ text naming the object.\r\n"
Profile:
slot_uri: cim:DataSet.Profile
range: Profile
required: true
multivalued: true
description: The profiles that describe the contents of the data set and the
rules governing the contents of the data set.
AlternateModel:
slot_uri: cim:DataSet.AlternateModel
range: AlternateModel
required: false
multivalued: false
description: The alternate model using the data.
ModelPartVersion:
slot_uri: cim:DataSet.ModelPartVersion
range: ModelPartVersion
required: true
multivalued: false
AlternateModel:
class_uri: cim:AlternateModel
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfPart303.AlternateModels
attributes:
AlternateModelGroup:
slot_uri: cim:AlternateModel.AlternateModelGroup
range: AlternateModelGroup
required: true
multivalued: false
description: The group of alternate models for which one alternate is used.
Dataset:
slot_uri: cim:AlternateModel.Dataset
range: DataSet
required: true
multivalued: false
description: The data belonging to the alternate model.
AlternateModelGroup:
class_uri: cim:AlternateModelGroup
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfPart303.AlternateModels
attributes:
AlternateModel:
slot_uri: cim:AlternateModelGroup.AlternateModel
range: AlternateModel
required: false
multivalued: true
description: An alternate model that can be one possiblity among alternates.
ModelPartVersion:
class_uri: cim:ModelPartVersion
is_a: ModelToBeDeleted
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfPart303.NetworkModelFrames
description: This is a version of a part of a model. New instances of this class
with new identity are instantiated upon changes to the content of this class
or changes to the associated data set. Instances of this class are considered
immutable. The case audit trail can reference this immutable data to exactly
reproduce a case.
attributes:
ModelSpecification:
slot_uri: cim:ModelPartVersion.ModelSpecification
range: ModelPartSpecification
required: true
multivalued: false
description: Model specification of the modelt.
DataSet:
slot_uri: cim:ModelPartVersion.DataSet
range: DataSet
required: false
multivalued: true
CompleteModelToBeDeleted:
slot_uri: cim:ModelPartVersion.CompleteModelToBeDeleted
range: CompleteModelToBeDeleted
required: false
multivalued: true
AssemblyManifest:
slot_uri: cim:ModelPartVersion.AssemblyManifest
range: AssemblyManifest
required: false
multivalued: true
ModelToBeDeleted:
class_uri: cim:ModelToBeDeleted
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfPart303.NetworkModelFrames
description: A Model is a collection of Datasets.
AssemblyManifest:
class_uri: cim:AssemblyManifest
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfPart303.NetworkModelFrames
description: A collection of model parts when combined form a case or part of
a case.
attributes:
ModelPartVersion:
slot_uri: cim:AssemblyManifest.ModelPartVersion
range: ModelPartVersion
required: false
multivalued: true
CompleteModelToBeDeleted:
slot_uri: cim:AssemblyManifest.CompleteModelToBeDeleted
range: CompleteModelToBeDeleted
required: false
multivalued: false
CompleteModelToBeDeleted:
class_uri: cim:CompleteModelToBeDeleted
is_a: ModelToBeDeleted
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfPart303.NetworkModelFrames
description: A complete model can be used in applications to perform meaningful
calculations, e.g. a study case in offline tools or a real time model in a SCADA/EMS.
attributes:
ModelPartVersion:
slot_uri: cim:CompleteModelToBeDeleted.ModelPartVersion
range: ModelPartVersion
required: false
multivalued: true
AssemblyManifest:
slot_uri: cim:CompleteModelToBeDeleted.AssemblyManifest
range: AssemblyManifest
required: false
multivalued: true
ModelPartSpecification:
class_uri: cim:ModelPartSpecification
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfPart303.NetworkModelFrames
description: 'The type of model. For example, state estimator, planning, planning
dynamics, short circuit, or real-time dynamics etc. The model must conform
to a profile. '
attributes:
FrameworkPart:
slot_uri: cim:ModelPartSpecification.FrameworkPart
range: ModelAuthoritySet
required: false
multivalued: false
description: Model frame of the model part.
Model:
slot_uri: cim:ModelPartSpecification.Model
range: ModelPartVersion
required: false
multivalued: true
description: Modle parts conforming to the model part specification.
AssemblyDescription:
slot_uri: cim:ModelPartSpecification.AssemblyDescription
range: AssemblyDescription
required: false
multivalued: true
description: The assembly description into which model parts should be included.
AssemblyDescription:
class_uri: cim:AssemblyDescription
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfPart303.NetworkModelFrames
description: A description for how to assemble model parts for a specific purpose.
attributes:
ModelSpecification:
slot_uri: cim:AssemblyDescription.ModelSpecification
range: ModelPartSpecification
required: false
multivalued: true
description: The models that are part of the assembly descrption.
ModelAuthoritySet:
class_uri: cim:ModelAuthoritySet
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfPart303.NetworkModelFrames
description: "A Modeling Authority Set is a group of objects in a network model\
\ where the data is supplied and maintained by the same Modeling Authority.\r\
\nThis class is typically not included in instance data exchange as this information\
\ is tracked by other mechanisms in the exchange.\r\n"
attributes:
ModelingAuthority:
slot_uri: cim:ModelAuthoritySet.ModelingAuthority
range: ModelAuthority
required: true
multivalued: false
description: Modeling Authority suppliying and maintaining the data for the
objects in this Modeling Authority Set.
ModelSpecification:
slot_uri: cim:ModelAuthoritySet.ModelSpecification
range: ModelPartSpecification
required: false
multivalued: true
description: Models of the model frame.
ModelAuthority:
class_uri: cim:ModelAuthority
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfPart303.NetworkModelFrames
description: A Modeling Authority is an entity responsible for supplying and maintaining
the data defining a specific set of objects in a network model.
attributes:
ModelingAuthoritySets:
slot_uri: cim:ModelAuthority.ModelingAuthoritySets
range: ModelAuthoritySet
required: true
multivalued: true
description: Modeling Authority Sets supplied and maintained by this Modeling
Authority.
Profile:
class_uri: cim:Profile
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.ExternalInputs
description: "A profile is a simpler curve type.\r\n"
attributes:
ProfileDatas:
slot_uri: cim:Profile.ProfileDatas
range: ProfileData
required: false
multivalued: true
description: A profile has profile data associated with it.
NetworkModelProjectChangeVersion:
class_uri: cim:NetworkModelProjectChangeVersion
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfPart303.NetworkModelProjects
description: Describes the status and the planned implementation of the associated
change set into the as-built model. New instances of this class with new
identity are instantiated upon changes to the content of this class or changes
to the associated change set. Instances of this class are considered immutable. The
case audit trail can reference this immutable data to exactly reproduce a case.
attributes:
comment:
slot_uri: cim:NetworkModelProjectChangeVersion.comment
range: string
required: false
multivalued: false
description: A user provided comment describing the changes in this version
from the previous version.
effectiveDateTime:
slot_uri: cim:NetworkModelProjectChangeVersion.effectiveDateTime
range: date
required: false
multivalued: false
description: The date/time the change set is included in the model.
timeStamp:
slot_uri: cim:NetworkModelProjectChangeVersion.timeStamp
range: date
required: false
multivalued: false
description: The date/time this version was finalized and thus made immutable.
ChangeSet:
slot_uri: cim:NetworkModelProjectChangeVersion.ChangeSet
range: ChangeSet
required: false
multivalued: false
description: The details of model changes for this project. The change set
should have a new identifier if it changes.
NetworkModelProjectChange:
slot_uri: cim:NetworkModelProjectChangeVersion.NetworkModelProjectChange
range: NetworkModelProjectChange
required: true
multivalued: false
description: The persistent network model project change to which this version
applies.
SupercededBy:
slot_uri: cim:NetworkModelProjectChangeVersion.SupercededBy
range: NetworkModelProjectChangeVersion
required: false
multivalued: false
description: The project version that will supercede this project version.
NetworkModelProjectState:
slot_uri: cim:NetworkModelProjectChangeVersion.NetworkModelProjectState
range: NetworkModelProjectState
required: false
multivalued: false
description: The state of this network model project version.
Supercedes:
slot_uri: cim:NetworkModelProjectChangeVersion.Supercedes
range: NetworkModelProjectChangeVersion
required: false
multivalued: false
description: Project version that is being superceded.
NetworkModelProjectChange:
class_uri: cim:NetworkModelProjectChange
is_a: NetworkModelProjectComponent
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfPart303.NetworkModelProjects
description: 'Network model project change described by versions of an associated
change set. Has persistent identity over multiple versions of the associated
change set. '
attributes:
NetworkModelProjectChangeVersion:
slot_uri: cim:NetworkModelProjectChange.NetworkModelProjectChangeVersion
range: NetworkModelProjectChangeVersion
required: true
multivalued: true
description: A specific version of the network model project change.
NetworkModelProjectComponent:
class_uri: cim:NetworkModelProjectComponent
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfPart303.NetworkModelProjects
description: Abstract class for both a network model project and network model
change.
attributes:
NetworkModelProjectDocument:
slot_uri: cim:NetworkModelProjectComponent.NetworkModelProjectDocument
range: NetworkModelProjectDocument
required: false
multivalued: true
ContainingProject:
slot_uri: cim:NetworkModelProjectComponent.ContainingProject
range: NetworkModelProject
required: true
multivalued: false
description: The parent project of this project.
ProjectARelationships:
slot_uri: cim:NetworkModelProjectComponent.ProjectARelationships
range: NetworkModelProjectRelationship
required: false
multivalued: true
ProjectBRelationships:
slot_uri: cim:NetworkModelProjectComponent.ProjectBRelationships
range: NetworkModelProjectRelationship
required: false
multivalued: true
NetworkModelProjectRelationship:
class_uri: cim:NetworkModelProjectRelationship
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfPart303.NetworkModelProjects
description: A relationship that assists humans and software building cases by
assembling project changes in the correct sequence. This class may be specialized
to create specific types of relationships.
attributes:
ProjectA:
slot_uri: cim:NetworkModelProjectRelationship.ProjectA
range: NetworkModelProjectComponent
required: true
multivalued: false
ProjectB:
slot_uri: cim:NetworkModelProjectRelationship.ProjectB
range: NetworkModelProjectComponent
required: true
multivalued: false
NetworkModelProjectDocument:
class_uri: cim:NetworkModelProjectDocument
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfPart303.NetworkModelProjects
attributes:
NetworkModelProjectComponent:
slot_uri: cim:NetworkModelProjectDocument.NetworkModelProjectComponent
range: NetworkModelProjectComponent
required: false
multivalued: true
NetworkModelProject:
class_uri: cim:NetworkModelProject
is_a: NetworkModelProjectComponent
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfPart303.NetworkModelProjects
description: "A grouping of network model change descriptions. Primarily used\
\ to organize the phases of an overall project.\r\n\r\n\r\n "
attributes:
ContainedProject:
slot_uri: cim:NetworkModelProject.ContainedProject
range: NetworkModelProjectComponent
required: false
multivalued: true
description: Projects that are included in this parent project.
NetworkModelProjectState:
class_uri: cim:NetworkModelProjectState
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfPart303.NetworkModelProjects
description: A network model project version state. States are agreed upon by
the exchange community. Examples are "approved", "proposed", "withdrawn", "committed"
etc.
attributes:
NetworkModelProjectChangeVersion:
slot_uri: cim:NetworkModelProjectState.NetworkModelProjectChangeVersion
range: NetworkModelProjectChangeVersion
required: false
multivalued: true
description: The change versions that are at this state.
IncrementalDatasetArg:
class_uri: cim:IncrementalDatasetArg
is_a: ModelOperationArg
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfPart303.ModelOperations
description: A generic model operation argument referencing an incremental change
description.
attributes:
IncrementalDatasetArgDescription:
slot_uri: cim:IncrementalDatasetArg.IncrementalDatasetArgDescription
range: IncrementalDatasetArgDescription
required: true
multivalued: false
IncrementalDataset:
slot_uri: cim:IncrementalDatasetArg.IncrementalDataset
range: ChangeSet
required: true
multivalued: false
ModelOperationArg:
class_uri: cim:ModelOperationArg
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfPart303.ModelOperations
description: Describes the role a dataset plays in a model operation. The role
is applicable only in the context of a single operation.
attributes:
sequenceNumber:
slot_uri: cim:ModelOperationArg.sequenceNumber
range: integer
required: false
multivalued: false
description: "The sequence number of the argument in an operation. Argument\
\ entries are considered in numerical order where the operation requires\
\ an ordering. \r\n "
ModelOperation:
slot_uri: cim:ModelOperationArg.ModelOperation
range: ModelOperation
required: true
multivalued: false
description: The opeation for the operation argument.
ModelOperation:
class_uri: cim:ModelOperation
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfPart303.ModelOperations
description: 'An operation performed on models. '
attributes:
sequenceNumber:
slot_uri: cim:ModelOperation.sequenceNumber
range: integer
required: false
multivalued: false
description: Sequence number within a operation sequence, lower is first. Normally
starts with 1.
ModelOperationDescription:
slot_uri: cim:ModelOperation.ModelOperationDescription
range: ModelOperationDescription
required: true
multivalued: false
description: The type of the model operation.
ModelOperationArg:
slot_uri: cim:ModelOperation.ModelOperationArg
range: ModelOperationArg
required: false
multivalued: true
description: Arguments of the operation.
OperationSequence:
slot_uri: cim:ModelOperation.OperationSequence
range: ModelOperationSequence
required: true
multivalued: false
ModelOperationSequence:
class_uri: cim:ModelOperationSequence
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfPart303.ModelOperations
description: A concrete sequence of operations. For example, this may be used
to describe a specific audit trail, a script or other specific set of actions
on specific datasets.
attributes:
ModelOperation:
slot_uri: cim:ModelOperationSequence.ModelOperation
range: ModelOperation
required: false
multivalued: true
ModelOperationDescription:
class_uri: cim:ModelOperationDescription
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfPart303.ModelOperations
description: The type of model operation. This class is referenced by model
operations and defines the kind of operation.
attributes:
OperationDatasetArgDescription:
slot_uri: cim:ModelOperationDescription.OperationDatasetArgDescription
range: ModelOperationArgDescription
required: false
multivalued: true
description: The type of dataset roles that can be used for a type of general
model operation.
ModelOperation:
slot_uri: cim:ModelOperationDescription.ModelOperation
range: ModelOperation
required: false
multivalued: true
description: The instances of operations that conform to this operation type.
ModelOperationArgDescription:
class_uri: cim:ModelOperationArgDescription
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfPart303.ModelOperations
description: The type of custom operation dataset role for an operation description.
attributes:
multiplicityMaximum:
slot_uri: cim:ModelOperationArgDescription.multiplicityMaximum
range: integer
required: false
multivalued: false
description: "\r\nThe maximum multiplicity of the instance arguments that\
\ should be supplied for a single operation. Use -1 to indicate unlimited. "
multiplicityMinimum:
slot_uri: cim:ModelOperationArgDescription.multiplicityMinimum
range: integer
required: false
multivalued: false
description: "\r\nThe minimum multiplicity of the instance arguments that\
\ should be supplied for a single operation. Use zero to indicate optional. "
ModelOperationDefinition:
slot_uri: cim:ModelOperationArgDescription.ModelOperationDefinition
range: ModelOperationDescription
required: true
multivalued: false
description: The type of operation for this type of dataset role. Operations
referencing the dataset role type should only belong to operations that
reference the operation type.
IncrementalDatasetArgDescription:
class_uri: cim:IncrementalDatasetArgDescription
is_a: ModelOperationArgDescription
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfPart303.ModelOperations
attributes:
IncrementalDatasetArg:
slot_uri: cim:IncrementalDatasetArgDescription.IncrementalDatasetArg
range: IncrementalDatasetArg
required: false
multivalued: true
description: The incremental dataset used for this argument instance.
NetworkModelProjectStage:
class_uri: cim:NetworkModelProjectStage
is_a: NetworkModelProjectComponent2
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfPart303.NetworkModelProjects
attributes:
changesetVersion:
slot_uri: cim:NetworkModelProjectStage.changesetVersion
range: integer
required: false
multivalued: false
commissionedDate:
slot_uri: cim:NetworkModelProjectStage.commissionedDate
range: date
required: false
multivalued: false
plannedCommissionedDate:
slot_uri: cim:NetworkModelProjectStage.plannedCommissionedDate
range: date
required: false
multivalued: false
ChangeSets:
slot_uri: cim:NetworkModelProjectStage.ChangeSets
range: ChangeSet
required: true
multivalued: true
DependencyDependentOnStage:
slot_uri: cim:NetworkModelProjectStage.DependencyDependentOnStage
range: AnnotatedProjectDependency
required: false
multivalued: false
DenpendecyDependingStage:
slot_uri: cim:NetworkModelProjectStage.DenpendecyDependingStage
range: AnnotatedProjectDependency
required: false
multivalued: true
NetworkModelProjectComponent2:
class_uri: cim:NetworkModelProjectComponent2
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfPart303.NetworkModelProjects
attributes:
closed:
slot_uri: cim:NetworkModelProjectComponent2.closed
range: date
required: false
multivalued: false
created:
slot_uri: cim:NetworkModelProjectComponent2.created
range: date
required: false
multivalued: false
updated:
slot_uri: cim:NetworkModelProjectComponent2.updated
range: date
required: false
multivalued: false
version:
slot_uri: cim:NetworkModelProjectComponent2.version
range: integer
required: false
multivalued: false
CurrentState:
slot_uri: cim:NetworkModelProjectComponent2.CurrentState
range: CurrentState
required: true
multivalued: false
Parent:
slot_uri: cim:NetworkModelProjectComponent2.Parent
range: NetworkModelProject2
required: false
multivalued: false
CurrentState:
class_uri: cim:CurrentState
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfPart303.NetworkModelProjects
attributes:
NetworkModelProjectComponent2:
slot_uri: cim:CurrentState.NetworkModelProjectComponent2
range: NetworkModelProjectComponent2
required: false
multivalued: true
NetworkModelProject2:
class_uri: cim:NetworkModelProject2
is_a: NetworkModelProjectComponent2
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfPart303.NetworkModelProjects
attributes:
Child:
slot_uri: cim:NetworkModelProject2.Child
range: NetworkModelProjectComponent2
required: false
multivalued: true
AnnotatedProjectDependency:
class_uri: cim:AnnotatedProjectDependency
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfPart303.NetworkModelProjects
attributes:
dependencyType:
slot_uri: cim:AnnotatedProjectDependency.dependencyType
range: DependencyKind
required: false
multivalued: false
DependentOnStage:
slot_uri: cim:AnnotatedProjectDependency.DependentOnStage
range: NetworkModelProjectStage
required: true
multivalued: false
DependingStage:
slot_uri: cim:AnnotatedProjectDependency.DependingStage
range: NetworkModelProjectStage
required: true
multivalued: false
DiagramObject:
class_uri: cim:DiagramObject
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.DiagramLayout
description: An object that defines one or more points in a given space. This
object can be associated with anything that specializes IdentifiedObject. For
single line diagrams such objects typically include such items as analog values,
breakers, disconnectors, power transformers, and transmission lines.
attributes:
drawingOrder:
slot_uri: cim:DiagramObject.drawingOrder
range: integer
required: false
multivalued: false
description: The drawing order of this element. The higher the number, the
later the element is drawn in sequence. This is used to ensure that elements
that overlap are rendered in the correct order.
isPolygon:
slot_uri: cim:DiagramObject.isPolygon
range: boolean
required: false
multivalued: false
description: Defines whether or not the diagram objects points define the
boundaries of a polygon or the routing of a polyline. If this value is true
then a receiving application should consider the first and last points to
be connected.
offsetX:
slot_uri: cim:DiagramObject.offsetX
range: float
required: false
multivalued: false
description: "The offset in the X direction. This is used for defining the\
\ offset from centre for rendering an icon (the default is that a single\
\ point specifies the centre of the icon).\r\n\r\nThe offset is in per-unit\
\ with 0 indicating there is no offset from the horizontal centre of the\
\ icon. -0.5 indicates it is offset by 50% to the left and 0.5 indicates\
\ an offset of 50% to the right.\r\n"
offsetY:
slot_uri: cim:DiagramObject.offsetY
range: float
required: false
multivalued: false
description: "The offset in the Y direction. This is used for defining the\
\ offset from centre for rendering an icon (the default is that a single\
\ point specifies the centre of the icon).\r\n\r\nThe offset is in per-unit\
\ with 0 indicating there is no offset from the vertical centre of the icon.\
\ The offset direction is dependent on the orientation of the diagram,\
\ with -0.5 and 0.5 indicating an offset of +/- 50% on the vertical axis.\r\
\n"
rotation:
slot_uri: cim:DiagramObject.rotation
range: AngleDegrees
required: false
multivalued: false
description: "Sets the angle of rotation of the diagram object. Zero degrees\
\ is pointing to the top of the diagram. Rotation is clockwise. DiagramObject.rotation=0\
\ has the following meaning: The connection point of an element which has\
\ one terminal is pointing to the top side of the diagram. The connection\
\ point \"From side\" of an element which has more than one terminal is\
\ pointing to the top side of the diagram.\r\nDiagramObject.rotation=90\
\ has the following meaning: The connection point of an element which has\
\ one terminal is pointing to the right hand side of the diagram. The connection\
\ point \"From side\" of an element which has more than one terminal is\
\ pointing to the right hand side of the diagram."
Diagram:
slot_uri: cim:DiagramObject.Diagram
range: Diagram
required: false
multivalued: false
description: A diagram object is part of a diagram.
VisibilityLayers:
slot_uri: cim:DiagramObject.VisibilityLayers
range: VisibilityLayer
required: false
multivalued: true
description: A diagram object can be part of multiple visibility layers.
DiagramObjectPoints:
slot_uri: cim:DiagramObject.DiagramObjectPoints
range: DiagramObjectPoint
required: false
multivalued: true
description: A diagram object can have 0 or more points to reflect its layout
position, routing (for polylines) or boundary (for polygons).
DiagramObjectStyle:
slot_uri: cim:DiagramObject.DiagramObjectStyle
range: DiagramObjectStyle
required: false
multivalued: false
description: A diagram object has a style associated that provides a reference
for the style used in the originating system.
IdentifiedObject:
slot_uri: cim:DiagramObject.IdentifiedObject
range: IdentifiedObject
required: false
multivalued: false
description: The domain object to which this diagram object is associated.
Diagram:
class_uri: cim:Diagram
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.DiagramLayout
description: The diagram being exchanged. The coordinate system is a standard
Cartesian coordinate system and the orientation attribute defines the orientation.
The initial view related attributes can be used to specify an initial view with
the x,y coordinates of the diagonal points.
attributes:
orientation:
slot_uri: cim:Diagram.orientation
range: OrientationKind
required: false
multivalued: false
description: "Coordinate system orientation of the diagram. A positive orientation\
\ gives standard \u201Cright-hand\u201D orientation, with negative orientation\
\ indicating a \u201Cleft-hand\u201D orientation. For 2D diagrams, a positive\
\ orientation will result in X values increasing from left to right and\
\ Y values increasing from bottom to top. A negative orientation gives the\
\ \u201Cleft-hand\u201D orientation (favoured by computer graphics displays)\
\ with X values increasing from left to right and Y values increasing from\
\ top to bottom.\r\n"
x1InitialView:
slot_uri: cim:Diagram.x1InitialView
range: float
required: false
multivalued: false
description: "X coordinate of the first corner of the initial view.\r\n"
x2InitialView:
slot_uri: cim:Diagram.x2InitialView
range: float
required: false
multivalued: false
description: "X coordinate of the second corner of the initial view.\r\n"
y1InitialView:
slot_uri: cim:Diagram.y1InitialView
range: float
required: false
multivalued: false
description: "Y coordinate of the first corner of the initial view.\r\n"
y2InitialView:
slot_uri: cim:Diagram.y2InitialView
range: float
required: false
multivalued: false
description: "Y coordinate of the second corner of the initial view.\r\n"
DiagramElements:
slot_uri: cim:Diagram.DiagramElements
range: DiagramObject
required: false
multivalued: true
description: A diagram is made up of multiple diagram objects.
DiagramStyle:
slot_uri: cim:Diagram.DiagramStyle
range: DiagramStyle
required: false
multivalued: false
description: A Diagram may have a DiagramStyle.
DiagramStyle:
class_uri: cim:DiagramStyle
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.DiagramLayout
description: The diagram style refers to a style used by the originating system
for a diagram. A diagram style describes information such as schematic, geographic,
etc.
attributes:
Diagram:
slot_uri: cim:DiagramStyle.Diagram
range: Diagram
required: false
multivalued: true
description: A DiagramStyle can be used by many Diagrams.
VisibilityLayer:
class_uri: cim:VisibilityLayer
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.DiagramLayout
description: "Layers are typically used for grouping diagram objects according\
\ to themes and scales. Themes are used to display or hide certain information\
\ (e.g., lakes, borders), while scales are used for hiding or displaying information\
\ depending on the current zoom level (hide text when it is too small to be\
\ read, or when it exceeds the screen size). This is also called de-cluttering.\r\
\nCIM based graphics exchange supports an m:n relationship between diagram objects\
\ and layers. The importing system shall convert an m:n case into an appropriate\
\ 1:n representation if the importing system does not support m:n."
attributes:
drawingOrder:
slot_uri: cim:VisibilityLayer.drawingOrder
range: integer
required: false
multivalued: false
description: "The drawing order for this layer. The higher the number, the\
\ later the layer and the objects within it are rendered.\r\n"
VisibleObjects:
slot_uri: cim:VisibilityLayer.VisibleObjects
range: DiagramObject
required: false
multivalued: true
description: A visibility layer can contain one or more diagram objects.
DiagramObjectPoint:
class_uri: cim:DiagramObjectPoint
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.DiagramLayout
description: "A point in a given space defined by 3 coordinates and associated\
\ to a diagram object. The coordinates may be positive or negative as the origin\
\ does not have to be in the corner of a diagram. \r\n"
attributes:
sequenceNumber:
slot_uri: cim:DiagramObjectPoint.sequenceNumber
range: integer
required: false
multivalued: false
description: "The sequence position of the point, used for defining the order\
\ of points for diagram objects acting as a polyline or polygon with more\
\ than one point. The attribute shall be a positive value.\r\n"
xPosition:
slot_uri: cim:DiagramObjectPoint.xPosition
range: float
required: false
multivalued: false
description: "The X coordinate of this point.\r\n"
yPosition:
slot_uri: cim:DiagramObjectPoint.yPosition
range: float
required: false
multivalued: false
description: "The Y coordinate of this point.\r\n"
zPosition:
slot_uri: cim:DiagramObjectPoint.zPosition
range: float
required: false
multivalued: false
description: "The Z coordinate of this point.\r\n"
DiagramObjectGluePoint:
slot_uri: cim:DiagramObjectPoint.DiagramObjectGluePoint
range: DiagramObjectGluePoint
required: false
multivalued: false
description: The 'glue' point to which this point is associated.
DiagramObject:
slot_uri: cim:DiagramObjectPoint.DiagramObject
range: DiagramObject
required: true
multivalued: false
description: The diagram object with which the points are associated.
DiagramObjectGluePoint:
class_uri: cim:DiagramObjectGluePoint
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.DiagramLayout
description: "This is used for grouping diagram object points from different diagram\
\ objects that are considered to be glued together in a diagram even if they\
\ are not at the exact same coordinates.\r\n"
attributes:
DiagramObjectPoints:
slot_uri: cim:DiagramObjectGluePoint.DiagramObjectPoints
range: DiagramObjectPoint
required: true
multivalued: true
description: A diagram object glue point is associated with 2 or more object
points that are considered to be 'glued' together.
DiagramObjectStyle:
class_uri: cim:DiagramObjectStyle
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.DiagramLayout
description: A reference to a style used by the originating system for a diagram
object. A diagram object style describes information such as line thickness,
shape such as circle or rectangle etc, and colour.
attributes:
StyledObjects:
slot_uri: cim:DiagramObjectStyle.StyledObjects
range: DiagramObject
required: false
multivalued: true
description: A style can be assigned to multiple diagram objects.
InstanceSet:
class_uri: cim:InstanceSet
is_a: DataSet
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.Part303.GenericDataSet
description: 'Instance of a version of a model part. This corresponds to a payload
of instance data. '
attributes:
DatasetArg:
slot_uri: cim:InstanceSet.DatasetArg
range: DatasetArg
required: false
multivalued: true
description: The role of a dataset in the context of an operation.
InstanceSetMember:
slot_uri: cim:InstanceSet.InstanceSetMember
range: IdentifiedObject
required: false
multivalued: true
description: Data objects contained in the dataset.
DatasetArg:
class_uri: cim:DatasetArg
is_a: ModelOperationArg
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfPart303.ModelOperations
description: A model operation argument referencing a dataset instance.
attributes:
OperationDatasetArgDescription:
slot_uri: cim:DatasetArg.OperationDatasetArgDescription
range: DatasetArgDescription
required: true
multivalued: false
description: The type of role for this dataset role. Should only reference
role types that belong to the operation type of the associated operation.
Dataset:
slot_uri: cim:DatasetArg.Dataset
range: InstanceSet
required: true
multivalued: false
description: Dataset referenced by this argument of a model operation..
DatasetArgDescription:
class_uri: cim:DatasetArgDescription
is_a: ModelOperationArgDescription
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfPart303.ModelOperations
attributes:
OperationDatasetArg:
slot_uri: cim:DatasetArgDescription.OperationDatasetArg
range: DatasetArg
required: false
multivalued: true
description: The operation dataset roles conforming to this role type.
ReportingGroup:
class_uri: cim:ReportingGroup
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Core
description: "A reporting group is used for various ad-hoc groupings used for\
\ reporting.\r\n"
attributes:
ReportingSuperGroup:
slot_uri: cim:ReportingGroup.ReportingSuperGroup
range: ReportingSuperGroup
required: false
multivalued: false
description: Reporting super group to which this reporting group belongs.
PowerSystemResource:
slot_uri: cim:ReportingGroup.PowerSystemResource
range: PowerSystemResource
required: false
multivalued: true
description: Power system resources which belong to this reporting group.
BusNameMarker:
slot_uri: cim:ReportingGroup.BusNameMarker
range: BusNameMarker
required: false
multivalued: true
description: The bus name markers that belong to this reporting group.
TopologicalNode:
slot_uri: cim:ReportingGroup.TopologicalNode
range: TopologicalNode
required: false
multivalued: true
description: The topological nodes that belong to the reporting group.
BusNameMarker:
class_uri: cim:BusNameMarker
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Topology
description: 'Used to apply user standard names to TopologicalNodes. Associated
with one or more terminals that are normally connected with the bus name. The
associated terminals are normally connected by non-retained switches. For a
ring bus station configuration, all BusbarSection terminals in the ring are
typically associated. For a breaker and a half scheme, both BusbarSections
would normally be associated. For a ring bus, all BusbarSections would normally
be associated. For a "straight" busbar configuration, normally only the main
terminal at the BusbarSection would be associated. '
attributes:
priority:
slot_uri: cim:BusNameMarker.priority
range: integer
required: false
multivalued: false
description: Priority of bus name marker for use as topology bus name. Use
0 for do not care. Use 1 for highest priority. Use 2 as priority is less
than 1 and so on.
ReportingGroup:
slot_uri: cim:BusNameMarker.ReportingGroup
range: ReportingGroup
required: false
multivalued: false
description: The reporting group to which this bus name marker belongs.
Terminal:
slot_uri: cim:BusNameMarker.Terminal
range: ACDCTerminal
required: true
multivalued: true
description: The terminals associated with this bus name marker.
TopologicalNode:
slot_uri: cim:BusNameMarker.TopologicalNode
range: TopologicalNode
required: false
multivalued: false
description: A user defined topological node that was originally defined in
a planning model not yet having topology described by ConnectivityNodes.
Once ConnectivityNodes has been created they may linked to user defined
ToplogicalNdes using BusNameMarkers.
ACDCTerminal:
class_uri: cim:ACDCTerminal
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Core
description: An electrical connection point (AC or DC) to a piece of conducting
equipment. Terminals are connected at physical connection points called connectivity
nodes.
attributes:
connected:
slot_uri: cim:ACDCTerminal.connected
range: boolean
required: false
multivalued: false
description: "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. \r\nIn 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.\r\n"
sequenceNumber:
slot_uri: cim:ACDCTerminal.sequenceNumber
range: integer
required: false
multivalued: false
description: "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.\r\n"
BusNameMarker:
slot_uri: cim:ACDCTerminal.BusNameMarker
range: BusNameMarker
required: false
multivalued: false
description: The bus name marker used to name the bus (topological node).
OperationalLimitSet:
slot_uri: cim:ACDCTerminal.OperationalLimitSet
range: OperationalLimitSet
required: false
multivalued: true
description: The operational limit sets at the terminal.
Measurements:
slot_uri: cim:ACDCTerminal.Measurements
range: Measurement
required: false
multivalued: true
description: Measurements associated with this terminal defining where the
measurement is placed in the network topology. It may be used, for instance,
to capture the sensor position, such as a voltage transformer (PT) at a
busbar or a current transformer (CT) at the bar between a breaker and an
isolator.
OperationalLimitSet:
class_uri: cim:OperationalLimitSet
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.OperationalLimits
description: "A set of limits associated with equipment. Sets of limits might\
\ apply to a specific temperature, or season for example. A set of limits may\
\ contain different severities of limit levels that would apply to the same\
\ equipment. The set may contain limits of different types such as apparent\
\ power and current limits or high and low voltage limits that are logically\
\ applied together as a set.\r\n"
attributes:
Equipment:
slot_uri: cim:OperationalLimitSet.Equipment
range: Equipment
required: false
multivalued: false
description: The equipment to which the limit set applies.
Terminal:
slot_uri: cim:OperationalLimitSet.Terminal
range: ACDCTerminal
required: false
multivalued: false
description: The terminal where the operational limit set apply.
OperationalLimitValue:
slot_uri: cim:OperationalLimitSet.OperationalLimitValue
range: OperationalLimit
required: false
multivalued: true
description: Values of equipment limits.
OperationalLimit:
class_uri: cim:OperationalLimit
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.OperationalLimits
description: "A value and normal value associated with a specific kind of limit.\
\ \r\nThe sub class value and normalValue attributes vary inversely to the associated\
\ OperationalLimitType.acceptableDuration (acceptableDuration for short). \r\
\nIf a particular piece of equipment has multiple operational limits of the\
\ same kind (apparent power, current, etc.), the limit with the greatest acceptableDuration\
\ shall have the smallest limit value and the limit with the smallest acceptableDuration\
\ shall have the largest limit value. Note: A large current can only be allowed\
\ to flow through a piece of equipment for a short duration without causing\
\ damage, but a lesser current can be allowed to flow for a longer duration. "
attributes:
OperationalLimitType:
slot_uri: cim:OperationalLimit.OperationalLimitType
range: OperationalLimitType
required: false
multivalued: false
description: The limit type associated with this limit.
OperationalLimitSet:
slot_uri: cim:OperationalLimit.OperationalLimitSet
range: OperationalLimitSet
required: true
multivalued: false
description: The limit set to which the limit values belong.
LimitDependencyModel:
slot_uri: cim:OperationalLimit.LimitDependencyModel
range: LimitDependency
required: false
multivalued: true
description: The limit dependency models which are used to calculate this
limit. If no limit dependencies are specified then the native limit value
is used.
LimitScalingLimit:
slot_uri: cim:OperationalLimit.LimitScalingLimit
range: LimitScalingLimit
required: false
multivalued: true
LimitScalingLimit:
class_uri: cim:LimitScalingLimit
is_a: LimitDependency
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfOperationalLimits
description: Specifies an operational limit is calculated by scaling another
operational limit.
attributes:
limitScalingPercent:
slot_uri: cim:LimitScalingLimit.limitScalingPercent
range: PerCent
required: false
multivalued: false
description: "The associated source limit is scaled by this value to compute\
\ the limit of the dependency model.\r\n"
SourceOperationalLimit:
slot_uri: cim:LimitScalingLimit.SourceOperationalLimit
range: OperationalLimit
required: true
multivalued: false
LimitDependency:
class_uri: cim:LimitDependency
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfOperationalLimits
description: A limit calculation model used to compute an operational limit based
on external input such as temperature. These are intended to be shared among
operational limits with the same calculation form that apply to a piece of equipment..
attributes:
Equipment:
slot_uri: cim:LimitDependency.Equipment
range: Equipment
required: false
multivalued: false
description: The equipment for which this limit dependency model is organized
under.
OperationalLimit:
slot_uri: cim:LimitDependency.OperationalLimit
range: OperationalLimit
required: false
multivalued: true
description: The operational limits to which this limit dependency model applies.
Equipment:
class_uri: cim:Equipment
is_a: PowerSystemResource
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Core
description: The parts of a power system that are physical devices, electronic
or mechanical.
attributes:
aggregate:
slot_uri: cim:Equipment.aggregate
range: boolean
required: false
multivalued: false
description: "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 \u201Ctrue\u201D 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.\
\ \r\nThe attribute is not used for EquivalentBranch, EquivalentShunt and\
\ EquivalentInjection."
inService:
slot_uri: cim:Equipment.inService
range: boolean
required: false
multivalued: false
description: 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.
networkAnalysisEnabled:
slot_uri: cim:Equipment.networkAnalysisEnabled
range: boolean
required: false
multivalued: false
description: The equipment is enabled to participate in network analysis. If
unspecified, the value is assumed to be true.
normallyInService:
slot_uri: cim:Equipment.normallyInService
range: boolean
required: false
multivalued: false
description: 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.
WeatherStation:
slot_uri: cim:Equipment.WeatherStation
range: WeatherStation
required: false
multivalued: true
OperationalLimitSet:
slot_uri: cim:Equipment.OperationalLimitSet
range: OperationalLimitSet
required: false
multivalued: true
description: The operational limit sets associated with this equipment.
ContingencyEquipment:
slot_uri: cim:Equipment.ContingencyEquipment
range: ContingencyEquipment
required: false
multivalued: true
description: The contingency equipments in which this equipment participates.
EquipmentContainer:
slot_uri: cim:Equipment.EquipmentContainer
range: EquipmentContainer
required: false
multivalued: false
description: Container of this equipment.
Faults:
slot_uri: cim:Equipment.Faults
range: Fault
required: false
multivalued: true
description: All faults on this equipment.
LimitDependencyModel:
slot_uri: cim:Equipment.LimitDependencyModel
range: LimitDependency
required: false
multivalued: true
description: Limit dependencymodels organized under this equipment as a means
for organizing the model in a tree view.
EqiupmentLimitSeriesComponent:
slot_uri: cim:Equipment.EqiupmentLimitSeriesComponent
range: EquipmentLimitSeriesComponent
required: false
multivalued: true
description: Equipment limit series calculation component to which this equipment
contributes.
ProtectiveActionEquipment:
slot_uri: cim:Equipment.ProtectiveActionEquipment
range: ProtectiveActionEquipment
required: false
multivalued: true
description: Protective action is controlling equipment. This can be direct
signals from the control center, or emulation of action done by protection
equipment.
PinEquipment:
slot_uri: cim:Equipment.PinEquipment
range: PinEquipment
required: false
multivalued: true
EquipmentUnavailabilitySchedule:
slot_uri: cim:Equipment.EquipmentUnavailabilitySchedule
range: EquipmentUnavailabilitySchedule
required: false
multivalued: true
AdditionalEquipmentContainer:
slot_uri: cim:Equipment.AdditionalEquipmentContainer
range: EquipmentContainer
required: false
multivalued: true
description: Additional equipment container beyond the primary equipment container. The
equipment is contained in another equipment container, but also grouped
with this equipment container.
UsagePoints:
slot_uri: cim:Equipment.UsagePoints
range: UsagePoint
required: false
multivalued: true
description: All usage points connected to the electrical grid through this
equipment.
Outages:
slot_uri: cim:Equipment.Outages
range: Outage
required: false
multivalued: true
description: All outages in which this equipment is involved.
OperationalRestrictions:
slot_uri: cim:Equipment.OperationalRestrictions
range: OperationalRestriction
required: false
multivalued: true
description: All operational restrictions for this equipment.
ContingencyEquipment:
class_uri: cim:ContingencyEquipment
is_a: ContingencyElement
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Contingency
description: Equipment whose in service status is to change, such as a power transformer
or AC line segment.
attributes:
contingentStatus:
slot_uri: cim:ContingencyEquipment.contingentStatus
range: ContingencyEquipmentStatusKind
required: false
multivalued: false
description: The status for the associated equipment when in the contingency
state. This status is independent of the case to which the contingency
is originally applied, but defines the equipment status when the contingency
is applied.
Equipment:
slot_uri: cim:ContingencyEquipment.Equipment
range: Equipment
required: true
multivalued: false
description: The single piece of equipment to which to apply the contingency.
ContingencyElement:
class_uri: cim:ContingencyElement
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Contingency
description: 'An element of a system event to be studied by contingency analysis,
representing a change in status of a single piece of equipment. '
attributes:
Contingency:
slot_uri: cim:ContingencyElement.Contingency
range: Contingency
required: true
multivalued: false
description: A contingency element belongs to one contingency.
Contingency:
class_uri: cim:Contingency
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Contingency
description: An event threatening system reliability, consisting of one or more
contingency elements.
attributes:
mustStudy:
slot_uri: cim:Contingency.mustStudy
range: boolean
required: false
multivalued: false
description: Set true if must study this contingency.
ContingencyElement:
slot_uri: cim:Contingency.ContingencyElement
range: ContingencyElement
required: false
multivalued: true
description: A contingency can have any number of contingency elements.
EquipmentContainer:
class_uri: cim:EquipmentContainer
is_a: ConnectivityNodeContainer
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Core
description: 'A modelling construct to provide a root class for containing equipment. '
attributes:
Equipments:
slot_uri: cim:EquipmentContainer.Equipments
range: Equipment
required: false
multivalued: true
description: Contained equipment.
AdditionalGroupedEquipment:
slot_uri: cim:EquipmentContainer.AdditionalGroupedEquipment
range: Equipment
required: false
multivalued: true
description: The additonal contained equipment. The equipment belong to the
equipment container. The equipment is contained in another equipment container,
but also grouped with this equipment container. Examples include when a
switch contained in a substation is also desired to be grouped with a line
contianer or when a switch is included in a secondary substation and also
grouped in a feeder.
ConnectivityNodeContainer:
class_uri: cim:ConnectivityNodeContainer
is_a: PowerSystemResource
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Core
description: "A base class for all objects that may contain connectivity nodes\
\ or topological nodes.\r\n"
attributes:
TopologicalNode:
slot_uri: cim:ConnectivityNodeContainer.TopologicalNode
range: TopologicalNode
required: false
multivalued: true
description: The topological nodes which belong to this connectivity node
container.
ConnectivityNodes:
slot_uri: cim:ConnectivityNodeContainer.ConnectivityNodes
range: ConnectivityNode
required: false
multivalued: true
description: Connectivity nodes which belong to this connectivity node container.
TopologicalNode:
class_uri: cim:TopologicalNode
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Topology
description: "For a detailed substation model a topological node is a set of connectivity\
\ nodes that, in the current network state, are connected together through any\
\ type of closed switches, including jumpers. Topological nodes change as the\
\ current network state changes (i.e., switches, breakers, etc. change state).\r\
\nFor a planning model, switch statuses are not used to form topological nodes.\
\ Instead they are manually created or deleted in a model builder tool. Topological\
\ nodes maintained this way are also called \"busses\"."
attributes:
pInjection:
slot_uri: cim:TopologicalNode.pInjection
range: ActivePower
required: false
multivalued: false
description: "The active power injected into the bus at this location in addition\
\ to injections from equipment. Positive sign means injection into the\
\ TopologicalNode (bus).\r\nStarting value for a steady state solution. "
qInjection:
slot_uri: cim:TopologicalNode.qInjection
range: ReactivePower
required: false
multivalued: false
description: "The reactive power injected into the bus at this location in\
\ addition to injections from equipment. Positive sign means injection into\
\ the TopologicalNode (bus).\r\nStarting value for a steady state solution."
TopologicalIsland:
slot_uri: cim:TopologicalNode.TopologicalIsland
range: TopologicalIsland
required: false
multivalued: false
description: A topological node belongs to a topological island.
ReportingGroup:
slot_uri: cim:TopologicalNode.ReportingGroup
range: ReportingGroup
required: false
multivalued: false
description: The reporting group to which the topological node belongs.
ConnectivityNodeContainer:
slot_uri: cim:TopologicalNode.ConnectivityNodeContainer
range: ConnectivityNodeContainer
required: false
multivalued: false
description: The connectivity node container to which the topological node
belongs.
BaseVoltage:
slot_uri: cim:TopologicalNode.BaseVoltage
range: BaseVoltage
required: false
multivalued: false
description: The base voltage of the topological node.
SvInjection:
slot_uri: cim:TopologicalNode.SvInjection
range: SvInjection
required: false
multivalued: true
description: The injection flows state variables associated with the topological
node.
SvVoltage:
slot_uri: cim:TopologicalNode.SvVoltage
range: SvVoltage
required: false
multivalued: true
description: The state voltage associated with the topological node.
AngleRefTopologicalIsland:
slot_uri: cim:TopologicalNode.AngleRefTopologicalIsland
range: TopologicalIsland
required: false
multivalued: false
description: The island for which the node is an angle reference. Normally
there is one angle reference node for each island.
ConnectivityNodes:
slot_uri: cim:TopologicalNode.ConnectivityNodes
range: ConnectivityNode
required: false
multivalued: true
description: The connectivity nodes combine together to form this topological
node. May depend on the current state of switches in the network.
Terminal:
slot_uri: cim:TopologicalNode.Terminal
range: Terminal
required: false
multivalued: true
description: The terminals associated with the topological node. This can
be used as an alternative to the connectivity node path to terminal, thus
making it unnecessary to model connectivity nodes in some cases. Note
that if connectivity nodes are in the model, this association would probably
not be used as an input specification.
BusNameMarker:
slot_uri: cim:TopologicalNode.BusNameMarker
range: BusNameMarker
required: false
multivalued: true
description: BusnameMarkers that may refer to a pre defined TopologicalNode.
SvInjection:
class_uri: cim:SvInjection
is_a: StateVariable
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.StateVariables
description: The SvInjection reports the calculated bus injection minus the sum
of the terminal flows. The terminal flow is positive out from the bus (load
sign convention) and bus injection has positive flow into the bus. SvInjection
may have the remainder after state estimation or slack after power flow calculation.
attributes:
phase:
slot_uri: cim:SvInjection.phase
range: SinglePhaseKind
required: false
multivalued: false
description: The terminal phase at which the connection is applied. If missing,
the injection is assumed to be balanced among non-neutral phases.
pInjection:
slot_uri: cim:SvInjection.pInjection
range: ActivePower
required: false
multivalued: false
description: The active power mismatch between calculated injection and initial
injection. Positive sign means injection into the TopologicalNode (bus).
qInjection:
slot_uri: cim:SvInjection.qInjection
range: ReactivePower
required: false
multivalued: false
description: The reactive power mismatch between calculated injection and
initial injection. Positive sign means injection into the TopologicalNode
(bus).
TopologicalNode:
slot_uri: cim:SvInjection.TopologicalNode
range: TopologicalNode
required: true
multivalued: false
description: The topological node associated with the flow injection state
variable.
StateVariable:
class_uri: cim:StateVariable
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.StateVariables
description: An abstract class for state variables.
SvVoltage:
class_uri: cim:SvVoltage
is_a: StateVariable
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.StateVariables
description: State variable for voltage.
attributes:
angle:
slot_uri: cim:SvVoltage.angle
range: AngleDegrees
required: false
multivalued: false
description: "The voltage angle of the topological node complex voltage with\
\ respect to system reference.\r\n"
phase:
slot_uri: cim:SvVoltage.phase
range: SinglePhaseKind
required: false
multivalued: false
description: 'If specified the voltage is the line to ground voltage of the
individual phase. If unspecified, then the voltage is assumed balanced. '
v:
slot_uri: cim:SvVoltage.v
range: Voltage
required: false
multivalued: false
description: The voltage magnitude at the topological node. The attribute
shall be a positive value.
TopologicalNode:
slot_uri: cim:SvVoltage.TopologicalNode
range: TopologicalNode
required: true
multivalued: false
description: The topological node associated with the voltage state.
TopologicalIsland:
class_uri: cim:TopologicalIsland
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Topology
description: "An electrically connected subset of the network. Topological islands\
\ can change as the current network state changes, e.g. due to: \r\n- disconnect\
\ switches or breakers changing state in a SCADA/EMS.\r\n- manual creation,\
\ change or deletion of topological nodes in a planning tool.\r\nOnly energised\
\ TopologicalNode-s shall be part of the topological island."
attributes:
AngleRefTopologicalNode:
slot_uri: cim:TopologicalIsland.AngleRefTopologicalNode
range: TopologicalNode
required: false
multivalued: false
description: The angle reference for the island. Normally there is one TopologicalNode
that is selected as the angle reference for each island. Other reference
schemes exist, so the association is typically optional.
TopologicalNodes:
slot_uri: cim:TopologicalIsland.TopologicalNodes
range: TopologicalNode
required: true
multivalued: true
description: A topological node belongs to a topological island.
ConnectivityNode:
class_uri: cim:ConnectivityNode
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Core
description: Connectivity nodes are points where terminals of AC conducting equipment
are connected together with zero impedance.
attributes:
TopologicalNode:
slot_uri: cim:ConnectivityNode.TopologicalNode
range: TopologicalNode
required: false
multivalued: false
description: The topological node to which this connectivity node is assigned. May
depend on the current state of switches in the network.
ConnectivityNodeContainer:
slot_uri: cim:ConnectivityNode.ConnectivityNodeContainer
range: ConnectivityNodeContainer
required: true
multivalued: false
description: Container of this connectivity node.
Terminals:
slot_uri: cim:ConnectivityNode.Terminals
range: Terminal
required: false
multivalued: true
description: 'Terminals interconnected with zero impedance at a this connectivity
node. '
Terminal:
class_uri: cim:Terminal
is_a: ACDCTerminal
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Core
description: An AC electrical connection point to a piece of conducting equipment.
Terminals are connected at physical connection points called connectivity nodes.
attributes:
phases:
slot_uri: cim:Terminal.phases
range: PhaseCode
required: false
multivalued: false
description: "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.\r\
\nThe phase code on terminals connecting same ConnectivityNode or same TopologicalNode\
\ as well as for equipment between two terminals shall be consistent."
TopologicalNode:
slot_uri: cim:Terminal.TopologicalNode
range: TopologicalNode
required: false
multivalued: false
description: The topological node associated with the terminal. This can
be used as an alternative to the connectivity node path to topological node,
thus making it unnecessary to model connectivity nodes in some cases. Note
that the if connectivity nodes are in the model, this association would
probably not be used as an input specification.
ConnectivityNode:
slot_uri: cim:Terminal.ConnectivityNode
range: ConnectivityNode
required: false
multivalued: false
description: The connectivity node to which this terminal connects with zero
impedance.
ConductingEquipment:
slot_uri: cim:Terminal.ConductingEquipment
range: ConductingEquipment
required: true
multivalued: false
description: The conducting equipment of the terminal. Conducting equipment
have terminals that may be connected to other conducting equipment terminals
via connectivity nodes or topological nodes.
RegulatingControl:
slot_uri: cim:Terminal.RegulatingControl
range: RegulatingControl
required: false
multivalued: true
description: The controls regulating this terminal.
HasFirstMutualCoupling:
slot_uri: cim:Terminal.HasFirstMutualCoupling
range: MutualCoupling
required: false
multivalued: true
description: Mutual couplings associated with the branch as the first branch.
TransformerEnd:
slot_uri: cim:Terminal.TransformerEnd
range: TransformerEnd
required: false
multivalued: true
description: All transformer ends connected at this terminal.
BranchGroupTerminal:
slot_uri: cim:Terminal.BranchGroupTerminal
range: BranchGroupTerminal
required: false
multivalued: true
description: 'The directed branch group terminals for which this terminal
is monitored. '
SvPowerFlow:
slot_uri: cim:Terminal.SvPowerFlow
range: SvPowerFlow
required: false
multivalued: true
description: The power flow state variable associated with the terminal.
AuxiliaryEquipment:
slot_uri: cim:Terminal.AuxiliaryEquipment
range: AuxiliaryEquipment
required: false
multivalued: true
description: The auxiliary equipment connected to the terminal.
HasSecondMutualCoupling:
slot_uri: cim:Terminal.HasSecondMutualCoupling
range: MutualCoupling
required: false
multivalued: true
description: Mutual couplings with the branch associated as the first branch.
TieFlow:
slot_uri: cim:Terminal.TieFlow
range: TieFlow
required: false
multivalued: true
description: The control area tie flows to which this terminal associates.
EquipmentFaults:
slot_uri: cim:Terminal.EquipmentFaults
range: EquipmentFault
required: false
multivalued: true
description: The equipment faults at this terminal.
ConverterDCSides:
slot_uri: cim:Terminal.ConverterDCSides
range: ACDCConverter
required: false
multivalued: true
description: All converters' DC sides linked to this point of common coupling
terminal.
PinTerminal:
slot_uri: cim:Terminal.PinTerminal
range: PinTerminal
required: false
multivalued: true
NormalHeadFeeder:
slot_uri: cim:Terminal.NormalHeadFeeder
range: Feeder
required: false
multivalued: false
description: The feeder that this terminal normally feeds. Only specified
for the terminals at head of feeders.
Circuit:
slot_uri: cim:Terminal.Circuit
range: Circuit
required: false
multivalued: false
RemoteInputSignal:
slot_uri: cim:Terminal.RemoteInputSignal
range: RemoteInputSignal
required: false
multivalued: true
description: Input signal coming from this terminal.
Bushing:
slot_uri: cim:Terminal.Bushing
range: Bushing
required: false
multivalued: false
MutualCoupling:
class_uri: cim:MutualCoupling
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: "This class represents the zero sequence line mutual coupling.\r\n"
attributes:
b0ch:
slot_uri: cim:MutualCoupling.b0ch
range: Susceptance
required: false
multivalued: false
description: Zero sequence mutual coupling shunt (charging) susceptance, uniformly
distributed, of the entire line section.
distance11:
slot_uri: cim:MutualCoupling.distance11
range: Length
required: false
multivalued: false
description: "Distance to the start of the coupled region from the first line's\
\ terminal having sequence number equal to 1.\r\n"
distance12:
slot_uri: cim:MutualCoupling.distance12
range: Length
required: false
multivalued: false
description: "Distance to the end of the coupled region from the first line's\
\ terminal with sequence number equal to 1.\r\n"
distance21:
slot_uri: cim:MutualCoupling.distance21
range: Length
required: false
multivalued: false
description: "Distance to the start of coupled region from the second line's\
\ terminal with sequence number equal to 1.\r\n"
distance22:
slot_uri: cim:MutualCoupling.distance22
range: Length
required: false
multivalued: false
description: Distance to the end of coupled region from the second line's
terminal with sequence number equal to 1.
g0ch:
slot_uri: cim:MutualCoupling.g0ch
range: Conductance
required: false
multivalued: false
description: Zero sequence mutual coupling shunt (charging) conductance, uniformly
distributed, of the entire line section.
r0:
slot_uri: cim:MutualCoupling.r0
range: Resistance
required: false
multivalued: false
description: "Zero sequence branch-to-branch mutual impedance coupling, resistance.\r\
\n"
x0:
slot_uri: cim:MutualCoupling.x0
range: Reactance
required: false
multivalued: false
description: "Zero sequence branch-to-branch mutual impedance coupling, reactance.\r\
\n"
First_Terminal:
slot_uri: cim:MutualCoupling.First_Terminal
range: Terminal
required: true
multivalued: false
description: The starting terminal for the calculation of distances along
the first branch of the mutual coupling. Normally MutualCoupling would
only be used for terminals of AC line segments. The first and second terminals
of a mutual coupling should point to different AC line segments.
Second_Terminal:
slot_uri: cim:MutualCoupling.Second_Terminal
range: Terminal
required: true
multivalued: false
description: The starting terminal for the calculation of distances along
the second branch of the mutual coupling.
TransformerEnd:
class_uri: cim:TransformerEnd
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: A conducting connection point of a power transformer. It corresponds
to a physical transformer winding terminal. In earlier CIM versions, the TransformerWinding
class served a similar purpose, but this class is more flexible because it associates
to terminal but is not a specialization of ConductingEquipment.
attributes:
bmagSat:
slot_uri: cim:TransformerEnd.bmagSat
range: PerCent
required: false
multivalued: false
description: "Core shunt magnetizing susceptance in the saturation region.\r\
\n"
endNumber:
slot_uri: cim:TransformerEnd.endNumber
range: integer
required: false
multivalued: false
description: "Number for this transformer end, corresponding to the end's\
\ order in the power transformer vector group or phase angle clock number.\
\ Highest voltage winding should be 1. Each end within a power transformer\
\ should have a unique subsequent end number. Note the transformer end\
\ number need not match the terminal sequence number.\r\n"
grounded:
slot_uri: cim:TransformerEnd.grounded
range: boolean
required: false
multivalued: false
description: (for Yn and Zn connections) True if the neutral is solidly grounded.
magBaseU:
slot_uri: cim:TransformerEnd.magBaseU
range: Voltage
required: false
multivalued: false
description: "The reference voltage at which the magnetizing saturation measurements\
\ were made.\r\n"
magSatFlux:
slot_uri: cim:TransformerEnd.magSatFlux
range: PerCent
required: false
multivalued: false
description: "Core magnetizing saturation curve knee flux level.\r\n"
rground:
slot_uri: cim:TransformerEnd.rground
range: Resistance
required: false
multivalued: false
description: (for Yn and Zn connections) Resistance part of neutral impedance
where 'grounded' is true.
xground:
slot_uri: cim:TransformerEnd.xground
range: Reactance
required: false
multivalued: false
description: (for Yn and Zn connections) Reactive part of neutral impedance
where 'grounded' is true.
PhaseTapChanger:
slot_uri: cim:TransformerEnd.PhaseTapChanger
range: PhaseTapChanger
required: false
multivalued: false
description: Phase tap changer associated with this transformer end.
StarImpedance:
slot_uri: cim:TransformerEnd.StarImpedance
range: TransformerStarImpedance
required: false
multivalued: false
description: (accurate for 2- or 3-winding transformers only) Pi-model impedances
of this transformer end. By convention, for a two winding transformer, the
full values of the transformer should be entered on the high voltage end
(endNumber=1).
RatioTapChanger:
slot_uri: cim:TransformerEnd.RatioTapChanger
range: RatioTapChanger
required: false
multivalued: false
description: Ratio tap changer associated with this transformer end.
BaseVoltage:
slot_uri: cim:TransformerEnd.BaseVoltage
range: BaseVoltage
required: false
multivalued: false
description: Base voltage of the transformer end. This is essential for PU
calculation.
Terminal:
slot_uri: cim:TransformerEnd.Terminal
range: Terminal
required: false
multivalued: false
description: Terminal of the power transformer to which this transformer end
belongs.
ToMeshImpedance:
slot_uri: cim:TransformerEnd.ToMeshImpedance
range: TransformerMeshImpedance
required: false
multivalued: true
description: All mesh impedances between this 'from' and other 'to' transformer
ends.
FromMeshImpedance:
slot_uri: cim:TransformerEnd.FromMeshImpedance
range: TransformerMeshImpedance
required: false
multivalued: true
description: All mesh impedances between this 'to' and other 'from' transformer
ends.
CoreAdmittance:
slot_uri: cim:TransformerEnd.CoreAdmittance
range: TransformerCoreAdmittance
required: false
multivalued: false
description: Core admittance of this transformer end, representing magnetising
current and core losses. The full values of the transformer should be supplied
for one transformer end only.
FromWindingInsulations:
slot_uri: cim:TransformerEnd.FromWindingInsulations
range: WindingInsulation
required: false
multivalued: true
ToWindingInsulations:
slot_uri: cim:TransformerEnd.ToWindingInsulations
range: WindingInsulation
required: false
multivalued: true
TransformerMeshImpedance:
class_uri: cim:TransformerMeshImpedance
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: "Transformer mesh impedance (Delta-model) between transformer ends.\r\
\nThe typical case is that this class describes the impedance between two transformer\
\ ends pair-wise, i.e. the cardinalities at both transformer end associations\
\ are 1. However, in cases where two or more transformer ends are modelled the\
\ cardinalities are larger than 1."
attributes:
r:
slot_uri: cim:TransformerMeshImpedance.r
range: Resistance
required: false
multivalued: false
description: "Resistance between the 'from' and the 'to' end, seen from the\
\ 'from' end.\r\n"
r0:
slot_uri: cim:TransformerMeshImpedance.r0
range: Resistance
required: false
multivalued: false
description: "Zero-sequence resistance between the 'from' and the 'to' end,\
\ seen from the 'from' end.\r\n"
x:
slot_uri: cim:TransformerMeshImpedance.x
range: Reactance
required: false
multivalued: false
description: "Reactance between the 'from' and the 'to' end, seen from the\
\ 'from' end.\r\n"
x0:
slot_uri: cim:TransformerMeshImpedance.x0
range: Reactance
required: false
multivalued: false
description: "Zero-sequence reactance between the 'from' and the 'to' end,\
\ seen from the 'from' end.\r\n"
ToTransformerEnd:
slot_uri: cim:TransformerMeshImpedance.ToTransformerEnd
range: TransformerEnd
required: true
multivalued: true
description: All transformer ends this mesh impedance is connected to.
FromTransformerEnd:
slot_uri: cim:TransformerMeshImpedance.FromTransformerEnd
range: TransformerEnd
required: true
multivalued: false
description: From end this mesh impedance is connected to. It determines the
voltage reference.
ToTransformerEndInfos:
slot_uri: cim:TransformerMeshImpedance.ToTransformerEndInfos
range: TransformerEndInfo
required: false
multivalued: true
description: All 'to' transformer end datasheets this mesh impedance for 'from'
transformer end is calculated from.
FromTransformerEndInfo:
slot_uri: cim:TransformerMeshImpedance.FromTransformerEndInfo
range: TransformerEndInfo
required: false
multivalued: false
description: '''from'' transformer end datasheet this mesh impedance is calculated
from. It determines the voltage reference.'
TransformerEndInfo:
class_uri: cim:TransformerEndInfo
is_a: AssetInfo
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetInfo
description: "Transformer end data.\r\n"
attributes:
connectionKind:
slot_uri: cim:TransformerEndInfo.connectionKind
range: WindingConnection
required: false
multivalued: false
description: "Kind of connection.\r\n"
emergencyS:
slot_uri: cim:TransformerEndInfo.emergencyS
range: ApparentPower
required: false
multivalued: false
description: "Apparent power that the winding can carry under emergency conditions\
\ (also called long-term emergency power).\r\n"
endNumber:
slot_uri: cim:TransformerEndInfo.endNumber
range: integer
required: false
multivalued: false
description: "Number for this transformer end, corresponding to the end's\
\ order in the PowerTransformer.vectorGroup attribute. Highest voltage winding\
\ should be 1.\r\n"
insulationU:
slot_uri: cim:TransformerEndInfo.insulationU
range: Voltage
required: false
multivalued: false
description: Basic insulation level voltage rating.
phaseAngleClock:
slot_uri: cim:TransformerEndInfo.phaseAngleClock
range: integer
required: false
multivalued: false
description: "Winding phase angle where 360 degrees are represented with clock\
\ hours, so the valid values are {0, ..., 11}. For example, to express the\
\ second winding in code 'Dyn11', set attributes as follows: 'endNumber'=2,\
\ 'connectionKind' = Yn and 'phaseAngleClock' = 11.\r\n"
r:
slot_uri: cim:TransformerEndInfo.r
range: Resistance
required: false
multivalued: false
description: "DC resistance.\r\n"
ratedS:
slot_uri: cim:TransformerEndInfo.ratedS
range: ApparentPower
required: false
multivalued: false
description: "Normal apparent power rating.\r\n"
ratedU:
slot_uri: cim:TransformerEndInfo.ratedU
range: Voltage
required: false
multivalued: false
description: "Rated voltage: phase-phase for three-phase windings, and either\
\ phase-phase or phase-neutral for single-phase windings.\r\n"
shortTermS:
slot_uri: cim:TransformerEndInfo.shortTermS
range: ApparentPower
required: false
multivalued: false
description: "Apparent power that this winding can carry for a short period\
\ of time (in emergency).\r\n"
ToMeshImpedances:
slot_uri: cim:TransformerEndInfo.ToMeshImpedances
range: TransformerMeshImpedance
required: false
multivalued: true
description: All mesh impedances between this 'from' and other 'to' transformer
ends.
TransformerStarImpedance:
slot_uri: cim:TransformerEndInfo.TransformerStarImpedance
range: TransformerStarImpedance
required: false
multivalued: false
description: Transformer star impedance calculated from this transformer end
datasheet.
FromMeshImpedances:
slot_uri: cim:TransformerEndInfo.FromMeshImpedances
range: TransformerMeshImpedance
required: false
multivalued: true
description: All mesh impedances between this 'to' and other 'from' transformer
ends.
CoreAdmittance:
slot_uri: cim:TransformerEndInfo.CoreAdmittance
range: TransformerCoreAdmittance
required: false
multivalued: false
description: Core admittance calculated from this transformer end datasheet,
representing magnetising current and core losses. The full values of the
transformer should be supplied for one transformer end info only.
EnergisedEndShortCircuitTests:
slot_uri: cim:TransformerEndInfo.EnergisedEndShortCircuitTests
range: ShortCircuitTest
required: false
multivalued: true
description: All short-circuit test measurements in which this transformer
end was energised.
TransformerTankInfo:
slot_uri: cim:TransformerEndInfo.TransformerTankInfo
range: TransformerTankInfo
required: true
multivalued: false
description: Transformer tank data that this end description is part of.
EnergisedEndOpenCircuitTests:
slot_uri: cim:TransformerEndInfo.EnergisedEndOpenCircuitTests
range: OpenCircuitTest
required: false
multivalued: true
description: All open-circuit test measurements in which this transformer
end was excited.
GroundedEndShortCircuitTests:
slot_uri: cim:TransformerEndInfo.GroundedEndShortCircuitTests
range: ShortCircuitTest
required: false
multivalued: true
description: All short-circuit test measurements in which this transformer
end was short-circuited.
OpenEndOpenCircuitTests:
slot_uri: cim:TransformerEndInfo.OpenEndOpenCircuitTests
range: OpenCircuitTest
required: false
multivalued: true
description: All open-circuit test measurements in which this transformer
end was not excited.
EnergisedEndNoLoadTests:
slot_uri: cim:TransformerEndInfo.EnergisedEndNoLoadTests
range: NoLoadTest
required: false
multivalued: true
description: All no-load test measurements in which this transformer end was
energised.
AssetInfo:
class_uri: cim:AssetInfo
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: "Set of attributes of an asset, representing typical datasheet information\
\ of a physical device that can be instantiated and shared in different data\
\ exchange contexts:\r\n- as attributes of an asset instance (installed or in\
\ stock)\r\n- as attributes of an asset model (product by a manufacturer)\r\n\
- as attributes of a type asset (generic type of an asset as used in designs/extension\
\ planning)."
attributes:
PowerSystemResources:
slot_uri: cim:AssetInfo.PowerSystemResources
range: PowerSystemResource
required: false
multivalued: true
description: All power system resources with this datasheet information.
CatalogAssetType:
slot_uri: cim:AssetInfo.CatalogAssetType
range: CatalogAssetType
required: false
multivalued: false
description: Asset information (nameplate) for this catalog asset type.
Assets:
slot_uri: cim:AssetInfo.Assets
range: Asset
required: false
multivalued: true
description: All assets described by this data.
ProductAssetModel:
slot_uri: cim:AssetInfo.ProductAssetModel
range: ProductAssetModel
required: false
multivalued: false
description: Product asset model which conforms to this catalog asset type.
Asset:
class_uri: cim:Asset
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: Tangible resource of the utility, including power system equipment,
various end devices, cabinets, buildings, etc. For electrical network equipment,
the role of the asset is defined through PowerSystemResource and its subclasses,
defined mainly in the Wires model (refer to IEC61970-301 and model package IEC61970::Wires).
Asset description places emphasis on the physical characteristics of the equipment
fulfilling that role.
attributes:
acceptanceTest:
slot_uri: cim:Asset.acceptanceTest
range: AcceptanceTest
required: false
multivalued: false
description: Information on acceptance test.
critical:
slot_uri: cim:Asset.critical
range: boolean
required: false
multivalued: false
description: True if asset is considered critical for some reason (for example,
a pole with critical attachments).
electronicAddress:
slot_uri: cim:Asset.electronicAddress
range: ElectronicAddress
required: false
multivalued: false
description: Electronic address.
initialCondition:
slot_uri: cim:Asset.initialCondition
range: string
required: false
multivalued: false
description: Condition of asset at last baseline. Examples include new, rebuilt,
overhaul required, other. Refer to inspection data for information on the
most current condition of the asset.
initialLossOfLife:
slot_uri: cim:Asset.initialLossOfLife
range: PerCent
required: false
multivalued: false
description: "Percentage of initial life expectancy that has been lost as\
\ of the last life expectancy baseline. Represents \r\n(initial life expectancy\
\ - current life expectancy) / initial life expectancy."
inUseDate:
slot_uri: cim:Asset.inUseDate
range: InUseDate
required: false
multivalued: false
description: In use dates for this asset.
inUseState:
slot_uri: cim:Asset.inUseState
range: InUseStateKind
required: false
multivalued: false
description: Indication of whether asset is currently deployed (in use), ready
to be put into use or not available for use.
kind:
slot_uri: cim:Asset.kind
range: AssetKind
required: false
multivalued: false
description: Kind of asset. Used in description of asset components in asset
instance templates.
lifecycleDate:
slot_uri: cim:Asset.lifecycleDate
range: LifecycleDate
required: false
multivalued: false
description: "\r\nLifecycle dates for this asset."
lifecycleState:
slot_uri: cim:Asset.lifecycleState
range: AssetLifecycleStateKind
required: false
multivalued: false
description: Current lifecycle state of asset.
lotNumber:
slot_uri: cim:Asset.lotNumber
range: string
required: false
multivalued: false
description: Lot number for this asset. Even for the same model and version
number, many assets are manufactured in lots.
position:
slot_uri: cim:Asset.position
range: string
required: false
multivalued: false
description: 'Position of asset or asset component. May often be in relation
to other assets or components. '
purchasePrice:
slot_uri: cim:Asset.purchasePrice
range: Money
required: false
multivalued: false
description: Purchase price of asset.
retiredReason:
slot_uri: cim:Asset.retiredReason
range: RetiredReasonKind
required: false
multivalued: false
description: Reason asset retired.
serialNumber:
slot_uri: cim:Asset.serialNumber
range: string
required: false
multivalued: false
description: Serial number of this asset.
status:
slot_uri: cim:Asset.status
range: Status
required: false
multivalued: false
description: Status of this asset.
type:
slot_uri: cim:Asset.type
range: string
required: false
multivalued: false
description: "Utility-specific classification of Asset and its subtypes, according\
\ to their corporate standards, practices, and existing IT systems (e.g.,\
\ for management of assets, maintenance, work, outage, customers, etc.).\r\
\n"
utcNumber:
slot_uri: cim:Asset.utcNumber
range: string
required: false
multivalued: false
description: "Uniquely tracked commodity (UTC) number.\r\n"
Location:
slot_uri: cim:Asset.Location
range: Location
required: false
multivalued: false
description: Location of this asset.
Measurements:
slot_uri: cim:Asset.Measurements
range: Measurement
required: false
multivalued: true
description: Measurement related to this asset.
AssetInfo:
slot_uri: cim:Asset.AssetInfo
range: AssetInfo
required: false
multivalued: false
description: Data applicable to this asset.
Reconditionings:
slot_uri: cim:Asset.Reconditionings
range: Reconditioning
required: false
multivalued: true
ProductAssetModel:
slot_uri: cim:Asset.ProductAssetModel
range: ProductAssetModel
required: false
multivalued: false
description: The model of this asset.
AssetDeployment:
slot_uri: cim:Asset.AssetDeployment
range: AssetDeployment
required: false
multivalued: false
description: This asset's deployment.
ErpRecDeliveryItems:
slot_uri: cim:Asset.ErpRecDeliveryItems
range: ErpRecDelvLineItem
required: false
multivalued: true
ConfigurationEvents:
slot_uri: cim:Asset.ConfigurationEvents
range: ConfigurationEvent
required: false
multivalued: true
description: All configuration events created for this asset.
AssetPropertyCurves:
slot_uri: cim:Asset.AssetPropertyCurves
range: AssetPropertyCurve
required: false
multivalued: true
AssetContainer:
slot_uri: cim:Asset.AssetContainer
range: AssetContainer
required: false
multivalued: false
description: Container of this asset.
PowerSystemResources:
slot_uri: cim:Asset.PowerSystemResources
range: PowerSystemResource
required: false
multivalued: true
description: All power system resources used to electrically model this asset.
For example, transformer asset is electrically modelled with a transformer
and its windings and tap changer.
AssetFunction:
slot_uri: cim:Asset.AssetFunction
range: AssetFunction
required: false
multivalued: true
description: Function performed by this asset.
ActivityRecords:
slot_uri: cim:Asset.ActivityRecords
range: ActivityRecord
required: false
multivalued: true
description: All activity records created for this asset.
OrganisationRoles:
slot_uri: cim:Asset.OrganisationRoles
range: AssetOrganisationRole
required: false
multivalued: true
description: All roles an organisation plays for this asset.
ErpInventory:
slot_uri: cim:Asset.ErpInventory
range: ErpInventory
required: false
multivalued: false
FinancialInfo:
slot_uri: cim:Asset.FinancialInfo
range: FinancialInfo
required: false
multivalued: false
description: Financial information related to this asset.
Incident:
slot_uri: cim:Asset.Incident
range: Incident
required: false
multivalued: true
ReliabilityInfos:
slot_uri: cim:Asset.ReliabilityInfos
range: ReliabilityInfo
required: false
multivalued: true
Procedures:
slot_uri: cim:Asset.Procedures
range: Procedure
required: false
multivalued: true
description: All procedures applicable to this asset.
AnalyticScore:
slot_uri: cim:Asset.AnalyticScore
range: AnalyticScore
required: false
multivalued: true
description: Analytic result related to this asset.
ServiceLocation:
slot_uri: cim:Asset.ServiceLocation
range: ServiceLocation
required: false
multivalued: false
description: The sevice location at which the assets exist
Analytic:
slot_uri: cim:Asset.Analytic
range: Analytic
required: false
multivalued: true
description: Analytic performed on this asset.
OperationalTags:
slot_uri: cim:Asset.OperationalTags
range: OperationalTag
required: false
multivalued: true
description: All operational tags placed on this asset.
Ownerships:
slot_uri: cim:Asset.Ownerships
range: Ownership
required: false
multivalued: true
description: All ownerships of this asset.
WorkTasks:
slot_uri: cim:Asset.WorkTasks
range: WorkTask
required: false
multivalued: true
description: All non-replacement work tasks performed on this asset.
ErpItemMaster:
slot_uri: cim:Asset.ErpItemMaster
range: ErpItemMaster
required: false
multivalued: false
Medium:
slot_uri: cim:Asset.Medium
range: Medium
required: false
multivalued: true
description: Medium with which this asset is filled.
BreakerOperation:
slot_uri: cim:Asset.BreakerOperation
range: SwitchOperationSummary
required: false
multivalued: false
description: Breaker operation information for this breaker.
AssetGroup:
slot_uri: cim:Asset.AssetGroup
range: AssetGroup
required: false
multivalued: true
description: Asset group of which this asset is a part.
ReplacementWorkTasks:
slot_uri: cim:Asset.ReplacementWorkTasks
range: WorkTask
required: false
multivalued: true
description: All work tasks on replacement of this old asset.
ScheduledEvents:
slot_uri: cim:Asset.ScheduledEvents
range: ScheduledEvent
required: false
multivalued: true
description: Scheduled event related to this asset.
ProcedureDataSet:
slot_uri: cim:Asset.ProcedureDataSet
range: ProcedureDataSet
required: false
multivalued: true
description: Procedure data set that applies to this asset.
AcceptanceTest:
class_uri: cim:AcceptanceTest
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: "Acceptance test for assets.\r\n"
attributes:
dateTime:
slot_uri: cim:AcceptanceTest.dateTime
range: date
required: false
multivalued: false
description: "Date and time the asset was last tested using the 'type' of\
\ test and yielding the current status in 'success' attribute.\r\n"
success:
slot_uri: cim:AcceptanceTest.success
range: boolean
required: false
multivalued: false
description: True if asset has passed acceptance test and may be placed in
or is in service. It is set to false if asset is removed from service and
is required to be tested again before being placed back in service, possibly
in a new location. Since asset may go through multiple tests during its
lifecycle, the date of each acceptance test may be recorded in 'Asset.ActivityRecord.status.dateTime'.
type:
slot_uri: cim:AcceptanceTest.type
range: string
required: false
multivalued: false
description: Type of test or group of tests that was conducted on 'dateTime'.
ElectronicAddress:
class_uri: cim:ElectronicAddress
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Common
description: Electronic address information.
attributes:
email1:
slot_uri: cim:ElectronicAddress.email1
range: string
required: false
multivalued: false
description: "Primary email address.\r\n"
email2:
slot_uri: cim:ElectronicAddress.email2
range: string
required: false
multivalued: false
description: "Alternate email address.\r\n"
lan:
slot_uri: cim:ElectronicAddress.lan
range: string
required: false
multivalued: false
description: Address on local area network.
mac:
slot_uri: cim:ElectronicAddress.mac
range: string
required: false
multivalued: false
description: "MAC (Media Access Control) address.\r\n"
password:
slot_uri: cim:ElectronicAddress.password
range: string
required: false
multivalued: false
description: Password needed to log in.
radio:
slot_uri: cim:ElectronicAddress.radio
range: string
required: false
multivalued: false
description: Radio address.
userID:
slot_uri: cim:ElectronicAddress.userID
range: string
required: false
multivalued: false
description: User ID needed to log in, which can be for an individual person,
an organisation, a location, etc.
web:
slot_uri: cim:ElectronicAddress.web
range: string
required: false
multivalued: false
description: "World wide web address.\r\n"
InUseDate:
class_uri: cim:InUseDate
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: "Dates associated with asset 'in use' status. May have multiple in\
\ use dates for this device and a compound type allows a query to return multiple\
\ dates.\r\n"
attributes:
inUseDate:
slot_uri: cim:InUseDate.inUseDate
range: date
required: false
multivalued: false
description: Date asset was most recently put in use.
notReadyForUseDate:
slot_uri: cim:InUseDate.notReadyForUseDate
range: date
required: false
multivalued: false
description: Date of most recent asset transition to not ready for use state.
readyForUseDate:
slot_uri: cim:InUseDate.readyForUseDate
range: date
required: false
multivalued: false
description: Date of most recent asset transition to ready for use state.
LifecycleDate:
class_uri: cim:LifecycleDate
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: "Dates for asset lifecycle state changes. May have multiple lifecycle\
\ dates for this device and a compound type allows a query to return multiple\
\ dates.\r\n\r\n"
attributes:
installationDate:
slot_uri: cim:LifecycleDate.installationDate
range: date
required: false
multivalued: false
description: Date current installation was completed, which may not be the
same as the in-service date. Asset may have been installed at other locations
previously. Ignored if asset is (1) not currently installed (e.g., stored
in a depot) or (2) not intended to be installed (e.g., vehicle, tool).
manufacturedDate:
slot_uri: cim:LifecycleDate.manufacturedDate
range: date
required: false
multivalued: false
description: Date the asset was manufactured.
purchaseDate:
slot_uri: cim:LifecycleDate.purchaseDate
range: date
required: false
multivalued: false
description: Date the asset was purchased. Note that even though an asset
may have been purchased, it may not have been received into inventory at
the time of purchase.
receivedDate:
slot_uri: cim:LifecycleDate.receivedDate
range: date
required: false
multivalued: false
description: Date the asset was received and first placed into inventory.
removalDate:
slot_uri: cim:LifecycleDate.removalDate
range: date
required: false
multivalued: false
description: Date when the asset was last removed from service. Ignored if
(1) not intended to be in service, or (2) currently in service.
retiredDate:
slot_uri: cim:LifecycleDate.retiredDate
range: date
required: false
multivalued: false
description: Date the asset is permanently retired from service and may be
scheduled for disposal. Ignored if asset is (1) currently in service, or
(2) permanently removed from service.
Status:
class_uri: cim:Status
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Common
description: "Current status information relevant to an entity.\r\n"
attributes:
dateTime:
slot_uri: cim:Status.dateTime
range: date
required: false
multivalued: false
description: "Date and time for which status 'value' applies.\r\n"
reason:
slot_uri: cim:Status.reason
range: string
required: false
multivalued: false
description: Reason code or explanation for why an object went to the current
status 'value'.
remark:
slot_uri: cim:Status.remark
range: string
required: false
multivalued: false
description: Pertinent information regarding the current 'value', as free
form text.
value:
slot_uri: cim:Status.value
range: string
required: false
multivalued: false
description: "Status value at 'dateTime'; prior status changes may have been\
\ kept in instances of activity records associated with the object to which\
\ this status applies.\r\n"
FinancialInfo:
class_uri: cim:FinancialInfo
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: "Various current financial properties associated with a particular\
\ asset. Historical properties may be determined by ActivityRecords associated\
\ with the asset.\r\n"
attributes:
account:
slot_uri: cim:FinancialInfo.account
range: string
required: false
multivalued: false
description: The account to which this actual material item is charged.
actualPurchaseCost:
slot_uri: cim:FinancialInfo.actualPurchaseCost
range: Money
required: false
multivalued: false
description: The actual purchase cost of this particular asset.
costDescription:
slot_uri: cim:FinancialInfo.costDescription
range: string
required: false
multivalued: false
description: Description of the cost.
costType:
slot_uri: cim:FinancialInfo.costType
range: string
required: false
multivalued: false
description: "Type of cost to which this Material Item belongs.\r\n"
financialValue:
slot_uri: cim:FinancialInfo.financialValue
range: Money
required: false
multivalued: false
description: Value of asset as of 'valueDateTime'.
plantTransferDateTime:
slot_uri: cim:FinancialInfo.plantTransferDateTime
range: date
required: false
multivalued: false
description: "Date and time asset's financial value was put in plant for regulatory\
\ accounting purposes (e.g., for rate base calculations). This is sometime\
\ referred to as the \"in-service date\".\r\n"
purchaseDateTime:
slot_uri: cim:FinancialInfo.purchaseDateTime
range: date
required: false
multivalued: false
description: "Date and time asset was purchased.\r\n"
purchaseOrderNumber:
slot_uri: cim:FinancialInfo.purchaseOrderNumber
range: string
required: false
multivalued: false
description: ' Purchase order identifier.'
quantity:
slot_uri: cim:FinancialInfo.quantity
range: IntegerQuantity
required: false
multivalued: false
description: The quantity of the asset if per unit length, for example conductor.
valueDateTime:
slot_uri: cim:FinancialInfo.valueDateTime
range: date
required: false
multivalued: false
description: "Date and time at which the financial value was last established.\r\
\n"
warrantyEndDateTime:
slot_uri: cim:FinancialInfo.warrantyEndDateTime
range: date
required: false
multivalued: false
description: "Date and time warranty on asset expires.\r\n"
Asset:
slot_uri: cim:FinancialInfo.Asset
range: Asset
required: false
multivalued: false
description: The asset to which this financial information relates.
Incident:
class_uri: cim:Incident
is_a: Document
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Operations
description: Description of a problem in the field that may be reported in a trouble
ticket or come from another source. It may have to do with an outage.
attributes:
cause:
slot_uri: cim:Incident.cause
range: string
required: false
multivalued: false
description: Cause of this incident.
Asset:
slot_uri: cim:Incident.Asset
range: Asset
required: false
multivalued: true
Works:
slot_uri: cim:Incident.Works
range: Work
required: false
multivalued: true
description: All works addressing this incident.
IncidentHazard:
slot_uri: cim:Incident.IncidentHazard
range: IncidentHazard
required: false
multivalued: true
description: All hazards associated with this incident.
Outage:
slot_uri: cim:Incident.Outage
range: Outage
required: false
multivalued: false
description: Outage for this incident.
Location:
slot_uri: cim:Incident.Location
range: Location
required: false
multivalued: false
description: Location of this incident.
Owner:
slot_uri: cim:Incident.Owner
range: Operator
required: false
multivalued: false
description: Operator who owns this incident.
CustomerNotifications:
slot_uri: cim:Incident.CustomerNotifications
range: CustomerNotification
required: false
multivalued: true
description: All notifications for a customer related to the status change
of this incident.
UnplannedOutage:
slot_uri: cim:Incident.UnplannedOutage
range: UnplannedOutage
required: false
multivalued: false
description: The unplanned outage that may be associated with the incidents.
TroubleOrder:
slot_uri: cim:Incident.TroubleOrder
range: TroubleOrder
required: false
multivalued: false
description: The trouble order that is associated to the incident
TroubleTickets:
slot_uri: cim:Incident.TroubleTickets
range: TroubleTicket
required: false
multivalued: true
description: All trouble tickets reporting this incident.
Hazard:
slot_uri: cim:Incident.Hazard
range: Hazard
required: false
multivalued: true
Document:
class_uri: cim:Document
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Common
description: Parent class for different groupings of information collected and
managed as a part of a business process. It will frequently contain references
to other objects, such as assets, people and power system resources.
attributes:
authorName:
slot_uri: cim:Document.authorName
range: string
required: false
multivalued: false
description: Name of the author of this document.
comment:
slot_uri: cim:Document.comment
range: string
required: false
multivalued: false
description: Free text comment.
createdDateTime:
slot_uri: cim:Document.createdDateTime
range: date
required: false
multivalued: false
description: "Date and time that this document was created.\r\n"
docStatus:
slot_uri: cim:Document.docStatus
range: Status
required: false
multivalued: false
description: "Status of this document. For status of subject matter this document\
\ represents (e.g., Agreement, Work), use 'status' attribute.\r\nExample\
\ values for 'docStatus.status' are draft, approved, cancelled, etc."
electronicAddress:
slot_uri: cim:Document.electronicAddress
range: ElectronicAddress
required: false
multivalued: false
description: Electronic address.
lastModifiedDateTime:
slot_uri: cim:Document.lastModifiedDateTime
range: date
required: false
multivalued: false
description: "Date and time this document was last modified. Documents may\
\ potentially be modified many times during their lifetime.\r\n"
revisionNumber:
slot_uri: cim:Document.revisionNumber
range: string
required: false
multivalued: false
description: Revision number for this document.
status:
slot_uri: cim:Document.status
range: Status
required: false
multivalued: false
description: Status of subject matter (e.g., Agreement, Work) this document
represents. For status of the document itself, use 'docStatus' attribute.
subject:
slot_uri: cim:Document.subject
range: string
required: false
multivalued: false
description: Document subject.
title:
slot_uri: cim:Document.title
range: string
required: false
multivalued: false
description: Document title.
type:
slot_uri: cim:Document.type
range: string
required: false
multivalued: false
description: Utility-specific classification of this document, according to
its corporate standards, practices, and existing IT systems (e.g., for management
of assets, maintenance, work, outage, customers, etc.).
ActivityRecord:
slot_uri: cim:Document.ActivityRecord
range: ActivityRecord
required: false
multivalued: true
description: The activity record for a document
ConfigurationEvents:
slot_uri: cim:Document.ConfigurationEvents
range: ConfigurationEvent
required: false
multivalued: true
description: All configuration events created for this document.
Author:
slot_uri: cim:Document.Author
range: Author
required: false
multivalued: false
description: Author of this document.
Editor:
slot_uri: cim:Document.Editor
range: Editor
required: false
multivalued: false
description: Editor of this document.
Approver:
slot_uri: cim:Document.Approver
range: Approver
required: false
multivalued: false
description: Approver of this document.
Issuer:
slot_uri: cim:Document.Issuer
range: Issuer
required: false
multivalued: false
description: Issuer of this document.
Author:
class_uri: cim:Author
is_a: DocumentPersonRole
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Common
description: Person who created document or activity record.
attributes:
Documents:
slot_uri: cim:Author.Documents
range: Document
required: false
multivalued: true
description: All documents of this this author.
ActivityRecords:
slot_uri: cim:Author.ActivityRecords
range: ActivityRecord
required: false
multivalued: true
description: All activity records with this author.
DocumentPersonRole:
class_uri: cim:DocumentPersonRole
is_a: PersonRole
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Common
description: Person role with respect to documents.
PersonRole:
class_uri: cim:PersonRole
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Common
attributes:
ConfigurationEvents:
slot_uri: cim:PersonRole.ConfigurationEvents
range: ConfigurationEvent
required: false
multivalued: true
description: All configuration events created for this person role.
Appointments:
slot_uri: cim:PersonRole.Appointments
range: Appointment
required: false
multivalued: true
description: All appointments for this person.
Person:
slot_uri: cim:PersonRole.Person
range: Person
required: false
multivalued: false
description: Person having this role.
Person:
class_uri: cim:Person
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Common
description: General purpose information for name and other information to contact
people.
attributes:
electronicAddress:
slot_uri: cim:Person.electronicAddress
range: ElectronicAddress
required: false
multivalued: false
description: Electronic address.
firstName:
slot_uri: cim:Person.firstName
range: string
required: false
multivalued: false
description: Person's first name.
landlinePhone:
slot_uri: cim:Person.landlinePhone
range: TelephoneNumber
required: false
multivalued: false
description: Landline phone number.
lastName:
slot_uri: cim:Person.lastName
range: string
required: false
multivalued: false
description: ' Person''s last (family, sir) name.'
mName:
slot_uri: cim:Person.mName
range: string
required: false
multivalued: false
description: ' Middle name(s) or initial(s).'
mobilePhone:
slot_uri: cim:Person.mobilePhone
range: TelephoneNumber
required: false
multivalued: false
description: Mobile phone number.
prefix:
slot_uri: cim:Person.prefix
range: string
required: false
multivalued: false
description: A prefix or title for the person's name, such as Miss, Mister,
Doctor, etc.
specialNeed:
slot_uri: cim:Person.specialNeed
range: string
required: false
multivalued: false
description: Special service needs for the person (contact) are described;
examples include life support, etc.
suffix:
slot_uri: cim:Person.suffix
range: string
required: false
multivalued: false
description: A suffix for the person's name, such as II, III, etc.
Roles:
slot_uri: cim:Person.Roles
range: PersonRole
required: false
multivalued: true
description: All roles of this person.
Customer:
slot_uri: cim:Person.Customer
range: Customer
required: false
multivalued: true
description: The customer represented by the person
TelephoneNumber:
class_uri: cim:TelephoneNumber
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Common
description: Telephone number.
attributes:
areaCode:
slot_uri: cim:TelephoneNumber.areaCode
range: string
required: false
multivalued: false
description: (if applicable) Area or region code.
cityCode:
slot_uri: cim:TelephoneNumber.cityCode
range: string
required: false
multivalued: false
description: City code.
countryCode:
slot_uri: cim:TelephoneNumber.countryCode
range: string
required: false
multivalued: false
description: Country code.
dialOut:
slot_uri: cim:TelephoneNumber.dialOut
range: string
required: false
multivalued: false
description: (if applicable) Dial out code, for instance to call outside an
enterprise.
extension:
slot_uri: cim:TelephoneNumber.extension
range: string
required: false
multivalued: false
description: (if applicable) Extension for this telephone number.
internationalPrefix:
slot_uri: cim:TelephoneNumber.internationalPrefix
range: string
required: false
multivalued: false
description: (if applicable) Prefix used when calling an international number.
ituPhone:
slot_uri: cim:TelephoneNumber.ituPhone
range: string
required: false
multivalued: false
description: Phone number according to International Telecommunication Union
(ITU) E.164.
localNumber:
slot_uri: cim:TelephoneNumber.localNumber
range: string
required: false
multivalued: false
description: Main (local) part of this telephone number.
Customer:
class_uri: cim:Customer
is_a: OrganisationRole
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Customers
description: Organisation receiving services from service supplier.
attributes:
kind:
slot_uri: cim:Customer.kind
range: CustomerKind
required: false
multivalued: false
description: Kind of customer.
locale:
slot_uri: cim:Customer.locale
range: string
required: false
multivalued: false
description: Locale designating language to use in communications with this
customer.
priority:
slot_uri: cim:Customer.priority
range: Priority
required: false
multivalued: false
description: Priority of the customer.
pucNumber:
slot_uri: cim:Customer.pucNumber
range: string
required: false
multivalued: false
description: (if applicable) Public utilities commission (PUC) identification
number.
specialNeed:
slot_uri: cim:Customer.specialNeed
range: string
required: false
multivalued: false
description: True if customer organisation has special service needs such
as life support, hospitals, etc.
status:
slot_uri: cim:Customer.status
range: Status
required: false
multivalued: false
description: Status of this customer.
vip:
slot_uri: cim:Customer.vip
range: boolean
required: false
multivalued: false
description: (deprecated) (use 'priority' instead) True if this is an important
customer. Importance is for matters different than those in 'specialNeed'
attribute.
Works:
slot_uri: cim:Customer.Works
range: Work
required: false
multivalued: true
description: All the works performed for this customer.
ErpPersons:
slot_uri: cim:Customer.ErpPersons
range: OldPerson
required: false
multivalued: true
CustomerAgreements:
slot_uri: cim:Customer.CustomerAgreements
range: CustomerAgreement
required: false
multivalued: true
description: All agreements of this customer.
CustomerAccounts:
slot_uri: cim:Customer.CustomerAccounts
range: CustomerAccount
required: false
multivalued: true
description: All accounts of this customer.
OutagePlan:
slot_uri: cim:Customer.OutagePlan
range: OutagePlan
required: false
multivalued: false
description: The outage plan that identifies the customers that are affected.
Person:
slot_uri: cim:Customer.Person
range: Person
required: false
multivalued: true
description: The person representing the customer
Customer:
slot_uri: cim:Customer.Customer
range: Customer
required: false
multivalued: false
description: The primary customer that manages the account(s).
EndDevices:
slot_uri: cim:Customer.EndDevices
range: EndDevice
required: false
multivalued: true
description: All end devices of this customer.
CustomerNotifications:
slot_uri: cim:Customer.CustomerNotifications
range: CustomerNotification
required: false
multivalued: true
description: All notifications required by this customer.
ServiceRequest:
slot_uri: cim:Customer.ServiceRequest
range: ServiceRequest
required: false
multivalued: true
description: All service requests for the customer
PlannedOutageNotification:
slot_uri: cim:Customer.PlannedOutageNotification
range: PlannedOutageNotification
required: false
multivalued: true
description: The notification of the planned outage
TroubleTickets:
slot_uri: cim:Customer.TroubleTickets
range: TroubleTicket
required: false
multivalued: true
description: All trouble tickets for this customer.
OrganisationRole:
class_uri: cim:OrganisationRole
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Common
description: "Identifies a way in which an organisation may participate in the\
\ utility enterprise (e.g., customer, manufacturer, etc).\r\n"
attributes:
Organisation:
slot_uri: cim:OrganisationRole.Organisation
range: Organisation
required: false
multivalued: false
description: Organisation having this role.
ConfigurationEvents:
slot_uri: cim:OrganisationRole.ConfigurationEvents
range: ConfigurationEvent
required: false
multivalued: true
description: All configuration events created for this organisation role.
Organisation:
class_uri: cim:Organisation
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Common
description: Organisation that might have roles as utility, contractor, supplier,
manufacturer, customer, etc.
attributes:
electronicAddress:
slot_uri: cim:Organisation.electronicAddress
range: ElectronicAddress
required: false
multivalued: false
description: Electronic address.
phone1:
slot_uri: cim:Organisation.phone1
range: TelephoneNumber
required: false
multivalued: false
description: Phone number.
phone2:
slot_uri: cim:Organisation.phone2
range: TelephoneNumber
required: false
multivalued: false
description: Additional phone number.
postalAddress:
slot_uri: cim:Organisation.postalAddress
range: StreetAddress
required: false
multivalued: false
description: Postal address, potentially different than 'streetAddress' (e.g.,
another city).
streetAddress:
slot_uri: cim:Organisation.streetAddress
range: StreetAddress
required: false
multivalued: false
description: Street address.
ParentOrganisation:
slot_uri: cim:Organisation.ParentOrganisation
range: ParentOrganization
required: false
multivalued: false
description: Parent organisation of this organisation.
Roles:
slot_uri: cim:Organisation.Roles
range: OrganisationRole
required: false
multivalued: true
description: All roles of this organisation.
SwitchingPlanRequest:
slot_uri: cim:Organisation.SwitchingPlanRequest
range: SwitchingPlanRequest
required: false
multivalued: true
description: The switching plan requested by the requesting organization
StreetAddress:
class_uri: cim:StreetAddress
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Common
description: General purpose street and postal address information.
attributes:
language:
slot_uri: cim:StreetAddress.language
range: string
required: false
multivalued: false
description: The language in which the address is specified, using ISO 639-1
two digit language code.
poBox:
slot_uri: cim:StreetAddress.poBox
range: string
required: false
multivalued: false
description: Post office box.
postalCode:
slot_uri: cim:StreetAddress.postalCode
range: string
required: false
multivalued: false
description: Postal code for the address.
status:
slot_uri: cim:StreetAddress.status
range: Status
required: false
multivalued: false
description: Status of this address.
streetDetail:
slot_uri: cim:StreetAddress.streetDetail
range: StreetDetail
required: false
multivalued: false
description: Street detail.
townDetail:
slot_uri: cim:StreetAddress.townDetail
range: TownDetail
required: false
multivalued: false
description: Town detail.
StreetDetail:
class_uri: cim:StreetDetail
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Common
description: "Street details, in the context of address.\r\n"
attributes:
addressGeneral:
slot_uri: cim:StreetDetail.addressGeneral
range: string
required: false
multivalued: false
description: First line of a free form address or some additional address
information (for example a mail stop).
addressGeneral2:
slot_uri: cim:StreetDetail.addressGeneral2
range: string
required: false
multivalued: false
description: (if applicable) Second line of a free form address.
addressGeneral3:
slot_uri: cim:StreetDetail.addressGeneral3
range: string
required: false
multivalued: false
description: (if applicable) Third line of a free form address.
buildingName:
slot_uri: cim:StreetDetail.buildingName
range: string
required: false
multivalued: false
description: (if applicable) In certain cases the physical location of the
place of interest does not have a direct point of entry from the street,
but may be located inside a larger structure such as a building, complex,
office block, apartment, etc.
code:
slot_uri: cim:StreetDetail.code
range: string
required: false
multivalued: false
description: (if applicable) Utilities often make use of external reference
systems, such as those of the town-planner's department or surveyor general's
mapping system, that allocate global reference codes to streets.
floorIdentification:
slot_uri: cim:StreetDetail.floorIdentification
range: string
required: false
multivalued: false
description: The identification by name or number, expressed as text, of the
floor in the building as part of this address.
name:
slot_uri: cim:StreetDetail.name
range: string
required: false
multivalued: false
description: Name of the street.
number:
slot_uri: cim:StreetDetail.number
range: string
required: false
multivalued: false
description: Designator of the specific location on the street.
prefix:
slot_uri: cim:StreetDetail.prefix
range: string
required: false
multivalued: false
description: 'Prefix to the street name. For example: North, South, East,
West.'
suffix:
slot_uri: cim:StreetDetail.suffix
range: string
required: false
multivalued: false
description: 'Suffix to the street name. For example: North, South, East,
West.'
suiteNumber:
slot_uri: cim:StreetDetail.suiteNumber
range: string
required: false
multivalued: false
description: Number of the apartment or suite.
type:
slot_uri: cim:StreetDetail.type
range: string
required: false
multivalued: false
description: 'Type of street. Examples include: street, circle, boulevard,
avenue, road, drive, etc.'
withinTownLimits:
slot_uri: cim:StreetDetail.withinTownLimits
range: boolean
required: false
multivalued: false
description: True if this street is within the legal geographical boundaries
of the specified town (default).
TownDetail:
class_uri: cim:TownDetail
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Common
description: "Town details, in the context of address.\r\n"
attributes:
code:
slot_uri: cim:TownDetail.code
range: string
required: false
multivalued: false
description: Town code.
country:
slot_uri: cim:TownDetail.country
range: string
required: false
multivalued: false
description: Name of the country.
name:
slot_uri: cim:TownDetail.name
range: string
required: false
multivalued: false
description: Town name.
section:
slot_uri: cim:TownDetail.section
range: string
required: false
multivalued: false
description: Town section. For example, it is common for there to be 36 sections
per township.
stateOrProvince:
slot_uri: cim:TownDetail.stateOrProvince
range: string
required: false
multivalued: false
description: Name of the state or province.
SwitchingPlanRequest:
class_uri: cim:SwitchingPlanRequest
is_a: Document
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Operations
description: A document used to request that a switching plan be created for a
particular purpose.
attributes:
comment:
slot_uri: cim:SwitchingPlanRequest.comment
range: string
required: false
multivalued: false
description: "Free-form text to describe the request\r\n"
equipmentToBeIsolated:
slot_uri: cim:SwitchingPlanRequest.equipmentToBeIsolated
range: string
required: false
multivalued: false
description: free-form list of the equipment to be isolated by the switching
forwardSwitchingDateTimeInterval:
slot_uri: cim:SwitchingPlanRequest.forwardSwitchingDateTimeInterval
range: DateTimeInterval
required: true
multivalued: false
description: The date when the switching to isolate equipment is performed.
groundingPoints:
slot_uri: cim:SwitchingPlanRequest.groundingPoints
range: string
required: false
multivalued: false
description: free-form list of equipment to be grounded or other actions to
be taken in order to accomplish the required grounding.
isolationArea:
slot_uri: cim:SwitchingPlanRequest.isolationArea
range: string
required: false
multivalued: false
description: "free-form description of the area to be isolated by the switching\r\
\n"
isolationPoints:
slot_uri: cim:SwitchingPlanRequest.isolationPoints
range: string
required: false
multivalued: false
description: 'free-form list of equipment to be operated or other actions
to be taken in order to accomplish the required isolation. '
outageDateTimeInterval:
slot_uri: cim:SwitchingPlanRequest.outageDateTimeInterval
range: DateTimeInterval
required: false
multivalued: false
description: "The window of time during which one or more customers will be\
\ de-energized during execution of the switching plan.\r\n"
purpose:
slot_uri: cim:SwitchingPlanRequest.purpose
range: string
required: true
multivalued: false
description: The purpose of this switching plan request.
reverseSwitchingDateTimeInterval:
slot_uri: cim:SwitchingPlanRequest.reverseSwitchingDateTimeInterval
range: DateTimeInterval
required: true
multivalued: false
description: The date when the switching to energize equipment is performed.
switchingRequestDetails:
slot_uri: cim:SwitchingPlanRequest.switchingRequestDetails
range: string
required: true
multivalued: false
description: The details of this switching plan request.
SwitchingPlan:
slot_uri: cim:SwitchingPlanRequest.SwitchingPlan
range: SwitchingPlan
required: false
multivalued: true
description: The switching plan for the request.
RequestingOrganization:
slot_uri: cim:SwitchingPlanRequest.RequestingOrganization
range: Organisation
required: false
multivalued: false
description: The organization that requested the switching plan.
SwitchingPlan:
class_uri: cim:SwitchingPlan
is_a: Document
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Operations
description: "A sequence of grouped or atomic steps intended to:\r\n- de-energise\
\ equipment or part of the network for safe work, and/or\r\n- bring back in\
\ service previously de-energised equipment or part of the network."
attributes:
approvedDateTime:
slot_uri: cim:SwitchingPlan.approvedDateTime
range: date
required: false
multivalued: false
description: The date and time the switching plan was approved
cancelledDateTime:
slot_uri: cim:SwitchingPlan.cancelledDateTime
range: date
required: false
multivalued: false
description: Date and Time the switching plan was cancelled.
plannedPeriod:
slot_uri: cim:SwitchingPlan.plannedPeriod
range: DateTimeInterval
required: false
multivalued: false
description: the planned start and end times for the switching plan.
purpose:
slot_uri: cim:SwitchingPlan.purpose
range: string
required: false
multivalued: false
description: Purpose of this plan, such as whether it is to move the state
from normal to some abnormal condition, or to restore the normal state after
an abnormal condition, or to perform some kind of optimisation such as correction
of overload, voltage control, etc.
rank:
slot_uri: cim:SwitchingPlan.rank
range: integer
required: false
multivalued: false
description: Ranking in comparison to other switching plans.
WorkTasks:
slot_uri: cim:SwitchingPlan.WorkTasks
range: WorkTask
required: false
multivalued: true
description: All work tasks to execute this switching plan.
OutagePlan:
slot_uri: cim:SwitchingPlan.OutagePlan
range: OutagePlan
required: false
multivalued: false
description: The outage plan for which the switching plan is defined.
SafetyDocuments:
slot_uri: cim:SwitchingPlan.SafetyDocuments
range: SafetyDocument
required: false
multivalued: true
description: All safety documents applicable to this swtiching plan.
SwitchingStepGroups:
slot_uri: cim:SwitchingPlan.SwitchingStepGroups
range: SwitchingStepGroup
required: false
multivalued: true
description: All groups of switching steps within this switching plan.
Outage:
slot_uri: cim:SwitchingPlan.Outage
range: Outage
required: false
multivalued: false
description: Outage that will be activated or eliminated when this switching
plan gets executed.
SwitchingOrder:
slot_uri: cim:SwitchingPlan.SwitchingOrder
range: SwitchingOrder
required: false
multivalued: false
description: The switching order that specified the switching plan to be implemented.
SwitchingAction:
slot_uri: cim:SwitchingPlan.SwitchingAction
range: SwitchingAction
required: false
multivalued: true
description: The switching actions that are associated with the switching
plan.
SwitchingPlanRequest:
slot_uri: cim:SwitchingPlan.SwitchingPlanRequest
range: SwitchingPlanRequest
required: false
multivalued: false
description: The request for the specified switching plan.
PlannedOutageNotification:
slot_uri: cim:SwitchingPlan.PlannedOutageNotification
range: PlannedOutageNotification
required: false
multivalued: false
description: The planned outage notification that is associated to the switching
plan.
SwitchingOrder:
class_uri: cim:SwitchingOrder
is_a: Document
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Operations
description: Transmits a switching plan to a crew in order for the plan to be
executed.
attributes:
comment:
slot_uri: cim:SwitchingOrder.comment
range: string
required: false
multivalued: false
description: Free-form comment associated with the switching order.
plannedExecutionInterval:
slot_uri: cim:SwitchingOrder.plannedExecutionInterval
range: DateTimeInterval
required: false
multivalued: false
description: 'The planned start and end time for the switching order. '
SwitchingPlan:
slot_uri: cim:SwitchingOrder.SwitchingPlan
range: SwitchingPlan
required: false
multivalued: false
description: The switching plan that is defined in the switching order.
Location:
slot_uri: cim:SwitchingOrder.Location
range: Location
required: false
multivalued: true
description: Location of this switching order.
Location:
class_uri: cim:Location
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Common
description: "The place, scene, or point of something where someone or something\
\ has been, is, and/or will be at a given moment in time. It can be defined\
\ with one or more position points (coordinates) in a given coordinate system.\r\
\n"
attributes:
direction:
slot_uri: cim:Location.direction
range: string
required: false
multivalued: false
description: "(if applicable) Direction that allows field crews to quickly\
\ find a given asset. For a given location, such as a street address, this\
\ is the relative direction in which to find the asset. For example, a streetlight\
\ may be located at the 'NW' (northwest) corner of the customer's site,\
\ or a usage point may be located on the second floor of an apartment building.\r\
\n"
electronicAddress:
slot_uri: cim:Location.electronicAddress
range: ElectronicAddress
required: false
multivalued: false
description: Electronic address.
geoInfoReference:
slot_uri: cim:Location.geoInfoReference
range: string
required: false
multivalued: false
description: (if applicable) Reference to geographical information source,
often external to the utility.
mainAddress:
slot_uri: cim:Location.mainAddress
range: StreetAddress
required: false
multivalued: false
description: Main address of the location.
phone1:
slot_uri: cim:Location.phone1
range: TelephoneNumber
required: false
multivalued: false
description: Phone number.
phone2:
slot_uri: cim:Location.phone2
range: TelephoneNumber
required: false
multivalued: false
description: Additional phone number.
secondaryAddress:
slot_uri: cim:Location.secondaryAddress
range: StreetAddress
required: false
multivalued: false
description: Secondary address of the location. For example, PO Box address
may have different ZIP code than that in the 'mainAddress'.
status:
slot_uri: cim:Location.status
range: Status
required: false
multivalued: false
description: Status of this location.
type:
slot_uri: cim:Location.type
range: string
required: false
multivalued: false
description: "Classification by utility's corporate standards and practices,\
\ relative to the location itself (e.g., geographical, functional accounting,\
\ etc., not a given property that happens to exist at that location).\r\n"
ConfigurationEvents:
slot_uri: cim:Location.ConfigurationEvents
range: ConfigurationEvent
required: false
multivalued: true
description: All configuration events created for this location.
SwitchingOrder:
slot_uri: cim:Location.SwitchingOrder
range: SwitchingOrder
required: false
multivalued: false
description: The switching order at this location.
Crew:
slot_uri: cim:Location.Crew
range: Crew
required: false
multivalued: true
description: The crew that is assigned to this locaton.
PowerSystemResources:
slot_uri: cim:Location.PowerSystemResources
range: PowerSystemResource
required: false
multivalued: true
description: All power system resources at this location.
CoordinateSystem:
slot_uri: cim:Location.CoordinateSystem
range: CoordinateSystem
required: false
multivalued: false
description: Coordinate system used to describe position points of this location.
PositionPoints:
slot_uri: cim:Location.PositionPoints
range: PositionPoint
required: false
multivalued: true
description: Sequence of position points describing this location, expressed
in coordinate system 'Location.CoordinateSystem'.
Measurements:
slot_uri: cim:Location.Measurements
range: Measurement
required: false
multivalued: true
description: All measurements at this location.
Assets:
slot_uri: cim:Location.Assets
range: Asset
required: false
multivalued: true
description: All assets at this location.
TroubleOrder:
slot_uri: cim:Location.TroubleOrder
range: TroubleOrder
required: false
multivalued: false
description: The trouble order at this location
OutageOrder:
slot_uri: cim:Location.OutageOrder
range: OutageOrder
required: false
multivalued: false
description: The outage order at this location.
Fault:
slot_uri: cim:Location.Fault
range: Fault
required: false
multivalued: true
description: All faults at this location.
Incident:
slot_uri: cim:Location.Incident
range: Incident
required: false
multivalued: false
description: Incident at this location.
Crews:
slot_uri: cim:Location.Crews
range: OldCrew
required: false
multivalued: true
Hazards:
slot_uri: cim:Location.Hazards
range: AssetLocationHazard
required: false
multivalued: true
description: All asset hazards at this location.
LandProperties:
slot_uri: cim:Location.LandProperties
range: LandProperty
required: false
multivalued: true
Routes:
slot_uri: cim:Location.Routes
range: Route
required: false
multivalued: true
TroubleTicket:
slot_uri: cim:Location.TroubleTicket
range: TroubleTicket
required: false
multivalued: false
EnvironmentalLocationKind:
slot_uri: cim:Location.EnvironmentalLocationKind
range: EnvironmentalLocationType
required: false
multivalued: true
description: Kind of environmental location which this location is.
EnvironmentalMonitoringStation:
slot_uri: cim:Location.EnvironmentalMonitoringStation
range: EnvironmentalMonitoringStation
required: false
multivalued: true
description: Monitoring station located at this location.
TroubleOrder:
class_uri: cim:TroubleOrder
is_a: Document
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Operations
description: Trouble order sends an incident to a crew to initiate a response
to an unplanned outage.
attributes:
comment:
slot_uri: cim:TroubleOrder.comment
range: string
required: true
multivalued: false
description: Free-form comment associated with the trouble order.
plannedExecutionInterval:
slot_uri: cim:TroubleOrder.plannedExecutionInterval
range: DateTimeInterval
required: false
multivalued: false
description: 'The planned start and end time for the trouble order. '
Location:
slot_uri: cim:TroubleOrder.Location
range: Location
required: false
multivalued: false
description: The location of this trouble order
Incident:
slot_uri: cim:TroubleOrder.Incident
range: Incident
required: false
multivalued: false
description: The incident that may be associated with the trouble order.
TroubleTicket:
slot_uri: cim:TroubleOrder.TroubleTicket
range: TroubleTicket
required: false
multivalued: true
description: The ticket called in by the customer that describes the trouble
WorkTask:
slot_uri: cim:TroubleOrder.WorkTask
range: WorkTask
required: false
multivalued: true
description: The work tasks that are associated with this trouble order.
UnplannedOutage:
slot_uri: cim:TroubleOrder.UnplannedOutage
range: UnplannedOutage
required: false
multivalued: false
description: The unplanned outage that is associated to the Trouble Order.
WorkTask:
class_uri: cim:WorkTask
is_a: BaseWork
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Work
description: A task within a set of work.
attributes:
completedDateTime:
slot_uri: cim:WorkTask.completedDateTime
range: date
required: false
multivalued: false
description: Date and time work task was completed.
contractorCost:
slot_uri: cim:WorkTask.contractorCost
range: Money
required: false
multivalued: false
description: Total contractor costs associated with the work task.
crewETA:
slot_uri: cim:WorkTask.crewETA
range: date
required: false
multivalued: false
description: Estimated time of arrival, so that customer or police/fire department
can be informed when the crew will arrive.
estimatedCompletionTime:
slot_uri: cim:WorkTask.estimatedCompletionTime
range: date
required: false
multivalued: false
description: Time and Date when the work task will be completed.
instruction:
slot_uri: cim:WorkTask.instruction
range: string
required: false
multivalued: false
description: Instructions for performing this task.
laborCost:
slot_uri: cim:WorkTask.laborCost
range: Money
required: false
multivalued: false
description: Total labor costs associated with the work task.
laborHours:
slot_uri: cim:WorkTask.laborHours
range: Hours
required: false
multivalued: false
description: Hours of labor expended under work task.
materiallCost:
slot_uri: cim:WorkTask.materiallCost
range: Money
required: false
multivalued: false
description: Total material costs associated with the work task.
schedOverride:
slot_uri: cim:WorkTask.schedOverride
range: string
required: false
multivalued: false
description: If specified, override schedule and perform this task in accordance
with instructions specified here.
startedDateTime:
slot_uri: cim:WorkTask.startedDateTime
range: date
required: false
multivalued: false
description: Date and time work task was started.
taskKind:
slot_uri: cim:WorkTask.taskKind
range: WorkTaskKind
required: false
multivalued: false
description: Kind of work.
toolCost:
slot_uri: cim:WorkTask.toolCost
range: Money
required: false
multivalued: false
description: Total tool costs associated with the work task.
TroubleOrder:
slot_uri: cim:WorkTask.TroubleOrder
range: TroubleOrder
required: false
multivalued: false
description: The trouble order that contains the work tasks.
Assets:
slot_uri: cim:WorkTask.Assets
range: Asset
required: false
multivalued: true
description: All assets on which this non-replacement work task is performed.
MaterialItems:
slot_uri: cim:WorkTask.MaterialItems
range: MaterialItem
required: false
multivalued: true
description: The material items that are required to perform the work task.
Crews:
slot_uri: cim:WorkTask.Crews
range: Crew
required: false
multivalued: true
description: All crews participating in this work task.
OldAsset:
slot_uri: cim:WorkTask.OldAsset
range: Asset
required: false
multivalued: true
description: Old asset replaced by this work task.
SwitchingPlan:
slot_uri: cim:WorkTask.SwitchingPlan
range: SwitchingPlan
required: false
multivalued: false
description: Switching plan executed by this work task.
ProcedureDataSet:
slot_uri: cim:WorkTask.ProcedureDataSet
range: ProcedureDataSet
required: false
multivalued: true
description: Procedure data set associated with this work task.
Work:
slot_uri: cim:WorkTask.Work
range: Work
required: true
multivalued: false
description: Work this task belongs to.
BaseWork:
class_uri: cim:BaseWork
is_a: Document
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Work
description: Common representation for work and work tasks.
attributes:
kind:
slot_uri: cim:BaseWork.kind
range: ServiceRequestKind
required: false
multivalued: false
description: Kind of work.
priority:
slot_uri: cim:BaseWork.priority
range: Priority
required: false
multivalued: false
description: Priority of work.
statusKind:
slot_uri: cim:BaseWork.statusKind
range: WorkStatusKind
required: false
multivalued: false
description: Kind of work status.
TimeSchedules:
slot_uri: cim:BaseWork.TimeSchedules
range: WorkTimeSchedule
required: false
multivalued: true
description: All time schedules for this work or work task.
WorkLocation:
slot_uri: cim:BaseWork.WorkLocation
range: WorkLocation
required: false
multivalued: false
description: Location for this work/task.
WorkActivityRecords:
slot_uri: cim:BaseWork.WorkActivityRecords
range: WorkActivityRecord
required: false
multivalued: true
description: All activity records for this work or work task.
Priority:
class_uri: cim:Priority
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Common
description: Priority definition.
attributes:
justification:
slot_uri: cim:Priority.justification
range: string
required: false
multivalued: false
description: Justification for 'rank'.
rank:
slot_uri: cim:Priority.rank
range: integer
required: false
multivalued: false
description: Priority level; lower number means high priority inside the same
'type'.
type:
slot_uri: cim:Priority.type
range: string
required: false
multivalued: false
description: Type describing 'rank'; e.g., high, emergency, etc.
WorkTimeSchedule:
class_uri: cim:WorkTimeSchedule
is_a: TimeSchedule
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Work
description: Time schedule specific to work.
attributes:
kind:
slot_uri: cim:WorkTimeSchedule.kind
range: WorkTimeScheduleKind
required: false
multivalued: false
description: Kind of this work schedule.
BaseWork:
slot_uri: cim:WorkTimeSchedule.BaseWork
range: BaseWork
required: false
multivalued: false
description: Time schedule for this work or work task.
ServiceRequest:
slot_uri: cim:WorkTimeSchedule.ServiceRequest
range: ServiceRequest
required: false
multivalued: false
description: The service request for which the work time schedule exists
TimeSchedule:
class_uri: cim:TimeSchedule
is_a: Document
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Common
description: "Description of anything that changes through time. Time schedule\
\ is used to perform a single-valued function of time. Use inherited 'type'\
\ attribute to give additional information on this schedule, such as: periodic\
\ (hourly, daily, weekly, monthly, etc.), day of the month, by date, calendar\
\ (specific times and dates).\r\n"
attributes:
disabled:
slot_uri: cim:TimeSchedule.disabled
range: boolean
required: false
multivalued: false
description: True if this schedule is deactivated (disabled).
offset:
slot_uri: cim:TimeSchedule.offset
range: Seconds
required: false
multivalued: false
description: The offset from midnight (i.e., 0 h, 0 min, 0 s) for the periodic
time points to begin. For example, for an interval meter that is set up
for five minute intervals ('recurrencePeriod'=300=5 min), setting 'offset'=120=2
min would result in scheduled events to read the meter executing at 2 min,
7 min, 12 min, 17 min, 22 min, 27 min, 32 min, 37 min, 42 min, 47 min, 52
min, and 57 min past each hour.
recurrencePattern:
slot_uri: cim:TimeSchedule.recurrencePattern
range: string
required: false
multivalued: false
description: Interval at which the scheduled action repeats (e.g., first Monday
of every month, last day of the month, etc.).
recurrencePeriod:
slot_uri: cim:TimeSchedule.recurrencePeriod
range: Seconds
required: false
multivalued: false
description: Duration between time points, from the beginning of one period
to the beginning of the next period. Note that a device like a meter may
have multiple interval periods (e.g., 1 min, 5 min, 15 min, 30 min, or 60
min).
scheduleInterval:
slot_uri: cim:TimeSchedule.scheduleInterval
range: DateTimeInterval
required: false
multivalued: false
description: Schedule date and time interval.
TimePoints:
slot_uri: cim:TimeSchedule.TimePoints
range: TimePoint
required: false
multivalued: true
description: Sequence of time points belonging to this time schedule.
MeterReadSchedule:
slot_uri: cim:TimeSchedule.MeterReadSchedule
range: MeterReadSchedule
required: false
multivalued: false
description: Meter read schedule for which the time schedule applies
MeterReadSchedule:
class_uri: cim:MeterReadSchedule
is_a: Document
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
attributes:
UsagePoint:
slot_uri: cim:MeterReadSchedule.UsagePoint
range: UsagePoint
required: false
multivalued: true
description: All usage points for the meter read schedule.
EndDeviceGroup:
slot_uri: cim:MeterReadSchedule.EndDeviceGroup
range: EndDeviceGroup
required: false
multivalued: true
description: All end device groups for the meter read schedule.
ReadingType:
slot_uri: cim:MeterReadSchedule.ReadingType
range: ReadingType
required: false
multivalued: true
description: All reading types for the meter read schedule.
UsagePointGroup:
slot_uri: cim:MeterReadSchedule.UsagePointGroup
range: UsagePointGroup
required: false
multivalued: true
description: All usage point groups for the meter read schedule.
TimeSchedule:
slot_uri: cim:MeterReadSchedule.TimeSchedule
range: TimeSchedule
required: false
multivalued: true
description: All time schedules for the meter read schedule.
CustomerAgreement:
slot_uri: cim:MeterReadSchedule.CustomerAgreement
range: CustomerAgreement
required: false
multivalued: true
description: All customer agreements for the meter read schedule.
EndDevice:
slot_uri: cim:MeterReadSchedule.EndDevice
range: EndDevice
required: false
multivalued: true
description: All end devices for the meter read schedule.
CustomerAccount:
slot_uri: cim:MeterReadSchedule.CustomerAccount
range: CustomerAccount
required: false
multivalued: true
description: All customer accounts for the meter read schedule.
UsagePoint:
class_uri: cim:UsagePoint
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
description: Logical or physical point in the network to which readings or events
may be attributed. Used at the place where a physical or virtual meter may be
located; however, it is not required that a meter be present.
attributes:
amiBillingReady:
slot_uri: cim:UsagePoint.amiBillingReady
range: AmiBillingReadyKind
required: false
multivalued: false
description: "Tracks the lifecycle of the metering installation at a usage\
\ point with respect to readiness for billing via advanced metering infrastructure\
\ reads.\r\n"
checkBilling:
slot_uri: cim:UsagePoint.checkBilling
range: boolean
required: false
multivalued: false
description: True if as a result of an inspection or otherwise, there is a
reason to suspect that a previous billing may have been performed with erroneous
data. Value should be reset once this potential discrepancy has been resolved.
connectionCategory:
slot_uri: cim:UsagePoint.connectionCategory
range: string
required: false
multivalued: false
description: A code used to specify the connection category, e.g., low voltage
or low pressure, where the usage point is defined.
connectionState:
slot_uri: cim:UsagePoint.connectionState
range: UsagePointConnectedKind
required: false
multivalued: false
description: "State of the usage point with respect to connection to the network.\r\
\n"
disconnectionMethod:
slot_uri: cim:UsagePoint.disconnectionMethod
range: string
required: false
multivalued: false
description: Is an indication of how the usage point is physically connected
or disconnected.
estimatedLoad:
slot_uri: cim:UsagePoint.estimatedLoad
range: CurrentFlow
required: false
multivalued: false
description: Estimated load.
grounded:
slot_uri: cim:UsagePoint.grounded
range: boolean
required: false
multivalued: false
description: True if grounded.
isSdp:
slot_uri: cim:UsagePoint.isSdp
range: boolean
required: false
multivalued: false
description: "If true, this usage point is a service delivery point, i.e.,\
\ a usage point where the ownership of the service changes hands.\r\n"
isVirtual:
slot_uri: cim:UsagePoint.isVirtual
range: boolean
required: false
multivalued: false
description: If true, this usage point is virtual, i.e., no physical location
exists in the network where a meter could be located to collect the meter
readings. For example, one may define a virtual usage point to serve as
an aggregation of usage for all of a company's premises distributed widely
across the distribution territory. Otherwise, the usage point is physical,
i.e., there is a logical point in the network where a meter could be located
to collect meter readings.
minimalUsageExpected:
slot_uri: cim:UsagePoint.minimalUsageExpected
range: boolean
required: false
multivalued: false
description: If true, minimal or zero usage is expected at this usage point
for situations such as premises vacancy, logical or physical disconnect.
It is used for readings validation and estimation.
nominalServiceVoltage:
slot_uri: cim:UsagePoint.nominalServiceVoltage
range: Voltage
required: false
multivalued: false
description: "Nominal service voltage.\r\n"
outageRegion:
slot_uri: cim:UsagePoint.outageRegion
range: string
required: false
multivalued: false
description: "Outage region in which this usage point is located.\r\n"
phaseCode:
slot_uri: cim:UsagePoint.phaseCode
range: PhaseCode
required: false
multivalued: false
description: "Phase code. Number of wires and specific nominal phases can\
\ be deduced from enumeration literal values. For example, ABCN is three-phase,\
\ four-wire, s12n (splitSecondary12N) is single-phase, three-wire, and s1n\
\ and s2n are single-phase, two-wire.\r\n"
phaseCount:
slot_uri: cim:UsagePoint.phaseCount
range: integer
required: false
multivalued: false
description: "Number of potential phases the Usage Point supports, typically\
\ 0, 1 or 3.\r\n"
physicalConnectionCapacity:
slot_uri: cim:UsagePoint.physicalConnectionCapacity
range: DecimalQuantity
required: false
multivalued: false
description: Quantitative information about the maximum physical capacity
of the connection for the usage point.
ratedCurrent:
slot_uri: cim:UsagePoint.ratedCurrent
range: CurrentFlow
required: false
multivalued: false
description: "Current flow that this usage point is configured to deliver.\r\
\n"
ratedPower:
slot_uri: cim:UsagePoint.ratedPower
range: ActivePower
required: false
multivalued: false
description: "Active power that this usage point is configured to deliver.\r\
\n"
readCycle:
slot_uri: cim:UsagePoint.readCycle
range: string
required: false
multivalued: false
description: "Cycle day on which the meter for this usage point will normally\
\ be read. Usually correlated with the billing cycle.\r\n"
readRoute:
slot_uri: cim:UsagePoint.readRoute
range: string
required: false
multivalued: false
description: "Identifier of the route to which this usage point is assigned\
\ for purposes of meter reading. Typically used to configure hand held meter\
\ reading systems prior to collection of reads.\r\n"
serviceDeliveryRemark:
slot_uri: cim:UsagePoint.serviceDeliveryRemark
range: string
required: false
multivalued: false
description: "Remarks about this usage point, for example the reason for it\
\ being rated with a non-nominal priority.\r\n"
servicePriority:
slot_uri: cim:UsagePoint.servicePriority
range: string
required: false
multivalued: false
description: "Priority of service for this usage point. Note that usage points\
\ at the same service location can have different priorities.\r\n"
Register:
slot_uri: cim:UsagePoint.Register
range: Register
required: false
multivalued: true
description: All registers for quantities metered at this Usage Point.
Equipments:
slot_uri: cim:UsagePoint.Equipments
range: Equipment
required: false
multivalued: true
description: All equipment connecting this usage point to the electrical grid.
EndDevices:
slot_uri: cim:UsagePoint.EndDevices
range: EndDevice
required: false
multivalued: true
description: All end devices at this usage point.
ServiceMultipliers:
slot_uri: cim:UsagePoint.ServiceMultipliers
range: ServiceMultiplier
required: false
multivalued: true
description: All multipliers applied at this usage point.
ConfigurationEvents:
slot_uri: cim:UsagePoint.ConfigurationEvents
range: ConfigurationEvent
required: false
multivalued: true
description: All configuration events created for this usage point.
ServiceCategory:
slot_uri: cim:UsagePoint.ServiceCategory
range: ServiceCategory
required: false
multivalued: false
description: Service category delivered by this usage point.
MeterReadSchedule:
slot_uri: cim:UsagePoint.MeterReadSchedule
range: MeterReadSchedule
required: false
multivalued: false
description: Meter read schedule that applies to the usage point
CustomerAgreement:
slot_uri: cim:UsagePoint.CustomerAgreement
range: CustomerAgreement
required: false
multivalued: false
description: Customer agreement regulating this service delivery point.
Outage:
slot_uri: cim:UsagePoint.Outage
range: Outage
required: false
multivalued: true
description: All outages at this Usage Point
PlannedOutageNotification:
slot_uri: cim:UsagePoint.PlannedOutageNotification
range: PlannedOutageNotification
required: false
multivalued: true
description: The planned outage notification for the specified Usage Point.
MetrologyRequirements:
slot_uri: cim:UsagePoint.MetrologyRequirements
range: MetrologyRequirement
required: false
multivalued: true
description: All metrology requirements for this usage point.
MeterServiceWorkTasks:
slot_uri: cim:UsagePoint.MeterServiceWorkTasks
range: MeterWorkTask
required: false
multivalued: true
description: All meter service work tasks at this usage point.
UsagePointGroups:
slot_uri: cim:UsagePoint.UsagePointGroups
range: UsagePointGroup
required: false
multivalued: true
description: All groups to which this usage point belongs.
ServiceSupplier:
slot_uri: cim:UsagePoint.ServiceSupplier
range: ServiceSupplier
required: false
multivalued: false
description: ServiceSupplier (utility) utilising this usage point to deliver
a service.
EndDeviceControls:
slot_uri: cim:UsagePoint.EndDeviceControls
range: EndDeviceControl
required: false
multivalued: true
description: All end device controls sending commands to this usage point.
EndDeviceEvents:
slot_uri: cim:UsagePoint.EndDeviceEvents
range: EndDeviceEvent
required: false
multivalued: true
description: All end device events reported for this usage point.
ServiceLocation:
slot_uri: cim:UsagePoint.ServiceLocation
range: ServiceLocation
required: false
multivalued: false
description: Service location where the service delivered by this usage point
is consumed.
UsagePointLocation:
slot_uri: cim:UsagePoint.UsagePointLocation
range: UsagePointLocation
required: false
multivalued: false
description: Location of this usage point.
PricingStructures:
slot_uri: cim:UsagePoint.PricingStructures
range: PricingStructure
required: false
multivalued: true
description: All pricing structures applicable to this service delivery point
(with prepayment meter running as a stand-alone device, with no CustomerAgreement
or Customer).
MeterReadings:
slot_uri: cim:UsagePoint.MeterReadings
range: MeterReading
required: false
multivalued: true
description: All meter readings obtained from this usage point.
EnvironmentalMonitoringStation:
slot_uri: cim:UsagePoint.EnvironmentalMonitoringStation
range: EnvironmentalMonitoringStation
required: false
multivalued: false
CustomerAgreement:
class_uri: cim:CustomerAgreement
is_a: Agreement
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Customers
description: Agreement between the customer and the service supplier to pay for
service at a specific service location. It records certain billing information
about the type of service provided at the service location and is used during
charge creation to determine the type of service.
attributes:
isPrePay:
slot_uri: cim:CustomerAgreement.isPrePay
range: boolean
required: false
multivalued: false
description: ' If true, the customer is a pre-pay customer for the specified
service.'
loadMgmt:
slot_uri: cim:CustomerAgreement.loadMgmt
range: string
required: false
multivalued: false
description: Load management code.
shutOffDateTime:
slot_uri: cim:CustomerAgreement.shutOffDateTime
range: date
required: false
multivalued: false
description: Final date and time the service will be billed to the previous
customer.
ServiceCategory:
slot_uri: cim:CustomerAgreement.ServiceCategory
range: ServiceCategory
required: false
multivalued: false
description: Service category for this agreement.
UsagePoints:
slot_uri: cim:CustomerAgreement.UsagePoints
range: UsagePoint
required: false
multivalued: true
description: All service delivery points regulated by this customer agreement.
PricingStructures:
slot_uri: cim:CustomerAgreement.PricingStructures
range: PricingStructure
required: false
multivalued: true
description: All pricing structures applicable to this customer agreement.
AuxiliaryAgreements:
slot_uri: cim:CustomerAgreement.AuxiliaryAgreements
range: AuxiliaryAgreement
required: false
multivalued: true
description: All (non-service related) auxiliary agreements that refer to
this customer agreement.
StandardIndustryCode:
slot_uri: cim:CustomerAgreement.StandardIndustryCode
range: StandardIndustryCode
required: false
multivalued: false
ServiceLocations:
slot_uri: cim:CustomerAgreement.ServiceLocations
range: ServiceLocation
required: false
multivalued: true
description: All service locations regulated by this customer agreement.
Customer:
slot_uri: cim:CustomerAgreement.Customer
range: Customer
required: true
multivalued: false
description: Customer for this agreement.
CustomerAccount:
slot_uri: cim:CustomerAgreement.CustomerAccount
range: CustomerAccount
required: true
multivalued: false
description: Customer account owning this agreement.
ServiceSupplier:
slot_uri: cim:CustomerAgreement.ServiceSupplier
range: ServiceSupplier
required: true
multivalued: false
description: Service supplier for this customer agreement.
MeterReadSchedule:
slot_uri: cim:CustomerAgreement.MeterReadSchedule
range: MeterReadSchedule
required: false
multivalued: false
description: Meter read schedule that applies to the customer agreement
MeterReadings:
slot_uri: cim:CustomerAgreement.MeterReadings
range: MeterReading
required: false
multivalued: true
description: (could be deprecated in the future) All meter readings for this
customer agreement.
DemandResponsePrograms:
slot_uri: cim:CustomerAgreement.DemandResponsePrograms
range: DemandResponseProgram
required: false
multivalued: true
description: All demand response programs the customer is enrolled in through
this customer agreement.
Agreement:
class_uri: cim:Agreement
is_a: Document
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Common
description: "Formal agreement between two parties defining the terms and conditions\
\ for a set of services. The specifics of the services are, in turn, defined\
\ via one or more service agreements.\r\n"
attributes:
signDate:
slot_uri: cim:Agreement.signDate
range: date
required: false
multivalued: false
description: "Date this agreement was consummated among associated persons\
\ and/or organisations.\r\n"
validityInterval:
slot_uri: cim:Agreement.validityInterval
range: DateTimeInterval
required: false
multivalued: false
description: Date and time interval this agreement is valid (from going into
effect to termination).
CustomerAccount:
class_uri: cim:CustomerAccount
is_a: Document
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Customers
description: Assignment of a group of products and services purchased by the customer
through a customer agreement, used as a mechanism for customer billing and payment.
It contains common information from the various types of customer agreements
to create billings (invoices) for a customer and receive payment.
attributes:
billingCycle:
slot_uri: cim:CustomerAccount.billingCycle
range: string
required: false
multivalued: false
description: "Cycle day on which the associated customer account will normally\
\ be billed, used to determine when to produce the billing.\r\n"
budgetBill:
slot_uri: cim:CustomerAccount.budgetBill
range: string
required: false
multivalued: false
description: "Budget bill code.\r\n"
lastBillAmount:
slot_uri: cim:CustomerAccount.lastBillAmount
range: Money
required: false
multivalued: false
description: The last amount that will be billed to the customer prior to
shut off of the account.
PaymentTransactions:
slot_uri: cim:CustomerAccount.PaymentTransactions
range: Transaction
required: false
multivalued: true
description: All payment transactions for this customer account.
CustomerAgreements:
slot_uri: cim:CustomerAccount.CustomerAgreements
range: CustomerAgreement
required: false
multivalued: true
description: All agreements for this customer account.
WorkBillingInfos:
slot_uri: cim:CustomerAccount.WorkBillingInfos
range: WorkBillingInfo
required: false
multivalued: true
ErpInvoicees:
slot_uri: cim:CustomerAccount.ErpInvoicees
range: ErpInvoice
required: false
multivalued: true
AccountNotification:
slot_uri: cim:CustomerAccount.AccountNotification
range: AccountNotification
required: false
multivalued: true
description: The notification for the customer account.
CustomerBillingInfos:
slot_uri: cim:CustomerAccount.CustomerBillingInfos
range: CustomerBillingInfo
required: false
multivalued: true
Customer:
slot_uri: cim:CustomerAccount.Customer
range: Customer
required: true
multivalued: false
description: Customer owning this account.
MeterReadSchedule:
slot_uri: cim:CustomerAccount.MeterReadSchedule
range: MeterReadSchedule
required: false
multivalued: false
description: Meter read schedule that applies to the customer account
CustomerBillingInfo:
class_uri: cim:CustomerBillingInfo
is_a: Document
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfCustomers
description: "The creation of the monthly customer billing statements is the method\
\ employed to notify Customers of charges, adjustments and credits applied to\
\ their account for Services and Products. The actuall billing occurs through\
\ an ErpInvoice. The CustomerBillingInfo includes information from the payment,\
\ collection, meter reading, installed meter, service, site, customer, customer\
\ account, customer agreement, services and pricing subject areas. Each component\
\ price shows up as a separate line item on the ErpInvoice.\r\nThe Customer\
\ Billing Statement may include collection and account messages, marketing/civic\
\ event messages and bill inserts.\r\nOne Customer Billing Statement is produced\
\ for all Agreements under a CustomerAccount per billing cycle date defined\
\ in 'CustomerAccount.billingCycle'.\r\nThe history of CustomerBillingInfo,\
\ Invoices and Payments is to be maintained in associated ActivityRecords."
attributes:
billingDate:
slot_uri: cim:CustomerBillingInfo.billingDate
range: date
required: false
multivalued: false
description: "Business date designated for the billing run which produced\
\ this CustomerBillingInfo. \r\n"
dueDate:
slot_uri: cim:CustomerBillingInfo.dueDate
range: date
required: false
multivalued: false
description: "Calculated date upon which a customer billing amount is due,\
\ used in the invoicing process to determine when a Customer's Payment is\
\ delinquent. It takes into consideration the regulatory criteria and the\
\ Customer's requested due date. In the absence of a Customer requested\
\ due date, the due date is typically calculated from the regulated number\
\ of days and the 'billingDate'.\r\n"
kind:
slot_uri: cim:CustomerBillingInfo.kind
range: CustomerBillingKind
required: false
multivalued: false
description: Kind of bill customer receives.
lastPaymentAmt:
slot_uri: cim:CustomerBillingInfo.lastPaymentAmt
range: Money
required: false
multivalued: false
description: Amount of the last payment received from the customer. It is
retained in the Customer Billing system, although the details of each payment
are tracked in the ERP system.
lastPaymentDate:
slot_uri: cim:CustomerBillingInfo.lastPaymentDate
range: date
required: false
multivalued: false
description: "Date of the last payment received from the customer. It is retained\
\ in the Customer Billing system, although the details of each payment are\
\ tracked in the ERP system.\r\n"
outBalance:
slot_uri: cim:CustomerBillingInfo.outBalance
range: Money
required: false
multivalued: false
description: Outstanding balance on the CustomerAccount as of the statement
date.
pymtPlanAmt:
slot_uri: cim:CustomerBillingInfo.pymtPlanAmt
range: Money
required: false
multivalued: false
description: Monthly amortized amount due during each billing cycle for the
CustomerAccount balance for which the Payment Plan is set-up.
pymtPlanType:
slot_uri: cim:CustomerBillingInfo.pymtPlanType
range: string
required: false
multivalued: false
description: Type of payment plan.
CustomerAccount:
slot_uri: cim:CustomerBillingInfo.CustomerAccount
range: CustomerAccount
required: false
multivalued: false
ErpInvoiceLineItems:
slot_uri: cim:CustomerBillingInfo.ErpInvoiceLineItems
range: ErpInvoiceLineItem
required: false
multivalued: true
ErpInvoiceLineItem:
class_uri: cim:ErpInvoiceLineItem
is_a: ErpDocument
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfERPSupport
description: An individual line item on an invoice.
attributes:
billPeriod:
slot_uri: cim:ErpInvoiceLineItem.billPeriod
range: DateTimeInterval
required: false
multivalued: false
description: Bill period for the line item.
glAccount:
slot_uri: cim:ErpInvoiceLineItem.glAccount
range: string
required: false
multivalued: false
description: General Ledger account code, must be a valid combination.
glDateTime:
slot_uri: cim:ErpInvoiceLineItem.glDateTime
range: date
required: false
multivalued: false
description: "Date and time line item will be posted to the General Ledger.\
\ \r\n"
kind:
slot_uri: cim:ErpInvoiceLineItem.kind
range: ErpInvoiceLineItemKind
required: false
multivalued: false
description: Kind of line item.
lineAmount:
slot_uri: cim:ErpInvoiceLineItem.lineAmount
range: float
required: false
multivalued: false
description: Amount due for this line item.
lineNumber:
slot_uri: cim:ErpInvoiceLineItem.lineNumber
range: string
required: false
multivalued: false
description: Line item number on invoice statement.
lineVersion:
slot_uri: cim:ErpInvoiceLineItem.lineVersion
range: string
required: false
multivalued: false
description: Version number of the bill run.
netAmount:
slot_uri: cim:ErpInvoiceLineItem.netAmount
range: float
required: false
multivalued: false
description: Net line item charge amount.
previousAmount:
slot_uri: cim:ErpInvoiceLineItem.previousAmount
range: float
required: false
multivalued: false
description: 'Previous line item charge amount. '
ErpPayableLineItem:
slot_uri: cim:ErpInvoiceLineItem.ErpPayableLineItem
range: ErpPayableLineItem
required: false
multivalued: false
ErpPayments:
slot_uri: cim:ErpInvoiceLineItem.ErpPayments
range: ErpPayment
required: false
multivalued: true
ErpRecLineItem:
slot_uri: cim:ErpInvoiceLineItem.ErpRecLineItem
range: ErpRecLineItem
required: false
multivalued: false
ContainerErpInvoiceLineItem:
slot_uri: cim:ErpInvoiceLineItem.ContainerErpInvoiceLineItem
range: ErpInvoiceLineItem
required: false
multivalued: false
UserAttributes:
slot_uri: cim:ErpInvoiceLineItem.UserAttributes
range: UserAttribute
required: false
multivalued: true
ErpJournalEntries:
slot_uri: cim:ErpInvoiceLineItem.ErpJournalEntries
range: ErpJournalEntry
required: false
multivalued: true
ErpInvoice:
slot_uri: cim:ErpInvoiceLineItem.ErpInvoice
range: ErpInvoice
required: true
multivalued: false
ComponentErpInvoiceLineItems:
slot_uri: cim:ErpInvoiceLineItem.ComponentErpInvoiceLineItems
range: ErpInvoiceLineItem
required: false
multivalued: true
ErpQuoteLineItem:
slot_uri: cim:ErpInvoiceLineItem.ErpQuoteLineItem
range: ErpQuoteLineItem
required: false
multivalued: false
WorkBillingInfos:
slot_uri: cim:ErpInvoiceLineItem.WorkBillingInfos
range: WorkBillingInfo
required: false
multivalued: true
CustomerBillingInfos:
slot_uri: cim:ErpInvoiceLineItem.CustomerBillingInfos
range: CustomerBillingInfo
required: false
multivalued: true
description: Customer billing for services rendered.
ErpRecDelvLineItem:
slot_uri: cim:ErpInvoiceLineItem.ErpRecDelvLineItem
range: ErpRecDelvLineItem
required: false
multivalued: false
ErpDocument:
class_uri: cim:ErpDocument
is_a: Document
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfERPSupport
description: Shadow class for Document, to isolate subclassing from this package.
If any subclass gets normative and needs inheritance, it will inherit directly
from Document.
ErpQuoteLineItem:
class_uri: cim:ErpQuoteLineItem
is_a: ErpIdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfERPSupport
description: Of an ErpQuote, the item or product quoted along with quantity, price
and other descriptive information.
attributes:
status:
slot_uri: cim:ErpQuoteLineItem.status
range: Status
required: false
multivalued: false
ErpQuote:
slot_uri: cim:ErpQuoteLineItem.ErpQuote
range: ErpQuote
required: true
multivalued: false
ErpInvoiceLineItem:
slot_uri: cim:ErpQuoteLineItem.ErpInvoiceLineItem
range: ErpInvoiceLineItem
required: false
multivalued: false
description: Some utilities provide quotes to customer for services, where
the customer accepts the quote by making a payment. An invoice is required
for this to occur.
ErpReqLineItem:
slot_uri: cim:ErpQuoteLineItem.ErpReqLineItem
range: ErpReqLineItem
required: false
multivalued: false
Design:
slot_uri: cim:ErpQuoteLineItem.Design
range: Design
required: false
multivalued: false
AssetModelCatalogueItem:
slot_uri: cim:ErpQuoteLineItem.AssetModelCatalogueItem
range: AssetModelCatalogueItem
required: false
multivalued: false
ErpIdentifiedObject:
class_uri: cim:ErpIdentifiedObject
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfERPSupport
description: Shadow class for IdentifiedObject, to isolate subclassing from this
package. If any subclass gets normative and needs inheritance, it will inherit
directly from IdentifiedObject.
AssetModelCatalogueItem:
class_uri: cim:AssetModelCatalogueItem
is_a: Document
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfAssetInfo
description: Provides pricing and other relevant information about a specific
manufacturer's product (i.e., AssetModel), and its price from a given supplier.
A single AssetModel may be availble from multiple suppliers. Note that manufacturer
and supplier are both types of organisation, which the association is inherited
from Document.
attributes:
unitCost:
slot_uri: cim:AssetModelCatalogueItem.unitCost
range: Money
required: false
multivalued: false
description: Unit cost for an asset model from a specific supplier, either
for a unit cost or cost per unit length. Cost is for material or asset only
and does not include labor to install/construct or configure it.
AssetModelCatalogue:
slot_uri: cim:AssetModelCatalogueItem.AssetModelCatalogue
range: AssetModelCatalogue
required: true
multivalued: false
ErpPOLineItems:
slot_uri: cim:AssetModelCatalogueItem.ErpPOLineItems
range: ErpPOLineItem
required: false
multivalued: true
ErpQuoteLineItems:
slot_uri: cim:AssetModelCatalogueItem.ErpQuoteLineItems
range: ErpQuoteLineItem
required: false
multivalued: true
AssetModel:
slot_uri: cim:AssetModelCatalogueItem.AssetModel
range: ProductAssetModel
required: false
multivalued: false
ProductAssetModel:
class_uri: cim:ProductAssetModel
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: Asset model by a specific manufacturer.
attributes:
catalogueNumber:
slot_uri: cim:ProductAssetModel.catalogueNumber
range: string
required: false
multivalued: false
description: Catalogue number for asset model.
corporateStandardKind:
slot_uri: cim:ProductAssetModel.corporateStandardKind
range: CorporateStandardKind
required: false
multivalued: false
description: Kind of corporate standard for this asset model.
drawingNumber:
slot_uri: cim:ProductAssetModel.drawingNumber
range: string
required: false
multivalued: false
description: Drawing number for asset model.
instructionManual:
slot_uri: cim:ProductAssetModel.instructionManual
range: string
required: false
multivalued: false
description: Reference manual or instruction book for this asset model.
modelNumber:
slot_uri: cim:ProductAssetModel.modelNumber
range: string
required: false
multivalued: false
description: Manufacturer's model number.
modelVersion:
slot_uri: cim:ProductAssetModel.modelVersion
range: string
required: false
multivalued: false
description: Version number for product model, which indicates vintage of
the product.
overallLength:
slot_uri: cim:ProductAssetModel.overallLength
range: Length
required: false
multivalued: false
description: Overall length of this asset model.
styleNumber:
slot_uri: cim:ProductAssetModel.styleNumber
range: string
required: false
multivalued: false
description: Style number of asset model.
usageKind:
slot_uri: cim:ProductAssetModel.usageKind
range: AssetModelUsageKind
required: false
multivalued: false
description: Intended usage for this asset model.
weightTotal:
slot_uri: cim:ProductAssetModel.weightTotal
range: Mass
required: false
multivalued: false
description: Total manufactured weight of asset.
CatalogAssetType:
slot_uri: cim:ProductAssetModel.CatalogAssetType
range: CatalogAssetType
required: false
multivalued: false
description: Catalog asset type to which this product asset model conforms.
AssetModelCatalogueItems:
slot_uri: cim:ProductAssetModel.AssetModelCatalogueItems
range: AssetModelCatalogueItem
required: false
multivalued: true
Manufacturer:
slot_uri: cim:ProductAssetModel.Manufacturer
range: Manufacturer
required: false
multivalued: false
description: Manufacturer of this asset model.
AssetInfo:
slot_uri: cim:ProductAssetModel.AssetInfo
range: AssetInfo
required: false
multivalued: false
description: Asset information (nameplate) for this product asset model.
Asset:
slot_uri: cim:ProductAssetModel.Asset
range: Asset
required: false
multivalued: true
description: An asset of this model.
OperationalRestrictions:
slot_uri: cim:ProductAssetModel.OperationalRestrictions
range: OperationalRestriction
required: false
multivalued: true
description: All operational restrictions applying to this asset model.
OperationalRestriction:
class_uri: cim:OperationalRestriction
is_a: Document
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Operations
description: "A document that can be associated with equipment to describe any\
\ sort of restrictions compared with the original manufacturer's specification\
\ or with the usual operational practice e.g. temporary maximum loadings, maximum\
\ switching current, do not operate if bus couplers are open, etc.\r\nIn the\
\ UK, for example, if a breaker or switch ever mal-operates, this is reported\
\ centrally and utilities use their asset systems to identify all the installed\
\ devices of the same manufacturer's type. They then apply operational restrictions\
\ in the operational systems to warn operators of potential problems. After\
\ appropriate inspection and maintenance, the operational restrictions may be\
\ removed."
attributes:
activePeriod:
slot_uri: cim:OperationalRestriction.activePeriod
range: DateTimeInterval
required: false
multivalued: false
description: Interval during which this restriction is applied.
restrictedValue:
slot_uri: cim:OperationalRestriction.restrictedValue
range: FloatQuantity
required: false
multivalued: false
description: Restricted (new) value; includes unit of measure and potentially
multiplier.
ProductAssetModel:
slot_uri: cim:OperationalRestriction.ProductAssetModel
range: ProductAssetModel
required: false
multivalued: false
description: Asset model to which this restriction applies.
Equipments:
slot_uri: cim:OperationalRestriction.Equipments
range: Equipment
required: false
multivalued: true
description: All equipments to which this restriction applies.
CatalogAssetType:
class_uri: cim:CatalogAssetType
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: a Assets that may be used for planning, work or design purposes.
attributes:
estimatedUnitCost:
slot_uri: cim:CatalogAssetType.estimatedUnitCost
range: Money
required: false
multivalued: false
description: Estimated unit cost (or cost per unit length) of this type of
asset. It does not include labor to install, construct or configure it.
kind:
slot_uri: cim:CatalogAssetType.kind
range: AssetKind
required: false
multivalued: false
description: Kind of asset (from enumerated list).
quantity:
slot_uri: cim:CatalogAssetType.quantity
range: StringQuantity
required: false
multivalued: false
description: The value, unit of measure, and multiplier for the quantity.
stockItem:
slot_uri: cim:CatalogAssetType.stockItem
range: boolean
required: false
multivalued: false
description: True if item is a stock item (default).
type:
slot_uri: cim:CatalogAssetType.type
range: string
required: false
multivalued: false
description: Description of type of asset.
ErpBomItemDatas:
slot_uri: cim:CatalogAssetType.ErpBomItemDatas
range: ErpBomItemData
required: false
multivalued: true
ErpReqLineItems:
slot_uri: cim:CatalogAssetType.ErpReqLineItems
range: ErpReqLineItem
required: false
multivalued: true
TypeAssetCatalogue:
slot_uri: cim:CatalogAssetType.TypeAssetCatalogue
range: TypeAssetCatalogue
required: false
multivalued: false
ProductAssetModel:
slot_uri: cim:CatalogAssetType.ProductAssetModel
range: ProductAssetModel
required: false
multivalued: true
description: Product asset model conforming to this catalog asset type.
CompatibleUnits:
slot_uri: cim:CatalogAssetType.CompatibleUnits
range: CompatibleUnit
required: false
multivalued: true
AssetInfo:
slot_uri: cim:CatalogAssetType.AssetInfo
range: AssetInfo
required: false
multivalued: false
description: Generic nameplate information associated with this catalog asset
type.
ErpInventoryIssues:
slot_uri: cim:CatalogAssetType.ErpInventoryIssues
range: ErpIssueInventory
required: false
multivalued: true
CompatibleUnit:
class_uri: cim:CompatibleUnit
is_a: WorkDocument
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfWork
description: A pre-planned job model containing labor, material, and accounting
requirements for standardized job planning.
attributes:
estCost:
slot_uri: cim:CompatibleUnit.estCost
range: Money
required: false
multivalued: false
description: Estimated total cost for perfoming CU.
quantity:
slot_uri: cim:CompatibleUnit.quantity
range: string
required: false
multivalued: false
description: The quantity, unit of measure, and multiplier at the CU level
that applies to the materials.
GenericAssetModel:
slot_uri: cim:CompatibleUnit.GenericAssetModel
range: CatalogAssetType
required: false
multivalued: false
CUGroup:
slot_uri: cim:CompatibleUnit.CUGroup
range: CUGroup
required: false
multivalued: false
Procedures:
slot_uri: cim:CompatibleUnit.Procedures
range: Procedure
required: false
multivalued: true
DesignLocationCUs:
slot_uri: cim:CompatibleUnit.DesignLocationCUs
range: DesignLocationCU
required: false
multivalued: true
CostType:
slot_uri: cim:CompatibleUnit.CostType
range: CostType
required: false
multivalued: false
CUWorkEquipmentItems:
slot_uri: cim:CompatibleUnit.CUWorkEquipmentItems
range: CUWorkEquipmentItem
required: false
multivalued: true
CULaborItems:
slot_uri: cim:CompatibleUnit.CULaborItems
range: CULaborItem
required: false
multivalued: true
CUContractorItems:
slot_uri: cim:CompatibleUnit.CUContractorItems
range: CUContractorItem
required: false
multivalued: true
PropertyUnit:
slot_uri: cim:CompatibleUnit.PropertyUnit
range: PropertyUnit
required: false
multivalued: false
CUMaterialItems:
slot_uri: cim:CompatibleUnit.CUMaterialItems
range: CUMaterialItem
required: false
multivalued: true
CUAllowableAction:
slot_uri: cim:CompatibleUnit.CUAllowableAction
range: CUAllowableAction
required: false
multivalued: false
WorkDocument:
class_uri: cim:WorkDocument
is_a: Document
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfWork
description: Shadow class for Document, to isolate subclassing from this package.
If any subclass gets normative and needs inheritance, it will inherit directly
from Document.
CostType:
class_uri: cim:CostType
is_a: WorkIdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfWork
description: 'A categorization for resources, often costs, in accounting transactions.
Examples include: material components, building in service, coal sales, overhead,
etc.'
attributes:
amountAssignable:
slot_uri: cim:CostType.amountAssignable
range: boolean
required: false
multivalued: false
description: "True if an amount can be assigned to the resource element (e.g.,\
\ building in service, transmission plant, software development capital);\
\ false otherwise (e.g., internal labor, material components).\r\n"
code:
slot_uri: cim:CostType.code
range: string
required: false
multivalued: false
description: A codified representation of the resource element.
level:
slot_uri: cim:CostType.level
range: string
required: false
multivalued: false
description: The level of the resource element in the hierarchy of resource
elements (recursive relationship).
stage:
slot_uri: cim:CostType.stage
range: string
required: false
multivalued: false
description: 'The stage for which this costType applies: estimated design,
estimated actual or actual actual. '
status:
slot_uri: cim:CostType.status
range: Status
required: false
multivalued: false
CompatibleUnits:
slot_uri: cim:CostType.CompatibleUnits
range: CompatibleUnit
required: false
multivalued: true
ErpJournalEntries:
slot_uri: cim:CostType.ErpJournalEntries
range: ErpJournalEntry
required: false
multivalued: true
WorkCostDetails:
slot_uri: cim:CostType.WorkCostDetails
range: WorkCostDetail
required: false
multivalued: true
ChildCostTypes:
slot_uri: cim:CostType.ChildCostTypes
range: CostType
required: false
multivalued: true
ParentCostType:
slot_uri: cim:CostType.ParentCostType
range: CostType
required: false
multivalued: false
WorkIdentifiedObject:
class_uri: cim:WorkIdentifiedObject
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfWork
description: Shadow class for IdentifiedObject, to isolate subclassing from this
package. If any subclass gets normative and needs inheritance, it will inherit
directly from IdentifiedObject.
ErpJournalEntry:
class_uri: cim:ErpJournalEntry
is_a: ErpIdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfERPSupport
description: "Details of an individual entry in a journal, which is to be posted\
\ to a ledger on the posting date.\r\n"
attributes:
accountID:
slot_uri: cim:ErpJournalEntry.accountID
range: string
required: false
multivalued: false
description: Account identifier for this entry.
amount:
slot_uri: cim:ErpJournalEntry.amount
range: Money
required: false
multivalued: false
description: The amount of the debit or credit for this account.
postingDateTime:
slot_uri: cim:ErpJournalEntry.postingDateTime
range: date
required: false
multivalued: false
description: "Date and time this entry is to be posted to the ledger.\r\n"
sourceID:
slot_uri: cim:ErpJournalEntry.sourceID
range: string
required: false
multivalued: false
description: The identifer of the source for this entry.
status:
slot_uri: cim:ErpJournalEntry.status
range: Status
required: false
multivalued: false
transactionDateTime:
slot_uri: cim:ErpJournalEntry.transactionDateTime
range: date
required: false
multivalued: false
description: "Date and time journal entry was recorded.\r\n"
ErpRecLineItems:
slot_uri: cim:ErpJournalEntry.ErpRecLineItems
range: ErpRecLineItem
required: false
multivalued: true
ErpLedgerEntry:
slot_uri: cim:ErpJournalEntry.ErpLedgerEntry
range: ErpLedgerEntry
required: false
multivalued: false
CostTypes:
slot_uri: cim:ErpJournalEntry.CostTypes
range: CostType
required: false
multivalued: true
ErpInvoiceLineItem:
slot_uri: cim:ErpJournalEntry.ErpInvoiceLineItem
range: ErpInvoiceLineItem
required: false
multivalued: false
ErpPayableLineItems:
slot_uri: cim:ErpJournalEntry.ErpPayableLineItems
range: ErpPayableLineItem
required: false
multivalued: true
ErpJournal:
slot_uri: cim:ErpJournalEntry.ErpJournal
range: ErpJournal
required: true
multivalued: false
ErpRecLineItem:
class_uri: cim:ErpRecLineItem
is_a: ErpIdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfERPSupport
description: Individual entry of an ErpReceivable, it is a particular transaction
representing an invoice, credit memo or debit memo to a customer.
attributes:
status:
slot_uri: cim:ErpRecLineItem.status
range: Status
required: false
multivalued: false
ErpJournalEntries:
slot_uri: cim:ErpRecLineItem.ErpJournalEntries
range: ErpJournalEntry
required: false
multivalued: true
ErpPayments:
slot_uri: cim:ErpRecLineItem.ErpPayments
range: ErpPayment
required: false
multivalued: true
ErpReceivable:
slot_uri: cim:ErpRecLineItem.ErpReceivable
range: ErpReceivable
required: true
multivalued: false
ErpInvoiceLineItem:
slot_uri: cim:ErpRecLineItem.ErpInvoiceLineItem
range: ErpInvoiceLineItem
required: false
multivalued: false
ErpPayment:
class_uri: cim:ErpPayment
is_a: ErpDocument
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfERPSupport
description: Payment infromation and status for any individual line item of an
ErpInvoice (e.g., when payment is from a customer). ErpPayable is also updated
when payment is to a supplier and ErpReceivable is updated when payment is from
a customer. Multiple payments can be made against a single line item and an
individual payment can apply to more that one line item.
attributes:
termsPayment:
slot_uri: cim:ErpPayment.termsPayment
range: string
required: false
multivalued: false
description: Payment terms (e.g., net 30).
ErpInvoiceLineItems:
slot_uri: cim:ErpPayment.ErpInvoiceLineItems
range: ErpInvoiceLineItem
required: false
multivalued: true
ErpPayableLineItems:
slot_uri: cim:ErpPayment.ErpPayableLineItems
range: ErpPayableLineItem
required: false
multivalued: true
ErpRecLineItems:
slot_uri: cim:ErpPayment.ErpRecLineItems
range: ErpRecLineItem
required: false
multivalued: true
ErpPayableLineItem:
class_uri: cim:ErpPayableLineItem
is_a: ErpIdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfERPSupport
description: Of an ErpPayable, a line item references an ErpInvoiceLineitem or
other source such as credit memos.
attributes:
status:
slot_uri: cim:ErpPayableLineItem.status
range: Status
required: false
multivalued: false
ErpPayments:
slot_uri: cim:ErpPayableLineItem.ErpPayments
range: ErpPayment
required: false
multivalued: true
ErpPayable:
slot_uri: cim:ErpPayableLineItem.ErpPayable
range: ErpPayable
required: true
multivalued: false
ErpJournalEntries:
slot_uri: cim:ErpPayableLineItem.ErpJournalEntries
range: ErpJournalEntry
required: false
multivalued: true
ErpInvoiceLineItem:
slot_uri: cim:ErpPayableLineItem.ErpInvoiceLineItem
range: ErpInvoiceLineItem
required: false
multivalued: false
ErpPayable:
class_uri: cim:ErpPayable
is_a: ErpDocument
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfERPSupport
description: A transaction that represents an invoice from a supplier. A payable
(or voucher) is an open item, approved and ready for payment, in the Accounts
Payable ledger.
attributes:
ErpPayableLineItems:
slot_uri: cim:ErpPayable.ErpPayableLineItems
range: ErpPayableLineItem
required: false
multivalued: true
ContractorItems:
slot_uri: cim:ErpPayable.ContractorItems
range: ContractorItem
required: false
multivalued: true
ContractorItem:
class_uri: cim:ContractorItem
is_a: WorkIdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfWork
description: Contractor information for work task.
attributes:
activityCode:
slot_uri: cim:ContractorItem.activityCode
range: string
required: false
multivalued: false
description: ' Activity code identifies a specific and distinguishable unit
of work.'
bidAmount:
slot_uri: cim:ContractorItem.bidAmount
range: Money
required: false
multivalued: false
description: The amount that a given contractor will charge for performing
this unit of work.
cost:
slot_uri: cim:ContractorItem.cost
range: Money
required: false
multivalued: false
description: The total amount charged.
status:
slot_uri: cim:ContractorItem.status
range: Status
required: false
multivalued: false
ErpPayables:
slot_uri: cim:ContractorItem.ErpPayables
range: ErpPayable
required: false
multivalued: true
WorkTask:
slot_uri: cim:ContractorItem.WorkTask
range: OldWorkTask
required: false
multivalued: false
WorkCostDetail:
slot_uri: cim:ContractorItem.WorkCostDetail
range: WorkCostDetail
required: true
multivalued: false
OldWorkTask:
class_uri: cim:OldWorkTask
is_a: WorkTask
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfWork
description: A set of tasks is required to implement a design.
attributes:
ContractorItems:
slot_uri: cim:OldWorkTask.ContractorItems
range: ContractorItem
required: false
multivalued: true
QualificationRequirements:
slot_uri: cim:OldWorkTask.QualificationRequirements
range: QualificationRequirement
required: false
multivalued: true
Usages:
slot_uri: cim:OldWorkTask.Usages
range: Usage
required: false
multivalued: true
MiscCostItems:
slot_uri: cim:OldWorkTask.MiscCostItems
range: MiscCostItem
required: false
multivalued: true
OverheadCost:
slot_uri: cim:OldWorkTask.OverheadCost
range: OverheadCost
required: false
multivalued: false
LaborItems:
slot_uri: cim:OldWorkTask.LaborItems
range: LaborItem
required: false
multivalued: true
Capabilities:
slot_uri: cim:OldWorkTask.Capabilities
range: Capability
required: false
multivalued: true
WorkCostDetails:
slot_uri: cim:OldWorkTask.WorkCostDetails
range: WorkCostDetail
required: false
multivalued: true
Design:
slot_uri: cim:OldWorkTask.Design
range: Design
required: false
multivalued: false
WorkFlowStep:
slot_uri: cim:OldWorkTask.WorkFlowStep
range: WorkFlowStep
required: false
multivalued: false
DesignLocationCUs:
slot_uri: cim:OldWorkTask.DesignLocationCUs
range: DesignLocationCU
required: false
multivalued: true
Capability:
class_uri: cim:Capability
is_a: WorkIdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfWork
description: "Capabilities of a crew.\r\n"
attributes:
performanceFactor:
slot_uri: cim:Capability.performanceFactor
range: string
required: false
multivalued: false
description: Capability performance factor.
status:
slot_uri: cim:Capability.status
range: Status
required: false
multivalued: false
type:
slot_uri: cim:Capability.type
range: string
required: false
multivalued: false
description: "Classification by utility's work management standards and practices.\r\
\n"
validityInterval:
slot_uri: cim:Capability.validityInterval
range: DateTimeInterval
required: false
multivalued: false
description: Date and time interval for which this capability is valid (when
it became effective and when it expires).
WorkTasks:
slot_uri: cim:Capability.WorkTasks
range: OldWorkTask
required: false
multivalued: true
Crafts:
slot_uri: cim:Capability.Crafts
range: Craft
required: false
multivalued: true
Crew:
slot_uri: cim:Capability.Crew
range: OldCrew
required: false
multivalued: false
Craft:
class_uri: cim:Craft
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfCommon
description: "Craft of a person or a crew. Examples include overhead electric,\
\ underground electric, high pressure gas, etc. This ensures necessary knowledge\
\ and skills before being allowed to perform certain types of work.\r\n"
attributes:
status:
slot_uri: cim:Craft.status
range: Status
required: false
multivalued: false
type:
slot_uri: cim:Craft.type
range: string
required: false
multivalued: false
description: "Classification by utility's work mangement standards and practices.\r\
\n"
ErpPersons:
slot_uri: cim:Craft.ErpPersons
range: OldPerson
required: false
multivalued: true
Capabilities:
slot_uri: cim:Craft.Capabilities
range: Capability
required: false
multivalued: true
Skills:
slot_uri: cim:Craft.Skills
range: Skill
required: false
multivalued: true
Skill:
class_uri: cim:Skill
is_a: Document
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfCommon
description: "Proficiency level of a craft, which is required to operate or maintain\
\ a particular type of asset and/or perform certain types of work. \r\n"
attributes:
certificationPeriod:
slot_uri: cim:Skill.certificationPeriod
range: DateTimeInterval
required: false
multivalued: false
description: Interval between the certification and its expiry.
effectiveDateTime:
slot_uri: cim:Skill.effectiveDateTime
range: date
required: false
multivalued: false
description: "Date and time the skill became effective.\r\n"
level:
slot_uri: cim:Skill.level
range: SkillLevelKind
required: false
multivalued: false
description: "Level of skill for a Craft.\r\n"
QualificationRequirements:
slot_uri: cim:Skill.QualificationRequirements
range: QualificationRequirement
required: false
multivalued: true
Crafts:
slot_uri: cim:Skill.Crafts
range: Craft
required: false
multivalued: true
ErpPerson:
slot_uri: cim:Skill.ErpPerson
range: OldPerson
required: false
multivalued: false
OldPerson:
class_uri: cim:OldPerson
is_a: Person
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfCommon
description: General purpose information for name and other information to contact
people.
attributes:
status:
slot_uri: cim:OldPerson.status
range: Status
required: false
multivalued: false
type:
slot_uri: cim:OldPerson.type
range: string
required: false
multivalued: false
description: "Utility-specific classification for this person, according to\
\ the utility's corporate standards and practices. Examples include employee,\
\ contractor, agent, not affiliated, etc.\r\nNote that this field is not\
\ used to indicate whether this person is a customer of the utility. Often\
\ an employee or contractor is also a customer. Customer information is\
\ gained with relationship to Organisation and CustomerData. In similar\
\ fashion, this field does not indicate the various roles this person may\
\ fill as part of utility operations.\r\n"
ErpPersonnel:
slot_uri: cim:OldPerson.ErpPersonnel
range: ErpPersonnel
required: false
multivalued: false
OrganisationRoles:
slot_uri: cim:OldPerson.OrganisationRoles
range: PersonOrganisationRole
required: false
multivalued: true
Skills:
slot_uri: cim:OldPerson.Skills
range: Skill
required: false
multivalued: true
LaborItems:
slot_uri: cim:OldPerson.LaborItems
range: LaborItem
required: false
multivalued: true
ErpCompetency:
slot_uri: cim:OldPerson.ErpCompetency
range: ErpCompetency
required: false
multivalued: false
LandPropertyRoles:
slot_uri: cim:OldPerson.LandPropertyRoles
range: PersonPropertyRole
required: false
multivalued: true
MeasurementValues:
slot_uri: cim:OldPerson.MeasurementValues
range: MeasurementValue
required: false
multivalued: true
Crafts:
slot_uri: cim:OldPerson.Crafts
range: Craft
required: false
multivalued: true
CustomerData:
slot_uri: cim:OldPerson.CustomerData
range: Customer
required: false
multivalued: false
ErpPersonnel:
class_uri: cim:ErpPersonnel
is_a: ErpIdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfERPSupport
description: Information that applies to the basic data about a utility person,
used by ERP applications to transfer Personnel data for a worker.
attributes:
status:
slot_uri: cim:ErpPersonnel.status
range: Status
required: false
multivalued: false
ErpPersons:
slot_uri: cim:ErpPersonnel.ErpPersons
range: OldPerson
required: false
multivalued: true
PersonOrganisationRole:
class_uri: cim:PersonOrganisationRole
is_a: OrganisationRole
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfCommon
description: "Role an organisation plays with respect to persons.\r\n"
attributes:
clientID:
slot_uri: cim:PersonOrganisationRole.clientID
range: string
required: false
multivalued: false
description: Identifiers of the person held by an organisation, such as a
government agency (federal, state, province, city, county), financial institutions,
etc.
ErpPerson:
slot_uri: cim:PersonOrganisationRole.ErpPerson
range: OldPerson
required: true
multivalued: false
LaborItem:
class_uri: cim:LaborItem
is_a: WorkIdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfWork
description: Labor used for work order.
attributes:
activityCode:
slot_uri: cim:LaborItem.activityCode
range: string
required: false
multivalued: false
description: ' Activity code identifies a specific and distinguishable unit
of work.'
cost:
slot_uri: cim:LaborItem.cost
range: Money
required: false
multivalued: false
description: Total cost for labor. Note that this may not be able to be derived
from labor rate and time charged.
laborDuration:
slot_uri: cim:LaborItem.laborDuration
range: Hours
required: false
multivalued: false
description: Time required to perform work.
laborRate:
slot_uri: cim:LaborItem.laborRate
range: CostRate
required: false
multivalued: false
description: ' The labor rate applied for work.'
status:
slot_uri: cim:LaborItem.status
range: Status
required: false
multivalued: false
WorkCostDetail:
slot_uri: cim:LaborItem.WorkCostDetail
range: WorkCostDetail
required: true
multivalued: false
ErpPersons:
slot_uri: cim:LaborItem.ErpPersons
range: OldPerson
required: false
multivalued: true
WorkTask:
slot_uri: cim:LaborItem.WorkTask
range: OldWorkTask
required: false
multivalued: false
WorkCostDetail:
class_uri: cim:WorkCostDetail
is_a: WorkDocument
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfWork
description: A collection of all of the individual cost items collected from multiple
sources.
attributes:
amount:
slot_uri: cim:WorkCostDetail.amount
range: Money
required: false
multivalued: false
description: 'Amount in designated currency for work, either a total or an
individual element. As defined in the attribute "type," multiple instances
are applicable to each work for: planned cost, actual cost, authorized cost,
budgeted cost, forecasted cost, other.'
isDebit:
slot_uri: cim:WorkCostDetail.isDebit
range: boolean
required: false
multivalued: false
description: True if 'amount' is a debit, false if it is a credit.
transactionDateTime:
slot_uri: cim:WorkCostDetail.transactionDateTime
range: date
required: false
multivalued: false
description: "Date and time that 'amount' is posted to the work.\r\n"
ErpProjectAccounting:
slot_uri: cim:WorkCostDetail.ErpProjectAccounting
range: ErpProjectAccounting
required: true
multivalued: false
WorkTask:
slot_uri: cim:WorkCostDetail.WorkTask
range: OldWorkTask
required: false
multivalued: false
WorkCostSummary:
slot_uri: cim:WorkCostDetail.WorkCostSummary
range: WorkCostSummary
required: false
multivalued: false
ContractorItems:
slot_uri: cim:WorkCostDetail.ContractorItems
range: ContractorItem
required: false
multivalued: true
PropertyUnits:
slot_uri: cim:WorkCostDetail.PropertyUnits
range: PropertyUnit
required: false
multivalued: true
Works:
slot_uri: cim:WorkCostDetail.Works
range: Work
required: false
multivalued: true
CostType:
slot_uri: cim:WorkCostDetail.CostType
range: CostType
required: true
multivalued: false
Design:
slot_uri: cim:WorkCostDetail.Design
range: Design
required: false
multivalued: false
LaborItems:
slot_uri: cim:WorkCostDetail.LaborItems
range: LaborItem
required: false
multivalued: true
OverheadCost:
slot_uri: cim:WorkCostDetail.OverheadCost
range: OverheadCost
required: false
multivalued: false
MiscCostItems:
slot_uri: cim:WorkCostDetail.MiscCostItems
range: MiscCostItem
required: false
multivalued: true
Design:
class_uri: cim:Design
is_a: WorkDocument
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfWork
description: "A design for consideration by customers, potential customers, or\
\ internal work.\r\nNote that the Version of design is the revision attribute\
\ that is inherited from Document."
attributes:
costEstimate:
slot_uri: cim:Design.costEstimate
range: Money
required: false
multivalued: false
description: Estimated cost (not price) of design.
kind:
slot_uri: cim:Design.kind
range: DesignKind
required: false
multivalued: false
description: Kind of this design.
price:
slot_uri: cim:Design.price
range: Money
required: false
multivalued: false
description: ' Price to customer for implementing design.'
ErpBOMs:
slot_uri: cim:Design.ErpBOMs
range: ErpBOM
required: false
multivalued: true
WorkCostDetails:
slot_uri: cim:Design.WorkCostDetails
range: WorkCostDetail
required: false
multivalued: true
WorkTasks:
slot_uri: cim:Design.WorkTasks
range: OldWorkTask
required: false
multivalued: true
Work:
slot_uri: cim:Design.Work
range: Work
required: false
multivalued: false
ConditionFactors:
slot_uri: cim:Design.ConditionFactors
range: ConditionFactor
required: false
multivalued: true
DesignLocationsCUs:
slot_uri: cim:Design.DesignLocationsCUs
range: DesignLocationCU
required: false
multivalued: true
DesignLocations:
slot_uri: cim:Design.DesignLocations
range: DesignLocation
required: false
multivalued: true
ErpQuoteLineItem:
slot_uri: cim:Design.ErpQuoteLineItem
range: ErpQuoteLineItem
required: false
multivalued: false
DesignLocationCU:
class_uri: cim:DesignLocationCU
is_a: WorkIdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfWork
description: Compatible unit at a given design location.
attributes:
cuAccount:
slot_uri: cim:DesignLocationCU.cuAccount
range: string
required: false
multivalued: false
description: A code that helps direct accounting (capital, expense, or accounting
treatment).
cuAction:
slot_uri: cim:DesignLocationCU.cuAction
range: WorkActionKind
required: false
multivalued: false
description: A code that instructs the crew what action to perform.
cuQuantity:
slot_uri: cim:DesignLocationCU.cuQuantity
range: IntegerQuantity
required: false
multivalued: false
description: The quantity of the CU being assigned to this location.
cuUsage:
slot_uri: cim:DesignLocationCU.cuUsage
range: string
required: false
multivalued: false
description: 'As the same CU can be used for different purposes and accounting
purposes, usage must be specified. Examples include: distribution, transmission,
substation.'
removalDate:
slot_uri: cim:DesignLocationCU.removalDate
range: date
required: false
multivalued: false
description: "Year when a CU that represents an asset is removed.\r\n"
status:
slot_uri: cim:DesignLocationCU.status
range: Status
required: false
multivalued: false
toBeEnergised:
slot_uri: cim:DesignLocationCU.toBeEnergised
range: boolean
required: false
multivalued: false
description: "True if associated electrical equipment is intended to be energized\
\ while work is being performed.\r\n"
CUGroups:
slot_uri: cim:DesignLocationCU.CUGroups
range: CUGroup
required: false
multivalued: true
Designs:
slot_uri: cim:DesignLocationCU.Designs
range: Design
required: false
multivalued: true
ConditionFactors:
slot_uri: cim:DesignLocationCU.ConditionFactors
range: ConditionFactor
required: false
multivalued: true
WorkTasks:
slot_uri: cim:DesignLocationCU.WorkTasks
range: OldWorkTask
required: false
multivalued: true
DesignLocation:
slot_uri: cim:DesignLocationCU.DesignLocation
range: DesignLocation
required: false
multivalued: false
CompatibleUnits:
slot_uri: cim:DesignLocationCU.CompatibleUnits
range: CompatibleUnit
required: false
multivalued: true
DesignLocation:
class_uri: cim:DesignLocation
is_a: WorkIdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfWork
description: A logical part of the design (e.g., pole and all equipment on a pole).
This includes points and spans.
attributes:
spanLength:
slot_uri: cim:DesignLocation.spanLength
range: Length
required: false
multivalued: false
description: The legth of the span from the previous pole to this pole.
status:
slot_uri: cim:DesignLocation.status
range: Status
required: false
multivalued: false
ConditionFactors:
slot_uri: cim:DesignLocation.ConditionFactors
range: ConditionFactor
required: false
multivalued: true
Designs:
slot_uri: cim:DesignLocation.Designs
range: Design
required: true
multivalued: true
DesignLocationCUs:
slot_uri: cim:DesignLocation.DesignLocationCUs
range: DesignLocationCU
required: false
multivalued: true
WorkLocations:
slot_uri: cim:DesignLocation.WorkLocations
range: WorkLocation
required: true
multivalued: true
MiscCostItems:
slot_uri: cim:DesignLocation.MiscCostItems
range: MiscCostItem
required: false
multivalued: true
ErpBomItemDatas:
slot_uri: cim:DesignLocation.ErpBomItemDatas
range: ErpBomItemData
required: false
multivalued: true
ErpBomItemData:
class_uri: cim:ErpBomItemData
is_a: ErpIdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfERPSupport
description: An individual item on a bill of materials.
attributes:
DesignLocation:
slot_uri: cim:ErpBomItemData.DesignLocation
range: DesignLocation
required: false
multivalued: false
ErpBOM:
slot_uri: cim:ErpBomItemData.ErpBOM
range: ErpBOM
required: true
multivalued: false
TypeAsset:
slot_uri: cim:ErpBomItemData.TypeAsset
range: CatalogAssetType
required: false
multivalued: false
ErpBOM:
class_uri: cim:ErpBOM
is_a: ErpDocument
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfERPSupport
description: "Information that generally describes the Bill of Material Structure\
\ and its contents for a utility.\r\n\r\nThis is used by ERP systems to transfer\
\ Bill of Material information between two business applications."
attributes:
Design:
slot_uri: cim:ErpBOM.Design
range: Design
required: false
multivalued: false
ErpBomItemDatas:
slot_uri: cim:ErpBOM.ErpBomItemDatas
range: ErpBomItemData
required: false
multivalued: true
ConditionFactor:
class_uri: cim:ConditionFactor
is_a: WorkIdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfWork
description: This is to specify the various condition factors for a design that
may alter the cost estimate or the allocation.
attributes:
cfValue:
slot_uri: cim:ConditionFactor.cfValue
range: string
required: false
multivalued: false
description: The actual value of the condition factor, such as labor flat
fee or percentage.
kind:
slot_uri: cim:ConditionFactor.kind
range: ConditionFactorKind
required: false
multivalued: false
description: Kind of this condition factor.
status:
slot_uri: cim:ConditionFactor.status
range: Status
required: false
multivalued: false
DesignLocations:
slot_uri: cim:ConditionFactor.DesignLocations
range: DesignLocation
required: false
multivalued: true
DesignLocationCUs:
slot_uri: cim:ConditionFactor.DesignLocationCUs
range: DesignLocationCU
required: false
multivalued: true
Designs:
slot_uri: cim:ConditionFactor.Designs
range: Design
required: false
multivalued: true
WorkLocation:
class_uri: cim:WorkLocation
is_a: Location
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Work
description: Information about a particular location for various forms of work.
attributes:
OneCallRequest:
slot_uri: cim:WorkLocation.OneCallRequest
range: OneCallRequest
required: false
multivalued: false
BaseWorks:
slot_uri: cim:WorkLocation.BaseWorks
range: BaseWork
required: false
multivalued: true
description: All works/tasks at this location.
DesignLocations:
slot_uri: cim:WorkLocation.DesignLocations
range: DesignLocation
required: false
multivalued: true
OneCallRequest:
class_uri: cim:OneCallRequest
is_a: WorkDocument
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfWork
description: A request for other utilities to mark their underground facilities
prior to commencement of construction and/or maintenance.
attributes:
explosivesUsed:
slot_uri: cim:OneCallRequest.explosivesUsed
range: boolean
required: false
multivalued: false
description: True if explosives have been or are planned to be used.
markedIndicator:
slot_uri: cim:OneCallRequest.markedIndicator
range: boolean
required: false
multivalued: false
description: True if work location has been marked, for example for a dig
area.
markingInstruction:
slot_uri: cim:OneCallRequest.markingInstruction
range: string
required: false
multivalued: false
description: Instructions for marking a dig area, if applicable.
WorkLocations:
slot_uri: cim:OneCallRequest.WorkLocations
range: WorkLocation
required: false
multivalued: true
MiscCostItem:
class_uri: cim:MiscCostItem
is_a: WorkIdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfWork
description: "Various cost items that are not associated with compatible units.\
\ Examples include rental equipment, labor, materials, contractor costs, permits\
\ - anything not covered in a CU.\r\n"
attributes:
account:
slot_uri: cim:MiscCostItem.account
range: string
required: false
multivalued: false
description: This drives the accounting treatment for this misc. item.
costPerUnit:
slot_uri: cim:MiscCostItem.costPerUnit
range: Money
required: false
multivalued: false
description: The cost per unit for this misc. item.
costType:
slot_uri: cim:MiscCostItem.costType
range: string
required: false
multivalued: false
description: "The cost type for accounting, such as material, labor, vehicle,\
\ contractor, equipment, overhead.\r\n"
externalRefID:
slot_uri: cim:MiscCostItem.externalRefID
range: string
required: false
multivalued: false
description: "External reference identifier (e.g. purchase order number, serial\
\ number) .\r\n"
quantity:
slot_uri: cim:MiscCostItem.quantity
range: IntegerQuantity
required: false
multivalued: false
description: The quantity of the misc. item being assigned to this location.
status:
slot_uri: cim:MiscCostItem.status
range: Status
required: false
multivalued: false
WorkCostDetail:
slot_uri: cim:MiscCostItem.WorkCostDetail
range: WorkCostDetail
required: false
multivalued: false
WorkTask:
slot_uri: cim:MiscCostItem.WorkTask
range: OldWorkTask
required: false
multivalued: false
DesignLocation:
slot_uri: cim:MiscCostItem.DesignLocation
range: DesignLocation
required: false
multivalued: false
CUGroup:
class_uri: cim:CUGroup
is_a: WorkIdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfWork
description: A Compatible Unit Group identifies a set of compatible units which
may be jointly utilized for estimating and designating jobs.
attributes:
status:
slot_uri: cim:CUGroup.status
range: Status
required: false
multivalued: false
ChildCUGroups:
slot_uri: cim:CUGroup.ChildCUGroups
range: CUGroup
required: false
multivalued: true
DesignLocationCUs:
slot_uri: cim:CUGroup.DesignLocationCUs
range: DesignLocationCU
required: false
multivalued: true
CompatibleUnits:
slot_uri: cim:CUGroup.CompatibleUnits
range: CompatibleUnit
required: false
multivalued: true
ParentCUGroups:
slot_uri: cim:CUGroup.ParentCUGroups
range: CUGroup
required: false
multivalued: true
Work:
class_uri: cim:Work
is_a: BaseWork
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Work
description: Document used to request, initiate, track and record work.
attributes:
requestDateTime:
slot_uri: cim:Work.requestDateTime
range: date
required: false
multivalued: false
description: "Date and time work was requested.\r\n"
workOrderNumber:
slot_uri: cim:Work.workOrderNumber
range: string
required: false
multivalued: false
description: Work order number (or other unique identifying information) for
this work.
ErpProjectAccounting:
slot_uri: cim:Work.ErpProjectAccounting
range: ErpProjectAccounting
required: false
multivalued: false
WorkTasks:
slot_uri: cim:Work.WorkTasks
range: WorkTask
required: false
multivalued: true
description: All tasks in this work.
Project:
slot_uri: cim:Work.Project
range: Project
required: false
multivalued: false
Customers:
slot_uri: cim:Work.Customers
range: Customer
required: false
multivalued: true
description: All the customers for which this work is performed.
Incidents:
slot_uri: cim:Work.Incidents
range: Incident
required: false
multivalued: true
description: All incidents being addressed by this work.
WorkFlowSteps:
slot_uri: cim:Work.WorkFlowSteps
range: WorkFlowStep
required: false
multivalued: true
BusinessCase:
slot_uri: cim:Work.BusinessCase
range: BusinessCase
required: false
multivalued: false
Appointments:
slot_uri: cim:Work.Appointments
range: Appointment
required: false
multivalued: true
description: All appointments for this work.
Designs:
slot_uri: cim:Work.Designs
range: Design
required: false
multivalued: true
WorkBillingInfo:
slot_uri: cim:Work.WorkBillingInfo
range: WorkBillingInfo
required: false
multivalued: false
WorkCostDetails:
slot_uri: cim:Work.WorkCostDetails
range: WorkCostDetail
required: false
multivalued: true
WorkFlowStep:
class_uri: cim:WorkFlowStep
is_a: WorkIdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfWork
description: A pre-defined set of work steps for a given type of work.
attributes:
sequenceNumber:
slot_uri: cim:WorkFlowStep.sequenceNumber
range: integer
required: false
multivalued: false
description: Used to define dependencies of each work flow step, which is
for the instance of WorkTask associated with a given instance of WorkFlow.
status:
slot_uri: cim:WorkFlowStep.status
range: Status
required: false
multivalued: false
Work:
slot_uri: cim:WorkFlowStep.Work
range: Work
required: false
multivalued: false
WorkTasks:
slot_uri: cim:WorkFlowStep.WorkTasks
range: OldWorkTask
required: false
multivalued: true
BusinessCase:
class_uri: cim:BusinessCase
is_a: WorkDocument
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfWork
description: Business justification for capital expenditures, usually addressing
operations and maintenance costs as well.
attributes:
corporateCode:
slot_uri: cim:BusinessCase.corporateCode
range: string
required: false
multivalued: false
description: A codified representation of the business case (i.e., codes for
highway relocation, replace substation transformers, etc.).
Projects:
slot_uri: cim:BusinessCase.Projects
range: Project
required: false
multivalued: true
Works:
slot_uri: cim:BusinessCase.Works
range: Work
required: false
multivalued: true
Project:
class_uri: cim:Project
is_a: WorkDocument
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfWork
description: A collection of related work. For construction projects and maintenance
projects, multiple phases may be performed.
attributes:
budget:
slot_uri: cim:Project.budget
range: Money
required: false
multivalued: false
description: Overall project budget.
SubProjects:
slot_uri: cim:Project.SubProjects
range: Project
required: false
multivalued: true
ParentProject:
slot_uri: cim:Project.ParentProject
range: Project
required: false
multivalued: false
BusinessCase:
slot_uri: cim:Project.BusinessCase
range: BusinessCase
required: false
multivalued: false
ErpProjectAccounting:
slot_uri: cim:Project.ErpProjectAccounting
range: ErpProjectAccounting
required: true
multivalued: false
Works:
slot_uri: cim:Project.Works
range: Work
required: false
multivalued: true
ErpProjectAccounting:
class_uri: cim:ErpProjectAccounting
is_a: ErpDocument
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfERPSupport
description: 'Utility Project Accounting information, used by ERP applications
to enable all relevant sub-systems that submit single sided transactions to
transfer information with a Project Accounting Application. This would include,
but not necessarily be limited to: Accounts Payable, Accounts Receivable, Budget,
Order Management, Purchasing, Time and Labor, Travel and Expense.'
attributes:
Projects:
slot_uri: cim:ErpProjectAccounting.Projects
range: Project
required: false
multivalued: true
Works:
slot_uri: cim:ErpProjectAccounting.Works
range: Work
required: false
multivalued: true
WorkCostDetails:
slot_uri: cim:ErpProjectAccounting.WorkCostDetails
range: WorkCostDetail
required: false
multivalued: true
ErpTimeEntries:
slot_uri: cim:ErpProjectAccounting.ErpTimeEntries
range: ErpTimeEntry
required: false
multivalued: true
ErpTimeEntry:
class_uri: cim:ErpTimeEntry
is_a: ErpIdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfERPSupport
description: An individual entry on an ErpTimeSheet.
attributes:
status:
slot_uri: cim:ErpTimeEntry.status
range: Status
required: false
multivalued: false
ErpProjectAccounting:
slot_uri: cim:ErpTimeEntry.ErpProjectAccounting
range: ErpProjectAccounting
required: false
multivalued: false
ErpTimeSheet:
slot_uri: cim:ErpTimeEntry.ErpTimeSheet
range: ErpTimeSheet
required: true
multivalued: false
ErpTimeSheet:
class_uri: cim:ErpTimeSheet
is_a: ErpDocument
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfERPSupport
description: Time sheet for employees and contractors. Note that ErpTimeSheet
inherits the relationship to ErpPerson from Document.
attributes:
ErpTimeEntries:
slot_uri: cim:ErpTimeSheet.ErpTimeEntries
range: ErpTimeEntry
required: false
multivalued: true
Appointment:
class_uri: cim:Appointment
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Common
description: Meeting time and location.
attributes:
callAhead:
slot_uri: cim:Appointment.callAhead
range: boolean
required: false
multivalued: false
description: True if requested to call customer when someone is about to arrive
at their premises.
meetingInterval:
slot_uri: cim:Appointment.meetingInterval
range: DateTimeInterval
required: false
multivalued: false
description: Date and time reserved for appointment.
Works:
slot_uri: cim:Appointment.Works
range: Work
required: false
multivalued: true
description: All works for this appointment.
Persons:
slot_uri: cim:Appointment.Persons
range: PersonRole
required: false
multivalued: true
description: All persons for this appointment.
WorkBillingInfo:
class_uri: cim:WorkBillingInfo
is_a: Document
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfCustomers
description: "Billing information for work performed for the customer. The history\
\ of Work Billing Info, Invoices, and Payments is to be maintained in associated\
\ ActivityRecords.\r\n"
attributes:
costEstimate:
slot_uri: cim:WorkBillingInfo.costEstimate
range: Money
required: false
multivalued: false
description: 'Estimated cost for work. '
deposit:
slot_uri: cim:WorkBillingInfo.deposit
range: Money
required: false
multivalued: false
description: Amount of price on deposit.
discount:
slot_uri: cim:WorkBillingInfo.discount
range: float
required: false
multivalued: false
description: Discount from standard price.
dueDateTime:
slot_uri: cim:WorkBillingInfo.dueDateTime
range: date
required: false
multivalued: false
description: "Date and time by which payment for bill is expected from client.\r\
\n"
issueDateTime:
slot_uri: cim:WorkBillingInfo.issueDateTime
range: date
required: false
multivalued: false
description: "Date and time bill was issued to client.\r\n"
receivedDateTime:
slot_uri: cim:WorkBillingInfo.receivedDateTime
range: date
required: false
multivalued: false
description: "Date payment was received from client.\r\n"
workPrice:
slot_uri: cim:WorkBillingInfo.workPrice
range: Money
required: false
multivalued: false
description: Amount of bill.
ErpLineItems:
slot_uri: cim:WorkBillingInfo.ErpLineItems
range: ErpInvoiceLineItem
required: false
multivalued: true
Works:
slot_uri: cim:WorkBillingInfo.Works
range: Work
required: false
multivalued: true
CustomerAccount:
slot_uri: cim:WorkBillingInfo.CustomerAccount
range: CustomerAccount
required: false
multivalued: false
OverheadCost:
class_uri: cim:OverheadCost
is_a: WorkIdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfWork
description: Overhead cost applied to work order.
attributes:
code:
slot_uri: cim:OverheadCost.code
range: string
required: false
multivalued: false
description: ' Overhead code.'
cost:
slot_uri: cim:OverheadCost.cost
range: Money
required: false
multivalued: false
description: The overhead cost to be applied.
status:
slot_uri: cim:OverheadCost.status
range: Status
required: false
multivalued: false
WorkCostDetails:
slot_uri: cim:OverheadCost.WorkCostDetails
range: WorkCostDetail
required: false
multivalued: true
WorkTasks:
slot_uri: cim:OverheadCost.WorkTasks
range: OldWorkTask
required: false
multivalued: true
WorkCostSummary:
class_uri: cim:WorkCostSummary
is_a: WorkDocument
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfWork
description: "A roll up by cost type for the entire cost of a work order. For\
\ example, total labor.\r\n"
attributes:
WorkCostDetail:
slot_uri: cim:WorkCostSummary.WorkCostDetail
range: WorkCostDetail
required: false
multivalued: false
PropertyUnit:
class_uri: cim:PropertyUnit
is_a: WorkIdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfWork
description: Unit of property for reporting purposes.
attributes:
accountingUsage:
slot_uri: cim:PropertyUnit.accountingUsage
range: string
required: false
multivalued: false
description: A code that identifies appropriate type of property accounts
such as distribution, streetlgihts, communications.
activityCode:
slot_uri: cim:PropertyUnit.activityCode
range: WorkActionKind
required: false
multivalued: false
description: Activity code identifies a specific and distinguishable work
action.
propertyAccount:
slot_uri: cim:PropertyUnit.propertyAccount
range: string
required: false
multivalued: false
description: Used for property record accounting. For example, in the USA,
this would be a FERC account.
status:
slot_uri: cim:PropertyUnit.status
range: Status
required: false
multivalued: false
CompatibleUnits:
slot_uri: cim:PropertyUnit.CompatibleUnits
range: CompatibleUnit
required: false
multivalued: true
CUMaterialItems:
slot_uri: cim:PropertyUnit.CUMaterialItems
range: CUMaterialItem
required: false
multivalued: true
WorkCostDetails:
slot_uri: cim:PropertyUnit.WorkCostDetails
range: WorkCostDetail
required: false
multivalued: true
CUMaterialItem:
class_uri: cim:CUMaterialItem
is_a: WorkIdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfWork
description: Compatible unit of a consumable supply item. For example, nuts, bolts,
brackets, glue, etc.
attributes:
corporateCode:
slot_uri: cim:CUMaterialItem.corporateCode
range: string
required: false
multivalued: false
description: Code for material.
quantity:
slot_uri: cim:CUMaterialItem.quantity
range: IntegerQuantity
required: false
multivalued: false
description: Quantity of the TypeMaterial for this CU, used to determine estimated
costs based on a per unit cost or a cost per unit length specified in the
TypeMaterial.
status:
slot_uri: cim:CUMaterialItem.status
range: Status
required: false
multivalued: false
TypeMaterial:
slot_uri: cim:CUMaterialItem.TypeMaterial
range: TypeMaterial
required: false
multivalued: false
CompatibleUnits:
slot_uri: cim:CUMaterialItem.CompatibleUnits
range: CompatibleUnit
required: false
multivalued: true
PropertyUnits:
slot_uri: cim:CUMaterialItem.PropertyUnits
range: PropertyUnit
required: false
multivalued: true
TypeMaterial:
class_uri: cim:TypeMaterial
is_a: WorkDocument
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfWork
description: "Documentation for a generic material item that may be used for design,\
\ work and other purposes. Any number of MaterialItems manufactured by various\
\ vendors may be used to perform this TypeMaterial.\r\nNote that class analagous\
\ to \"AssetModel\" is not used for material items. This is because in some\
\ cases, for example, a utility sets up a Master material record for a 3 inch\
\ long half inch diameter steel bolt and they do not necessarily care what specific\
\ supplier is providing the material item. As different vendors are used to\
\ supply the part, the Stock Code of the material item can stay the same. In\
\ other cases, each time the vendor changes, a new stock code is set up so they\
\ can track material used by vendor. Therefore a Material Item \"Model\" is\
\ not typically needed.\r\n"
attributes:
costType:
slot_uri: cim:TypeMaterial.costType
range: string
required: false
multivalued: false
description: "The type of cost to which this Material Item belongs.\r\n"
estUnitCost:
slot_uri: cim:TypeMaterial.estUnitCost
range: Money
required: false
multivalued: false
description: The estimated unit cost of this type of material, either for
a unit cost or cost per unit length. Cost is for material or asset only
and does not include labor to install/construct or configure it.
quantity:
slot_uri: cim:TypeMaterial.quantity
range: string
required: false
multivalued: false
description: The value, unit of measure, and multiplier for the quantity.
stockItem:
slot_uri: cim:TypeMaterial.stockItem
range: boolean
required: false
multivalued: false
description: True if item is a stock item (default).
MaterialItems:
slot_uri: cim:TypeMaterial.MaterialItems
range: MaterialItem
required: false
multivalued: true
ErpReqLineItems:
slot_uri: cim:TypeMaterial.ErpReqLineItems
range: ErpReqLineItem
required: false
multivalued: true
ErpIssueInventories:
slot_uri: cim:TypeMaterial.ErpIssueInventories
range: ErpIssueInventory
required: false
multivalued: true
CUMaterialItems:
slot_uri: cim:TypeMaterial.CUMaterialItems
range: CUMaterialItem
required: false
multivalued: true
ErpIssueInventory:
class_uri: cim:ErpIssueInventory
is_a: ErpIdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfERPSupport
description: Can be used to request an application to process an issue or request
information about an issue.
attributes:
status:
slot_uri: cim:ErpIssueInventory.status
range: Status
required: false
multivalued: false
TypeMaterial:
slot_uri: cim:ErpIssueInventory.TypeMaterial
range: TypeMaterial
required: false
multivalued: false
TypeAsset:
slot_uri: cim:ErpIssueInventory.TypeAsset
range: CatalogAssetType
required: false
multivalued: false
MaterialItem:
class_uri: cim:MaterialItem
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Work
description: "The physical consumable supply used for work and other purposes.\
\ It includes items such as nuts, bolts, brackets, glue, etc.\r\n"
attributes:
quantity:
slot_uri: cim:MaterialItem.quantity
range: IntegerQuantity
required: false
multivalued: false
description: Quantity of material used.
TypeMaterial:
slot_uri: cim:MaterialItem.TypeMaterial
range: TypeMaterial
required: false
multivalued: false
WorkTask:
slot_uri: cim:MaterialItem.WorkTask
range: WorkTask
required: false
multivalued: false
description: The work task that uses the material items
ErpReqLineItem:
class_uri: cim:ErpReqLineItem
is_a: ErpIdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfERPSupport
description: "Information that describes a requested item and its attributes.\r\
\n"
attributes:
code:
slot_uri: cim:ErpReqLineItem.code
range: string
required: false
multivalued: false
cost:
slot_uri: cim:ErpReqLineItem.cost
range: Money
required: false
multivalued: false
description: "Cost of material.\r\n"
deliveryDate:
slot_uri: cim:ErpReqLineItem.deliveryDate
range: date
required: false
multivalued: false
quantity:
slot_uri: cim:ErpReqLineItem.quantity
range: integer
required: false
multivalued: false
description: ' Quantity of item requisitioned.'
status:
slot_uri: cim:ErpReqLineItem.status
range: Status
required: false
multivalued: false
ErpRequisition:
slot_uri: cim:ErpReqLineItem.ErpRequisition
range: ErpRequisition
required: true
multivalued: false
ErpPOLineItem:
slot_uri: cim:ErpReqLineItem.ErpPOLineItem
range: ErpPOLineItem
required: false
multivalued: false
TypeMaterial:
slot_uri: cim:ErpReqLineItem.TypeMaterial
range: TypeMaterial
required: false
multivalued: false
TypeAsset:
slot_uri: cim:ErpReqLineItem.TypeAsset
range: CatalogAssetType
required: false
multivalued: false
ErpQuoteLineItem:
slot_uri: cim:ErpReqLineItem.ErpQuoteLineItem
range: ErpQuoteLineItem
required: false
multivalued: false
ErpRequisition:
class_uri: cim:ErpRequisition
is_a: ErpDocument
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfERPSupport
description: General information that applies to a utility requisition that is
a request for the purchase of goods or services. Typically, a requisition leads
to the creation of a purchase order to a specific supplier.
attributes:
ErpReqLineItems:
slot_uri: cim:ErpRequisition.ErpReqLineItems
range: ErpReqLineItem
required: false
multivalued: true
ErpPOLineItem:
class_uri: cim:ErpPOLineItem
is_a: ErpDocument
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfERPSupport
description: Of an ErpPurchaseOrder, this is an individually ordered item or product
along with the quantity, price and other descriptive information.
attributes:
ErpPurchaseOrder:
slot_uri: cim:ErpPOLineItem.ErpPurchaseOrder
range: ErpPurchaseOrder
required: true
multivalued: false
ErpRecDelLineItem:
slot_uri: cim:ErpPOLineItem.ErpRecDelLineItem
range: ErpRecDelvLineItem
required: false
multivalued: false
ErpReqLineItem:
slot_uri: cim:ErpPOLineItem.ErpReqLineItem
range: ErpReqLineItem
required: false
multivalued: false
AssetModelCatalogueItem:
slot_uri: cim:ErpPOLineItem.AssetModelCatalogueItem
range: AssetModelCatalogueItem
required: false
multivalued: false
ErpRecDelvLineItem:
class_uri: cim:ErpRecDelvLineItem
is_a: ErpIdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfERPSupport
description: Of an ErpReceiveDelivery, this is an individually received good or
service by the Organisation receiving goods or services. It may be used to indicate
receipt of goods in conjunction with a purchase order line item.
attributes:
status:
slot_uri: cim:ErpRecDelvLineItem.status
range: Status
required: false
multivalued: false
ErpReceiveDelivery:
slot_uri: cim:ErpRecDelvLineItem.ErpReceiveDelivery
range: ErpReceiveDelivery
required: true
multivalued: false
ErpPOLineItem:
slot_uri: cim:ErpRecDelvLineItem.ErpPOLineItem
range: ErpPOLineItem
required: false
multivalued: false
ErpInvoiceLineItem:
slot_uri: cim:ErpRecDelvLineItem.ErpInvoiceLineItem
range: ErpInvoiceLineItem
required: false
multivalued: false
Assets:
slot_uri: cim:ErpRecDelvLineItem.Assets
range: Asset
required: false
multivalued: true
ErpReceiveDelivery:
class_uri: cim:ErpReceiveDelivery
is_a: ErpDocument
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfERPSupport
description: Transaction for an Organisation receiving goods or services that
may be used to indicate receipt of goods in conjunction with a purchase order.
A receivable is an open (unpaid) item in the Accounts Receivable ledger.
attributes:
ErpRecDelvLineItems:
slot_uri: cim:ErpReceiveDelivery.ErpRecDelvLineItems
range: ErpRecDelvLineItem
required: false
multivalued: true
ErpPurchaseOrder:
class_uri: cim:ErpPurchaseOrder
is_a: ErpDocument
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfERPSupport
description: A document that communicates an order to purchase goods from a buyer
to a supplier. The PurchaseOrder carries information to and from the buyer and
supplier. It is a legally binding document once both Parties agree to the contents
and the specified terms and conditions of the order.
attributes:
ErpPOLineItems:
slot_uri: cim:ErpPurchaseOrder.ErpPOLineItems
range: ErpPOLineItem
required: false
multivalued: true
ErpCompetency:
class_uri: cim:ErpCompetency
is_a: ErpIdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfERPSupport
description: Information that describes aptitudes of a utility employee. Unlike
Skills that an ErpPerson must be certified to perform before undertaking certain
type of assignments (to be able to perfrom a Craft), ErpCompetency has more
to do with typical Human Resource (HR) matters such as schooling, training,
etc.
attributes:
ErpPersons:
slot_uri: cim:ErpCompetency.ErpPersons
range: OldPerson
required: false
multivalued: true
PersonPropertyRole:
class_uri: cim:PersonPropertyRole
is_a: Role
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfCommon
description: 'The role of a person relative to a given piece of property. Examples
of roles include: owner, renter, contractor, etc.'
attributes:
LandProperty:
slot_uri: cim:PersonPropertyRole.LandProperty
range: LandProperty
required: true
multivalued: false
Person:
slot_uri: cim:PersonPropertyRole.Person
range: OldPerson
required: true
multivalued: false
Role:
class_uri: cim:Role
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfCommon
description: "Enumeration of potential roles that might be played by one object\
\ relative to another.\r\n"
attributes:
status:
slot_uri: cim:Role.status
range: Status
required: false
multivalued: false
type:
slot_uri: cim:Role.type
range: string
required: false
multivalued: false
description: "Type of role.\r\n"
LandProperty:
class_uri: cim:LandProperty
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfLocations
description: Information about a particular piece of (land) property such as its
use. Ownership of the property may be determined through associations to Organisations
and/or ErpPersons.
attributes:
demographicKind:
slot_uri: cim:LandProperty.demographicKind
range: DemographicKind
required: false
multivalued: false
description: Demographics around the site.
externalRecordReference:
slot_uri: cim:LandProperty.externalRecordReference
range: string
required: false
multivalued: false
description: Reference allocated by the governing organisation (such as municipality)
to this piece of land that has a formal reference to Surveyor General's
records. The governing organisation is specified in associated Organisation.
kind:
slot_uri: cim:LandProperty.kind
range: LandPropertyKind
required: false
multivalued: false
description: Kind of (land) property, categorised according to its main functional
use from the utility's perspective.
status:
slot_uri: cim:LandProperty.status
range: Status
required: false
multivalued: false
ErpOrganisationRoles:
slot_uri: cim:LandProperty.ErpOrganisationRoles
range: PropertyOrganisationRole
required: false
multivalued: true
AssetContainers:
slot_uri: cim:LandProperty.AssetContainers
range: AssetContainer
required: false
multivalued: true
ErpSiteLevelDatas:
slot_uri: cim:LandProperty.ErpSiteLevelDatas
range: ErpSiteLevelData
required: false
multivalued: true
ErpPersonRoles:
slot_uri: cim:LandProperty.ErpPersonRoles
range: PersonPropertyRole
required: false
multivalued: true
Locations:
slot_uri: cim:LandProperty.Locations
range: Location
required: false
multivalued: true
description: The spatail description of a piece of property.
LocationGrants:
slot_uri: cim:LandProperty.LocationGrants
range: LocationGrant
required: false
multivalued: true
description: All location grants this land property has.
RightOfWays:
slot_uri: cim:LandProperty.RightOfWays
range: RightOfWay
required: false
multivalued: true
description: All rights of way this land property has.
RightOfWay:
class_uri: cim:RightOfWay
is_a: Agreement
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfLocations
description: ' A right-of-way (ROW) is for land where it is lawful to use for
a public road, an electric power line, etc. Note that the association to Location,
Asset, Organisation, etc. for the Grant is inherited from Agreement, a type
of Document.'
attributes:
propertyData:
slot_uri: cim:RightOfWay.propertyData
range: string
required: false
multivalued: false
description: Property related information that describes the ROW's land parcel.
For example, it may be a deed book number, deed book page number, and parcel
number.
LandProperties:
slot_uri: cim:RightOfWay.LandProperties
range: LandProperty
required: false
multivalued: true
description: All land properties this right of way applies to.
PropertyOrganisationRole:
class_uri: cim:PropertyOrganisationRole
is_a: OrganisationRole
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfCommon
description: "Role an organisation plays with respect to property (for example,\
\ the organisation may be the owner, renter, occupier, taxiing authority, etc.).\r\
\n"
attributes:
LandProperty:
slot_uri: cim:PropertyOrganisationRole.LandProperty
range: LandProperty
required: true
multivalued: false
AssetContainer:
class_uri: cim:AssetContainer
is_a: Asset
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: Asset that is aggregation of other assets such as conductors, transformers,
switchgear, land, fences, buildings, equipment, vehicles, etc.
attributes:
Seals:
slot_uri: cim:AssetContainer.Seals
range: Seal
required: false
multivalued: true
description: All seals applied to this asset container.
LandProperties:
slot_uri: cim:AssetContainer.LandProperties
range: LandProperty
required: false
multivalued: true
Assets:
slot_uri: cim:AssetContainer.Assets
range: Asset
required: false
multivalued: true
description: All assets within this container asset.
Seal:
class_uri: cim:Seal
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: "Physically controls access to AssetContainers.\r\n"
attributes:
appliedDateTime:
slot_uri: cim:Seal.appliedDateTime
range: date
required: false
multivalued: false
description: "Date and time this seal has been applied.\r\n"
condition:
slot_uri: cim:Seal.condition
range: SealConditionKind
required: false
multivalued: false
description: Condition of seal.
kind:
slot_uri: cim:Seal.kind
range: SealKind
required: false
multivalued: false
description: Kind of seal.
sealNumber:
slot_uri: cim:Seal.sealNumber
range: string
required: false
multivalued: false
description: (reserved word) Seal number.
AssetContainer:
slot_uri: cim:Seal.AssetContainer
range: AssetContainer
required: false
multivalued: false
description: Asset container to which this seal is applied.
ErpSiteLevelData:
class_uri: cim:ErpSiteLevelData
is_a: ErpIdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfERPSupport
description: For a utility, general information that describes physical locations
of organizations or the location codes and their meanings. This enables ERP
applications to ensure that the physical location identifiers are synchronized
between the business applications.
attributes:
status:
slot_uri: cim:ErpSiteLevelData.status
range: Status
required: false
multivalued: false
LandProperty:
slot_uri: cim:ErpSiteLevelData.LandProperty
range: LandProperty
required: false
multivalued: false
LocationGrant:
class_uri: cim:LocationGrant
is_a: Agreement
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfLocations
description: A grant provides a right, as defined by type, for a parcel of land.
Note that the association to Location, Asset, Organisation, etc. for the Grant
is inherited from Agreement, a type of Document.
attributes:
propertyData:
slot_uri: cim:LocationGrant.propertyData
range: string
required: false
multivalued: false
description: Property related information that describes the Grant's land
parcel. For example, it may be a deed book number, deed book page number,
and parcel number.
LandProperty:
slot_uri: cim:LocationGrant.LandProperty
range: LandProperty
required: false
multivalued: false
description: Land property this location grant applies to.
MeasurementValue:
class_uri: cim:MeasurementValue
is_a: IOPoint
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Meas
description: "The current state for a measurement. A state value is an instance\
\ of a measurement from a specific source. Measurements can be associated with\
\ many state values, each representing a different source for the measurement.\r\
\n"
attributes:
sensorAccuracy:
slot_uri: cim:MeasurementValue.sensorAccuracy
range: PerCent
required: false
multivalued: false
description: The limit, expressed as a percentage of the sensor maximum, that
errors will not exceed when the sensor is used under reference conditions.
timeStamp:
slot_uri: cim:MeasurementValue.timeStamp
range: date
required: false
multivalued: false
description: The time when the value was last updated.
RemoteSource:
slot_uri: cim:MeasurementValue.RemoteSource
range: RemoteSource
required: false
multivalued: false
description: Link to the physical telemetered point associated with this measurement.
MeasurementValueQuality:
slot_uri: cim:MeasurementValue.MeasurementValueQuality
range: MeasurementValueQuality
required: false
multivalued: false
description: A MeasurementValue has a MeasurementValueQuality associated with
it.
MeasurementValueSource:
slot_uri: cim:MeasurementValue.MeasurementValueSource
range: MeasurementValueSource
required: true
multivalued: false
description: A reference to the type of source that updates the MeasurementValue,
e.g. SCADA, CCLink, manual, etc. User conventions for the names of sources
are contained in the introduction to IEC 61970-301.
CalculationMethodHierarchy:
slot_uri: cim:MeasurementValue.CalculationMethodHierarchy
range: CalculationMethodHierarchy
required: false
multivalued: false
ProcedureDataSet:
slot_uri: cim:MeasurementValue.ProcedureDataSet
range: ProcedureDataSet
required: false
multivalued: true
description: Procedure data set that applies to this mesurement value.
ErpPerson:
slot_uri: cim:MeasurementValue.ErpPerson
range: OldPerson
required: false
multivalued: false
IOPoint:
class_uri: cim:IOPoint
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Meas
description: The class describe a measurement or control value. The purpose is
to enable having attributes and associations common for measurement and control.
attributes:
BilateralToIOPoint:
slot_uri: cim:IOPoint.BilateralToIOPoint
range: ProvidedBilateralPoint
required: false
multivalued: true
description: Bilateral ICCP point for the measurement or control.
IOPointSource:
slot_uri: cim:IOPoint.IOPointSource
range: IOPointSource
required: false
multivalued: false
description: Local merasurement value source for an ICCP point.
IOPointSource:
class_uri: cim:IOPointSource
is_a: MeasurementValueSource
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.ICCPConfiguration
description: Indicates the point source for an IO Point.
attributes:
IOPoint:
slot_uri: cim:IOPointSource.IOPoint
range: IOPoint
required: false
multivalued: true
description: ICCP point for a local measurement value source.
MeasurementValueSource:
class_uri: cim:MeasurementValueSource
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Meas
description: MeasurementValueSource describes the alternative sources updating
a MeasurementValue. User conventions for how to use the MeasurementValueSource
attributes are defined in IEC 61970-301.
attributes:
MeasurementValues:
slot_uri: cim:MeasurementValueSource.MeasurementValues
range: MeasurementValue
required: false
multivalued: true
description: The MeasurementValues updated by the source.
ProvidedBilateralPoint:
class_uri: cim:ProvidedBilateralPoint
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.ICCPConfiguration
description: Allows declaration of ICCP points to be provided through a Bilateral
Table agreement.
attributes:
BilateralExchangeActor:
slot_uri: cim:ProvidedBilateralPoint.BilateralExchangeActor
range: BilateralExchangeActor
required: true
multivalued: false
description: Remote peer that will receive ICCP information in a Bilateral
table.
IOPoint:
slot_uri: cim:ProvidedBilateralPoint.IOPoint
range: IOPoint
required: false
multivalued: false
description: Measurement or control for the bilateral ICCP point.
BilateralExchangeActor:
class_uri: cim:BilateralExchangeActor
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.ICCPConfiguration
description: BilateralExchangeActor describes an actor that provides ICCP data,
consumes ICCP data or both. The ICCP data provider lists the data it makes available
to an ICCP data consumer. This data is described by ProvidedBilateralPoints.
The relation between an ICCP data provider and a consumer is established by
a BilateralExchangeAgreement. It is up to the ICCP data consumer to select
what ProvidedBilateralPoints to use. The selection made is not described in
this information model.
attributes:
ProviderBilateralExchange:
slot_uri: cim:BilateralExchangeActor.ProviderBilateralExchange
range: BilateralExchangeAgreement
required: false
multivalued: true
description: Agreement to information provider.
CommunicationLink:
slot_uri: cim:BilateralExchangeActor.CommunicationLink
range: CommunicationLink
required: false
multivalued: true
description: Communication addressing for a Bilateral Table used by a ICCP
data provider or consumer.
ConsumerBilateralExchange:
slot_uri: cim:BilateralExchangeActor.ConsumerBilateralExchange
range: BilateralExchangeAgreement
required: false
multivalued: true
description: Agreement to information subscriber.
ProvidedBilateralIOPoint:
slot_uri: cim:BilateralExchangeActor.ProvidedBilateralIOPoint
range: ProvidedBilateralPoint
required: false
multivalued: true
description: ICCP information in a Bilateral table that will be exposed to
a remote peer.
CommunicationLink:
class_uri: cim:CommunicationLink
is_a: PowerSystemResource
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.SCADA
description: The connection to remote units is through one or more communication
links. Reduntant links may exist. The CommunicationLink class inherits PowerSystemResource.
The intention is to allow CommunicationLinks to have Measurements. These Measurements
can be used to model link status as operational, out of service, unit failure
etc.
attributes:
RemoteUnits:
slot_uri: cim:CommunicationLink.RemoteUnits
range: RemoteUnit
required: false
multivalued: true
description: RTUs may be attached to communication links.
BilateralExchangeActor:
slot_uri: cim:CommunicationLink.BilateralExchangeActor
range: BilateralExchangeActor
required: false
multivalued: false
description: ICCP data provider or consumer using communication addressing
for a Bilateral table.
RemoteUnit:
class_uri: cim:RemoteUnit
is_a: PowerSystemResource
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.SCADA
description: A remote unit can be an RTU, IED, substation control system, control
centre, etc. The communication with the remote unit can be through various standard
protocols (e.g. IEC 61870, IEC 61850) or non standard protocols (e.g. DNP, RP570,
etc.). A remote unit contains remote data points that might be telemetered,
collected or calculated. The RemoteUnit class inherits PowerSystemResource.
The intention is to allow RemoteUnits to have Measurements. These Measurements
can be used to model unit status as operational, out of service, unit failure,
etc.
attributes:
remoteUnitType:
slot_uri: cim:RemoteUnit.remoteUnitType
range: RemoteUnitType
required: false
multivalued: false
description: Type of remote unit.
CommunicationLinks:
slot_uri: cim:RemoteUnit.CommunicationLinks
range: CommunicationLink
required: true
multivalued: true
description: RTUs may be attached to communication links.
RemotePoints:
slot_uri: cim:RemoteUnit.RemotePoints
range: RemotePoint
required: false
multivalued: true
description: Remote points this Remote unit contains.
RemotePoint:
class_uri: cim:RemotePoint
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.SCADA
description: For an RTU, remote points correspond to telemetered values or control
outputs. Other units (e.g. control centres) usually also contain calculated
values.
attributes:
RemoteUnit:
slot_uri: cim:RemotePoint.RemoteUnit
range: RemoteUnit
required: true
multivalued: false
description: Remote unit this point belongs to.
BilateralExchangeAgreement:
class_uri: cim:BilateralExchangeAgreement
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.ICCPConfiguration
description: This is the representation of the information exchange agreement
between peers.
attributes:
Consumer:
slot_uri: cim:BilateralExchangeAgreement.Consumer
range: BilateralExchangeActor
required: false
multivalued: false
description: Subscriber of information from a remote peer.
Provider:
slot_uri: cim:BilateralExchangeAgreement.Provider
range: BilateralExchangeActor
required: true
multivalued: false
description: Provider of information to a remote peer.
MeasurementValueQuality:
class_uri: cim:MeasurementValueQuality
is_a: Quality61850
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Meas
description: Measurement quality flags. Bits 0-10 are defined for substation automation
in IEC 61850-7-3. Bits 11-15 are reserved for future expansion by that document.
Bits 16-31 are reserved for EMS applications.
attributes:
MeasurementValue:
slot_uri: cim:MeasurementValueQuality.MeasurementValue
range: MeasurementValue
required: true
multivalued: false
description: A MeasurementValue has a MeasurementValueQuality associated with
it.
Quality61850:
class_uri: cim:Quality61850
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Meas
description: "Quality flags in this class are as defined in IEC 61850, except\
\ for estimatorReplaced, which has been included in this class for convenience.\r\
\n"
attributes:
badReference:
slot_uri: cim:Quality61850.badReference
range: boolean
required: false
multivalued: false
description: Measurement value may be incorrect due to a reference being out
of calibration.
estimatorReplaced:
slot_uri: cim:Quality61850.estimatorReplaced
range: boolean
required: false
multivalued: false
description: Value has been replaced by State Estimator. estimatorReplaced
is not an IEC61850 quality bit but has been put in this class for convenience.
failure:
slot_uri: cim:Quality61850.failure
range: boolean
required: false
multivalued: false
description: This identifier indicates that a supervision function has detected
an internal or external failure, e.g. communication failure.
oldData:
slot_uri: cim:Quality61850.oldData
range: boolean
required: false
multivalued: false
description: Measurement value is old and possibly invalid, as it has not
been successfully updated during a specified time interval.
operatorBlocked:
slot_uri: cim:Quality61850.operatorBlocked
range: boolean
required: false
multivalued: false
description: 'Measurement value is blocked and hence unavailable for transmission. '
oscillatory:
slot_uri: cim:Quality61850.oscillatory
range: boolean
required: false
multivalued: false
description: To prevent some overload of the communication it is sensible
to detect and suppress oscillating (fast changing) binary inputs. If a signal
changes in a defined time twice in the same direction (from 0 to 1 or from
1 to 0) then oscillation is detected and the detail quality identifier "oscillatory"
is set. If it is detected a configured numbers of transient changes could
be passed by. In this time the validity status "questionable" is set. If
after this defined numbers of changes the signal is still in the oscillating
state the value shall be set either to the opposite state of the previous
stable value or to a defined default value. In this case the validity status
"questionable" is reset and "invalid" is set as long as the signal is oscillating.
If it is configured such that no transient changes should be passed by then
the validity status "invalid" is set immediately in addition to the detail
quality identifier "oscillatory" (used for status information only).
outOfRange:
slot_uri: cim:Quality61850.outOfRange
range: boolean
required: false
multivalued: false
description: Measurement value is beyond a predefined range of value.
overFlow:
slot_uri: cim:Quality61850.overFlow
range: boolean
required: false
multivalued: false
description: 'Measurement value is beyond the capability of being represented
properly. For example, a counter value overflows from maximum count back
to a value of zero. '
source:
slot_uri: cim:Quality61850.source
range: Source
required: false
multivalued: false
description: Source gives information related to the origin of a value. The
value may be acquired from the process, defaulted or substituted.
suspect:
slot_uri: cim:Quality61850.suspect
range: boolean
required: false
multivalued: false
description: A correlation function has detected that the value is not consistent
with other values. Typically set by a network State Estimator.
test:
slot_uri: cim:Quality61850.test
range: boolean
required: false
multivalued: false
description: Measurement value is transmitted for test purposes.
validity:
slot_uri: cim:Quality61850.validity
range: Validity
required: false
multivalued: false
description: Validity of the measurement value.
CalculationMethodHierarchy:
class_uri: cim:CalculationMethodHierarchy
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetMeas
description: "The hierarchy of calculation methods used to derive this measurement.\r\
\n."
attributes:
MeasurementValue:
slot_uri: cim:CalculationMethodHierarchy.MeasurementValue
range: MeasurementValue
required: false
multivalued: false
description: Measurement value to which this calculation method hierarchy
applies.
CalculationMethodOrder:
slot_uri: cim:CalculationMethodHierarchy.CalculationMethodOrder
range: CalculationMethodOrder
required: false
multivalued: true
description: Order of a statistical calculation associated with this calculation
method hierarchy.
Measurement:
slot_uri: cim:CalculationMethodHierarchy.Measurement
range: Measurement
required: false
multivalued: true
description: Measurement to which this calculation method hierarchy applies.
CalculationMethodOrder:
class_uri: cim:CalculationMethodOrder
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetMeas
description: "The order of this calculation method in a hierarchy of calculation\
\ methods.\r\n"
attributes:
order:
slot_uri: cim:CalculationMethodOrder.order
range: integer
required: true
multivalued: false
description: Order of the statistical calculation method within the calculation
method hierarchy.
CalculationMethodHierarchy:
slot_uri: cim:CalculationMethodOrder.CalculationMethodHierarchy
range: CalculationMethodHierarchy
required: true
multivalued: false
description: The calculation method hierarchy of which this order of statistical
calculation is a member.
StatisicalCalculation:
slot_uri: cim:CalculationMethodOrder.StatisicalCalculation
range: StatisticalCalculation
required: true
multivalued: false
description: The statistical calculation done at this order.
StatisticalCalculation:
class_uri: cim:StatisticalCalculation
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetMeas
description: "Description of statistical calculation performed.\r\n"
attributes:
calculationMode:
slot_uri: cim:StatisticalCalculation.calculationMode
range: CalculationModeKind
required: false
multivalued: false
description: Calculation mode.
calculationTechnique:
slot_uri: cim:StatisticalCalculation.calculationTechnique
range: CalculationTechniqueKind
required: false
multivalued: false
description: Kind of statistical calculation, specifying how the measurement
value is calculated.
CalculationMethodOrder:
slot_uri: cim:StatisticalCalculation.CalculationMethodOrder
range: CalculationMethodOrder
required: false
multivalued: true
description: The order in which this statistical calculation is done.
Measurement:
class_uri: cim:Measurement
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Meas
description: "A Measurement represents any measured, calculated or non-measured\
\ non-calculated quantity. Any piece of equipment may contain Measurements,\
\ e.g. a substation may have temperature measurements and door open indications,\
\ a transformer may have oil temperature and tank pressure measurements, a bay\
\ may contain a number of power flow measurements and a Breaker may contain\
\ a switch status measurement. \r\nThe PSR - Measurement association is intended\
\ to capture this use of Measurement and is included in the naming hierarchy\
\ based on EquipmentContainer. The naming hierarchy typically has Measurements\
\ as leaves, e.g. Substation-VoltageLevel-Bay-Switch-Measurement.\r\nSome Measurements\
\ represent quantities related to a particular sensor location in the network,\
\ e.g. a voltage transformer (VT) or potential transformer (PT) at a busbar\
\ or a current transformer (CT) at the bar between a breaker and an isolator.\
\ The sensing position is not captured in the PSR - Measurement association.\
\ Instead it is captured by the Measurement - Terminal association that is used\
\ to define the sensing location in the network topology. The location is defined\
\ by the connection of the Terminal to ConductingEquipment. \r\nIf both a Terminal\
\ and PSR are associated, and the PSR is of type ConductingEquipment, the associated\
\ Terminal should belong to that ConductingEquipment instance.\r\nWhen the sensor\
\ location is needed both Measurement-PSR and Measurement-Terminal are used.\
\ The Measurement-Terminal association is never used alone."
attributes:
measurementType:
slot_uri: cim:Measurement.measurementType
range: string
required: false
multivalued: false
description: "Specifies the type of measurement. For example, this specifies\
\ if the measurement represents an indoor temperature, outdoor temperature,\
\ bus voltage, line flow, etc.\r\nWhen the measurementType is set to \"\
Specialization\", the type of Measurement is defined in more detail by the\
\ specialized class which inherits from Measurement.\r\n\r\n"
phases:
slot_uri: cim:Measurement.phases
range: PhaseCode
required: false
multivalued: false
description: "Indicates to which phases the measurement applies and avoids\
\ the need to use 'measurementType' to also encode phase information (which\
\ would explode the types). The phase information in Measurement, along\
\ with 'measurementType' and 'phases' uniquely defines a Measurement for\
\ a device, based on normal network phase. Their meaning will not change\
\ when the computed energizing phasing is changed due to jumpers or other\
\ reasons.\r\nIf the attribute is missing three phases (ABC) shall be assumed."
unitMultiplier:
slot_uri: cim:Measurement.unitMultiplier
range: UnitMultiplier
required: false
multivalued: false
description: The unit multiplier of the measured quantity.
unitSymbol:
slot_uri: cim:Measurement.unitSymbol
range: UnitSymbol
required: false
multivalued: false
description: The unit of measure of the measured quantity.
Terminal:
slot_uri: cim:Measurement.Terminal
range: ACDCTerminal
required: false
multivalued: false
description: One or more measurements may be associated with a terminal in
the network.
ProtectiveActionAdjustment:
slot_uri: cim:Measurement.ProtectiveActionAdjustment
range: ProtectiveActionAdjustment
required: false
multivalued: true
CalculationMethodHierarchy:
slot_uri: cim:Measurement.CalculationMethodHierarchy
range: CalculationMethodHierarchy
required: false
multivalued: false
description: Calculation method hierarchy which applies to this analog.
PowerSystemResource:
slot_uri: cim:Measurement.PowerSystemResource
range: PowerSystemResource
required: false
multivalued: false
description: The power system resource that contains the measurement.
PinMeasurement:
slot_uri: cim:Measurement.PinMeasurement
range: PinMeasurement
required: false
multivalued: true
MeasurementCalculatorInput:
slot_uri: cim:Measurement.MeasurementCalculatorInput
range: MeasurementCalculatorInput
required: false
multivalued: true
Asset:
slot_uri: cim:Measurement.Asset
range: Asset
required: false
multivalued: false
description: Asset that has a measurement
MeasurementAction:
slot_uri: cim:Measurement.MeasurementAction
range: MeasurementAction
required: false
multivalued: false
description: The measurement action that is performed on the measurement
Locations:
slot_uri: cim:Measurement.Locations
range: Location
required: false
multivalued: true
description: Location of this measurement.
Procedures:
slot_uri: cim:Measurement.Procedures
range: Procedure
required: false
multivalued: true
description: Measurements are specified in types of documents, such as procedures.
PinMeasurement:
class_uri: cim:PinMeasurement
is_a: GateInputPin
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfSIPS
description: 'Gate input pin that is associated with a Measurement or a calculation
of Measurement. '
attributes:
Measurement:
slot_uri: cim:PinMeasurement.Measurement
range: Measurement
required: false
multivalued: false
description: The Measurement that should be used in compare.
MeasurementCalculator:
slot_uri: cim:PinMeasurement.MeasurementCalculator
range: MeasurementCalculator
required: false
multivalued: false
description: Result of the calculation used as input to a gate.
GateInputPin:
class_uri: cim:GateInputPin
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfSIPS
description: Input pin for a logical gate. The condition described in the input
pin will give a logical true or false. Result from measurement and calculation
are converted to a true or false.
attributes:
absoluteValue:
slot_uri: cim:GateInputPin.absoluteValue
range: boolean
required: false
multivalued: false
description: 'If true, use the absolute value for compare.. '
aDLogicKind:
slot_uri: cim:GateInputPin.aDLogicKind
range: AnalogToDigitalLogicKind
required: false
multivalued: false
description: The compare operation.
duration:
slot_uri: cim:GateInputPin.duration
range: Seconds
required: false
multivalued: false
description: The duration the compare condition need to be present before
given a true. Default is 0 seconds.
negate:
slot_uri: cim:GateInputPin.negate
range: boolean
required: false
multivalued: false
description: Invert/negate the result of the compare.
thresholdPercentage:
slot_uri: cim:GateInputPin.thresholdPercentage
range: PerCent
required: false
multivalued: false
description: The threshold percentage that should be used for compare with
the percentage change between input value and threshold value.
thresholdValue:
slot_uri: cim:GateInputPin.thresholdValue
range: float
required: false
multivalued: false
description: The threshold value that should be used for compare with the
input value.
Gate:
slot_uri: cim:GateInputPin.Gate
range: Gate
required: true
multivalued: false
Gate:
class_uri: cim:Gate
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfSIPS
description: Logical gate than support logical operation based on the input.
attributes:
kind:
slot_uri: cim:Gate.kind
range: GateLogicKind
required: false
multivalued: false
description: The logical operation of the gate.
RemedialActionScheme:
slot_uri: cim:Gate.RemedialActionScheme
range: RemedialActionScheme
required: false
multivalued: true
PinGate:
slot_uri: cim:Gate.PinGate
range: PinGate
required: false
multivalued: true
StageTriggerArmed:
slot_uri: cim:Gate.StageTriggerArmed
range: StageTrigger
required: false
multivalued: true
ProtectiveActionCom:
slot_uri: cim:Gate.ProtectiveActionCom
range: ProtectiveAction
required: false
multivalued: true
description: For the ProtectiveAction to be activated the condition for communication
needs to be met (true).
StageTriggerCom:
slot_uri: cim:Gate.StageTriggerCom
range: StageTrigger
required: false
multivalued: true
StageTrigger:
slot_uri: cim:Gate.StageTrigger
range: StageTrigger
required: false
multivalued: true
TriggerCondition:
slot_uri: cim:Gate.TriggerCondition
range: TriggerCondition
required: false
multivalued: true
ProtectiveActionEnabled:
slot_uri: cim:Gate.ProtectiveActionEnabled
range: ProtectiveAction
required: false
multivalued: true
GateInputPin:
slot_uri: cim:Gate.GateInputPin
range: GateInputPin
required: true
multivalued: true
description: Input to the gate.
StageTrigger:
class_uri: cim:StageTrigger
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfSIPS
description: Condition that is triggered either by TriggerCondition of by gate
condition within a stage and has remedial action-s.
attributes:
armed:
slot_uri: cim:StageTrigger.armed
range: boolean
required: false
multivalued: false
description: The status of the class set by operation or by signal. Optional
field that will override other status fields.
normalArmed:
slot_uri: cim:StageTrigger.normalArmed
range: boolean
required: false
multivalued: false
description: The default/normal value used when other active signal/values
are missing.
priority:
slot_uri: cim:StageTrigger.priority
range: integer
required: false
multivalued: false
description: Priority of trigger. 0 = don t care (default) 1 = highest priority.
2 is less than 1 and so on. A trigger with the highest priority will trigger
first.
Stage:
slot_uri: cim:StageTrigger.Stage
range: Stage
required: true
multivalued: false
GateArmed:
slot_uri: cim:StageTrigger.GateArmed
range: Gate
required: false
multivalued: false
description: Association to a Gate that through a gate logic and input pin
defines arming of the StageTrigger.
GateComCondition:
slot_uri: cim:StageTrigger.GateComCondition
range: Gate
required: false
multivalued: false
description: For the StageTrigger to active the set of protective actions
the condition for communication needs to be met (true).
GateTrigger:
slot_uri: cim:StageTrigger.GateTrigger
range: Gate
required: false
multivalued: false
description: The Gate result that trigger the StageTrigger and thereby executing
the a set of protective actions.
ProtectiveActionCollection:
slot_uri: cim:StageTrigger.ProtectiveActionCollection
range: ProtectiveActionCollection
required: true
multivalued: false
ProtectiveActionCollection:
class_uri: cim:ProtectiveActionCollection
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfSIPS
description: A collection of protective actions to protect the integrity of the
power system.
attributes:
StageTrigger:
slot_uri: cim:ProtectiveActionCollection.StageTrigger
range: StageTrigger
required: false
multivalued: true
description: When condition to the StageTrigger is met, the actions in the
ProtectiveActionCollection are activated/triggered.
ProtectiveAction:
slot_uri: cim:ProtectiveActionCollection.ProtectiveAction
range: ProtectiveAction
required: true
multivalued: true
description: Set of ProtectiveAction belonging to a ProtectiveActionCollection.
ProtectiveAction:
class_uri: cim:ProtectiveAction
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfSIPS
description: A protective action for supporting the integrity of the power system.
attributes:
enabled:
slot_uri: cim:ProtectiveAction.enabled
range: boolean
required: false
multivalued: false
description: The status of the class set by operation or by signal. Optional
field that will override other status fields.
normalEnabled:
slot_uri: cim:ProtectiveAction.normalEnabled
range: boolean
required: false
multivalued: false
description: The default/normal value used when other active signal/values
are missing.
GateComCondition:
slot_uri: cim:ProtectiveAction.GateComCondition
range: Gate
required: false
multivalued: false
GateEnabledCondition:
slot_uri: cim:ProtectiveAction.GateEnabledCondition
range: Gate
required: false
multivalued: false
description: Association to a Gate that through a gate logic and input pin
defines enabling of the ProtectiveAction.
ProtectionEquipment:
slot_uri: cim:ProtectiveAction.ProtectionEquipment
range: ProtectionEquipment
required: false
multivalued: false
ProtectiveActionCollection:
slot_uri: cim:ProtectiveAction.ProtectiveActionCollection
range: ProtectiveActionCollection
required: true
multivalued: false
ProtectionEquipment:
class_uri: cim:ProtectionEquipment
is_a: Equipment
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Protection
description: An electrical device designed to respond to input conditions in a
prescribed manner and after specified conditions are met to cause contact operation
or similar abrupt change in associated electric control circuits, or simply
to display the detected condition. Protection equipment is associated with conducting
equipment and usually operate circuit breakers.
attributes:
highLimit:
slot_uri: cim:ProtectionEquipment.highLimit
range: float
required: false
multivalued: false
description: The maximum allowable value.
lowLimit:
slot_uri: cim:ProtectionEquipment.lowLimit
range: float
required: false
multivalued: false
description: The minimum allowable value.
powerDirectionFlag:
slot_uri: cim:ProtectionEquipment.powerDirectionFlag
range: boolean
required: false
multivalued: false
description: Direction same as positive active power flow value.
relayDelayTime:
slot_uri: cim:ProtectionEquipment.relayDelayTime
range: Seconds
required: false
multivalued: false
description: The time delay from detection of abnormal conditions to relay
operation.
unitMultiplier:
slot_uri: cim:ProtectionEquipment.unitMultiplier
range: UnitMultiplier
required: false
multivalued: false
description: The unit multiplier of the value.
unitSymbol:
slot_uri: cim:ProtectionEquipment.unitSymbol
range: UnitSymbol
required: false
multivalued: false
description: The unit of measure of the value.
ProtectedSwitches:
slot_uri: cim:ProtectionEquipment.ProtectedSwitches
range: ProtectedSwitch
required: false
multivalued: true
description: Protected switches operated by this ProtectionEquipment.
ConductingEquipments:
slot_uri: cim:ProtectionEquipment.ConductingEquipments
range: ConductingEquipment
required: false
multivalued: true
description: Protection equipment may be used to protect specific conducting
equipment.
ProtectiveAction:
slot_uri: cim:ProtectionEquipment.ProtectiveAction
range: ProtectiveAction
required: false
multivalued: true
description: Protective action can emulate the action done by one or more
protection equipment. In a node breaker model were protective equipment
is model this association will be used.
ProtectedSwitch:
class_uri: cim:ProtectedSwitch
is_a: Switch
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: A ProtectedSwitch is a switching device that can be operated by ProtectionEquipment.
attributes:
breakingCapacity:
slot_uri: cim:ProtectedSwitch.breakingCapacity
range: CurrentFlow
required: false
multivalued: false
description: "The maximum fault current a breaking device can break safely\
\ under prescribed conditions of use.\r\n"
OperatedByProtectionEquipment:
slot_uri: cim:ProtectedSwitch.OperatedByProtectionEquipment
range: ProtectionEquipment
required: false
multivalued: true
description: Protection equipments that operate this ProtectedSwitch.
RecloseSequences:
slot_uri: cim:ProtectedSwitch.RecloseSequences
range: RecloseSequence
required: false
multivalued: true
description: A breaker may have zero or more automatic reclosures after a
trip occurs.
Switch:
class_uri: cim:Switch
is_a: ConductingEquipment
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: A generic device designed to close, or open, or both, one or more
electric circuits. All switches are two terminal devices including grounding
switches. The ACDCTerminal.connected at the two sides of the switch shall not
be considered for assessing switch connectivity, i.e. only Switch.open, .normalOpen
and .locked are relevant.
attributes:
locked:
slot_uri: cim:Switch.locked
range: boolean
required: false
multivalued: false
description: "If true, the switch is locked. The resulting switch state is\
\ a combination of locked and Switch.open attributes as follows:\r\n\r\
\n\t- locked=true and Switch.open=true. The resulting state is open and\
\ locked;
\r\n\t- locked=false and Switch.open=true. The resulting\
\ state is open;
\r\n\t- locked=false and Switch.open=false. The resulting\
\ state is closed.
\r\n
"
normalOpen:
slot_uri: cim:Switch.normalOpen
range: boolean
required: false
multivalued: false
description: The attribute is used in cases when no Measurement for the status
value is present. If the Switch has a status measurement the Discrete.normalValue
is expected to match with the Switch.normalOpen.
open:
slot_uri: cim:Switch.open
range: boolean
required: false
multivalued: false
description: The attribute tells if the switch is considered open when used
as input to topology processing.
ratedCurrent:
slot_uri: cim:Switch.ratedCurrent
range: CurrentFlow
required: false
multivalued: false
description: "The maximum continuous current carrying capacity in amps governed\
\ by the device material and construction.\r\nThe attribute shall be a positive\
\ value.\r\n\r\n"
retained:
slot_uri: cim:Switch.retained
range: boolean
required: false
multivalued: false
description: Branch is retained in the topological solution. The flow through
retained switches will normally be calculated in power flow.
switchOnCount:
slot_uri: cim:Switch.switchOnCount
range: integer
required: false
multivalued: false
description: The switch on count since the switch was last reset or initialized.
switchOnDate:
slot_uri: cim:Switch.switchOnDate
range: date
required: false
multivalued: false
description: The date and time when the switch was last switched on.
SwitchPhase:
slot_uri: cim:Switch.SwitchPhase
range: SwitchPhase
required: false
multivalued: true
description: The individual switch phases for the switch.
SwitchSchedules:
slot_uri: cim:Switch.SwitchSchedules
range: SwitchSchedule
required: false
multivalued: true
description: A Switch can be associated with SwitchSchedules.
CompositeSwitch:
slot_uri: cim:Switch.CompositeSwitch
range: CompositeSwitch
required: false
multivalued: false
description: Composite switch to which this Switch belongs.
UnavailabilitySwitchAction:
slot_uri: cim:Switch.UnavailabilitySwitchAction
range: UnavailabilitySwitchAction
required: false
multivalued: true
SvSwitch:
slot_uri: cim:Switch.SvSwitch
range: SvSwitch
required: false
multivalued: true
description: The switch state associated with the switch.
ConnectDisconnectFunctions:
slot_uri: cim:Switch.ConnectDisconnectFunctions
range: ConnectDisconnectFunction
required: false
multivalued: true
SwitchAction:
slot_uri: cim:Switch.SwitchAction
range: SwitchAction
required: false
multivalued: false
description: Action changing status of this switch.
ConductingEquipment:
class_uri: cim:ConductingEquipment
is_a: Equipment
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Core
description: The parts of the AC power system that are designed to carry current
or that are conductively connected through terminals.
attributes:
ProtectiveActionAdjustment:
slot_uri: cim:ConductingEquipment.ProtectiveActionAdjustment
range: ProtectiveActionAdjustment
required: false
multivalued: true
description: 'The operating condition to the Conducting Equipment is changed
when protective action adjustment is activated. For ShuntCompensator or
other conducting equipment that operates on discrete values (integer), the
values given in float will be rounded. '
SvStatus:
slot_uri: cim:ConductingEquipment.SvStatus
range: SvStatus
required: false
multivalued: true
description: The status state variable associated with this conducting equipment.
ProtectionEquipments:
slot_uri: cim:ConductingEquipment.ProtectionEquipments
range: ProtectionEquipment
required: false
multivalued: true
description: 'Protection equipment used to protect specific conducting equipment. '
BaseVoltage:
slot_uri: cim:ConductingEquipment.BaseVoltage
range: BaseVoltage
required: false
multivalued: false
description: Base voltage of this conducting equipment. Use only when there
is no voltage level container used and only one base voltage applies. For
example, not used for transformers.
Terminals:
slot_uri: cim:ConductingEquipment.Terminals
range: Terminal
required: false
multivalued: true
description: Conducting equipment have terminals that may be connected to
other conducting equipment terminals via connectivity nodes or topological
nodes.
JumpingAction:
slot_uri: cim:ConductingEquipment.JumpingAction
range: JumperAction
required: false
multivalued: false
description: Jumper action involving jumping operation on this conducting
equipment.
GroundingAction:
slot_uri: cim:ConductingEquipment.GroundingAction
range: GroundAction
required: false
multivalued: false
description: Action involving grounding operation on this conducting equipment.
Outage:
slot_uri: cim:ConductingEquipment.Outage
range: Outage
required: false
multivalued: false
description: The outage that is isolated by the outage isolation equipment.
SvStatus:
class_uri: cim:SvStatus
is_a: StateVariable
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.StateVariables
description: State variable for status.
attributes:
inService:
slot_uri: cim:SvStatus.inService
range: boolean
required: false
multivalued: false
description: 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:
slot_uri: cim:SvStatus.phase
range: SinglePhaseKind
required: false
multivalued: false
description: The individual phase status. If the attribute is unspecified,
then three phase model is assumed.
ConductingEquipment:
slot_uri: cim:SvStatus.ConductingEquipment
range: ConductingEquipment
required: true
multivalued: false
description: The conducting equipment associated with the status state variable.
BaseVoltage:
class_uri: cim:BaseVoltage
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Core
description: 'Defines a system base voltage which is referenced. '
attributes:
nominalVoltage:
slot_uri: cim:BaseVoltage.nominalVoltage
range: Voltage
required: false
multivalued: false
description: The power system resource's base voltage. Shall be a positive
value and not zero.
ConductingEquipment:
slot_uri: cim:BaseVoltage.ConductingEquipment
range: ConductingEquipment
required: false
multivalued: true
description: All conducting equipment with this base voltage. Use only when
there is no voltage level container used and only one base voltage applies. For
example, not used for transformers.
VoltageLevel:
slot_uri: cim:BaseVoltage.VoltageLevel
range: VoltageLevel
required: false
multivalued: true
description: The voltage levels having this base voltage.
TransformerEnds:
slot_uri: cim:BaseVoltage.TransformerEnds
range: TransformerEnd
required: false
multivalued: true
description: Transformer ends at the base voltage. This is essential for
PU calculation.
TopologicalNode:
slot_uri: cim:BaseVoltage.TopologicalNode
range: TopologicalNode
required: false
multivalued: true
description: The topological nodes at the base voltage.
NetworkAssetDeployment:
slot_uri: cim:BaseVoltage.NetworkAssetDeployment
range: AssetDeployment
required: false
multivalued: true
description: A network asset deployment at this base voltage level.
VoltageLevel:
class_uri: cim:VoltageLevel
is_a: EquipmentContainer
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Core
description: A collection of equipment at one common system voltage forming a
switchgear. The equipment typically consists of breakers, busbars, instrumentation,
control, regulation and protection devices as well as assemblies of all these.
attributes:
highVoltageLimit:
slot_uri: cim:VoltageLevel.highVoltageLimit
range: Voltage
required: false
multivalued: false
description: "The bus bar's high voltage limit.\r\nThe limit applies to all\
\ equipment and nodes contained in a given VoltageLevel. It is not required\
\ that it is exchanged in pair with lowVoltageLimit. It is preferable to\
\ use operational VoltageLimit, which prevails, if present."
lowVoltageLimit:
slot_uri: cim:VoltageLevel.lowVoltageLimit
range: Voltage
required: false
multivalued: false
description: "The bus bar's low voltage limit.\r\nThe limit applies to all\
\ equipment and nodes contained in a given VoltageLevel. It is not required\
\ that it is exchanged in pair with highVoltageLimit. It is preferable to\
\ use operational VoltageLimit, which prevails, if present."
Bays:
slot_uri: cim:VoltageLevel.Bays
range: Bay
required: false
multivalued: true
description: The bays within this voltage level.
BaseVoltage:
slot_uri: cim:VoltageLevel.BaseVoltage
range: BaseVoltage
required: true
multivalued: false
description: The base voltage used for all equipment within the voltage level.
Substation:
slot_uri: cim:VoltageLevel.Substation
range: Substation
required: true
multivalued: false
description: The substation of the voltage level.
Substation:
class_uri: cim:Substation
is_a: EquipmentContainer
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Core
description: "A collection of equipment for purposes other than generation or\
\ utilization, through which electric energy in bulk is passed for the purposes\
\ of switching or modifying its characteristics. \r\n"
attributes:
VoltageLevels:
slot_uri: cim:Substation.VoltageLevels
range: VoltageLevel
required: false
multivalued: true
description: The voltage levels within this substation.
Region:
slot_uri: cim:Substation.Region
range: SubGeographicalRegion
required: false
multivalued: false
description: The SubGeographicalRegion containing the substation.
Bays:
slot_uri: cim:Substation.Bays
range: Bay
required: false
multivalued: true
description: Bays contained in the substation.
DCConverterUnit:
slot_uri: cim:Substation.DCConverterUnit
range: DCConverterUnit
required: false
multivalued: true
description: The DC converter unit belonging of the substation.
NormalEnergizedFeeder:
slot_uri: cim:Substation.NormalEnergizedFeeder
range: Feeder
required: false
multivalued: true
description: The normal energized feeders of the substation. Also used for
naming purposes.
NamingFeeder:
slot_uri: cim:Substation.NamingFeeder
range: Feeder
required: false
multivalued: false
description: The primary feeder that normally energizes the secondary substation.
Used for naming purposes. Either this association or the substation to
subgeographical region should be used for hierarchical containment specification.
NormalEnergizingFeeder:
slot_uri: cim:Substation.NormalEnergizingFeeder
range: Feeder
required: false
multivalued: true
description: The feeders that potentially energize the downstream substation. Should
be consistent with the associations that describe the naming hierarchy.
SubGeographicalRegion:
class_uri: cim:SubGeographicalRegion
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Core
description: "A subset of a geographical region of a power system network model.\r\
\n"
attributes:
Lines:
slot_uri: cim:SubGeographicalRegion.Lines
range: Line
required: false
multivalued: true
description: The lines within the sub-geographical region.
Substations:
slot_uri: cim:SubGeographicalRegion.Substations
range: Substation
required: false
multivalued: true
description: The substations in this sub-geographical region.
Region:
slot_uri: cim:SubGeographicalRegion.Region
range: GeographicalRegion
required: false
multivalued: false
description: The geographical region which this sub-geographical region is
within.
DCLines:
slot_uri: cim:SubGeographicalRegion.DCLines
range: DCLine
required: false
multivalued: true
description: The DC lines in this sub-geographical region.
GeographicalRegion:
class_uri: cim:GeographicalRegion
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Core
description: "A geographical region of a power system network model.\r\n"
attributes:
Regions:
slot_uri: cim:GeographicalRegion.Regions
range: SubGeographicalRegion
required: false
multivalued: true
description: All sub-geographical regions within this geographical region.
DCLine:
class_uri: cim:DCLine
is_a: DCEquipmentContainer
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.DC
description: Overhead lines and/or cables connecting two or more HVDC substations.
attributes:
Region:
slot_uri: cim:DCLine.Region
range: SubGeographicalRegion
required: false
multivalued: false
description: The SubGeographicalRegion containing the DC line.
DCEquipmentContainer:
class_uri: cim:DCEquipmentContainer
is_a: EquipmentContainer
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.DC
description: A modelling construct to provide a root class for containment of
DC as well as AC equipment. The class differ from the EquipmentContaner for
AC in that it may also contain DCNode-s. Hence it can contain both AC and DC
equipment.
attributes:
DCTopologicalNode:
slot_uri: cim:DCEquipmentContainer.DCTopologicalNode
range: DCTopologicalNode
required: false
multivalued: true
description: The topological nodes which belong to this connectivity node
container.
DCNodes:
slot_uri: cim:DCEquipmentContainer.DCNodes
range: DCNode
required: false
multivalued: true
description: The DC nodes contained in the DC equipment container.
DCNode:
class_uri: cim:DCNode
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.DC
description: DC nodes are points where terminals of DC conducting equipment are
connected together with zero impedance.
attributes:
DCTerminals:
slot_uri: cim:DCNode.DCTerminals
range: DCBaseTerminal
required: false
multivalued: true
description: 'DC base terminals interconnected with zero impedance at a this
DC connectivity node. '
DCTopologicalNode:
slot_uri: cim:DCNode.DCTopologicalNode
range: DCTopologicalNode
required: false
multivalued: false
description: The DC topological node to which this DC connectivity node is
assigned. May depend on the current state of switches in the network.
DCEquipmentContainer:
slot_uri: cim:DCNode.DCEquipmentContainer
range: DCEquipmentContainer
required: true
multivalued: false
description: The DC container for the DC nodes.
DCBaseTerminal:
class_uri: cim:DCBaseTerminal
is_a: ACDCTerminal
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.DC
description: 'An electrical connection point at a piece of DC conducting equipment.
DC terminals are connected at one physical DC node that may have multiple DC
terminals connected. A DC node is similar to an AC connectivity node. The model
requires that DC connections are distinct from AC connections. '
attributes:
DCTopologicalNode:
slot_uri: cim:DCBaseTerminal.DCTopologicalNode
range: DCTopologicalNode
required: false
multivalued: false
description: See association end Terminal.TopologicalNode.
DCNode:
slot_uri: cim:DCBaseTerminal.DCNode
range: DCNode
required: false
multivalued: false
description: The DC connectivity node to which this DC base terminal connects
with zero impedance.
DCTopologicalNode:
class_uri: cim:DCTopologicalNode
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.DC
description: DC bus.
attributes:
DCTopologicalIsland:
slot_uri: cim:DCTopologicalNode.DCTopologicalIsland
range: DCTopologicalIsland
required: false
multivalued: false
description: A DC topological node belongs to a DC topological island.
DCTerminals:
slot_uri: cim:DCTopologicalNode.DCTerminals
range: DCBaseTerminal
required: false
multivalued: true
description: See association end TopologicalNode.Terminal.
DCNodes:
slot_uri: cim:DCTopologicalNode.DCNodes
range: DCNode
required: false
multivalued: true
description: The DC connectivity nodes combined together to form this DC topological
node. May depend on the current state of switches in the network.
DCEquipmentContainer:
slot_uri: cim:DCTopologicalNode.DCEquipmentContainer
range: DCEquipmentContainer
required: false
multivalued: false
description: The connectivity node container to which the topological node
belongs.
DCTopologicalIsland:
class_uri: cim:DCTopologicalIsland
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.DC
description: "An electrically connected subset of the network. DC topological\
\ islands can change as the current network state changes, e.g. due to: \r\n\
- disconnect switches or breakers changing state in a SCADA/EMS.\r\n- manual\
\ creation, change or deletion of topological nodes in a planning tool.\r\n\
Only energised TopologicalNode-s shall be part of the topological island."
attributes:
DCTopologicalNodes:
slot_uri: cim:DCTopologicalIsland.DCTopologicalNodes
range: DCTopologicalNode
required: true
multivalued: true
description: The DC topological nodes in a DC topological island.
Line:
class_uri: cim:Line
is_a: EquipmentContainer
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: 'Contains equipment beyond a substation belonging to a power transmission
line. '
attributes:
Region:
slot_uri: cim:Line.Region
range: SubGeographicalRegion
required: false
multivalued: false
description: The sub-geographical region of the line.
Bay:
class_uri: cim:Bay
is_a: EquipmentContainer
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Core
description: "A collection of power system resources (within a given substation)\
\ including conducting equipment, protection relays, measurements, and telemetry.\
\ A bay typically represents a physical grouping related to modularization\
\ of equipment.\r\n"
attributes:
bayEnergyMeasFlag:
slot_uri: cim:Bay.bayEnergyMeasFlag
range: boolean
required: false
multivalued: false
description: Indicates the presence/absence of energy measurements.
bayPowerMeasFlag:
slot_uri: cim:Bay.bayPowerMeasFlag
range: boolean
required: false
multivalued: false
description: Indicates the presence/absence of active/reactive power measurements.
breakerConfiguration:
slot_uri: cim:Bay.breakerConfiguration
range: BreakerConfiguration
required: false
multivalued: false
description: 'Breaker configuration. '
busBarConfiguration:
slot_uri: cim:Bay.busBarConfiguration
range: BusbarConfiguration
required: false
multivalued: false
description: Busbar configuration.
Substation:
slot_uri: cim:Bay.Substation
range: Substation
required: false
multivalued: false
description: Substation containing the bay.
VoltageLevel:
slot_uri: cim:Bay.VoltageLevel
range: VoltageLevel
required: false
multivalued: false
description: The voltage level containing this bay.
Circuit:
slot_uri: cim:Bay.Circuit
range: Circuit
required: false
multivalued: false
Circuit:
class_uri: cim:Circuit
is_a: Line
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.Feeder
attributes:
EndBay:
slot_uri: cim:Circuit.EndBay
range: Bay
required: false
multivalued: true
EndTerminal:
slot_uri: cim:Circuit.EndTerminal
range: Terminal
required: false
multivalued: true
DCConverterUnit:
class_uri: cim:DCConverterUnit
is_a: DCEquipmentContainer
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.DC
description: "Indivisible operative unit comprising all equipment between the\
\ point of common coupling on the AC side and the point of common coupling \u2013\
\ DC side, essentially one or more converters, together with one or more converter\
\ transformers, converter control equipment, essential protective and switching\
\ devices and auxiliaries, if any, used for conversion."
attributes:
operationMode:
slot_uri: cim:DCConverterUnit.operationMode
range: DCConverterOperatingModeKind
required: false
multivalued: false
description: The operating mode of an HVDC bipole (bipolar, monopolar metallic
return, etc).
Substation:
slot_uri: cim:DCConverterUnit.Substation
range: Substation
required: false
multivalued: false
description: The containing substation of the DC converter unit.
Feeder:
class_uri: cim:Feeder
is_a: EquipmentContainer
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Core
description: "A collection of equipment for organizational purposes, used for\
\ grouping distribution resources.\r\nThe organization a feeder does not necessarily\
\ reflect connectivity or current operation state.\r\n\r\n"
attributes:
NormalEnergizingSubstation:
slot_uri: cim:Feeder.NormalEnergizingSubstation
range: Substation
required: false
multivalued: false
description: The substation that nominally energizes the feeder. Also used
for naming purposes.
NamingSecondarySubstation:
slot_uri: cim:Feeder.NamingSecondarySubstation
range: Substation
required: false
multivalued: true
description: The secondary substations that are normally energized from the
feeder. Used for naming purposes. Should be consistent with the other
associations for energizing terminal specification and the feeder energization
specification.
NormalHeadTerminal:
slot_uri: cim:Feeder.NormalHeadTerminal
range: Terminal
required: true
multivalued: true
description: The normal head terminal or terminals of the feeder.
NormalEnergizedSubstation:
slot_uri: cim:Feeder.NormalEnergizedSubstation
range: Substation
required: false
multivalued: true
description: The substations that are normally energized by the feeder.
AssetDeployment:
class_uri: cim:AssetDeployment
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: Deployment of asset deployment in a power system resource role.
attributes:
breakerApplication:
slot_uri: cim:AssetDeployment.breakerApplication
range: BreakerApplicationKind
required: false
multivalued: false
description: Type of network role breaker is playing in this deployment (applies
to breaker assets only).
deploymentDate:
slot_uri: cim:AssetDeployment.deploymentDate
range: DeploymentDate
required: false
multivalued: false
description: Dates of asset deployment.
deploymentState:
slot_uri: cim:AssetDeployment.deploymentState
range: DeploymentStateKind
required: false
multivalued: false
description: Current deployment state of asset.
facilityKind:
slot_uri: cim:AssetDeployment.facilityKind
range: FacilityKind
required: false
multivalued: false
description: Kind of facility (like substation or pole or building or plant
or service center) at which asset deployed.
likelihoodOfFailure:
slot_uri: cim:AssetDeployment.likelihoodOfFailure
range: integer
required: false
multivalued: false
description: Likelihood of asset failure on a scale of 1(low) to 100 (high).
transformerApplication:
slot_uri: cim:AssetDeployment.transformerApplication
range: TransformerApplicationKind
required: false
multivalued: false
description: Type of network role transformer is playing in this deployment
(applies to transformer assets only).
BaseVoltage:
slot_uri: cim:AssetDeployment.BaseVoltage
range: BaseVoltage
required: true
multivalued: false
description: Base voltage of this network asset deployment.
Asset:
slot_uri: cim:AssetDeployment.Asset
range: Asset
required: false
multivalued: false
description: Asset in this deployment.
DeploymentDate:
class_uri: cim:DeploymentDate
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: Dates for deployment events of an asset. May have multiple deployment
type dates for this device and a compound type allows a query to return multiple
dates.
attributes:
inServiceDate:
slot_uri: cim:DeploymentDate.inServiceDate
range: date
required: false
multivalued: false
description: Date and time asset most recently put in service.
installedDate:
slot_uri: cim:DeploymentDate.installedDate
range: date
required: false
multivalued: false
description: Date and time asset most recently installed.
notYetInstalledDate:
slot_uri: cim:DeploymentDate.notYetInstalledDate
range: date
required: false
multivalued: false
description: Date and time of asset deployment transition to not yet installed.
outOfServiceDate:
slot_uri: cim:DeploymentDate.outOfServiceDate
range: date
required: false
multivalued: false
description: Date and time asset most recently taken out of service.
removedDate:
slot_uri: cim:DeploymentDate.removedDate
range: date
required: false
multivalued: false
description: Date and time asset most recently removed.
JumperAction:
class_uri: cim:JumperAction
is_a: SwitchingAction
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Operations
description: Action on jumper as a switching step.
attributes:
kind:
slot_uri: cim:JumperAction.kind
range: TempEquipActionKind
required: false
multivalued: false
description: Switching action to perform.
JumpedEquipments:
slot_uri: cim:JumperAction.JumpedEquipments
range: ConductingEquipment
required: false
multivalued: true
description: Conducting equipment is affected when the jumper action connects
one or both ends of a jumper to the conducting equipment. If the jumper
action involves placing one or both ends of a jumper anywhere along a line
segment, you must use the clamp (to get the distance from one terminal),
using the explicit relation with clamp. In the case of placing one or both
ends of the jumper at a line segment terminal, reference to one or more
line segments is sufficient.
ACLineSegments:
slot_uri: cim:JumperAction.ACLineSegments
range: ACLineSegment
required: false
multivalued: true
description: The line segment that this jumper action will affect. This is
the only way to access relationship to clamp in case the jumper needs to
connect along the line segment.
Jumper:
slot_uri: cim:JumperAction.Jumper
range: Jumper
required: false
multivalued: false
description: Jumper on which this action is taken.
Clamp:
slot_uri: cim:JumperAction.Clamp
range: Clamp
required: false
multivalued: false
description: Clamp on which this action is taken.
SwitchingAction:
class_uri: cim:SwitchingAction
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Operations
description: Atomic switching action.
attributes:
executedDateTime:
slot_uri: cim:SwitchingAction.executedDateTime
range: date
required: false
multivalued: false
description: Actual date and time of this switching step.
issuedDateTime:
slot_uri: cim:SwitchingAction.issuedDateTime
range: date
required: false
multivalued: false
description: Date and time when the crew was given the instruction to execute
the action; not applicable if the action is performed by operator remote
control.
phases:
slot_uri: cim:SwitchingAction.phases
range: PhaseCode
required: false
multivalued: false
description: Phases of the Switching Action
plannedDateTime:
slot_uri: cim:SwitchingAction.plannedDateTime
range: date
required: false
multivalued: false
description: Planned date and time of this switching step.
SwitchingPlan:
slot_uri: cim:SwitchingAction.SwitchingPlan
range: SwitchingPlan
required: false
multivalued: false
description: The switching plan that is associated with the switching actions.
Operator:
slot_uri: cim:SwitchingAction.Operator
range: Operator
required: false
multivalued: false
description: Operator responsible for this switching step.
Crew:
slot_uri: cim:SwitchingAction.Crew
range: Crew
required: false
multivalued: true
description: The crew that is assigned to the switching action.
SwitchingEvent:
slot_uri: cim:SwitchingAction.SwitchingEvent
range: SwitchingEvent
required: false
multivalued: false
description: The switching event that the switching action is performed on
SwitchingStep:
slot_uri: cim:SwitchingAction.SwitchingStep
range: SwitchingStep
required: false
multivalued: false
description: The switching step that is associated to the switching action.
SwitchingStep:
class_uri: cim:SwitchingStep
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Operations
description: Atomic switching step; can be part of a switching step group, or
part of a switching plan.
attributes:
isFreeSequence:
slot_uri: cim:SwitchingStep.isFreeSequence
range: boolean
required: true
multivalued: false
description: "For a step, if isFreeSequence is set to false or is not specified,\
\ all of the steps in the group must be executed in the order defined by\
\ the sequenceNumber attribute. The sequenceNumber for a step has a different\
\ meaning when there are two or more sequential steps that have the isFreeSequence\
\ attribute set to true. Execution must still be performed in sequenceNumber\
\ order until a set of two or more steps that have isFreeSequence set to\
\ true is encountered. In this case, these steps can be executed in any\
\ sequence, until a step is encountered that has isFreeSequence set to false.\
\ All of the steps preceding this step must be executed before the step\
\ can be executed.\r\n"
sequenceNumber:
slot_uri: cim:SwitchingStep.sequenceNumber
range: integer
required: true
multivalued: false
description: Order of this activity in the sequence of activities within the
switching plan.
subStepSequenceNumber:
slot_uri: cim:SwitchingStep.subStepSequenceNumber
range: integer
required: true
multivalued: false
description: Supports compound switching steps that are made up of several
sub steps.
SwitchingStepGroup:
slot_uri: cim:SwitchingStep.SwitchingStepGroup
range: SwitchingStepGroup
required: false
multivalued: false
description: The switching step group that contains the switching steps.
RevisionHistory:
slot_uri: cim:SwitchingStep.RevisionHistory
range: RevisionHistory
required: true
multivalued: false
SwitchingAction:
slot_uri: cim:SwitchingStep.SwitchingAction
range: SwitchingAction
required: true
multivalued: false
description: The switching action that is associated to the switching step.
SwitchingStepGroup:
class_uri: cim:SwitchingStepGroup
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Operations
description: A logical step, grouping atomic switching steps that are important
to distinguish when they may change topology (e.g. placing a jumper between
two cuts).
attributes:
description:
slot_uri: cim:SwitchingStepGroup.description
range: string
required: false
multivalued: false
description: Descriptive information concerning the switching step group.
isFreeSequence:
slot_uri: cim:SwitchingStepGroup.isFreeSequence
range: boolean
required: false
multivalued: false
description: If true, the sequence number serves for presentation purposes
only, and the activity itself may be executed at any time.
purpose:
slot_uri: cim:SwitchingStepGroup.purpose
range: string
required: false
multivalued: false
description: Describes the overall purpose of the steps in this switching
step group.
sequenceNumber:
slot_uri: cim:SwitchingStepGroup.sequenceNumber
range: integer
required: false
multivalued: false
description: Order of this activity in the sequence of activities within the
switching plan.
SwitchingStep:
slot_uri: cim:SwitchingStepGroup.SwitchingStep
range: SwitchingStep
required: false
multivalued: true
description: The switching steps that are part of the switching step group.
SwitchingPlan:
slot_uri: cim:SwitchingStepGroup.SwitchingPlan
range: SwitchingPlan
required: false
multivalued: false
description: Switching plan to which this group belongs.
RevisionHistory:
class_uri: cim:RevisionHistory
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Operations
description: History of changes made to a switching plan step after the switching
plan has been approved.
attributes:
kind:
slot_uri: cim:RevisionHistory.kind
range: RevisionKind
required: true
multivalued: false
description: Kind of change, either void or added.
revisionAuthor:
slot_uri: cim:RevisionHistory.revisionAuthor
range: string
required: true
multivalued: false
description: Person who made the change
revisionDateTime:
slot_uri: cim:RevisionHistory.revisionDateTime
range: date
required: true
multivalued: false
description: Date and time of the change
revisionReason:
slot_uri: cim:RevisionHistory.revisionReason
range: string
required: true
multivalued: false
description: Reason for making the change
SwitchingStep:
slot_uri: cim:RevisionHistory.SwitchingStep
range: SwitchingStep
required: false
multivalued: false
Operator:
class_uri: cim:Operator
is_a: OperationPersonRole
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Common
description: Control room operator.
attributes:
SwitchingSteps:
slot_uri: cim:Operator.SwitchingSteps
range: SwitchingAction
required: false
multivalued: true
description: All switching steps this operator is responsible for.
Incidents:
slot_uri: cim:Operator.Incidents
range: Incident
required: false
multivalued: true
description: All incidents owned by this operator.
OperationPersonRole:
class_uri: cim:OperationPersonRole
is_a: PersonRole
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Common
description: Person role in the context of utility operations.
Crew:
class_uri: cim:Crew
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Common
description: Group of people with specific skills, tools, and vehicles.
attributes:
status:
slot_uri: cim:Crew.status
range: Status
required: false
multivalued: false
description: Status of this crew.
CrewType:
slot_uri: cim:Crew.CrewType
range: CrewType
required: false
multivalued: false
description: Type of this crew.
CrewMembers:
slot_uri: cim:Crew.CrewMembers
range: CrewMember
required: false
multivalued: true
description: All members of this crew.
FieldDispatchHistory:
slot_uri: cim:Crew.FieldDispatchHistory
range: FieldDispatchHistory
required: false
multivalued: true
description: The dispatch history associated with the crew.
Location:
slot_uri: cim:Crew.Location
range: Location
required: false
multivalued: false
description: The location this crew is assigned to.
WorkAssets:
slot_uri: cim:Crew.WorkAssets
range: WorkAsset
required: false
multivalued: true
description: All work assets used by this crew.
SwitchingAction:
slot_uri: cim:Crew.SwitchingAction
range: SwitchingAction
required: true
multivalued: false
description: The switching action that is assigned to this crew.
Outage:
slot_uri: cim:Crew.Outage
range: Outage
required: false
multivalued: true
description: The outage that is assigned to the crew.
WorkTasks:
slot_uri: cim:Crew.WorkTasks
range: WorkTask
required: false
multivalued: true
description: All work tasks this crew participates in.
FieldDispatchHistory:
class_uri: cim:FieldDispatchHistory
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Common
description: The history of field dispatch statuses for this work.
attributes:
FieldDispatchStep:
slot_uri: cim:FieldDispatchHistory.FieldDispatchStep
range: FieldDispatchStep
required: false
multivalued: true
description: The field dispatch step that has the field dispatch history.
Crew:
slot_uri: cim:FieldDispatchHistory.Crew
range: Crew
required: false
multivalued: false
description: The crew that has this field dispatch history.
PlannedOutage:
slot_uri: cim:FieldDispatchHistory.PlannedOutage
range: PlannedOutage
required: false
multivalued: false
description: The planned outage that has the field dispatch history.
UnplannedOutage:
slot_uri: cim:FieldDispatchHistory.UnplannedOutage
range: UnplannedOutage
required: false
multivalued: false
description: The unplanned outage that has the field dispatch history.
FieldDispatchStep:
class_uri: cim:FieldDispatchStep
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Common
description: Details of the step in the field dispatch history.
attributes:
dispatchStatus:
slot_uri: cim:FieldDispatchStep.dispatchStatus
range: CrewStatusKind
required: true
multivalued: false
description: The status of one or more crews dispatched to perform field work
at one or more work sites
occurredDateTime:
slot_uri: cim:FieldDispatchStep.occurredDateTime
range: date
required: false
multivalued: false
description: The date and time at which the dispatch status occurred.
remarks:
slot_uri: cim:FieldDispatchStep.remarks
range: string
required: false
multivalued: false
description: freeform comments related to the dispatch to perform field work.
sequenceNumber:
slot_uri: cim:FieldDispatchStep.sequenceNumber
range: integer
required: false
multivalued: false
description: The sequence number of the field dispatch step within the field
dispatch history. Begins with 1 and increments up.
FieldDispatchHistory:
slot_uri: cim:FieldDispatchStep.FieldDispatchHistory
range: FieldDispatchHistory
required: true
multivalued: false
description: The dispatch history associated with the field dispatch step
PlannedOutage:
class_uri: cim:PlannedOutage
is_a: Outage
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Operations
attributes:
reason:
slot_uri: cim:PlannedOutage.reason
range: string
required: false
multivalued: false
description: The reason for the planned outage.
FieldDispatchHistory:
slot_uri: cim:PlannedOutage.FieldDispatchHistory
range: FieldDispatchHistory
required: false
multivalued: false
description: The dispatch history associated with the planned outage
UpdatedRatings:
slot_uri: cim:PlannedOutage.UpdatedRatings
range: OperationalUpdatedRating
required: false
multivalued: true
description: All updated ratings for this planned equipment outage.
OutagePlan:
slot_uri: cim:PlannedOutage.OutagePlan
range: OutagePlan
required: false
multivalued: false
description: Outage plan for executing a planned outage.
Outage:
class_uri: cim:Outage
is_a: Document
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Operations
description: "Document describing details of an active or planned outage in a\
\ part of the electrical network.\r\nA non-planned outage may be created upon:\r\
\n- a breaker trip,\r\n- a fault indicator status change,\r\n- a meter event\
\ indicating customer outage,\r\n- a reception of one or more customer trouble\
\ calls, or\r\n- an operator command, reflecting information obtained from the\
\ field crew.\r\nOutage restoration may be performed using a switching plan\
\ which complements the outage information with detailed switching activities,\
\ including the relationship to the crew and work.\r\nA planned outage may be\
\ created upon:\r\n- a request for service, maintenance or construction work\
\ in the field, or\r\n- an operator-defined outage for what-if/contingency network\
\ analysis."
attributes:
actualPeriod:
slot_uri: cim:Outage.actualPeriod
range: DateTimeInterval
required: false
multivalued: false
description: Actual outage period; end of the period corresponds to the actual
restoration time.
communityDescriptor:
slot_uri: cim:Outage.communityDescriptor
range: string
required: false
multivalued: false
description: a name to denote the community - this could be a name or a code
of some kind.
customersRestored:
slot_uri: cim:Outage.customersRestored
range: integer
required: false
multivalued: false
description: number of customers that have been restored in the area.
estimatedPeriod:
slot_uri: cim:Outage.estimatedPeriod
range: DateTimeInterval
required: false
multivalued: false
description: Estimated outage period for a planned outage. The start of the
period is the start of the planned outage and the end of the period corresponds
to the end of the planned outage.
metersAffected:
slot_uri: cim:Outage.metersAffected
range: integer
required: false
multivalued: false
description: The updated number of meters affected by the outage as reported
by the OMS within the utility. It is assumed this number will be updated
repeatedly until the full outage is resolved.
originalCustomersServed:
slot_uri: cim:Outage.originalCustomersServed
range: integer
required: true
multivalued: false
description: the total number of customers that are served in the area (both
outaged and not outaged).
originalMetersAffected:
slot_uri: cim:Outage.originalMetersAffected
range: integer
required: false
multivalued: false
description: The original number of meters that were affected as reported
by the OMS within the utility. That is, this is the total number of meters
that were out at the beginning of the outage.
outageKind:
slot_uri: cim:Outage.outageKind
range: OutageStatusKind
required: false
multivalued: false
description: Defines if the outage has been verified or is only estimated
statusKind:
slot_uri: cim:Outage.statusKind
range: CrewStatusKind
required: false
multivalued: false
description: defines the status of the crew as in dispatched or arrived, etc.
summary:
slot_uri: cim:Outage.summary
range: ServicePointOutageSummary
required: false
multivalued: false
description: Summary counts of service points (customers) affected by this
outage.
utilityDisclaimer:
slot_uri: cim:Outage.utilityDisclaimer
range: string
required: false
multivalued: false
description: This contains an disclaimers the utility would like to place
on the data provided to any stakeholder. This may be different for different
stakeholders. This should possibly be an attribute under the Organization
class but it is placed here for now.
EnergizedUsagePoint:
slot_uri: cim:Outage.EnergizedUsagePoint
range: UsagePoint
required: false
multivalued: true
description: All energized usage points associated with this outage.
Equipments:
slot_uri: cim:Outage.Equipments
range: Equipment
required: false
multivalued: true
description: All equipments associated with this outage.
PlannedSwitchActions:
slot_uri: cim:Outage.PlannedSwitchActions
range: SwitchAction
required: false
multivalued: true
description: All switch actions to apply within the scope of this planned
outage. Each such action groups switches to which the action is to apply
in order to produce the desired network state considered as outage.
DeEnergizedUsagePoint:
slot_uri: cim:Outage.DeEnergizedUsagePoint
range: UsagePoint
required: false
multivalued: true
description: 'all deenergized useage points associated with the outage. '
Faults:
slot_uri: cim:Outage.Faults
range: Fault
required: false
multivalued: true
description: All faults involved in this outage.
Crew:
slot_uri: cim:Outage.Crew
range: Crew
required: false
multivalued: true
description: The crew that is assigned to the outage.
OutageIsolationEquipment:
slot_uri: cim:Outage.OutageIsolationEquipment
range: ConductingEquipment
required: false
multivalued: true
description: The equipment that isolates this outage
Incident:
slot_uri: cim:Outage.Incident
range: Incident
required: false
multivalued: true
description: Incident reported in trouble call that results in this outage.
EstimatedRestorationTime:
slot_uri: cim:Outage.EstimatedRestorationTime
range: EstimatedRestorationTime
required: false
multivalued: false
description: The estimated time that the power will be restored after an outage
SwitchingPlans:
slot_uri: cim:Outage.SwitchingPlans
range: SwitchingPlan
required: false
multivalued: true
description: All switching plans that lead to supply restoration due to this
outage. Only one will be retained for execution.
OutageArea:
slot_uri: cim:Outage.OutageArea
range: OutageArea
required: false
multivalued: true
description: The outage area where the outage occured.
ServicePointOutageSummary:
class_uri: cim:ServicePointOutageSummary
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Operations
description: Summary counts of service points affected by an outage. These counts
are sometimes referred to as total and critical customer count.
attributes:
criticalCount:
slot_uri: cim:ServicePointOutageSummary.criticalCount
range: integer
required: false
multivalued: false
description: Number of critical service (delivery) points affected by an outage.
totalCount:
slot_uri: cim:ServicePointOutageSummary.totalCount
range: integer
required: false
multivalued: false
description: Number of all service (delivery) points affected by an outage.
EstimatedRestorationTime:
class_uri: cim:EstimatedRestorationTime
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Operations
description: The Estimated Restoration Time (ERT) for a single outage
attributes:
confidenceKind:
slot_uri: cim:EstimatedRestorationTime.confidenceKind
range: ERTConfidenceKind
required: false
multivalued: false
description: provides the confidence level that this ERT can be accomplished. This
may be changed/updated as needed.
ert:
slot_uri: cim:EstimatedRestorationTime.ert
range: date
required: false
multivalued: false
description: estimated time the outage will be restored
ertSource:
slot_uri: cim:EstimatedRestorationTime.ertSource
range: string
required: false
multivalued: false
description: defines the source that provided the ERT value.
Outage:
slot_uri: cim:EstimatedRestorationTime.Outage
range: Outage
required: false
multivalued: true
description: The outage associated with the estimated time the power will
be restored.
OutageArea:
class_uri: cim:OutageArea
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Operations
description: This defines the area covered by the Outage.
attributes:
earliestReportedTime:
slot_uri: cim:OutageArea.earliestReportedTime
range: date
required: false
multivalued: false
description: This is the reported time of the first outage report
metersServed:
slot_uri: cim:OutageArea.metersServed
range: integer
required: false
multivalued: false
description: defines the number of meters served in the defined area.
outageAreaKind:
slot_uri: cim:OutageArea.outageAreaKind
range: AreaKind
required: false
multivalued: false
description: defines the type of area that has the outage - county, state,
zipcode, etc.
Outage:
slot_uri: cim:OutageArea.Outage
range: Outage
required: false
multivalued: true
description: The outage associated with the outage area.
SwitchAction:
class_uri: cim:SwitchAction
is_a: SwitchingAction
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Operations
description: Action on switch as a switching step.
attributes:
kind:
slot_uri: cim:SwitchAction.kind
range: SwitchActionKind
required: false
multivalued: false
description: Switching action to perform.
OperatedSwitch:
slot_uri: cim:SwitchAction.OperatedSwitch
range: Switch
required: false
multivalued: false
description: Switch that is the object of this switch action.
PlannedOutage:
slot_uri: cim:SwitchAction.PlannedOutage
range: Outage
required: false
multivalued: false
description: Planned outage for whose scope this switch action applies.
Fault:
class_uri: cim:Fault
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Faults
description: Abnormal condition causing current flow through conducting equipment,
such as caused by equipment failure or short circuits from objects not typically
modelled (for example, a tree falling on a line).
attributes:
impedance:
slot_uri: cim:Fault.impedance
range: FaultImpedance
required: false
multivalued: false
description: Fault impedance. Its usage is described by 'kind'.
kind:
slot_uri: cim:Fault.kind
range: PhaseConnectedFaultKind
required: false
multivalued: false
description: The kind of phase fault.
occurredDateTime:
slot_uri: cim:Fault.occurredDateTime
range: date
required: false
multivalued: false
description: The date and time at which the fault occurred.
phases:
slot_uri: cim:Fault.phases
range: PhaseCode
required: false
multivalued: false
description: The phases participating in the fault. The fault connections
into these phases are further specified by the type of fault.
FaultyEquipment:
slot_uri: cim:Fault.FaultyEquipment
range: Equipment
required: false
multivalued: false
description: Equipment carrying this fault.
FaultCauseTypes:
slot_uri: cim:Fault.FaultCauseTypes
range: FaultCauseType
required: false
multivalued: true
description: All types of fault cause.
Location:
slot_uri: cim:Fault.Location
range: Location
required: false
multivalued: false
description: Location of this fault.
Outage:
slot_uri: cim:Fault.Outage
range: Outage
required: false
multivalued: false
description: Outage associated with this fault.
FaultImpedance:
class_uri: cim:FaultImpedance
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Faults
description: Impedance description for the fault.
attributes:
rGround:
slot_uri: cim:FaultImpedance.rGround
range: Resistance
required: false
multivalued: false
description: The resistance of the fault between phases and ground.
rLineToLine:
slot_uri: cim:FaultImpedance.rLineToLine
range: Resistance
required: false
multivalued: false
description: The resistance of the fault between phases.
xGround:
slot_uri: cim:FaultImpedance.xGround
range: Reactance
required: false
multivalued: false
description: The reactance of the fault between phases and ground.
xLineToLine:
slot_uri: cim:FaultImpedance.xLineToLine
range: Reactance
required: false
multivalued: false
description: The reactance of the fault between phases.
FaultCauseType:
class_uri: cim:FaultCauseType
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Faults
description: Type of cause of the fault.
attributes:
Faults:
slot_uri: cim:FaultCauseType.Faults
range: Fault
required: false
multivalued: true
description: All faults with this cause type.
ConfigurationEvent:
slot_uri: cim:FaultCauseType.ConfigurationEvent
range: ConfigurationEvent
required: false
multivalued: true
description: All configuration events created for this fault cause type.
ConfigurationEvent:
class_uri: cim:ConfigurationEvent
is_a: ActivityRecord
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Common
description: "Used to report details on creation, change or deletion of an entity\
\ or its configuration.\r\n"
attributes:
effectiveDateTime:
slot_uri: cim:ConfigurationEvent.effectiveDateTime
range: date
required: false
multivalued: false
description: "Date and time this event has or will become effective.\r\n"
modifiedBy:
slot_uri: cim:ConfigurationEvent.modifiedBy
range: string
required: false
multivalued: false
description: "Source/initiator of modification.\r\n"
remark:
slot_uri: cim:ConfigurationEvent.remark
range: string
required: false
multivalued: false
description: "Free text remarks.\r\n"
FaultCauseType:
slot_uri: cim:ConfigurationEvent.FaultCauseType
range: FaultCauseType
required: true
multivalued: false
description: Fault cause type whose change resulted in this configuration
event.
ChangedLocation:
slot_uri: cim:ConfigurationEvent.ChangedLocation
range: Location
required: false
multivalued: false
description: Location whose change resulted in this configuration event.
PowerSystemResource:
slot_uri: cim:ConfigurationEvent.PowerSystemResource
range: PowerSystemResource
required: false
multivalued: false
description: Power system resource whose change resulted in this configuration
event.
ChangedServiceCategory:
slot_uri: cim:ConfigurationEvent.ChangedServiceCategory
range: ServiceCategory
required: false
multivalued: false
description: Service category whose change resulted in this configuration
event.
ChangedPersonRole:
slot_uri: cim:ConfigurationEvent.ChangedPersonRole
range: PersonRole
required: false
multivalued: false
description: Person role whose change resulted in this configuration event.
ChangedAsset:
slot_uri: cim:ConfigurationEvent.ChangedAsset
range: Asset
required: false
multivalued: false
description: Asset whose change resulted in this configuration event.
ChangedOrganisationRole:
slot_uri: cim:ConfigurationEvent.ChangedOrganisationRole
range: OrganisationRole
required: false
multivalued: false
description: Organisation role whose change resulted in this configuration
event.
ChangedUsagePoint:
slot_uri: cim:ConfigurationEvent.ChangedUsagePoint
range: UsagePoint
required: false
multivalued: false
description: Usage point whose change resulted in this configuration event.
ChangedDocument:
slot_uri: cim:ConfigurationEvent.ChangedDocument
range: Document
required: false
multivalued: false
description: Document whose change resulted in this configuration event.
ActivityRecord:
class_uri: cim:ActivityRecord
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Common
description: Records activity for an entity at a point in time; activity may be
for an event that has already occurred or for a planned activity.
attributes:
createdDateTime:
slot_uri: cim:ActivityRecord.createdDateTime
range: date
required: false
multivalued: false
description: "Date and time this activity record has been created (different\
\ from the 'status.dateTime', which is the time of a status change of the\
\ associated object, if applicable).\r\n"
reason:
slot_uri: cim:ActivityRecord.reason
range: string
required: false
multivalued: false
description: Reason for event resulting in this activity record, typically
supplied when user initiated.
severity:
slot_uri: cim:ActivityRecord.severity
range: string
required: false
multivalued: false
description: Severity level of event resulting in this activity record.
status:
slot_uri: cim:ActivityRecord.status
range: Status
required: false
multivalued: false
description: Information on consequence of event resulting in this activity
record.
type:
slot_uri: cim:ActivityRecord.type
range: string
required: false
multivalued: false
description: "Type of event resulting in this activity record.\r\n"
Document:
slot_uri: cim:ActivityRecord.Document
range: Document
required: false
multivalued: false
description: The document having associated activity records
Author:
slot_uri: cim:ActivityRecord.Author
range: Author
required: false
multivalued: false
description: Author of this activity record.
Assets:
slot_uri: cim:ActivityRecord.Assets
range: Asset
required: false
multivalued: true
description: All assets for which this activity record has been created.
ServiceCategory:
class_uri: cim:ServiceCategory
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Customers
description: Category of service provided to the customer.
attributes:
kind:
slot_uri: cim:ServiceCategory.kind
range: ServiceKind
required: false
multivalued: false
description: Kind of service.
ConfigurationEvents:
slot_uri: cim:ServiceCategory.ConfigurationEvents
range: ConfigurationEvent
required: false
multivalued: true
description: All configuration events created for this service category.
PricingStructures:
slot_uri: cim:ServiceCategory.PricingStructures
range: PricingStructure
required: false
multivalued: true
description: All pricing structures applicable to this service category.
CustomerAgreements:
slot_uri: cim:ServiceCategory.CustomerAgreements
range: CustomerAgreement
required: false
multivalued: true
description: All customer agreements with this service category.
UsagePoints:
slot_uri: cim:ServiceCategory.UsagePoints
range: UsagePoint
required: false
multivalued: true
description: All usage points that deliver this category of service.
PricingStructure:
class_uri: cim:PricingStructure
is_a: Document
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Customers
description: Grouping of pricing components and prices used in the creation of
customer charges and the eligibility criteria under which these terms may be
offered to a customer. The reasons for grouping include state, customer classification,
site characteristics, classification (i.e. fee price structure, deposit price
structure, electric service price structure, etc.) and accounting requirements.
attributes:
code:
slot_uri: cim:PricingStructure.code
range: string
required: false
multivalued: false
description: Unique user-allocated key for this pricing structure, used by
company representatives to identify the correct price structure for allocating
to a customer. For rate schedules it is often prefixed by a state code.
dailyCeilingUsage:
slot_uri: cim:PricingStructure.dailyCeilingUsage
range: integer
required: false
multivalued: false
description: Absolute maximum valid non-demand usage quantity used in validating
a customer's billed non-demand usage.
dailyEstimatedUsage:
slot_uri: cim:PricingStructure.dailyEstimatedUsage
range: integer
required: false
multivalued: false
description: Used in place of actual computed estimated average when history
of usage is not available, and typically manually entered by customer accounting.
dailyFloorUsage:
slot_uri: cim:PricingStructure.dailyFloorUsage
range: integer
required: false
multivalued: false
description: Absolute minimum valid non-demand usage quantity used in validating
a customer's billed non-demand usage.
revenueKind:
slot_uri: cim:PricingStructure.revenueKind
range: RevenueKind
required: false
multivalued: false
description: (accounting) Kind of revenue, often used to determine the grace
period allowed, before collection actions are taken on a customer (grace
periods vary between revenue classes).
taxExemption:
slot_uri: cim:PricingStructure.taxExemption
range: boolean
required: false
multivalued: false
description: True if this pricing structure is not taxable.
Transactions:
slot_uri: cim:PricingStructure.Transactions
range: Transaction
required: false
multivalued: true
description: All transactions applying this pricing structure.
Tariffs:
slot_uri: cim:PricingStructure.Tariffs
range: Tariff
required: false
multivalued: true
description: All tariffs used by this pricing structure.
UsagePoints:
slot_uri: cim:PricingStructure.UsagePoints
range: UsagePoint
required: false
multivalued: true
description: All service delivery points (with prepayment meter running as
a stand-alone device, with no CustomerAgreement or Customer) to which this
pricing structure applies.
CustomerAgreements:
slot_uri: cim:PricingStructure.CustomerAgreements
range: CustomerAgreement
required: false
multivalued: true
description: All customer agreements with this pricing structure.
ServiceCategory:
slot_uri: cim:PricingStructure.ServiceCategory
range: ServiceCategory
required: true
multivalued: false
description: Service category to which this pricing structure applies.
Transaction:
class_uri: cim:Transaction
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.PaymentMetering
description: The record of details of payment for service or token sale.
attributes:
diverseReference:
slot_uri: cim:Transaction.diverseReference
range: string
required: false
multivalued: false
description: Formal reference for use with diverse payment (traffic fine for
example).
donorReference:
slot_uri: cim:Transaction.donorReference
range: string
required: false
multivalued: false
description: 'Reference to the entity that is the source of ''amount'' (for
example: customer for token purchase; or supplier for free issue token).'
kind:
slot_uri: cim:Transaction.kind
range: TransactionKind
required: false
multivalued: false
description: Kind of transaction.
line:
slot_uri: cim:Transaction.line
range: LineDetail
required: false
multivalued: false
description: Transaction amount, rounding, date and note for this transaction
line.
receiverReference:
slot_uri: cim:Transaction.receiverReference
range: string
required: false
multivalued: false
description: Reference to the entity that is the recipient of 'amount' (for
example, supplier for service charge payment; or tax receiver for VAT).
reversedId:
slot_uri: cim:Transaction.reversedId
range: string
required: false
multivalued: false
description: (if 'kind' is transactionReversal) Reference to the original
transaction that is being reversed by this transaction.
serviceUnitsEnergy:
slot_uri: cim:Transaction.serviceUnitsEnergy
range: RealEnergy
required: false
multivalued: false
description: Actual amount of service units that is being paid for.
serviceUnitsError:
slot_uri: cim:Transaction.serviceUnitsError
range: RealEnergy
required: false
multivalued: false
description: Number of service units not reflected in 'serviceUnitsEnergy'
due to process rounding or truncating errors.
Meter:
slot_uri: cim:Transaction.Meter
range: Meter
required: false
multivalued: false
description: Meter for this vending transaction.
CustomerAccount:
slot_uri: cim:Transaction.CustomerAccount
range: CustomerAccount
required: false
multivalued: false
description: Customer account for this payment transaction.
PricingStructure:
slot_uri: cim:Transaction.PricingStructure
range: PricingStructure
required: false
multivalued: false
description: Pricing structure applicable for this transaction.
UserAttributes:
slot_uri: cim:Transaction.UserAttributes
range: UserAttribute
required: false
multivalued: true
description: All snapshots of meter parameters recorded at the time of this
transaction. Use 'name' and 'value.value' attributes to specify name and
value of a parameter from meter.
CashierShift:
slot_uri: cim:Transaction.CashierShift
range: CashierShift
required: false
multivalued: false
description: Cashier shift during which this transaction was recorded.
Receipt:
slot_uri: cim:Transaction.Receipt
range: Receipt
required: false
multivalued: false
description: The receipted payment for which this transaction has been recorded.
VendorShift:
slot_uri: cim:Transaction.VendorShift
range: VendorShift
required: false
multivalued: false
description: Vendor shift during which this transaction was recorded.
AuxiliaryAccount:
slot_uri: cim:Transaction.AuxiliaryAccount
range: AuxiliaryAccount
required: false
multivalued: false
description: Auxiliary account for this payment transaction.
LineDetail:
class_uri: cim:LineDetail
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.PaymentMetering
description: "Details on an amount line, with rounding, date and note.\r\n"
attributes:
amount:
slot_uri: cim:LineDetail.amount
range: Money
required: false
multivalued: false
description: Amount for this line item.
dateTime:
slot_uri: cim:LineDetail.dateTime
range: date
required: false
multivalued: false
description: "Date and time when this line was created in the application\
\ process.\r\n"
note:
slot_uri: cim:LineDetail.note
range: string
required: false
multivalued: false
description: Free format note relevant to this line.
rounding:
slot_uri: cim:LineDetail.rounding
range: Money
required: false
multivalued: false
description: Totalised monetary value of all errors due to process rounding
or truncating that is not reflected in 'amount'.
UserAttribute:
class_uri: cim:UserAttribute
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Common
description: Generic name-value pair class, with optional sequence number and
units for value; can be used to model parts of information exchange when concrete
types are not known in advance.
attributes:
name:
slot_uri: cim:UserAttribute.name
range: string
required: false
multivalued: false
description: Name of an attribute.
sequenceNumber:
slot_uri: cim:UserAttribute.sequenceNumber
range: integer
required: false
multivalued: false
description: Sequence number for this attribute in a list of attributes.
value:
slot_uri: cim:UserAttribute.value
range: StringQuantity
required: false
multivalued: false
description: Value of an attribute, including unit information.
Transaction:
slot_uri: cim:UserAttribute.Transaction
range: Transaction
required: false
multivalued: false
description: Transaction for which this snapshot has been recorded.
ProcedureDataSets:
slot_uri: cim:UserAttribute.ProcedureDataSets
range: ProcedureDataSet
required: false
multivalued: true
PropertySpecification:
slot_uri: cim:UserAttribute.PropertySpecification
range: Specification
required: false
multivalued: false
RatingSpecification:
slot_uri: cim:UserAttribute.RatingSpecification
range: Specification
required: false
multivalued: false
ErpInvoiceLineItems:
slot_uri: cim:UserAttribute.ErpInvoiceLineItems
range: ErpInvoiceLineItem
required: false
multivalued: true
ErpLedgerEntries:
slot_uri: cim:UserAttribute.ErpLedgerEntries
range: ErpLedgerEntry
required: false
multivalued: true
ErpLedgerEntry:
class_uri: cim:ErpLedgerEntry
is_a: ErpIdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfERPSupport
description: Details of an individual entry in a ledger, which was posted from
a journal on the posted date.
attributes:
accountID:
slot_uri: cim:ErpLedgerEntry.accountID
range: string
required: false
multivalued: false
description: Account identifier for this entry.
accountKind:
slot_uri: cim:ErpLedgerEntry.accountKind
range: ErpAccountKind
required: false
multivalued: false
description: Kind of account for this entry.
amount:
slot_uri: cim:ErpLedgerEntry.amount
range: Money
required: false
multivalued: false
description: The amount of the debit or credit for this account.
postedDateTime:
slot_uri: cim:ErpLedgerEntry.postedDateTime
range: date
required: false
multivalued: false
description: "Date and time this entry was posted to the ledger.\r\n"
status:
slot_uri: cim:ErpLedgerEntry.status
range: Status
required: false
multivalued: false
transactionDateTime:
slot_uri: cim:ErpLedgerEntry.transactionDateTime
range: date
required: false
multivalued: false
description: "Date and time journal entry was recorded.\r\n"
ErpJounalEntry:
slot_uri: cim:ErpLedgerEntry.ErpJounalEntry
range: ErpJournalEntry
required: false
multivalued: false
UserAttributes:
slot_uri: cim:ErpLedgerEntry.UserAttributes
range: UserAttribute
required: false
multivalued: true
ErpLedgerEntry:
slot_uri: cim:ErpLedgerEntry.ErpLedgerEntry
range: ErpLedBudLineItem
required: false
multivalued: false
ErpLedger:
slot_uri: cim:ErpLedgerEntry.ErpLedger
range: ErpLedger
required: true
multivalued: false
ErpLedger:
class_uri: cim:ErpLedger
is_a: ErpDocument
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfERPSupport
description: In accounting transactions, a ledger is a book containing accounts
to which debits and credits are posted from journals, where transactions are
initially recorded. Journal entries are periodically posted to the ledger. Ledger
Actual represents actual amounts by account within ledger within company or
business area. Actual amounts may be generated in a source application and then
loaded to a specific ledger within the enterprise general ledger or budget application.
attributes:
ErpLedgerEntries:
slot_uri: cim:ErpLedger.ErpLedgerEntries
range: ErpLedgerEntry
required: false
multivalued: true
ErpLedBudLineItem:
class_uri: cim:ErpLedBudLineItem
is_a: ErpIdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfERPSupport
description: Individual entry of a given Ledger Budget, typically containing information
such as amount, accounting date, accounting period, and is associated with the
applicable general ledger account.
attributes:
status:
slot_uri: cim:ErpLedBudLineItem.status
range: Status
required: false
multivalued: false
ErpLedgerBudget:
slot_uri: cim:ErpLedBudLineItem.ErpLedgerBudget
range: ErpLedgerBudget
required: true
multivalued: false
ErpLedBudLineItem:
slot_uri: cim:ErpLedBudLineItem.ErpLedBudLineItem
range: ErpLedgerEntry
required: false
multivalued: false
ErpLedgerBudget:
class_uri: cim:ErpLedgerBudget
is_a: ErpDocument
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfERPSupport
description: Information for utility Ledger Budgets. They support the transfer
budget amounts between all possible source applications throughout an enterprise
and a general ledger or budget application.
attributes:
ErpLedBudLineItems:
slot_uri: cim:ErpLedgerBudget.ErpLedBudLineItems
range: ErpLedBudLineItem
required: false
multivalued: true
ProcedureDataSet:
class_uri: cim:ProcedureDataSet
is_a: Document
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: A data set recorded each time a procedure is executed. Observed results
are captured in associated measurement values and/or values for properties relevant
to the type of procedure performed.
attributes:
completedDateTime:
slot_uri: cim:ProcedureDataSet.completedDateTime
range: date
required: false
multivalued: false
description: "Date and time procedure was completed.\r\n"
WorkTask:
slot_uri: cim:ProcedureDataSet.WorkTask
range: WorkTask
required: false
multivalued: false
description: Work task that created this procedure data set.
TransformerObservations:
slot_uri: cim:ProcedureDataSet.TransformerObservations
range: TransformerObservation
required: false
multivalued: true
MeasurementValue:
slot_uri: cim:ProcedureDataSet.MeasurementValue
range: MeasurementValue
required: false
multivalued: true
description: Measurement value related to this procedure data set.
Asset:
slot_uri: cim:ProcedureDataSet.Asset
range: Asset
required: false
multivalued: false
description: Asset to which this procedure data set applies.
Properties:
slot_uri: cim:ProcedureDataSet.Properties
range: UserAttribute
required: false
multivalued: true
description: UserAttributes used to specify further properties of this procedure
data set. Use 'name' to specify what kind of property it is, and 'value.value'
attribute for the actual value.
Procedure:
slot_uri: cim:ProcedureDataSet.Procedure
range: Procedure
required: false
multivalued: false
description: Procedure capturing this data set.
Procedure:
class_uri: cim:Procedure
is_a: Document
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: Documented procedure for various types of work or work tasks on assets.
attributes:
instruction:
slot_uri: cim:Procedure.instruction
range: string
required: false
multivalued: false
description: Textual description of this procedure.
kind:
slot_uri: cim:Procedure.kind
range: ProcedureKind
required: false
multivalued: false
description: Kind of procedure.
sequenceNumber:
slot_uri: cim:Procedure.sequenceNumber
range: string
required: false
multivalued: false
description: Sequence number in a sequence of procedures being performed.
Assets:
slot_uri: cim:Procedure.Assets
range: Asset
required: false
multivalued: true
description: All assets to which this procedure applies.
Limits:
slot_uri: cim:Procedure.Limits
range: Limit
required: false
multivalued: true
ProcedureDataSets:
slot_uri: cim:Procedure.ProcedureDataSets
range: ProcedureDataSet
required: false
multivalued: true
description: All data sets captured by this procedure.
Measurements:
slot_uri: cim:Procedure.Measurements
range: Measurement
required: false
multivalued: true
description: Document containing this measurement.
CompatibleUnits:
slot_uri: cim:Procedure.CompatibleUnits
range: CompatibleUnit
required: false
multivalued: true
Limit:
class_uri: cim:Limit
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Meas
description: Specifies one limit value for a Measurement. A Measurement typically
has several limits that are kept together by the LimitSet class. The actual
meaning and use of a Limit instance (i.e., if it is an alarm or warning limit
or if it is a high or low limit) is not captured in the Limit class. However
the name of a Limit instance may indicate both meaning and use.
attributes:
Procedures:
slot_uri: cim:Limit.Procedures
range: Procedure
required: false
multivalued: true
TransformerObservation:
class_uri: cim:TransformerObservation
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfAssets
description: Common information captured during transformer inspections and/or
diagnostics. Note that some properties may be measured through other means and
therefore have measurement values in addition to the observed values recorded
here.
attributes:
bushingTemp:
slot_uri: cim:TransformerObservation.bushingTemp
range: Temperature
required: false
multivalued: false
description: Bushing temperature.
dga:
slot_uri: cim:TransformerObservation.dga
range: string
required: false
multivalued: false
description: 'Dissolved Gas Analysis. Typical values are: Acceptable, Overheating,
Corona, Sparking, Arcing.'
freqResp:
slot_uri: cim:TransformerObservation.freqResp
range: string
required: false
multivalued: false
description: 'Frequency Response Analysis. Typical values are: acceptable,
slight movement, significant movement, failed, near failure. A graphic of
the response diagram, which is a type of document, may be associated with
this analysis through the recursive document relationship of the ProcedureDataSet.'
furfuralDP:
slot_uri: cim:TransformerObservation.furfuralDP
range: string
required: false
multivalued: false
description: Overall measure of furfural in oil and mechanical strength of
paper. DP, the degree of polymerization, is the strength of the paper. Furfural
is a measure of furfural compounds, often expressed in parts per million.
hotSpotTemp:
slot_uri: cim:TransformerObservation.hotSpotTemp
range: Temperature
required: false
multivalued: false
description: Hotspot oil temperature.
oilColor:
slot_uri: cim:TransformerObservation.oilColor
range: string
required: false
multivalued: false
description: Oil Quality Analysis-Color.
oilDielectricStrength:
slot_uri: cim:TransformerObservation.oilDielectricStrength
range: Voltage
required: false
multivalued: false
description: Oil Quality Analysis-Dielectric Strength.
oilIFT:
slot_uri: cim:TransformerObservation.oilIFT
range: string
required: false
multivalued: false
description: Oil Quality Analysis- inter facial tension (IFT) - number-Dynes/CM.
oilLevel:
slot_uri: cim:TransformerObservation.oilLevel
range: string
required: false
multivalued: false
description: The level of oil in the transformer.
oilNeutralizationNumber:
slot_uri: cim:TransformerObservation.oilNeutralizationNumber
range: string
required: false
multivalued: false
description: Oil Quality Analysis-Neutralization Number - Number - Mg KOH.
pumpVibration:
slot_uri: cim:TransformerObservation.pumpVibration
range: string
required: false
multivalued: false
description: 'Pump vibration, with typical values being: nominal, high.'
status:
slot_uri: cim:TransformerObservation.status
range: Status
required: false
multivalued: false
topOilTemp:
slot_uri: cim:TransformerObservation.topOilTemp
range: Temperature
required: false
multivalued: false
description: Top oil temperature.
waterContent:
slot_uri: cim:TransformerObservation.waterContent
range: string
required: false
multivalued: false
description: Water Content expressed in parts per million.
Transformer:
slot_uri: cim:TransformerObservation.Transformer
range: TransformerTank
required: false
multivalued: false
WindingInsulationPFs:
slot_uri: cim:TransformerObservation.WindingInsulationPFs
range: WindingInsulation
required: false
multivalued: true
Reconditioning:
slot_uri: cim:TransformerObservation.Reconditioning
range: Reconditioning
required: true
multivalued: false
ProcedureDataSets:
slot_uri: cim:TransformerObservation.ProcedureDataSets
range: ProcedureDataSet
required: false
multivalued: true
BushingInsultationPFs:
slot_uri: cim:TransformerObservation.BushingInsultationPFs
range: BushingInsulationPF
required: false
multivalued: true
Reconditioning:
class_uri: cim:Reconditioning
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfAssets
description: Reconditioning information for an asset.
attributes:
dateTime:
slot_uri: cim:Reconditioning.dateTime
range: date
required: false
multivalued: false
description: Date and time this reconditioning (or a major overhaul) has been
performed.
TransformerObservations:
slot_uri: cim:Reconditioning.TransformerObservations
range: TransformerObservation
required: false
multivalued: true
Asset:
slot_uri: cim:Reconditioning.Asset
range: Asset
required: false
multivalued: false
PowerRatings:
slot_uri: cim:Reconditioning.PowerRatings
range: CoolingPowerRating
required: false
multivalued: true
CoolingPowerRating:
class_uri: cim:CoolingPowerRating
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfAssets
description: "There are often stages of power which are associated with stages\
\ of cooling. For instance, a transformer may be rated 121kV on the primary,\
\ 15kV on the secondary and 4kV on the tertiary winding. These are voltage ratings\
\ and the power ratings are generally the same for all three windings and independent\
\ of the voltage ratings, there are instances where the tertiary may have a\
\ lower power rating.\r\nFor example, for three stages, the power rating may\
\ be 15/20/25 MVA and the cooling is OA/FA/FOA. The 15 MVA rating goes with\
\ the OA cooling (Oil and Air cooling). This is called the self cooled rating\
\ as there are no external cooling enhancements. The 20 MVA rating goes with\
\ the FA cooling (Forced Air cooling), this means that when the fans are running\
\ and thus enhancing the cooling characteristics, the transformer can operate\
\ at a power level of 20 MVA. The 25 MVA rating goes with the FOA cooling (Forced\
\ Oil and Air cooling), this means that when the fans and pumps are running\
\ and thus enhancing the cooling characteristics even more than before, the\
\ transformer can operate at a power level of 25 MVA. This 15/20/25 MVA does\
\ not state how the power is split between the various windings. It may be 25\
\ MVA input on the primary, 25 MVA output on the secondary and 0 MVA output\
\ on the tertiary. It may also operate at 25 MVA input on the primary, 17 MVA\
\ output on the secondary and 8 MVA output on the tertiary."
attributes:
coolingKind:
slot_uri: cim:CoolingPowerRating.coolingKind
range: CoolingKind
required: false
multivalued: false
description: Kind of cooling system.
powerRating:
slot_uri: cim:CoolingPowerRating.powerRating
range: ApparentPower
required: false
multivalued: false
description: The power rating associated with type of cooling specified for
this stage.
stage:
slot_uri: cim:CoolingPowerRating.stage
range: integer
required: false
multivalued: false
description: Stage of cooling and associated power rating.
Reconditionings:
slot_uri: cim:CoolingPowerRating.Reconditionings
range: Reconditioning
required: false
multivalued: true
BushingInsulationPF:
class_uri: cim:BushingInsulationPF
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfAssets
description: "Bushing insulation power factor condition as a result of a test.\r\
\nTypical status values are: Acceptable, Minor Deterioration or Moisture Absorption,\
\ Major Deterioration or Moisture Absorption, Failed."
attributes:
status:
slot_uri: cim:BushingInsulationPF.status
range: Status
required: false
multivalued: false
testKind:
slot_uri: cim:BushingInsulationPF.testKind
range: BushingInsulationPfTestKind
required: false
multivalued: false
description: Kind of test for this bushing.
TransformerObservation:
slot_uri: cim:BushingInsulationPF.TransformerObservation
range: TransformerObservation
required: false
multivalued: false
Bushing:
slot_uri: cim:BushingInsulationPF.Bushing
range: Bushing
required: false
multivalued: false
Bushing:
class_uri: cim:Bushing
is_a: Asset
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: Bushing asset.
attributes:
Terminal:
slot_uri: cim:Bushing.Terminal
range: Terminal
required: false
multivalued: false
description: Terminal to which this bushing is attached.
BushingInsulationPFs:
slot_uri: cim:Bushing.BushingInsulationPFs
range: BushingInsulationPF
required: false
multivalued: true
MovingContact:
slot_uri: cim:Bushing.MovingContact
range: InterrupterUnit
required: false
multivalued: false
description: Moving contact of interrupter to which this bushing is attached.
FixedContact:
slot_uri: cim:Bushing.FixedContact
range: InterrupterUnit
required: false
multivalued: false
description: Fixed contact of interrupter to which this bushing is attached.
InterrupterUnit:
class_uri: cim:InterrupterUnit
is_a: Asset
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: "Breaker interrupter.\r\nSome interrupters have one fixed and one\
\ moving contact, some have 2 fixed contacts, some 2 moving contacts. An interrupter\
\ will have relationships with 2 bushings and those relationships may be any\
\ combination of the FixedContact and MovingContact associations."
attributes:
Bushing:
slot_uri: cim:InterrupterUnit.Bushing
range: Bushing
required: false
multivalued: true
description: Bushing(s) to which the fixed contact(s) of this interrupter
is(are) attached. Some interrupters have one fixed and one moving contact,
some have 2 fixed contacts, some 2 moving contacts. An interrupter will
have relationships with 2 bushings and those relationships may be any combination
of the FixedContact and MovingContact associations.
OperatingMechanism:
slot_uri: cim:InterrupterUnit.OperatingMechanism
range: OperatingMechanism
required: false
multivalued: false
description: Breaker mechanism controlling this interrupter.
OperatingMechanism:
class_uri: cim:OperatingMechanism
is_a: Asset
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: Breaker mechanism.
attributes:
InterrupterUnit:
slot_uri: cim:OperatingMechanism.InterrupterUnit
range: InterrupterUnit
required: false
multivalued: true
description: Interrupter controlled by this mechanism.
TransformerTank:
class_uri: cim:TransformerTank
is_a: Equipment
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: An assembly of two or more coupled windings that transform electrical
power between voltage levels. These windings are bound on a common core and
placed in the same tank. Transformer tank can be used to model both single-phase
and 3-phase transformers.
attributes:
PowerTransformer:
slot_uri: cim:TransformerTank.PowerTransformer
range: PowerTransformer
required: false
multivalued: false
description: Bank this transformer belongs to.
TransformerTankEnds:
slot_uri: cim:TransformerTank.TransformerTankEnds
range: TransformerTankEnd
required: true
multivalued: true
description: All windings of this transformer.
TransformerObservations:
slot_uri: cim:TransformerTank.TransformerObservations
range: TransformerObservation
required: false
multivalued: true
TransformerTankEnd:
class_uri: cim:TransformerTankEnd
is_a: TransformerEnd
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: "Transformer tank end represents an individual winding for unbalanced\
\ models or for transformer tanks connected into a bank (and bank is modelled\
\ with the PowerTransformer).\r\n"
attributes:
phases:
slot_uri: cim:TransformerTankEnd.phases
range: PhaseCode
required: false
multivalued: false
description: Describes the phases carried by a conducting equipment.
TransformerTank:
slot_uri: cim:TransformerTankEnd.TransformerTank
range: TransformerTank
required: false
multivalued: false
description: Transformer this winding belongs to.
PowerTransformer:
class_uri: cim:PowerTransformer
is_a: ConductingEquipment
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: "An electrical device consisting of two or more coupled windings,\
\ with or without a magnetic core, for introducing mutual coupling between electric\
\ circuits. Transformers can be used to control voltage and phase shift (active\
\ power flow).\r\nA power transformer may be composed of separate transformer\
\ tanks that need not be identical.\r\nA power transformer can be modelled with\
\ or without tanks and is intended for use in both balanced and unbalanced representations.\
\ A power transformer typically has two terminals, but may have one (grounding),\
\ three or more terminals.\r\nThe inherited association ConductingEquipment.BaseVoltage\
\ should not be used. The association from TransformerEnd to BaseVoltage should\
\ be used instead."
attributes:
beforeShCircuitHighestOperatingCurrent:
slot_uri: cim:PowerTransformer.beforeShCircuitHighestOperatingCurrent
range: CurrentFlow
required: false
multivalued: false
description: The highest operating current (Ib in IEC 60909-0) before short
circuit (depends on network configuration and relevant reliability philosophy).
It is used for calculation of the impedance correction factor KT defined
in IEC 60909-0.
beforeShCircuitHighestOperatingVoltage:
slot_uri: cim:PowerTransformer.beforeShCircuitHighestOperatingVoltage
range: Voltage
required: false
multivalued: false
description: The highest operating voltage (Ub in IEC 60909-0) before short
circuit. It is used for calculation of the impedance correction factor KT
defined in IEC 60909-0. This is worst case voltage on the low side winding
(3.7.1 of IEC 60909:2001). Used to define operating conditions.
beforeShortCircuitAnglePf:
slot_uri: cim:PowerTransformer.beforeShortCircuitAnglePf
range: AngleDegrees
required: false
multivalued: false
description: The angle of power factor before short circuit (phib in IEC 60909-0).
It is used for calculation of the impedance correction factor KT defined
in IEC 60909-0. This is the worst case power factor. Used to define operating
conditions.
highSideMinOperatingU:
slot_uri: cim:PowerTransformer.highSideMinOperatingU
range: Voltage
required: false
multivalued: false
description: The minimum operating voltage (uQmin in IEC 60909-0) at the high
voltage side (Q side) of the unit transformer of the power station unit.
A value well established from long-term operating experience of the system.
It is used for calculation of the impedance correction factor KG defined
in IEC 60909-0.
isPartOfGeneratorUnit:
slot_uri: cim:PowerTransformer.isPartOfGeneratorUnit
range: boolean
required: false
multivalued: false
description: Indicates whether the machine is part of a power station unit.
Used for short circuit data exchange according to IEC 60909. It has an
impact on how the correction factors are calculated for transformers, since
the transformer is not necessarily part of a synchronous machine and generating
unit. It is not always possible to derive this information from the model.
This is why the attribute is necessary.
operationalValuesConsidered:
slot_uri: cim:PowerTransformer.operationalValuesConsidered
range: boolean
required: false
multivalued: false
description: It is used to define if the data (other attributes related to
short circuit data exchange) defines long term operational conditions or
not. Used for short circuit data exchange according to IEC 60909.
vectorGroup:
slot_uri: cim:PowerTransformer.vectorGroup
range: string
required: false
multivalued: false
description: "Vector group of the transformer for protective relaying, e.g.,\
\ Dyn1. For unbalanced transformers, this may not be simply determined from\
\ the constituent winding connections and phase angle displacements.\r\n\
\r\nThe vectorGroup string consists of the following components in the order\
\ listed: high voltage winding connection, mid voltage winding connection\
\ (for three winding transformers), phase displacement clock number from\
\ 0 to 11, low voltage winding connection \r\nphase displacement clock\
\ number from 0 to 11. The winding connections are D (delta), Y (wye),\
\ YN (wye with neutral), Z (zigzag), ZN (zigzag with neutral), A (auto transformer).\
\ Upper case means the high voltage, lower case mid or low. The high voltage\
\ winding always has clock position 0 and is not included in the vector\
\ group string. Some examples: YNy0 (two winding wye to wye with no phase\
\ displacement), YNd11 (two winding wye to delta with 330 degrees phase\
\ displacement), YNyn0d5 (three winding transformer wye with neutral high\
\ voltage, wye with neutral mid voltage and no phase displacement, delta\
\ low voltage with 150 degrees displacement).\r\n\r\nPhase displacement\
\ is defined as the angular difference between the phasors representing\
\ the voltages between the neutral point (real or imaginary) and the corresponding\
\ terminals of two windings, a positive sequence voltage system being applied\
\ to the high-voltage terminals, following each other in alphabetical sequence\
\ if they are lettered, or in numerical sequence if they are numbered: the\
\ phasors are assumed to rotate in a counter-clockwise sense."
PowerTransformerEnd:
slot_uri: cim:PowerTransformer.PowerTransformerEnd
range: PowerTransformerEnd
required: false
multivalued: true
description: The ends of this power transformer.
TransformerTanks:
slot_uri: cim:PowerTransformer.TransformerTanks
range: TransformerTank
required: false
multivalued: true
description: All transformers that belong to this bank.
PowerTransformerEnd:
class_uri: cim:PowerTransformerEnd
is_a: TransformerEnd
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: "A PowerTransformerEnd is associated with each Terminal of a PowerTransformer.\r\
\nThe impedance values r, r0, x, and x0 of a PowerTransformerEnd represents\
\ a star equivalent as follows.\r\n1) for a two Terminal PowerTransformer the\
\ high voltage (TransformerEnd.endNumber=1) PowerTransformerEnd has non zero\
\ values on r, r0, x, and x0 while the low voltage (TransformerEnd.endNumber=2)\
\ PowerTransformerEnd has zero values for r, r0, x, and x0. Parameters are\
\ always provided, even if the PowerTransformerEnds have the same rated voltage.\
\ In this case, the parameters are provided at the PowerTransformerEnd which\
\ has TransformerEnd.endNumber equal to 1.\r\n2) for a three Terminal PowerTransformer\
\ the three PowerTransformerEnds represent a star equivalent with each leg in\
\ the star represented by r, r0, x, and x0 values.\r\n3) For a three Terminal\
\ transformer each PowerTransformerEnd shall have g, g0, b and b0 values corresponding\
\ to the no load losses distributed on the three PowerTransformerEnds. The total\
\ no load loss shunt impedances may also be placed at one of the PowerTransformerEnds,\
\ preferably the end numbered 1, having the shunt values on end 1. This is\
\ the preferred way.\r\n4) for a PowerTransformer with more than three Terminals\
\ the PowerTransformerEnd impedance values cannot be used. Instead use the TransformerMeshImpedance\
\ or split the transformer into multiple PowerTransformers.\r\nEach PowerTransformerEnd\
\ must be contained by a PowerTransformer. Because a PowerTransformerEnd (or\
\ any other object) can not be contained by more than one parent, a PowerTransformerEnd\
\ can not have an association to an EquipmentContainer (Substation, VoltageLevel,\
\ etc)."
attributes:
b:
slot_uri: cim:PowerTransformerEnd.b
range: Susceptance
required: false
multivalued: false
description: "Magnetizing branch susceptance (B mag). The value can be positive\
\ or negative.\r\n"
b0:
slot_uri: cim:PowerTransformerEnd.b0
range: Susceptance
required: false
multivalued: false
description: "Zero sequence magnetizing branch susceptance.\r\n"
connectionKind:
slot_uri: cim:PowerTransformerEnd.connectionKind
range: WindingConnection
required: false
multivalued: false
description: "Kind of connection.\r\n"
g:
slot_uri: cim:PowerTransformerEnd.g
range: Conductance
required: false
multivalued: false
description: "Magnetizing branch conductance.\r\n"
g0:
slot_uri: cim:PowerTransformerEnd.g0
range: Conductance
required: false
multivalued: false
description: "Zero sequence magnetizing branch conductance (star-model).\r\
\n"
phaseAngleClock:
slot_uri: cim:PowerTransformerEnd.phaseAngleClock
range: integer
required: false
multivalued: false
description: "Terminal voltage phase angle displacement where 360 degrees\
\ are represented with clock hours. The valid values are 0 to 11. For example,\
\ for the secondary side end of a transformer with vector group code of\
\ 'Dyn11', specify the connection kind as wye with neutral and specify the\
\ phase angle of the clock as 11. The clock value of the transformer end\
\ number specified as 1, is assumed to be zero. Note the transformer end\
\ number is not assumed to be the same as the terminal sequence number.\r\
\n"
r:
slot_uri: cim:PowerTransformerEnd.r
range: Resistance
required: false
multivalued: false
description: "Resistance (star-model) of the transformer end.\r\nThe attribute\
\ shall be equal to or greater than zero for non-equivalent transformers."
r0:
slot_uri: cim:PowerTransformerEnd.r0
range: Resistance
required: false
multivalued: false
description: "Zero sequence series resistance (star-model) of the transformer\
\ end.\r\n"
ratedS:
slot_uri: cim:PowerTransformerEnd.ratedS
range: ApparentPower
required: false
multivalued: false
description: "Normal apparent power rating.\r\nThe attribute shall be a positive\
\ value. For a two-winding transformer the values for the high and low voltage\
\ sides shall be identical. "
ratedU:
slot_uri: cim:PowerTransformerEnd.ratedU
range: Voltage
required: false
multivalued: false
description: "Rated voltage: phase-phase for three-phase windings, and either\
\ phase-phase or phase-neutral for single-phase windings.\r\nA high voltage\
\ side, as given by TransformerEnd.endNumber, shall have a ratedU that is\
\ greater than or equal to ratedU for the lower voltage sides.\r\nThe attribute\
\ shall be a positive value."
x:
slot_uri: cim:PowerTransformerEnd.x
range: Reactance
required: false
multivalued: false
description: "Positive sequence series reactance (star-model) of the transformer\
\ end.\r\n"
x0:
slot_uri: cim:PowerTransformerEnd.x0
range: Reactance
required: false
multivalued: false
description: "Zero sequence series reactance of the transformer end.\r\n"
PowerTransformer:
slot_uri: cim:PowerTransformerEnd.PowerTransformer
range: PowerTransformer
required: false
multivalued: false
description: The power transformer of this power transformer end.
WindingInsulation:
class_uri: cim:WindingInsulation
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfAssets
description: Winding insulation condition as a result of a test.
attributes:
insulationPFStatus:
slot_uri: cim:WindingInsulation.insulationPFStatus
range: string
required: false
multivalued: false
description: 'Status of Winding Insulation Power Factor as of statusDate:
Acceptable, Minor Deterioration or Moisture Absorption, Major Deterioration
or Moisture Absorption, Failed.'
insulationResistance:
slot_uri: cim:WindingInsulation.insulationResistance
range: string
required: false
multivalued: false
description: 'For testType, status of Winding Insulation Resistance as of
statusDate. Typical values are: Acceptable, Questionable, Failed.'
leakageReactance:
slot_uri: cim:WindingInsulation.leakageReactance
range: Reactance
required: false
multivalued: false
description: As of statusDate, the leakage reactance measured at the "from"
winding with the "to" winding short-circuited and all other windings open-circuited.
status:
slot_uri: cim:WindingInsulation.status
range: Status
required: false
multivalued: false
FromWinding:
slot_uri: cim:WindingInsulation.FromWinding
range: TransformerEnd
required: true
multivalued: false
ToWinding:
slot_uri: cim:WindingInsulation.ToWinding
range: TransformerEnd
required: true
multivalued: false
TransformerObservation:
slot_uri: cim:WindingInsulation.TransformerObservation
range: TransformerObservation
required: false
multivalued: false
Specification:
class_uri: cim:Specification
is_a: Document
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfAssets
description: Specification can be used for various purposes relative to an asset,
a logical device (PowerSystemResource), location, etc. Examples include documents
supplied by manufacturers such as asset installation instructions, asset maintenance
instructions, etc.
attributes:
AssetPropertyCurves:
slot_uri: cim:Specification.AssetPropertyCurves
range: AssetPropertyCurve
required: false
multivalued: true
Mediums:
slot_uri: cim:Specification.Mediums
range: Medium
required: false
multivalued: true
DimensionsInfos:
slot_uri: cim:Specification.DimensionsInfos
range: DimensionsInfo
required: false
multivalued: true
QualificationRequirements:
slot_uri: cim:Specification.QualificationRequirements
range: QualificationRequirement
required: false
multivalued: true
AssetProperites:
slot_uri: cim:Specification.AssetProperites
range: UserAttribute
required: false
multivalued: true
description: UserAttributes used to specify further properties of the asset
covered with this specification. Use 'name' to specify what kind of property
it is, and 'value.value' attribute for the actual value.
Ratings:
slot_uri: cim:Specification.Ratings
range: UserAttribute
required: false
multivalued: true
description: UserAttributes used to specify ratings of the asset covered by
this specification. Ratings also can be used to set the initial value of
operational measurement limits. Use 'name' to specify what kind of rating
it is (e.g., voltage, current), and 'value' attribute for the actual value
and unit information of the rating.
ReliabilityInfos:
slot_uri: cim:Specification.ReliabilityInfos
range: ReliabilityInfo
required: false
multivalued: true
DimensionsInfo:
class_uri: cim:DimensionsInfo
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfAssets
description: As applicable, the basic linear, area, or volume dimensions of an
asset, asset type (AssetModel) or other type of object (such as land area).
Units and multipliers are specified per dimension.
attributes:
orientation:
slot_uri: cim:DimensionsInfo.orientation
range: string
required: false
multivalued: false
description: A description of the orientation of the object relative to the
dimensions. As an example, a vault may have north-south orientation for
the sizeLength measurement and sizeDepth may be the height of the vault.
sizeDepth:
slot_uri: cim:DimensionsInfo.sizeDepth
range: Length
required: false
multivalued: false
description: ' Depth measurement.'
sizeDiameter:
slot_uri: cim:DimensionsInfo.sizeDiameter
range: Length
required: false
multivalued: false
description: ' Diameter measurement.'
sizeLength:
slot_uri: cim:DimensionsInfo.sizeLength
range: Length
required: false
multivalued: false
description: ' Length measurement.'
sizeWidth:
slot_uri: cim:DimensionsInfo.sizeWidth
range: Length
required: false
multivalued: false
description: ' Width measurement.'
Specifications:
slot_uri: cim:DimensionsInfo.Specifications
range: Specification
required: false
multivalued: true
QualificationRequirement:
class_uri: cim:QualificationRequirement
is_a: WorkIdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfWork
description: ' Certain skills are required and must be certified in order for
a person (typically a member of a crew) to be qualified to work on types of
equipment.'
attributes:
qualificationID:
slot_uri: cim:QualificationRequirement.qualificationID
range: string
required: false
multivalued: false
description: Qualification identifier.
Specifications:
slot_uri: cim:QualificationRequirement.Specifications
range: Specification
required: false
multivalued: true
CULaborItems:
slot_uri: cim:QualificationRequirement.CULaborItems
range: CULaborItem
required: false
multivalued: true
WorkTasks:
slot_uri: cim:QualificationRequirement.WorkTasks
range: OldWorkTask
required: false
multivalued: true
Skills:
slot_uri: cim:QualificationRequirement.Skills
range: Skill
required: false
multivalued: true
CULaborItem:
class_uri: cim:CULaborItem
is_a: WorkIdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfWork
description: Compatible unit labor item.
attributes:
activityCode:
slot_uri: cim:CULaborItem.activityCode
range: string
required: false
multivalued: false
description: ' Activity code identifies a specific and distinguishable unit
of work.'
laborDuration:
slot_uri: cim:CULaborItem.laborDuration
range: Hours
required: false
multivalued: false
description: Estimated time to perform work.
laborRate:
slot_uri: cim:CULaborItem.laborRate
range: CostRate
required: false
multivalued: false
description: ' The labor rate applied for work.'
status:
slot_uri: cim:CULaborItem.status
range: Status
required: false
multivalued: false
CompatibleUnits:
slot_uri: cim:CULaborItem.CompatibleUnits
range: CompatibleUnit
required: false
multivalued: true
QualificationRequirements:
slot_uri: cim:CULaborItem.QualificationRequirements
range: QualificationRequirement
required: false
multivalued: true
CULaborCode:
slot_uri: cim:CULaborItem.CULaborCode
range: CULaborCode
required: false
multivalued: false
CULaborCode:
class_uri: cim:CULaborCode
is_a: WorkIdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfWork
description: Labor code associated with various compatible unit labor items.
attributes:
code:
slot_uri: cim:CULaborCode.code
range: string
required: false
multivalued: false
description: Labor code.
status:
slot_uri: cim:CULaborCode.status
range: Status
required: false
multivalued: false
CULaborItems:
slot_uri: cim:CULaborCode.CULaborItems
range: CULaborItem
required: false
multivalued: true
ReliabilityInfo:
class_uri: cim:ReliabilityInfo
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfAssets
description: Information regarding the experienced and expected reliability of
a specific asset, type of asset, or asset model.
attributes:
momFailureRate:
slot_uri: cim:ReliabilityInfo.momFailureRate
range: PerCent
required: false
multivalued: false
description: Momentary failure rate (temporary failures/kft-year).
mTTR:
slot_uri: cim:ReliabilityInfo.mTTR
range: Hours
required: false
multivalued: false
description: Mean time to repair (MTTR - hours).
Assets:
slot_uri: cim:ReliabilityInfo.Assets
range: Asset
required: false
multivalued: true
Specification:
slot_uri: cim:ReliabilityInfo.Specification
range: Specification
required: false
multivalued: false
AssetPropertyCurve:
class_uri: cim:AssetPropertyCurve
is_a: Curve
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfAssets
description: An Asset Property that is described through curves rather than as
a data point. The relationship is to be defined between an independent variable
(X-axis) and one or two dependent variables (Y1-axis and Y2-axis).
attributes:
Specification:
slot_uri: cim:AssetPropertyCurve.Specification
range: Specification
required: false
multivalued: false
Assets:
slot_uri: cim:AssetPropertyCurve.Assets
range: Asset
required: false
multivalued: true
Curve:
class_uri: cim:Curve
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Core
description: "A multi-purpose curve or functional relationship between an independent\
\ variable (X-axis) and dependent (Y-axis) variables. \r\n"
attributes:
curveStyle:
slot_uri: cim:Curve.curveStyle
range: CurveStyle
required: false
multivalued: false
description: The style or shape of the curve.
xMultiplier:
slot_uri: cim:Curve.xMultiplier
range: UnitMultiplier
required: false
multivalued: false
description: Multiplier for X-axis.
xUnit:
slot_uri: cim:Curve.xUnit
range: UnitSymbol
required: false
multivalued: false
description: The X-axis units of measure.
y1Multiplier:
slot_uri: cim:Curve.y1Multiplier
range: UnitMultiplier
required: false
multivalued: false
description: "Multiplier for Y1-axis.\r\n"
y1Unit:
slot_uri: cim:Curve.y1Unit
range: UnitSymbol
required: false
multivalued: false
description: The Y1-axis units of measure.
y2Multiplier:
slot_uri: cim:Curve.y2Multiplier
range: UnitMultiplier
required: false
multivalued: false
description: Multiplier for Y2-axis.
y2Unit:
slot_uri: cim:Curve.y2Unit
range: UnitSymbol
required: false
multivalued: false
description: The Y2-axis units of measure.
y3Multiplier:
slot_uri: cim:Curve.y3Multiplier
range: UnitMultiplier
required: false
multivalued: false
description: Multiplier for Y3-axis.
y3Unit:
slot_uri: cim:Curve.y3Unit
range: UnitSymbol
required: false
multivalued: false
description: The Y3-axis units of measure.
CurveDatas:
slot_uri: cim:Curve.CurveDatas
range: CurveData
required: false
multivalued: true
description: The point data values that define this curve.
CurveData:
class_uri: cim:CurveData
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Core
description: Multi-purpose data points for defining a curve. The use of this
generic class is discouraged if a more specific class can be used to specify
the X and Y axis values along with their specific data types.
attributes:
xvalue:
slot_uri: cim:CurveData.xvalue
range: float
required: false
multivalued: false
description: "The data value of the X-axis variable, depending on the X-axis\
\ units.\r\n"
y1value:
slot_uri: cim:CurveData.y1value
range: float
required: false
multivalued: false
description: "The data value of the first Y-axis variable, depending on the\
\ Y-axis units.\r\n"
y2value:
slot_uri: cim:CurveData.y2value
range: float
required: false
multivalued: false
description: "The data value of the second Y-axis variable (if present), depending\
\ on the Y-axis units.\r\n"
y3value:
slot_uri: cim:CurveData.y3value
range: float
required: false
multivalued: false
description: "The data value of the third Y-axis variable (if present), depending\
\ on the Y-axis units.\r\n"
Curve:
slot_uri: cim:CurveData.Curve
range: Curve
required: true
multivalued: false
description: The curve of this curve data point.
Medium:
class_uri: cim:Medium
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: A substance that either (1) provides the means of transmission of
a force or effect, such as hydraulic fluid, or (2) is used for a surrounding
or enveloping substance, such as oil in a transformer or circuit breaker.
attributes:
kind:
slot_uri: cim:Medium.kind
range: MediumKind
required: false
multivalued: false
description: Kind of this medium.
volumeSpec:
slot_uri: cim:Medium.volumeSpec
range: Volume
required: false
multivalued: false
description: The volume of the medium specified for this application. Note
that the actual volume is a type of measurement associated witht the asset.
Asset:
slot_uri: cim:Medium.Asset
range: Asset
required: false
multivalued: true
description: Medium with which this asset is filled.
Specification:
slot_uri: cim:Medium.Specification
range: Specification
required: false
multivalued: false
CashierShift:
class_uri: cim:CashierShift
is_a: Shift
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.PaymentMetering
description: The operating shift for a cashier, during which the cashier may transact
against the cashier shift, subject to vendor shift being open.
attributes:
cashFloat:
slot_uri: cim:CashierShift.cashFloat
range: Money
required: false
multivalued: false
description: The amount of cash that the cashier brings to start the shift
and that will be taken away at the end of the shift; i.e. the cash float
does not get banked.
Transactions:
slot_uri: cim:CashierShift.Transactions
range: Transaction
required: false
multivalued: true
description: All transactions recorded during this cashier shift.
Receipts:
slot_uri: cim:CashierShift.Receipts
range: Receipt
required: false
multivalued: true
description: All Receipts recorded for this Shift.
PointOfSale:
slot_uri: cim:CashierShift.PointOfSale
range: PointOfSale
required: false
multivalued: false
description: Point of sale that is in operation during this shift.
Cashier:
slot_uri: cim:CashierShift.Cashier
range: Cashier
required: false
multivalued: false
description: Cashier operating this shift.
Shift:
class_uri: cim:Shift
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.PaymentMetering
description: "Generally referring to a period of operation or work performed.\
\ Whether the shift is open/closed can be derived from attributes 'activityInterval.start'\
\ and 'activityInterval.end'.\r\nThe grand total for receipts (i.e., cumulative\
\ total of all actual receipted amounts during this shift; bankable + non-bankable;\
\ excludes rounding error totals) can be derived from receipt:\r\n=sum('Receipt.receiptAmount');\
\ includes bankable and non-bankable receipts.\r\nIt also has to be reconciled\
\ against:\r\n=sum('receiptsGrandTotalBankable' + 'receiptsGrandTotalNonBankable')\r\
\nand against receipt summary:\r\n=sum('ReceiptSummary.receiptsTotal').\r\n\
The attributes with \"GrandTotal\" defined in this class may need to be used\
\ when the source data is periodically flushed from the system and then these\
\ cannot be derived."
attributes:
activityInterval:
slot_uri: cim:Shift.activityInterval
range: DateTimeInterval
required: false
multivalued: false
description: Interval for activity of this shift.
receiptsGrandTotalBankable:
slot_uri: cim:Shift.receiptsGrandTotalBankable
range: Money
required: false
multivalued: false
description: "Total of amounts receipted during this shift that can be manually\
\ banked (cash and cheques for example). Values are obtained from Receipt\
\ attributes:\r\n=sum(Receipt.receiptAmount) for all Receipt.bankable =\
\ true."
receiptsGrandTotalNonBankable:
slot_uri: cim:Shift.receiptsGrandTotalNonBankable
range: Money
required: false
multivalued: false
description: "Total of amounts receipted during this shift that cannot be\
\ manually banked (card payments for example). Values are obtained from\
\ Receipt attributes:\r\n=sum(Receipt.receiptAmount) for all Receipt.bankable\
\ = false."
receiptsGrandTotalRounding:
slot_uri: cim:Shift.receiptsGrandTotalRounding
range: Money
required: false
multivalued: false
description: "Cumulative amount in error due to process rounding not reflected\
\ in receiptsGrandTotal. Values are obtained from Receipt attributes:\r\n\
=sum(Receipt.receiptRounding)."
transactionsGrandTotal:
slot_uri: cim:Shift.transactionsGrandTotal
range: Money
required: false
multivalued: false
description: "Cumulative total of transacted amounts during this shift. Values\
\ are obtained from transaction:\r\n=sum('Transaction.transactionAmount').\
\ It also has to be reconciled against transaction summary:\r\n=sum('TransactionSummary.transactionsTotal')."
transactionsGrandTotalRounding:
slot_uri: cim:Shift.transactionsGrandTotalRounding
range: Money
required: false
multivalued: false
description: "Cumulative amount in error due to process rounding not reflected\
\ in transactionsGandTotal. Values are obtained from Transaction attributes:\r\
\n=sum(Transaction.transactionRounding)."
Cashier:
class_uri: cim:Cashier
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.PaymentMetering
description: The operator of the point of sale for the duration of CashierShift.
Cashier is under the exclusive management control of Vendor.
attributes:
electronicAddress:
slot_uri: cim:Cashier.electronicAddress
range: ElectronicAddress
required: false
multivalued: false
description: Electronic address.
CashierShifts:
slot_uri: cim:Cashier.CashierShifts
range: CashierShift
required: false
multivalued: true
description: All shifts operated by this cashier.
Receipt:
class_uri: cim:Receipt
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.PaymentMetering
description: "Record of total receipted payment from customer.\r\n"
attributes:
isBankable:
slot_uri: cim:Receipt.isBankable
range: boolean
required: false
multivalued: false
description: True if this receipted payment is manually bankable, otherwise
it is an electronic funds transfer.
line:
slot_uri: cim:Receipt.line
range: LineDetail
required: false
multivalued: false
description: Receipted amount with rounding, date and note.
Transactions:
slot_uri: cim:Receipt.Transactions
range: Transaction
required: true
multivalued: true
description: All transactions recorded for this receipted payment.
CashierShift:
slot_uri: cim:Receipt.CashierShift
range: CashierShift
required: false
multivalued: false
description: Cashier shift during which this receipt was recorded.
Tenders:
slot_uri: cim:Receipt.Tenders
range: Tender
required: true
multivalued: true
description: All payments received in the form of tenders recorded by this
receipt.
VendorShift:
slot_uri: cim:Receipt.VendorShift
range: VendorShift
required: false
multivalued: false
description: Vendor shift during which this receipt was recorded.
Tender:
class_uri: cim:Tender
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.PaymentMetering
description: "Tender is what is \"offered\" by the customer towards making a payment\
\ and is often more than the required payment (hence the need for 'change').\
\ The payment is thus that part of the Tender that goes towards settlement of\
\ a particular transaction.\r\nTender is modelled as an aggregation of Cheque\
\ and Card. Both these tender types can exist in a single tender bid thus 'accountHolderName'\
\ has to exist separately in each of Cheque and Card as each could have a different\
\ account holder name."
attributes:
amount:
slot_uri: cim:Tender.amount
range: Money
required: false
multivalued: false
description: Amount tendered by customer.
change:
slot_uri: cim:Tender.change
range: Money
required: false
multivalued: false
description: Difference between amount tendered by customer and the amount
charged by point of sale.
kind:
slot_uri: cim:Tender.kind
range: TenderKind
required: false
multivalued: false
description: Kind of tender from customer.
Receipt:
slot_uri: cim:Tender.Receipt
range: Receipt
required: true
multivalued: false
description: Receipt that recorded this receiving of a payment in the form
of tenders.
Card:
slot_uri: cim:Tender.Card
range: Card
required: false
multivalued: false
description: Card used to tender payment.
Cheque:
slot_uri: cim:Tender.Cheque
range: Cheque
required: false
multivalued: false
description: Cheque used to tender payment.
Card:
class_uri: cim:Card
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.PaymentMetering
description: "Documentation of the tender when it is a type of card (credit, debit,\
\ etc).\r\n"
attributes:
accountHolderName:
slot_uri: cim:Card.accountHolderName
range: string
required: false
multivalued: false
description: Name of account holder.
cvNumber:
slot_uri: cim:Card.cvNumber
range: string
required: false
multivalued: false
description: The card verification number.
expiryDate:
slot_uri: cim:Card.expiryDate
range: date
required: false
multivalued: false
description: "The date when this card expires.\r\n"
pan:
slot_uri: cim:Card.pan
range: string
required: false
multivalued: false
description: The primary account number.
Tender:
slot_uri: cim:Card.Tender
range: Tender
required: true
multivalued: false
description: Payment tender this card is being used for.
Cheque:
class_uri: cim:Cheque
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.PaymentMetering
description: "The actual tender when it is a type of cheque.\r\n"
attributes:
bankAccountDetail:
slot_uri: cim:Cheque.bankAccountDetail
range: BankAccountDetail
required: false
multivalued: false
description: Details of the account holder and bank.
chequeNumber:
slot_uri: cim:Cheque.chequeNumber
range: string
required: false
multivalued: false
description: Cheque reference number as printed on the cheque.
date:
slot_uri: cim:Cheque.date
range: date
required: false
multivalued: false
description: "Date when cheque becomes valid.\r\n"
kind:
slot_uri: cim:Cheque.kind
range: ChequeKind
required: false
multivalued: false
description: Kind of cheque.
micrNumber:
slot_uri: cim:Cheque.micrNumber
range: string
required: false
multivalued: false
description: The magnetic ink character recognition number printed on the
cheque.
Tender:
slot_uri: cim:Cheque.Tender
range: Tender
required: true
multivalued: false
description: Payment tender the cheque is being used for.
BankAccountDetail:
class_uri: cim:BankAccountDetail
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.PaymentMetering
description: Details of a bank account.
attributes:
accountNumber:
slot_uri: cim:BankAccountDetail.accountNumber
range: string
required: false
multivalued: false
description: Operational account reference number.
bankName:
slot_uri: cim:BankAccountDetail.bankName
range: string
required: false
multivalued: false
description: Name of bank where account is held.
branchCode:
slot_uri: cim:BankAccountDetail.branchCode
range: string
required: false
multivalued: false
description: Branch of bank where account is held.
holderID:
slot_uri: cim:BankAccountDetail.holderID
range: string
required: false
multivalued: false
description: National identity number (or equivalent) of account holder.
holderName:
slot_uri: cim:BankAccountDetail.holderName
range: string
required: false
multivalued: false
description: Name of account holder.
VendorShift:
class_uri: cim:VendorShift
is_a: Shift
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.PaymentMetering
description: The operating shift for a vendor during which the vendor may transact
against the merchant's account. It aggregates transactions and receipts during
the shift and periodically debits a merchant account. The totals in vendor shift
should always be the sum of totals aggregated in all cashier shifts that were
open under the particular vendor shift.
attributes:
merchantDebitAmount:
slot_uri: cim:VendorShift.merchantDebitAmount
range: Money
required: false
multivalued: false
description: The amount that is to be debited from the merchant account for
this vendor shift. This amount reflects the sum(PaymentTransaction.transactionAmount).
posted:
slot_uri: cim:VendorShift.posted
range: boolean
required: false
multivalued: false
description: "If true, merchantDebitAmount has been debited from MerchantAccount;\
\ typically happens at the end of VendorShift when it closes.\r\n"
Receipts:
slot_uri: cim:VendorShift.Receipts
range: Receipt
required: false
multivalued: true
description: All receipts recorded during this vendor shift.
Transactions:
slot_uri: cim:VendorShift.Transactions
range: Transaction
required: false
multivalued: true
description: All transactions recorded during this vendor shift.
MerchantAccount:
slot_uri: cim:VendorShift.MerchantAccount
range: MerchantAccount
required: false
multivalued: false
description: Merchant account this vendor shift periodically debits (based
on aggregated transactions).
Vendor:
slot_uri: cim:VendorShift.Vendor
range: Vendor
required: false
multivalued: false
description: Vendor that opens and owns this vendor shift.
MerchantAccount:
class_uri: cim:MerchantAccount
is_a: Document
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.PaymentMetering
description: The operating account controlled by merchant agreement, against which
the vendor may vend tokens or receipt payments. Transactions via vendor shift
debit the account and bank deposits via bank statement credit the account.
attributes:
currentBalance:
slot_uri: cim:MerchantAccount.currentBalance
range: Money
required: false
multivalued: false
description: The current operating balance of this account.
provisionalBalance:
slot_uri: cim:MerchantAccount.provisionalBalance
range: Money
required: false
multivalued: false
description: The balance of this account after taking into account any pending
debits from VendorShift.merchantDebitAmount and pending credits from BankStatement.merchantCreditAmount
or credits (see also BankStatement attributes and VendorShift attributes).
VendorShifts:
slot_uri: cim:MerchantAccount.VendorShifts
range: VendorShift
required: false
multivalued: true
description: All vendor shifts that operate on this merchant account.
Transactors:
slot_uri: cim:MerchantAccount.Transactors
range: Transactor
required: false
multivalued: true
description: All transactors this merchant account is registered with.
MerchantAgreement:
slot_uri: cim:MerchantAccount.MerchantAgreement
range: MerchantAgreement
required: false
multivalued: false
description: Merchant agreement that instantiated this merchant account.
MerchantAgreement:
class_uri: cim:MerchantAgreement
is_a: Agreement
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.PaymentMetering
description: A formal controlling contractual agreement between supplier and merchant,
in terms of which the merchant is authorised to vend tokens and receipt payments
on behalf of the supplier. The merchant is accountable to the supplier for revenue
collected at point of sale.
attributes:
MerchantAccounts:
slot_uri: cim:MerchantAgreement.MerchantAccounts
range: MerchantAccount
required: false
multivalued: true
description: All merchant accounts instantiated as a result of this merchant
agreement.
Transactor:
class_uri: cim:Transactor
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.PaymentMetering
description: The entity that ultimately executes the transaction and which is
in control of the process; typically this is embodied in secure software running
on a server that may employ secure hardware encryption devices for secure transaction
processing.
attributes:
MerchantAccounts:
slot_uri: cim:Transactor.MerchantAccounts
range: MerchantAccount
required: false
multivalued: true
description: All merchant accounts registered with this transactor.
Vendor:
class_uri: cim:Vendor
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.PaymentMetering
description: The entity that owns the point of sale and contracts with the cashier
to receipt payments and vend tokens using the payment system. The vendor has
a private contract with and is managed by the merchant which is a type of organisation.
The vendor is accountable to the merchant for revenue collected, and the merchant
is in turn accountable to the supplier.
attributes:
VendorShifts:
slot_uri: cim:Vendor.VendorShifts
range: VendorShift
required: false
multivalued: true
description: All vendor shifts opened and owned by this vendor.
PointOfSale:
class_uri: cim:PointOfSale
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.PaymentMetering
description: 'Logical point where transactions take place with operational interaction
between cashier and the payment system; in certain cases the point of sale interacts
directly with the end customer, in which case the cashier might not be a real
person: for example a self-service kiosk or over the internet.'
attributes:
location:
slot_uri: cim:PointOfSale.location
range: string
required: false
multivalued: false
description: Local description for where this point of sale is physically
located.
CashierShifts:
slot_uri: cim:PointOfSale.CashierShifts
range: CashierShift
required: false
multivalued: true
description: All shifts this point of sale operated in.
AuxiliaryAccount:
class_uri: cim:AuxiliaryAccount
is_a: Document
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.PaymentMetering
description: "Variable and dynamic part of auxiliary agreement, generally representing\
\ the current state of the account related to the outstanding balance defined\
\ in auxiliary agreement.\r\n"
attributes:
balance:
slot_uri: cim:AuxiliaryAccount.balance
range: Money
required: false
multivalued: false
description: The total amount currently remaining on this account that is
required to be paid in order to settle the account to zero. This excludes
any due amounts not yet paid.
due:
slot_uri: cim:AuxiliaryAccount.due
range: Due
required: false
multivalued: false
description: Current amounts now due for payment on this account.
lastCredit:
slot_uri: cim:AuxiliaryAccount.lastCredit
range: AccountMovement
required: false
multivalued: false
description: Details of the last credit transaction performed on this account.
lastDebit:
slot_uri: cim:AuxiliaryAccount.lastDebit
range: AccountMovement
required: false
multivalued: false
description: Details of the last debit transaction performed on this account.
principleAmount:
slot_uri: cim:AuxiliaryAccount.principleAmount
range: Money
required: false
multivalued: false
description: The initial principle amount, with which this account was instantiated.
Charges:
slot_uri: cim:AuxiliaryAccount.Charges
range: Charge
required: false
multivalued: true
description: All charges levied on this account.
PaymentTransactions:
slot_uri: cim:AuxiliaryAccount.PaymentTransactions
range: Transaction
required: false
multivalued: true
description: All payments against this account.
AuxiliaryAgreement:
slot_uri: cim:AuxiliaryAccount.AuxiliaryAgreement
range: AuxiliaryAgreement
required: false
multivalued: false
description: Auxiliary agreement regulating this account.
Due:
class_uri: cim:Due
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.PaymentMetering
description: Details on amounts due for an account.
attributes:
arrears:
slot_uri: cim:Due.arrears
range: Money
required: false
multivalued: false
description: Part of 'current' that constitutes the arrears portion.
charges:
slot_uri: cim:Due.charges
range: Money
required: false
multivalued: false
description: 'Part of ''current'' that constitutes the charge portion: ''charges''
= ''Charge.fixedPortion'' + ''Charge.variablePortion''.'
current:
slot_uri: cim:Due.current
range: Money
required: false
multivalued: false
description: 'Current total amount now due: current = principle + arrears
+ interest + charges. Typically the rule for settlement priority is: interest
dues, then arrears dues, then current dues, then charge dues.'
interest:
slot_uri: cim:Due.interest
range: Money
required: false
multivalued: false
description: Part of 'current' that constitutes the interest portion.
principle:
slot_uri: cim:Due.principle
range: Money
required: false
multivalued: false
description: Part of 'current' that constitutes the portion of the principle
amount currently due.
AccountMovement:
class_uri: cim:AccountMovement
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.PaymentMetering
description: "Credit/debit movements for an account.\r\n"
attributes:
amount:
slot_uri: cim:AccountMovement.amount
range: Money
required: false
multivalued: false
description: 'Amount that was credited to/debited from an account. For example:
payment received/interest charge on arrears.'
dateTime:
slot_uri: cim:AccountMovement.dateTime
range: date
required: false
multivalued: false
description: "Date and time when the credit/debit transaction was performed.\r\
\n"
reason:
slot_uri: cim:AccountMovement.reason
range: string
required: false
multivalued: false
description: 'Reason for credit/debit transaction on an account. Example:
payment received/arrears interest levied.'
AuxiliaryAgreement:
class_uri: cim:AuxiliaryAgreement
is_a: Agreement
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.PaymentMetering
description: "An ad-hoc auxiliary account agreement associated with a customer\
\ agreement, not part of the customer's account, but typically subject to formal\
\ agreement between customer and supplier (utility). Typically this is used\
\ to collect revenue owed by the customer for other services or arrears accrued\
\ with the utility for other services. It is typically linked to a prepaid token\
\ purchase transaction, thus forcing the customer to make a payment towards\
\ settlement of the auxiliary account balance whenever the customer needs to\
\ purchase a prepaid token for electricity.\r\nThe present status of the auxiliary\
\ agreement can be defined in the context of the utility's business rules, for\
\ example: enabled, disabled, pending, over recovered, under recovered, written\
\ off, etc."
attributes:
arrearsInterest:
slot_uri: cim:AuxiliaryAgreement.arrearsInterest
range: PerCent
required: false
multivalued: false
description: "The interest per annum to be charged prorata on 'AuxiliaryAccount.dueArrears'\
\ at the end of each 'payCycle'.\r\n"
auxCycle:
slot_uri: cim:AuxiliaryAgreement.auxCycle
range: string
required: false
multivalued: false
description: "The frequency for automatically recurring auxiliary charges,\
\ where 'AuxiliaryAccount.initialCharge' is recursively added to 'AuxiliaryAccount.dueCurrent'\
\ at the start of each 'auxCycle'. For example: on a specified date and\
\ time; hourly; daily; weekly; monthly; 3-monthly; 6-monthly; 12-monthly;\
\ etc.\r\n"
auxPriorityCode:
slot_uri: cim:AuxiliaryAgreement.auxPriorityCode
range: string
required: false
multivalued: false
description: "The coded priority indicating the priority that this auxiliary\
\ agreement has above other auxiliary agreements (associated with the same\
\ customer agreement) when it comes to competing for settlement from a payment\
\ transaction or token purchase.\r\n"
fixedAmount:
slot_uri: cim:AuxiliaryAgreement.fixedAmount
range: Money
required: false
multivalued: false
description: The fixed amount that has to be collected from each vending transaction
towards settlement of this auxiliary agreement. Note that there may be multiple
tokens vended per vending transaction, but this is not relevant.
minAmount:
slot_uri: cim:AuxiliaryAgreement.minAmount
range: Money
required: false
multivalued: false
description: The minimum amount that has to be paid at any transaction towards
settling this auxiliary agreement or reducing the balance.
payCycle:
slot_uri: cim:AuxiliaryAgreement.payCycle
range: string
required: false
multivalued: false
description: 'The contractually expected payment frequency (by the customer).
Examples are: ad-hoc; on specified date; hourly, daily, weekly, monthly.
etc.'
subType:
slot_uri: cim:AuxiliaryAgreement.subType
range: string
required: false
multivalued: false
description: "Sub-classification of the inherited 'type' for this AuxiliaryAgreement.\r\
\n"
vendPortion:
slot_uri: cim:AuxiliaryAgreement.vendPortion
range: PerCent
required: false
multivalued: false
description: The percentage of the transaction amount that has to be collected
from each vending transaction towards settlement of this auxiliary agreement
when payments are not in arrears. Note that there may be multiple tokens
vended per vending transaction, but this is not relevant.
vendPortionArrear:
slot_uri: cim:AuxiliaryAgreement.vendPortionArrear
range: PerCent
required: false
multivalued: false
description: The percentage of the transaction amount that has to be collected
from each vending transaction towards settlement of this auxiliary agreement
when payments are in arrears. Note that there may be multiple tokens vended
per vending transaction, but this is not relevant.
AuxiliaryAccounts:
slot_uri: cim:AuxiliaryAgreement.AuxiliaryAccounts
range: AuxiliaryAccount
required: true
multivalued: true
description: All auxiliary accounts regulated by this agreement.
CustomerAgreement:
slot_uri: cim:AuxiliaryAgreement.CustomerAgreement
range: CustomerAgreement
required: false
multivalued: false
description: Customer agreement this (non-service related) auxiliary agreement
refers to.
Charge:
class_uri: cim:Charge
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.PaymentMetering
description: A charge element associated with other entities such as tariff structures,
auxiliary agreements or other charge elements. The total charge amount applicable
to this instance of charge is the sum of fixed and variable portion.
attributes:
fixedPortion:
slot_uri: cim:Charge.fixedPortion
range: AccountingUnit
required: false
multivalued: false
description: The fixed portion of this charge element.
kind:
slot_uri: cim:Charge.kind
range: ChargeKind
required: false
multivalued: false
description: The kind of charge to be applied.
variablePortion:
slot_uri: cim:Charge.variablePortion
range: PerCent
required: false
multivalued: false
description: The variable portion of this charge element, calculated as a
percentage of the total amount of a parent charge.
ChildCharges:
slot_uri: cim:Charge.ChildCharges
range: Charge
required: false
multivalued: true
description: All sub-components of this complex charge.
ParentCharge:
slot_uri: cim:Charge.ParentCharge
range: Charge
required: false
multivalued: false
description: Parent of this charge sub-component.
TimeTariffIntervals:
slot_uri: cim:Charge.TimeTariffIntervals
range: TimeTariffInterval
required: false
multivalued: true
description: Tariff intervals to which this time-based charge has to be levied.
ConsumptionTariffIntervals:
slot_uri: cim:Charge.ConsumptionTariffIntervals
range: ConsumptionTariffInterval
required: false
multivalued: true
description: Tariff intervals to which this consumption-based charge has to
be levied.
AuxiliaryAccounts:
slot_uri: cim:Charge.AuxiliaryAccounts
range: AuxiliaryAccount
required: false
multivalued: true
description: All auxiliary accounts to which this charge has to be levied.
AccountingUnit:
class_uri: cim:AccountingUnit
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.PaymentMetering
description: Unit for accounting; use either 'energyUnit' or 'currencyUnit' to
specify the unit for 'value'.
attributes:
energyUnit:
slot_uri: cim:AccountingUnit.energyUnit
range: RealEnergy
required: false
multivalued: false
description: Unit of service.
monetaryUnit:
slot_uri: cim:AccountingUnit.monetaryUnit
range: Currency
required: false
multivalued: false
description: Unit of currency.
multiplier:
slot_uri: cim:AccountingUnit.multiplier
range: UnitMultiplier
required: false
multivalued: false
description: Multiplier for the 'energyUnit' or 'monetaryUnit'.
value:
slot_uri: cim:AccountingUnit.value
range: float
required: false
multivalued: false
description: Value expressed in applicable units.
TimeTariffInterval:
class_uri: cim:TimeTariffInterval
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.PaymentMetering
description: "One of a sequence of time intervals defined in terms of real time.\
\ It is typically used in association with TariffProfile to define the intervals\
\ in a time of use tariff structure, where startDateTime simultaneously determines\
\ the starting point of this interval and the ending point of the previous interval.\r\
\n"
attributes:
sequenceNumber:
slot_uri: cim:TimeTariffInterval.sequenceNumber
range: integer
required: false
multivalued: false
description: A sequential reference that defines the identity of this interval
and its relative position with respect to other intervals in a sequence
of intervals.
startTime:
slot_uri: cim:TimeTariffInterval.startTime
range: time
required: false
multivalued: false
description: "A real time marker that defines the starting time (typically\
\ it is the time of day) for this interval. The interval extends to the\
\ start of the next interval or until it is reset to the start of the first\
\ interval by TariffProfile.tariffCycle.\r\n"
Charges:
slot_uri: cim:TimeTariffInterval.Charges
range: Charge
required: false
multivalued: true
description: All charges used to define this time tariff interval.
TariffProfiles:
slot_uri: cim:TimeTariffInterval.TariffProfiles
range: TariffProfile
required: false
multivalued: true
description: All tariff profiles defined by this time tariff interval.
ConsumptionTariffIntervals:
slot_uri: cim:TimeTariffInterval.ConsumptionTariffIntervals
range: ConsumptionTariffInterval
required: false
multivalued: true
description: All consumption tariff intervals that introduce variation in
this time of use tariff interval; allows to express e.g., peak hour prices
that are different with different consumption blocks.
TariffProfile:
class_uri: cim:TariffProfile
is_a: Document
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.PaymentMetering
description: 'A schedule of charges; structure associated with Tariff that allows
the definition of complex tarif structures such as step and time of use when
used in conjunction with TimeTariffInterval and Charge. Inherited ''status.value''
is defined in the context of the utility''s business rules, for example: active,
inactive, etc.'
attributes:
tariffCycle:
slot_uri: cim:TariffProfile.tariffCycle
range: string
required: false
multivalued: false
description: 'The frequency at which the tariff charge schedule is repeated.
Examples are: once off on a specified date and time; hourly; daily; weekly;
monthly; 3-monthly; 6-monthly; 12-monthly; etc. At the end of each cycle,
the business rules are reset to start from the beginning again.'
TimeTariffIntervals:
slot_uri: cim:TariffProfile.TimeTariffIntervals
range: TimeTariffInterval
required: false
multivalued: true
description: All time tariff intervals used to define this tariff profile.
ConsumptionTariffIntervals:
slot_uri: cim:TariffProfile.ConsumptionTariffIntervals
range: ConsumptionTariffInterval
required: false
multivalued: true
description: All consumption tariff intervals used to define this tariff profile.
Tariffs:
slot_uri: cim:TariffProfile.Tariffs
range: Tariff
required: false
multivalued: true
description: All tariffs defined by this tariff profile.
Tariff:
class_uri: cim:Tariff
is_a: Document
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Customers
description: "Document, approved by the responsible regulatory agency, listing\
\ the terms and conditions, including a schedule of prices, under which utility\
\ services will be provided. It has a unique number within the state or province.\
\ For rate schedules it is frequently allocated by the affiliated Public utilities\
\ commission (PUC).\r\n"
attributes:
endDate:
slot_uri: cim:Tariff.endDate
range: date
required: false
multivalued: false
description: "(if tariff became inactive) Date tariff was terminated.\r\n"
startDate:
slot_uri: cim:Tariff.startDate
range: date
required: false
multivalued: false
description: "Date tariff was activated.\r\n"
TariffProfiles:
slot_uri: cim:Tariff.TariffProfiles
range: TariffProfile
required: false
multivalued: true
description: All tariff profiles using this tariff.
PricingStructures:
slot_uri: cim:Tariff.PricingStructures
range: PricingStructure
required: false
multivalued: true
description: All pricing structures using this tariff.
ConsumptionTariffInterval:
class_uri: cim:ConsumptionTariffInterval
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.PaymentMetering
description: One of a sequence of intervals defined in terms of consumption quantity
of a service such as electricity, water, gas, etc. It is typically used in association
with TariffProfile to define the steps or blocks in a step tariff structure,
where startValue simultaneously defines the entry value of this step and the
closing value of the previous step. Where consumption is >= startValue it falls
within this interval and where consumption is < startValue it falls within the
previous interval.
attributes:
sequenceNumber:
slot_uri: cim:ConsumptionTariffInterval.sequenceNumber
range: integer
required: false
multivalued: false
description: A sequential reference that defines the identity of this interval
and its relative position with respect to other intervals in a sequence
of intervals.
startValue:
slot_uri: cim:ConsumptionTariffInterval.startValue
range: float
required: false
multivalued: false
description: The lowest level of consumption that defines the starting point
of this interval. The interval extends to the start of the next interval
or until it is reset to the start of the first interval by TariffProfile.tariffCycle.
ReadingType:
slot_uri: cim:ConsumptionTariffInterval.ReadingType
range: ReadingType
required: false
multivalued: false
description: Reading type for 'startValue'.
Charges:
slot_uri: cim:ConsumptionTariffInterval.Charges
range: Charge
required: false
multivalued: true
description: All charges used to define this consumption tariff interval.
TouTariffIntervals:
slot_uri: cim:ConsumptionTariffInterval.TouTariffIntervals
range: TimeTariffInterval
required: false
multivalued: true
description: All time of use tariff intervals influenced by this consumption
tariff interval.
TariffProfiles:
slot_uri: cim:ConsumptionTariffInterval.TariffProfiles
range: TariffProfile
required: false
multivalued: true
description: All tariff profiles defined by this consumption tariff interval.
ReadingType:
class_uri: cim:ReadingType
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
description: 'Detailed description for a type of a reading value. Values in attributes
allow for the creation of recommended codes to be used for identifying reading
value types as follows: ..................'
attributes:
accumulation:
slot_uri: cim:ReadingType.accumulation
range: AccumulationKind
required: false
multivalued: false
description: Accumulation behaviour of a reading over time, usually 'measuringPeriod',
to be used with individual endpoints (as opposed to 'macroPeriod' and 'aggregate'
that are used to describe aggregations of data from individual endpoints).
aggregate:
slot_uri: cim:ReadingType.aggregate
range: AggregateKind
required: false
multivalued: false
description: Salient attribute of the reading data aggregated from individual
endpoints. This is mainly used to define a mathematical operation carried
out over 'macroPeriod', but may also be used to describe an attribute of
the data when the 'macroPeriod' is not defined.
argument:
slot_uri: cim:ReadingType.argument
range: RationalNumber
required: false
multivalued: false
description: "Argument used to introduce numbers into the unit of measure\
\ description where they are needed (e.g., 4 where the measure needs an\
\ argument such as CEMI(n=4)). Most arguments used in practice however will\
\ be integers (i.e., 'denominator'=1).\r\nValue 0 in 'numerator' and 'denominator'\
\ means not applicable.\r\n"
commodity:
slot_uri: cim:ReadingType.commodity
range: CommodityKind
required: false
multivalued: false
description: Commodity being measured.
consumptionTier:
slot_uri: cim:ReadingType.consumptionTier
range: integer
required: false
multivalued: false
description: "In case of common flat-rate pricing for power, in which all\
\ purchases are at a given rate, 'consumptionTier'=0. Otherwise, the value\
\ indicates the consumption tier, which can be used in conjunction with\
\ TOU or CPP pricing.\r\nConsumption tier pricing refers to the method of\
\ billing in which a certain \"block\" of energy is purchased/sold at one\
\ price, after which the next block of energy is purchased at another price,\
\ and so on, all throughout a defined period. At the start of the defined\
\ period, consumption is initially zero, and any usage is measured against\
\ the first consumption tier ('consumptionTier'=1). If this block of energy\
\ is consumed before the end of the period, energy consumption moves to\
\ be reconed against the second consumption tier ('consumptionTier'=2),\
\ and so on. At the end of the defined period, the consumption accumulator\
\ is reset, and usage within the 'consumptionTier'=1 restarts.\r\n"
cpp:
slot_uri: cim:ReadingType.cpp
range: integer
required: false
multivalued: false
description: "Critical peak period (CPP) bucket the reading value is attributed\
\ to. Value 0 means not applicable. Even though CPP is usually considered\
\ a specialised form of time of use 'tou', this attribute is defined explicitly\
\ for flexibility.\r\n"
currency:
slot_uri: cim:ReadingType.currency
range: Currency
required: false
multivalued: false
description: Metering-specific currency.
flowDirection:
slot_uri: cim:ReadingType.flowDirection
range: FlowDirectionKind
required: false
multivalued: false
description: Flow direction for a reading where the direction of flow of the
commodity is important (for electricity measurements this includes current,
energy, power, and demand).
interharmonic:
slot_uri: cim:ReadingType.interharmonic
range: ReadingInterharmonic
required: false
multivalued: false
description: "Indication of a \"harmonic\" or \"interharmonic\" basis for\
\ the measurement. Value 0 in 'numerator' and 'denominator' means not applicable.\r\
\n"
macroPeriod:
slot_uri: cim:ReadingType.macroPeriod
range: MacroPeriodKind
required: false
multivalued: false
description: Time period of interest that reflects how the reading is viewed
or captured over a long period of time.
measurementKind:
slot_uri: cim:ReadingType.measurementKind
range: MeasurementKind
required: false
multivalued: false
description: 'Identifies "what" is being measured, as refinement of ''commodity''.
When combined with ''unit'', it provides detail to the unit of measure.
For example, ''energy'' with a unit of measure of ''kWh'' indicates to the
user that active energy is being measured, while with ''kVAh'' or ''kVArh'',
it indicates apparent energy and reactive energy, respectively. ''power''
can be combined in a similar way with various power units of measure: Distortion
power (''distortionVoltAmperes'') with ''kVA'' is different from ''power''
with ''kVA''.'
measuringPeriod:
slot_uri: cim:ReadingType.measuringPeriod
range: MeasuringPeriodKind
required: false
multivalued: false
description: "Time attribute inherent or fundamental to the reading value\
\ (as opposed to 'macroPeriod' that supplies an \"adjective\" to describe\
\ aspects of a time period with regard to the measurement). It refers to\
\ the way the value was originally measured and not to the frequency at\
\ which it is reported or presented. For example, an hourly interval of\
\ consumption data would have value 'hourly' as an attribute. However in\
\ the case of an hourly sampled voltage value, the meterReadings schema\
\ would carry the 'hourly' interval size information.\r\nIt is common for\
\ meters to report demand in a form that is measured over the course of\
\ a portion of an hour, while enterprise applications however commonly assume\
\ the demand (in kW or kVAr) normalised to 1 hour. The system that receives\
\ readings directly from the meter therefore shall perform this transformation\
\ before publishing readings for use by the other enterprise systems. The\
\ scalar used is chosen based on the block size (not any sub-interval size)."
multiplier:
slot_uri: cim:ReadingType.multiplier
range: UnitMultiplier
required: false
multivalued: false
description: Metering-specific multiplier.
phases:
slot_uri: cim:ReadingType.phases
range: PhaseCode
required: false
multivalued: false
description: Metering-specific phase code.
tou:
slot_uri: cim:ReadingType.tou
range: integer
required: false
multivalued: false
description: "Time of use (TOU) bucket the reading value is attributed to.\
\ Value 0 means not applicable.\r\n"
unit:
slot_uri: cim:ReadingType.unit
range: UnitSymbol
required: false
multivalued: false
description: Metering-specific unit.
Channel:
slot_uri: cim:ReadingType.Channel
range: Channel
required: false
multivalued: false
description: Channel reporting/collecting register values with this type information.
MeterReadSchedule:
slot_uri: cim:ReadingType.MeterReadSchedule
range: MeterReadSchedule
required: false
multivalued: false
description: Meter read schedule for which the reading type applies
ConsumptionTariffIntervals:
slot_uri: cim:ReadingType.ConsumptionTariffIntervals
range: ConsumptionTariffInterval
required: false
multivalued: true
description: All tariff intervals with consumption described by this reading
type.
PendingCalculation:
slot_uri: cim:ReadingType.PendingCalculation
range: PendingCalculation
required: false
multivalued: false
description: Pending calculation that produced this reading type.
IntervalBlocks:
slot_uri: cim:ReadingType.IntervalBlocks
range: IntervalBlock
required: false
multivalued: true
description: All blocks containing interval reading values with this type
information.
MetrologyRequirements:
slot_uri: cim:ReadingType.MetrologyRequirements
range: MetrologyRequirement
required: false
multivalued: true
description: All metrology requirements that require this reading type to
be collected.
Readings:
slot_uri: cim:ReadingType.Readings
range: Reading
required: false
multivalued: true
description: All reading values with this type information.
RationalNumber:
class_uri: cim:RationalNumber
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
description: "Rational number = 'numerator' / 'denominator'.\r\n"
attributes:
denominator:
slot_uri: cim:RationalNumber.denominator
range: integer
required: false
multivalued: false
description: "Denominator. Value 1 indicates the number is a simple integer.\r\
\n"
numerator:
slot_uri: cim:RationalNumber.numerator
range: integer
required: false
multivalued: false
description: "Numerator.\r\n"
ReadingInterharmonic:
class_uri: cim:ReadingInterharmonic
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
description: "Interharmonics are represented as a rational number 'numerator'\
\ / 'denominator', and harmonics are represented using the same mechanism and\
\ identified by 'denominator'=1.\r\n"
attributes:
denominator:
slot_uri: cim:ReadingInterharmonic.denominator
range: integer
required: false
multivalued: false
description: "Interharmonic denominator. Value 0 means not applicable. Value\
\ 2 is used in combination with 'numerator'=1 to represent interharmonic\
\ 1/2. Finally, value 1 indicates the harmonic of the order specified with\
\ 'numerator'.\r\n"
numerator:
slot_uri: cim:ReadingInterharmonic.numerator
range: integer
required: false
multivalued: false
description: "Interharmonic numerator. Value 0 means not applicable. Value\
\ 1 is used in combination with 'denominator'=2 to represent interharmonic\
\ 1/2, and with 'denominator'=1 it represents fundamental frequency. Finally,\
\ values greater than 1 indicate the harmonic of that order (e.g., 'numerator'=5\
\ is the fifth harmonic).\r\n"
PendingCalculation:
class_uri: cim:PendingCalculation
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
description: "When present, a scalar conversion that needs to be applied to every\
\ IntervalReading.value contained in IntervalBlock. This conversion results\
\ in a new associated ReadingType, reflecting the true dimensions of IntervalReading\
\ values after the conversion.\r\n"
attributes:
multiplyBeforeAdd:
slot_uri: cim:PendingCalculation.multiplyBeforeAdd
range: boolean
required: false
multivalued: false
description: Whether scalars should be applied before adding the 'offset'.
offset:
slot_uri: cim:PendingCalculation.offset
range: integer
required: false
multivalued: false
description: (if applicable) Offset to be added as well as multiplication
using scalars.
scalarDenominator:
slot_uri: cim:PendingCalculation.scalarDenominator
range: integer
required: false
multivalued: false
description: "(if scalar is rational number) When 'IntervalReading.value'\
\ is multiplied by 'scalarNumerator' and divided by this value, it causes\
\ a unit of measure conversion to occur, resulting in the 'ReadingType.unit'.\r\
\n"
scalarFloat:
slot_uri: cim:PendingCalculation.scalarFloat
range: float
required: false
multivalued: false
description: "(if scalar is floating number) When multiplied with 'IntervalReading.value',\
\ it causes a unit of measure conversion to occur, according to the 'ReadingType.unit'.\r\
\n"
scalarNumerator:
slot_uri: cim:PendingCalculation.scalarNumerator
range: integer
required: false
multivalued: false
description: (if scalar is integer or rational number) When the scalar is
a simple integer, and this attribute is presented alone and multiplied with
'IntervalReading.value', it causes a unit of measure conversion to occur,
resulting in the 'ReadingType.unit'. It is never used in conjunction with
'scalarFloat', only with 'scalarDenominator'.
ReadingType:
slot_uri: cim:PendingCalculation.ReadingType
range: ReadingType
required: true
multivalued: false
description: Reading type resulting from this pending conversion.
IntervalBlocks:
slot_uri: cim:PendingCalculation.IntervalBlocks
range: IntervalBlock
required: false
multivalued: true
description: All blocks of interval reading values to which this pending conversion
applies.
IntervalBlock:
class_uri: cim:IntervalBlock
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
description: "Time sequence of readings of the same reading type. Contained interval\
\ readings may need conversion through the application of an offset and a scalar\
\ defined in associated pending.\r\nTable 548 shows all association ends of\
\ IntervalBlock with other classes.\r\nTable 548 \u2013 Association ends of\
\ Metering::IntervalBlock with other classes\r\nAssociations\r\nname\r\nmult\
\ to\r\ntype\r\ndescription\r\n\r\n0..*\r\nPendingCalculation\r\n0..1\r\nPendingCalculation\r\
\nPending calculation to apply to interval reading values contained by this\
\ block (after which the resulting reading type is different than the original\
\ because it reflects the conversion result).\r\n\r\n0..*\r\nIntervalReadings\r\
\n0..*\r\nIntervalReading\r\nInterval reading contained in this block.\r\n\r\
\n0..*\r\nReadingType\r\n0..1\r\nReadingType\r\nType information for interval\
\ reading values contained in this block.\r\n\r\n0..*\r\nMeterReading\r\n0..1\r\
\nMeterReading\r\nMeter reading containing this interval block.\r\n\r\n\r\n\
IntervalReading\r\nData captured at regular intervals of time. Interval data\
\ could be captured as incremental data, absolute data, or relative data. The\
\ source for the data is usually a tariff quantity or an engineering quantity.\
\ Data is typically captured in time-tagged, uniform, fixed-length intervals\
\ of 5 min, 10 min, 15 min, 30 min, or 60 min.\r\nNote: Interval Data is sometimes\
\ also called \"Interval Data Readings\" (IDR)."
attributes:
MeterReading:
slot_uri: cim:IntervalBlock.MeterReading
range: MeterReading
required: false
multivalued: false
description: Meter reading containing this interval block.
IntervalReadings:
slot_uri: cim:IntervalBlock.IntervalReadings
range: IntervalReading
required: false
multivalued: true
description: Interval reading contained in this block.
ReadingType:
slot_uri: cim:IntervalBlock.ReadingType
range: ReadingType
required: false
multivalued: false
description: Type information for interval reading values contained in this
block.
PendingCalculation:
slot_uri: cim:IntervalBlock.PendingCalculation
range: PendingCalculation
required: false
multivalued: false
description: Pending calculation to apply to interval reading values contained
by this block (after which the resulting reading type is different than
the original because it reflects the conversion result).
MeterReading:
class_uri: cim:MeterReading
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
description: Set of values obtained from the meter.
attributes:
isCoincidentTrigger:
slot_uri: cim:MeterReading.isCoincidentTrigger
range: boolean
required: false
multivalued: false
description: "If true, this meter reading is the meter reading for which other\
\ coincident meter readings are requested or provided.\r\n"
valuesInterval:
slot_uri: cim:MeterReading.valuesInterval
range: DateTimeInterval
required: false
multivalued: false
description: Date and time interval of the data items contained within this
meter reading.
CustomerAgreement:
slot_uri: cim:MeterReading.CustomerAgreement
range: CustomerAgreement
required: false
multivalued: false
description: (could be deprecated in the future) Customer agreement for this
meter reading.
EndDeviceEvents:
slot_uri: cim:MeterReading.EndDeviceEvents
range: EndDeviceEvent
required: false
multivalued: true
description: All end device events associated with this set of measured values.
UsagePoint:
slot_uri: cim:MeterReading.UsagePoint
range: UsagePoint
required: false
multivalued: false
description: Usage point from which this meter reading (set of values) has
been obtained.
IntervalBlocks:
slot_uri: cim:MeterReading.IntervalBlocks
range: IntervalBlock
required: false
multivalued: true
description: All interval blocks contained in this meter reading.
Readings:
slot_uri: cim:MeterReading.Readings
range: Reading
required: false
multivalued: true
description: All reading values contained within this meter reading.
Meter:
slot_uri: cim:MeterReading.Meter
range: Meter
required: false
multivalued: false
description: Meter providing this reading.
Reading:
class_uri: cim:Reading
is_a: BaseReading
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
description: "Specific value measured by a meter or other asset, or calculated\
\ by a system. Each Reading is associated with a specific ReadingType.\r\n"
attributes:
position:
slot_uri: cim:Reading.position
range: integer
required: false
multivalued: false
description: A sequential value representing the relative position within
a given time interval.
reason:
slot_uri: cim:Reading.reason
range: ReadingReasonKind
required: false
multivalued: false
description: "Reason for this reading being taken.\r\n"
valueMissing:
slot_uri: cim:Reading.valueMissing
range: boolean
required: false
multivalued: false
description: The indication of whether or not the quantity of this reading
is missing.
MeterReadings:
slot_uri: cim:Reading.MeterReadings
range: MeterReading
required: false
multivalued: true
description: All meter readings (sets of values) containing this reading value.
ReadingType:
slot_uri: cim:Reading.ReadingType
range: ReadingType
required: true
multivalued: false
description: Type information for this reading value.
BaseReading:
class_uri: cim:BaseReading
is_a: MeasurementValue
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
description: "Common representation for reading values. Note that a reading value\
\ may have multiple qualities, as produced by various systems ('ReadingQuality.source').\r\
\n"
attributes:
reportedDateTime:
slot_uri: cim:BaseReading.reportedDateTime
range: date
required: false
multivalued: false
description: "(used only when there are detailed auditing requirements) Date\
\ and time at which the reading was first delivered to the metering system.\r\
\n"
source:
slot_uri: cim:BaseReading.source
range: string
required: false
multivalued: false
description: "System that originally supplied the reading (e.g., customer,\
\ AMI system, handheld reading system, another enterprise system, etc.).\r\
\n"
timePeriod:
slot_uri: cim:BaseReading.timePeriod
range: DateTimeInterval
required: false
multivalued: false
description: "Start and end of the period for those readings whose type has\
\ a time attribute such as 'billing', seasonal' or 'forTheSpecifiedPeriod'.\r\
\n"
value:
slot_uri: cim:BaseReading.value
range: string
required: false
multivalued: false
description: "Value of this reading.\r\n"
ReadingQualities:
slot_uri: cim:BaseReading.ReadingQualities
range: ReadingQuality
required: false
multivalued: true
description: All qualities of this reading.
ReadingQuality:
class_uri: cim:ReadingQuality
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
description: "Quality of a specific reading value or interval reading value. Note\
\ that more than one quality may be applicable to a given reading. Typically\
\ not used unless problems or unusual conditions occur (i.e., quality for each\
\ reading is assumed to be good unless stated otherwise in associated reading\
\ quality type). It can also be used with the corresponding reading quality\
\ type to indicate that the validation has been performed and succeeded.\r\n"
attributes:
comment:
slot_uri: cim:ReadingQuality.comment
range: string
required: false
multivalued: false
description: "Elaboration on the quality code.\r\n"
source:
slot_uri: cim:ReadingQuality.source
range: string
required: false
multivalued: false
description: "System acting as the source of the quality code.\r\n"
timeStamp:
slot_uri: cim:ReadingQuality.timeStamp
range: date
required: false
multivalued: false
description: "Date and time at which the quality code was assigned or ascertained.\r\
\n"
ReadingQualityType:
slot_uri: cim:ReadingQuality.ReadingQualityType
range: ReadingQualityType
required: true
multivalued: false
description: Type of this reading quality.
Reading:
slot_uri: cim:ReadingQuality.Reading
range: BaseReading
required: false
multivalued: false
description: Reading value to which this quality applies.
ReadingQualityType:
class_uri: cim:ReadingQualityType
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
description: 'Detailed description for a quality of a reading value, produced
by an end device or a system. Values in attributes allow for creation of the
recommended codes to be used for identifying reading value quality codes as
follows: ...'
attributes:
category:
slot_uri: cim:ReadingQualityType.category
range: string
required: false
multivalued: false
description: "High-level nature of the reading value quality.\r\n"
subCategory:
slot_uri: cim:ReadingQualityType.subCategory
range: string
required: false
multivalued: false
description: "More specific nature of the reading value quality, as a further\
\ sub-categorisation of 'category'.\r\n"
systemId:
slot_uri: cim:ReadingQualityType.systemId
range: string
required: false
multivalued: false
description: "Identification of the system which has declared the issue with\
\ the data or provided commentary on the data.\r\n"
ReadingQualities:
slot_uri: cim:ReadingQualityType.ReadingQualities
range: ReadingQuality
required: false
multivalued: true
description: All reading qualities of this type.
Meter:
class_uri: cim:Meter
is_a: EndDevice
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
description: "Physical asset that performs the metering role of the usage point.\
\ Used for measuring consumption and detection of events.\r\n"
attributes:
connectionCategory:
slot_uri: cim:Meter.connectionCategory
range: string
required: false
multivalued: false
description: A code used to specify the connection category, e.g. low voltage,
where the meter operates.
formNumber:
slot_uri: cim:Meter.formNumber
range: string
required: false
multivalued: false
description: "Meter form designation per ANSI C12.10 or other applicable standard.\
\ An alphanumeric designation denoting the circuit arrangement for which\
\ the meter is applicable and its specific terminal arrangement.\r\n"
MeterMultipliers:
slot_uri: cim:Meter.MeterMultipliers
range: MeterMultiplier
required: false
multivalued: true
description: All multipliers applied at this meter.
MeterReadings:
slot_uri: cim:Meter.MeterReadings
range: MeterReading
required: false
multivalued: true
description: All meter readings provided by this meter.
MeterReplacementWorkTasks:
slot_uri: cim:Meter.MeterReplacementWorkTasks
range: MeterWorkTask
required: false
multivalued: true
description: All work tasks on replacement of this old meter.
VendingTransactions:
slot_uri: cim:Meter.VendingTransactions
range: Transaction
required: false
multivalued: true
description: All vending transactions on this meter.
MeterServiceWorkTask:
slot_uri: cim:Meter.MeterServiceWorkTask
range: MeterWorkTask
required: false
multivalued: true
description: All non-replacement work tasks on this meter.
EndDevice:
class_uri: cim:EndDevice
is_a: AssetContainer
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
description: "Asset container that performs one or more end device functions.\
\ One type of end device is a meter which can perform metering, load management,\
\ connect/disconnect, accounting functions, etc. Some end devices, such as ones\
\ monitoring and controlling air conditioners, refrigerators, pool pumps may\
\ be connected to a meter. All end devices may have communication capability\
\ defined by the associated communication function(s). An end device may be\
\ owned by a consumer, a service provider, utility or otherwise.\r\nThere may\
\ be a related end device function that identifies a sensor or control point\
\ within a metering application or communications systems (e.g., water, gas,\
\ electricity).\r\nSome devices may use an optical port that conforms to the\
\ ANSI C12.18 standard for communications."
attributes:
amrSystem:
slot_uri: cim:EndDevice.amrSystem
range: string
required: false
multivalued: false
description: Automated meter reading (AMR) or other communication system responsible
for communications to this end device.
installCode:
slot_uri: cim:EndDevice.installCode
range: string
required: false
multivalued: false
description: "Installation code.\r\n"
isPan:
slot_uri: cim:EndDevice.isPan
range: boolean
required: false
multivalued: false
description: If true, this is a premises area network (PAN) device.
isSmartInverter:
slot_uri: cim:EndDevice.isSmartInverter
range: boolean
required: false
multivalued: false
description: If true, there is a communicating inverter present.
isVirtual:
slot_uri: cim:EndDevice.isVirtual
range: boolean
required: false
multivalued: false
description: "If true, there is no physical device. As an example, a virtual\
\ meter can be defined to aggregate the consumption for two or more physical\
\ meters. Otherwise, this is a physical hardware device.\r\n"
timeZoneOffset:
slot_uri: cim:EndDevice.timeZoneOffset
range: Minutes
required: false
multivalued: false
description: Time zone offset relative to GMT for the location of this end
device.
EndDeviceInfo:
slot_uri: cim:EndDevice.EndDeviceInfo
range: EndDeviceInfo
required: false
multivalued: false
description: End device data.
EndDeviceFunctions:
slot_uri: cim:EndDevice.EndDeviceFunctions
range: EndDeviceFunction
required: false
multivalued: true
description: All end device functions this end device performs.
EndDeviceEvents:
slot_uri: cim:EndDevice.EndDeviceEvents
range: EndDeviceEvent
required: false
multivalued: true
description: All events reported by this end device.
EndDeviceControls:
slot_uri: cim:EndDevice.EndDeviceControls
range: EndDeviceControl
required: false
multivalued: true
description: All end device controls sending commands to this end device.
UsagePoint:
slot_uri: cim:EndDevice.UsagePoint
range: UsagePoint
required: false
multivalued: false
description: Usage point to which this end device belongs.
Customer:
slot_uri: cim:EndDevice.Customer
range: Customer
required: false
multivalued: false
description: Customer owning this end device.
MeterReadSchedule:
slot_uri: cim:EndDevice.MeterReadSchedule
range: MeterReadSchedule
required: false
multivalued: false
description: Meter read schedule that applies to the end device
ServiceLocation:
slot_uri: cim:EndDevice.ServiceLocation
range: ServiceLocation
required: false
multivalued: false
description: Service location whose service delivery is measured by this end
device.
EndDeviceGroups:
slot_uri: cim:EndDevice.EndDeviceGroups
range: EndDeviceGroup
required: false
multivalued: true
description: All end device groups referring to this end device.
EndDeviceEvent:
class_uri: cim:EndDeviceEvent
is_a: ActivityRecord
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
description: Event detected by a device function associated with the end device.
attributes:
issuerID:
slot_uri: cim:EndDeviceEvent.issuerID
range: string
required: false
multivalued: false
description: "Unique identifier of the business entity originating an end\
\ device control.\r\n"
issuerTrackingID:
slot_uri: cim:EndDeviceEvent.issuerTrackingID
range: string
required: false
multivalued: false
description: "Identifier assigned by the initiator (e.g. retail electric provider)\
\ of an end device control action to uniquely identify the demand response\
\ event, text message, or other subject of the control action. Can be used\
\ when cancelling an event or text message request or to identify the originating\
\ event or text message in a consequential end device event.\r\n"
userID:
slot_uri: cim:EndDeviceEvent.userID
range: string
required: false
multivalued: false
description: (if user initiated) ID of user who initiated this end device
event.
EndDevice:
slot_uri: cim:EndDeviceEvent.EndDevice
range: EndDevice
required: false
multivalued: false
description: End device that reported this end device event.
EndDeviceEventDetails:
slot_uri: cim:EndDeviceEvent.EndDeviceEventDetails
range: EndDeviceEventDetail
required: false
multivalued: true
description: All details of this end device event.
EndDeviceEventType:
slot_uri: cim:EndDeviceEvent.EndDeviceEventType
range: EndDeviceEventType
required: true
multivalued: false
description: Type of this end device event.
UsagePoint:
slot_uri: cim:EndDeviceEvent.UsagePoint
range: UsagePoint
required: false
multivalued: false
description: Usage point for which this end device event is reported.
MeterReading:
slot_uri: cim:EndDeviceEvent.MeterReading
range: MeterReading
required: false
multivalued: false
description: Set of measured values to which this event applies.
EndDeviceEventDetail:
class_uri: cim:EndDeviceEventDetail
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
description: "Name-value pair, specific to end device events.\r\n"
attributes:
name:
slot_uri: cim:EndDeviceEventDetail.name
range: string
required: false
multivalued: false
description: "Name.\r\n"
value:
slot_uri: cim:EndDeviceEventDetail.value
range: StringQuantity
required: false
multivalued: false
description: "Value, including unit information.\r\n"
EndDeviceEvent:
slot_uri: cim:EndDeviceEventDetail.EndDeviceEvent
range: EndDeviceEvent
required: false
multivalued: false
description: End device owning this detail.
EndDeviceEventType:
class_uri: cim:EndDeviceEventType
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
description: 'Detailed description for an event produced by an end device. Values
in attributes allow for creation of recommended codes to be used for identifying
end device events as follows: ....'
attributes:
domain:
slot_uri: cim:EndDeviceEventType.domain
range: string
required: false
multivalued: false
description: "High-level nature of the event. By properly classifying events\
\ by a small set of domain codes, a system can more easily run reports based\
\ on the types of events that have occurred or been received.\r\n"
eventOrAction:
slot_uri: cim:EndDeviceEventType.eventOrAction
range: string
required: false
multivalued: false
description: "The most specific part of this event type. It is mainly in the\
\ form of a verb that gives action to the event that just occurred.\r\n"
subDomain:
slot_uri: cim:EndDeviceEventType.subDomain
range: string
required: false
multivalued: false
description: "More specific nature of the event, as a further sub-categorisation\
\ of 'domain'.\r\n"
type:
slot_uri: cim:EndDeviceEventType.type
range: string
required: false
multivalued: false
description: "Type of physical device from which the event was created. A\
\ value of zero (0) can be used when the source is unknown.\r\n"
EndDeviceEvents:
slot_uri: cim:EndDeviceEventType.EndDeviceEvents
range: EndDeviceEvent
required: false
multivalued: true
description: All end device events of this type.
EndDeviceControl:
class_uri: cim:EndDeviceControl
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
description: "Instructs an end device (or an end device group) to perform a specified\
\ action.\r\n"
attributes:
drProgramLevel:
slot_uri: cim:EndDeviceControl.drProgramLevel
range: integer
required: false
multivalued: false
description: 'Level of a demand response program request, where 0=emergency.
Note: Attribute is not defined on DemandResponseProgram as it is not its
inherent property (it serves to control it).'
drProgramMandatory:
slot_uri: cim:EndDeviceControl.drProgramMandatory
range: boolean
required: false
multivalued: false
description: 'Whether a demand response program request is mandatory. Note:
Attribute is not defined on DemandResponseProgram as it is not its inherent
property (it serves to control it).'
issuerID:
slot_uri: cim:EndDeviceControl.issuerID
range: string
required: false
multivalued: false
description: "Unique identifier of the business entity originating an end\
\ device control.\r\n"
issuerTrackingID:
slot_uri: cim:EndDeviceControl.issuerTrackingID
range: string
required: false
multivalued: false
description: "Identifier assigned by the initiator (e.g. retail electric provider)\
\ of an end device control action to uniquely identify the demand response\
\ event, text message, or other subject of the control action. Can be used\
\ when cancelling an event or text message request or to identify the originating\
\ event or text message in a consequential end device event.\r\n"
priceSignal:
slot_uri: cim:EndDeviceControl.priceSignal
range: float
required: false
multivalued: false
description: (if applicable) Price signal used as parameter for this end device
control.
primaryDeviceTiming:
slot_uri: cim:EndDeviceControl.primaryDeviceTiming
range: EndDeviceTiming
required: false
multivalued: false
description: "Timing for the control actions performed on the device identified\
\ in the end device control.\r\n"
reason:
slot_uri: cim:EndDeviceControl.reason
range: string
required: false
multivalued: false
description: Reason for the control action that allows to determine how to
continue processing. For example, disconnect meter command may require different
processing by the receiving system if it has been issued for a network-related
reason (protection) or for a payment-related reason.
scheduledInterval:
slot_uri: cim:EndDeviceControl.scheduledInterval
range: DateTimeInterval
required: false
multivalued: false
description: (if control has scheduled duration) Date and time interval the
control has been scheduled to execute within.
secondaryDeviceTiming:
slot_uri: cim:EndDeviceControl.secondaryDeviceTiming
range: EndDeviceTiming
required: false
multivalued: false
description: "Timing for the control actions performed by devices that are\
\ responding to event related information sent to the primary device indicated\
\ in the end device control. For example, load control actions performed\
\ by a PAN device in response to demand response event information sent\
\ to a PAN gateway server.\r\n"
EndDeviceAction:
slot_uri: cim:EndDeviceControl.EndDeviceAction
range: EndDeviceAction
required: false
multivalued: false
description: End device action issued by this end device control.
EndDevices:
slot_uri: cim:EndDeviceControl.EndDevices
range: EndDevice
required: false
multivalued: true
description: All end devices receiving commands from this end device control.
UsagePoints:
slot_uri: cim:EndDeviceControl.UsagePoints
range: UsagePoint
required: false
multivalued: true
description: All usage points receiving commands from this end device control.
UsagePointGroups:
slot_uri: cim:EndDeviceControl.UsagePointGroups
range: UsagePointGroup
required: false
multivalued: true
description: All usage point groups receiving commands from this end device
control.
EndDeviceControlType:
slot_uri: cim:EndDeviceControl.EndDeviceControlType
range: EndDeviceControlType
required: true
multivalued: false
description: Type of this end device control.
EndDeviceGroups:
slot_uri: cim:EndDeviceControl.EndDeviceGroups
range: EndDeviceGroup
required: false
multivalued: true
description: All end device groups receiving commands from this end device
control.
EndDeviceTiming:
class_uri: cim:EndDeviceTiming
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
description: "Timing for the control actions of end devices.\r\n"
attributes:
duration:
slot_uri: cim:EndDeviceTiming.duration
range: Minutes
required: false
multivalued: false
description: "Duration of the end device control action or the business event\
\ that is the subject of the end device control.\r\n"
durationIndefinite:
slot_uri: cim:EndDeviceTiming.durationIndefinite
range: boolean
required: false
multivalued: false
description: "True if 'duration' is indefinite.\r\n"
interval:
slot_uri: cim:EndDeviceTiming.interval
range: DateTimeInterval
required: false
multivalued: false
description: "Start and end time of an interval during which end device control\
\ actions are to be executed.\r\n"
randomisation:
slot_uri: cim:EndDeviceTiming.randomisation
range: RandomisationKind
required: false
multivalued: false
description: "Kind of randomisation to be applied to the end device control\
\ actions to be executed.\r\n"
EndDeviceGroup:
class_uri: cim:EndDeviceGroup
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
description: Abstraction for management of group communications within a two-way
AMR system or the data for a group of related end devices. Commands can be issued
to all of the end devices that belong to the group using a defined group address
and the underlying AMR communication infrastructure. A DERGroup and a PANDeviceGroup
is an EndDeviceGroup.
attributes:
status:
slot_uri: cim:EndDeviceGroup.status
range: Status
required: false
multivalued: false
description: Current status information relevant to a group.
type:
slot_uri: cim:EndDeviceGroup.type
range: string
required: false
multivalued: false
description: Type of this group.
version:
slot_uri: cim:EndDeviceGroup.version
range: Version
required: false
multivalued: false
description: version of this group
DERGroupDispatch:
slot_uri: cim:EndDeviceGroup.DERGroupDispatch
range: DERGroupDispatch
required: false
multivalued: true
description: An individual dispatch for a DER Group.
EndDeviceControls:
slot_uri: cim:EndDeviceGroup.EndDeviceControls
range: EndDeviceControl
required: false
multivalued: true
description: All end device controls sending commands to this end device group.
DERMonitorableParameter:
slot_uri: cim:EndDeviceGroup.DERMonitorableParameter
range: DERMonitorableParameter
required: false
multivalued: true
description: The DER monitorable parameters associated with a DER Group.
DER Function:
slot_uri: cim:EndDeviceGroup.DER%20Function
range: DERFunction
required: false
multivalued: true
description: The DER functions that are applied to the DER Group.
EndDevices:
slot_uri: cim:EndDeviceGroup.EndDevices
range: EndDevice
required: false
multivalued: true
description: All end devices this end device group refers to.
MeterReadSchedule:
slot_uri: cim:EndDeviceGroup.MeterReadSchedule
range: MeterReadSchedule
required: false
multivalued: false
description: Meter read schedule that applies to the end device group
DemandResponsePrograms:
slot_uri: cim:EndDeviceGroup.DemandResponsePrograms
range: DemandResponseProgram
required: false
multivalued: true
description: All demand response programs this group of end devices is enrolled
in.
DERFunction:
slot_uri: cim:EndDeviceGroup.DERFunction
range: DERFunction
required: false
multivalued: false
description: Functions supported by the DER Group
DERGroupForecast:
slot_uri: cim:EndDeviceGroup.DERGroupForecast
range: DERGroupForecast
required: true
multivalued: true
description: An individual forecast for a DER Group.
Version:
class_uri: cim:Version
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Common
description: This is the version for a group of devices or objects. This could
be used to track the version for any group of objects or devices over time.
For example, for a DERGroup, the requesting system may want to get the details
of a specific version of a DERGroup.
attributes:
date:
slot_uri: cim:Version.date
range: date
required: false
multivalued: false
description: date of this version
major:
slot_uri: cim:Version.major
range: integer
required: true
multivalued: false
description: major release level for this version
minor:
slot_uri: cim:Version.minor
range: integer
required: false
multivalued: false
description: minor release level for this version
revision:
slot_uri: cim:Version.revision
range: integer
required: false
multivalued: false
description: revision level for this version
DemandResponseProgram:
class_uri: cim:DemandResponseProgram
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
description: Demand response program.
attributes:
type:
slot_uri: cim:DemandResponseProgram.type
range: string
required: false
multivalued: false
description: Type of demand response program; examples are CPP (critical-peak
pricing), RTP (real-time pricing), DLC (direct load control), DBP (demand
bidding program), BIP (base interruptible program). Note that possible types
change a lot and it would be impossible to enumerate them all.
validityInterval:
slot_uri: cim:DemandResponseProgram.validityInterval
range: DateTimeInterval
required: false
multivalued: false
description: Interval within which the program is valid.
EndDeviceGroups:
slot_uri: cim:DemandResponseProgram.EndDeviceGroups
range: EndDeviceGroup
required: false
multivalued: true
description: All groups of end devices enrolled in this demand response program.
UsagePointGroups:
slot_uri: cim:DemandResponseProgram.UsagePointGroups
range: UsagePointGroup
required: false
multivalued: true
description: All usage point groups enrolled in this demand response program.
CustomerAgreements:
slot_uri: cim:DemandResponseProgram.CustomerAgreements
range: CustomerAgreement
required: false
multivalued: true
description: All customer agreements through which the customer is enrolled
in this demand response program.
UsagePointGroup:
class_uri: cim:UsagePointGroup
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
description: "Abstraction for management of group communications within a two-way\
\ AMR system or the data for a group of related usage points. Commands can be\
\ issued to all of the usage points that belong to a usage point group using\
\ a defined group address and the underlying AMR communication infrastructure.\
\ \r\n"
attributes:
type:
slot_uri: cim:UsagePointGroup.type
range: string
required: false
multivalued: false
description: Type of this group.
UsagePoints:
slot_uri: cim:UsagePointGroup.UsagePoints
range: UsagePoint
required: false
multivalued: true
description: All usage points in this group.
DemandResponsePrograms:
slot_uri: cim:UsagePointGroup.DemandResponsePrograms
range: DemandResponseProgram
required: false
multivalued: true
description: All demand response programs this usage point group is enrolled
in.
MeterReadSchedule:
slot_uri: cim:UsagePointGroup.MeterReadSchedule
range: MeterReadSchedule
required: false
multivalued: false
description: Meter read schedule that applies to the usage point group
EndDeviceControls:
slot_uri: cim:UsagePointGroup.EndDeviceControls
range: EndDeviceControl
required: false
multivalued: true
description: All end device controls sending commands to this usage point
group.
DERFunction:
class_uri: cim:DERFunction
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.DER
description: "Specifies the list of functions that are supported.\r\n\r\n"
attributes:
connectDisconnect:
slot_uri: cim:DERFunction.connectDisconnect
range: boolean
required: false
multivalued: false
description: If set to TRUE, the connect/disconnect function is supported.
frequencyWattCurveFunction:
slot_uri: cim:DERFunction.frequencyWattCurveFunction
range: boolean
required: false
multivalued: false
maxRealPowerLimiting:
slot_uri: cim:DERFunction.maxRealPowerLimiting
range: boolean
required: false
multivalued: false
description: "If set to TRUE, the maxRealPowerLimiting function is supported.\r\
\n"
rampRateControl:
slot_uri: cim:DERFunction.rampRateControl
range: boolean
required: false
multivalued: false
description: "If set to TRUE, the rampRateControl function is supported.\r\
\n"
reactivePowerDispatch:
slot_uri: cim:DERFunction.reactivePowerDispatch
range: boolean
required: false
multivalued: false
description: "If set to TRUE, the reactivePowerDispatch function is supported.\r\
\n"
realPowerDispatch:
slot_uri: cim:DERFunction.realPowerDispatch
range: boolean
required: false
multivalued: false
description: "If set to TRUE, the realPowerDispatch function is supported.\r\
\n"
voltageRegulation:
slot_uri: cim:DERFunction.voltageRegulation
range: boolean
required: false
multivalued: false
description: "If set to TRUE, the voltageRegulation function is supported.\r\
\n"
voltVarCurveFunction:
slot_uri: cim:DERFunction.voltVarCurveFunction
range: boolean
required: false
multivalued: false
description: "If set to TRUE, the voltVARCurveFunction is supported.\r\n"
voltWattCurveFunction:
slot_uri: cim:DERFunction.voltWattCurveFunction
range: boolean
required: false
multivalued: false
description: "If set to TRUE, the voltWattCurveFunction is supported.\r\n"
EndDeviceGroup:
slot_uri: cim:DERFunction.EndDeviceGroup
range: EndDeviceGroup
required: false
multivalued: false
description: The DER Group supporting the DER functions.
DERGroupForecast:
class_uri: cim:DERGroupForecast
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.DER
description: "Specifies the forecasted values of the DERMonitorableParameters\
\ for a DER Group over a specific time interval.\r\n\r\n"
attributes:
predictionCreationDate:
slot_uri: cim:DERGroupForecast.predictionCreationDate
range: date
required: false
multivalued: false
description: The timestamp for when the DER Group forecast was created
EndDeviceGroup:
slot_uri: cim:DERGroupForecast.EndDeviceGroup
range: EndDeviceGroup
required: true
multivalued: true
description: The DER Group for which forecasts are made.
DERGroupDispatch:
class_uri: cim:DERGroupDispatch
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.DER
description: "Specifies the capabilities of the DER Group that are to be dispatched\
\ according to a schedule. Each dispatch identifies a DER Group and the specific\
\ monitorable parameter to be dispatched over a specific time interval.\r\n\r\
\n"
attributes:
EndDeviceGroup:
slot_uri: cim:DERGroupDispatch.EndDeviceGroup
range: EndDeviceGroup
required: false
multivalued: true
description: The DER Group for which dispatches are made.
DERMonitorableParameter:
class_uri: cim:DERMonitorableParameter
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.DER
description: "To define the DER monitorable parameters that will be forecasted\
\ and dispatched for a DER Group. Each parameter is represented as a Y Value\
\ at a point in time or on a curve as a function of time, which is represented\
\ on the X axis.\r\n\r\n"
attributes:
DERParameter:
slot_uri: cim:DERMonitorableParameter.DERParameter
range: DERParameterKind
required: false
multivalued: false
description: Defines the specific engineering value being forecasted or dispatched.
flowDirection:
slot_uri: cim:DERMonitorableParameter.flowDirection
range: FlowDirectionKind
required: true
multivalued: false
description: Kind of flow direction for reading/measured values proper to
some commodities such as, for example, energy, power, demand.
yMultiplier:
slot_uri: cim:DERMonitorableParameter.yMultiplier
range: UnitMultiplier
required: false
multivalued: false
description: The UnitMultiplier that is applied to the DERMonitorableParameter.
yUnit:
slot_uri: cim:DERMonitorableParameter.yUnit
range: DERUnitSymbol
required: false
multivalued: false
description: The DERUnitSymbol that is applied to the DERMonitorableParameter
yUnitInstalledMax:
slot_uri: cim:DERMonitorableParameter.yUnitInstalledMax
range: float
required: false
multivalued: false
description: The maximum value of the DERMonitorableParameter based on the
installed capacity.
yUnitInstalledMin:
slot_uri: cim:DERMonitorableParameter.yUnitInstalledMin
range: float
required: false
multivalued: false
description: "The minimum value of the DERMonitorableParameter based on the\
\ installed capacity.\r\n"
DERCurveData:
slot_uri: cim:DERMonitorableParameter.DERCurveData
range: DERCurveData
required: false
multivalued: false
description: Specifies the time dependent curve for a DER monitorable parameter
EndDeviceGroup:
slot_uri: cim:DERMonitorableParameter.EndDeviceGroup
range: EndDeviceGroup
required: false
multivalued: true
description: The DER Group having DER monitorable parameters.
DispatchSchedule:
slot_uri: cim:DERMonitorableParameter.DispatchSchedule
range: DispatchSchedule
required: false
multivalued: true
description: The schedule used for dispatching or forecasting the values of
DER monitorable parameters over time.
DERCurveData:
class_uri: cim:DERCurveData
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.DER
description: "The DER curve data class provides the nominal, maximum and minimum\
\ values for a DER Monitorable parameter for a series of time intervals defined\
\ by the DER DispatchSchedule.\r\n"
attributes:
intervalNumber:
slot_uri: cim:DERCurveData.intervalNumber
range: integer
required: false
multivalued: false
description: The sequence number of a time interval defined by the DispatchSchedule.
maxYValue:
slot_uri: cim:DERCurveData.maxYValue
range: float
required: false
multivalued: false
description: The maximum value of the DERMonitorableParameter during the time
interval.
minYValue:
slot_uri: cim:DERCurveData.minYValue
range: float
required: false
multivalued: false
description: "The minimum value of the DERMonitorableParameter during the\
\ time interval.\r\n"
nominalYValue:
slot_uri: cim:DERCurveData.nominalYValue
range: float
required: false
multivalued: false
description: "The nominal value of the DERMonitorableParameter during the\
\ time interval.\r\n"
timeStamp:
slot_uri: cim:DERCurveData.timeStamp
range: date
required: false
multivalued: false
description: 'The start time of the interval '
DERMonitorableParameter:
slot_uri: cim:DERCurveData.DERMonitorableParameter
range: DERMonitorableParameter
required: true
multivalued: false
description: The DER monitorable parameter for which a time dependent curve
has been created.
DispatchSchedule:
slot_uri: cim:DERCurveData.DispatchSchedule
range: DispatchSchedule
required: false
multivalued: false
description: The schedule used for dispatching or forecasting the values of
DER monitorable parameters over time.
DispatchSchedule:
class_uri: cim:DispatchSchedule
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.DER
description: "Specifies the characteristics of the time schedule over which DERMonitorableParameters\
\ are dispatched.\r\n\r\n"
attributes:
confidence:
slot_uri: cim:DispatchSchedule.confidence
range: PerCent
required: false
multivalued: false
description: A value set by the system, function, algorithm or person creating
a prediction as to how accurate the prediction is.
curveStyleKind:
slot_uri: cim:DispatchSchedule.curveStyleKind
range: CurveStyle
required: false
multivalued: false
description: Used to specify whether the values over an interval are constant
(constantYValue) or linearly interpolated (straightLineYValues)
numberOfIntervals:
slot_uri: cim:DispatchSchedule.numberOfIntervals
range: integer
required: false
multivalued: false
description: Used to specify the number of intervals when requesting a forecast
or a dispatch.
startTime:
slot_uri: cim:DispatchSchedule.startTime
range: date
required: false
multivalued: false
description: The start time of the first interval in the dispatch schedule
timeIntervalDuration:
slot_uri: cim:DispatchSchedule.timeIntervalDuration
range: integer
required: true
multivalued: false
description: The length of time for each interval in the dispatch schedule.
timeIntervalUnit:
slot_uri: cim:DispatchSchedule.timeIntervalUnit
range: TimeIntervalKind
required: false
multivalued: false
description: The unit of measure for the time axis of the dispatch schedule.
DERMonitorableParameter:
slot_uri: cim:DispatchSchedule.DERMonitorableParameter
range: DERMonitorableParameter
required: true
multivalued: false
description: The DER monitorable parameter included in the DER dispatch schedule.
DERCurveData:
slot_uri: cim:DispatchSchedule.DERCurveData
range: DERCurveData
required: false
multivalued: true
description: Specifies the time dependent curve for a DER monitorable parameter
in the DER dispatch schedule.
EndDeviceAction:
class_uri: cim:EndDeviceAction
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
description: "Action/command performed by an end device on a device other than\
\ the end device.\r\n"
attributes:
command:
slot_uri: cim:EndDeviceAction.command
range: string
required: false
multivalued: false
description: "Command text.\r\n"
duration:
slot_uri: cim:EndDeviceAction.duration
range: Minutes
required: false
multivalued: false
description: "Amount of time the action of this control is to remain active.\r\
\n"
durationIndefinite:
slot_uri: cim:EndDeviceAction.durationIndefinite
range: boolean
required: false
multivalued: false
description: "True if the action of this control is indefinite.\r\n"
startDateTime:
slot_uri: cim:EndDeviceAction.startDateTime
range: date
required: false
multivalued: false
description: "Start date and time for action of this control.\r\n"
EndDeviceControl:
slot_uri: cim:EndDeviceAction.EndDeviceControl
range: EndDeviceControl
required: false
multivalued: false
description: End device control issuing this end device action.
EndDeviceControlType:
class_uri: cim:EndDeviceControlType
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
description: 'Detailed description for a control produced by an end device. Values
in attributes allow for creation of recommended codes to be used for identifying
end device controls as follows: ....'
attributes:
domain:
slot_uri: cim:EndDeviceControlType.domain
range: string
required: false
multivalued: false
description: "High-level nature of the control.\r\n"
eventOrAction:
slot_uri: cim:EndDeviceControlType.eventOrAction
range: string
required: false
multivalued: false
description: "The most specific part of this control type. It is mainly in\
\ the form of a verb that gives action to the control that just occurred.\r\
\n"
subDomain:
slot_uri: cim:EndDeviceControlType.subDomain
range: string
required: false
multivalued: false
description: "More specific nature of the control, as a further sub-categorisation\
\ of 'domain'.\r\n"
type:
slot_uri: cim:EndDeviceControlType.type
range: string
required: false
multivalued: false
description: "Type of physical device from which the control was created.\
\ A value of zero (0) can be used when the source is unknown.\r\n"
EndDeviceControls:
slot_uri: cim:EndDeviceControlType.EndDeviceControls
range: EndDeviceControl
required: false
multivalued: true
description: All end device controls of this type.
ServiceLocation:
class_uri: cim:ServiceLocation
is_a: WorkLocation
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Customers
description: A real estate location, commonly referred to as premises.
attributes:
accessMethod:
slot_uri: cim:ServiceLocation.accessMethod
range: string
required: false
multivalued: false
description: Method for the service person to access this service location.
For example, a description of where to obtain a key if the facility is unmanned
and secured.
needsInspection:
slot_uri: cim:ServiceLocation.needsInspection
range: boolean
required: false
multivalued: false
description: True if inspection is needed of facilities at this service location.
This could be requested by a customer, due to suspected tampering, environmental
concerns (e.g., a fire in the vicinity), or to correct incompatible data.
siteAccessProblem:
slot_uri: cim:ServiceLocation.siteAccessProblem
range: string
required: false
multivalued: false
description: "Problems previously encountered when visiting or performing\
\ work on this location. Examples include: bad dog, violent customer, verbally\
\ abusive occupant, obstructions, safety hazards, etc.\r\n"
Asset:
slot_uri: cim:ServiceLocation.Asset
range: Asset
required: false
multivalued: true
description: All assets that exist at the service location
TroubleTicket:
slot_uri: cim:ServiceLocation.TroubleTicket
range: TroubleTicket
required: false
multivalued: true
description: The ticket called in by the customer that describes the trouble
UsagePoints:
slot_uri: cim:ServiceLocation.UsagePoints
range: UsagePoint
required: false
multivalued: true
description: All usage points delivering service (of the same type) to this
service location.
EndDevices:
slot_uri: cim:ServiceLocation.EndDevices
range: EndDevice
required: false
multivalued: true
description: All end devices that measure the service delivered to this service
location.
ServiceRequest:
slot_uri: cim:ServiceLocation.ServiceRequest
range: ServiceRequest
required: false
multivalued: true
description: All service requests for the service location
CustomerAgreements:
slot_uri: cim:ServiceLocation.CustomerAgreements
range: CustomerAgreement
required: false
multivalued: true
description: All customer agreements regulating this service location.
ServiceRequest:
class_uri: cim:ServiceRequest
is_a: WorkRequest
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Customers
attributes:
appointmentRequested:
slot_uri: cim:ServiceRequest.appointmentRequested
range: boolean
required: true
multivalued: false
kind:
slot_uri: cim:ServiceRequest.kind
range: ServiceRequestKind
required: true
multivalued: false
serviceKind:
slot_uri: cim:ServiceRequest.serviceKind
range: ServiceKind
required: true
multivalued: false
serviceSize:
slot_uri: cim:ServiceRequest.serviceSize
range: string
required: true
multivalued: false
description: The size or quantity requested by the customer; for example,
200 AMPS for electrical service, 50 MBits per second for internet service,
etc.
WorkTimeSchedule:
slot_uri: cim:ServiceRequest.WorkTimeSchedule
range: WorkTimeSchedule
required: false
multivalued: true
description: All work time schedules associated with a service request
ServiceLocation:
slot_uri: cim:ServiceRequest.ServiceLocation
range: ServiceLocation
required: false
multivalued: false
description: The service location for the serivce request
Customer:
slot_uri: cim:ServiceRequest.Customer
range: Customer
required: false
multivalued: false
description: The customer making the service request
WorkRequest:
class_uri: cim:WorkRequest
is_a: Document
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Work
description: Document used to plan or initiate work
TroubleTicket:
class_uri: cim:TroubleTicket
is_a: Document
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Customers
attributes:
comment:
slot_uri: cim:TroubleTicket.comment
range: string
required: true
multivalued: false
description: Free-form comment associated with the trouble call for example,
"customer reported a large flash", etc.
dateTimeOfReport:
slot_uri: cim:TroubleTicket.dateTimeOfReport
range: date
required: false
multivalued: false
description: Date and time the trouble has been reported.
firstResponderStatus:
slot_uri: cim:TroubleTicket.firstResponderStatus
range: string
required: false
multivalued: false
description: Indicates whether the first responder such as police, fire department
etc.has been notified and whether they are on site or en route.
multiplePremises:
slot_uri: cim:TroubleTicket.multiplePremises
range: boolean
required: true
multivalued: false
description: Set to true if the outage report indicated that other neighbors
are also out of power.
reportingKind:
slot_uri: cim:TroubleTicket.reportingKind
range: TroubleReportingKind
required: false
multivalued: false
description: Indicates how the customer reported trouble.
resolvedDateTime:
slot_uri: cim:TroubleTicket.resolvedDateTime
range: date
required: false
multivalued: false
description: Date and time this trouble ticket has been resolved.
troubleCode:
slot_uri: cim:TroubleTicket.troubleCode
range: string
required: false
multivalued: false
description: Trouble code (e.g., power down, flickering lights, partial power,
etc).
Incident:
slot_uri: cim:TroubleTicket.Incident
range: Incident
required: false
multivalued: false
description: Incident reported in this trouble ticket
Location:
slot_uri: cim:TroubleTicket.Location
range: Location
required: false
multivalued: false
Customer:
slot_uri: cim:TroubleTicket.Customer
range: Customer
required: false
multivalued: false
description: Customer for whom this trouble ticket is relevant.
IncidentHazard:
slot_uri: cim:TroubleTicket.IncidentHazard
range: IncidentHazard
required: false
multivalued: true
description: All hazards reported with this trouble ticket.
TroubleSymptoms:
slot_uri: cim:TroubleTicket.TroubleSymptoms
range: TroubleSymptoms
required: false
multivalued: false
Notification:
slot_uri: cim:TroubleTicket.Notification
range: CustomerNotification
required: false
multivalued: true
description: Notification for this trouble ticket.
TroubleOrder:
slot_uri: cim:TroubleTicket.TroubleOrder
range: TroubleOrder
required: false
multivalued: false
description: The order to which one or more trouble tickets are associated.
ServiceLocation:
slot_uri: cim:TroubleTicket.ServiceLocation
range: ServiceLocation
required: true
multivalued: false
description: The service location to which one or more trouble tickets are
associated.
UnplannedOutage:
slot_uri: cim:TroubleTicket.UnplannedOutage
range: UnplannedOutage
required: false
multivalued: false
description: The unplanned outage to which one or more trouble tickets are
associated.
Hazard:
slot_uri: cim:TroubleTicket.Hazard
range: Hazard
required: false
multivalued: true
TroubleReporter:
slot_uri: cim:TroubleTicket.TroubleReporter
range: TroubleReporter
required: false
multivalued: false
TroubleSymptoms:
class_uri: cim:TroubleSymptoms
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Customers
description: Trouble symptoms reported by person reporting the trouble. The symptoms
provide clues to utility personnel analyzing the ticket to help identify the
root cause of the problem.
attributes:
troubleSymptomsExtent:
slot_uri: cim:TroubleSymptoms.troubleSymptomsExtent
range: TroubleSymptomsExtentKind
required: true
multivalued: false
description: The extent of the problem being reported.
troubleSymptomsExtentOther:
slot_uri: cim:TroubleSymptoms.troubleSymptomsExtentOther
range: string
required: true
multivalued: false
description: The extent of the problem being reported that does not fit any
of the enumeration values.
troubleSymptomsLight:
slot_uri: cim:TroubleSymptoms.troubleSymptomsLight
range: TroubleSymptomsLightKind
required: true
multivalued: false
description: The problem with lights being reported.
troubleSymptomsLightOther:
slot_uri: cim:TroubleSymptoms.troubleSymptomsLightOther
range: string
required: true
multivalued: false
description: The problem with lights being reported that does not fit any
of the enumeration values
troubleSymptomsPole:
slot_uri: cim:TroubleSymptoms.troubleSymptomsPole
range: TroubleSymptomsPoleKind
required: true
multivalued: false
description: "The problem with pole being reported.\r\n"
troubleSymptomsPoleOther:
slot_uri: cim:TroubleSymptoms.troubleSymptomsPoleOther
range: string
required: true
multivalued: false
description: The problem with pole being reported that does not fit any of
the enumeration values
troubleSymptomsTransformer:
slot_uri: cim:TroubleSymptoms.troubleSymptomsTransformer
range: TroubleSymptomsTransformerKind
required: true
multivalued: false
description: "The problem with transformer being reported.\r\n"
troubleSymptomsTransformerOther:
slot_uri: cim:TroubleSymptoms.troubleSymptomsTransformerOther
range: string
required: true
multivalued: false
description: The problem with transformer being reported that does not fit
any of the enumeration values
troubleSymptomsTree:
slot_uri: cim:TroubleSymptoms.troubleSymptomsTree
range: TroubleSymptomsTree Kind
required: true
multivalued: false
description: "The problem with tree being reported.\r\n"
troubleSymptomsTreeOther:
slot_uri: cim:TroubleSymptoms.troubleSymptomsTreeOther
range: string
required: true
multivalued: false
description: The problem with tree being reported that does not fit any of
the enumeration values
troubleSymptomsWire:
slot_uri: cim:TroubleSymptoms.troubleSymptomsWire
range: TroubleSymptomsWireKind
required: true
multivalued: false
description: "The problem with wire being reported.\r\n"
troubleSymptomsWireOther:
slot_uri: cim:TroubleSymptoms.troubleSymptomsWireOther
range: string
required: true
multivalued: false
description: The problem with wire being reported that does not fit any of
the enumeration values
TroubleTicket:
slot_uri: cim:TroubleSymptoms.TroubleTicket
range: TroubleTicket
required: false
multivalued: false
CustomerNotification:
class_uri: cim:CustomerNotification
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Customers
description: Conditions for notifying the customer about the changes in the status
of their service (e.g., outage restore, estimated restoration time, tariff or
service level change, etc.)
attributes:
contactType:
slot_uri: cim:CustomerNotification.contactType
range: string
required: false
multivalued: false
description: Type of contact (e.g., phone, email, etc.).
contactValue:
slot_uri: cim:CustomerNotification.contactValue
range: string
required: false
multivalued: false
description: Value of contact type (e.g., phone number, email address, etc.).
earliestDateTimeToCall:
slot_uri: cim:CustomerNotification.earliestDateTimeToCall
range: date
required: false
multivalued: false
description: Earliest date time to call the customer.
latestDateTimeToCall:
slot_uri: cim:CustomerNotification.latestDateTimeToCall
range: date
required: false
multivalued: false
description: Latest date time to call the customer.
trigger:
slot_uri: cim:CustomerNotification.trigger
range: NotificationTriggerKind
required: false
multivalued: false
description: Trigger for this notification.
Customer:
slot_uri: cim:CustomerNotification.Customer
range: Customer
required: false
multivalued: false
description: Customer requiring this notification.
TroubleTickets:
slot_uri: cim:CustomerNotification.TroubleTickets
range: TroubleTicket
required: false
multivalued: true
description: All trouble tickets with this notification.
Incident:
slot_uri: cim:CustomerNotification.Incident
range: Incident
required: false
multivalued: false
description: Incident as a subject of this customer notification.
UnplannedOutage:
class_uri: cim:UnplannedOutage
is_a: Outage
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Operations
description: "Document describing the consequence of an unplanned outage in a\
\ part of the electrical network. For the purposes of this model, an unplanned\
\ outage refers to a state where energy is not delivered; such as, customers\
\ out of service, a street light is not served, etc.\r\nA unplanned outage may\
\ be created upon:\r\n- impacts the SAIDI calculation\r\n- a breaker trip,\r\
\n- a fault indicator status change,\r\n- a meter event indicating customer\
\ outage,\r\n- a reception of one or more customer trouble calls, or\r\n- an\
\ operator command, reflecting information obtained from the field crew.\r\n\
Outage restoration may be performed using a switching plan which complements\
\ the outage information with detailed switching activities, including the relationship\
\ to the crew and work.\r\n"
attributes:
cause:
slot_uri: cim:UnplannedOutage.cause
range: string
required: false
multivalued: false
description: "The cause of this outage. This is the cause that is used to\
\ present to external entities. That is, the cause is weather, equipment\
\ failure, etc.\r\nNote: At present, this is a free string text; it could\
\ be replaced with an enumeration in the future."
causeKind:
slot_uri: cim:UnplannedOutage.causeKind
range: OutageCauseKind
required: false
multivalued: false
description: The possible cause that could be associated with this unplanned
outage.
reportedStartTime:
slot_uri: cim:UnplannedOutage.reportedStartTime
range: date
required: false
multivalued: false
description: The earliest start time of the Outage - as reported by some system
or individual
TroubleTicket:
slot_uri: cim:UnplannedOutage.TroubleTicket
range: TroubleTicket
required: false
multivalued: true
description: The ticket called in by the customer that describes the trouble
TroubleOrder:
slot_uri: cim:UnplannedOutage.TroubleOrder
range: TroubleOrder
required: false
multivalued: true
description: The trouble order that is associated to the unplanned outage.
FieldDispatchHistory:
slot_uri: cim:UnplannedOutage.FieldDispatchHistory
range: FieldDispatchHistory
required: false
multivalued: false
description: The dispatch history associated with the unplanned outage
Incident:
slot_uri: cim:UnplannedOutage.Incident
range: Incident
required: false
multivalued: true
description: The incidents that are associated with the unplanned outage
Hazard:
class_uri: cim:Hazard
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Common
description: An object or a condition that is a danger for causing loss or perils
to an asset and/or people.
attributes:
status:
slot_uri: cim:Hazard.status
range: Status
required: false
multivalued: false
description: Status of this hazard.
type:
slot_uri: cim:Hazard.type
range: string
required: false
multivalued: false
description: Type of this hazard.
TroubleTicket:
slot_uri: cim:Hazard.TroubleTicket
range: TroubleTicket
required: false
multivalued: false
Incident:
slot_uri: cim:Hazard.Incident
range: Incident
required: false
multivalued: false
TroubleReporter:
class_uri: cim:TroubleReporter
is_a: OperationPersonRole
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Common
description: Type of Person reporting the Trouble - Customer, First Responder,
Passer-by, etc.
attributes:
troubleReporterType:
slot_uri: cim:TroubleReporter.troubleReporterType
range: string
required: true
multivalued: false
description: The type of person reporting the trouble
TroubleTicket:
slot_uri: cim:TroubleReporter.TroubleTicket
range: TroubleTicket
required: false
multivalued: true
IncidentHazard:
class_uri: cim:IncidentHazard
is_a: Hazard
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Customers
description: Hazardous situation associated with an incident. Examples are line
down, gas leak, fire, etc.
attributes:
Incident:
slot_uri: cim:IncidentHazard.Incident
range: Incident
required: false
multivalued: false
description: Incident associated with this hazard.
TroubleTicket:
slot_uri: cim:IncidentHazard.TroubleTicket
range: TroubleTicket
required: false
multivalued: false
description: Trouble ticket associated with this hazard.
EndDeviceInfo:
class_uri: cim:EndDeviceInfo
is_a: AssetInfo
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
description: "End device data.\r\n"
attributes:
capability:
slot_uri: cim:EndDeviceInfo.capability
range: EndDeviceCapability
required: false
multivalued: false
description: "Inherent capabilities of the device (i.e., the functions it\
\ supports).\r\n"
isSolidState:
slot_uri: cim:EndDeviceInfo.isSolidState
range: boolean
required: false
multivalued: false
description: "If true, this is a solid state end device (as opposed to a mechanical\
\ or electromechanical device).\r\n"
phaseCount:
slot_uri: cim:EndDeviceInfo.phaseCount
range: integer
required: false
multivalued: false
description: "Number of potential phases the end device supports, typically\
\ 0, 1 or 3.\r\n"
ratedCurrent:
slot_uri: cim:EndDeviceInfo.ratedCurrent
range: CurrentFlow
required: false
multivalued: false
description: Rated current.
ratedVoltage:
slot_uri: cim:EndDeviceInfo.ratedVoltage
range: Voltage
required: false
multivalued: false
description: Rated voltage.
EndDevices:
slot_uri: cim:EndDeviceInfo.EndDevices
range: EndDevice
required: false
multivalued: true
description: All end devices described with this data.
EndDeviceCapability:
class_uri: cim:EndDeviceCapability
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
description: "Inherent capabilities of an end device (i.e., the functions it supports).\r\
\n"
attributes:
autonomousDst:
slot_uri: cim:EndDeviceCapability.autonomousDst
range: boolean
required: false
multivalued: false
description: "True if autonomous DST (daylight saving time) function is supported.\r\
\n"
communication:
slot_uri: cim:EndDeviceCapability.communication
range: boolean
required: false
multivalued: false
description: "True if communication function is supported.\r\n"
connectDisconnect:
slot_uri: cim:EndDeviceCapability.connectDisconnect
range: boolean
required: false
multivalued: false
description: "True if connect and disconnect function is supported.\r\n"
demandResponse:
slot_uri: cim:EndDeviceCapability.demandResponse
range: boolean
required: false
multivalued: false
description: "True if demand response function is supported.\r\n"
electricMetering:
slot_uri: cim:EndDeviceCapability.electricMetering
range: boolean
required: false
multivalued: false
description: "True if electric metering function is supported.\r\n"
gasMetering:
slot_uri: cim:EndDeviceCapability.gasMetering
range: boolean
required: false
multivalued: false
description: "True if gas metering function is supported.\r\n"
metrology:
slot_uri: cim:EndDeviceCapability.metrology
range: boolean
required: false
multivalued: false
description: "True if metrology function is supported.\r\n"
onRequestRead:
slot_uri: cim:EndDeviceCapability.onRequestRead
range: boolean
required: false
multivalued: false
description: "True if on request read function is supported.\r\n"
outageHistory:
slot_uri: cim:EndDeviceCapability.outageHistory
range: boolean
required: false
multivalued: false
description: "True if outage history function is supported.\r\n"
pressureCompensation:
slot_uri: cim:EndDeviceCapability.pressureCompensation
range: boolean
required: false
multivalued: false
description: "True if device performs pressure compensation for metered quantities.\r\
\n"
pricingInfo:
slot_uri: cim:EndDeviceCapability.pricingInfo
range: boolean
required: false
multivalued: false
description: "True if pricing information is supported.\r\n"
pulseOutput:
slot_uri: cim:EndDeviceCapability.pulseOutput
range: boolean
required: false
multivalued: false
description: "True if device produces pulse outputs.\r\n"
relaysProgramming:
slot_uri: cim:EndDeviceCapability.relaysProgramming
range: boolean
required: false
multivalued: false
description: "True if relays programming function is supported.\r\n"
reverseFlow:
slot_uri: cim:EndDeviceCapability.reverseFlow
range: boolean
required: false
multivalued: false
description: "True if reverse flow function is supported.\r\n"
superCompressibilityCompensation:
slot_uri: cim:EndDeviceCapability.superCompressibilityCompensation
range: boolean
required: false
multivalued: false
description: "True if device performs super compressibility compensation for\
\ metered quantities.\r\n"
temperatureCompensation:
slot_uri: cim:EndDeviceCapability.temperatureCompensation
range: boolean
required: false
multivalued: false
description: "True if device performs temperature compensation for metered\
\ quantities.\r\n"
textMessage:
slot_uri: cim:EndDeviceCapability.textMessage
range: boolean
required: false
multivalued: false
description: "True if the displaying of text messages is supported.\r\n"
waterMetering:
slot_uri: cim:EndDeviceCapability.waterMetering
range: boolean
required: false
multivalued: false
description: "True if water metering function is supported.\r\n"
EndDeviceFunction:
class_uri: cim:EndDeviceFunction
is_a: AssetFunction
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
description: "Function performed by an end device such as a meter, communication\
\ equipment, controllers, etc.\r\n"
attributes:
enabled:
slot_uri: cim:EndDeviceFunction.enabled
range: boolean
required: false
multivalued: false
description: "True if the function is enabled.\r\n"
EndDevice:
slot_uri: cim:EndDeviceFunction.EndDevice
range: EndDevice
required: false
multivalued: false
description: End device that performs this function.
Registers:
slot_uri: cim:EndDeviceFunction.Registers
range: Register
required: false
multivalued: true
description: All registers for quantities metered by this end device function.
AssetFunction:
class_uri: cim:AssetFunction
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: "Function performed by an asset.\r\n"
attributes:
configID:
slot_uri: cim:AssetFunction.configID
range: string
required: false
multivalued: false
description: Configuration specified for this function.
firmwareID:
slot_uri: cim:AssetFunction.firmwareID
range: string
required: false
multivalued: false
description: Firmware version.
hardwareID:
slot_uri: cim:AssetFunction.hardwareID
range: string
required: false
multivalued: false
description: Hardware version.
password:
slot_uri: cim:AssetFunction.password
range: string
required: false
multivalued: false
description: Password needed to access this function.
programID:
slot_uri: cim:AssetFunction.programID
range: string
required: false
multivalued: false
description: Name of program.
Asset:
slot_uri: cim:AssetFunction.Asset
range: Asset
required: false
multivalued: false
description: Asset on which this function can be performed.
Register:
class_uri: cim:Register
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
description: "A device that indicates or records units of the commodity or other\
\ quantity measured.\r\n"
attributes:
isVirtual:
slot_uri: cim:Register.isVirtual
range: boolean
required: false
multivalued: false
description: "If true, the data it produces is calculated or measured by\
\ a device other than a physical end device/meter. Otherwise, any data streams\
\ it produces are measured by the hardware of the end device/meter itself.\
\ \r\n"
leftDigitCount:
slot_uri: cim:Register.leftDigitCount
range: integer
required: false
multivalued: false
description: "Number of digits (dials on a mechanical meter) to the left of\
\ the decimal place; default is normally 5.\r\n"
rightDigitCount:
slot_uri: cim:Register.rightDigitCount
range: integer
required: false
multivalued: false
description: Number of digits (dials on a mechanical meter) to the right of
the decimal place.
touTier:
slot_uri: cim:Register.touTier
range: TimeInterval
required: false
multivalued: false
description: Clock time interval for register to beging/cease accumulating
time of usage (e.g., start at 8:00 am, stop at 5:00 pm).
touTierName:
slot_uri: cim:Register.touTierName
range: string
required: false
multivalued: false
description: "Name used for the time of use tier (also known as bin or bucket).\
\ For example, \"peak\", \"off-peak\", \"TOU Category A\", etc. \r\n"
Channels:
slot_uri: cim:Register.Channels
range: Channel
required: false
multivalued: true
description: All channels that collect/report values from this register.
EndDeviceFunction:
slot_uri: cim:Register.EndDeviceFunction
range: EndDeviceFunction
required: false
multivalued: false
description: End device function metering quantities displayed by this register.
Usage Point:
slot_uri: cim:Register.Usage%20Point
range: UsagePoint
required: false
multivalued: false
description: Usage Point, when metered, has these registers.
Channel:
class_uri: cim:Channel
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
description: "A single path for the collection or reporting of register values\
\ over a period of time. For example, a register which measures forward energy\
\ can have two channels, one providing bulk quantity readings and the other\
\ providing interval readings of a fixed interval size.\r\n"
attributes:
isVirtual:
slot_uri: cim:Channel.isVirtual
range: boolean
required: false
multivalued: false
description: "If true, the data is being calculated by an enterprise system\
\ rather than metered directly.\r\n"
Register:
slot_uri: cim:Channel.Register
range: Register
required: false
multivalued: false
description: Register whose values are collected/reported by this channel.
ReadingType:
slot_uri: cim:Channel.ReadingType
range: ReadingType
required: false
multivalued: false
description: Reading type for register values reported/collected by this channel.
MeterWorkTask:
class_uri: cim:MeterWorkTask
is_a: WorkTask
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
description: Work task involving meters.
attributes:
OldMeter:
slot_uri: cim:MeterWorkTask.OldMeter
range: Meter
required: false
multivalued: false
description: Old meter replaced by this work task.
UsagePoint:
slot_uri: cim:MeterWorkTask.UsagePoint
range: UsagePoint
required: false
multivalued: false
description: Usage point to which this meter service work task applies.
Meter:
slot_uri: cim:MeterWorkTask.Meter
range: Meter
required: false
multivalued: false
description: Meter on which this non-replacement work task is performed.
MeterMultiplier:
class_uri: cim:MeterMultiplier
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
description: "Multiplier applied at the meter.\r\n"
attributes:
kind:
slot_uri: cim:MeterMultiplier.kind
range: MeterMultiplierKind
required: false
multivalued: false
description: "Kind of multiplier.\r\n"
value:
slot_uri: cim:MeterMultiplier.value
range: float
required: false
multivalued: false
description: "Multiplier value.\r\n"
Meter:
slot_uri: cim:MeterMultiplier.Meter
range: Meter
required: false
multivalued: false
description: Meter applying this multiplier.
IntervalReading:
class_uri: cim:IntervalReading
is_a: BaseReading
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
description: "Data captured at regular intervals of time. Interval data could\
\ be captured as incremental data, absolute data, or relative data. The source\
\ for the data is usually a tariff quantity or an engineering quantity. Data\
\ is typically captured in time-tagged, uniform, fixed-length intervals of 5\
\ min, 10 min, 15 min, 30 min, or 60 min.\r\nNote: Interval Data is sometimes\
\ also called \"Interval Data Readings\" (IDR)."
attributes:
IntervalBlocks:
slot_uri: cim:IntervalReading.IntervalBlocks
range: IntervalBlock
required: false
multivalued: true
description: All blocks containing this interval reading.
MetrologyRequirement:
class_uri: cim:MetrologyRequirement
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
description: "A specification of the metering requirements for a particular point\
\ within a network.\r\n"
attributes:
reason:
slot_uri: cim:MetrologyRequirement.reason
range: ReadingReasonKind
required: false
multivalued: false
description: "Reason for this metrology requirement being specified.\r\n"
UsagePoints:
slot_uri: cim:MetrologyRequirement.UsagePoints
range: UsagePoint
required: false
multivalued: true
description: All usage points having this metrology requirement.
ReadingTypes:
slot_uri: cim:MetrologyRequirement.ReadingTypes
range: ReadingType
required: true
multivalued: true
description: All reading types required to be collected by this metrology
requirement.
OperationalUpdatedRating:
class_uri: cim:OperationalUpdatedRating
is_a: OperationalRestriction
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Operations
description: Lowered capability because of deterioration or inadequacy (sometimes
referred to as derating or partial outage) or other kind of operational rating
change.
attributes:
changeType:
slot_uri: cim:OperationalUpdatedRating.changeType
range: string
required: false
multivalued: false
description: Type of operational updated rating, e.g. a derate, a rerate or
a return to normal.
PlannedOutage:
slot_uri: cim:OperationalUpdatedRating.PlannedOutage
range: PlannedOutage
required: true
multivalued: false
description: Planned equipment outage with this updated rating.
OutagePlan:
class_uri: cim:OutagePlan
is_a: Document
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Operations
description: Document containing the definition of planned outages of equipment
and/or usage points. It will reference switching plans that are used to execute
the planned outage.
attributes:
approvedDateTime:
slot_uri: cim:OutagePlan.approvedDateTime
range: date
required: false
multivalued: false
description: The date and time the outage plan was approved
cancelledDateTime:
slot_uri: cim:OutagePlan.cancelledDateTime
range: date
required: false
multivalued: false
description: Date and Time the planned outage was canceled.
plannedPeriod:
slot_uri: cim:OutagePlan.plannedPeriod
range: DateTimeInterval
required: false
multivalued: false
description: planned start and end time of the planned outage.
purpose:
slot_uri: cim:OutagePlan.purpose
range: string
required: false
multivalued: false
description: Purpose of this outage plan, such as whether it is to replace
equipment or perform maintenance or repairs or to reconfigure network topology.
OutageOrder:
slot_uri: cim:OutagePlan.OutageOrder
range: OutageOrder
required: false
multivalued: false
description: The outage order that will address the outage plan.
PlannedOutage:
slot_uri: cim:OutagePlan.PlannedOutage
range: PlannedOutage
required: false
multivalued: false
description: The outage resulting from the execution of the outage plan.
SwitchingPlan:
slot_uri: cim:OutagePlan.SwitchingPlan
range: SwitchingPlan
required: false
multivalued: false
description: The swiching plan that is associated with the outage plan.
Customer:
slot_uri: cim:OutagePlan.Customer
range: Customer
required: false
multivalued: true
description: The customers that are affected by this planned outage.
OutageOrder:
class_uri: cim:OutageOrder
is_a: Document
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Operations
description: Transmits an outage plan to a crew in order for the planned outage
to be executed.
attributes:
comment:
slot_uri: cim:OutageOrder.comment
range: string
required: false
multivalued: false
description: Free-form comment associated with the outage order
Location:
slot_uri: cim:OutageOrder.Location
range: Location
required: false
multivalued: true
description: Location of this outage order.
OutagePlan:
slot_uri: cim:OutageOrder.OutagePlan
range: OutagePlan
required: false
multivalued: false
description: The outage plan that is defined to address the outage order.
WorkAsset:
class_uri: cim:WorkAsset
is_a: Asset
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Work
description: Asset used to perform work.
attributes:
Crew:
slot_uri: cim:WorkAsset.Crew
range: Crew
required: false
multivalued: false
description: Crew using this work asset.
CUWorkEquipmentAsset:
slot_uri: cim:WorkAsset.CUWorkEquipmentAsset
range: CUWorkEquipmentItem
required: false
multivalued: false
CUWorkEquipmentItem:
class_uri: cim:CUWorkEquipmentItem
is_a: WorkIdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfWork
description: Compatible unit for various types of WorkEquipmentAssets, including
vehicles.
attributes:
equipCode:
slot_uri: cim:CUWorkEquipmentItem.equipCode
range: string
required: false
multivalued: false
description: The equipment type code.
rate:
slot_uri: cim:CUWorkEquipmentItem.rate
range: CostRate
required: false
multivalued: false
description: Standard usage rate for the type of vehicle.
status:
slot_uri: cim:CUWorkEquipmentItem.status
range: Status
required: false
multivalued: false
CompatibleUnits:
slot_uri: cim:CUWorkEquipmentItem.CompatibleUnits
range: CompatibleUnit
required: false
multivalued: true
TypeAsset:
slot_uri: cim:CUWorkEquipmentItem.TypeAsset
range: WorkAsset
required: false
multivalued: false
CrewType:
class_uri: cim:CrewType
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Common
description: Custom description of the type of crew. This may be used to determine
the type of work the crew can be assigned to. Examples include repair, tree
trimming, switching, etc.
attributes:
Crews:
slot_uri: cim:CrewType.Crews
range: Crew
required: false
multivalued: true
description: All crews of this type.
CrewMember:
class_uri: cim:CrewMember
is_a: OperationPersonRole
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Common
description: Member of a crew.
attributes:
Crew:
slot_uri: cim:CrewMember.Crew
range: Crew
required: false
multivalued: false
description: Crew to which this crew member belongs.
SwitchingEvent:
class_uri: cim:SwitchingEvent
is_a: ActivityRecord
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Operations
description: 'Event indicating the completion (success or fail) of any switching
action (jumper action, cut action, tag action, etc). The switching action may
or may not be a consequential event in response to a request to complete the
action. '
attributes:
SwitchingAction:
slot_uri: cim:SwitchingEvent.SwitchingAction
range: SwitchingAction
required: true
multivalued: false
description: The switching action that is performed on the switching event
Clamp:
class_uri: cim:Clamp
is_a: ConductingEquipment
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: "A Clamp is a galvanic connection at a line segment where other equipment\
\ is connected. A Clamp does not cut the line segment. \r\nA Clamp is ConductingEquipment\
\ and has one Terminal with an associated ConnectivityNode. Any other ConductingEquipment\
\ can be connected to the Clamp ConnectivityNode.\r\n"
attributes:
lengthFromTerminal1:
slot_uri: cim:Clamp.lengthFromTerminal1
range: Length
required: false
multivalued: false
description: "The length to the place where the clamp is located starting\
\ from side one of the line segment, i.e. the line segment terminal with\
\ sequence number equal to 1.\r\n"
JumperAction:
slot_uri: cim:Clamp.JumperAction
range: JumperAction
required: false
multivalued: false
description: Action taken with this jumper.
ClampAction:
slot_uri: cim:Clamp.ClampAction
range: ClampAction
required: false
multivalued: false
description: The clamp action that is performed on the clamp
ACLineSegment:
slot_uri: cim:Clamp.ACLineSegment
range: ACLineSegment
required: true
multivalued: false
description: The line segment to which the clamp is connected.
ACLineSegment:
class_uri: cim:ACLineSegment
is_a: Conductor
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: "A wire or combination of wires, with consistent electrical characteristics,\
\ building a single electrical system, used to carry alternating current between\
\ points in the power system.\r\nFor symmetrical, transposed three phase lines,\
\ it is sufficient to use attributes of the line segment, which describe impedances\
\ and admittances for the entire length of the segment. Additionally impedances\
\ can be computed by using length and associated per length impedances.\r\n\
The BaseVoltage at the two ends of ACLineSegments in a Line shall have the same\
\ BaseVoltage.nominalVoltage. However, boundary lines may have slightly different\
\ BaseVoltage.nominalVoltages and variation is allowed. Larger voltage difference\
\ in general requires use of an equivalent branch."
attributes:
b0ch:
slot_uri: cim:ACLineSegment.b0ch
range: Susceptance
required: false
multivalued: false
description: Zero sequence shunt (charging) susceptance, uniformly distributed,
of the entire line section.
bch:
slot_uri: cim:ACLineSegment.bch
range: Susceptance
required: false
multivalued: false
description: Positive sequence shunt (charging) susceptance, uniformly distributed,
of the entire line section. This value represents the full charging over
the full length of the line.
g0ch:
slot_uri: cim:ACLineSegment.g0ch
range: Conductance
required: false
multivalued: false
description: Zero sequence shunt (charging) conductance, uniformly distributed,
of the entire line section.
gch:
slot_uri: cim:ACLineSegment.gch
range: Conductance
required: false
multivalued: false
description: Positive sequence shunt (charging) conductance, uniformly distributed,
of the entire line section.
r:
slot_uri: cim:ACLineSegment.r
range: Resistance
required: false
multivalued: false
description: Positive sequence series resistance of the entire line section.
r0:
slot_uri: cim:ACLineSegment.r0
range: Resistance
required: false
multivalued: false
description: Zero sequence series resistance of the entire line section.
shortCircuitEndTemperature:
slot_uri: cim:ACLineSegment.shortCircuitEndTemperature
range: Temperature
required: false
multivalued: false
description: Maximum permitted temperature at the end of SC for the calculation
of minimum short-circuit currents. Used for short circuit data exchange
according to IEC 60909.
x:
slot_uri: cim:ACLineSegment.x
range: Reactance
required: false
multivalued: false
description: Positive sequence series reactance of the entire line section.
x0:
slot_uri: cim:ACLineSegment.x0
range: Reactance
required: false
multivalued: false
description: Zero sequence series reactance of the entire line section.
Clamp:
slot_uri: cim:ACLineSegment.Clamp
range: Clamp
required: false
multivalued: true
description: The clamps connected to the line segment.
WireSpacingInfo:
slot_uri: cim:ACLineSegment.WireSpacingInfo
range: WireSpacingInfo
required: false
multivalued: false
description: The wire spacing information that applies to this AC line segment
PerLengthImpedance:
slot_uri: cim:ACLineSegment.PerLengthImpedance
range: PerLengthImpedance
required: false
multivalued: false
description: Per-length impedance of this line segment.
Cut:
slot_uri: cim:ACLineSegment.Cut
range: Cut
required: false
multivalued: true
description: Cuts applied to the line segment.
LineFaults:
slot_uri: cim:ACLineSegment.LineFaults
range: LineFault
required: false
multivalued: true
description: The line faults of the line segment.
ACLineSegmentPhases:
slot_uri: cim:ACLineSegment.ACLineSegmentPhases
range: ACLineSegmentPhase
required: false
multivalued: true
description: The line segment phases which belong to the line segment.
LineGroundingAction:
slot_uri: cim:ACLineSegment.LineGroundingAction
range: GroundAction
required: false
multivalued: false
description: Ground action involving clamp usage (for the case when the ground
is applied along the line segment instead of at its terminals).
LineJumpingAction:
slot_uri: cim:ACLineSegment.LineJumpingAction
range: JumperAction
required: false
multivalued: false
description: Jumper action involving clamp usage (for the case when the jumper
is applied along the line segment instead of at its terminals).
Conductor:
class_uri: cim:Conductor
is_a: ConductingEquipment
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: 'Combination of conducting material with consistent electrical characteristics,
building a single electrical system, used to carry current between points in
the power system. '
attributes:
length:
slot_uri: cim:Conductor.length
range: Length
required: false
multivalued: false
description: Segment length for calculating line section capabilities.
PerLengthImpedance:
class_uri: cim:PerLengthImpedance
is_a: PerLengthLineParameter
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: "Common type for per-length impedance electrical catalogues.\r\n"
attributes:
ACLineSegments:
slot_uri: cim:PerLengthImpedance.ACLineSegments
range: ACLineSegment
required: false
multivalued: true
description: All line segments described by this per-length impedance.
PerLengthLineParameter:
class_uri: cim:PerLengthLineParameter
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: Common type for per-length electrical catalogues describing line
parameters.
attributes:
WireAssemblyInfo:
slot_uri: cim:PerLengthLineParameter.WireAssemblyInfo
range: WireAssemblyInfo
required: false
multivalued: false
WireAssemblyInfo:
class_uri: cim:WireAssemblyInfo
is_a: AssetInfo
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetInfo
description: Describes the construction of a multi-conductor wire.
attributes:
PerLengthLineParameter:
slot_uri: cim:WireAssemblyInfo.PerLengthLineParameter
range: PerLengthLineParameter
required: false
multivalued: true
description: Per length line parameter associated with this wire assembly.
WirePhaseInfo:
slot_uri: cim:WireAssemblyInfo.WirePhaseInfo
range: WirePhaseInfo
required: false
multivalued: true
description: Wire phase information associated with this wire assembly.
WirePhaseInfo:
class_uri: cim:WirePhaseInfo
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetInfo
description: Information on a wire carrying a single phase.
attributes:
phaseInfo:
slot_uri: cim:WirePhaseInfo.phaseInfo
range: SinglePhaseKind
required: false
multivalued: false
description: Phase information.
WireAssemblyInfo:
slot_uri: cim:WirePhaseInfo.WireAssemblyInfo
range: WireAssemblyInfo
required: true
multivalued: false
description: Wire assembly information using this wire phase information.
WirePosition:
slot_uri: cim:WirePhaseInfo.WirePosition
range: WirePosition
required: false
multivalued: false
description: Wire position with this wire phase information.
WireInfo:
slot_uri: cim:WirePhaseInfo.WireInfo
range: WireInfo
required: false
multivalued: false
description: Wire information contributing to this wire phase information.
WirePosition:
class_uri: cim:WirePosition
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetInfo
description: "Identification, spacing and configuration of the wires of a conductor\
\ with respect to a structure.\r\n"
attributes:
sequenceNumber:
slot_uri: cim:WirePosition.sequenceNumber
range: integer
required: false
multivalued: false
description: Numbering for wires on a WireSpacingInfo. Neutrals should be
numbered last.
xCoord:
slot_uri: cim:WirePosition.xCoord
range: Displacement
required: false
multivalued: false
description: "Signed horizontal distance from the wire at this position to\
\ a common reference point.\r\n"
yCoord:
slot_uri: cim:WirePosition.yCoord
range: Displacement
required: false
multivalued: false
description: "Signed vertical distance from the wire at this position: above\
\ ground (positive value) or burial depth below ground (negative value).\r\
\n"
WirePhaseInfo:
slot_uri: cim:WirePosition.WirePhaseInfo
range: WirePhaseInfo
required: false
multivalued: true
description: Wire phase information for this wire position.
WireSpacingInfo:
slot_uri: cim:WirePosition.WireSpacingInfo
range: WireSpacingInfo
required: false
multivalued: false
description: Wire spacing data this wire position belongs to.
WireSpacingInfo:
class_uri: cim:WireSpacingInfo
is_a: AssetInfo
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetInfo
description: Wire spacing data that associates multiple wire positions with the
line segment, and allows to calculate line segment impedances. Number of phases
can be derived from the number of associated wire positions whose phase is not
neutral.
attributes:
isCable:
slot_uri: cim:WireSpacingInfo.isCable
range: boolean
required: false
multivalued: false
description: "If true, this spacing data describes a cable.\r\n"
phaseWireCount:
slot_uri: cim:WireSpacingInfo.phaseWireCount
range: integer
required: false
multivalued: false
description: "Number of wire sub-conductors in the symmetrical bundle (typically\
\ between 1 and 4).\r\n"
phaseWireSpacing:
slot_uri: cim:WireSpacingInfo.phaseWireSpacing
range: Length
required: false
multivalued: false
description: "Distance between wire sub-conductors in a symmetrical bundle.\r\
\n"
usage:
slot_uri: cim:WireSpacingInfo.usage
range: WireUsageKind
required: false
multivalued: false
description: "Usage of the associated wires.\r\n"
DuctBank:
slot_uri: cim:WireSpacingInfo.DuctBank
range: DuctBank
required: false
multivalued: false
Structures:
slot_uri: cim:WireSpacingInfo.Structures
range: Structure
required: false
multivalued: true
WirePositions:
slot_uri: cim:WireSpacingInfo.WirePositions
range: WirePosition
required: true
multivalued: true
description: All positions of single wires (phase or neutral) making the conductor.
ACLineSegment:
slot_uri: cim:WireSpacingInfo.ACLineSegment
range: ACLineSegment
required: false
multivalued: true
description: The AC line segment defined by the wire spacing information
DuctBank:
class_uri: cim:DuctBank
is_a: AssetContainer
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: "A duct contains individual wires in the layout as specified with\
\ associated wire spacing instances; number of them gives the number of conductors\
\ in this duct.\r\n"
attributes:
circuitCount:
slot_uri: cim:DuctBank.circuitCount
range: integer
required: false
multivalued: false
description: Number of circuits in duct bank. Refer to associations between
a duct (ConductorAsset) and an ACLineSegment to understand which circuits
are in which ducts.
WireSpacingInfos:
slot_uri: cim:DuctBank.WireSpacingInfos
range: WireSpacingInfo
required: false
multivalued: true
Structure:
class_uri: cim:Structure
is_a: AssetContainer
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: "Construction holding assets such as conductors, transformers, switchgear,\
\ etc. Where applicable, number of conductors can be derived from the number\
\ of associated wire spacing instances.\r\n"
attributes:
fumigantAppliedDate:
slot_uri: cim:Structure.fumigantAppliedDate
range: date
required: false
multivalued: false
description: "Date fumigant was last applied.\r\n"
fumigantName:
slot_uri: cim:Structure.fumigantName
range: string
required: false
multivalued: false
description: Name of fumigant.
height:
slot_uri: cim:Structure.height
range: Length
required: false
multivalued: false
description: Visible height of structure above ground level for overhead construction
(e.g., Pole or Tower) or below ground level for an underground vault, manhole,
etc. Refer to associated DimensionPropertiesInfo for other types of dimensions.
materialKind:
slot_uri: cim:Structure.materialKind
range: StructureMaterialKind
required: false
multivalued: false
description: "Material this structure is made of.\r\n"
ratedVoltage:
slot_uri: cim:Structure.ratedVoltage
range: Voltage
required: false
multivalued: false
description: Maximum rated voltage of the equipment that can be mounted on/contained
within the structure.
removeWeed:
slot_uri: cim:Structure.removeWeed
range: boolean
required: false
multivalued: false
description: True if weeds are to be removed around asset.
weedRemovedDate:
slot_uri: cim:Structure.weedRemovedDate
range: date
required: false
multivalued: false
description: "Date weed were last removed.\r\n"
StructureSupports:
slot_uri: cim:Structure.StructureSupports
range: StructureSupport
required: false
multivalued: true
description: Structure support for this structure.
WireSpacingInfos:
slot_uri: cim:Structure.WireSpacingInfos
range: WireSpacingInfo
required: false
multivalued: true
StructureSupport:
class_uri: cim:StructureSupport
is_a: Asset
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: "Support for structure assets.\r\n"
attributes:
anchorKind:
slot_uri: cim:StructureSupport.anchorKind
range: AnchorKind
required: false
multivalued: false
description: (if anchor) Kind of anchor.
anchorRodCount:
slot_uri: cim:StructureSupport.anchorRodCount
range: integer
required: false
multivalued: false
description: (if anchor) Number of rods used.
anchorRodLength:
slot_uri: cim:StructureSupport.anchorRodLength
range: Length
required: false
multivalued: false
description: (if anchor) Length of rod used.
direction:
slot_uri: cim:StructureSupport.direction
range: AngleDegrees
required: false
multivalued: false
description: Direction of this support structure.
kind:
slot_uri: cim:StructureSupport.kind
range: StructureSupportKind
required: false
multivalued: false
description: Kind of structure support.
length:
slot_uri: cim:StructureSupport.length
range: Length
required: false
multivalued: false
description: Length of this support structure.
size:
slot_uri: cim:StructureSupport.size
range: string
required: false
multivalued: false
description: Size of this support structure.
SecuredStructure:
slot_uri: cim:StructureSupport.SecuredStructure
range: Structure
required: false
multivalued: false
description: The secured structure supported by this structure support.
WireInfo:
class_uri: cim:WireInfo
is_a: AssetInfo
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetInfo
description: "Wire data that can be specified per line segment phase, or for the\
\ line segment as a whole in case its phases all have the same wire characteristics.\r\
\n"
attributes:
coreRadius:
slot_uri: cim:WireInfo.coreRadius
range: Length
required: false
multivalued: false
description: (if there is a different core material) Radius of the central
core.
coreStrandCount:
slot_uri: cim:WireInfo.coreStrandCount
range: integer
required: false
multivalued: false
description: (if used) Number of strands in the steel core.
gmr:
slot_uri: cim:WireInfo.gmr
range: Length
required: false
multivalued: false
description: "Geometric mean radius. If we replace the conductor by a thin\
\ walled tube of radius GMR, then its reactance is identical to the reactance\
\ of the actual conductor.\r\n"
insulated:
slot_uri: cim:WireInfo.insulated
range: boolean
required: false
multivalued: false
description: True if conductor is insulated.
insulationMaterial:
slot_uri: cim:WireInfo.insulationMaterial
range: WireInsulationKind
required: false
multivalued: false
description: (if insulated conductor) Material used for insulation.
insulationThickness:
slot_uri: cim:WireInfo.insulationThickness
range: Length
required: false
multivalued: false
description: (if insulated conductor) Thickness of the insulation.
material:
slot_uri: cim:WireInfo.material
range: WireMaterialKind
required: false
multivalued: false
description: "Conductor material.\r\n"
rAC25:
slot_uri: cim:WireInfo.rAC25
range: ResistancePerLength
required: false
multivalued: false
description: "AC resistance per unit length of the conductor at 25 \xB0C.\r\
\n"
rAC50:
slot_uri: cim:WireInfo.rAC50
range: ResistancePerLength
required: false
multivalued: false
description: "AC resistance per unit length of the conductor at 50 \xB0C.\r\
\n"
rAC75:
slot_uri: cim:WireInfo.rAC75
range: ResistancePerLength
required: false
multivalued: false
description: "AC resistance per unit length of the conductor at 75 \xB0C.\r\
\n"
radius:
slot_uri: cim:WireInfo.radius
range: Length
required: false
multivalued: false
description: Outside radius of the wire.
ratedCurrent:
slot_uri: cim:WireInfo.ratedCurrent
range: CurrentFlow
required: false
multivalued: false
description: Current carrying capacity of the wire under stated thermal conditions.
rDC20:
slot_uri: cim:WireInfo.rDC20
range: ResistancePerLength
required: false
multivalued: false
description: "DC resistance per unit length of the conductor at 20 \xB0C.\r\
\n"
sizeDescription:
slot_uri: cim:WireInfo.sizeDescription
range: string
required: false
multivalued: false
description: "Describes the wire gauge or cross section (e.g., 4/0, #2, 336.5).\r\
\n"
strandCount:
slot_uri: cim:WireInfo.strandCount
range: integer
required: false
multivalued: false
description: "Number of strands in the conductor.\r\n"
WirePhaseInfo:
slot_uri: cim:WireInfo.WirePhaseInfo
range: WirePhaseInfo
required: false
multivalued: true
description: Wire phase information associated with this wire information.
ACLineSegmentPhase:
slot_uri: cim:WireInfo.ACLineSegmentPhase
range: ACLineSegmentPhase
required: false
multivalued: true
description: AC line segment phase information associated with this wire information.
ACLineSegmentPhase:
class_uri: cim:ACLineSegmentPhase
is_a: PowerSystemResource
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: "Represents a single wire of an alternating current line segment.\r\
\n"
attributes:
phase:
slot_uri: cim:ACLineSegmentPhase.phase
range: SinglePhaseKind
required: false
multivalued: false
description: "The phase connection of the wire at both ends.\r\n"
sequenceNumber:
slot_uri: cim:ACLineSegmentPhase.sequenceNumber
range: integer
required: false
multivalued: false
description: Number designation for this line segment phase. Each line segment
phase within a line segment should have a unique sequence number. This is
useful for unbalanced modelling to bind the mathematical model (PhaseImpedanceData
of PerLengthPhaseImpedance) with the connectivity model (this class) and
the physical model (WirePosition) without tight coupling.
ACLineSegment:
slot_uri: cim:ACLineSegmentPhase.ACLineSegment
range: ACLineSegment
required: true
multivalued: false
description: The line segment to which the phase belongs.
WireInfo:
slot_uri: cim:ACLineSegmentPhase.WireInfo
range: WireInfo
required: false
multivalued: false
description: Wire information contributing to this AC line segment phase information.
Cut:
class_uri: cim:Cut
is_a: Switch
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: "A cut separates a line segment into two parts. The cut appears as\
\ a switch inserted between these two parts and connects them together. As the\
\ cut is normally open there is no galvanic connection between the two line\
\ segment parts. But it is possible to close the cut to get galvanic connection.\r\
\nThe cut terminals are oriented towards the line segment terminals with the\
\ same sequence number. Hence the cut terminal with sequence number equal to\
\ 1 is oriented to the line segment's terminal with sequence number equal to\
\ 1.\r\nThe cut terminals also act as connection points for jumpers and other\
\ equipment, e.g. a mobile generator. To enable this, connectivity nodes are\
\ placed at the cut terminals. Once the connectivity nodes are in place any\
\ conducting equipment can be connected at them.\r\n"
attributes:
lengthFromTerminal1:
slot_uri: cim:Cut.lengthFromTerminal1
range: Length
required: false
multivalued: false
description: "The length to the place where the cut is located starting from\
\ side one of the cut line segment, i.e. the line segment Terminal with\
\ sequenceNumber equal to 1.\r\n"
ACLineSegment:
slot_uri: cim:Cut.ACLineSegment
range: ACLineSegment
required: true
multivalued: false
description: The line segment to which the cut is applied.
CutAction:
slot_uri: cim:Cut.CutAction
range: CutAction
required: false
multivalued: false
description: Action taken with this cut.
CutAction:
class_uri: cim:CutAction
is_a: SwitchingAction
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Operations
description: Action on cut as a switching step.
attributes:
kind:
slot_uri: cim:CutAction.kind
range: TempEquipActionKind
required: false
multivalued: false
description: Switching action to perform.
Cut:
slot_uri: cim:CutAction.Cut
range: Cut
required: false
multivalued: false
description: Cut on which this action is taken.
LineFault:
class_uri: cim:LineFault
is_a: Fault
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Faults
description: A fault that occurs on an AC line segment at some point along the
length.
attributes:
lengthFromTerminal1:
slot_uri: cim:LineFault.lengthFromTerminal1
range: Length
required: false
multivalued: false
description: The length to the place where the fault is located starting from
terminal with sequence number 1 of the faulted line segment.
ACLineSegment:
slot_uri: cim:LineFault.ACLineSegment
range: ACLineSegment
required: false
multivalued: false
description: The line segment of this line fault.
GroundAction:
class_uri: cim:GroundAction
is_a: SwitchingAction
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Operations
description: Action on ground as a switching step.
attributes:
kind:
slot_uri: cim:GroundAction.kind
range: TempEquipActionKind
required: false
multivalued: false
description: Switching action to perform.
AlongACLineSegment:
slot_uri: cim:GroundAction.AlongACLineSegment
range: ACLineSegment
required: false
multivalued: false
description: The line segment that this ground action will affect. This is
the only way to access relationship to clamp in case the ground needs to
be placed along the line segment.
Ground:
slot_uri: cim:GroundAction.Ground
range: Ground
required: false
multivalued: false
description: Ground on which this action is taken.
GroundedEquipment:
slot_uri: cim:GroundAction.GroundedEquipment
range: ConductingEquipment
required: false
multivalued: false
description: Equipment being grounded with this operation. In case of placing
a ground anywhere along a line segment, you must use the clamp (to get the
distance from one terminal), so use the explicit relation with line segment.
In all other cases (including placing the ground at a line segment terminal),
reference to one or more conducting equipment is sufficient.
Ground:
class_uri: cim:Ground
is_a: ConductingEquipment
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: A point where the system is grounded used for connecting conducting
equipment to ground. The power system model can have any number of grounds.
attributes:
GroundAction:
slot_uri: cim:Ground.GroundAction
range: GroundAction
required: false
multivalued: false
description: Action taken with this ground.
ClampAction:
class_uri: cim:ClampAction
is_a: SwitchingAction
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Operations
description: Action on Clamp as a switching step
attributes:
kind:
slot_uri: cim:ClampAction.kind
range: TempEquipActionKind
required: false
multivalued: false
description: Switching action to perform
Clamp:
slot_uri: cim:ClampAction.Clamp
range: Clamp
required: false
multivalued: false
description: The clamp that the clamp action is performed on
Jumper:
class_uri: cim:Jumper
is_a: Switch
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: A short section of conductor with negligible impedance which can
be manually removed and replaced if the circuit is de-energized. Note that zero-impedance
branches can potentially be modelled by other equipment types.
attributes:
JumperAction:
slot_uri: cim:Jumper.JumperAction
range: JumperAction
required: false
multivalued: false
description: Action taken with this jumper.
ProtectiveActionAdjustment:
class_uri: cim:ProtectiveActionAdjustment
is_a: ProtectiveAction
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfSIPS
description: Protective actions on non-switching equipment. The operating condition
is adjusted.
attributes:
byPercentage:
slot_uri: cim:ProtectiveActionAdjustment.byPercentage
range: PerCent
required: false
multivalued: false
description: The adjustment is given in percent of the active value.
byValue:
slot_uri: cim:ProtectiveActionAdjustment.byValue
range: float
required: false
multivalued: false
description: The adjustment is given in value of the active value.
kind:
slot_uri: cim:ProtectiveActionAdjustment.kind
range: ProtectiveActionAdjustmentKind
required: false
multivalued: false
description: Defines the kind of adjustment that should be done. With this
value the correct attribute containing the value needs to be used.
reduce:
slot_uri: cim:ProtectiveActionAdjustment.reduce
range: boolean
required: false
multivalued: false
description: If true, the adjusted value is an reduction. Other wise it is
an increase in the value.
setValue:
slot_uri: cim:ProtectiveActionAdjustment.setValue
range: float
required: false
multivalued: false
description: The adjustment is given by a new active value.
DCConductingEquipment:
slot_uri: cim:ProtectiveActionAdjustment.DCConductingEquipment
range: DCConductingEquipment
required: true
multivalued: false
description: The operating condition to the Conducting Equipment is changed
when protective action adjustment is activated.
Measurement:
slot_uri: cim:ProtectiveActionAdjustment.Measurement
range: Measurement
required: false
multivalued: false
description: The measurement is used to control the operation of an equipment.
ConductingEquipment:
slot_uri: cim:ProtectiveActionAdjustment.ConductingEquipment
range: ConductingEquipment
required: true
multivalued: false
description: ConductingEquipment whose operating condition is changed when
this protective action adjustment gets activated.
DCConductingEquipment:
class_uri: cim:DCConductingEquipment
is_a: Equipment
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.DC
description: The parts of the DC power system that are designed to carry current
or that are conductively connected through DC terminals.
attributes:
ratedUdc:
slot_uri: cim:DCConductingEquipment.ratedUdc
range: Voltage
required: false
multivalued: false
description: Rated DC device voltage. The attribute shall be a positive value.
It is configuration data used in power flow.
DCTerminals:
slot_uri: cim:DCConductingEquipment.DCTerminals
range: DCTerminal
required: false
multivalued: true
description: A DC conducting equipment has DC terminals.
ProtectiveActionAdjustment:
slot_uri: cim:DCConductingEquipment.ProtectiveActionAdjustment
range: ProtectiveActionAdjustment
required: false
multivalued: true
DCTerminal:
class_uri: cim:DCTerminal
is_a: DCBaseTerminal
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.DC
description: An electrical connection point to generic DC conducting equipment.
attributes:
DCConductingEquipment:
slot_uri: cim:DCTerminal.DCConductingEquipment
range: DCConductingEquipment
required: true
multivalued: false
description: An DC terminal belong to a DC conducting equipment.
CompositeSwitch:
class_uri: cim:CompositeSwitch
is_a: Equipment
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: "A model of a set of individual Switches normally enclosed within\
\ the same cabinet and possibly with interlocks that restrict the combination\
\ of switch positions. These are typically found in medium voltage distribution\
\ networks. \r\nA CompositeSwitch could represent a Ring-Main-Unit (RMU), or\
\ pad-mounted switchgear, with primitive internal devices such as an internal\
\ bus-bar plus 3 or 4 internal switches each of which may individually be open\
\ or closed. A CompositeSwitch and a set of contained Switches can also be used\
\ to represent a multi-position switch e.g. a switch that can connect a circuit\
\ to Ground, Open or Busbar."
attributes:
compositeSwitchType:
slot_uri: cim:CompositeSwitch.compositeSwitchType
range: string
required: false
multivalued: false
description: An alphanumeric code that can be used as a reference to extra
information such as the description of the interlocking scheme if any.
Switches:
slot_uri: cim:CompositeSwitch.Switches
range: Switch
required: false
multivalued: true
description: Switches contained in this Composite switch.
UnavailabilitySwitchAction:
class_uri: cim:UnavailabilitySwitchAction
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfAvailabilityPlans
description: Relevant switching action for supporting the availability (or unavailability)
plans. This could open or close a switch that is not directly connected to
the unavailable equipment .
attributes:
open:
slot_uri: cim:UnavailabilitySwitchAction.open
range: boolean
required: false
multivalued: false
description: 'The switch is to be open during the scheduled period. '
EquipmentUnavailabilitySchedule:
slot_uri: cim:UnavailabilitySwitchAction.EquipmentUnavailabilitySchedule
range: EquipmentUnavailabilitySchedule
required: true
multivalued: false
Switch:
slot_uri: cim:UnavailabilitySwitchAction.Switch
range: Switch
required: true
multivalued: false
EquipmentUnavailabilitySchedule:
class_uri: cim:EquipmentUnavailabilitySchedule
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfAvailabilityPlans
attributes:
UnavailablitySchedule:
slot_uri: cim:EquipmentUnavailabilitySchedule.UnavailablitySchedule
range: UnavailablitySchedule
required: true
multivalued: false
Equipment:
slot_uri: cim:EquipmentUnavailabilitySchedule.Equipment
range: Equipment
required: false
multivalued: false
UnavailabilitySwitchAction:
slot_uri: cim:EquipmentUnavailabilitySchedule.UnavailabilitySwitchAction
range: UnavailabilitySwitchAction
required: false
multivalued: true
UnavailablitySchedule:
class_uri: cim:UnavailablitySchedule
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfAvailabilityPlans
description: A schedule of unavailability for one or more specified equipment
that need to follow the same scheduling periods.
attributes:
AvailablityPlan:
slot_uri: cim:UnavailablitySchedule.AvailablityPlan
range: AvailablityPlan
required: false
multivalued: false
EquipmentUnavailabilitySchedule:
slot_uri: cim:UnavailablitySchedule.EquipmentUnavailabilitySchedule
range: EquipmentUnavailabilitySchedule
required: false
multivalued: true
DependsOn:
slot_uri: cim:UnavailablitySchedule.DependsOn
range: UnavailabilityScheduleDependency
required: false
multivalued: true
Impacts:
slot_uri: cim:UnavailablitySchedule.Impacts
range: UnavailabilityScheduleDependency
required: false
multivalued: true
UnavailabilityScheduleDependency:
class_uri: cim:UnavailabilityScheduleDependency
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfAvailabilityPlans
attributes:
UnavailabilityScheduleImpacts:
slot_uri: cim:UnavailabilityScheduleDependency.UnavailabilityScheduleImpacts
range: UnavailablitySchedule
required: true
multivalued: false
UnavailabilityScheduleDependsOn:
slot_uri: cim:UnavailabilityScheduleDependency.UnavailabilityScheduleDependsOn
range: UnavailablitySchedule
required: true
multivalued: false
AvailablityPlan:
class_uri: cim:AvailablityPlan
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfAvailabilityPlans
description: 'The collection of all the availability schedules for a given time
range. Only one availability plan shall be valid for the same period. '
attributes:
validPeriod:
slot_uri: cim:AvailablityPlan.validPeriod
range: DateTimeInterval
required: false
multivalued: false
description: The period of time for which the plan is valid.
UnavailablitySchedule:
slot_uri: cim:AvailablityPlan.UnavailablitySchedule
range: UnavailablitySchedule
required: false
multivalued: true
SvSwitch:
class_uri: cim:SvSwitch
is_a: StateVariable
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.StateVariables
description: 'State variable for switch. '
attributes:
open:
slot_uri: cim:SvSwitch.open
range: boolean
required: false
multivalued: false
description: The attribute tells if the computed state of the switch is considered
open.
phase:
slot_uri: cim:SvSwitch.phase
range: SinglePhaseKind
required: false
multivalued: false
description: The terminal phase at which the connection is applied. If missing,
the injection is assumed to be balanced among non-neutral phases.
Switch:
slot_uri: cim:SvSwitch.Switch
range: Switch
required: true
multivalued: false
description: The switch associated with the switch state.
ConnectDisconnectFunction:
class_uri: cim:ConnectDisconnectFunction
is_a: EndDeviceFunction
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.LoadControl
description: "A function that will disconnect and reconnect the customer's load\
\ under defined conditions.\r\n"
attributes:
eventCount:
slot_uri: cim:ConnectDisconnectFunction.eventCount
range: integer
required: false
multivalued: false
description: "Running cumulative count of connect or disconnect events, for\
\ the lifetime of this function or until the value is cleared.\r\n"
isConnected:
slot_uri: cim:ConnectDisconnectFunction.isConnected
range: boolean
required: false
multivalued: false
description: True if this function is in the connected state.
isDelayedDiscon:
slot_uri: cim:ConnectDisconnectFunction.isDelayedDiscon
range: boolean
required: false
multivalued: false
description: If set true, the switch may disconnect the service at the end
of a specified time delay after the disconnect signal has been given. If
set false, the switch may disconnect the service immediately after the disconnect
signal has been given. This is typically the case for over current circuit-breakers
which are classified as either instantaneous or slow acting.
isLocalAutoDisconOp:
slot_uri: cim:ConnectDisconnectFunction.isLocalAutoDisconOp
range: boolean
required: false
multivalued: false
description: "If set true and if disconnection can be operated locally, the\
\ operation happens automatically. Otherwise it happens manually.\r\n"
isLocalAutoReconOp:
slot_uri: cim:ConnectDisconnectFunction.isLocalAutoReconOp
range: boolean
required: false
multivalued: false
description: "If set true and if reconnection can be operated locally, then\
\ the operation happens automatically. Otherwise, it happens manually.\r\
\n"
isRemoteAutoDisconOp:
slot_uri: cim:ConnectDisconnectFunction.isRemoteAutoDisconOp
range: boolean
required: false
multivalued: false
description: If set true and if disconnection can be operated remotely, then
the operation happens automatically. If set false and if disconnection can
be operated remotely, then the operation happens manually.
isRemoteAutoReconOp:
slot_uri: cim:ConnectDisconnectFunction.isRemoteAutoReconOp
range: boolean
required: false
multivalued: false
description: "If set true and if reconnection can be operated remotely, then\
\ the operation happens automatically. If set false and if reconnection\
\ can be operated remotely, then the operation happens manually.\r\n"
rcdInfo:
slot_uri: cim:ConnectDisconnectFunction.rcdInfo
range: RemoteConnectDisconnectInfo
required: false
multivalued: false
description: Information on remote connect disconnect switch.
Switches:
slot_uri: cim:ConnectDisconnectFunction.Switches
range: Switch
required: false
multivalued: true
RemoteConnectDisconnectInfo:
class_uri: cim:RemoteConnectDisconnectInfo
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.LoadControl
description: "Details of remote connect and disconnect function.\r\n"
attributes:
armedTimeout:
slot_uri: cim:RemoteConnectDisconnectInfo.armedTimeout
range: Seconds
required: false
multivalued: false
description: Setting of the timeout elapsed time.
customerVoltageLimit:
slot_uri: cim:RemoteConnectDisconnectInfo.customerVoltageLimit
range: Voltage
required: false
multivalued: false
description: Voltage limit on customer side of RCD switch above which the
connect should not be made.
energyLimit:
slot_uri: cim:RemoteConnectDisconnectInfo.energyLimit
range: RealEnergy
required: false
multivalued: false
description: Limit of energy before disconnect.
energyUsageStartDateTime:
slot_uri: cim:RemoteConnectDisconnectInfo.energyUsageStartDateTime
range: date
required: false
multivalued: false
description: "Start date and time to accumulate energy for energy usage limiting.\r\
\n"
energyUsageWarning:
slot_uri: cim:RemoteConnectDisconnectInfo.energyUsageWarning
range: RealEnergy
required: false
multivalued: false
description: Warning energy limit, used to trigger event code that energy
usage is nearing limit.
isArmConnect:
slot_uri: cim:RemoteConnectDisconnectInfo.isArmConnect
range: boolean
required: false
multivalued: false
description: True if the RCD switch has to be armed before a connect action
can be initiated.
isArmDisconnect:
slot_uri: cim:RemoteConnectDisconnectInfo.isArmDisconnect
range: boolean
required: false
multivalued: false
description: True if the RCD switch has to be armed before a disconnect action
can be initiated.
isEnergyLimiting:
slot_uri: cim:RemoteConnectDisconnectInfo.isEnergyLimiting
range: boolean
required: false
multivalued: false
description: True if the energy usage is limited and the customer will be
disconnected if they go over the limit.
needsPowerLimitCheck:
slot_uri: cim:RemoteConnectDisconnectInfo.needsPowerLimitCheck
range: boolean
required: false
multivalued: false
description: True if load limit has to be checked to issue an immediate disconnect
(after a connect) if load is over the limit.
needsVoltageLimitCheck:
slot_uri: cim:RemoteConnectDisconnectInfo.needsVoltageLimitCheck
range: boolean
required: false
multivalued: false
description: True if voltage limit has to be checked to prevent connect if
voltage is over the limit.
powerLimit:
slot_uri: cim:RemoteConnectDisconnectInfo.powerLimit
range: ActivePower
required: false
multivalued: false
description: Load limit above which the connect should either not take place
or should cause an immediate disconnect.
usePushbutton:
slot_uri: cim:RemoteConnectDisconnectInfo.usePushbutton
range: boolean
required: false
multivalued: false
description: True if pushbutton has to be used for connect.
SwitchPhase:
class_uri: cim:SwitchPhase
is_a: PowerSystemResource
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: "Single phase of a multi-phase switch when its attributes might be\
\ different per phase.\r\n"
attributes:
closed:
slot_uri: cim:SwitchPhase.closed
range: boolean
required: false
multivalued: false
description: The attribute tells if the switch is considered closed when used
as input to topology processing.
normalOpen:
slot_uri: cim:SwitchPhase.normalOpen
range: boolean
required: false
multivalued: false
description: "Used in cases when no Measurement for the status value is present.\
\ If the SwitchPhase has a status measurement the Discrete.normalValue is\
\ expected to match with this value.\r\n"
phaseSide1:
slot_uri: cim:SwitchPhase.phaseSide1
range: SinglePhaseKind
required: false
multivalued: false
description: "Phase of this SwitchPhase on the side with terminal sequence\
\ number equal to 1. Should be a phase contained in that terminal\u2019\
s phases attribute."
phaseSide2:
slot_uri: cim:SwitchPhase.phaseSide2
range: SinglePhaseKind
required: false
multivalued: false
description: "Phase of this SwitchPhase on the side with terminal sequence\
\ number equal to 2. Should be a phase contained in that terminal\u2019\
s Terminal.phases attribute."
ratedCurrent:
slot_uri: cim:SwitchPhase.ratedCurrent
range: CurrentFlow
required: false
multivalued: false
description: "The maximum continuous current carrying capacity in amps governed\
\ by the device material and construction.\r\nThe attribute shall be a positive\
\ value.\r\n"
Switch:
slot_uri: cim:SwitchPhase.Switch
range: Switch
required: true
multivalued: false
description: The switch of the switch phase.
SwitchSchedule:
class_uri: cim:SwitchSchedule
is_a: SeasonDayTypeSchedule
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: 'A schedule of switch positions. If RegularTimePoint.value1 is 0,
the switch is open. If 1, the switch is closed. '
attributes:
Switch:
slot_uri: cim:SwitchSchedule.Switch
range: Switch
required: true
multivalued: false
description: A SwitchSchedule is associated with a Switch.
SeasonDayTypeSchedule:
class_uri: cim:SeasonDayTypeSchedule
is_a: RegularIntervalSchedule
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.LoadModel
description: "A time schedule covering a 24 hour period, with curve data for a\
\ specific type of season and day.\r\n"
attributes:
DayType:
slot_uri: cim:SeasonDayTypeSchedule.DayType
range: DayType
required: false
multivalued: false
description: DayType for the Schedule.
Season:
slot_uri: cim:SeasonDayTypeSchedule.Season
range: Season
required: false
multivalued: false
description: Season for the Schedule.
RegularIntervalSchedule:
class_uri: cim:RegularIntervalSchedule
is_a: BasicIntervalSchedule
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Core
description: "The schedule has time points where the time between them is constant.\r\
\n"
attributes:
endTime:
slot_uri: cim:RegularIntervalSchedule.endTime
range: date
required: false
multivalued: false
description: The time for the last time point. The value can be a time of
day, not a specific date.
timeStep:
slot_uri: cim:RegularIntervalSchedule.timeStep
range: Seconds
required: false
multivalued: false
description: "The time between each pair of subsequent regular time points\
\ in sequence order.\r\n"
TimePoints:
slot_uri: cim:RegularIntervalSchedule.TimePoints
range: RegularTimePoint
required: true
multivalued: true
description: The regular interval time point data values that define this
schedule.
BasicIntervalSchedule:
class_uri: cim:BasicIntervalSchedule
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Core
description: Schedule of values at points in time.
attributes:
startTime:
slot_uri: cim:BasicIntervalSchedule.startTime
range: date
required: false
multivalued: false
description: The time for the first time point. The value can be a time of
day, not a specific date.
value1Multiplier:
slot_uri: cim:BasicIntervalSchedule.value1Multiplier
range: UnitMultiplier
required: false
multivalued: false
description: Multiplier for value1.
value1Unit:
slot_uri: cim:BasicIntervalSchedule.value1Unit
range: UnitSymbol
required: false
multivalued: false
description: Value1 units of measure.
value2Multiplier:
slot_uri: cim:BasicIntervalSchedule.value2Multiplier
range: UnitMultiplier
required: false
multivalued: false
description: Multiplier for value2.
value2Unit:
slot_uri: cim:BasicIntervalSchedule.value2Unit
range: UnitSymbol
required: false
multivalued: false
description: Value2 units of measure.
RegularTimePoint:
class_uri: cim:RegularTimePoint
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Core
description: "Time point for a schedule where the time between the consecutive\
\ points is constant.\r\n"
attributes:
sequenceNumber:
slot_uri: cim:RegularTimePoint.sequenceNumber
range: integer
required: false
multivalued: false
description: "The position of the regular time point in the sequence. Note\
\ that time points don't have to be sequential, i.e. time points may be\
\ omitted. The actual time for a RegularTimePoint is computed by multiplying\
\ the associated regular interval schedule's time step with the regular\
\ time point sequence number and adding the associated schedules start time.\
\ To specify values for the start time, use sequence number 0. The sequence\
\ number cannot be negative.\r\n"
value1:
slot_uri: cim:RegularTimePoint.value1
range: float
required: false
multivalued: false
description: "The first value at the time. The meaning of the value is defined\
\ by the derived type of the associated schedule.\r\n"
value2:
slot_uri: cim:RegularTimePoint.value2
range: float
required: false
multivalued: false
description: "The second value at the time. The meaning of the value is defined\
\ by the derived type of the associated schedule.\r\n\r\n"
IntervalSchedule:
slot_uri: cim:RegularTimePoint.IntervalSchedule
range: RegularIntervalSchedule
required: true
multivalued: false
description: Regular interval schedule containing this time point.
DayType:
class_uri: cim:DayType
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.LoadModel
description: "Group of similar days. For example it could be used to represent\
\ weekdays, weekend, or holidays.\r\n"
attributes:
SeasonDayTypeSchedules:
slot_uri: cim:DayType.SeasonDayTypeSchedules
range: SeasonDayTypeSchedule
required: false
multivalued: true
description: Schedules that use this DayType.
Season:
class_uri: cim:Season
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.LoadModel
description: A specified time period of the year.
attributes:
endDate:
slot_uri: cim:Season.endDate
range: date
required: false
multivalued: false
description: Date season ends.
startDate:
slot_uri: cim:Season.startDate
range: date
required: false
multivalued: false
description: Date season starts.
SeasonDayTypeSchedules:
slot_uri: cim:Season.SeasonDayTypeSchedules
range: SeasonDayTypeSchedule
required: false
multivalued: true
description: Schedules that use this Season.
ScheduledLimits:
slot_uri: cim:Season.ScheduledLimits
range: ScheduledLimitValue
required: false
multivalued: true
description: The scheduled limits associated with the season.
ScheduledLimitValue:
class_uri: cim:ScheduledLimitValue
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfOperationalLimits
description: A limit that is applicable during a scheduled time period.
attributes:
Season:
slot_uri: cim:ScheduledLimitValue.Season
range: Season
required: false
multivalued: false
description: The season for which the scheduled limits applies. If not
specified, then applicable ot any season.
ScheduledLimitDependency:
slot_uri: cim:ScheduledLimitValue.ScheduledLimitDependency
range: ScheduledLimitDependency
required: true
multivalued: false
ScheduledLimitDependency:
class_uri: cim:ScheduledLimitDependency
is_a: LimitDependency
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfOperationalLimits
attributes:
ScheduledLimitValues:
slot_uri: cim:ScheduledLimitDependency.ScheduledLimitValues
range: ScheduledLimitValue
required: false
multivalued: true
description: The scheduled limit values for this limit dependency.
RecloseSequence:
class_uri: cim:RecloseSequence
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Protection
description: A reclose sequence (open and close) is defined for each possible
reclosure of a breaker.
attributes:
recloseDelay:
slot_uri: cim:RecloseSequence.recloseDelay
range: Seconds
required: false
multivalued: false
description: Indicates the time lapse before the reclose step will execute
a reclose.
recloseStep:
slot_uri: cim:RecloseSequence.recloseStep
range: integer
required: false
multivalued: false
description: Indicates the ordinal position of the reclose step relative to
other steps in the sequence.
ProtectedSwitch:
slot_uri: cim:RecloseSequence.ProtectedSwitch
range: ProtectedSwitch
required: true
multivalued: false
description: A breaker may have zero or more automatic reclosures after a
trip occurs.
Stage:
class_uri: cim:Stage
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfSIPS
description: Stage of a remedial action scheme.
attributes:
priority:
slot_uri: cim:Stage.priority
range: integer
required: false
multivalued: false
description: The priority of the stage. 0 = don t care (default) 1 = highest
priority. 2 is less than 1 and so on. A stage with higher priority needs
be activated before a lower stage can be activated.
RemedialActionScheme:
slot_uri: cim:Stage.RemedialActionScheme
range: RemedialActionScheme
required: true
multivalued: false
StageTrigger:
slot_uri: cim:Stage.StageTrigger
range: StageTrigger
required: true
multivalued: true
description: A Stage consist of one or more StageTrigger.
RemedialActionScheme:
class_uri: cim:RemedialActionScheme
is_a: PowerSystemResource
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfSIPS
description: Remedial Action Scheme (RAS), Special Protection Schemes (SPS), System
Protection Schemes (SPS) or System Integrity Protection Schemes (SIPS).
attributes:
armed:
slot_uri: cim:RemedialActionScheme.armed
range: boolean
required: false
multivalued: false
description: The status of the class set by operation or by signal. Optional
field that will override other status fields.
kind:
slot_uri: cim:RemedialActionScheme.kind
range: RemedialActionSchemeKind
required: false
multivalued: false
description: Kind of Remedial Action Scheme (RAS).
normalArmed:
slot_uri: cim:RemedialActionScheme.normalArmed
range: boolean
required: false
multivalued: false
description: The default/normal value used when other active signal/values
are missing.
Stage:
slot_uri: cim:RemedialActionScheme.Stage
range: Stage
required: true
multivalued: true
description: A Remedial Action Scheme (RAS) consist of one or more stage that
are trigger and execute protection action.
TriggerCondition:
slot_uri: cim:RemedialActionScheme.TriggerCondition
range: TriggerCondition
required: false
multivalued: true
description: Triggering of the Remedial Action Schemes (RAS).
GateArmed:
slot_uri: cim:RemedialActionScheme.GateArmed
range: Gate
required: false
multivalued: false
description: Gate that through a gate logic and input pin defines arming of
the Remedial Action Schemes (RAS).
TriggerCondition:
class_uri: cim:TriggerCondition
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfSIPS
description: A conditions that can trigger remedial actions.
attributes:
RemedialActionScheme:
slot_uri: cim:TriggerCondition.RemedialActionScheme
range: RemedialActionScheme
required: true
multivalued: false
GateTrigger:
slot_uri: cim:TriggerCondition.GateTrigger
range: Gate
required: true
multivalued: false
description: The resulting Gate that is the condition for the Trigger.
PinGate:
class_uri: cim:PinGate
is_a: GateInputPin
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfSIPS
description: An output from one gate represent an input to another gate.
attributes:
GateOutput:
slot_uri: cim:PinGate.GateOutput
range: Gate
required: true
multivalued: false
MeasurementCalculator:
class_uri: cim:MeasurementCalculator
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfSIPS
description: 'Result of a calculation of one or more measurement. '
attributes:
kind:
slot_uri: cim:MeasurementCalculator.kind
range: CalculationKind
required: false
multivalued: false
description: Calculation operation executed on the operants.
PinMeasurement:
slot_uri: cim:MeasurementCalculator.PinMeasurement
range: PinMeasurement
required: false
multivalued: true
MeasurementCalculatorInput:
slot_uri: cim:MeasurementCalculator.MeasurementCalculatorInput
range: MeasurementCalculatorInput
required: true
multivalued: true
description: Used in the calculation.
MeasurementCalculatorInput:
class_uri: cim:MeasurementCalculatorInput
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfSIPS
description: Input to measurement calculation. Support Analog, Discrete and Accumulator.
attributes:
absoluteValue:
slot_uri: cim:MeasurementCalculatorInput.absoluteValue
range: boolean
required: false
multivalued: false
description: 'If true, use the absolute value for the calculation. '
order:
slot_uri: cim:MeasurementCalculatorInput.order
range: integer
required: false
multivalued: false
description: 'Positive number that defines the order of the operant in the
calculation. 0 = default. The order is not relevant (e.g. summation). '
Measurement:
slot_uri: cim:MeasurementCalculatorInput.Measurement
range: Measurement
required: true
multivalued: false
description: Measurement used as input to a calculation.
MeasurementCalculator:
slot_uri: cim:MeasurementCalculatorInput.MeasurementCalculator
range: MeasurementCalculator
required: true
multivalued: false
MeasurementAction:
class_uri: cim:MeasurementAction
is_a: SwitchingAction
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Operations
description: Measurement taken as a switching step.
attributes:
Measurement:
slot_uri: cim:MeasurementAction.Measurement
range: Measurement
required: false
multivalued: false
description: The measurement that the measurement action is performed on
RemoteSource:
class_uri: cim:RemoteSource
is_a: RemotePoint
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.SCADA
description: Remote sources are state variables that are telemetered or calculated
within the remote unit.
attributes:
deadband:
slot_uri: cim:RemoteSource.deadband
range: float
required: false
multivalued: false
description: The smallest change in value to be reported.
scanInterval:
slot_uri: cim:RemoteSource.scanInterval
range: Seconds
required: false
multivalued: false
description: The time interval between scans.
sensorMaximum:
slot_uri: cim:RemoteSource.sensorMaximum
range: float
required: false
multivalued: false
description: The maximum value the telemetry item can return.
sensorMinimum:
slot_uri: cim:RemoteSource.sensorMinimum
range: float
required: false
multivalued: false
description: The minimum value the telemetry item can return.
MeasurementValue:
slot_uri: cim:RemoteSource.MeasurementValue
range: MeasurementValue
required: true
multivalued: false
description: Link to the physical telemetered point associated with this measurement.
OldCrew:
class_uri: cim:OldCrew
is_a: Crew
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfCommon
description: A crew is a group of people with specific skills, tools, and vehicles.
attributes:
type:
slot_uri: cim:OldCrew.type
range: string
required: false
multivalued: false
description: "Classification by utility's work management standards and practices.\r\
\n"
ShiftPatterns:
slot_uri: cim:OldCrew.ShiftPatterns
range: ShiftPattern
required: false
multivalued: true
Route:
slot_uri: cim:OldCrew.Route
range: Route
required: false
multivalued: false
Locations:
slot_uri: cim:OldCrew.Locations
range: Location
required: false
multivalued: true
Assignments:
slot_uri: cim:OldCrew.Assignments
range: Assignment
required: false
multivalued: true
description: All Assignments for this Crew.
Capabilities:
slot_uri: cim:OldCrew.Capabilities
range: Capability
required: false
multivalued: true
ShiftPattern:
class_uri: cim:ShiftPattern
is_a: WorkIdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfWork
description: The patterns of shifts worked by people or crews.
attributes:
assignmentType:
slot_uri: cim:ShiftPattern.assignmentType
range: string
required: false
multivalued: false
description: Type of assignement intended to be worked on this shift, for
example, temporary, standard, etc.
cycleCount:
slot_uri: cim:ShiftPattern.cycleCount
range: integer
required: false
multivalued: false
description: Number of cycles for a temporary shift.
status:
slot_uri: cim:ShiftPattern.status
range: Status
required: false
multivalued: false
validityInterval:
slot_uri: cim:ShiftPattern.validityInterval
range: DateTimeInterval
required: false
multivalued: false
description: Date and time interval for which this shift pattern is valid
(when it became effective and when it expires).
Crews:
slot_uri: cim:ShiftPattern.Crews
range: OldCrew
required: false
multivalued: true
Route:
class_uri: cim:Route
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfLocations
description: "Route that is followed, for example by service crews.\r\n"
attributes:
status:
slot_uri: cim:Route.status
range: Status
required: false
multivalued: false
type:
slot_uri: cim:Route.type
range: string
required: false
multivalued: false
description: "Classification by utility's work management standards and practices.\r\
\n"
Locations:
slot_uri: cim:Route.Locations
range: Location
required: false
multivalued: true
Crews:
slot_uri: cim:Route.Crews
range: OldCrew
required: false
multivalued: true
Assignment:
class_uri: cim:Assignment
is_a: WorkDocument
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfWork
description: An assignment is given to an ErpPerson, Crew, Organisation, Equipment
Item, Tool, etc. and may be used to perform Work, WorkTasks, Procedures, etc.
TimeSchedules may be set up directly for Assignments or indirectly via the associated
WorkTask. Note that these associations are all inherited through the recursive
relationship on Document.
attributes:
effectivePeriod:
slot_uri: cim:Assignment.effectivePeriod
range: DateTimeInterval
required: false
multivalued: false
description: Period between the assignment becoming effective and its expiration.
Crews:
slot_uri: cim:Assignment.Crews
range: OldCrew
required: false
multivalued: true
description: All Crews having this Assignment.
Usage:
class_uri: cim:Usage
is_a: WorkIdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfWork
description: The way material and assets are used to perform a certain type of
work task. The way is described in text in the inheritied description attribute.
attributes:
status:
slot_uri: cim:Usage.status
range: Status
required: false
multivalued: false
WorkTask:
slot_uri: cim:Usage.WorkTask
range: OldWorkTask
required: false
multivalued: false
ErpReceivable:
class_uri: cim:ErpReceivable
is_a: ErpDocument
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfERPSupport
description: Transaction representing an invoice, credit memo or debit memo to
a customer. It is an open (unpaid) item in the Accounts Receivable ledger.
attributes:
ErpRecLineItems:
slot_uri: cim:ErpReceivable.ErpRecLineItems
range: ErpRecLineItem
required: false
multivalued: true
ErpJournal:
class_uri: cim:ErpJournal
is_a: ErpDocument
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfERPSupport
description: "Book for recording accounting transactions as they occur. Transactions\
\ and adjustments are first recorded in a journal, which is like a diary of\
\ instructions, advising which account to be charged and by how much.\r\nA journal\
\ represents a change in the balances of a business's financial accounts. Many\
\ tasks or transactions throughout an enterprise will result in the creation\
\ of a journal. Some examples are creating a customer invoice, paying a vendor,\
\ transferring inventory, or paying employees."
attributes:
ErpJournalEntries:
slot_uri: cim:ErpJournal.ErpJournalEntries
range: ErpJournalEntry
required: false
multivalued: true
CUContractorItem:
class_uri: cim:CUContractorItem
is_a: WorkIdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfWork
description: Compatible unit contractor item.
attributes:
activityCode:
slot_uri: cim:CUContractorItem.activityCode
range: string
required: false
multivalued: false
description: ' Activity code identifies a specific and distinguishable unit
of work.'
bidAmount:
slot_uri: cim:CUContractorItem.bidAmount
range: Money
required: false
multivalued: false
description: ' The amount that a given contractor will charge for performing
this unit of work.'
status:
slot_uri: cim:CUContractorItem.status
range: Status
required: false
multivalued: false
CompatibleUnits:
slot_uri: cim:CUContractorItem.CompatibleUnits
range: CompatibleUnit
required: false
multivalued: true
CUAllowableAction:
class_uri: cim:CUAllowableAction
is_a: WorkIdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfWork
description: 'Allowed actions: Install, Remove, Transfer, Abandon, etc.'
attributes:
status:
slot_uri: cim:CUAllowableAction.status
range: Status
required: false
multivalued: false
CompatibleUnits:
slot_uri: cim:CUAllowableAction.CompatibleUnits
range: CompatibleUnit
required: false
multivalued: true
TypeAssetCatalogue:
class_uri: cim:TypeAssetCatalogue
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfTypeAsset
description: Catalogue of generic types of assets (TypeAsset) that may be used
for design purposes. It is not associated with a particular manufacturer.
attributes:
status:
slot_uri: cim:TypeAssetCatalogue.status
range: Status
required: false
multivalued: false
TypeAssets:
slot_uri: cim:TypeAssetCatalogue.TypeAssets
range: CatalogAssetType
required: false
multivalued: true
Manufacturer:
class_uri: cim:Manufacturer
is_a: OrganisationRole
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: "Organisation that manufactures asset products.\r\n"
attributes:
ProductAssetModels:
slot_uri: cim:Manufacturer.ProductAssetModels
range: ProductAssetModel
required: false
multivalued: true
description: All asset models by this manufacturer.
AssetModelCatalogue:
class_uri: cim:AssetModelCatalogue
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfAssetInfo
description: Catalogue of available types of products and materials that are used
to build or install, maintain or operate an Asset. Each catalogue item is for
a specific product (AssetModel) available from a specific supplier.
attributes:
status:
slot_uri: cim:AssetModelCatalogue.status
range: Status
required: false
multivalued: false
AssetModelCatalogueItems:
slot_uri: cim:AssetModelCatalogue.AssetModelCatalogueItems
range: AssetModelCatalogueItem
required: false
multivalued: true
ErpQuote:
class_uri: cim:ErpQuote
is_a: ErpDocument
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfERPSupport
description: Document describing the prices of goods or services provided by a
supplier. It includes the terms of the purchase, delivery proposals, identification
of goods or services ordered, as well as their quantities.
attributes:
ErpQuoteLineItems:
slot_uri: cim:ErpQuote.ErpQuoteLineItems
range: ErpQuoteLineItem
required: false
multivalued: true
ErpInvoice:
class_uri: cim:ErpInvoice
is_a: ErpDocument
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfERPSupport
description: "A roll up of invoice line items. The whole invoice has a due date\
\ and amount to be paid, with information such as customer, banks etc. being\
\ obtained through associations. The invoice roll up is based on individual\
\ line items that each contain amounts and descriptions for specific services\
\ or products.\r\n"
attributes:
amount:
slot_uri: cim:ErpInvoice.amount
range: Money
required: false
multivalued: false
description: Total amount due on this invoice based on line items and applicable
adjustments.
billMediaKind:
slot_uri: cim:ErpInvoice.billMediaKind
range: BillMediaKind
required: false
multivalued: false
description: Kind of media by which the CustomerBillingInfo was delivered.
dueDate:
slot_uri: cim:ErpInvoice.dueDate
range: date
required: false
multivalued: false
description: "Calculated date upon which the Invoice amount is due.\r\n"
kind:
slot_uri: cim:ErpInvoice.kind
range: ErpInvoiceKind
required: false
multivalued: false
description: Kind of invoice (default is 'sales').
mailedDate:
slot_uri: cim:ErpInvoice.mailedDate
range: date
required: false
multivalued: false
description: "Date on which the customer billing statement/invoice was printed/mailed.\r\
\n"
proForma:
slot_uri: cim:ErpInvoice.proForma
range: boolean
required: false
multivalued: false
description: True if payment is to be paid by a Customer to accept a particular
ErpQuote (with associated Design) and have work initiated, at which time
an associated ErpInvoice should automatically be generated. EprPayment.subjectStatus
satisfies terms specificed in the ErpQuote.
referenceNumber:
slot_uri: cim:ErpInvoice.referenceNumber
range: string
required: false
multivalued: false
description: Number of an invoice to be reference by this invoice.
transactionDateTime:
slot_uri: cim:ErpInvoice.transactionDateTime
range: date
required: false
multivalued: false
description: "Date and time when the invoice is issued.\r\n"
transferType:
slot_uri: cim:ErpInvoice.transferType
range: string
required: false
multivalued: false
description: Type of invoice transfer.
ErpInvoiceLineItems:
slot_uri: cim:ErpInvoice.ErpInvoiceLineItems
range: ErpInvoiceLineItem
required: false
multivalued: true
CustomerAccount:
slot_uri: cim:ErpInvoice.CustomerAccount
range: CustomerAccount
required: false
multivalued: false
AccountNotification:
class_uri: cim:AccountNotification
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Customers
description: Notifications for move-in, move-out, delinquencies, etc.
attributes:
customerNotificationType:
slot_uri: cim:AccountNotification.customerNotificationType
range: string
required: false
multivalued: false
description: "Notifications for move-in, move-out, delinquencies, planned\
\ outage, demand response programs, time of use, etc.\r\n"
methodType:
slot_uri: cim:AccountNotification.methodType
range: string
required: true
multivalued: false
description: method of notification such as phone call, email, letter, door
hanger, text message, etc.
note:
slot_uri: cim:AccountNotification.note
range: string
required: false
multivalued: false
description: 'Free form text characterizing the notification. '
time:
slot_uri: cim:AccountNotification.time
range: date
required: false
multivalued: false
description: Time of notification - this is the time the notification was
sent.
CustomerAccount:
slot_uri: cim:AccountNotification.CustomerAccount
range: CustomerAccount
required: true
multivalued: false
description: The customer account for which a notification is made
ServiceSupplier:
class_uri: cim:ServiceSupplier
is_a: OrganisationRole
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.PaymentMetering
description: Organisation that provides services to customers.
attributes:
issuerIdentificationNumber:
slot_uri: cim:ServiceSupplier.issuerIdentificationNumber
range: string
required: false
multivalued: false
description: Unique transaction reference prefix number issued to an entity
by the International Organization for Standardization for the purpose of
tagging onto electronic financial transactions, as defined in ISO/IEC 7812-1
and ISO/IEC 7812-2.
kind:
slot_uri: cim:ServiceSupplier.kind
range: SupplierKind
required: false
multivalued: false
description: Kind of supplier.
CustomerAgreements:
slot_uri: cim:ServiceSupplier.CustomerAgreements
range: CustomerAgreement
required: false
multivalued: true
description: All customer agreements of this service supplier.
UsagePoints:
slot_uri: cim:ServiceSupplier.UsagePoints
range: UsagePoint
required: false
multivalued: true
description: All usage points this service supplier utilises to deliver a
service.
BankAccounts:
slot_uri: cim:ServiceSupplier.BankAccounts
range: BankAccount
required: false
multivalued: true
description: All BackAccounts this ServiceSupplier owns.
BankAccount:
class_uri: cim:BankAccount
is_a: Document
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfCommon
description: Bank account.
attributes:
accountNumber:
slot_uri: cim:BankAccount.accountNumber
range: string
required: false
multivalued: false
description: Account reference number.
Bank:
slot_uri: cim:BankAccount.Bank
range: Bank
required: false
multivalued: false
description: Bank that provides this BankAccount.
ServiceSupplier:
slot_uri: cim:BankAccount.ServiceSupplier
range: ServiceSupplier
required: false
multivalued: false
description: ServiceSupplier that is owner of this BankAccount.
Bank:
class_uri: cim:Bank
is_a: OrganisationRole
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfCommon
description: Organisation that is a commercial bank, agency, or other institution
that offers a similar service.
attributes:
bic:
slot_uri: cim:Bank.bic
range: string
required: false
multivalued: false
description: Bank identifier code as defined in ISO 9362; for use in countries
wher IBAN is not yet in operation.
iban:
slot_uri: cim:Bank.iban
range: string
required: false
multivalued: false
description: International bank account number defined in ISO 13616; for countries
where IBAN is not in operation, the existing BIC or SWIFT codes may be used
instead (see ISO 9362).
BankAccounts:
slot_uri: cim:Bank.BankAccounts
range: BankAccount
required: false
multivalued: true
description: All BankAccounts this Bank provides.
StandardIndustryCode:
class_uri: cim:StandardIndustryCode
is_a: Document
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfCustomers
description: "The Standard Industrial Classification (SIC) are the codes that\
\ identify the type of products/service an industry is involved in, and used\
\ for statutory reporting purposes. For example, in the USA these codes are\
\ located by the federal government, and then published in a book entitled \"\
The Standard Industrial Classification Manual\". The codes are arranged in a\
\ hierarchical structure.\r\nNote that Residential Service Agreements are not\
\ classified according to the SIC codes."
attributes:
code:
slot_uri: cim:StandardIndustryCode.code
range: string
required: false
multivalued: false
description: Standard alphanumeric code assigned to a particular product/service
within an industry.
CustomerAgreements:
slot_uri: cim:StandardIndustryCode.CustomerAgreements
range: CustomerAgreement
required: false
multivalued: true
PlannedOutageNotification:
class_uri: cim:PlannedOutageNotification
is_a: Document
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Operations
description: This class will be used to generate call ahead lists for customers
who will be affected by a planned outage.
attributes:
UsagePoint:
slot_uri: cim:PlannedOutageNotification.UsagePoint
range: UsagePoint
required: false
multivalued: true
description: The Usage Point that is specified in the planned outage notification.
Customer:
slot_uri: cim:PlannedOutageNotification.Customer
range: Customer
required: false
multivalued: true
description: The customer that receives the notification
SwitchingPlan:
slot_uri: cim:PlannedOutageNotification.SwitchingPlan
range: SwitchingPlan
required: false
multivalued: false
description: The switching plan that contains the planned outage notification.
UsagePointLocation:
class_uri: cim:UsagePointLocation
is_a: Location
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
description: "Location of an individual usage point.\r\n"
attributes:
accessMethod:
slot_uri: cim:UsagePointLocation.accessMethod
range: string
required: false
multivalued: false
description: "Method for the service person to access this usage point location.\
\ For example, a description of where to obtain a key if the facility is\
\ unmanned and secured.\r\n"
remark:
slot_uri: cim:UsagePointLocation.remark
range: string
required: false
multivalued: false
description: Remarks about this location.
siteAccessProblem:
slot_uri: cim:UsagePointLocation.siteAccessProblem
range: string
required: false
multivalued: false
description: "Problems previously encountered when visiting or performing\
\ work at this location. Examples include: bad dog, violent customer, verbally\
\ abusive occupant, obstructions, safety hazards, etc.\r\n"
UsagePoints:
slot_uri: cim:UsagePointLocation.UsagePoints
range: UsagePoint
required: false
multivalued: true
description: All usage points at this location.
EnvironmentalMonitoringStation:
class_uri: cim:EnvironmentalMonitoringStation
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketCommon
description: 'An environmental monitoring station, examples of which could be
a weather station or a seismic monitoring station. '
attributes:
dstObserved:
slot_uri: cim:EnvironmentalMonitoringStation.dstObserved
range: boolean
required: false
multivalued: false
description: Whether this station is currently reporting using daylight saving
time. Intended to aid a utility Weather Service in interpreting information
coming from a station and has no direct relationship to the manner in which
time is expressed in EnvironmentalValueSet.
isNetworked:
slot_uri: cim:EnvironmentalMonitoringStation.isNetworked
range: boolean
required: false
multivalued: false
description: Indication that station is part of a network of stations used
to monitor weather phenomena covering a large geographical area.
timeZoneOffset:
slot_uri: cim:EnvironmentalMonitoringStation.timeZoneOffset
range: Minutes
required: false
multivalued: false
description: "The time offset from UTC (a.k.a. GMT) configured in the station\
\ \"clock\", not (necessarily) the time zone in which the station is physically\
\ located.\r\nThis attribute exists to support management of utility monitoring\
\ stations and has no direct relationship to the manner in which time is\
\ expressed in EnvironmentalValueSet."
Location:
slot_uri: cim:EnvironmentalMonitoringStation.Location
range: Location
required: false
multivalued: false
description: Location of this monitoring station.
UsagePoint:
slot_uri: cim:EnvironmentalMonitoringStation.UsagePoint
range: UsagePoint
required: false
multivalued: true
TimeSeries:
slot_uri: cim:EnvironmentalMonitoringStation.TimeSeries
range: TimeSeries
required: false
multivalued: true
ReportingCapability:
slot_uri: cim:EnvironmentalMonitoringStation.ReportingCapability
range: ReportingCapability
required: false
multivalued: true
description: One of the reporting capabilities of this monitoring station.
EnvironmentalAnalog:
slot_uri: cim:EnvironmentalMonitoringStation.EnvironmentalAnalog
range: EnvironmentalAnalog
required: false
multivalued: true
description: Environmental analog measurement provided by this monitoring
station.
TimeSeries:
class_uri: cim:TimeSeries
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketManagement
description: A set of regular time-ordered measurements or values of quantitative
nature of an individual or collective phenomenon taken at successive, in most
cases equidistant, periods / points of time.
attributes:
businessType:
slot_uri: cim:TimeSeries.businessType
range: string
required: false
multivalued: false
description: The identification of the nature of the time series.
cancelledTS:
slot_uri: cim:TimeSeries.cancelledTS
range: string
required: false
multivalued: false
description: An indicator stating that the TimeSeries, identified by the mRID,
is cancelled as well as all the values sent in a previous version of the
TimeSeries in a previous document.
curveType:
slot_uri: cim:TimeSeries.curveType
range: string
required: false
multivalued: false
description: "The coded representation of the type of curve being described.\r\
\n"
objectAggregation:
slot_uri: cim:TimeSeries.objectAggregation
range: string
required: false
multivalued: false
description: Identification of the object that is the common denominator used
to aggregate a time series.
product:
slot_uri: cim:TimeSeries.product
range: string
required: false
multivalued: false
description: "The type of the product such as Power, energy, reactive power,\
\ transport capacity that is the subject of the time series.\r\n"
version:
slot_uri: cim:TimeSeries.version
range: string
required: false
multivalued: false
description: "Version of the time series.\r\n"
FlowDirection:
slot_uri: cim:TimeSeries.FlowDirection
range: FlowDirection
required: false
multivalued: true
MarketParticipant:
slot_uri: cim:TimeSeries.MarketParticipant
range: MarketParticipant
required: false
multivalued: true
DateAndOrTime:
slot_uri: cim:TimeSeries.DateAndOrTime
range: DateAndOrTime
required: false
multivalued: true
EnvironmentalMonitoringStation:
slot_uri: cim:TimeSeries.EnvironmentalMonitoringStation
range: EnvironmentalMonitoringStation
required: false
multivalued: true
Period:
slot_uri: cim:TimeSeries.Period
range: Period
required: false
multivalued: true
Domain:
slot_uri: cim:TimeSeries.Domain
range: Domain
required: false
multivalued: true
MarketDocument:
slot_uri: cim:TimeSeries.MarketDocument
range: MarketDocument
required: false
multivalued: true
MarketEvaluationPoint:
slot_uri: cim:TimeSeries.MarketEvaluationPoint
range: MarketEvaluationPoint
required: false
multivalued: true
Reason:
slot_uri: cim:TimeSeries.Reason
range: Reason
required: false
multivalued: true
ConstraintDuration:
slot_uri: cim:TimeSeries.ConstraintDuration
range: ConstraintDuration
required: false
multivalued: true
AttributeInstanceComponent:
slot_uri: cim:TimeSeries.AttributeInstanceComponent
range: AttributeInstanceComponent
required: false
multivalued: true
Unit:
slot_uri: cim:TimeSeries.Unit
range: Unit
required: false
multivalued: true
Price:
slot_uri: cim:TimeSeries.Price
range: Price
required: false
multivalued: true
Auction:
slot_uri: cim:TimeSeries.Auction
range: Auction
required: false
multivalued: true
MktPSRType:
slot_uri: cim:TimeSeries.MktPSRType
range: MktPSRType
required: false
multivalued: true
Quantity:
slot_uri: cim:TimeSeries.Quantity
range: Quantity
required: false
multivalued: true
RegisteredResource:
slot_uri: cim:TimeSeries.RegisteredResource
range: RegisteredResource
required: false
multivalued: true
MarketObjectStatus:
slot_uri: cim:TimeSeries.MarketObjectStatus
range: MarketObjectStatus
required: false
multivalued: true
Point:
slot_uri: cim:TimeSeries.Point
range: Point
required: false
multivalued: true
ConstraintDuration:
class_uri: cim:ConstraintDuration
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketManagement
description: Duration constraint to activate, to put in operation, to deactivate,
... a given event.
attributes:
duration:
slot_uri: cim:ConstraintDuration.duration
range: integer
required: false
multivalued: false
description: The duration of the constraint.
type:
slot_uri: cim:ConstraintDuration.type
range: string
required: false
multivalued: false
description: The type of the constraint.
TimeSeries:
slot_uri: cim:ConstraintDuration.TimeSeries
range: TimeSeries
required: false
multivalued: true
AttributeInstanceComponent:
class_uri: cim:AttributeInstanceComponent
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketManagement
description: 'A class used to provide information about an attribute. '
attributes:
attribute:
slot_uri: cim:AttributeInstanceComponent.attribute
range: string
required: false
multivalued: false
description: The identification of the formal name of an attribute.
attributeValue:
slot_uri: cim:AttributeInstanceComponent.attributeValue
range: string
required: false
multivalued: false
description: The instance value of the attribute.
position:
slot_uri: cim:AttributeInstanceComponent.position
range: integer
required: false
multivalued: false
description: A sequential value representing a relative sequence number.
TimeSeries:
slot_uri: cim:AttributeInstanceComponent.TimeSeries
range: TimeSeries
required: false
multivalued: true
MarketDocument:
slot_uri: cim:AttributeInstanceComponent.MarketDocument
range: MarketDocument
required: false
multivalued: true
MarketDocument:
class_uri: cim:MarketDocument
is_a: Document
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketManagement
description: 'Electronic document containing the information necessary to satisfy
a given business process set of requirements. '
attributes:
Period:
slot_uri: cim:MarketDocument.Period
range: Period
required: false
multivalued: true
SelfMarketDocument:
slot_uri: cim:MarketDocument.SelfMarketDocument
range: MarketDocument
required: false
multivalued: true
AttributeInstanceComponent:
slot_uri: cim:MarketDocument.AttributeInstanceComponent
range: AttributeInstanceComponent
required: false
multivalued: true
Domain:
slot_uri: cim:MarketDocument.Domain
range: Domain
required: false
multivalued: true
Process:
slot_uri: cim:MarketDocument.Process
range: Process
required: false
multivalued: true
AceTariffType:
slot_uri: cim:MarketDocument.AceTariffType
range: AceTariffType
required: false
multivalued: true
MarketParticipant:
slot_uri: cim:MarketDocument.MarketParticipant
range: MarketParticipant
required: false
multivalued: true
MarketDocument:
slot_uri: cim:MarketDocument.MarketDocument
range: MarketDocument
required: false
multivalued: true
TimeSeries:
slot_uri: cim:MarketDocument.TimeSeries
range: TimeSeries
required: false
multivalued: true
Reason:
slot_uri: cim:MarketDocument.Reason
range: Reason
required: false
multivalued: true
DateAndOrTime:
slot_uri: cim:MarketDocument.DateAndOrTime
range: DateAndOrTime
required: false
multivalued: true
Process:
class_uri: cim:Process
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketManagement
description: "The formal specification of a set of business transactions having\
\ the same business goal.\r\n"
attributes:
classificationType:
slot_uri: cim:Process.classificationType
range: string
required: false
multivalued: false
description: "The classification mechanism used to group a set of objects\
\ together within a business process. The grouping may be of a detailed\
\ or a summary nature.\r\n"
processType:
slot_uri: cim:Process.processType
range: string
required: false
multivalued: false
description: "The kind of business process.\r\n"
MarketDocument:
slot_uri: cim:Process.MarketDocument
range: MarketDocument
required: false
multivalued: true
AceTariffType:
class_uri: cim:AceTariffType
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketManagement
description: The Area Control Error tariff type that is applied or used.
attributes:
type:
slot_uri: cim:AceTariffType.type
range: string
required: false
multivalued: false
description: The coded type of an ACE tariff.
MarketDocument:
slot_uri: cim:AceTariffType.MarketDocument
range: MarketDocument
required: false
multivalued: true
Unit:
slot_uri: cim:AceTariffType.Unit
range: Unit
required: false
multivalued: true
Point:
slot_uri: cim:AceTariffType.Point
range: Point
required: false
multivalued: true
Point:
class_uri: cim:Point
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketManagement
description: An identification of a set of values beeing adressed within a specific
interval of time.
attributes:
position:
slot_uri: cim:Point.position
range: integer
required: false
multivalued: false
description: "A sequential value representing the relative position within\
\ a given time interval.\r\n"
quality:
slot_uri: cim:Point.quality
range: string
required: false
multivalued: false
description: The quality of the information being provided. This quality may
be estimated, not available, as provided, etc.
quantity:
slot_uri: cim:Point.quantity
range: double
required: false
multivalued: false
description: Principal quantity identified for a point.
secondaryQuantity:
slot_uri: cim:Point.secondaryQuantity
range: double
required: false
multivalued: false
description: Secondary quantity identified for a point.
Period:
slot_uri: cim:Point.Period
range: Period
required: true
multivalued: false
AceTariffType:
slot_uri: cim:Point.AceTariffType
range: AceTariffType
required: false
multivalued: true
TimeSeries:
slot_uri: cim:Point.TimeSeries
range: TimeSeries
required: false
multivalued: true
Reason:
slot_uri: cim:Point.Reason
range: Reason
required: false
multivalued: true
Quantity:
slot_uri: cim:Point.Quantity
range: Quantity
required: false
multivalued: true
FlowDirection:
slot_uri: cim:Point.FlowDirection
range: FlowDirection
required: false
multivalued: true
Price:
slot_uri: cim:Point.Price
range: Price
required: false
multivalued: true
Reason:
class_uri: cim:Reason
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketManagement
description: "The motivation of an act.\r\n"
attributes:
code:
slot_uri: cim:Reason.code
range: string
required: false
multivalued: false
description: "The motivation of an act in coded form.\r\n"
text:
slot_uri: cim:Reason.text
range: string
required: false
multivalued: false
description: "The textual explanation corresponding to the reason code.\r\n"
Point:
slot_uri: cim:Reason.Point
range: Point
required: false
multivalued: true
MarketDocument:
slot_uri: cim:Reason.MarketDocument
range: MarketDocument
required: false
multivalued: true
RegisteredResource:
slot_uri: cim:Reason.RegisteredResource
range: RegisteredResource
required: false
multivalued: true
Period:
slot_uri: cim:Reason.Period
range: Period
required: false
multivalued: true
TimeSeries:
slot_uri: cim:Reason.TimeSeries
range: TimeSeries
required: false
multivalued: true
RegisteredResource:
class_uri: cim:RegisteredResource
is_a: PowerSystemResource
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketCommon
description: A resource that is registered through the market participant registration
system. Examples include generating unit, load, and non-physical generator or
load.
attributes:
ACAFlag:
slot_uri: cim:RegisteredResource.ACAFlag
range: YesNo
required: false
multivalued: false
description: "Indication that this resource is associated with an Adjacent\
\ Control Area.\r\n"
ASSPOptimizationFlag:
slot_uri: cim:RegisteredResource.ASSPOptimizationFlag
range: YesNo
required: false
multivalued: false
description: "Indication that the resource participates in the optimization\
\ process by default.\r\n"
commercialOpDate:
slot_uri: cim:RegisteredResource.commercialOpDate
range: date
required: false
multivalued: false
description: "Resource Commercial Operation Date. \r\n"
contingencyAvailFlag:
slot_uri: cim:RegisteredResource.contingencyAvailFlag
range: YesNo
required: false
multivalued: false
description: "Contingent operating reserve availiability (Yes/No). Resource\
\ is availiable to participate with capacity in contingency dispatch.\r\n"
dispatchable:
slot_uri: cim:RegisteredResource.dispatchable
range: boolean
required: false
multivalued: false
description: 'Dispatchable: indicates whether the resource is dispatchable.
This implies that the resource intends to submit Energy bids/offers or Ancillary
Services bids/offers, or self-provided schedules.'
ECAFlag:
slot_uri: cim:RegisteredResource.ECAFlag
range: YesNo
required: false
multivalued: false
description: "Indication that this resource is associated with an Embedded\
\ Control area.\r\n"
flexibleOfferFlag:
slot_uri: cim:RegisteredResource.flexibleOfferFlag
range: YesNo
required: false
multivalued: false
description: "Flexible offer flag (Y/N).\r\n"
hourlyPredispatch:
slot_uri: cim:RegisteredResource.hourlyPredispatch
range: YesNo
required: false
multivalued: false
description: "Indicates need to dispatch before the start of the operating\
\ hour. Only relevant in Real-Time Market. Applies to generation, intertie\
\ and participating load resource. Value (Y/N).\r\n"
isAggregatedRes:
slot_uri: cim:RegisteredResource.isAggregatedRes
range: YesNo
required: false
multivalued: false
description: "A flag to indicate if a resource is an aggregated resource.\r\
\n"
lastModified:
slot_uri: cim:RegisteredResource.lastModified
range: date
required: false
multivalued: false
description: "Indication of the last time this item was modified/versioned.\r\
\n"
LMPMFlag:
slot_uri: cim:RegisteredResource.LMPMFlag
range: YesNo
required: false
multivalued: false
description: "LMPM flag: indicates whether the resource is subject to the\
\ LMPM test (Yes/No).\r\n"
marketParticipationFlag:
slot_uri: cim:RegisteredResource.marketParticipationFlag
range: YesNo
required: false
multivalued: false
description: 'Market Participation flag: indicates whether the resource participate
in the market.'
'maxBaseSelfSchedQty ':
slot_uri: cim:RegisteredResource.maxBaseSelfSchedQty%20
range: float
required: false
multivalued: false
description: "Maximum base self schedule quantity.\r\n"
maxOnTime:
slot_uri: cim:RegisteredResource.maxOnTime
range: float
required: false
multivalued: false
description: "Maximum on time after start up.\r\n"
minDispatchTime:
slot_uri: cim:RegisteredResource.minDispatchTime
range: Hours
required: false
multivalued: false
description: 'Minimum number of consecutive hours a resource shall be dispatched
if bid is accepted. '
minOffTime:
slot_uri: cim:RegisteredResource.minOffTime
range: float
required: false
multivalued: false
description: "Minimum off time after shut down.\r\n"
minOnTime:
slot_uri: cim:RegisteredResource.minOnTime
range: float
required: false
multivalued: false
description: "Minimum on time after start up.\r\n"
mustOfferFlag:
slot_uri: cim:RegisteredResource.mustOfferFlag
range: YesNo
required: false
multivalued: false
description: "Must offer flag: indicates whether the unit is subject to the\
\ must offer provisions (Y/N).\r\n"
nonMarket:
slot_uri: cim:RegisteredResource.nonMarket
range: YesNo
required: false
multivalued: false
description: "Flag to indicate that the Resource is not participating in the\
\ Market Operations.\r\n"
pointOfDeliveryFlag:
slot_uri: cim:RegisteredResource.pointOfDeliveryFlag
range: YesNo
required: false
multivalued: false
description: "Indication that the registered resource is a Point of Delivery\
\ (YES) resource which implies there is a POD Loss Factor.\r\n"
priceSetFlagDA:
slot_uri: cim:RegisteredResource.priceSetFlagDA
range: YesNo
required: false
multivalued: false
description: "Price setting flag: indicates whether a resource is capable\
\ of setting the Market Clearing Price (Y) for the DA market, and if not,\
\ indicates whether the resource shall submit bids for energy at $ 0 (S)\
\ or not (N).\r\n\r\nInitially in the RegisteredGenerator class. It was\
\ moved to the RegisteredResource class for the participating load dispatch\
\ purpose."
priceSetFlagRT:
slot_uri: cim:RegisteredResource.priceSetFlagRT
range: YesNo
required: false
multivalued: false
description: "Price setting flag: indicates whether a resource is capable\
\ of setting the Market Clearing Price (Y) for the RT market, and if not,\
\ indicates whether the resource shall submit bids for energy at $ 0 (S)\
\ or not (N).\r\n\r\nInitially in the RegisteredGenerator class. It was\
\ moved to the RegisteredResource class for the participating load dispatch\
\ purpose."
registrationStatus:
slot_uri: cim:RegisteredResource.registrationStatus
range: ResourceRegistrationStatus
required: false
multivalued: false
description: "Registration Status of resource - Active, Mothballed, Planned,\
\ or Decommissioned.\r\n"
resourceAdequacyFlag:
slot_uri: cim:RegisteredResource.resourceAdequacyFlag
range: YesNo
required: false
multivalued: false
description: "Indication that this resource participates in the resource adequacy\
\ function.\r\n"
SMPMFlag:
slot_uri: cim:RegisteredResource.SMPMFlag
range: YesNo
required: false
multivalued: false
description: "SMPM flag: indicates whether the resource is subject to the\
\ SMPM test (Yes/No).\r\n"
DopInstruction:
slot_uri: cim:RegisteredResource.DopInstruction
range: DopInstruction
required: false
multivalued: true
ResourceGroups:
slot_uri: cim:RegisteredResource.ResourceGroups
range: ResourceGroup
required: false
multivalued: true
ResourceCertification:
slot_uri: cim:RegisteredResource.ResourceCertification
range: ResourceCertification
required: false
multivalued: true
MktConnectivityNode:
slot_uri: cim:RegisteredResource.MktConnectivityNode
range: MktConnectivityNode
required: false
multivalued: false
InterTie:
slot_uri: cim:RegisteredResource.InterTie
range: SchedulingPoint
required: false
multivalued: true
FormerReference:
slot_uri: cim:RegisteredResource.FormerReference
range: FormerReference
required: false
multivalued: true
IntermittentResourceEligibility:
slot_uri: cim:RegisteredResource.IntermittentResourceEligibility
range: IntermittentResourceEligibility
required: false
multivalued: true
ResourceCapacity:
slot_uri: cim:RegisteredResource.ResourceCapacity
range: ResourceCapacity
required: false
multivalued: true
Reason:
slot_uri: cim:RegisteredResource.Reason
range: Reason
required: false
multivalued: true
ExpectedEnergyValues:
slot_uri: cim:RegisteredResource.ExpectedEnergyValues
range: ExpectedEnergyValues
required: false
multivalued: true
ResourceAncillaryServiceQualification:
slot_uri: cim:RegisteredResource.ResourceAncillaryServiceQualification
range: ResourceCertification
required: false
multivalued: true
description: RegisteredResources are qualified for resource ancillary service
types (which include market product types as well as other types such as
BlackStart) by the association to the class ResourceAncillaryServiceQualification.
ResourceLoadFollowingInst:
slot_uri: cim:RegisteredResource.ResourceLoadFollowingInst
range: ResourceLoadFollowingInst
required: false
multivalued: true
LoadFollowingInst:
slot_uri: cim:RegisteredResource.LoadFollowingInst
range: LoadFollowingInst
required: false
multivalued: true
AllocationResultValues:
slot_uri: cim:RegisteredResource.AllocationResultValues
range: AllocationResultValues
required: false
multivalued: true
RUCAwardInstruction:
slot_uri: cim:RegisteredResource.RUCAwardInstruction
range: RUCAwardInstruction
required: false
multivalued: true
MPMResourceStatus:
slot_uri: cim:RegisteredResource.MPMResourceStatus
range: MPMResourceStatus
required: false
multivalued: true
Commitments:
slot_uri: cim:RegisteredResource.Commitments
range: Commitments
required: false
multivalued: true
MarketParticipant:
slot_uri: cim:RegisteredResource.MarketParticipant
range: MarketParticipant
required: false
multivalued: false
SubControlArea:
slot_uri: cim:RegisteredResource.SubControlArea
range: SubControlArea
required: false
multivalued: true
AdjacentCASet:
slot_uri: cim:RegisteredResource.AdjacentCASet
range: AdjacentCASet
required: false
multivalued: false
SubstitutionResourceList:
slot_uri: cim:RegisteredResource.SubstitutionResourceList
range: SubstitutionResourceList
required: false
multivalued: true
ResourceDispatchResults:
slot_uri: cim:RegisteredResource.ResourceDispatchResults
range: ResourceDispatchResults
required: false
multivalued: true
RMROperatorInput:
slot_uri: cim:RegisteredResource.RMROperatorInput
range: RMROperatorInput
required: false
multivalued: true
OrgResOwnership:
slot_uri: cim:RegisteredResource.OrgResOwnership
range: OrgResOwnership
required: false
multivalued: true
ContractDistributionFactor:
slot_uri: cim:RegisteredResource.ContractDistributionFactor
range: ContractDistributionFactor
required: false
multivalued: true
RampRateCurve:
slot_uri: cim:RegisteredResource.RampRateCurve
range: RampRateCurve
required: false
multivalued: true
TimeSeries:
slot_uri: cim:RegisteredResource.TimeSeries
range: TimeSeries
required: false
multivalued: true
DispatchInstReply:
slot_uri: cim:RegisteredResource.DispatchInstReply
range: DispatchInstReply
required: false
multivalued: true
AggregateNode:
slot_uri: cim:RegisteredResource.AggregateNode
range: AggregateNode
required: false
multivalued: false
description: An AggregateNode may be associated with up to many RegisteredResources.
ForbiddenRegion:
slot_uri: cim:RegisteredResource.ForbiddenRegion
range: ForbiddenRegion
required: false
multivalued: true
DotInstruction:
slot_uri: cim:RegisteredResource.DotInstruction
range: DotInstruction
required: false
multivalued: true
EnergyMarkets:
slot_uri: cim:RegisteredResource.EnergyMarkets
range: EnergyMarket
required: false
multivalued: true
Domain:
slot_uri: cim:RegisteredResource.Domain
range: Domain
required: false
multivalued: true
Instructions:
slot_uri: cim:RegisteredResource.Instructions
range: Instructions
required: false
multivalued: true
HostControlArea:
slot_uri: cim:RegisteredResource.HostControlArea
range: HostControlArea
required: false
multivalued: false
Pnode:
slot_uri: cim:RegisteredResource.Pnode
range: Pnode
required: false
multivalued: false
description: A registered resource injects power at one or more connectivity
nodes related to a pnode
ExPostResourceResults:
slot_uri: cim:RegisteredResource.ExPostResourceResults
range: ExPostResourceResults
required: false
multivalued: true
ResourceAwardInstruction:
slot_uri: cim:RegisteredResource.ResourceAwardInstruction
range: ResourceAwardInstruction
required: false
multivalued: true
MPMTestThreshold:
slot_uri: cim:RegisteredResource.MPMTestThreshold
range: MPMTestThreshold
required: false
multivalued: true
LoadFollowingOperatorInput:
slot_uri: cim:RegisteredResource.LoadFollowingOperatorInput
range: LoadFollowingOperatorInput
required: false
multivalued: true
ControlAreaDesignation:
slot_uri: cim:RegisteredResource.ControlAreaDesignation
range: ControlAreaDesignation
required: false
multivalued: true
MarketObjectStatus:
slot_uri: cim:RegisteredResource.MarketObjectStatus
range: MarketObjectStatus
required: false
multivalued: true
DefaultBid:
slot_uri: cim:RegisteredResource.DefaultBid
range: DefaultBid
required: false
multivalued: false
ResourceVerifiableCosts:
slot_uri: cim:RegisteredResource.ResourceVerifiableCosts
range: ResourceVerifiableCosts
required: false
multivalued: false
DotInstruction:
class_uri: cim:DotInstruction
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: "Provides the necessary information (on a resource basis) to capture\
\ the Dispatch Operating Target (DOT) results on a Dispatch interval. This information\
\ is only relevant to the RT interval market.\r\n"
attributes:
actualRampRate:
slot_uri: cim:DotInstruction.actualRampRate
range: float
required: false
multivalued: false
description: "Actual ramp rate.\r\n"
compliantIndicator:
slot_uri: cim:DotInstruction.compliantIndicator
range: YesNo
required: false
multivalued: false
description: "Flag indicating whether or not the resource was in compliance\
\ with the instruction (plus/minus 10%).\r\n\r\nDirects if a unit is allowed\
\ to set the price (ex-post pricing).\r\n"
DOT:
slot_uri: cim:DotInstruction.DOT
range: float
required: false
multivalued: false
description: "Dispatch operating target value.\r\n"
economicMaxOverride:
slot_uri: cim:DotInstruction.economicMaxOverride
range: float
required: false
multivalued: false
description: "Economic Max Limit override for unit, this value is null, if\
\ it is not, this value overrides the Energy column value. \r\nAllows dispatcher\
\ to override the unit's energy value.\r\n"
expectedEnergy:
slot_uri: cim:DotInstruction.expectedEnergy
range: float
required: false
multivalued: false
description: "Expected energy.\r\n"
generatorPerformanceDegree:
slot_uri: cim:DotInstruction.generatorPerformanceDegree
range: float
required: false
multivalued: false
description: "The Degree of Generator Performance (DGP) used for the unit.\
\ Measure of how a generator responds to raise /lower signals. Calculated\
\ every five minutes.\r\n"
hourAheadSchedEnergy:
slot_uri: cim:DotInstruction.hourAheadSchedEnergy
range: float
required: false
multivalued: false
description: "HASP results.\r\n"
hourlySchedule:
slot_uri: cim:DotInstruction.hourlySchedule
range: float
required: false
multivalued: false
description: "Hourly Schedule (DA Energy Schedule).\r\n"
instructionTime:
slot_uri: cim:DotInstruction.instructionTime
range: date
required: false
multivalued: false
description: "The date/time for the instruction.\r\n"
maximumEmergencyInd:
slot_uri: cim:DotInstruction.maximumEmergencyInd
range: boolean
required: false
multivalued: false
description: "True if maximum emergency limit activated; false otherwise.\
\ If unit is requested to move up to its max emergency limit., this flag\
\ is set to true.\r\n"
meterLoadFollowing:
slot_uri: cim:DotInstruction.meterLoadFollowing
range: float
required: false
multivalued: false
description: "Meter Sub System Load Following. \r\n"
nonRampRestrictedMW:
slot_uri: cim:DotInstruction.nonRampRestrictedMW
range: float
required: false
multivalued: false
description: "Desired MW that is not ramp restricted. If no ramp rate limit\
\ existed for the unit, this is the MW value tha t the unit was requested\
\ to move to.\r\n"
nonSpinReserve:
slot_uri: cim:DotInstruction.nonSpinReserve
range: float
required: false
multivalued: false
description: "Non Spin Reserve used to procure energy.\r\n"
previousDOTTimeStamp:
slot_uri: cim:DotInstruction.previousDOTTimeStamp
range: date
required: false
multivalued: false
description: "Timestamp when the previous DOT value was issued.\r\n"
rampRateLimit:
slot_uri: cim:DotInstruction.rampRateLimit
range: float
required: false
multivalued: false
description: "The ramp rate limit for the unit in MWs per minute. Participant\
\ bidding data.\r\n"
regulationStatus:
slot_uri: cim:DotInstruction.regulationStatus
range: YesNo
required: false
multivalued: false
description: "Regulation Status (Yes/No).\r\n"
spinReserve:
slot_uri: cim:DotInstruction.spinReserve
range: float
required: false
multivalued: false
description: "Spin Reserve used to procure energy.\r\n"
standardRampEnergy:
slot_uri: cim:DotInstruction.standardRampEnergy
range: float
required: false
multivalued: false
description: "Standard ramping energy (MWH).\r\n"
supplementalEnergy:
slot_uri: cim:DotInstruction.supplementalEnergy
range: float
required: false
multivalued: false
description: "Supplemental Energy procure by Real Time Dispatch.\r\n"
unitStatus:
slot_uri: cim:DotInstruction.unitStatus
range: integer
required: false
multivalued: false
description: "Output results from the case identifying the reason the unit\
\ was committed by the software.\r\n"
RegisteredResource:
slot_uri: cim:DotInstruction.RegisteredResource
range: RegisteredResource
required: false
multivalued: false
InstructionClearingDOT:
slot_uri: cim:DotInstruction.InstructionClearingDOT
range: InstructionClearingDOT
required: true
multivalued: true
InstructionClearingDOT:
class_uri: cim:InstructionClearingDOT
is_a: MarketFactors
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: "Model of market clearing, related to Dispatch Operating Target (model\
\ of anticipatory dispatch). Identifies interval.\r\n"
attributes:
contingencyActive:
slot_uri: cim:InstructionClearingDOT.contingencyActive
range: YesNo
required: false
multivalued: false
description: Indication that the system is currently operating in a contingency
mode.
dispatchMode:
slot_uri: cim:InstructionClearingDOT.dispatchMode
range: AutomaticDispatchMode
required: false
multivalued: false
DotInstruction:
slot_uri: cim:InstructionClearingDOT.DotInstruction
range: DotInstruction
required: true
multivalued: true
DemandResponseActualEvent:
slot_uri: cim:InstructionClearingDOT.DemandResponseActualEvent
range: DistributedResourceActualEvent
required: false
multivalued: false
MarketFactors:
class_uri: cim:MarketFactors
is_a: Document
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketPlan
description: Aggregation of market information relative for a specific time interval.
attributes:
intervalEndTime:
slot_uri: cim:MarketFactors.intervalEndTime
range: date
required: false
multivalued: false
description: "The end of the time interval for which requirement is defined.\r\
\n"
intervalStartTime:
slot_uri: cim:MarketFactors.intervalStartTime
range: date
required: false
multivalued: false
description: "The start of the time interval for which requirement is defined.\r\
\n"
MktActivityRecord:
slot_uri: cim:MarketFactors.MktActivityRecord
range: MktActivityRecord
required: false
multivalued: true
Market:
slot_uri: cim:MarketFactors.Market
range: Market
required: false
multivalued: false
MktActivityRecord:
class_uri: cim:MktActivityRecord
is_a: ActivityRecord
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketOpCommon
description: 'Subclass of IEC61968: Common:ActivityRecord.'
attributes:
MarketFactors:
slot_uri: cim:MktActivityRecord.MarketFactors
range: MarketFactors
required: false
multivalued: true
Market:
class_uri: cim:Market
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketPlan
description: Market (e.g. Day Ahead Market, Real Time Market) with a description
of the Market operation control parameters.
attributes:
actualEnd:
slot_uri: cim:Market.actualEnd
range: date
required: false
multivalued: false
description: "Market ending time - actual market end\r\n"
actualStart:
slot_uri: cim:Market.actualStart
range: date
required: false
multivalued: false
description: "Market starting time - actual market start\r\n"
dst:
slot_uri: cim:Market.dst
range: boolean
required: false
multivalued: false
description: "True if daylight savings time (DST) is in effect.\r\n"
end:
slot_uri: cim:Market.end
range: date
required: false
multivalued: false
description: "Market end time.\r\n"
localTimeZone:
slot_uri: cim:Market.localTimeZone
range: string
required: false
multivalued: false
description: "Local time zone.\r\n"
start:
slot_uri: cim:Market.start
range: date
required: false
multivalued: false
description: "Market start time.\r\n"
status:
slot_uri: cim:Market.status
range: string
required: false
multivalued: false
description: "Market Status \r\n'OPEN', 'CLOSED', 'CLEARED', 'BLOCKED'\r\n"
timeIntervalLength:
slot_uri: cim:Market.timeIntervalLength
range: float
required: false
multivalued: false
description: "Trading time interval length.\r\n"
tradingDay:
slot_uri: cim:Market.tradingDay
range: date
required: false
multivalued: false
description: "Market trading date\r\n"
tradingPeriod:
slot_uri: cim:Market.tradingPeriod
range: string
required: false
multivalued: false
description: "Trading period that describes the market, possibilities could\
\ be for an Energy Market:\r\nDay\r\nHour\r\n\r\nFor a CRR Market:\r\nYear\r\
\nMonth\r\nSeason"
MarketRun:
slot_uri: cim:Market.MarketRun
range: MarketRun
required: false
multivalued: true
MarketProducts:
slot_uri: cim:Market.MarketProducts
range: MarketProduct
required: true
multivalued: true
MarketFactors:
slot_uri: cim:Market.MarketFactors
range: MarketFactors
required: false
multivalued: true
MarketRun:
class_uri: cim:MarketRun
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketPlan
description: This class represents an actual instance of a planned market. For
example, a Day Ahead market opens with the Bid Submission, ends with the closing
of the Bid Submission. The market run represent the whole process. MarketRuns
can be defined for markets such as Day Ahead Market, Real Time Market, Hour
Ahead Market, Week Ahead Market, etc.
attributes:
executionType:
slot_uri: cim:MarketRun.executionType
range: ExecutionType
required: false
multivalued: false
description: "The execution type; Day Ahead, Intra Day, Real Time Pre-Dispatch,\
\ Real Time Dispatch\r\n"
marketApprovalTime:
slot_uri: cim:MarketRun.marketApprovalTime
range: date
required: false
multivalued: false
description: "Approved time for case. Identifies the time that the dispatcher\
\ approved a specific real time unit dispatch case\r\n"
marketApprovedStatus:
slot_uri: cim:MarketRun.marketApprovedStatus
range: boolean
required: false
multivalued: false
description: "Set to true when the plan is approved by authority and becomes\
\ the official plan for the day ahead market. Identifies the approved case\
\ for the market for the specified time interval.\r\n"
marketEndTime:
slot_uri: cim:MarketRun.marketEndTime
range: date
required: false
multivalued: false
description: "The end time defined as the end of the market, market end time.\r\
\n"
marketStartTime:
slot_uri: cim:MarketRun.marketStartTime
range: date
required: false
multivalued: false
description: "The start time defined as the beginning of the market, market\
\ start time.\r\n"
marketType:
slot_uri: cim:MarketRun.marketType
range: MarketType
required: false
multivalued: false
description: "The market type, Day Ahead Market or Real Time Market.\r\n"
reportedState:
slot_uri: cim:MarketRun.reportedState
range: string
required: false
multivalued: false
description: "This is the state of market run activity as reported by market\
\ systems to the market definition services.\r\n"
runState:
slot_uri: cim:MarketRun.runState
range: string
required: false
multivalued: false
description: "This is the state controlled by market defintion service.\r\n\
Possible values could be but not limited by: Open, Close.\r\n"
Market:
slot_uri: cim:MarketRun.Market
range: Market
required: true
multivalued: false
MarketActualEvent:
slot_uri: cim:MarketRun.MarketActualEvent
range: MarketActualEvent
required: true
multivalued: true
description: All actual events that trigger this market run.
PlannedMarket:
slot_uri: cim:MarketRun.PlannedMarket
range: PlannedMarket
required: true
multivalued: false
description: A planned market could have multiple market runs for the reason
that a planned market could have a rerun.
MarketActualEvent:
class_uri: cim:MarketActualEvent
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketPlan
description: This class represents the actual instance of an event.
attributes:
eventComments:
slot_uri: cim:MarketActualEvent.eventComments
range: string
required: true
multivalued: false
description: Free format comments for the event, for any purpose needed.
eventEndTime:
slot_uri: cim:MarketActualEvent.eventEndTime
range: date
required: false
multivalued: false
description: End time of the event.
eventStartTime:
slot_uri: cim:MarketActualEvent.eventStartTime
range: date
required: false
multivalued: false
description: Start time of the event.
eventStatus:
slot_uri: cim:MarketActualEvent.eventStatus
range: MarketEventStatusKind
required: true
multivalued: false
description: Event status, e.g. active, canceled, expired, etc.
eventType:
slot_uri: cim:MarketActualEvent.eventType
range: string
required: true
multivalued: false
description: Actual event type.
PlannedMarketEvent:
slot_uri: cim:MarketActualEvent.PlannedMarketEvent
range: PlannedMarketEvent
required: false
multivalued: false
description: Planned event executed by this actual event.
MarketRun:
slot_uri: cim:MarketActualEvent.MarketRun
range: MarketRun
required: false
multivalued: false
description: 'Market run triggered by this actual event. For example, the
DA market run is triggered by the actual open bid submission event and terminated
by the actual execution and completion of the DA market run captured by
the runState of the MarketRun. '
PlannedMarketEvent:
class_uri: cim:PlannedMarketEvent
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketPlan
description: This class represents planned events. Used to model the various planned
events in a market (closing time, clearing time, etc.)
attributes:
eventType:
slot_uri: cim:PlannedMarketEvent.eventType
range: string
required: false
multivalued: false
description: "Planned event type.\r\n"
plannedTime:
slot_uri: cim:PlannedMarketEvent.plannedTime
range: integer
required: false
multivalued: false
description: "This is relative time so that this attribute can be used by\
\ more than one planned market. For example the bid submission is 10am everyday.\r\
\n"
PlannedMarket:
slot_uri: cim:PlannedMarketEvent.PlannedMarket
range: PlannedMarket
required: false
multivalued: true
description: A planned market shall have a set of planned events
MarketActualEvent:
slot_uri: cim:PlannedMarketEvent.MarketActualEvent
range: MarketActualEvent
required: true
multivalued: true
description: All actual events that execute this planned event.
PlannedMarket:
class_uri: cim:PlannedMarket
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketPlan
description: Represent a planned market. For example a planned DA/HA/RT market.
attributes:
marketEndTime:
slot_uri: cim:PlannedMarket.marketEndTime
range: date
required: false
multivalued: false
description: "Market end time.\r\n"
marketStartTime:
slot_uri: cim:PlannedMarket.marketStartTime
range: date
required: false
multivalued: false
description: "Market start time.\r\n"
marketType:
slot_uri: cim:PlannedMarket.marketType
range: MarketType
required: false
multivalued: false
description: "Market type.\r\n"
PlannedMarketEvent:
slot_uri: cim:PlannedMarket.PlannedMarketEvent
range: PlannedMarketEvent
required: true
multivalued: true
description: A planned market shall have a set of planned events
MarketRun:
slot_uri: cim:PlannedMarket.MarketRun
range: MarketRun
required: false
multivalued: true
description: A planned market could have multiple market runs for the reason
that a planned market could have a rerun.
MarketPlan:
slot_uri: cim:PlannedMarket.MarketPlan
range: MarketPlan
required: true
multivalued: false
description: A market plan has a number of markets (DA, HA, RT).
MarketPlan:
class_uri: cim:MarketPlan
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketPlan
description: This class identifies a set of planned markets.
attributes:
tradingDay:
slot_uri: cim:MarketPlan.tradingDay
range: date
required: false
multivalued: false
description: "Planned market trading day.\r\n"
PlannedMarket:
slot_uri: cim:MarketPlan.PlannedMarket
range: PlannedMarket
required: true
multivalued: true
description: A market plan has a number of markets (DA, HA, RT).
MarketProduct:
class_uri: cim:MarketProduct
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketPlan
description: 'A product traded by an RTO (e.g. energy, 10 minute spinning reserve). Ancillary
service product examples include: Regulation, Regulation Up, Regulation Down,
Spinning Reserve, Non-Spinning Reserve, etc.'
attributes:
marketProductType:
slot_uri: cim:MarketProduct.marketProductType
range: MarketProductType
required: false
multivalued: false
description: "Market product type examples:\r\n\r\nEN (Energy)\r\nRU (Regulation\
\ Up)\r\nRD (Regulation Dn)\r\nSR (Spinning Reserve)\r\nNR (Non-Spinning\
\ Reserve)\r\nRC (RUC)\r\n"
rampInterval:
slot_uri: cim:MarketProduct.rampInterval
range: float
required: false
multivalued: false
description: Ramping time interval for the specific market product type specified
by marketProductType attribute. For example, if marketProductType = EN (from
enumeration MarketProductType), then the rampInterval is the ramping time
interval for Energy.
MarketRegionResults:
slot_uri: cim:MarketProduct.MarketRegionResults
range: MarketRegionResults
required: false
multivalued: false
BidPriceCap:
slot_uri: cim:MarketProduct.BidPriceCap
range: BidPriceCap
required: false
multivalued: true
Market:
slot_uri: cim:MarketProduct.Market
range: Market
required: false
multivalued: false
BidError:
slot_uri: cim:MarketProduct.BidError
range: BidError
required: false
multivalued: true
ResourceAwardInstruction:
slot_uri: cim:MarketProduct.ResourceAwardInstruction
range: ResourceAwardInstruction
required: false
multivalued: true
ProductBids:
slot_uri: cim:MarketProduct.ProductBids
range: ProductBid
required: false
multivalued: true
CommodityDefinition:
slot_uri: cim:MarketProduct.CommodityDefinition
range: CommodityDefinition
required: false
multivalued: true
ReserveReqs:
slot_uri: cim:MarketProduct.ReserveReqs
range: ReserveReq
required: false
multivalued: true
description: Market product associated with reserve requirement must be a
reserve or regulation product.
CommodityDefinition:
class_uri: cim:CommodityDefinition
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketPlan
description: Commodities in the context of IEC 62325 are MarketProducts (energy,
regulation, reserve, etc) traded at a specific location, which in this case
is a Pnode (either a specific pricing node or a pricing area or zone defined
as a collection of pricing nodes). The CommodityDefinition is a container for
these two parameters, plus the unit of measure and the currency in which the
Commodity is traded. Each CommodityDefinition should be relatively static;
defined once and rarely changed.
attributes:
commodityCurrency:
slot_uri: cim:CommodityDefinition.commodityCurrency
range: Currency
required: false
multivalued: false
description: The currency in which the Commodity is traded, using the standard
conventions associated with the Currency enumeration.
commodityUnit:
slot_uri: cim:CommodityDefinition.commodityUnit
range: UnitSymbol
required: false
multivalued: false
description: The unit of measure in which the Commodity is traded, using the
standard conventions associated with the UnitSymbol enumeration.
commodityUnitMultiplier:
slot_uri: cim:CommodityDefinition.commodityUnitMultiplier
range: UnitMultiplier
required: false
multivalued: false
description: The unit multiplier, e.g. "k" to convert the unit "W-h" to "kW-h",
using the standard conventions associated with the UnitMultiplier enumeration.
MarketProduct:
slot_uri: cim:CommodityDefinition.MarketProduct
range: MarketProduct
required: true
multivalued: false
Pnode:
slot_uri: cim:CommodityDefinition.Pnode
range: Pnode
required: true
multivalued: false
RTO:
slot_uri: cim:CommodityDefinition.RTO
range: RTO
required: true
multivalued: false
CommodityPrice:
slot_uri: cim:CommodityDefinition.CommodityPrice
range: CommodityPrice
required: true
multivalued: true
RTO:
class_uri: cim:RTO
is_a: MarketParticipant
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: Regional transmission operator.
attributes:
TransmissionRightChain:
slot_uri: cim:RTO.TransmissionRightChain
range: TransmissionRightChain
required: false
multivalued: true
Pnodes:
slot_uri: cim:RTO.Pnodes
range: Pnode
required: false
multivalued: true
HostControlArea:
slot_uri: cim:RTO.HostControlArea
range: HostControlArea
required: false
multivalued: true
TransmissionContractRight:
slot_uri: cim:RTO.TransmissionContractRight
range: ContractRight
required: false
multivalued: true
AggregateNode:
slot_uri: cim:RTO.AggregateNode
range: AggregateNode
required: false
multivalued: true
CommodityDefinition:
slot_uri: cim:RTO.CommodityDefinition
range: CommodityDefinition
required: false
multivalued: true
SubControlArea:
slot_uri: cim:RTO.SubControlArea
range: SubControlArea
required: false
multivalued: true
FuelRegion:
slot_uri: cim:RTO.FuelRegion
range: FuelRegion
required: false
multivalued: true
MktConnectivityNode:
slot_uri: cim:RTO.MktConnectivityNode
range: MktConnectivityNode
required: false
multivalued: true
LocalReliabilityArea:
slot_uri: cim:RTO.LocalReliabilityArea
range: LocalReliabilityArea
required: false
multivalued: true
AdjacentCASet:
slot_uri: cim:RTO.AdjacentCASet
range: AdjacentCASet
required: false
multivalued: true
ResourceGroupReqs:
slot_uri: cim:RTO.ResourceGroupReqs
range: ResourceGroupReq
required: false
multivalued: true
MSSAggregation:
slot_uri: cim:RTO.MSSAggregation
range: MSSAggregation
required: false
multivalued: true
EnergyMarkets:
slot_uri: cim:RTO.EnergyMarkets
range: EnergyMarket
required: false
multivalued: true
SecurityConstraintsLinear:
slot_uri: cim:RTO.SecurityConstraintsLinear
range: SecurityConstraintSum
required: false
multivalued: true
SecurityConstraints:
slot_uri: cim:RTO.SecurityConstraints
range: SecurityConstraints
required: false
multivalued: true
MarketParticipant:
class_uri: cim:MarketParticipant
is_a: Organisation
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketCommon
description: An identification of a party acting in a electricity market business
process. This class is used to identify organizations that can participate in
market management and/or market operations.
attributes:
MarketDocument:
slot_uri: cim:MarketParticipant.MarketDocument
range: MarketDocument
required: false
multivalued: true
MarketPerson:
slot_uri: cim:MarketParticipant.MarketPerson
range: MarketPerson
required: false
multivalued: true
TimeSeries:
slot_uri: cim:MarketParticipant.TimeSeries
range: TimeSeries
required: false
multivalued: true
Bid:
slot_uri: cim:MarketParticipant.Bid
range: Bid
required: false
multivalued: true
MarketRole:
slot_uri: cim:MarketParticipant.MarketRole
range: MarketRole
required: false
multivalued: true
RegisteredResource:
slot_uri: cim:MarketParticipant.RegisteredResource
range: RegisteredResource
required: false
multivalued: true
SchedulingCoordinator:
slot_uri: cim:MarketParticipant.SchedulingCoordinator
range: SchedulingCoordinator
required: false
multivalued: true
Bid:
class_uri: cim:Bid
is_a: Document
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ParticipantInterfaces
description: "Represents both bids to purchase and offers to sell energy or ancillary\
\ services in an RTO-sponsored market.\r\n"
attributes:
marketType:
slot_uri: cim:Bid.marketType
range: MarketType
required: false
multivalued: false
description: The market type, DAM or RTM.
startTime:
slot_uri: cim:Bid.startTime
range: date
required: false
multivalued: false
description: "Start time and date for which bid applies.\r\n"
stopTime:
slot_uri: cim:Bid.stopTime
range: date
required: false
multivalued: false
description: "Stop time and date for which bid is applicable.\r\n"
MarketParticipant:
slot_uri: cim:Bid.MarketParticipant
range: MarketParticipant
required: false
multivalued: false
EnergyMarket:
slot_uri: cim:Bid.EnergyMarket
range: EnergyMarket
required: true
multivalued: false
ChargeProfiles:
slot_uri: cim:Bid.ChargeProfiles
range: ChargeProfile
required: false
multivalued: true
MitigatedBidSegment:
slot_uri: cim:Bid.MitigatedBidSegment
range: MitigatedBidSegment
required: false
multivalued: true
RMRDetermination:
slot_uri: cim:Bid.RMRDetermination
range: RMRDetermination
required: false
multivalued: true
MitigatedBid:
slot_uri: cim:Bid.MitigatedBid
range: MitigatedBid
required: false
multivalued: true
BidHourlySchedule:
slot_uri: cim:Bid.BidHourlySchedule
range: BidHourlySchedule
required: false
multivalued: true
ProductBids:
slot_uri: cim:Bid.ProductBids
range: ProductBid
required: true
multivalued: true
description: A bid comprises one or more product bids of market products
ActionRequest:
slot_uri: cim:Bid.ActionRequest
range: ActionRequest
required: true
multivalued: false
RMRDetermination:
class_uri: cim:RMRDetermination
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: "Indicates whether unit is a reliablity must run unit: required to\
\ be on to satisfy Grid Code Reliablitiy criteria, load demand, or voltage support.\r\
\n"
attributes:
Bid:
slot_uri: cim:RMRDetermination.Bid
range: Bid
required: false
multivalued: false
MitigatedBidClearing:
slot_uri: cim:RMRDetermination.MitigatedBidClearing
range: MitigatedBidClearing
required: true
multivalued: true
MitigatedBidClearing:
class_uri: cim:MitigatedBidClearing
is_a: MarketFactors
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: "Model of market power mitigation through reference or mitigated\
\ bids. Interval based.\r\n"
attributes:
MPMResourceStatus:
slot_uri: cim:MitigatedBidClearing.MPMResourceStatus
range: MPMResourceStatus
required: false
multivalued: true
RMRDetermination:
slot_uri: cim:MitigatedBidClearing.RMRDetermination
range: RMRDetermination
required: false
multivalued: true
MitigatedBid:
slot_uri: cim:MitigatedBidClearing.MitigatedBid
range: MitigatedBid
required: false
multivalued: true
MitigatedBid:
class_uri: cim:MitigatedBid
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: "Mitigated bid results posted for a given settlement period.\r\n"
attributes:
Bid:
slot_uri: cim:MitigatedBid.Bid
range: Bid
required: false
multivalued: false
MitigatedBidClearing:
slot_uri: cim:MitigatedBid.MitigatedBidClearing
range: MitigatedBidClearing
required: true
multivalued: true
MPMResourceStatus:
class_uri: cim:MPMResourceStatus
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: "Model of results of Market Power tests, gives status of resource\
\ for the associated interval.\r\n"
attributes:
resourceStatus:
slot_uri: cim:MPMResourceStatus.resourceStatus
range: string
required: false
multivalued: false
description: "Interval Test Status\r\n\r\n'N' - not applicable\r\n"
RegisteredResource:
slot_uri: cim:MPMResourceStatus.RegisteredResource
range: RegisteredResource
required: false
multivalued: false
MitigatedBidClearing:
slot_uri: cim:MPMResourceStatus.MitigatedBidClearing
range: MitigatedBidClearing
required: true
multivalued: true
MPMTestCategory:
slot_uri: cim:MPMResourceStatus.MPMTestCategory
range: MPMTestCategory
required: true
multivalued: false
MPMTestCategory:
class_uri: cim:MPMTestCategory
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: Provides a reference to the Market Power Mitigation test identifiers
and methods for the results of the DA or RT markets. Specific data is the test
identifier (Price, Conduct, or Impact) and the test method (System MPM, Local
MPM, Alternate System MPM, or Alternate Local MPM).
attributes:
purposeFlag:
slot_uri: cim:MPMTestCategory.purposeFlag
range: PurposeFlagType
required: false
multivalued: false
description: "Nature of threshold data:\r\n'M' - Mitigation threshold\r\n\
'R' - Reporting threshold"
testIdentifier:
slot_uri: cim:MPMTestCategory.testIdentifier
range: MPMTestIdentifierType
required: false
multivalued: false
description: "1 - Global Price Test\r\n2 - Global Conduct Test\r\n3 - Global\
\ Impact Test\r\n4 - Local Price Test\r\n5 - Local Conduct Test\r\n6 - Local\
\ Impact Test"
testMethod:
slot_uri: cim:MPMTestCategory.testMethod
range: MPMTestMethodType
required: false
multivalued: false
description: The method of performing the market power monitoring. Examples
are Normal (default) thresholds or Alternate thresholds.
MPMTestThreshold:
slot_uri: cim:MPMTestCategory.MPMTestThreshold
range: MPMTestThreshold
required: false
multivalued: true
MPMTestResults:
slot_uri: cim:MPMTestCategory.MPMTestResults
range: MPMTestResults
required: false
multivalued: true
MPMResourceStatus:
slot_uri: cim:MPMTestCategory.MPMResourceStatus
range: MPMResourceStatus
required: false
multivalued: true
MPMTestThreshold:
class_uri: cim:MPMTestThreshold
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: "Market Power Mitigation (MPM) test thresholds for resource as well\
\ as designated congestion areas (DCAs).\r\n"
attributes:
marketType:
slot_uri: cim:MPMTestThreshold.marketType
range: MarketType
required: false
multivalued: false
description: Market Type (DAM, RTM)
percent:
slot_uri: cim:MPMTestThreshold.percent
range: PerCent
required: false
multivalued: false
description: "Price Threshold in %\r\n"
price:
slot_uri: cim:MPMTestThreshold.price
range: CostPerEnergyUnit
required: false
multivalued: false
description: "Price Threshold in $/MW\r\n"
AggregatedPnode:
slot_uri: cim:MPMTestThreshold.AggregatedPnode
range: AggregatedPnode
required: false
multivalued: true
RegisteredResource:
slot_uri: cim:MPMTestThreshold.RegisteredResource
range: RegisteredResource
required: false
multivalued: true
MPMTestCategory:
slot_uri: cim:MPMTestThreshold.MPMTestCategory
range: MPMTestCategory
required: true
multivalued: false
AggregatedPnode:
class_uri: cim:AggregatedPnode
is_a: Pnode
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: "An aggregated pricing node is a specialized type of pricing node\
\ used to model items such as System Zone, Default Price Zone, Custom Price\
\ Zone, Control Area, Aggregated Generation, Aggregated Particpating Load, Aggregated\
\ Non-Participating Load, Trading Hub, Designated Control Area(DCA) Zone.\r\n"
attributes:
apnodeType:
slot_uri: cim:AggregatedPnode.apnodeType
range: ApnodeType
required: false
multivalued: false
description: "Aggregate Price Node Types\r\n"
participationCategory:
slot_uri: cim:AggregatedPnode.participationCategory
range: ParticipationCategoryMPM
required: false
multivalued: false
description: "Designated Control Area participation in LMP price measurement\r\
\n\r\n'Y' - Participates in both Local Market Power Mitigation (LMPM) and\
\ System Market Power Mitigation (SMPM)\r\n'N' - Not included in LMP price\
\ measures\r\n'S' - Participatesin SMPM price measures\r\n'L' - Participatesin\
\ LMPM price measures\r\n"
TACArea:
slot_uri: cim:AggregatedPnode.TACArea
range: TACArea
required: false
multivalued: true
LoadDistributionFactor:
slot_uri: cim:AggregatedPnode.LoadDistributionFactor
range: LoadDistributionFactor
required: true
multivalued: true
GenDistributionFactor:
slot_uri: cim:AggregatedPnode.GenDistributionFactor
range: GenDistributionFactor
required: true
multivalued: true
MPMTestResults:
slot_uri: cim:AggregatedPnode.MPMTestResults
range: MPMTestResults
required: true
multivalued: true
PnodeDistributionFactor:
slot_uri: cim:AggregatedPnode.PnodeDistributionFactor
range: PnodeDistributionFactor
required: true
multivalued: true
TradingHubValues:
slot_uri: cim:AggregatedPnode.TradingHubValues
range: TradingHubValues
required: false
multivalued: true
MPMTestThreshold:
slot_uri: cim:AggregatedPnode.MPMTestThreshold
range: MPMTestThreshold
required: true
multivalued: true
MktCombinedCyclePlant:
slot_uri: cim:AggregatedPnode.MktCombinedCyclePlant
range: MktCombinedCyclePlant
required: false
multivalued: true
Pnode:
class_uri: cim:Pnode
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: 'A pricing node is directly associated with a connectivity node. It
is a pricing location for which market participants submit their bids, offers,
buy/sell CRRs, and settle. '
attributes:
isPublic:
slot_uri: cim:Pnode.isPublic
range: boolean
required: false
multivalued: false
description: "If true, this Pnode is public (prices are published for DA/RT\
\ and FTR markets), otherwise it is private (location is not usable by market\
\ for bidding/FTRs/transactions).\r\n"
PnodeResults:
slot_uri: cim:Pnode.PnodeResults
range: PnodeResults
required: true
multivalued: true
DeliveryTransactionBids:
slot_uri: cim:Pnode.DeliveryTransactionBids
range: TransactionBid
required: false
multivalued: true
MktMeasurement:
slot_uri: cim:Pnode.MktMeasurement
range: MktMeasurement
required: false
multivalued: true
description: Allows Measurements to be associated to Pnodes.
SinkCRRSegment:
slot_uri: cim:Pnode.SinkCRRSegment
range: CRRSegment
required: false
multivalued: true
RegisteredResources:
slot_uri: cim:Pnode.RegisteredResources
range: RegisteredResource
required: false
multivalued: true
description: A registered resource injects power at one or more connectivity
nodes related to a pnode
ReceiptTransactionBids:
slot_uri: cim:Pnode.ReceiptTransactionBids
range: TransactionBid
required: false
multivalued: true
SourceCRRSegment:
slot_uri: cim:Pnode.SourceCRRSegment
range: CRRSegment
required: false
multivalued: true
Trade:
slot_uri: cim:Pnode.Trade
range: Trade
required: false
multivalued: true
ExPostResults:
slot_uri: cim:Pnode.ExPostResults
range: ExPostPricingResults
required: false
multivalued: true
SubControlArea:
slot_uri: cim:Pnode.SubControlArea
range: SubControlArea
required: false
multivalued: false
RTO:
slot_uri: cim:Pnode.RTO
range: RTO
required: false
multivalued: false
FTRs:
slot_uri: cim:Pnode.FTRs
range: FTR
required: false
multivalued: true
OrgPnodeAllocation:
slot_uri: cim:Pnode.OrgPnodeAllocation
range: OrgPnodeAllocation
required: false
multivalued: true
CommodityDefinition:
slot_uri: cim:Pnode.CommodityDefinition
range: CommodityDefinition
required: false
multivalued: true
AggregateNode:
slot_uri: cim:Pnode.AggregateNode
range: AggregateNode
required: false
multivalued: true
FTR:
class_uri: cim:FTR
is_a: Agreement
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfCongestionRevenueRights
description: "Financial Transmission Rights (FTR) regarding transmission capacity\
\ at a flowgate. \r\n"
attributes:
action:
slot_uri: cim:FTR.action
range: string
required: false
multivalued: false
description: "Buy, Sell\r\n"
baseEnergy:
slot_uri: cim:FTR.baseEnergy
range: ActivePower
required: false
multivalued: false
description: "Quantity, typically MWs - Seller owns all rights being offered,\
\ MWs over time on same Point of Receipt, Point of Delivery, or Resource.\r\
\n"
class:
slot_uri: cim:FTR.class
range: string
required: false
multivalued: false
description: "Peak, Off-peak, 24-hour\r\n"
ftrType:
slot_uri: cim:FTR.ftrType
range: string
required: false
multivalued: false
description: "Type of rights being offered (product) allowed to be auctioned\
\ (option, obligation).\r\n"
optimized:
slot_uri: cim:FTR.optimized
range: string
required: false
multivalued: false
description: "Fixed (covers re-configuration, grandfathering) or Optimized\
\ (up for sale/purchase\r\n"
Pnodes:
slot_uri: cim:FTR.Pnodes
range: Pnode
required: false
multivalued: true
EnergyPriceCurve:
slot_uri: cim:FTR.EnergyPriceCurve
range: EnergyPriceCurve
required: false
multivalued: false
Flowgate:
slot_uri: cim:FTR.Flowgate
range: Flowgate
required: false
multivalued: false
EnergyPriceCurve:
class_uri: cim:EnergyPriceCurve
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ParticipantInterfaces
description: "Relationship between a price in $(or other monetary unit) /hour\
\ (Y-axis) and a MW value (X-axis). \r\n"
attributes:
FTRs:
slot_uri: cim:EnergyPriceCurve.FTRs
range: FTR
required: false
multivalued: true
EnergyTransactions:
slot_uri: cim:EnergyPriceCurve.EnergyTransactions
range: EnergyTransaction
required: false
multivalued: true
EnergyTransaction:
class_uri: cim:EnergyTransaction
is_a: Document
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.ExternalInputs
description: Specifies the schedule for energy transfers between interchange areas
that are necessary to satisfy the associated interchange transaction.
attributes:
capacityBacked:
slot_uri: cim:EnergyTransaction.capacityBacked
range: boolean
required: false
multivalued: false
description: "Interchange capacity flag. When the flag is set to true, it\
\ indicates a transaction is capacity backed. \r\n"
congestChargeMax:
slot_uri: cim:EnergyTransaction.congestChargeMax
range: Money
required: false
multivalued: false
description: "Maximum congestion charges in monetary units.\r\n"
deliveryPointP:
slot_uri: cim:EnergyTransaction.deliveryPointP
range: ActivePower
required: false
multivalued: false
description: "Delivery point active power.\r\n"
energyMin:
slot_uri: cim:EnergyTransaction.energyMin
range: ActivePower
required: false
multivalued: false
description: "Transaction minimum active power if dispatchable.\r\n"
firmInterchangeFlag:
slot_uri: cim:EnergyTransaction.firmInterchangeFlag
range: boolean
required: false
multivalued: false
description: "Firm interchange flag indicates whether or not this energy transaction\
\ can be changed without potential financial consequences.\r\n"
payCongestion:
slot_uri: cim:EnergyTransaction.payCongestion
range: boolean
required: false
multivalued: false
description: "Willing to Pay congestion flag\r\n"
reason:
slot_uri: cim:EnergyTransaction.reason
range: string
required: false
multivalued: false
description: "Reason for energy transaction.\r\n"
receiptPointP:
slot_uri: cim:EnergyTransaction.receiptPointP
range: ActivePower
required: false
multivalued: false
description: "Receipt point active power.\r\n"
state:
slot_uri: cim:EnergyTransaction.state
range: EnergyTransactionType
required: false
multivalued: false
description: "{ Approve | Deny | Study }\r\n"
EnergyPriceCurves:
slot_uri: cim:EnergyTransaction.EnergyPriceCurves
range: EnergyPriceCurve
required: false
multivalued: true
EnergyProduct:
slot_uri: cim:EnergyTransaction.EnergyProduct
range: EnergyProduct
required: true
multivalued: false
description: The "Source" for an EnergyTransaction is an EnergyProduct which
is injected into a ControlArea. Typically this is a ServicePoint.
TieLines:
slot_uri: cim:EnergyTransaction.TieLines
range: TieLine
required: false
multivalued: true
description: A dynamic energy transaction can act as a pseudo tie line.
LossProfiles:
slot_uri: cim:EnergyTransaction.LossProfiles
range: LossProfile
required: false
multivalued: true
description: An EnergyTransaction may have a LossProfile.
Import_SubControlArea:
slot_uri: cim:EnergyTransaction.Import_SubControlArea
range: SubControlArea
required: true
multivalued: false
description: Energy is transferred between interchange areas
CurtailmentProfiles:
slot_uri: cim:EnergyTransaction.CurtailmentProfiles
range: CurtailmentProfile
required: false
multivalued: true
description: An EnergyTransaction may be curtailed by any of the participating
entities.
TransmissionReservation:
slot_uri: cim:EnergyTransaction.TransmissionReservation
range: TransmissionReservation
required: false
multivalued: false
EnergyProfiles:
slot_uri: cim:EnergyTransaction.EnergyProfiles
range: EnergyProfile
required: true
multivalued: true
description: An EnergyTransaction shall have at least one EnergyProfile.
Export_SubControlArea:
slot_uri: cim:EnergyTransaction.Export_SubControlArea
range: SubControlArea
required: true
multivalued: false
description: Energy is transferred between interchange areas
LossProfile:
class_uri: cim:LossProfile
is_a: Profile
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfEnergyScheduling
description: "LossProfile is associated with an EnerrgyTransaction and must be\
\ completely contained within the time frame of the EnergyProfile associated\
\ with this EnergyTransaction.\r\n"
attributes:
EnergyTransaction:
slot_uri: cim:LossProfile.EnergyTransaction
range: EnergyTransaction
required: true
multivalued: false
description: An EnergyTransaction may have a LossProfile.
HasLoss_:
slot_uri: cim:LossProfile.HasLoss_
range: TransmissionProvider
required: false
multivalued: false
description: Part of the LossProfile for an EnergyTransaction may be a loss
for a TransmissionProvider. If so, the TransmissionProvider must be one
of the participating entities in the EnergyTransaction.
TransmissionProvider:
class_uri: cim:TransmissionProvider
is_a: Organisation
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfFinancial
description: "Provider of the transmission capacity (interconnecting wires between\
\ Generation and Consumption) required to fulfill and Energy Transaction's\
\ energy exchange. Posts information for transmission paths and AvailableTransmissionCapacities\
\ on a reservation node. Buys and sells its products and services on the same\
\ reservation node.\r\n"
attributes:
For:
slot_uri: cim:TransmissionProvider.For
range: LossProfile
required: false
multivalued: true
description: Part of the LossProfile for an EnergyTransaction may be a loss
for a TransmissionProvider. If so, the TransmissionProvider must be one
of the participating entities in the EnergyTransaction.
TransmissionProducts:
slot_uri: cim:TransmissionProvider.TransmissionProducts
range: TransmissionProduct
required: true
multivalued: true
description: A TransmissionProvider offers a TransmissionProduct.
TransmissionProduct:
class_uri: cim:TransmissionProduct
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfFinancial
attributes:
transmissionProductType:
slot_uri: cim:TransmissionProduct.transmissionProductType
range: string
required: false
multivalued: false
description: "Type of the transmission product. This could be a transmission\
\ service class (firm, total transmission capability, or non-firm), transmission\
\ service period (on-peak, full-period, off-peak), transmission service\
\ increments (yearly extended, hourly fixed, monthly sliding, etc.), transmission\
\ service type (network, available transmission capability, or point-to-point,\
\ or a transmission service window (fixed hourly, sliding weekly, extended\
\ monthly, etc.).\r\n"
LocationFor:
slot_uri: cim:TransmissionProduct.LocationFor
range: TransmissionPath
required: false
multivalued: true
description: A transmission product is located on a transmission path.
TransmissionProvider:
slot_uri: cim:TransmissionProduct.TransmissionProvider
range: TransmissionProvider
required: true
multivalued: false
description: A TransmissionProvider offers a TransmissionProduct.
TransmissionPath:
class_uri: cim:TransmissionPath
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.ExternalInputs
description: "An electrical connection, link, or line consisting of one or more\
\ parallel transmission elements between two areas of the interconnected electric\
\ systems, or portions thereof. TransmissionCorridor and TransmissionRightOfWay\
\ refer to legal aspects. The TransmissionPath refers to the segments between\
\ a TransmissionProvider's ServicePoints.\r\n"
attributes:
availTransferCapability:
slot_uri: cim:TransmissionPath.availTransferCapability
range: ActivePower
required: false
multivalued: false
description: "The available transmission capability of a transmission path\
\ for the reference direction.\r\n"
parallelPathFlag:
slot_uri: cim:TransmissionPath.parallelPathFlag
range: boolean
required: false
multivalued: false
description: "Flag which indicates if the transmission path is also a designated\
\ interconnection \"parallel path\".\r\n"
totalTransferCapability:
slot_uri: cim:TransmissionPath.totalTransferCapability
range: ActivePower
required: false
multivalued: false
description: "The total transmission capability of a transmission path in\
\ the reference direction.\r\n"
For:
slot_uri: cim:TransmissionPath.For
range: TransmissionCorridor
required: true
multivalued: false
description: A TransmissionPath is contained in a TransmissionCorridor.
TransmissionReservation:
slot_uri: cim:TransmissionPath.TransmissionReservation
range: TransmissionReservation
required: false
multivalued: true
DeliveryPoint:
slot_uri: cim:TransmissionPath.DeliveryPoint
range: ServicePoint
required: true
multivalued: false
description: A transmission path has a "point-of-delivery" service point
LocatedOn:
slot_uri: cim:TransmissionPath.LocatedOn
range: TransmissionProduct
required: false
multivalued: true
description: A transmission product is located on a transmission path.
PointOfReceipt:
slot_uri: cim:TransmissionPath.PointOfReceipt
range: ServicePoint
required: true
multivalued: false
description: A transmission path has a "point-of-receipt" service point
ServicePoint:
class_uri: cim:ServicePoint
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.ExternalInputs
description: The defined termination points of a transmission path. Service points
are defined from the viewpoint of the transmission service. Each service point
is contained within (or on the boundary of) an interchange area. A service point
is source or destination of a transaction.
attributes:
PODTransmissionPath:
slot_uri: cim:ServicePoint.PODTransmissionPath
range: TransmissionPath
required: false
multivalued: true
description: A transmission path has a "point-of-delivery" service point
SinkReservation:
slot_uri: cim:ServicePoint.SinkReservation
range: TransmissionReservation
required: false
multivalued: true
PORTransmissionPath:
slot_uri: cim:ServicePoint.PORTransmissionPath
range: TransmissionPath
required: false
multivalued: true
description: A transmission path has a "point-of-receipt" service point
SourceReservation:
slot_uri: cim:ServicePoint.SourceReservation
range: TransmissionReservation
required: false
multivalued: true
TransmissionReservation:
class_uri: cim:TransmissionReservation
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.ExternalInputs
description: "A transmission reservation is obtained from the OASIS system to\
\ reserve transmission for a specified time period, transmission path and transmission\
\ product.\r\n"
attributes:
EnergyTransaction:
slot_uri: cim:TransmissionReservation.EnergyTransaction
range: EnergyTransaction
required: false
multivalued: false
TransactionBid:
slot_uri: cim:TransmissionReservation.TransactionBid
range: TransactionBid
required: false
multivalued: false
Sink:
slot_uri: cim:TransmissionReservation.Sink
range: ServicePoint
required: false
multivalued: false
Source:
slot_uri: cim:TransmissionReservation.Source
range: ServicePoint
required: false
multivalued: false
TransmissionPath:
slot_uri: cim:TransmissionReservation.TransmissionPath
range: TransmissionPath
required: true
multivalued: false
TransactionBid:
class_uri: cim:TransactionBid
is_a: Bid
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ParticipantInterfaces
description: "Bilateral or scheduled transactions for energy and ancillary services\
\ considered by market clearing process.\r\n"
attributes:
demandTransaction:
slot_uri: cim:TransactionBid.demandTransaction
range: boolean
required: false
multivalued: false
description: "Set true if this is a demand transaction.\r\n"
dispatchable:
slot_uri: cim:TransactionBid.dispatchable
range: boolean
required: false
multivalued: false
description: "Set true if this is a dispatchable transaction.\r\n"
payCongestion:
slot_uri: cim:TransactionBid.payCongestion
range: boolean
required: false
multivalued: false
description: "Set true if this is a willing to pay transaction. This flag\
\ is used to determine whether a schedule is willing-to-pay-congestion or\
\ not.\r\n"
TransactionBidResults:
slot_uri: cim:TransactionBid.TransactionBidResults
range: TransactionBidResults
required: false
multivalued: true
Delivery_Pnode:
slot_uri: cim:TransactionBid.Delivery_Pnode
range: Pnode
required: false
multivalued: false
Receipt_Pnode:
slot_uri: cim:TransactionBid.Receipt_Pnode
range: Pnode
required: false
multivalued: false
TransmissionReservation:
slot_uri: cim:TransactionBid.TransmissionReservation
range: TransmissionReservation
required: false
multivalued: false
EnergyProfiles:
slot_uri: cim:TransactionBid.EnergyProfiles
range: EnergyProfile
required: true
multivalued: true
TransactionBidResults:
class_uri: cim:TransactionBidResults
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: "Contains the cleared results for each TransactionBid submitted to\
\ and accepted by the market.\r\n"
attributes:
clearedMW:
slot_uri: cim:TransactionBidResults.clearedMW
range: float
required: false
multivalued: false
description: "The market transaction megawatt\r\n"
clearedPrice:
slot_uri: cim:TransactionBidResults.clearedPrice
range: float
required: false
multivalued: false
description: "The price of the market transaction\r\n"
TransactionBid:
slot_uri: cim:TransactionBidResults.TransactionBid
range: TransactionBid
required: false
multivalued: false
TransactionBidClearing:
slot_uri: cim:TransactionBidResults.TransactionBidClearing
range: TransactionBidClearing
required: true
multivalued: false
TransactionBidClearing:
class_uri: cim:TransactionBidClearing
is_a: MarketFactors
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: "Contains the intervals relavent for the associated TransactionBidResults.\
\ For example, Day Ahead cleared results for the transaction bids for each interval\
\ of the market day.\r\n"
attributes:
TransactionBidResults:
slot_uri: cim:TransactionBidClearing.TransactionBidResults
range: TransactionBidResults
required: false
multivalued: true
EnergyProfile:
class_uri: cim:EnergyProfile
is_a: Profile
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.ExternalInputs
description: Specifies the start time, stop time, level for an EnergyTransaction.
attributes:
EnergyTransaction:
slot_uri: cim:EnergyProfile.EnergyTransaction
range: EnergyTransaction
required: true
multivalued: false
description: An EnergyTransaction shall have at least one EnergyProfile.
TransactionBid:
slot_uri: cim:EnergyProfile.TransactionBid
range: TransactionBid
required: true
multivalued: false
TransmissionCorridor:
class_uri: cim:TransmissionCorridor
is_a: PowerSystemResource
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfEnergyScheduling
description: "A corridor containing one or more rights of way\r\n"
attributes:
TransmissionRightOfWays:
slot_uri: cim:TransmissionCorridor.TransmissionRightOfWays
range: TransmissionRightOfWay
required: true
multivalued: true
description: A transmission right-of-way is a member of a transmission corridor
ContainedIn:
slot_uri: cim:TransmissionCorridor.ContainedIn
range: TransmissionPath
required: false
multivalued: true
description: A TransmissionPath is contained in a TransmissionCorridor.
TransmissionRightOfWay:
class_uri: cim:TransmissionRightOfWay
is_a: PowerSystemResource
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfEnergyScheduling
description: "A collection of transmission lines that are close proximity to each\
\ other.\r\n"
attributes:
MktLine:
slot_uri: cim:TransmissionRightOfWay.MktLine
range: MktLine
required: false
multivalued: true
TransmissionCorridor:
slot_uri: cim:TransmissionRightOfWay.TransmissionCorridor
range: TransmissionCorridor
required: true
multivalued: false
description: A transmission right-of-way is a member of a transmission corridor
MktLine:
class_uri: cim:MktLine
is_a: Line
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketOpCommon
description: Subclass for IEC61970:Wires:Line.
attributes:
TransmissionRightOfWay:
slot_uri: cim:MktLine.TransmissionRightOfWay
range: TransmissionRightOfWay
required: false
multivalued: false
Flowgate:
slot_uri: cim:MktLine.Flowgate
range: Flowgate
required: false
multivalued: true
Flowgate:
class_uri: cim:Flowgate
is_a: PowerSystemResource
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: "A flowgate, is single or group of transmission elements intended\
\ to model MW flow impact relating to transmission limitations and transmission\
\ service usage. \r\n"
attributes:
direction:
slot_uri: cim:Flowgate.direction
range: InterTieDirection
required: false
multivalued: false
description: "The direction of the flowgate, export or import\r\n"
exportMWRating:
slot_uri: cim:Flowgate.exportMWRating
range: ActivePower
required: false
multivalued: false
description: "Export MW rating\r\n"
importMWRating:
slot_uri: cim:Flowgate.importMWRating
range: ActivePower
required: false
multivalued: false
description: "Import MW rating\r\n"
InterTie:
slot_uri: cim:Flowgate.InterTie
range: SchedulingPoint
required: false
multivalued: true
ConstraintResults:
slot_uri: cim:Flowgate.ConstraintResults
range: ConstraintResults
required: true
multivalued: true
From_SubControlArea:
slot_uri: cim:Flowgate.From_SubControlArea
range: SubControlArea
required: false
multivalued: false
TranmissionRightEntitlement:
slot_uri: cim:Flowgate.TranmissionRightEntitlement
range: TransmissionInterfaceRightEntitlement
required: false
multivalued: true
FlowgateValue:
slot_uri: cim:Flowgate.FlowgateValue
range: FlowgateValue
required: false
multivalued: true
ContractDistributionFactor:
slot_uri: cim:Flowgate.ContractDistributionFactor
range: ContractDistributionFactor
required: false
multivalued: true
To_SubControlArea:
slot_uri: cim:Flowgate.To_SubControlArea
range: SubControlArea
required: false
multivalued: false
TransmissionCapacity:
slot_uri: cim:Flowgate.TransmissionCapacity
range: TransmissionCapacity
required: false
multivalued: true
MktLine:
slot_uri: cim:Flowgate.MktLine
range: MktLine
required: false
multivalued: true
FlowgateRelief:
slot_uri: cim:Flowgate.FlowgateRelief
range: FlowgateRelief
required: false
multivalued: true
RegisteredInterTie:
slot_uri: cim:Flowgate.RegisteredInterTie
range: RegisteredInterTie
required: false
multivalued: true
SecurityConstraints:
slot_uri: cim:Flowgate.SecurityConstraints
range: SecurityConstraints
required: false
multivalued: false
FTRs:
slot_uri: cim:Flowgate.FTRs
range: FTR
required: false
multivalued: true
MktPowerTransformer:
slot_uri: cim:Flowgate.MktPowerTransformer
range: MktPowerTransformer
required: false
multivalued: true
InterTieResults:
slot_uri: cim:Flowgate.InterTieResults
range: InterTieResults
required: true
multivalued: true
ViolationLimits:
slot_uri: cim:Flowgate.ViolationLimits
range: ViolationLimit
required: false
multivalued: true
GeneratingUnitDynamicValues:
slot_uri: cim:Flowgate.GeneratingUnitDynamicValues
range: GeneratingUnitDynamicValues
required: false
multivalued: true
HostControlArea:
slot_uri: cim:Flowgate.HostControlArea
range: HostControlArea
required: false
multivalued: false
CongestionRevenueRight:
slot_uri: cim:Flowgate.CongestionRevenueRight
range: CongestionRevenueRight
required: false
multivalued: false
GenericConstraints:
slot_uri: cim:Flowgate.GenericConstraints
range: GenericConstraints
required: false
multivalued: false
MktTerminal:
slot_uri: cim:Flowgate.MktTerminal
range: MktTerminal
required: false
multivalued: true
ViolationLimit:
class_uri: cim:ViolationLimit
is_a: Limit
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfCongestionRevenueRights
description: "A type of limit that indicates if it is enforced and, through association,\
\ the organisation responsible for setting the limit.\r\n"
attributes:
enforced:
slot_uri: cim:ViolationLimit.enforced
range: boolean
required: false
multivalued: false
description: "True if limit is enforced. \r\n"
Flowgate:
slot_uri: cim:ViolationLimit.Flowgate
range: Flowgate
required: false
multivalued: false
MktMeasurement:
slot_uri: cim:ViolationLimit.MktMeasurement
range: MktMeasurement
required: false
multivalued: false
MktMeasurement:
class_uri: cim:MktMeasurement
is_a: Measurement
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketOpCommon
description: Subclass of IEC61970:Meas:Measurement.
attributes:
DynamicSchedule:
slot_uri: cim:MktMeasurement.DynamicSchedule
range: DynamicSchedule
required: false
multivalued: true
ByTiePoint:
slot_uri: cim:MktMeasurement.ByTiePoint
range: TiePoint
required: true
multivalued: false
description: A measurement is made on the B side of a tie point
Pnode:
slot_uri: cim:MktMeasurement.Pnode
range: Pnode
required: false
multivalued: false
description: Allows Pnode an association to aggregated resources external
DC ties or psuedo tie measurements.
ViolationLimit:
slot_uri: cim:MktMeasurement.ViolationLimit
range: ViolationLimit
required: false
multivalued: true
ForTiePoint:
slot_uri: cim:MktMeasurement.ForTiePoint
range: TiePoint
required: true
multivalued: false
description: A measurement is made on the A side of a tie point
DynamicSchedule:
class_uri: cim:DynamicSchedule
is_a: BasicIntervalSchedule
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfEnergyScheduling
description: "A continuously variable component of a control area's MW net interchange\
\ schedule. Dynamic schedules are sent and received by control areas.\r\n"
attributes:
dynSchedSignRev:
slot_uri: cim:DynamicSchedule.dynSchedSignRev
range: boolean
required: false
multivalued: false
description: "Dynamic schedule sign reversal required (true/false)\r\n"
dynSchedStatus:
slot_uri: cim:DynamicSchedule.dynSchedStatus
range: string
required: false
multivalued: false
description: "The \"active\" or \"inactive\" status of the dynamic schedule\r\
\n"
MktMeasurement:
slot_uri: cim:DynamicSchedule.MktMeasurement
range: MktMeasurement
required: true
multivalued: false
Receive_SubControlArea:
slot_uri: cim:DynamicSchedule.Receive_SubControlArea
range: SubControlArea
required: true
multivalued: false
description: A control area can receive dynamic schedules from other control
areas
Send_SubControlArea:
slot_uri: cim:DynamicSchedule.Send_SubControlArea
range: SubControlArea
required: true
multivalued: false
description: A control area can send dynamic schedules to other control areas
SubControlArea:
class_uri: cim:SubControlArea
is_a: PowerSystemResource
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: An area defined for the purpose of tracking interchange with surrounding
areas via tie points; may or may not serve as a control area.
attributes:
areaShortName:
slot_uri: cim:SubControlArea.areaShortName
range: string
required: false
multivalued: false
description: "Market area short name, which is the regulation zone. It references\
\ AGC regulation zone name.\r\n"
constantCoefficient:
slot_uri: cim:SubControlArea.constantCoefficient
range: float
required: false
multivalued: false
description: "Loss estimate constant coefficient\r\n"
embeddedControlArea:
slot_uri: cim:SubControlArea.embeddedControlArea
range: YesNo
required: false
multivalued: false
description: "Used in conjunction with the InternalCA flag. If the InternalCA\
\ flag is YES, this flag does not apply. If the InternaCA flag is NO, this\
\ flag provides an indication of AdjacentCA (NO) or Embedded CA (YES).\r\
\n"
internalCA:
slot_uri: cim:SubControlArea.internalCA
range: YesNo
required: false
multivalued: false
description: "A Yes/No indication that this control area is contained internal\
\ to the system.\r\n"
linearCoefficient:
slot_uri: cim:SubControlArea.linearCoefficient
range: float
required: false
multivalued: false
description: "Loss estimate linear coefficient\r\n"
localCA:
slot_uri: cim:SubControlArea.localCA
range: YesNo
required: false
multivalued: false
description: "Indication that this control area is the local control area.\r\
\n"
maxSelfSchedMW:
slot_uri: cim:SubControlArea.maxSelfSchedMW
range: float
required: false
multivalued: false
description: "Maximum amount of self schedule MWs allowed for an embedded\
\ control area.\r\n"
minSelfSchedMW:
slot_uri: cim:SubControlArea.minSelfSchedMW
range: float
required: false
multivalued: false
description: "Minimum amount of self schedule MW allowed for an embedded control\
\ area.\r\n"
quadraticCoefficient:
slot_uri: cim:SubControlArea.quadraticCoefficient
range: float
required: false
multivalued: false
description: "Loss estimate quadratic coefficient\r\n"
Import_EnergyTransactions:
slot_uri: cim:SubControlArea.Import_EnergyTransactions
range: EnergyTransaction
required: false
multivalued: true
description: Energy is transferred between interchange areas
GeneralClearingResults:
slot_uri: cim:SubControlArea.GeneralClearingResults
range: GeneralClearingResults
required: false
multivalued: true
BidSelfSched:
slot_uri: cim:SubControlArea.BidSelfSched
range: BidSelfSched
required: false
multivalued: true
Export_EnergyTransactions:
slot_uri: cim:SubControlArea.Export_EnergyTransactions
range: EnergyTransaction
required: false
multivalued: true
description: Energy is transferred between interchange areas
From_Flowgate:
slot_uri: cim:SubControlArea.From_Flowgate
range: Flowgate
required: false
multivalued: true
AdjacentCASet:
slot_uri: cim:SubControlArea.AdjacentCASet
range: AdjacentCASet
required: false
multivalued: false
InadvertentAccount:
slot_uri: cim:SubControlArea.InadvertentAccount
range: InadvertentAccount
required: false
multivalued: true
description: A control area can have one or more net inadvertent interchange
accounts
SideB_TieLines:
slot_uri: cim:SubControlArea.SideB_TieLines
range: TieLine
required: false
multivalued: true
description: The SubControlArea is on the B side of a collection of metered
points which define the SubControlArea's boundary for a ControlAreaOperator
or CustomerConsumer.
LossClearingResults:
slot_uri: cim:SubControlArea.LossClearingResults
range: LossClearingResults
required: true
multivalued: true
CnodeDistributionFactor:
slot_uri: cim:SubControlArea.CnodeDistributionFactor
range: CnodeDistributionFactor
required: false
multivalued: true
AggregateNode:
slot_uri: cim:SubControlArea.AggregateNode
range: AggregateNode
required: false
multivalued: true
ExPostLossResults:
slot_uri: cim:SubControlArea.ExPostLossResults
range: ExPostLossResults
required: false
multivalued: true
Receive_DynamicSchedules:
slot_uri: cim:SubControlArea.Receive_DynamicSchedules
range: DynamicSchedule
required: false
multivalued: true
description: A control area can receive dynamic schedules from other control
areas
RegisteredResource:
slot_uri: cim:SubControlArea.RegisteredResource
range: RegisteredResource
required: false
multivalued: true
To_Flowgate:
slot_uri: cim:SubControlArea.To_Flowgate
range: Flowgate
required: false
multivalued: true
SideA_TieLines:
slot_uri: cim:SubControlArea.SideA_TieLines
range: TieLine
required: false
multivalued: true
description: The SubControlArea is on the A side of a collection of metered
points which define the SubControlArea's boundary for a ControlAreaOperator
or CustomerConsumer.
ControlAreaDesignation:
slot_uri: cim:SubControlArea.ControlAreaDesignation
range: ControlAreaDesignation
required: false
multivalued: true
Send_DynamicSchedules:
slot_uri: cim:SubControlArea.Send_DynamicSchedules
range: DynamicSchedule
required: false
multivalued: true
description: A control area can send dynamic schedules to other control areas
RTO:
slot_uri: cim:SubControlArea.RTO
range: RTO
required: true
multivalued: false
Pnode:
slot_uri: cim:SubControlArea.Pnode
range: Pnode
required: false
multivalued: true
AreaReserveSpecification:
slot_uri: cim:SubControlArea.AreaReserveSpecification
range: AreaReserveSpec
required: true
multivalued: false
HostControlArea:
slot_uri: cim:SubControlArea.HostControlArea
range: HostControlArea
required: true
multivalued: false
description: The interchange area may operate as a control area
AdjacentCASet:
class_uri: cim:AdjacentCASet
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: Groups Adjacent Control Areas.
attributes:
'lossPercentage ':
slot_uri: cim:AdjacentCASet.lossPercentage%20
range: float
required: false
multivalued: false
description: "Loss percentage\r\n"
SubControlArea:
slot_uri: cim:AdjacentCASet.SubControlArea
range: SubControlArea
required: false
multivalued: true
BidSelfSched:
slot_uri: cim:AdjacentCASet.BidSelfSched
range: BidSelfSched
required: false
multivalued: true
RegisteredResource:
slot_uri: cim:AdjacentCASet.RegisteredResource
range: RegisteredResource
required: false
multivalued: true
HostControlArea:
slot_uri: cim:AdjacentCASet.HostControlArea
range: HostControlArea
required: false
multivalued: false
RTO:
slot_uri: cim:AdjacentCASet.RTO
range: RTO
required: true
multivalued: false
HostControlArea:
class_uri: cim:HostControlArea
is_a: PowerSystemResource
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: A HostControlArea has a set of tie points and a set of generator
controls (i.e., AGC). It also has a total load, including transmission and distribution
losses.
attributes:
areaControlMode:
slot_uri: cim:HostControlArea.areaControlMode
range: AreaControlMode
required: false
multivalued: false
description: "The area's present control mode: (CF = constant frequency) or\
\ (CTL = constant tie-line) or (TLB = tie-line bias) or (OFF = off control)\r\
\n"
freqSetPoint:
slot_uri: cim:HostControlArea.freqSetPoint
range: Frequency
required: false
multivalued: false
description: "The present power system frequency set point for automatic generation\
\ control\r\n"
frequencyBiasFactor:
slot_uri: cim:HostControlArea.frequencyBiasFactor
range: float
required: false
multivalued: false
description: "The control area's frequency bias factor, in MW/0.1 Hz, for\
\ automatic generation control (AGC)\r\n"
Controls:
slot_uri: cim:HostControlArea.Controls
range: ControlAreaOperator
required: true
multivalued: false
description: A ControlAreaCompany controls a ControlArea.
SysLoadDistribuFactor:
slot_uri: cim:HostControlArea.SysLoadDistribuFactor
range: SysLoadDistributionFactor
required: false
multivalued: true
CnodeDistributionFactor:
slot_uri: cim:HostControlArea.CnodeDistributionFactor
range: CnodeDistributionFactor
required: false
multivalued: true
RegisteredResource:
slot_uri: cim:HostControlArea.RegisteredResource
range: RegisteredResource
required: false
multivalued: true
BidSelfSched:
slot_uri: cim:HostControlArea.BidSelfSched
range: BidSelfSched
required: false
multivalued: true
AdjacentCASet:
slot_uri: cim:HostControlArea.AdjacentCASet
range: AdjacentCASet
required: false
multivalued: false
TransferInterface:
slot_uri: cim:HostControlArea.TransferInterface
range: TransferInterface
required: false
multivalued: true
LossClearingResults:
slot_uri: cim:HostControlArea.LossClearingResults
range: LossClearingResults
required: false
multivalued: true
Flowgate:
slot_uri: cim:HostControlArea.Flowgate
range: Flowgate
required: false
multivalued: true
SubControlAreas:
slot_uri: cim:HostControlArea.SubControlAreas
range: SubControlArea
required: false
multivalued: true
description: The interchange area may operate as a control area
RTO:
slot_uri: cim:HostControlArea.RTO
range: RTO
required: true
multivalued: false
ControlAreaOperator:
class_uri: cim:ControlAreaOperator
is_a: Organisation
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfFinancial
description: "Operates the Control Area. Approves and implements energy transactions.\
\ Verifies both Inter-Control Area and Intra-Control Area transactions for the\
\ power system before granting approval (and implementing) the transactions.\r\
\n"
attributes:
CAChildOf:
slot_uri: cim:ControlAreaOperator.CAChildOf
range: TieLine
required: false
multivalued: true
description: A ControlAreaOperator has a collection of tie points that ring
the ControlArea, called a TieLine.
ControlledBy:
slot_uri: cim:ControlAreaOperator.ControlledBy
range: HostControlArea
required: true
multivalued: false
description: A ControlAreaCompany controls a ControlArea.
TieLine:
class_uri: cim:TieLine
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfEnergyScheduling
attributes:
SideB_SubControlArea:
slot_uri: cim:TieLine.SideB_SubControlArea
range: SubControlArea
required: true
multivalued: false
description: The SubControlArea is on the B side of a collection of metered
points which define the SubControlArea's boundary for a ControlAreaOperator
or CustomerConsumer.
SideA_SubControlArea:
slot_uri: cim:TieLine.SideA_SubControlArea
range: SubControlArea
required: true
multivalued: false
description: The SubControlArea is on the A side of a collection of metered
points which define the SubControlArea's boundary for a ControlAreaOperator
or CustomerConsumer.
ParentOfA:
slot_uri: cim:TieLine.ParentOfA
range: ControlAreaOperator
required: false
multivalued: true
description: A ControlAreaOperator has a collection of tie points that ring
the ControlArea, called a TieLine.
ParentOfB:
slot_uri: cim:TieLine.ParentOfB
range: CustomerConsumer
required: false
multivalued: false
description: A CustomerConsumer may ring its perimeter with metering, which
can create a unique SubControlArea at the collection of metering points,
called a TieLine.
EnergyTransaction:
slot_uri: cim:TieLine.EnergyTransaction
range: EnergyTransaction
required: false
multivalued: false
description: A dynamic energy transaction can act as a pseudo tie line.
CustomerConsumer:
class_uri: cim:CustomerConsumer
is_a: Organisation
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfFinancial
description: "The energy buyer in the energy marketplace.\r\n"
attributes:
CustChildOf:
slot_uri: cim:CustomerConsumer.CustChildOf
range: TieLine
required: false
multivalued: true
description: A ControlAreaOperator or CustomerConsumer may ring their perimeter
with metering, which can create a unique SubControlArea at the collection
of metering points, called a TieLine.
SysLoadDistributionFactor:
class_uri: cim:SysLoadDistributionFactor
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.ExternalInputs
description: "This class models the system distribution factors. This class needs\
\ to be used along with the HostControlArea and the ConnectivityNode to show\
\ the distribution of each individual party.\r\n"
attributes:
factor:
slot_uri: cim:SysLoadDistributionFactor.factor
range: float
required: false
multivalued: false
description: "Used to calculate load \"participation\" of a connectivity node\
\ in an host control area\r\n"
MktConnectivityNode:
slot_uri: cim:SysLoadDistributionFactor.MktConnectivityNode
range: MktConnectivityNode
required: true
multivalued: false
HostControlArea:
slot_uri: cim:SysLoadDistributionFactor.HostControlArea
range: HostControlArea
required: true
multivalued: false
DistributionFactorSet:
slot_uri: cim:SysLoadDistributionFactor.DistributionFactorSet
range: DistributionFactorSet
required: false
multivalued: true
DistributionFactorSet:
class_uri: cim:DistributionFactorSet
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.ExternalInputs
description: "A containing class that groups all the distribution factors within\
\ a market. \r\nThis is calculated daily for DA factors and hourly for RT\
\ factors.\r\n"
attributes:
intervalEndTime:
slot_uri: cim:DistributionFactorSet.intervalEndTime
range: date
required: false
multivalued: false
description: "The end of the time interval for which requirement is defined.\r\
\n"
intervalStartTime:
slot_uri: cim:DistributionFactorSet.intervalStartTime
range: date
required: false
multivalued: false
description: "The start of the time interval for which requirement is defined.\r\
\n"
marketType:
slot_uri: cim:DistributionFactorSet.marketType
range: MarketType
required: false
multivalued: false
description: Market type.
LoadDistributionFactor:
slot_uri: cim:DistributionFactorSet.LoadDistributionFactor
range: LoadDistributionFactor
required: false
multivalued: true
SysLoadDistribuFactor:
slot_uri: cim:DistributionFactorSet.SysLoadDistribuFactor
range: SysLoadDistributionFactor
required: false
multivalued: true
GenDistributionFactor:
slot_uri: cim:DistributionFactorSet.GenDistributionFactor
range: GenDistributionFactor
required: false
multivalued: true
LoadDistributionFactor:
class_uri: cim:LoadDistributionFactor
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.ExternalInputs
description: "This class models the load distribution factors. This class should\
\ be used in one of two ways:\r\n\r\nUse it along with the AggregatedPnode and\
\ the IndividualPnode to show the distriubtion of each individual party\r\n\r\
\nOR\r\n\r\nUse it with Mkt_EnergyConsumer to represent the current MW/Mvar\
\ distribution within it's parnet load group.\r\n"
attributes:
pDistFactor:
slot_uri: cim:LoadDistributionFactor.pDistFactor
range: float
required: false
multivalued: false
description: "Real power (MW) load distribution factor\r\n"
qDistFactor:
slot_uri: cim:LoadDistributionFactor.qDistFactor
range: float
required: false
multivalued: false
description: "Reactive power (MVAr) load distribution factor\r\n"
AggregatedPnode:
slot_uri: cim:LoadDistributionFactor.AggregatedPnode
range: AggregatedPnode
required: false
multivalued: false
DistributionFactorSet:
slot_uri: cim:LoadDistributionFactor.DistributionFactorSet
range: DistributionFactorSet
required: false
multivalued: true
IndividualPnode:
slot_uri: cim:LoadDistributionFactor.IndividualPnode
range: IndividualPnode
required: false
multivalued: false
IndividualPnode:
class_uri: cim:IndividualPnode
is_a: Pnode
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: "Individual pricing node based on Pnode.\r\n"
attributes:
GenDistributionFactor:
slot_uri: cim:IndividualPnode.GenDistributionFactor
range: GenDistributionFactor
required: false
multivalued: false
PnodeDistributionFactor:
slot_uri: cim:IndividualPnode.PnodeDistributionFactor
range: PnodeDistributionFactor
required: false
multivalued: true
MktConnectivityNode:
slot_uri: cim:IndividualPnode.MktConnectivityNode
range: MktConnectivityNode
required: true
multivalued: false
LoadDistributionFactor:
slot_uri: cim:IndividualPnode.LoadDistributionFactor
range: LoadDistributionFactor
required: false
multivalued: false
CongestionArea:
slot_uri: cim:IndividualPnode.CongestionArea
range: CongestionArea
required: false
multivalued: true
CongestionArea:
class_uri: cim:CongestionArea
is_a: AggregatedPnode
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: "Designated Congestion Area Definition (DCA).\r\n"
attributes:
IndividualPnode:
slot_uri: cim:CongestionArea.IndividualPnode
range: IndividualPnode
required: false
multivalued: true
GenDistributionFactor:
class_uri: cim:GenDistributionFactor
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.ExternalInputs
description: "This class models the generation distribution factors. This class\
\ needs to be used along with the AggregatedPnode and the IndividualPnode to\
\ show the distribution of each individual party.\r\n"
attributes:
factor:
slot_uri: cim:GenDistributionFactor.factor
range: float
required: false
multivalued: false
description: "Used to calculate generation \"participation\" of an individual\
\ pnond in an AggregatePnode. \r\n"
IndividualPnode:
slot_uri: cim:GenDistributionFactor.IndividualPnode
range: IndividualPnode
required: false
multivalued: false
AggregatedPnode:
slot_uri: cim:GenDistributionFactor.AggregatedPnode
range: AggregatedPnode
required: false
multivalued: false
DistributionFactorSet:
slot_uri: cim:GenDistributionFactor.DistributionFactorSet
range: DistributionFactorSet
required: false
multivalued: true
PnodeDistributionFactor:
class_uri: cim:PnodeDistributionFactor
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: "This class allows SC to input different distribution factors for\
\ pricing node.\r\n"
attributes:
factor:
slot_uri: cim:PnodeDistributionFactor.factor
range: float
required: false
multivalued: false
description: "Used to calculate \"participation\" of Pnode in an AggregatePnode.\
\ For example, for regulation region this factor is 1 and total sum of all\
\ factors for a specific regulation region does not have to be 1. For pricing\
\ zone the total sum of all factors has to be 1.\r\n"
offPeak:
slot_uri: cim:PnodeDistributionFactor.offPeak
range: YesNo
required: false
multivalued: false
description: Indication that this distribution factor is to apply during off
peak.
onPeak:
slot_uri: cim:PnodeDistributionFactor.onPeak
range: YesNo
required: false
multivalued: false
description: Indication that this factor is to apply during Peak periods.
podLossFactor:
slot_uri: cim:PnodeDistributionFactor.podLossFactor
range: float
required: false
multivalued: false
description: "Point of delivery loss factor\r\n"
IndividualPnode:
slot_uri: cim:PnodeDistributionFactor.IndividualPnode
range: IndividualPnode
required: true
multivalued: false
BidDistributionFactor:
slot_uri: cim:PnodeDistributionFactor.BidDistributionFactor
range: BidDistributionFactor
required: false
multivalued: false
AggregatedPnode:
slot_uri: cim:PnodeDistributionFactor.AggregatedPnode
range: AggregatedPnode
required: true
multivalued: false
BidDistributionFactor:
class_uri: cim:BidDistributionFactor
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ParticipantInterfaces
description: "This class allows SC to input different time intervals for distribution\
\ factors.\r\n"
attributes:
timeIntervalEnd:
slot_uri: cim:BidDistributionFactor.timeIntervalEnd
range: date
required: false
multivalued: false
description: "End of the time interval n which bid is valid (yyyy-mm-dd hh24:\
\ mi: ss) \r\n"
timeIntervalStart:
slot_uri: cim:BidDistributionFactor.timeIntervalStart
range: date
required: false
multivalued: false
description: "Start of the time interval in which bid is valid (yyyy-mm-dd\
\ hh24: mi: ss). \r\n"
PnodeDistributionFactor:
slot_uri: cim:BidDistributionFactor.PnodeDistributionFactor
range: PnodeDistributionFactor
required: false
multivalued: true
ProductBid:
slot_uri: cim:BidDistributionFactor.ProductBid
range: ProductBid
required: true
multivalued: false
ProductBid:
class_uri: cim:ProductBid
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ParticipantInterfaces
description: "Component of a bid that pertains to one market product.\r\n"
attributes:
BidDistributionFactor:
slot_uri: cim:ProductBid.BidDistributionFactor
range: BidDistributionFactor
required: false
multivalued: true
BidSelfSched:
slot_uri: cim:ProductBid.BidSelfSched
range: BidSelfSched
required: false
multivalued: true
Bid:
slot_uri: cim:ProductBid.Bid
range: Bid
required: true
multivalued: false
description: A bid comprises one or more product bids of market products
BidSchedule:
slot_uri: cim:ProductBid.BidSchedule
range: BidPriceSchedule
required: false
multivalued: true
MarketProduct:
slot_uri: cim:ProductBid.MarketProduct
range: MarketProduct
required: true
multivalued: false
BidHourlyProductSchedule:
slot_uri: cim:ProductBid.BidHourlyProductSchedule
range: BidHourlyProductSchedule
required: false
multivalued: true
BidHourlyProductSchedule:
class_uri: cim:BidHourlyProductSchedule
is_a: RegularIntervalSchedule
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ParticipantInterfaces
description: "Containment for bid parameters that are dependent on a market product\
\ type.\r\n"
attributes:
ProductBid:
slot_uri: cim:BidHourlyProductSchedule.ProductBid
range: ProductBid
required: true
multivalued: false
BidSelfSched:
class_uri: cim:BidSelfSched
is_a: RegularIntervalSchedule
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ParticipantInterfaces
description: Defines self schedule values to be used for specified time intervals.
attributes:
balancingFlag:
slot_uri: cim:BidSelfSched.balancingFlag
range: YesNo
required: false
multivalued: false
description: This is a Y/N flag for a self-schedule of a resource per market
per date and hour, using a specific TR ID. It indicates whether a self-schedule
using a TR is balanced with another self-schedule using the same TR ID.
bidType:
slot_uri: cim:BidSelfSched.bidType
range: BidTypeRMR
required: false
multivalued: false
description: bidType has two types as the required output of requirements
and qualified pre-dispatch.
priorityFlag:
slot_uri: cim:BidSelfSched.priorityFlag
range: YesNo
required: false
multivalued: false
description: "This is a Y/N flag for a self-schedule of a resource per market\
\ per date and hour, using a specific TR ID. It indicates whether a self-schedule\
\ using a TR has scheduling priority in DAM/RTM.\r\n"
pumpSelfSchedMw:
slot_uri: cim:BidSelfSched.pumpSelfSchedMw
range: float
required: false
multivalued: false
description: "Contains the PriceTaker, ExistingTransmissionContract, TransmissionOwnershipRights\
\ pumping self schedule quantity. If this value is not null, then the unit\
\ is in pumping mode.\r\n"
referenceType:
slot_uri: cim:BidSelfSched.referenceType
range: SelfSchedReferenceType
required: false
multivalued: false
description: "Indication of which type of self schedule is being referenced.\r\
\n"
selfSchedMw:
slot_uri: cim:BidSelfSched.selfSchedMw
range: float
required: false
multivalued: false
description: "Self scheduled value\r\n"
selfSchedSptResource:
slot_uri: cim:BidSelfSched.selfSchedSptResource
range: string
required: false
multivalued: false
description: "Price Taker Export Self Sched Support Resource\r\n"
selfSchedType:
slot_uri: cim:BidSelfSched.selfSchedType
range: MarketProductSelfSchedType
required: false
multivalued: false
description: "This attribute is used to specify if a bid includes a self sched\
\ bid. If so what self sched type is it. The possible values are shown as\
\ follow but not limited to:\r\n\r\n'ETC' - Existing transmission contract\r\
\n'TOR' - Transmission ownership right\r\n'RMR' - Reliability must run\r\
\n'RGMR' - Regulatory must run\r\n\"RMT\" - Relaiability must take\r\n\"\
PT\" - Price taker\r\n\"LPT\" - Low price taker\r\n\"SP\" - Self provision\r\
\n\"RA\" - Resource adequacy\r\n\r\nThis attribute is originally defined\
\ in the BidSelfSched class\r\n"
updateType:
slot_uri: cim:BidSelfSched.updateType
range: MQSCHGType
required: false
multivalued: false
wheelingTransactionReference:
slot_uri: cim:BidSelfSched.wheelingTransactionReference
range: string
required: false
multivalued: false
description: "A unique identifier of a wheeling transaction. A wheeling transaction\
\ is a balanced Energy exchange among Supply and Demand Resources.\r\n"
ProductBid:
slot_uri: cim:BidSelfSched.ProductBid
range: ProductBid
required: true
multivalued: false
HostControlArea:
slot_uri: cim:BidSelfSched.HostControlArea
range: HostControlArea
required: false
multivalued: false
SubControlArea:
slot_uri: cim:BidSelfSched.SubControlArea
range: SubControlArea
required: false
multivalued: false
AdjacentCASet:
slot_uri: cim:BidSelfSched.AdjacentCASet
range: AdjacentCASet
required: false
multivalued: false
TransmissionContractRight:
slot_uri: cim:BidSelfSched.TransmissionContractRight
range: ContractRight
required: false
multivalued: false
ContractRight:
class_uri: cim:ContractRight
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: 'Provides definition of Transmission Ownership Right and Existing
Transmission Contract identifiers for use by SCUC. RMR contract hosting: Startup
lead time, Contract Service Limits, Max Service Hours, Max MWhs, Max Start-ups,
Ramp Rate, Max Net Dependable Capacity, Min Capacity and Unit Substitution for
DAM/RTM to retrieve.'
attributes:
chainOrder:
slot_uri: cim:ContractRight.chainOrder
range: integer
required: false
multivalued: false
description: "When used in conjunction with a Transmission Right contract\
\ chain, this is the precedence for the contracts.\r\n"
contractMW:
slot_uri: cim:ContractRight.contractMW
range: float
required: false
multivalued: false
description: "MW value of the contract\r\n"
contractPrice:
slot_uri: cim:ContractRight.contractPrice
range: CostPerEnergyUnit
required: false
multivalued: false
description: "Financial value of the contract\r\n"
contractPriority:
slot_uri: cim:ContractRight.contractPriority
range: integer
required: false
multivalued: false
description: "Priority for the contract. This should be unique amoung all\
\ contracts for a specific resource. This value is the directive for the\
\ SCUC algorithm on the order to satisfy/cut contracts.\r\n"
contractStatus:
slot_uri: cim:ContractRight.contractStatus
range: string
required: false
multivalued: false
description: "Contract status\r\n"
contractType:
slot_uri: cim:ContractRight.contractType
range: ContractType
required: false
multivalued: false
description: "type of the contract. Possible values are but not limited by:\r\
\n\r\nETC, TOR or RMR and RMT self schedules"
financialLocation:
slot_uri: cim:ContractRight.financialLocation
range: YesNo
required: false
multivalued: false
description: Indicator if the location associated with this contract is financial
(e.g. pricing nodes) or physical (e.g. connectivity nodes).
financialRightsDAM:
slot_uri: cim:ContractRight.financialRightsDAM
range: YesNo
required: false
multivalued: false
description: Flag to indicate this contract provides financial rights in the
DA Market
financialRightsRTM:
slot_uri: cim:ContractRight.financialRightsRTM
range: YesNo
required: false
multivalued: false
description: Flag to indicate this contract provides financial rights in the
RT Market
fuelAdder:
slot_uri: cim:ContractRight.fuelAdder
range: float
required: false
multivalued: false
description: "Estimated Fuel Adder\r\n"
latestSchedMinutes:
slot_uri: cim:ContractRight.latestSchedMinutes
range: integer
required: false
multivalued: false
description: "This indicates the latest schedule minutes (e.g. t - xx) that\
\ this resource can be notified to respond. This attribute is only used\
\ if the market type is not supplied. \r\n"
latestSchedMktType:
slot_uri: cim:ContractRight.latestSchedMktType
range: MarketType
required: false
multivalued: false
description: 'This indicates the latest schedule market type a contract can
be applied to. This is used in conjunction with the latestSchedMinutes attribute
to determine the latest time this contract can be called in. The possible
values for this attribute are: DAM, RTM or it can be omitted. If omitted,
the latestSchedMinutes attribute defines the value.'
maximumScheduleQuantity:
slot_uri: cim:ContractRight.maximumScheduleQuantity
range: float
required: false
multivalued: false
description: "Maximum schedule MW quantity\r\n"
maximumServiceHours:
slot_uri: cim:ContractRight.maximumServiceHours
range: integer
required: false
multivalued: false
description: "Maximum service hours\r\n"
maximumStartups:
slot_uri: cim:ContractRight.maximumStartups
range: integer
required: false
multivalued: false
description: "Maximum startups\r\n"
maxNetDependableCapacity:
slot_uri: cim:ContractRight.maxNetDependableCapacity
range: float
required: false
multivalued: false
description: "Maximum Net Dependable Capacity\r\n"
minimumLoad:
slot_uri: cim:ContractRight.minimumLoad
range: float
required: false
multivalued: false
description: "Minimum Load\r\n"
minimumScheduleQuantity:
slot_uri: cim:ContractRight.minimumScheduleQuantity
range: float
required: false
multivalued: false
description: "Minimum schedule quanity\r\n"
physicalRightsDAM:
slot_uri: cim:ContractRight.physicalRightsDAM
range: YesNo
required: false
multivalued: false
description: Flag to indicate this contract provides physical rights in the
DA Market
physicalRightsRTM:
slot_uri: cim:ContractRight.physicalRightsRTM
range: YesNo
required: false
multivalued: false
description: Flag to indicate this contract provides physical rights in the
RT Market
startupLeadTime:
slot_uri: cim:ContractRight.startupLeadTime
range: integer
required: false
multivalued: false
description: "Start up lead time\r\n"
TRType:
slot_uri: cim:ContractRight.TRType
range: TRType
required: false
multivalued: false
description: "Transmission Right type - is this an individual contract right\
\ or a chain contract right. Types = CHAIN or INDIVIDUAL\r\n"
TREntitlement:
slot_uri: cim:ContractRight.TREntitlement
range: TREntitlement
required: false
multivalued: true
ContractDistributionFactor:
slot_uri: cim:ContractRight.ContractDistributionFactor
range: ContractDistributionFactor
required: false
multivalued: true
SubstitutionResourceList:
slot_uri: cim:ContractRight.SubstitutionResourceList
range: SubstitutionResourceList
required: false
multivalued: true
BidSelfSched:
slot_uri: cim:ContractRight.BidSelfSched
range: BidSelfSched
required: false
multivalued: true
Chain_TransmissionRightChain:
slot_uri: cim:ContractRight.Chain_TransmissionRightChain
range: TransmissionRightChain
required: false
multivalued: false
Ind_TransmissionRightChain:
slot_uri: cim:ContractRight.Ind_TransmissionRightChain
range: TransmissionRightChain
required: false
multivalued: false
RTO:
slot_uri: cim:ContractRight.RTO
range: RTO
required: true
multivalued: false
SchedulingCoordinator:
slot_uri: cim:ContractRight.SchedulingCoordinator
range: SchedulingCoordinator
required: true
multivalued: false
TransmissionInterfaceEntitlement:
slot_uri: cim:ContractRight.TransmissionInterfaceEntitlement
range: TransmissionInterfaceRightEntitlement
required: false
multivalued: true
TransmissionRightChain:
class_uri: cim:TransmissionRightChain
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: Allows chaining of TransmissionContractRights. Many individual contract
rights can be included in the definition of a TransmissionRightChain. A TransmissionRightChain
is also defined as a TransmissionContractRight itself.
attributes:
Chain_ContractRight:
slot_uri: cim:TransmissionRightChain.Chain_ContractRight
range: ContractRight
required: true
multivalued: false
Ind_ContractRight:
slot_uri: cim:TransmissionRightChain.Ind_ContractRight
range: ContractRight
required: true
multivalued: true
RTO:
slot_uri: cim:TransmissionRightChain.RTO
range: RTO
required: true
multivalued: false
SchedulingCoordinator:
class_uri: cim:SchedulingCoordinator
is_a: MarketParticipant
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: Market participants could be represented by Scheduling Coordinators
(SCs) that are registered with the RTO/ISO. One participant could register multiple
SCs with the RTO/ISO. Many market participants can do business with the RTO/ISO
using a single SC. One SC could schedule multiple generators. A load scheduling
point could be used by multiple SCs. Each SC could schedule load at multiple
scheduling points. An inter-tie scheduling point can be used by multiple SCs.
Each SC can schedule interchange at multiple inter-tie scheduling points.
attributes:
creditFlag:
slot_uri: cim:SchedulingCoordinator.creditFlag
range: YesNo
required: false
multivalued: false
description: Flag to indicate creditworthiness (Y, N)
creditStartEffectiveDate:
slot_uri: cim:SchedulingCoordinator.creditStartEffectiveDate
range: date
required: false
multivalued: false
description: Date that the scheduling coordinator becomes creditworthy.
lastModified:
slot_uri: cim:SchedulingCoordinator.lastModified
range: date
required: false
multivalued: false
description: Indication of the last time this scheduling coordinator information
was modified.
qualificationStatus:
slot_uri: cim:SchedulingCoordinator.qualificationStatus
range: string
required: false
multivalued: false
description: Scheduling coordinator qualification status, Qualified, Not Qualified,
or Disqualified.
scid:
slot_uri: cim:SchedulingCoordinator.scid
range: string
required: false
multivalued: false
description: "This is the short name or Scheduling Coordinator ID field.\r\
\n"
FromSCTrade:
slot_uri: cim:SchedulingCoordinator.FromSCTrade
range: Trade
required: false
multivalued: true
ToSCTrade:
slot_uri: cim:SchedulingCoordinator.ToSCTrade
range: Trade
required: false
multivalued: true
SubmitFromSCTrade:
slot_uri: cim:SchedulingCoordinator.SubmitFromSCTrade
range: Trade
required: false
multivalued: true
TransmissionContractRight:
slot_uri: cim:SchedulingCoordinator.TransmissionContractRight
range: ContractRight
required: false
multivalued: true
SubmitToSCTrade:
slot_uri: cim:SchedulingCoordinator.SubmitToSCTrade
range: Trade
required: false
multivalued: true
MarketParticipant:
slot_uri: cim:SchedulingCoordinator.MarketParticipant
range: MarketParticipant
required: false
multivalued: false
LoadRatio:
slot_uri: cim:SchedulingCoordinator.LoadRatio
range: LoadRatio
required: true
multivalued: false
SchedulingCoordinatorUser:
slot_uri: cim:SchedulingCoordinator.SchedulingCoordinatorUser
range: SchedulingCoordinatorUser
required: false
multivalued: true
LoadRatio:
class_uri: cim:LoadRatio
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: "Representing the ratio of the load share for the associated SC.\r\
\n"
attributes:
intervalEndTime:
slot_uri: cim:LoadRatio.intervalEndTime
range: date
required: false
multivalued: false
description: "Interval End Time\r\n"
intervalStartTime:
slot_uri: cim:LoadRatio.intervalStartTime
range: date
required: false
multivalued: false
description: "Interval Start Time\r\n"
share:
slot_uri: cim:LoadRatio.share
range: PerCent
required: false
multivalued: false
description: "Share in percentage of total Market load for the selected time\
\ interval.\r\n"
SchedulingCoordinator:
slot_uri: cim:LoadRatio.SchedulingCoordinator
range: SchedulingCoordinator
required: false
multivalued: false
SchedulingCoordinatorUser:
class_uri: cim:SchedulingCoordinatorUser
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: Describing users of a Scheduling Coordinator.
attributes:
loginID:
slot_uri: cim:SchedulingCoordinatorUser.loginID
range: string
required: false
multivalued: false
description: "Login ID\r\n"
loginRole:
slot_uri: cim:SchedulingCoordinatorUser.loginRole
range: string
required: false
multivalued: false
description: "Assigned roles (these are roles with either Read or Read/Write\
\ privileges on different Market Systems)\r\n"
SchedulingCoordinator:
slot_uri: cim:SchedulingCoordinatorUser.SchedulingCoordinator
range: SchedulingCoordinator
required: true
multivalued: false
Trade:
class_uri: cim:Trade
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ParticipantInterfaces
description: "Inter Scheduling Coordinator Trades to model financial trades which\
\ may impact settlement.\r\n"
attributes:
adjustedTradeQuantity:
slot_uri: cim:Trade.adjustedTradeQuantity
range: float
required: false
multivalued: false
description: "The validated and current market accepted trade amount of a\
\ physical energy trade.\r\n"
counterTradeQuantity:
slot_uri: cim:Trade.counterTradeQuantity
range: float
required: false
multivalued: false
description: "MW quantity submitted by counter SC for the same trade\r\n"
dependOnTradeName:
slot_uri: cim:Trade.dependOnTradeName
range: string
required: false
multivalued: false
description: "The Depend On IST Name points to the unique IST Name in the\
\ chain of physical energy trades.\r\n"
lastModified:
slot_uri: cim:Trade.lastModified
range: date
required: false
multivalued: false
description: "Time and date the trade was last modified. \r\n"
marketType:
slot_uri: cim:Trade.marketType
range: MarketType
required: false
multivalued: false
startTime:
slot_uri: cim:Trade.startTime
range: date
required: false
multivalued: false
description: "Start time and date for which trade applies.\r\n"
stopTime:
slot_uri: cim:Trade.stopTime
range: date
required: false
multivalued: false
description: "Stop time and date for which trade is applicable.\r\n"
submitFromTimeStamp:
slot_uri: cim:Trade.submitFromTimeStamp
range: date
required: false
multivalued: false
description: "Timestamp of submittal of submit From Scheduling Coordinator\
\ Trade to Market Participant Bid Submittal\r\n"
submitFromUser:
slot_uri: cim:Trade.submitFromUser
range: string
required: false
multivalued: false
description: "Userid of the submit From Scheduling Coordinator trade \r\n"
submitToTimeStamp:
slot_uri: cim:Trade.submitToTimeStamp
range: date
required: false
multivalued: false
description: "Timestamp of submittal of submit To Scheduling Coordinator Trade\
\ to Market Participant Bid Submittal\r\n"
'submitToUser ':
slot_uri: cim:Trade.submitToUser%20
range: string
required: false
multivalued: false
description: "Userid of the submit To Scheduling Coordinator trade \r\n"
tradeQuantity:
slot_uri: cim:Trade.tradeQuantity
range: float
required: false
multivalued: false
description: "tradeQuantity: \r\nIf tradeType = IST, The amount of an Energy\
\ Trade. \r\nIf tradeType = AST, The amount of an Ancillary Service Obligation\
\ Trade. \r\nIf tradeType = UCT, The amount of a Unit Commitment Obligation\
\ Trade.\r\n"
tradeStatus:
slot_uri: cim:Trade.tradeStatus
range: string
required: false
multivalued: false
description: "Resulting status of the trade following the rule engine processing.\r\
\n"
updateTimeStamp:
slot_uri: cim:Trade.updateTimeStamp
range: date
required: false
multivalued: false
updateUser:
slot_uri: cim:Trade.updateUser
range: string
required: false
multivalued: false
TradeError:
slot_uri: cim:Trade.TradeError
range: TradeError
required: false
multivalued: true
RegisteredGenerator:
slot_uri: cim:Trade.RegisteredGenerator
range: RegisteredGenerator
required: false
multivalued: false
From_SC:
slot_uri: cim:Trade.From_SC
range: SchedulingCoordinator
required: true
multivalued: false
To_SC:
slot_uri: cim:Trade.To_SC
range: SchedulingCoordinator
required: true
multivalued: false
ActionRequest:
slot_uri: cim:Trade.ActionRequest
range: ActionRequest
required: true
multivalued: false
submitFromSchedulingCoordinator:
slot_uri: cim:Trade.submitFromSchedulingCoordinator
range: SchedulingCoordinator
required: false
multivalued: false
TradeProduct:
slot_uri: cim:Trade.TradeProduct
range: TradeProduct
required: true
multivalued: false
submitToSchedulingCoordinator:
slot_uri: cim:Trade.submitToSchedulingCoordinator
range: SchedulingCoordinator
required: false
multivalued: false
Pnode:
slot_uri: cim:Trade.Pnode
range: Pnode
required: false
multivalued: false
RegisteredGenerator:
class_uri: cim:RegisteredGenerator
is_a: RegisteredResource
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: Model of a generator that is registered to participate in the market.
attributes:
capacityFactor:
slot_uri: cim:RegisteredGenerator.capacityFactor
range: PerCent
required: false
multivalued: false
description: The ratio of actual energy produced by resource divided by the
maximum potential energy if the resource is fully utilized. As an example,
wind farms.
coldStartTime:
slot_uri: cim:RegisteredGenerator.coldStartTime
range: float
required: false
multivalued: false
description: "Cold start time.\r\n"
combinedCycleOperatingMode:
slot_uri: cim:RegisteredGenerator.combinedCycleOperatingMode
range: string
required: false
multivalued: false
description: Combined Cycle operating mode.
commericialOperationDate:
slot_uri: cim:RegisteredGenerator.commericialOperationDate
range: date
required: false
multivalued: false
constrainedOutputFlag:
slot_uri: cim:RegisteredGenerator.constrainedOutputFlag
range: YesNo
required: false
multivalued: false
description: "Constrained Output Generator (COG) Indicator (Yes/No), per Generating\
\ Resource\r\n"
energyDownRampRate:
slot_uri: cim:RegisteredGenerator.energyDownRampRate
range: ActivePowerChangeRate
required: false
multivalued: false
description: Response rate in MW per minute for ramping energy down.
energyUpRampRate:
slot_uri: cim:RegisteredGenerator.energyUpRampRate
range: ActivePowerChangeRate
required: false
multivalued: false
description: Response rate in MW per minute for ramping energy up.
extremeLongStart:
slot_uri: cim:RegisteredGenerator.extremeLongStart
range: YesNo
required: false
multivalued: false
description: Some long-start up time units may need to receive start up instruction
before DA market results are available. Long-Start resources may be either
physical resources within the control with start-up times greater than 18
hours or the long-start contractual inter-tie commitment that shall be completed
by 6 am one-day ahead. Therefore, there is a need for a process to determine
the commitment of such resources before the DA market.
fuelSource:
slot_uri: cim:RegisteredGenerator.fuelSource
range: FuelSource
required: false
multivalued: false
description: "Values: Natural Gas Based Resource, Non Natural Gas Based Resource\r\
\n\"NG\" - Natural-Gas-Based Resource - a Resource that is powered by Natural\
\ Gas\r\n\"NNG\" - Non-Natural-Gas-Based Resource - a Resouce that is powered\
\ by some other fuel than Natural Gas\r\n"
highControlLimit:
slot_uri: cim:RegisteredGenerator.highControlLimit
range: ActivePower
required: false
multivalued: false
description: "High limit for secondary (AGC) control\r\n"
hotIntTime:
slot_uri: cim:RegisteredGenerator.hotIntTime
range: float
required: false
multivalued: false
description: "Hot-to-intermediate time (Seasonal)\r\n"
hotStartTime:
slot_uri: cim:RegisteredGenerator.hotStartTime
range: float
required: false
multivalued: false
description: "Hot start time.\r\n"
intColdTime:
slot_uri: cim:RegisteredGenerator.intColdTime
range: float
required: false
multivalued: false
description: "Intermediate-to-cold time (Seasonal)\r\n"
intStartTime:
slot_uri: cim:RegisteredGenerator.intStartTime
range: float
required: false
multivalued: false
description: "Intermediate start time.\r\n"
loadFollowingDownMSS:
slot_uri: cim:RegisteredGenerator.loadFollowingDownMSS
range: YesNo
required: false
multivalued: false
description: "Certifies resources for use in MSS Load Following Down\r\n"
loadFollowingUpMSS:
slot_uri: cim:RegisteredGenerator.loadFollowingUpMSS
range: YesNo
required: false
multivalued: false
description: "Certifies resources for use in MSS Load Following Up\r\n"
lowControlLImit:
slot_uri: cim:RegisteredGenerator.lowControlLImit
range: ActivePower
required: false
multivalued: false
description: "Low limit for secondary (AGC) control\r\n"
maxDependableCap:
slot_uri: cim:RegisteredGenerator.maxDependableCap
range: ActivePower
required: false
multivalued: false
description: Maximum Dependable Capacity (MNDC). Maximun Net Dependable Capacity
is used in association with an RMR contract.
maximumAllowableSpinningReserve:
slot_uri: cim:RegisteredGenerator.maximumAllowableSpinningReserve
range: ActivePower
required: false
multivalued: false
description: "Maximum allowable spinning reserve. Spinning reserve will never\
\ be considered greater than this value regardless of the current operating\
\ point.\r\n"
maximumOperatingLimit:
slot_uri: cim:RegisteredGenerator.maximumOperatingLimit
range: ActivePower
required: false
multivalued: false
description: This is the maximum operating MW limit the dispatcher can enter
for this unit
maxMinLoadCost:
slot_uri: cim:RegisteredGenerator.maxMinLoadCost
range: CostRate
required: false
multivalued: false
description: "The registered maximum Minimum Load Cost of a Generating Resource\
\ registered with a Cost Basis of \"Bid Cost\".\r\n"
maxPumpingLevel:
slot_uri: cim:RegisteredGenerator.maxPumpingLevel
range: ActivePower
required: false
multivalued: false
description: "max pumping level of a hydro pump unit\r\n"
maxShutdownTime:
slot_uri: cim:RegisteredGenerator.maxShutdownTime
range: date
required: false
multivalued: false
description: "Maximum time this device can be shut down.\r\n"
maxStartUpsPerDay:
slot_uri: cim:RegisteredGenerator.maxStartUpsPerDay
range: integer
required: false
multivalued: false
description: "maximum start ups per day\r\n"
maxWeeklyEnergy:
slot_uri: cim:RegisteredGenerator.maxWeeklyEnergy
range: float
required: false
multivalued: false
description: "Maximum weekly Energy (Seasonal)\r\n"
maxWeeklyStarts:
slot_uri: cim:RegisteredGenerator.maxWeeklyStarts
range: integer
required: false
multivalued: false
description: "Maximum weekly starts (seasonal parameter)\r\n"
minimumLoadCostBasis:
slot_uri: cim:RegisteredGenerator.minimumLoadCostBasis
range: CostBasis
required: false
multivalued: false
description: The cost basis for minimum load.
minimumLoadFuelCost:
slot_uri: cim:RegisteredGenerator.minimumLoadFuelCost
range: CostPerHeatUnit
required: false
multivalued: false
description: "The cost for the fuel required to get a Generating Resource\
\ to operate at the minimum load level\r\n"
minimumOperatingLimit:
slot_uri: cim:RegisteredGenerator.minimumOperatingLimit
range: ActivePower
required: false
multivalued: false
description: This is the minimum operating MW limit the dispatcher can enter
for this unit.
minLoadCost:
slot_uri: cim:RegisteredGenerator.minLoadCost
range: CostRate
required: false
multivalued: false
description: "minimum load cost. Value is (currency/hr)\r\n"
mustOfferRA:
slot_uri: cim:RegisteredGenerator.mustOfferRA
range: YesNo
required: false
multivalued: false
description: "Flag to indicate that this unit is a resource adequacy resource\
\ and must offer.\r\n"
nameplateCapacity:
slot_uri: cim:RegisteredGenerator.nameplateCapacity
range: ActivePower
required: false
multivalued: false
description: "MW value stated on the nameplate of the Generator -- the value\
\ it potentially could provide.\r\n"
operatingMaintenanceCost:
slot_uri: cim:RegisteredGenerator.operatingMaintenanceCost
range: CostPerEnergyUnit
required: false
multivalued: false
description: "The portion of the Operating Cost of a Generating Resource that\
\ is not related to fuel cost.\r\n"
pumpingCost:
slot_uri: cim:RegisteredGenerator.pumpingCost
range: CostRate
required: false
multivalued: false
pumpingFactor:
slot_uri: cim:RegisteredGenerator.pumpingFactor
range: float
required: false
multivalued: false
description: "Pumping factor for pump storage units, conversion factor between\
\ generating and pumping.\r\n"
pumpMinDownTime:
slot_uri: cim:RegisteredGenerator.pumpMinDownTime
range: float
required: false
multivalued: false
description: "The minimum down time for the pump in a pump storage unit.\r\
\n"
pumpMinUpTime:
slot_uri: cim:RegisteredGenerator.pumpMinUpTime
range: float
required: false
multivalued: false
description: "The minimum up time aspect for the pump in a pump storage unit\r\
\n"
pumpShutdownCost:
slot_uri: cim:RegisteredGenerator.pumpShutdownCost
range: float
required: false
multivalued: false
description: "The cost to shutdown a pump during the pump aspect of a pump\
\ storage unit.\r\n"
pumpShutdownTime:
slot_uri: cim:RegisteredGenerator.pumpShutdownTime
range: integer
required: false
multivalued: false
description: "The shutdown time (minutes) of the pump aspect of a pump storage\
\ unit.\r\n"
quickStartFlag:
slot_uri: cim:RegisteredGenerator.quickStartFlag
range: YesNo
required: false
multivalued: false
description: Quick start flag (Yes/No). Identifies the registered generator
as a quick start unit. A quick start unit is a unit that has the ability
to be available for load within a 30 minute period.
rampCurveType:
slot_uri: cim:RegisteredGenerator.rampCurveType
range: RampCurveType
required: false
multivalued: false
description: Ramp curve type. Identifies the type of curve which may be a
fixed, static or dynamic.
regulationDownRampRate:
slot_uri: cim:RegisteredGenerator.regulationDownRampRate
range: ActivePowerChangeRate
required: false
multivalued: false
description: Regulation down response rate in MW per minute
regulationFlag:
slot_uri: cim:RegisteredGenerator.regulationFlag
range: UnitRegulationKind
required: false
multivalued: false
description: Specifies if the unit is regulating or not regulating or expected
to be regulating but is not.
regulationUpRampRate:
slot_uri: cim:RegisteredGenerator.regulationUpRampRate
range: ActivePowerChangeRate
required: false
multivalued: false
description: Regulation up response rate in MW per minute.
resourceSubType:
slot_uri: cim:RegisteredGenerator.resourceSubType
range: string
required: false
multivalued: false
description: Unit sub type used by Settlements or scheduling application.
Application use of the unit sub type may define the necessary types as applicable.
riverSystem:
slot_uri: cim:RegisteredGenerator.riverSystem
range: string
required: false
multivalued: false
description: "River System the Resource is tied to.\r\n"
RMNRFlag:
slot_uri: cim:RegisteredGenerator.RMNRFlag
range: YesNo
required: false
multivalued: false
description: "Reliability must not run (RMNR) flag: indicated whether the\
\ RMR unit is set as an RMNR in the current market\r\n"
RMRFlag:
slot_uri: cim:RegisteredGenerator.RMRFlag
range: FlagTypeRMR
required: false
multivalued: false
description: "Reliability must run (RMR) flag: indicates whether the unit\
\ is RMR; Indicates whether the unit is RMR:\r\nN' - not an RMR unit\r\n\
'1' - RMR Condition 1 unit\r\n'2' - RMR Condition 2 unit\r\n"
RMRManualIndicator:
slot_uri: cim:RegisteredGenerator.RMRManualIndicator
range: YesNo
required: false
multivalued: false
description: "Indicates the RMR Manual pre-determination status [Y/N]\r\n"
RMTFlag:
slot_uri: cim:RegisteredGenerator.RMTFlag
range: YesNo
required: false
multivalued: false
description: "Reliability must take (RMT) flag (Yes/No): indicates whether\
\ the unit is RMT\r\n"
spinRampRate:
slot_uri: cim:RegisteredGenerator.spinRampRate
range: ActivePowerChangeRate
required: false
multivalued: false
description: Response rate in MW per minute for spinning reserve.
startUpCostBasis:
slot_uri: cim:RegisteredGenerator.startUpCostBasis
range: CostBasis
required: false
multivalued: false
description: The cost basis for start up.
syncCondCapable:
slot_uri: cim:RegisteredGenerator.syncCondCapable
range: YesNo
required: false
multivalued: false
description: "Is the Resource Synchronous Condenser capable Resource? \r\n"
unitType:
slot_uri: cim:RegisteredGenerator.unitType
range: UnitType
required: false
multivalued: false
description: "Generating unit type: Combined Cycle, Gas Turbine, Hydro Turbine,\
\ Other, Photovoltaic, Hydro Pump-Turbine, Reciprocating Engine, Steam Turbine,\
\ Synchronous Condenser, Wind Turbine\r\n"
useLimitFlag:
slot_uri: cim:RegisteredGenerator.useLimitFlag
range: YesNo
required: false
multivalued: false
description: "Use limit flag: indicates if the use-limited resource is fully\
\ scheduled (or has some slack for real-time dispatch) (Y/N)\r\n"
variableEnergyResource:
slot_uri: cim:RegisteredGenerator.variableEnergyResource
range: YesNo
required: false
multivalued: false
description: Provides an indication that this resource is intending to participate
in an intermittent resource program.
Trade:
slot_uri: cim:RegisteredGenerator.Trade
range: Trade
required: false
multivalued: true
MktHeatRateCurve:
slot_uri: cim:RegisteredGenerator.MktHeatRateCurve
range: MktHeatRateCurve
required: false
multivalued: false
RMRStartUpEnergyCurve:
slot_uri: cim:RegisteredGenerator.RMRStartUpEnergyCurve
range: RMRStartUpEnergyCurve
required: false
multivalued: false
RMRStartUpTimeCurve:
slot_uri: cim:RegisteredGenerator.RMRStartUpTimeCurve
range: RMRStartUpTimeCurve
required: false
multivalued: false
StartUpEnergyCurve:
slot_uri: cim:RegisteredGenerator.StartUpEnergyCurve
range: StartUpEnergyCurve
required: false
multivalued: false
StartUpTimeCurve:
slot_uri: cim:RegisteredGenerator.StartUpTimeCurve
range: StartUpTimeCurve
required: false
multivalued: false
RegulatingLimit:
slot_uri: cim:RegisteredGenerator.RegulatingLimit
range: RegulatingLimit
required: false
multivalued: false
StartUpFuelCurve:
slot_uri: cim:RegisteredGenerator.StartUpFuelCurve
range: StartUpFuelCurve
required: false
multivalued: false
GeneratingBids:
slot_uri: cim:RegisteredGenerator.GeneratingBids
range: GeneratingBid
required: false
multivalued: true
RMRStartUpCostCurve:
slot_uri: cim:RegisteredGenerator.RMRStartUpCostCurve
range: RMRStartUpCostCurve
required: false
multivalued: false
RMRStartUpFuelCurve:
slot_uri: cim:RegisteredGenerator.RMRStartUpFuelCurve
range: RMRStartUpFuelCurve
required: false
multivalued: false
RMRHeatRateCurve:
slot_uri: cim:RegisteredGenerator.RMRHeatRateCurve
range: RMRHeatRateCurve
required: false
multivalued: false
FuelRegion:
slot_uri: cim:RegisteredGenerator.FuelRegion
range: FuelRegion
required: false
multivalued: false
LocalReliabilityArea:
slot_uri: cim:RegisteredGenerator.LocalReliabilityArea
range: LocalReliabilityArea
required: false
multivalued: false
StartUpCostCurves:
slot_uri: cim:RegisteredGenerator.StartUpCostCurves
range: StartUpCostCurve
required: false
multivalued: true
EnergyPriceIndex:
slot_uri: cim:RegisteredGenerator.EnergyPriceIndex
range: EnergyPriceIndex
required: true
multivalued: false
AuxillaryObject:
slot_uri: cim:RegisteredGenerator.AuxillaryObject
range: AuxiliaryObject
required: false
multivalued: true
FuelCostCurve:
slot_uri: cim:RegisteredGenerator.FuelCostCurve
range: FuelCostCurve
required: false
multivalued: false
UnitInitialConditions:
slot_uri: cim:RegisteredGenerator.UnitInitialConditions
range: UnitInitialConditions
required: false
multivalued: true
FuelRegion:
class_uri: cim:FuelRegion
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: Indication of region for fuel inventory purposes.
attributes:
fuelRegionType:
slot_uri: cim:FuelRegion.fuelRegionType
range: string
required: false
multivalued: false
description: "The type of fuel region\r\n"
lastModified:
slot_uri: cim:FuelRegion.lastModified
range: date
required: false
multivalued: false
description: "Time of last update\r\n"
RegisteredGenerator:
slot_uri: cim:FuelRegion.RegisteredGenerator
range: RegisteredGenerator
required: false
multivalued: true
GasPrice:
slot_uri: cim:FuelRegion.GasPrice
range: GasPrice
required: true
multivalued: false
OilPrice:
slot_uri: cim:FuelRegion.OilPrice
range: OilPrice
required: true
multivalued: false
RTO:
slot_uri: cim:FuelRegion.RTO
range: RTO
required: true
multivalued: false
GasPrice:
class_uri: cim:GasPrice
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: Price of gas in monetary units.
attributes:
gasPriceIndex:
slot_uri: cim:GasPrice.gasPriceIndex
range: float
required: false
multivalued: false
description: "The average natural gas price at a defined fuel region.\r\n"
FuelRegion:
slot_uri: cim:GasPrice.FuelRegion
range: FuelRegion
required: true
multivalued: false
OilPrice:
class_uri: cim:OilPrice
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: "Price of oil in monetary units.\r\n"
attributes:
oilPriceIndex:
slot_uri: cim:OilPrice.oilPriceIndex
range: float
required: false
multivalued: false
description: "The average oil price at a defined fuel region.\r\n"
FuelRegion:
slot_uri: cim:OilPrice.FuelRegion
range: FuelRegion
required: true
multivalued: false
LocalReliabilityArea:
class_uri: cim:LocalReliabilityArea
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: "Allows definition of reliability areas (e.g.. load pockets) within\
\ the ISO/RTO.\r\n"
attributes:
RegisteredGenerator:
slot_uri: cim:LocalReliabilityArea.RegisteredGenerator
range: RegisteredGenerator
required: false
multivalued: true
RTO:
slot_uri: cim:LocalReliabilityArea.RTO
range: RTO
required: true
multivalued: false
StartUpCostCurve:
class_uri: cim:StartUpCostCurve
is_a: Curve
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ParticipantInterfaces
description: "Startup costs and time as a function of down time. Relationship\
\ between unit startup cost (Y1-axis) vs. unit elapsed down time (X-axis). \r\
\n"
attributes:
GeneratingBid:
slot_uri: cim:StartUpCostCurve.GeneratingBid
range: GeneratingBid
required: false
multivalued: true
RegisteredGenerators:
slot_uri: cim:StartUpCostCurve.RegisteredGenerators
range: RegisteredGenerator
required: false
multivalued: true
GeneratingBid:
class_uri: cim:GeneratingBid
is_a: ResourceBid
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ParticipantInterfaces
description: Offer to supply energy/ancillary services from a generating unit
or resource.
attributes:
combinedCycleUnitOffer:
slot_uri: cim:GeneratingBid.combinedCycleUnitOffer
range: string
required: false
multivalued: false
description: "Will indicate if the unit is part of a CC offer or not\r\n"
downTimeMax:
slot_uri: cim:GeneratingBid.downTimeMax
range: float
required: false
multivalued: false
description: "Maximum down time.\r\n"
installedCapacity:
slot_uri: cim:GeneratingBid.installedCapacity
range: float
required: false
multivalued: false
description: "Installed Capacity value\r\n"
lowerRampRate:
slot_uri: cim:GeneratingBid.lowerRampRate
range: ActivePowerChangeRate
required: false
multivalued: false
description: "Maximum Dn ramp rate in MW/min\r\n"
maxEmergencyMW:
slot_uri: cim:GeneratingBid.maxEmergencyMW
range: ActivePower
required: false
multivalued: false
description: "Power rating available for unit under emergency conditions greater\
\ than or equal to maximum economic limit.\r\n"
maximumEconomicMW:
slot_uri: cim:GeneratingBid.maximumEconomicMW
range: float
required: false
multivalued: false
description: "Maximum high economic MW limit, that should not exceed the maximum\
\ operating MW limit\r\n"
minEmergencyMW:
slot_uri: cim:GeneratingBid.minEmergencyMW
range: ActivePower
required: false
multivalued: false
description: "Minimum power rating for unit under emergency conditions, which\
\ is less than or equal to the economic minimum.\r\n"
minimumEconomicMW:
slot_uri: cim:GeneratingBid.minimumEconomicMW
range: float
required: false
multivalued: false
description: Low economic MW limit that shall be greater than or equal to
the minimum operating MW limit
noLoadCost:
slot_uri: cim:GeneratingBid.noLoadCost
range: float
required: false
multivalued: false
description: "Resource fixed no load cost.\r\n"
notificationTime:
slot_uri: cim:GeneratingBid.notificationTime
range: float
required: false
multivalued: false
description: "Time required for crew notification prior to start up of the\
\ unit.\r\n"
operatingMode:
slot_uri: cim:GeneratingBid.operatingMode
range: string
required: false
multivalued: false
description: "Bid operating mode ('C' - cycling, 'F' - fixed, 'M' - must run,\
\ 'U' - unavailable)\r\n"
raiseRampRate:
slot_uri: cim:GeneratingBid.raiseRampRate
range: ActivePowerChangeRate
required: false
multivalued: false
description: "Maximum Up ramp rate in MW/min\r\n"
rampCurveType:
slot_uri: cim:GeneratingBid.rampCurveType
range: integer
required: false
multivalued: false
description: "Ramp curve type:\r\n0 - Fixed ramp rate independent of rate\
\ function unit MW output\r\n1 - Static ramp rates as a function of unit\
\ MW output only \r\n2 - Dynamic ramp rates as a function of unit MW output\
\ and ramping time\r\n"
startupCost:
slot_uri: cim:GeneratingBid.startupCost
range: float
required: false
multivalued: false
description: "Startup cost/price\r\n"
startUpRampRate:
slot_uri: cim:GeneratingBid.startUpRampRate
range: ActivePowerChangeRate
required: false
multivalued: false
description: "Resource startup ramp rate (MW/minute)\r\n"
startUpType:
slot_uri: cim:GeneratingBid.startUpType
range: integer
required: false
multivalued: false
description: "Resource startup type:\r\n1 - Fixed startup time and fixed startup\
\ cost\r\n2 - Startup time as a function of down time and fixed startup\
\ cost\r\n3 - Startup cost as a function of down time\r\n"
upTimeMax:
slot_uri: cim:GeneratingBid.upTimeMax
range: float
required: false
multivalued: false
description: "Maximum up time.\r\n"
NotificationTimeCurve:
slot_uri: cim:GeneratingBid.NotificationTimeCurve
range: NotificationTimeCurve
required: false
multivalued: false
RampRateCurve:
slot_uri: cim:GeneratingBid.RampRateCurve
range: RampRateCurve
required: false
multivalued: true
BidSet:
slot_uri: cim:GeneratingBid.BidSet
range: BidSet
required: false
multivalued: false
SecurityConstraints:
slot_uri: cim:GeneratingBid.SecurityConstraints
range: SecurityConstraints
required: false
multivalued: true
StartUpCostCurve:
slot_uri: cim:GeneratingBid.StartUpCostCurve
range: StartUpCostCurve
required: false
multivalued: false
StartUpTimeCurve:
slot_uri: cim:GeneratingBid.StartUpTimeCurve
range: StartUpTimeCurve
required: false
multivalued: false
RegisteredGenerator:
slot_uri: cim:GeneratingBid.RegisteredGenerator
range: RegisteredGenerator
required: false
multivalued: false
ResourceBid:
class_uri: cim:ResourceBid
is_a: Bid
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ParticipantInterfaces
description: Energy bid for generation, load, or virtual type for the whole of
the market-trading period (i.e., one day in day ahead market or one hour in
the real time market).
attributes:
aggregationFlag:
slot_uri: cim:ResourceBid.aggregationFlag
range: integer
required: false
multivalued: false
description: "Aggregation flag \r\n0: individual resource level\r\n1: Aggregated\
\ node location\r\n2: Aggregated price location)\r\n"
bidStatus:
slot_uri: cim:ResourceBid.bidStatus
range: string
required: false
multivalued: false
commodityType:
slot_uri: cim:ResourceBid.commodityType
range: string
required: false
multivalued: false
description: "Energy product (commodity) type:\r\n'En' - Energy\r\n'Ru' -\
\ Regulation Up\r\n'Rd' - Regulation Dn\r\n'Sr' - Spinning Reserve\r\n'Nr'\
\ - Non-Spinning Reserve\r\n'Or' - Operating Reserve\r\n"
contingencyAvailFlag:
slot_uri: cim:ResourceBid.contingencyAvailFlag
range: YesNo
required: false
multivalued: false
description: "contingent operating reserve availiability (Yes/No). Resource\
\ is availiable to participate with capacity only in contingency dispatch.\r\
\n"
createdISO:
slot_uri: cim:ResourceBid.createdISO
range: YesNo
required: false
multivalued: false
description: "A Yes indicates that this bid was created by the ISO.\r\n"
energyMaxDay:
slot_uri: cim:ResourceBid.energyMaxDay
range: float
required: false
multivalued: false
description: "Maximum amount of energy per day which can be produced during\
\ the trading period in MWh\r\n"
energyMinDay:
slot_uri: cim:ResourceBid.energyMinDay
range: float
required: false
multivalued: false
description: "Minimum amount of energy per day which has to be produced during\
\ the trading period in MWh\r\n"
marketSepFlag:
slot_uri: cim:ResourceBid.marketSepFlag
range: string
required: false
multivalued: false
description: "Market Separation Flag\r\n\r\n'Y' - Enforce market separation\
\ constraints for this bid \r\n'N' - Don't enforce market separation constraints\
\ for this bid.\r\n"
minDispatchTime:
slot_uri: cim:ResourceBid.minDispatchTime
range: integer
required: false
multivalued: false
description: 'minimum number of consecutive hours a resource shall be dispatched
if bid is accepted '
resourceLoadingType:
slot_uri: cim:ResourceBid.resourceLoadingType
range: integer
required: false
multivalued: false
description: "Resource loading curve type\r\n1 - step-wise continuous loading\r\
\n2 - piece-wise linear continuous loading\r\n3 - block loading\r\n"
shutDownsMaxDay:
slot_uri: cim:ResourceBid.shutDownsMaxDay
range: integer
required: false
multivalued: false
description: "Maximum number of shutdowns per day.\r\n"
shutDownsMaxWeek:
slot_uri: cim:ResourceBid.shutDownsMaxWeek
range: integer
required: false
multivalued: false
description: "Maximum number of shutdowns per week.\r\n"
startUpsMaxDay:
slot_uri: cim:ResourceBid.startUpsMaxDay
range: integer
required: false
multivalued: false
description: "Maximum number of startups per day.\r\n"
startUpsMaxWeek:
slot_uri: cim:ResourceBid.startUpsMaxWeek
range: integer
required: false
multivalued: false
description: "Maximum number of startups per week.\r\n"
virtual:
slot_uri: cim:ResourceBid.virtual
range: boolean
required: false
multivalued: false
description: "True if bid is virtual. Bid is assumed to be non-virtual if\
\ attribute is absent\r\n"
BidError:
slot_uri: cim:ResourceBid.BidError
range: BidError
required: false
multivalued: true
BidError:
class_uri: cim:BidError
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ParticipantInterfaces
description: "This class represent the error information for a bid that is detected\
\ during bid validation.\r\n"
attributes:
componentType:
slot_uri: cim:BidError.componentType
range: string
required: false
multivalued: false
endTime:
slot_uri: cim:BidError.endTime
range: date
required: false
multivalued: false
description: "hour wihthin the bid for which the error applies\r\n"
errMessage:
slot_uri: cim:BidError.errMessage
range: string
required: false
multivalued: false
description: "error message\r\n"
errPriority:
slot_uri: cim:BidError.errPriority
range: integer
required: false
multivalued: false
description: "Priority number for the error message\r\n"
logTimeStamp:
slot_uri: cim:BidError.logTimeStamp
range: date
required: false
multivalued: false
msgLevel:
slot_uri: cim:BidError.msgLevel
range: integer
required: false
multivalued: false
ruleID:
slot_uri: cim:BidError.ruleID
range: integer
required: false
multivalued: false
startTime:
slot_uri: cim:BidError.startTime
range: date
required: false
multivalued: false
description: "hour wihthin the bid for which the error applies\r\n"
ResourceBid:
slot_uri: cim:BidError.ResourceBid
range: ResourceBid
required: false
multivalued: true
MarketProduct:
slot_uri: cim:BidError.MarketProduct
range: MarketProduct
required: false
multivalued: false
StartUpTimeCurve:
class_uri: cim:StartUpTimeCurve
is_a: Curve
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ParticipantInterfaces
description: "Startup time curve as a function of down time, where time is specified\
\ in minutes. Relationship between unit startup time (Y1-axis) vs. unit elapsed\
\ down time (X-axis).\r\n"
attributes:
GeneratingBid:
slot_uri: cim:StartUpTimeCurve.GeneratingBid
range: GeneratingBid
required: false
multivalued: true
RegisteredGenerator:
slot_uri: cim:StartUpTimeCurve.RegisteredGenerator
range: RegisteredGenerator
required: false
multivalued: false
NotificationTimeCurve:
class_uri: cim:NotificationTimeCurve
is_a: Curve
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ParticipantInterfaces
description: "Notification time curve as a function of down time. Relationship\
\ between crew notification time (Y1-axis) and unit startup time (Y2-axis) vs.\
\ unit elapsed down time (X-axis).\r\n"
attributes:
GeneratingBids:
slot_uri: cim:NotificationTimeCurve.GeneratingBids
range: GeneratingBid
required: false
multivalued: true
RampRateCurve:
class_uri: cim:RampRateCurve
is_a: Curve
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ParticipantInterfaces
description: Ramp rate as a function of resource MW output.
attributes:
condition:
slot_uri: cim:RampRateCurve.condition
range: RampRateCondition
required: false
multivalued: false
description: "condition for the ramp rate\r\n"
constraintRampType:
slot_uri: cim:RampRateCurve.constraintRampType
range: ConstraintRampType
required: false
multivalued: false
description: "The condition that identifies whether a Generating Resource\
\ should be constrained from Ancillary Service provision if its Schedule\
\ or Dispatch change across Trading Hours or Trading Intervals requires\
\ more than a specified fraction of the duration of the Trading Hour or\
\ Trading Interval. \r\n\r\nValid values are Fast/Slow\r\n"
rampRateType:
slot_uri: cim:RampRateCurve.rampRateType
range: RampRateType
required: false
multivalued: false
description: How ramp rate is applied (e.g. raise or lower, as when applied
to a generation resource)
InterTieBid:
slot_uri: cim:RampRateCurve.InterTieBid
range: InterTieBid
required: false
multivalued: false
LoadBid:
slot_uri: cim:RampRateCurve.LoadBid
range: LoadBid
required: false
multivalued: false
RegisteredResource:
slot_uri: cim:RampRateCurve.RegisteredResource
range: RegisteredResource
required: false
multivalued: true
GeneratingBid:
slot_uri: cim:RampRateCurve.GeneratingBid
range: GeneratingBid
required: false
multivalued: false
InterTieBid:
class_uri: cim:InterTieBid
is_a: ResourceBid
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ParticipantInterfaces
description: "This class represents the inter tie bid.\r\n"
attributes:
'minHourlyBlock ':
slot_uri: cim:InterTieBid.minHourlyBlock%20
range: integer
required: false
multivalued: false
description: "The minimum hourly block for an Inter-Tie Resource supplied\
\ within the bid.\r\n"
RampRateCurve:
slot_uri: cim:InterTieBid.RampRateCurve
range: RampRateCurve
required: false
multivalued: true
RegisteredInterTie:
slot_uri: cim:InterTieBid.RegisteredInterTie
range: RegisteredInterTie
required: false
multivalued: false
RegisteredInterTie:
class_uri: cim:RegisteredInterTie
is_a: RegisteredResource
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: "This class represents the inter tie resource.\r\n"
attributes:
direction:
slot_uri: cim:RegisteredInterTie.direction
range: InterTieDirection
required: false
multivalued: false
description: Indicates the direction (export/import) of an InterTie resource.
energyProductType:
slot_uri: cim:RegisteredInterTie.energyProductType
range: EnergyProductType
required: false
multivalued: false
description: "Under each major product type, the commodity type can be applied\
\ to further specify the type.\r\n"
isDCTie:
slot_uri: cim:RegisteredInterTie.isDCTie
range: YesNo
required: false
multivalued: false
description: "Flag to indicated whether this Inter-tie is a DC Tie.\r\n"
isDynamicInterchange:
slot_uri: cim:RegisteredInterTie.isDynamicInterchange
range: YesNo
required: false
multivalued: false
description: Specifies whether the inter-tie resource is registered for the
dynamic interchange.
minHourlyBlockLimit:
slot_uri: cim:RegisteredInterTie.minHourlyBlockLimit
range: integer
required: false
multivalued: false
description: The registered upper bound of minimum hourly block for an Inter-Tie
Resource.
InterTieDispatchResponse:
slot_uri: cim:RegisteredInterTie.InterTieDispatchResponse
range: InterTieDispatchResponse
required: false
multivalued: true
WheelingCounterParty:
slot_uri: cim:RegisteredInterTie.WheelingCounterParty
range: WheelingCounterParty
required: false
multivalued: true
Flowgate:
slot_uri: cim:RegisteredInterTie.Flowgate
range: Flowgate
required: true
multivalued: false
InterTieBid:
slot_uri: cim:RegisteredInterTie.InterTieBid
range: InterTieBid
required: false
multivalued: false
InterchangeSchedule:
slot_uri: cim:RegisteredInterTie.InterchangeSchedule
range: InterchangeSchedule
required: false
multivalued: true
WheelingCounterParty:
class_uri: cim:WheelingCounterParty
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: Counter party in a wheeling transaction.
attributes:
RegisteredInterTie:
slot_uri: cim:WheelingCounterParty.RegisteredInterTie
range: RegisteredInterTie
required: false
multivalued: true
InterchangeSchedule:
class_uri: cim:InterchangeSchedule
is_a: Curve
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.ExternalInputs
description: "Interchange schedule class to hold information for interchange schedules\
\ such as import export type, energy type, and etc.\r\n"
attributes:
checkOutType:
slot_uri: cim:InterchangeSchedule.checkOutType
range: CheckOutType
required: false
multivalued: false
description: "To indicate a check out type such as adjusted capacity or dispatch\
\ capacity.\r\n"
directionType:
slot_uri: cim:InterchangeSchedule.directionType
range: InterTieDirection
required: false
multivalued: false
description: "Import or export.\r\n"
energyType:
slot_uri: cim:InterchangeSchedule.energyType
range: MarketProductType
required: false
multivalued: false
description: "Energy product type.\r\n"
intervalLength:
slot_uri: cim:InterchangeSchedule.intervalLength
range: integer
required: false
multivalued: false
description: "Interval length.\r\n"
marketType:
slot_uri: cim:InterchangeSchedule.marketType
range: MarketType
required: false
multivalued: false
description: "Market type.\r\n"
operatingDate:
slot_uri: cim:InterchangeSchedule.operatingDate
range: date
required: false
multivalued: false
description: "Operating date, hour.\r\n"
outOfMarketType:
slot_uri: cim:InterchangeSchedule.outOfMarketType
range: boolean
required: false
multivalued: false
description: "To indicate an out-of-market (OOM) schedule.\r\n"
scheduleType:
slot_uri: cim:InterchangeSchedule.scheduleType
range: EnergyProductType
required: false
multivalued: false
description: "Schedule type.\r\n"
wcrID:
slot_uri: cim:InterchangeSchedule.wcrID
range: string
required: false
multivalued: false
description: "Wheeling Counter-Resource ID (required when Schedule Type=Wheel).\r\
\n"
InterchangeETCData:
slot_uri: cim:InterchangeSchedule.InterchangeETCData
range: InterchangeETCData
required: false
multivalued: true
RegisteredInterTie:
slot_uri: cim:InterchangeSchedule.RegisteredInterTie
range: RegisteredInterTie
required: false
multivalued: false
InterTie:
slot_uri: cim:InterchangeSchedule.InterTie
range: SchedulingPoint
required: false
multivalued: false
InterchangeETCData:
class_uri: cim:InterchangeETCData
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.ExternalInputs
description: "Existing Transmission Contract data for an interchange schedule.\r\
\n"
attributes:
contractNumber:
slot_uri: cim:InterchangeETCData.contractNumber
range: string
required: false
multivalued: false
description: "Existing transmission contract number\r\n"
usageMW:
slot_uri: cim:InterchangeETCData.usageMW
range: float
required: false
multivalued: false
description: "Existing transmission contract usage MW value\r\n"
InterchangeSchedule:
slot_uri: cim:InterchangeETCData.InterchangeSchedule
range: InterchangeSchedule
required: false
multivalued: false
SchedulingPoint:
class_uri: cim:SchedulingPoint
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: Connection to other organizations at the boundary of the ISO/RTO.
attributes:
Flowgate:
slot_uri: cim:SchedulingPoint.Flowgate
range: Flowgate
required: false
multivalued: false
RegisteredResource:
slot_uri: cim:SchedulingPoint.RegisteredResource
range: RegisteredResource
required: false
multivalued: true
InterchangeSchedule:
slot_uri: cim:SchedulingPoint.InterchangeSchedule
range: InterchangeSchedule
required: false
multivalued: true
InterTieDispatchResponse:
class_uri: cim:InterTieDispatchResponse
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ParticipantInterfaces
description: "Response from an intertie resource acknowledging receipt of dispatch\
\ instructions.\r\n"
attributes:
acceptMW:
slot_uri: cim:InterTieDispatchResponse.acceptMW
range: float
required: false
multivalued: false
description: "The accepted mw amount by the responder. aka response mw. \r\
\n"
acceptStatus:
slot_uri: cim:InterTieDispatchResponse.acceptStatus
range: DispatchResponseType
required: false
multivalued: false
description: The accept status submitted by the responder. Valid values are
NON-RESPONSE, ACCEPT, DECLINE, PARTIAL.
clearedMW:
slot_uri: cim:InterTieDispatchResponse.clearedMW
range: float
required: false
multivalued: false
description: "MW amount associated with instruction. For 5 minute binding\
\ dispatches, this is the Goto MW or DOT\r\n"
passIndicator:
slot_uri: cim:InterTieDispatchResponse.passIndicator
range: PassIndicatorType
required: false
multivalued: false
description: Part of the Composite key that downstream app uses to match the
instruction
startTime:
slot_uri: cim:InterTieDispatchResponse.startTime
range: date
required: false
multivalued: false
description: "Part of the Composite key that downstream app uses to match\
\ the instruction\r\n"
RegisteredInterTie:
slot_uri: cim:InterTieDispatchResponse.RegisteredInterTie
range: RegisteredInterTie
required: true
multivalued: false
LoadBid:
class_uri: cim:LoadBid
is_a: ResourceBid
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ParticipantInterfaces
description: Offer to supply energy/ancillary services from a load resource (participating
load reduces consumption).
attributes:
dropRampRate:
slot_uri: cim:LoadBid.dropRampRate
range: ActivePowerChangeRate
required: false
multivalued: false
description: "Maximum rate that load can be reduced (MW/minute)\r\n"
loadRedInitiationCost:
slot_uri: cim:LoadBid.loadRedInitiationCost
range: Money
required: false
multivalued: false
description: "load reduction initiation cost\r\n"
loadRedInitiationTime:
slot_uri: cim:LoadBid.loadRedInitiationTime
range: float
required: false
multivalued: false
description: "load reduction initiation time\r\n"
marketDate:
slot_uri: cim:LoadBid.marketDate
range: date
required: false
multivalued: false
description: "The date represents the NextMarketDate for which the load response\
\ bids apply to.\r\n"
meteredValue:
slot_uri: cim:LoadBid.meteredValue
range: boolean
required: false
multivalued: false
description: "Flag indicated that the load reduction is metered. (See above)\r\
\nIf priceSetting and meteredValue both equal 1, then the facility is eligible\
\ to set LMP in the real time market.\r\n"
minLoad:
slot_uri: cim:LoadBid.minLoad
range: ActivePower
required: false
multivalued: false
description: "Minimum MW load below which it may not be reduced.\r\n"
minLoadReduction:
slot_uri: cim:LoadBid.minLoadReduction
range: ActivePower
required: false
multivalued: false
description: Minimum MW for a load reduction (e.g. MW rating of a discrete
pump.
minLoadReductionCost:
slot_uri: cim:LoadBid.minLoadReductionCost
range: Money
required: false
multivalued: false
description: "Cost in $ at the minimum reduced load\r\n"
minLoadReductionInterval:
slot_uri: cim:LoadBid.minLoadReductionInterval
range: float
required: false
multivalued: false
description: Shortest period load reduction shall be maintained before load
can be restored to normal levels.
minTimeBetLoadRed:
slot_uri: cim:LoadBid.minTimeBetLoadRed
range: float
required: false
multivalued: false
description: Shortest time that load shall be left at normal levels before
a new load reduction.
pickUpRampRate:
slot_uri: cim:LoadBid.pickUpRampRate
range: ActivePowerChangeRate
required: false
multivalued: false
description: "Maximum rate load may be restored (MW/minute)\r\n"
priceSetting:
slot_uri: cim:LoadBid.priceSetting
range: boolean
required: false
multivalued: false
description: "Flag to indicate that the facility can set LMP Works in tandem\
\ with Metered Value. Greater chance of this being dynamic than the Metered\
\ Value, however, it is requested that Price Setting and Metered Value stay\
\ at the same source. Currently no customers have implemented the metering\
\ capability, but if this option is implemented, then Price Setting could\
\ become dynamic. However, Metered Value will remain static. \r\n"
reqNoticeTime:
slot_uri: cim:LoadBid.reqNoticeTime
range: float
required: false
multivalued: false
description: "Time period that is required from an order to reduce a load\
\ to the time that it takes to get to the minimum load reduction.\r\n"
shutdownCost:
slot_uri: cim:LoadBid.shutdownCost
range: Money
required: false
multivalued: false
description: "The fixed cost associated with committing a load reduction.\r\
\n"
LoadReductionPriceCurve:
slot_uri: cim:LoadBid.LoadReductionPriceCurve
range: LoadReductionPriceCurve
required: false
multivalued: true
RampRateCurve:
slot_uri: cim:LoadBid.RampRateCurve
range: RampRateCurve
required: false
multivalued: true
RegisteredLoad:
slot_uri: cim:LoadBid.RegisteredLoad
range: RegisteredLoad
required: false
multivalued: false
AreaLoadBid:
slot_uri: cim:LoadBid.AreaLoadBid
range: AreaLoadBid
required: false
multivalued: false
RegisteredLoad:
class_uri: cim:RegisteredLoad
is_a: RegisteredResource
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: "Model of a load that is registered to participate in the market.\r\
\n\r\nRegisteredLoad is used to model any load that is served by the wholesale\
\ market directly. RegisteredLoads may be dispatchable or non-dispatchable and\
\ may or may not have bid curves. Examples of RegisteredLoads would include:\
\ distribution company load, energy retailer load, large bulk power system connected\
\ facility load.\r\n\r\nLoads that are served indirectly, for example - through\
\ an energy retailer or a vertical utility, should be modeled as RegisteredDistributedResources.\
\ Examples of RegisteredDistributedResources would include: distribution level\
\ storage, distribution level generation and distribution level demand response."
attributes:
blockLoadTransfer:
slot_uri: cim:RegisteredLoad.blockLoadTransfer
range: boolean
required: false
multivalued: false
description: Emergency operating procedure - Flag to indicate that the Resource
is Block Load pseudo resource.
dynamicallyScheduledLoadResource:
slot_uri: cim:RegisteredLoad.dynamicallyScheduledLoadResource
range: boolean
required: false
multivalued: false
description: Flag to indicate that a Load Resource is part of a DSR Load
dynamicallyScheduledQualification:
slot_uri: cim:RegisteredLoad.dynamicallyScheduledQualification
range: boolean
required: false
multivalued: false
description: Qualification status (used for DSR qualification).
LoadBids:
slot_uri: cim:RegisteredLoad.LoadBids
range: LoadBid
required: false
multivalued: true
AuxillaryObject:
slot_uri: cim:RegisteredLoad.AuxillaryObject
range: AuxiliaryObject
required: false
multivalued: true
AuxiliaryObject:
class_uri: cim:AuxiliaryObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketQualitySystem
description: "Models Auxiliary Values.\r\n"
attributes:
RegisteredGenerator:
slot_uri: cim:AuxiliaryObject.RegisteredGenerator
range: RegisteredGenerator
required: false
multivalued: false
RegisteredLoad:
slot_uri: cim:AuxiliaryObject.RegisteredLoad
range: RegisteredLoad
required: false
multivalued: false
AreaLoadBid:
class_uri: cim:AreaLoadBid
is_a: Bid
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ParticipantInterfaces
description: "AreaLoadBid is not submitted by a market participant into the Markets.\
\ Instead, it is simply an aggregation of all LoadBids contained wtihin a specific\
\ SubControlArea. This entity should inherit from Bid for representation of\
\ the timeframe (startTime, stopTime) and the market type.\r\n"
attributes:
demandBidMW:
slot_uri: cim:AreaLoadBid.demandBidMW
range: float
required: false
multivalued: false
description: "The Demand Bid Megawatt for the area case. \r\nAttribute Usage:\
\ This is Scheduled demand MW in Day Ahead\r\n"
LoadBid:
slot_uri: cim:AreaLoadBid.LoadBid
range: LoadBid
required: false
multivalued: true
LoadReductionPriceCurve:
class_uri: cim:LoadReductionPriceCurve
is_a: Curve
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ParticipantInterfaces
description: "This is the price sensitivity that bidder expresses for allowing\
\ market load interruption. Relationship between price (Y1-axis) vs. MW (X-axis).\r\
\n"
attributes:
LoadBid:
slot_uri: cim:LoadReductionPriceCurve.LoadBid
range: LoadBid
required: true
multivalued: false
BidSet:
class_uri: cim:BidSet
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ParticipantInterfaces
description: "As set of mutually exclusive bids for which a maximum of one may\
\ be scheduled.\r\nOf these generating bids, only one generating bid can be\
\ scheduled at a time.\r\n"
attributes:
GeneratingBids:
slot_uri: cim:BidSet.GeneratingBids
range: GeneratingBid
required: true
multivalued: true
SecurityConstraints:
class_uri: cim:SecurityConstraints
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.ExternalInputs
description: "Typical for regional transmission operators (RTOs), these constraints\
\ include transmission as well as generation group constraints identified in\
\ both base case and critical contingency cases.\r\n"
attributes:
actualMW:
slot_uri: cim:SecurityConstraints.actualMW
range: ActivePower
required: false
multivalued: false
description: "Actual branch or group of branches MW flow (only for transmission\
\ constraints)\r\n"
maxMW:
slot_uri: cim:SecurityConstraints.maxMW
range: ActivePower
required: false
multivalued: false
description: "Maximum MW limit\r\n"
minMW:
slot_uri: cim:SecurityConstraints.minMW
range: ActivePower
required: false
multivalued: false
description: "Minimum MW limit (only for transmission constraints).\r\n"
RTO:
slot_uri: cim:SecurityConstraints.RTO
range: RTO
required: false
multivalued: false
Flowgate:
slot_uri: cim:SecurityConstraints.Flowgate
range: Flowgate
required: false
multivalued: false
GeneratingBid:
slot_uri: cim:SecurityConstraints.GeneratingBid
range: GeneratingBid
required: false
multivalued: false
EnergyPriceIndex:
class_uri: cim:EnergyPriceIndex
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.ExternalInputs
description: An Energy Price Index for each Resource is valid for a period (e.g.
daily) that is identified by a Valid Period Start Time and a Valid Period End
Time. An Energy Price Index is in $/MWh.
attributes:
energyPriceIndex:
slot_uri: cim:EnergyPriceIndex.energyPriceIndex
range: float
required: false
multivalued: false
description: "Energy price index\r\n"
energyPriceIndexType:
slot_uri: cim:EnergyPriceIndex.energyPriceIndexType
range: EnergyPriceIndexType
required: false
multivalued: false
description: EPI type such as wholesale or retail
lastModified:
slot_uri: cim:EnergyPriceIndex.lastModified
range: date
required: false
multivalued: false
description: "Time updated\r\n"
validPeriod:
slot_uri: cim:EnergyPriceIndex.validPeriod
range: DateTimeInterval
required: false
multivalued: false
description: Valid period for which the energy price index is valid.
RegisteredGenerator:
slot_uri: cim:EnergyPriceIndex.RegisteredGenerator
range: RegisteredGenerator
required: true
multivalued: false
FuelCostCurve:
class_uri: cim:FuelCostCurve
is_a: Curve
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: "Relationship between unit fuel cost in $/kWh(Y-axis) and unit output\
\ in MW (X-axis).\r\n"
attributes:
RegisteredGenerator:
slot_uri: cim:FuelCostCurve.RegisteredGenerator
range: RegisteredGenerator
required: false
multivalued: false
UnitInitialConditions:
class_uri: cim:UnitInitialConditions
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.ExternalInputs
description: "Resource status at the end of a given clearing period.\r\n"
attributes:
cumEnergy:
slot_uri: cim:UnitInitialConditions.cumEnergy
range: RealEnergy
required: false
multivalued: false
description: "Cumulative energy production over trading period.\r\n"
cumStatusChanges:
slot_uri: cim:UnitInitialConditions.cumStatusChanges
range: integer
required: false
multivalued: false
description: "Cumulative number of status changes of the resource.\r\n"
numberOfStartups:
slot_uri: cim:UnitInitialConditions.numberOfStartups
range: integer
required: false
multivalued: false
description: "Number of start ups in the Operating Day until the end of previous\
\ hour.\r\n"
onlineStatus:
slot_uri: cim:UnitInitialConditions.onlineStatus
range: boolean
required: false
multivalued: false
description: "'true' if the GeneratingUnit is currently On-Line\r\n"
resourceMW:
slot_uri: cim:UnitInitialConditions.resourceMW
range: ActivePower
required: false
multivalued: false
description: "Resource MW output at the end of previous clearing period.\r\
\n"
resourceStatus:
slot_uri: cim:UnitInitialConditions.resourceStatus
range: integer
required: false
multivalued: false
description: "Resource status at the end of previous clearing period:\r\n\
0 - off-line\r\n1 - on-line production\r\n2 - in shutdown process\r\n3 -\
\ in startup process\r\n"
statusDate:
slot_uri: cim:UnitInitialConditions.statusDate
range: date
required: false
multivalued: false
description: "Time and date for resourceStatus\r\n"
timeInStatus:
slot_uri: cim:UnitInitialConditions.timeInStatus
range: float
required: false
multivalued: false
description: "Time in market trading intervals the resource is in the state\
\ as of the end of the previous clearing period.\r\n"
timeInterval:
slot_uri: cim:UnitInitialConditions.timeInterval
range: date
required: false
multivalued: false
description: "Time interval\r\n"
GeneratingUnit:
slot_uri: cim:UnitInitialConditions.GeneratingUnit
range: RegisteredGenerator
required: false
multivalued: false
MktHeatRateCurve:
class_uri: cim:MktHeatRateCurve
is_a: HeatRateCurve
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: 'Subclass of IEC 61970: Generation: Production:HeatRateCurve.'
attributes:
ResourceVerifiableCosts:
slot_uri: cim:MktHeatRateCurve.ResourceVerifiableCosts
range: ResourceVerifiableCosts
required: false
multivalued: false
RegisteredGenerator:
slot_uri: cim:MktHeatRateCurve.RegisteredGenerator
range: RegisteredGenerator
required: false
multivalued: false
HeatRateCurve:
class_uri: cim:HeatRateCurve
is_a: Curve
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.Production
description: Relationship between unit heat rate per active power (Y-axis) and unit
output (X-axis). The heat input is from all fuels.
attributes:
isNetGrossP:
slot_uri: cim:HeatRateCurve.isNetGrossP
range: boolean
required: false
multivalued: false
description: "Flag is set to true when output is expressed in net active power.\r\
\n"
ThermalGeneratingUnit:
slot_uri: cim:HeatRateCurve.ThermalGeneratingUnit
range: ThermalGeneratingUnit
required: true
multivalued: false
description: A thermal generating unit may have a heat rate curve.
ThermalGeneratingUnit:
class_uri: cim:ThermalGeneratingUnit
is_a: GeneratingUnit
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.Production
description: "A generating unit whose prime mover could be a steam turbine, combustion\
\ turbine, or diesel engine.\r\n"
attributes:
oMCost:
slot_uri: cim:ThermalGeneratingUnit.oMCost
range: CostPerHeatUnit
required: false
multivalued: false
description: "Operating and maintenance cost for the thermal unit.\r\n"
HeatRateCurve:
slot_uri: cim:ThermalGeneratingUnit.HeatRateCurve
range: HeatRateCurve
required: false
multivalued: false
description: A thermal generating unit may have a heat rate curve.
CogenerationPlant:
slot_uri: cim:ThermalGeneratingUnit.CogenerationPlant
range: CogenerationPlant
required: false
multivalued: false
description: A thermal generating unit may be a member of a cogeneration plant.
FuelAllocationSchedules:
slot_uri: cim:ThermalGeneratingUnit.FuelAllocationSchedules
range: FuelAllocationSchedule
required: false
multivalued: true
description: A thermal generating unit may have one or more fuel allocation
schedules.
StartupModel:
slot_uri: cim:ThermalGeneratingUnit.StartupModel
range: StartupModel
required: false
multivalued: false
description: A thermal generating unit may have a startup model.
EmissionCurves:
slot_uri: cim:ThermalGeneratingUnit.EmissionCurves
range: EmissionCurve
required: false
multivalued: true
description: A thermal generating unit may have one or more emission curves.
ShutdownCurve:
slot_uri: cim:ThermalGeneratingUnit.ShutdownCurve
range: ShutdownCurve
required: false
multivalued: false
description: A thermal generating unit may have a shutdown curve.
IncrementalHeatRateCurve:
slot_uri: cim:ThermalGeneratingUnit.IncrementalHeatRateCurve
range: IncrementalHeatRateCurve
required: false
multivalued: false
description: A thermal generating unit may have an incremental heat rate curve.
FossilFuels:
slot_uri: cim:ThermalGeneratingUnit.FossilFuels
range: FossilFuel
required: false
multivalued: true
description: A thermal generating unit may have one or more fossil fuels.
CAESPlant:
slot_uri: cim:ThermalGeneratingUnit.CAESPlant
range: CAESPlant
required: false
multivalued: false
description: A thermal generating unit may be a member of a compressed air
energy storage plant.
CombinedCyclePlant:
slot_uri: cim:ThermalGeneratingUnit.CombinedCyclePlant
range: CombinedCyclePlant
required: false
multivalued: false
description: A thermal generating unit may be a member of a combined cycle
plant.
EmmissionAccounts:
slot_uri: cim:ThermalGeneratingUnit.EmmissionAccounts
range: EmissionAccount
required: false
multivalued: true
description: A thermal generating unit may have one or more emission allowance
accounts.
HeatInputCurve:
slot_uri: cim:ThermalGeneratingUnit.HeatInputCurve
range: HeatInputCurve
required: false
multivalued: false
description: A thermal generating unit may have a heat input curve.
GeneratingUnit:
class_uri: cim:GeneratingUnit
is_a: Equipment
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.Production
description: 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.
attributes:
allocSpinResP:
slot_uri: cim:GeneratingUnit.allocSpinResP
range: ActivePower
required: false
multivalued: false
description: "The planned unused capacity (spinning reserve) which can be\
\ used to support emergency load.\r\n"
autoCntrlMarginP:
slot_uri: cim:GeneratingUnit.autoCntrlMarginP
range: ActivePower
required: false
multivalued: false
description: The planned unused capacity which can be used to support automatic
control overruns.
baseP:
slot_uri: cim:GeneratingUnit.baseP
range: ActivePower
required: false
multivalued: false
description: 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.
controlDeadband:
slot_uri: cim:GeneratingUnit.controlDeadband
range: ActivePower
required: false
multivalued: false
description: 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.
controlPulseHigh:
slot_uri: cim:GeneratingUnit.controlPulseHigh
range: Seconds
required: false
multivalued: false
description: "Pulse high limit which is the largest control pulse that the\
\ unit can respond to.\r\n"
controlPulseLow:
slot_uri: cim:GeneratingUnit.controlPulseLow
range: Seconds
required: false
multivalued: false
description: "Pulse low limit which is the smallest control pulse that the\
\ unit can respond to.\r\n"
controlResponseRate:
slot_uri: cim:GeneratingUnit.controlResponseRate
range: ActivePowerChangeRate
required: false
multivalued: false
description: 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.
efficiency:
slot_uri: cim:GeneratingUnit.efficiency
range: PerCent
required: false
multivalued: false
description: The efficiency of the unit in converting mechanical energy, from
the prime mover, into electrical energy.
genControlMode:
slot_uri: cim:GeneratingUnit.genControlMode
range: GeneratorControlMode
required: false
multivalued: false
description: The unit control mode.
genControlSource:
slot_uri: cim:GeneratingUnit.genControlSource
range: GeneratorControlSource
required: false
multivalued: false
description: The source of controls for a generating unit. Defines the control
status of the generating unit.
governorMPL:
slot_uri: cim:GeneratingUnit.governorMPL
range: PU
required: false
multivalued: false
description: "Governor motor position limit.\r\n"
governorSCD:
slot_uri: cim:GeneratingUnit.governorSCD
range: PerCent
required: false
multivalued: false
description: 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.
highControlLimit:
slot_uri: cim:GeneratingUnit.highControlLimit
range: ActivePower
required: false
multivalued: false
description: "High limit for secondary (AGC) control.\r\n"
initialP:
slot_uri: cim:GeneratingUnit.initialP
range: ActivePower
required: false
multivalued: false
description: "Default initial active power which is used to store a powerflow\
\ result for the initial active power for this unit in this network configuration.\r\
\n"
longPF:
slot_uri: cim:GeneratingUnit.longPF
range: float
required: false
multivalued: false
description: "Generating unit long term economic participation factor.\r\n"
lowControlLimit:
slot_uri: cim:GeneratingUnit.lowControlLimit
range: ActivePower
required: false
multivalued: false
description: "Low limit for secondary (AGC) control.\r\n"
lowerRampRate:
slot_uri: cim:GeneratingUnit.lowerRampRate
range: ActivePowerChangeRate
required: false
multivalued: false
description: "The normal maximum rate the generating unit active power output\
\ can be lowered by control actions.\r\n"
maxEconomicP:
slot_uri: cim:GeneratingUnit.maxEconomicP
range: ActivePower
required: false
multivalued: false
description: "Maximum high economic active power limit, that should not exceed\
\ the maximum operating active power limit.\r\n"
maximumAllowableSpinningReserve:
slot_uri: cim:GeneratingUnit.maximumAllowableSpinningReserve
range: ActivePower
required: false
multivalued: false
description: Maximum allowable spinning reserve. Spinning reserve will never
be considered greater than this value regardless of the current operating
point.
maxOperatingP:
slot_uri: cim:GeneratingUnit.maxOperatingP
range: ActivePower
required: false
multivalued: false
description: "This is the maximum operating active power limit the dispatcher\
\ can enter for this unit.\r\n"
minEconomicP:
slot_uri: cim:GeneratingUnit.minEconomicP
range: ActivePower
required: false
multivalued: false
description: Low economic active power limit that shall be greater than or
equal to the minimum operating active power limit.
minimumOffTime:
slot_uri: cim:GeneratingUnit.minimumOffTime
range: Seconds
required: false
multivalued: false
description: "Minimum time interval between unit shutdown and startup.\r\n"
minOperatingP:
slot_uri: cim:GeneratingUnit.minOperatingP
range: ActivePower
required: false
multivalued: false
description: This is the minimum operating active power limit the dispatcher
can enter for this unit.
modelDetail:
slot_uri: cim:GeneratingUnit.modelDetail
range: Classification
required: false
multivalued: false
description: "Detail level of the generator model data.\r\n"
nominalP:
slot_uri: cim:GeneratingUnit.nominalP
range: ActivePower
required: false
multivalued: false
description: "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).\r\nThe attribute shall be a positive value\
\ equal to or less than RotatingMachine.ratedS."
normalPF:
slot_uri: cim:GeneratingUnit.normalPF
range: float
required: false
multivalued: false
description: 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.
penaltyFactor:
slot_uri: cim:GeneratingUnit.penaltyFactor
range: float
required: false
multivalued: false
description: '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).'
raiseRampRate:
slot_uri: cim:GeneratingUnit.raiseRampRate
range: ActivePowerChangeRate
required: false
multivalued: false
description: "The normal maximum rate the generating unit active power output\
\ can be raised by control actions.\r\n"
ratedGrossMaxP:
slot_uri: cim:GeneratingUnit.ratedGrossMaxP
range: ActivePower
required: false
multivalued: false
description: "The unit's gross rated maximum capacity (book value).\r\nThe\
\ attribute shall be a positive value.\r\n"
ratedGrossMinP:
slot_uri: cim:GeneratingUnit.ratedGrossMinP
range: ActivePower
required: false
multivalued: false
description: "The gross rated minimum generation level which the unit can\
\ safely operate at while delivering power to the transmission grid.\r\n\
The attribute shall be a positive value.\r\n"
ratedNetMaxP:
slot_uri: cim:GeneratingUnit.ratedNetMaxP
range: ActivePower
required: false
multivalued: false
description: "The net rated maximum capacity determined by subtracting the\
\ auxiliary power used to operate the internal plant machinery from the\
\ rated gross maximum capacity.\r\nThe attribute shall be a positive value.\r\
\n"
shortPF:
slot_uri: cim:GeneratingUnit.shortPF
range: float
required: false
multivalued: false
description: "Generating unit short term economic participation factor.\r\n"
startupCost:
slot_uri: cim:GeneratingUnit.startupCost
range: Money
required: false
multivalued: false
description: The initial startup cost incurred for each start of the GeneratingUnit.
startupTime:
slot_uri: cim:GeneratingUnit.startupTime
range: Seconds
required: false
multivalued: false
description: "Time it takes to get the unit on-line, from the time that the\
\ prime mover mechanical power is applied.\r\n"
tieLinePF:
slot_uri: cim:GeneratingUnit.tieLinePF
range: float
required: false
multivalued: false
description: "Generating unit economic participation factor.\r\n"
totalEfficiency:
slot_uri: cim:GeneratingUnit.totalEfficiency
range: PerCent
required: false
multivalued: false
description: The efficiency of the unit in converting the fuel into electrical
energy.
variableCost:
slot_uri: cim:GeneratingUnit.variableCost
range: Money
required: false
multivalued: false
description: The variable cost component of production per unit of ActivePower.
RotatingMachine:
slot_uri: cim:GeneratingUnit.RotatingMachine
range: RotatingMachine
required: false
multivalued: true
description: A synchronous machine may operate as a generator and as such
becomes a member of a generating unit.
GenUnitOpSchedule:
slot_uri: cim:GeneratingUnit.GenUnitOpSchedule
range: GenUnitOpSchedule
required: false
multivalued: false
description: A generating unit may have an operating schedule, indicating
the planned operation of the unit.
ControlAreaGeneratingUnit:
slot_uri: cim:GeneratingUnit.ControlAreaGeneratingUnit
range: ControlAreaGeneratingUnit
required: false
multivalued: true
description: ControlArea specifications for this generating unit.
GrossToNetActivePowerCurves:
slot_uri: cim:GeneratingUnit.GrossToNetActivePowerCurves
range: GrossToNetActivePowerCurve
required: false
multivalued: true
description: A generating unit may have a gross active power to net active
power curve, describing the losses and auxiliary power requirements of the
unit.
GenUnitOpCostCurves:
slot_uri: cim:GeneratingUnit.GenUnitOpCostCurves
range: GenUnitOpCostCurve
required: false
multivalued: true
description: A generating unit may have one or more cost curves, depending
upon fuel mixture and fuel cost.
GenUnitOpSchedule:
class_uri: cim:GenUnitOpSchedule
is_a: RegularIntervalSchedule
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.Production
description: "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.\r\
\n"
attributes:
GeneratingUnit:
slot_uri: cim:GenUnitOpSchedule.GeneratingUnit
range: GeneratingUnit
required: true
multivalued: false
description: A generating unit may have an operating schedule, indicating
the planned operation of the unit.
ControlAreaGeneratingUnit:
class_uri: cim:ControlAreaGeneratingUnit
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.ControlArea
description: A control area generating unit. This class is needed so that alternate
control area definitions may include the same generating unit. It should be
noted that only one instance within a control area should reference a specific
generating unit.
attributes:
ControlArea:
slot_uri: cim:ControlAreaGeneratingUnit.ControlArea
range: ControlArea
required: true
multivalued: false
description: The parent control area for the generating unit specifications.
GeneratingUnit:
slot_uri: cim:ControlAreaGeneratingUnit.GeneratingUnit
range: GeneratingUnit
required: true
multivalued: false
description: The generating unit specified for this control area. Note that
a control area should include a GeneratingUnit only once.
AltGeneratingUnitMeas:
slot_uri: cim:ControlAreaGeneratingUnit.AltGeneratingUnitMeas
range: AltGeneratingUnitMeas
required: false
multivalued: true
description: The link to prioritized measurements for this GeneratingUnit.
AltGeneratingUnitMeas:
class_uri: cim:AltGeneratingUnitMeas
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.ControlArea
description: A prioritized measurement to be used for the generating unit in the
control area specification.
attributes:
priority:
slot_uri: cim:AltGeneratingUnitMeas.priority
range: integer
required: false
multivalued: false
description: Priority of a measurement usage. Lower numbers have first priority.
ControlAreaGeneratingUnit:
slot_uri: cim:AltGeneratingUnitMeas.ControlAreaGeneratingUnit
range: ControlAreaGeneratingUnit
required: true
multivalued: false
description: The control area generating unit to which the prioritized measurement
assignment is applied.
AnalogValue:
slot_uri: cim:AltGeneratingUnitMeas.AnalogValue
range: AnalogValue
required: true
multivalued: false
description: The specific analog value used as a source.
AnalogValue:
class_uri: cim:AnalogValue
is_a: MeasurementValue
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Meas
description: AnalogValue represents an analog MeasurementValue.
attributes:
value:
slot_uri: cim:AnalogValue.value
range: float
required: false
multivalued: false
description: The value to supervise.
AnalogControl:
slot_uri: cim:AnalogValue.AnalogControl
range: AnalogControl
required: false
multivalued: false
description: The Control variable associated with the MeasurementValue.
AltTieMeas:
slot_uri: cim:AnalogValue.AltTieMeas
range: AltTieMeas
required: false
multivalued: true
description: The usage of the measurement within the control area specification.
AltGeneratingUnit:
slot_uri: cim:AnalogValue.AltGeneratingUnit
range: AltGeneratingUnitMeas
required: false
multivalued: true
description: The alternate generating unit for which this measurement value
applies.
Analog:
slot_uri: cim:AnalogValue.Analog
range: Analog
required: true
multivalued: false
description: Measurement to which this value is connected.
AltTieMeas:
class_uri: cim:AltTieMeas
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.ControlArea
description: A prioritized measurement to be used for the tie flow as part of
the control area specification.
attributes:
priority:
slot_uri: cim:AltTieMeas.priority
range: integer
required: false
multivalued: false
description: Priority of a measurement usage. Lower numbers have first priority.
TieFlow:
slot_uri: cim:AltTieMeas.TieFlow
range: TieFlow
required: true
multivalued: false
description: The tie flow of the alternate measurements.
AnalogValue:
slot_uri: cim:AltTieMeas.AnalogValue
range: AnalogValue
required: true
multivalued: false
description: The specific analog value used as a source.
TieFlow:
class_uri: cim:TieFlow
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.ControlArea
description: Defines the structure (in terms of location and direction) of the
net interchange constraint for a control area. This constraint may be used by
either AGC or power flow.
attributes:
positiveFlowIn:
slot_uri: cim:TieFlow.positiveFlowIn
range: boolean
required: false
multivalued: false
description: Specifies the sign of the tie flow associated with a control
area. True if positive flow into the terminal (load convention) is also
positive flow into the control area. See the description of ControlArea
for further explanation of how TieFlow.positiveFlowIn is used.
ControlArea:
slot_uri: cim:TieFlow.ControlArea
range: ControlArea
required: true
multivalued: false
description: The control area of the tie flows.
Terminal:
slot_uri: cim:TieFlow.Terminal
range: Terminal
required: true
multivalued: false
description: The terminal to which this tie flow belongs.
AltTieMeas:
slot_uri: cim:TieFlow.AltTieMeas
range: AltTieMeas
required: false
multivalued: true
description: The primary and alternate tie flow measurements associated with
the tie flow.
ControlArea:
class_uri: cim:ControlArea
is_a: PowerSystemResource
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.ControlArea
description: "A control area is a grouping of generating units and/or loads and\
\ a cutset of tie lines (as terminals) which may be used for a variety of purposes\
\ including automatic generation control, power flow solution area interchange\
\ control specification, and input to load forecasting. All generation and load\
\ within the area defined by the terminals on the border are considered in the\
\ area interchange control. Note that any number of overlapping control area\
\ specifications can be superimposed on the physical model. The following general\
\ principles apply to ControlArea:\r\n1. The control area orientation for net\
\ interchange is positive for an import, negative for an export.\r\n2. The\
\ control area net interchange is determined by summing flows in Terminals.\
\ The Terminals are identified by creating a set of TieFlow objects associated\
\ with a ControlArea object. Each TieFlow object identifies one Terminal.\r\n\
3. In a single network model, a tie between two control areas must be modelled\
\ in both control area specifications, such that the two representations of\
\ the tie flow sum to zero.\r\n4. The normal orientation of Terminal flow is\
\ positive for flow into the conducting equipment that owns the Terminal. (i.e.\
\ flow from a bus into a device is positive.) However, the orientation of each\
\ flow in the control area specification must align with the control area convention,\
\ i.e. import is positive. If the orientation of the Terminal flow referenced\
\ by a TieFlow is positive into the control area, then this is confirmed by\
\ setting TieFlow.positiveFlowIn flag TRUE. If not, the orientation must be\
\ reversed by setting the TieFlow.positiveFlowIn flag FALSE."
attributes:
netInterchange:
slot_uri: cim:ControlArea.netInterchange
range: ActivePower
required: false
multivalued: false
description: The specified positive net interchange into the control area,
i.e. positive sign means flow into the area.
pTolerance:
slot_uri: cim:ControlArea.pTolerance
range: ActivePower
required: false
multivalued: false
description: Active power net interchange tolerance. The attribute shall be
a positive value or zero.
type:
slot_uri: cim:ControlArea.type
range: ControlAreaTypeKind
required: false
multivalued: false
description: The primary type of control area definition used to determine
if this is used for automatic generation control, for planning interchange
control, or other purposes. A control area specified with primary type
of automatic generation control could still be forecast and used as an interchange
area in power flow analysis.
EnergyArea:
slot_uri: cim:ControlArea.EnergyArea
range: EnergyArea
required: false
multivalued: false
description: The energy area that is forecast from this control area specification.
ControlAreaGeneratingUnit:
slot_uri: cim:ControlArea.ControlAreaGeneratingUnit
range: ControlAreaGeneratingUnit
required: false
multivalued: true
description: The generating unit specifications for the control area.
TieFlow:
slot_uri: cim:ControlArea.TieFlow
range: TieFlow
required: false
multivalued: true
description: The tie flows associated with the control area.
EnergyGroup:
slot_uri: cim:ControlArea.EnergyGroup
range: EnergyGroup
required: false
multivalued: true
EnergyGroup:
class_uri: cim:EnergyGroup
is_a: PowerSystemResource
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.EnergyArea
attributes:
isSlack:
slot_uri: cim:EnergyGroup.isSlack
range: boolean
required: false
multivalued: false
p:
slot_uri: cim:EnergyGroup.p
range: ActivePower
required: false
multivalued: false
EnergyTypeReference:
slot_uri: cim:EnergyGroup.EnergyTypeReference
range: EnergyTypeReference
required: true
multivalued: false
ControlArea:
slot_uri: cim:EnergyGroup.ControlArea
range: ControlArea
required: true
multivalued: false
BlockDispatchInstruction:
slot_uri: cim:EnergyGroup.BlockDispatchInstruction
range: BlockDispatchInstruction
required: false
multivalued: true
EnergyComponent:
slot_uri: cim:EnergyGroup.EnergyComponent
range: EnergyComponent
required: false
multivalued: true
SvPowerFlow:
slot_uri: cim:EnergyGroup.SvPowerFlow
range: SvPowerFlow
required: false
multivalued: true
BlockDispatchInstruction:
class_uri: cim:BlockDispatchInstruction
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.EnergyArea
attributes:
EnergyGroup:
slot_uri: cim:BlockDispatchInstruction.EnergyGroup
range: EnergyGroup
required: true
multivalued: false
BlockDispatchOrder:
slot_uri: cim:BlockDispatchInstruction.BlockDispatchOrder
range: BlockDispatchOrder
required: true
multivalued: true
BlockDispatchOrder:
class_uri: cim:BlockDispatchOrder
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.EnergyArea
attributes:
p:
slot_uri: cim:BlockDispatchOrder.p
range: ActivePower
required: false
multivalued: false
sequence:
slot_uri: cim:BlockDispatchOrder.sequence
range: integer
required: false
multivalued: false
BlockDispatchComponent:
slot_uri: cim:BlockDispatchOrder.BlockDispatchComponent
range: BlockDispatchComponent
required: true
multivalued: false
BlockDispatchInstruction:
slot_uri: cim:BlockDispatchOrder.BlockDispatchInstruction
range: BlockDispatchInstruction
required: true
multivalued: false
BlockDispatchComponent:
class_uri: cim:BlockDispatchComponent
is_a: EnergyComponent
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.EnergyArea
attributes:
BlockDispatchOrder:
slot_uri: cim:BlockDispatchComponent.BlockDispatchOrder
range: BlockDispatchOrder
required: true
multivalued: true
EnergyComponent:
class_uri: cim:EnergyComponent
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.EnergyArea
attributes:
EnergyGroup:
slot_uri: cim:EnergyComponent.EnergyGroup
range: EnergyGroup
required: true
multivalued: false
EnergyConnection:
slot_uri: cim:EnergyComponent.EnergyConnection
range: EnergyConnection
required: true
multivalued: false
EnergyConnection:
class_uri: cim:EnergyConnection
is_a: ConductingEquipment
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: A connection of energy generation or consumption on the power system
model.
attributes:
EnergyComponent:
slot_uri: cim:EnergyConnection.EnergyComponent
range: EnergyComponent
required: false
multivalued: true
SvPowerFlow:
class_uri: cim:SvPowerFlow
is_a: StateVariable
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.StateVariables
description: State variable for power flow. Load convention is used for flow direction.
This means flow out from the TopologicalNode into the equipment is positive.
attributes:
p:
slot_uri: cim:SvPowerFlow.p
range: ActivePower
required: false
multivalued: false
description: The active power flow. Load sign convention is used, i.e. positive
sign means flow out from a TopologicalNode (bus) into the conducting equipment.
phase:
slot_uri: cim:SvPowerFlow.phase
range: SinglePhaseKind
required: false
multivalued: false
description: The individual phase of the flow. If unspecified, then assumed
to be balanced among phases.
q:
slot_uri: cim:SvPowerFlow.q
range: ReactivePower
required: false
multivalued: false
description: The reactive power flow. Load sign convention is used, i.e. positive
sign means flow out from a TopologicalNode (bus) into the conducting equipment.
Terminal:
slot_uri: cim:SvPowerFlow.Terminal
range: Terminal
required: true
multivalued: false
description: The terminal associated with the power flow state variable.
EnergyGroup:
slot_uri: cim:SvPowerFlow.EnergyGroup
range: EnergyGroup
required: false
multivalued: false
EnergyTypeReference:
class_uri: cim:EnergyTypeReference
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.EnergyArea
attributes:
kind:
slot_uri: cim:EnergyTypeReference.kind
range: EnergyTypeKind
required: false
multivalued: false
EnergyGroup:
slot_uri: cim:EnergyTypeReference.EnergyGroup
range: EnergyGroup
required: false
multivalued: true
EnergyArea:
class_uri: cim:EnergyArea
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.LoadModel
description: Describes an area having energy production or consumption. Specializations
are intended to support the load allocation function as typically required in
energy management systems or planning studies to allocate hypothesized load
levels to individual load points for power flow analysis. Often the energy
area can be linked to both measured and forecast load levels.
attributes:
ControlArea:
slot_uri: cim:EnergyArea.ControlArea
range: ControlArea
required: false
multivalued: false
description: The control area specification that is used for the load forecast.
Analog:
class_uri: cim:Analog
is_a: Measurement
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Meas
description: "Analog represents an analog Measurement.\r\n"
attributes:
maxValue:
slot_uri: cim:Analog.maxValue
range: float
required: false
multivalued: false
description: Normal value range maximum for any of the MeasurementValue.values.
Used for scaling, e.g. in bar graphs or of telemetered raw values.
minValue:
slot_uri: cim:Analog.minValue
range: float
required: false
multivalued: false
description: "Normal value range minimum for any of the MeasurementValue.values.\
\ Used for scaling, e.g. in bar graphs or of telemetered raw values.\r\n"
normalValue:
slot_uri: cim:Analog.normalValue
range: float
required: false
multivalued: false
description: Normal measurement value, e.g., used for percentage calculations.
positiveFlowIn:
slot_uri: cim:Analog.positiveFlowIn
range: boolean
required: false
multivalued: false
description: If true then this measurement is an active power, reactive power
or current with the convention that a positive value measured at the Terminal
means power is flowing into the related PowerSystemResource.
AnalogValues:
slot_uri: cim:Analog.AnalogValues
range: AnalogValue
required: false
multivalued: true
description: The values connected to this measurement.
LimitSets:
slot_uri: cim:Analog.LimitSets
range: AnalogLimitSet
required: false
multivalued: true
description: A measurement may have zero or more limit ranges defined for
it.
AnalogLimitSet:
class_uri: cim:AnalogLimitSet
is_a: LimitSet
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Meas
description: An AnalogLimitSet specifies a set of Limits that are associated with
an Analog measurement.
attributes:
Limits:
slot_uri: cim:AnalogLimitSet.Limits
range: AnalogLimit
required: false
multivalued: true
description: The limit values used for supervision of Measurements.
Measurements:
slot_uri: cim:AnalogLimitSet.Measurements
range: Analog
required: false
multivalued: true
description: The Measurements using the LimitSet.
LimitSet:
class_uri: cim:LimitSet
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Meas
description: Specifies a set of Limits that are associated with a Measurement.
A Measurement may have several LimitSets corresponding to seasonal or other
changing conditions. The condition is captured in the name and description attributes.
The same LimitSet may be used for several Measurements. In particular percentage
limits are used this way.
attributes:
isPercentageLimits:
slot_uri: cim:LimitSet.isPercentageLimits
range: boolean
required: false
multivalued: false
description: Tells if the limit values are in percentage of normalValue or
the specified Unit for Measurements and Controls.
AnalogLimit:
class_uri: cim:AnalogLimit
is_a: Limit
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Meas
description: "Limit values for Analog measurements.\r\n"
attributes:
value:
slot_uri: cim:AnalogLimit.value
range: float
required: false
multivalued: false
description: The value to supervise against.
LimitSet:
slot_uri: cim:AnalogLimit.LimitSet
range: AnalogLimitSet
required: true
multivalued: false
description: The set of limits.
AnalogControl:
class_uri: cim:AnalogControl
is_a: Control
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Meas
description: An analog control used for supervisory control.
attributes:
maxValue:
slot_uri: cim:AnalogControl.maxValue
range: float
required: false
multivalued: false
description: Normal value range maximum for any of the Control.value. Used
for scaling, e.g. in bar graphs.
minValue:
slot_uri: cim:AnalogControl.minValue
range: float
required: false
multivalued: false
description: Normal value range minimum for any of the Control.value. Used
for scaling, e.g. in bar graphs.
AnalogValue:
slot_uri: cim:AnalogControl.AnalogValue
range: AnalogValue
required: true
multivalued: false
description: The MeasurementValue that is controlled.
Control:
class_uri: cim:Control
is_a: IOPoint
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Meas
description: "Control is used for supervisory/device control. It represents control\
\ outputs that are used to change the state in a process, e.g. close or open\
\ breaker, a set point value or a raise lower command.\r\n"
attributes:
controlType:
slot_uri: cim:Control.controlType
range: string
required: false
multivalued: false
description: Specifies the type of Control. For example, this specifies if
the Control represents BreakerOpen, BreakerClose, GeneratorVoltageSetPoint,
GeneratorRaise, GeneratorLower, etc.
operationInProgress:
slot_uri: cim:Control.operationInProgress
range: boolean
required: false
multivalued: false
description: "Indicates that a client is currently sending control commands\
\ that has not completed.\r\n"
timeStamp:
slot_uri: cim:Control.timeStamp
range: date
required: false
multivalued: false
description: "The last time a control output was sent.\r\n"
unitMultiplier:
slot_uri: cim:Control.unitMultiplier
range: UnitMultiplier
required: false
multivalued: false
description: The unit multiplier of the controlled quantity.
unitSymbol:
slot_uri: cim:Control.unitSymbol
range: UnitSymbol
required: false
multivalued: false
description: The unit of measure of the controlled quantity.
RemoteControl:
slot_uri: cim:Control.RemoteControl
range: RemoteControl
required: false
multivalued: false
description: The remote point controlling the physical actuator.
PowerSystemResource:
slot_uri: cim:Control.PowerSystemResource
range: PowerSystemResource
required: false
multivalued: false
description: Regulating device governed by this control output.
ControlAction:
slot_uri: cim:Control.ControlAction
range: ControlAction
required: false
multivalued: false
description: The control action that is performed on the control
RemoteControl:
class_uri: cim:RemoteControl
is_a: RemotePoint
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.SCADA
description: Remote controls are outputs that are sent by the remote unit to actuators
in the process.
attributes:
actuatorMaximum:
slot_uri: cim:RemoteControl.actuatorMaximum
range: float
required: false
multivalued: false
description: The maximum set point value accepted by the remote control point.
actuatorMinimum:
slot_uri: cim:RemoteControl.actuatorMinimum
range: float
required: false
multivalued: false
description: The minimum set point value accepted by the remote control point.
remoteControlled:
slot_uri: cim:RemoteControl.remoteControlled
range: boolean
required: false
multivalued: false
description: Set to true if the actuator is remotely controlled.
Control:
slot_uri: cim:RemoteControl.Control
range: Control
required: true
multivalued: false
description: The Control for the RemoteControl point.
ControlAction:
class_uri: cim:ControlAction
is_a: SwitchingAction
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Operations
description: Control executed as a switching step.
attributes:
analogValue:
slot_uri: cim:ControlAction.analogValue
range: float
required: false
multivalued: false
description: The analog value used for the analog control, the raise/lower
control and the set point control
discreteValue:
slot_uri: cim:ControlAction.discreteValue
range: integer
required: false
multivalued: false
description: The integer value used for the command or the accumulator reset.
Control:
slot_uri: cim:ControlAction.Control
range: Control
required: false
multivalued: false
description: The control that the control action is performed on.
GrossToNetActivePowerCurve:
class_uri: cim:GrossToNetActivePowerCurve
is_a: Curve
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.Production
description: Relationship between the generating unit's gross active power output
on the X-axis (measured at the terminals of the machine(s)) and the generating
unit's net active power output on the Y-axis (based on utility-defined measurements
at the power station). Station service loads, when modelled, should be treated
as non-conforming bus loads. There may be more than one curve, depending on
the auxiliary equipment that is in service.
attributes:
GeneratingUnit:
slot_uri: cim:GrossToNetActivePowerCurve.GeneratingUnit
range: GeneratingUnit
required: true
multivalued: false
description: A generating unit may have a gross active power to net active
power curve, describing the losses and auxiliary power requirements of the
unit.
GenUnitOpCostCurve:
class_uri: cim:GenUnitOpCostCurve
is_a: Curve
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.Production
description: 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.
attributes:
isNetGrossP:
slot_uri: cim:GenUnitOpCostCurve.isNetGrossP
range: boolean
required: false
multivalued: false
description: "Flag is set to true when output is expressed in net active power.\r\
\n"
GeneratingUnit:
slot_uri: cim:GenUnitOpCostCurve.GeneratingUnit
range: GeneratingUnit
required: true
multivalued: false
description: A generating unit may have one or more cost curves, depending
upon fuel mixture and fuel cost.
RotatingMachine:
class_uri: cim:RotatingMachine
is_a: RegulatingCondEq
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: A rotating machine which may be used as a generator or motor.
attributes:
p:
slot_uri: cim:RotatingMachine.p
range: ActivePower
required: false
multivalued: false
description: "Active power injection. Load sign convention is used, i.e. positive\
\ sign means flow out from a node.\r\nStarting value for a steady state\
\ solution."
q:
slot_uri: cim:RotatingMachine.q
range: ReactivePower
required: false
multivalued: false
description: "Reactive power injection. Load sign convention is used, i.e.\
\ positive sign means flow out from a node.\r\nStarting value for a steady\
\ state solution."
ratedPowerFactor:
slot_uri: cim:RotatingMachine.ratedPowerFactor
range: float
required: false
multivalued: false
description: Power factor (nameplate data). It is primarily used for short
circuit data exchange according to IEC 60909. The attribute cannot be a
negative value.
ratedS:
slot_uri: cim:RotatingMachine.ratedS
range: ApparentPower
required: false
multivalued: false
description: "Nameplate apparent power rating for the unit.\r\nThe attribute\
\ shall have a positive value."
ratedU:
slot_uri: cim:RotatingMachine.ratedU
range: Voltage
required: false
multivalued: false
description: "Rated voltage (nameplate data, Ur in IEC 60909-0). It is primarily\
\ used for short circuit data exchange according to IEC 60909.\r\nThe attribute\
\ shall be a positive value."
HydroPump:
slot_uri: cim:RotatingMachine.HydroPump
range: HydroPump
required: false
multivalued: false
description: The synchronous machine drives the turbine which moves the water
from a low elevation to a higher elevation. The direction of machine rotation
for pumping may or may not be the same as for generating.
GeneratingUnit:
slot_uri: cim:RotatingMachine.GeneratingUnit
range: GeneratingUnit
required: false
multivalued: false
description: A synchronous machine may operate as a generator and as such
becomes a member of a generating unit.
RegulatingCondEq:
class_uri: cim:RegulatingCondEq
is_a: EnergyConnection
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: 'A type of conducting equipment that can regulate a quantity (i.e.
voltage or flow) at a specific point in the network. '
attributes:
controlEnabled:
slot_uri: cim:RegulatingCondEq.controlEnabled
range: boolean
required: false
multivalued: false
description: Specifies the regulation status of the equipment. True is regulating,
false is not regulating.
RegulatingControl:
slot_uri: cim:RegulatingCondEq.RegulatingControl
range: RegulatingControl
required: false
multivalued: false
description: The regulating control scheme in which this equipment participates.
RegulatingControl:
class_uri: cim:RegulatingControl
is_a: PowerSystemResource
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: "Specifies a set of equipment that works together to control a power\
\ system quantity such as voltage or flow. \r\nRemote bus voltage control is\
\ possible by specifying the controlled terminal located at some place remote\
\ from the controlling equipment.\r\nThe specified terminal shall be associated\
\ with the connectivity node of the controlled point. The most specific subtype\
\ of RegulatingControl shall be used in case such equipment participate in the\
\ control, e.g. TapChangerControl for tap changers.\r\nFor flow control, load\
\ sign convention is used, i.e. positive sign means flow out from a TopologicalNode\
\ (bus) into the conducting equipment.\r\nThe attribute minAllowedTargetValue\
\ and maxAllowedTargetValue are required in the following cases:\r\n- For a\
\ power generating module operated in power factor control mode to specify maximum\
\ and minimum power factor values;\r\n- Whenever it is necessary to have an\
\ off center target voltage for the tap changer regulator. For instance, due\
\ to long cables to off shore wind farms and the need to have a simpler setup\
\ at the off shore transformer platform, the voltage is controlled from the\
\ land at the connection point for the off shore wind farm. Since there usually\
\ is a voltage rise along the cable, there is typical and overvoltage of up\
\ 3-4 kV compared to the on shore station. Thus in normal operation the tap\
\ changer on the on shore station is operated with a target set point, which\
\ is in the lower parts of the dead band.\r\nThe attributes minAllowedTargetValue\
\ and maxAllowedTargetValue are not related to the attribute targetDeadband\
\ and thus they are not treated as an alternative of the targetDeadband. They\
\ are needed due to limitations in the local substation controller. The attribute\
\ targetDeadband is used to prevent the power flow from move the tap position\
\ in circles (hunting) that is to be used regardless of the attributes minAllowedTargetValue\
\ and maxAllowedTargetValue."
attributes:
discrete:
slot_uri: cim:RegulatingControl.discrete
range: boolean
required: false
multivalued: false
description: The regulation is performed in a discrete mode. This applies
to equipment with discrete controls, e.g. tap changers and shunt compensators.
enabled:
slot_uri: cim:RegulatingControl.enabled
range: boolean
required: false
multivalued: false
description: The flag tells if regulation is enabled.
maxAllowedTargetValue:
slot_uri: cim:RegulatingControl.maxAllowedTargetValue
range: float
required: false
multivalued: false
description: Maximum allowed target value (RegulatingControl.targetValue).
minAllowedTargetValue:
slot_uri: cim:RegulatingControl.minAllowedTargetValue
range: float
required: false
multivalued: false
description: "Minimum allowed target value (RegulatingControl.targetValue).\r\
\n"
mode:
slot_uri: cim:RegulatingControl.mode
range: RegulatingControlModeKind
required: false
multivalued: false
description: The regulating control mode presently available. This specification
allows for determining the kind of regulation without need for obtaining
the units from a schedule.
monitoredPhase:
slot_uri: cim:RegulatingControl.monitoredPhase
range: PhaseCode
required: false
multivalued: false
description: Phase voltage controlling this regulator, measured at regulator
location.
targetDeadband:
slot_uri: cim:RegulatingControl.targetDeadband
range: float
required: false
multivalued: false
description: "This is a deadband used with discrete control to avoid excessive\
\ update of controls like tap changers and shunt compensator banks while\
\ regulating. The units of those appropriate for the mode. The attribute\
\ shall be a positive value or zero. If RegulatingControl.discrete is set\
\ to \"false\", the RegulatingControl.targetDeadband is to be ignored.\r\
\nNote that for instance, if the targetValue is 100 kV and the targetDeadband\
\ is 2 kV the range is from 99 to 101 kV."
targetValue:
slot_uri: cim:RegulatingControl.targetValue
range: float
required: false
multivalued: false
description: The target value specified for case input. This value can be
used for the target value without the use of schedules. The value has the
units appropriate to the mode attribute.
targetValueUnitMultiplier:
slot_uri: cim:RegulatingControl.targetValueUnitMultiplier
range: UnitMultiplier
required: false
multivalued: false
description: Specify the multiplier for used for the targetValue.
RegulatingCondEq:
slot_uri: cim:RegulatingControl.RegulatingCondEq
range: RegulatingCondEq
required: false
multivalued: true
description: The equipment that participates in this regulating control scheme.
RegulationSchedule:
slot_uri: cim:RegulatingControl.RegulationSchedule
range: RegulationSchedule
required: false
multivalued: true
description: Schedule for this regulating control.
Terminal:
slot_uri: cim:RegulatingControl.Terminal
range: Terminal
required: false
multivalued: false
description: 'The terminal associated with this regulating control. The terminal
is associated instead of a node, since the terminal could connect into either
a topological node or a connectivity node. Sometimes it is useful to model
regulation at a terminal of a bus bar object. '
ProtectiveActionRegulation:
slot_uri: cim:RegulatingControl.ProtectiveActionRegulation
range: ProtectiveActionRegulation
required: false
multivalued: true
description: Enable/disable a regulating control or set new target value.
RegulationSchedule:
class_uri: cim:RegulationSchedule
is_a: SeasonDayTypeSchedule
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: A pre-established pattern over time for a controlled variable, e.g.,
busbar voltage.
attributes:
RegulatingControl:
slot_uri: cim:RegulationSchedule.RegulatingControl
range: RegulatingControl
required: true
multivalued: false
description: Regulating controls that have this schedule.
VoltageControlZones:
slot_uri: cim:RegulationSchedule.VoltageControlZones
range: VoltageControlZone
required: false
multivalued: true
description: A VoltageControlZone may have a voltage regulation schedule.
VoltageControlZone:
class_uri: cim:VoltageControlZone
is_a: PowerSystemResource
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: An area of the power system network which is defined for secondary
voltage control purposes. A voltage control zone consists of a collection of
substations with a designated bus bar section whose voltage will be controlled.
attributes:
RegulationSchedule:
slot_uri: cim:VoltageControlZone.RegulationSchedule
range: RegulationSchedule
required: false
multivalued: false
description: A VoltageControlZone may have a voltage regulation schedule.
BusbarSection:
slot_uri: cim:VoltageControlZone.BusbarSection
range: BusbarSection
required: true
multivalued: false
description: A VoltageControlZone is controlled by a designated BusbarSection.
BusbarSection:
class_uri: cim:BusbarSection
is_a: Connector
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: "A conductor, or group of conductors, with negligible impedance,\
\ that serve to connect other conducting equipment within a single substation.\
\ \r\nVoltage measurements are typically obtained from voltage transformers\
\ that are connected to busbar sections. A bus bar section may have many physical\
\ terminals but for analysis is modelled with exactly one logical terminal."
attributes:
ipMax:
slot_uri: cim:BusbarSection.ipMax
range: CurrentFlow
required: false
multivalued: false
description: "Maximum allowable peak short-circuit current of busbar (Ipmax\
\ in IEC 60909-0). \r\nMechanical limit of the busbar in the substation\
\ itself. Used for short circuit data exchange according to IEC 60909."
VoltageControlZone:
slot_uri: cim:BusbarSection.VoltageControlZone
range: VoltageControlZone
required: false
multivalued: false
description: A VoltageControlZone is controlled by a designated BusbarSection.
Connector:
class_uri: cim:Connector
is_a: ConductingEquipment
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: A conductor, or group of conductors, with negligible impedance, that
serve to connect other conducting equipment within a single substation and are
modelled with a single logical terminal.
ProtectiveActionRegulation:
class_uri: cim:ProtectiveActionRegulation
is_a: ProtectiveAction
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfSIPS
description: Protective action to change regulation to Equipment.
attributes:
isRegulating:
slot_uri: cim:ProtectiveActionRegulation.isRegulating
range: boolean
required: false
multivalued: false
description: If true the regulator is put in-service, otherwise out-of-service
(no regulation).
targetValue:
slot_uri: cim:ProtectiveActionRegulation.targetValue
range: float
required: false
multivalued: false
description: The target value specified the new case input for the regulator. The
value has the units appropriate to the mode attribute. The protective action
does not change the mode attribute.
RegulatingControl:
slot_uri: cim:ProtectiveActionRegulation.RegulatingControl
range: RegulatingControl
required: true
multivalued: false
HydroPump:
class_uri: cim:HydroPump
is_a: Equipment
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.Production
description: A synchronous motor-driven pump, typically associated with a pumped
storage plant.
attributes:
pumpDischAtMaxHead:
slot_uri: cim:HydroPump.pumpDischAtMaxHead
range: VolumeFlowRate
required: false
multivalued: false
description: "The pumping discharge under maximum head conditions, usually\
\ at full gate.\r\n"
pumpDischAtMinHead:
slot_uri: cim:HydroPump.pumpDischAtMinHead
range: VolumeFlowRate
required: false
multivalued: false
description: "The pumping discharge under minimum head conditions, usually\
\ at full gate.\r\n"
pumpPowerAtMaxHead:
slot_uri: cim:HydroPump.pumpPowerAtMaxHead
range: ActivePower
required: false
multivalued: false
description: "The pumping power under maximum head conditions, usually at\
\ full gate.\r\n"
pumpPowerAtMinHead:
slot_uri: cim:HydroPump.pumpPowerAtMinHead
range: ActivePower
required: false
multivalued: false
description: The pumping power under minimum head conditions, usually at full
gate.
HydroPumpOpSchedule:
slot_uri: cim:HydroPump.HydroPumpOpSchedule
range: HydroPumpOpSchedule
required: false
multivalued: false
description: The hydro pump has a pumping schedule over time, indicating when
pumping is to occur.
HydroPowerPlant:
slot_uri: cim:HydroPump.HydroPowerPlant
range: HydroPowerPlant
required: false
multivalued: false
description: The hydro pump may be a member of a pumped storage plant or a
pump for distributing water.
RotatingMachine:
slot_uri: cim:HydroPump.RotatingMachine
range: RotatingMachine
required: true
multivalued: false
description: The synchronous machine drives the turbine which moves the water
from a low elevation to a higher elevation. The direction of machine rotation
for pumping may or may not be the same as for generating.
HydroPumpOpSchedule:
class_uri: cim:HydroPumpOpSchedule
is_a: RegularIntervalSchedule
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.Production
description: 'The hydro pump''s Operator-approved current operating schedule (or
plan), typically produced with the aid of unit commitment type analyses. The
unit''s operating schedule status is typically given as: (0=unavailable) (1=available
to startup or shutdown) (2=must pump).'
attributes:
HydroPump:
slot_uri: cim:HydroPumpOpSchedule.HydroPump
range: HydroPump
required: true
multivalued: false
description: The hydro pump has a pumping schedule over time, indicating when
pumping is to occur.
HydroPowerPlant:
class_uri: cim:HydroPowerPlant
is_a: PowerSystemResource
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.Production
description: A hydro power station which can generate or pump. When generating,
the generator turbines receive water from an upper reservoir. When pumping,
the pumps receive their water from a lower reservoir.
attributes:
dischargeTravelDelay:
slot_uri: cim:HydroPowerPlant.dischargeTravelDelay
range: Seconds
required: false
multivalued: false
description: "Water travel delay from tailbay to next downstream hydro power\
\ station.\r\n"
genRatedP:
slot_uri: cim:HydroPowerPlant.genRatedP
range: ActivePower
required: false
multivalued: false
description: "The hydro plant's generating rating active power for rated head\
\ conditions.\r\nThe attribute shall be a positive value.\r\n"
hydroPlantStorageType:
slot_uri: cim:HydroPowerPlant.hydroPlantStorageType
range: HydroPlantStorageKind
required: false
multivalued: false
description: The type of hydro power plant water storage.
penstockType:
slot_uri: cim:HydroPowerPlant.penstockType
range: string
required: false
multivalued: false
description: Type and configuration of hydro plant penstock(s).
plantDischargeCapacity:
slot_uri: cim:HydroPowerPlant.plantDischargeCapacity
range: VolumeFlowRate
required: false
multivalued: false
description: "Total plant discharge capacity.\r\n"
plantRatedHead:
slot_uri: cim:HydroPowerPlant.plantRatedHead
range: Length
required: false
multivalued: false
description: "The plant's rated gross head.\r\nThe attribute shall be a positive\
\ value.\r\n"
pumpRatedP:
slot_uri: cim:HydroPowerPlant.pumpRatedP
range: ActivePower
required: false
multivalued: false
description: "The hydro plant's pumping rating active power for rated head\
\ conditions.\r\nThe attribute shall be a positive value.\r\n"
surgeTankCode:
slot_uri: cim:HydroPowerPlant.surgeTankCode
range: string
required: false
multivalued: false
description: A code describing the type (or absence) of surge tank that is
associated with the hydro power plant.
surgeTankCrestLevel:
slot_uri: cim:HydroPowerPlant.surgeTankCrestLevel
range: WaterLevel
required: false
multivalued: false
description: "The level at which the surge tank spills.\r\n"
HydroPumps:
slot_uri: cim:HydroPowerPlant.HydroPumps
range: HydroPump
required: false
multivalued: true
description: The hydro pump may be a member of a pumped storage plant or a
pump for distributing water.
Reservoir:
slot_uri: cim:HydroPowerPlant.Reservoir
range: Reservoir
required: false
multivalued: false
description: Generators discharge water to or pumps are supplied water from
a downstream reservoir.
GenSourcePumpDischargeReservoir:
slot_uri: cim:HydroPowerPlant.GenSourcePumpDischargeReservoir
range: Reservoir
required: true
multivalued: false
description: Generators are supplied water from or pumps discharge water to
an upstream reservoir.
HydroGeneratingUnits:
slot_uri: cim:HydroPowerPlant.HydroGeneratingUnits
range: HydroGeneratingUnit
required: false
multivalued: true
description: The hydro generating unit belongs to a hydro power plant.
Reservoir:
class_uri: cim:Reservoir
is_a: PowerSystemResource
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.Production
description: "A water storage facility within a hydro system, including: ponds,\
\ lakes, lagoons, and rivers. The storage is usually behind some type of dam.\r\
\n"
attributes:
activeStorageCapacity:
slot_uri: cim:Reservoir.activeStorageCapacity
range: Volume
required: false
multivalued: false
description: "Storage volume between the full supply level and the normal\
\ minimum operating level.\r\n"
energyStorageRating:
slot_uri: cim:Reservoir.energyStorageRating
range: float
required: false
multivalued: false
description: "The reservoir's energy storage rating in energy for given head\
\ conditions.\r\n"
fullSupplyLevel:
slot_uri: cim:Reservoir.fullSupplyLevel
range: WaterLevel
required: false
multivalued: false
description: Full supply level, above which water will spill. This can be
the spillway crest level or the top of closed gates.
grossCapacity:
slot_uri: cim:Reservoir.grossCapacity
range: Volume
required: false
multivalued: false
description: "Total capacity of reservoir.\r\n"
normalMinOperateLevel:
slot_uri: cim:Reservoir.normalMinOperateLevel
range: WaterLevel
required: false
multivalued: false
description: "Normal minimum operating level below which the penstocks will\
\ draw air.\r\n"
riverOutletWorks:
slot_uri: cim:Reservoir.riverOutletWorks
range: string
required: false
multivalued: false
description: "River outlet works for riparian right releases or other purposes.\r\
\n"
spillTravelDelay:
slot_uri: cim:Reservoir.spillTravelDelay
range: Seconds
required: false
multivalued: false
description: "The spillway water travel delay to the next downstream reservoir.\r\
\n"
spillwayCapacity:
slot_uri: cim:Reservoir.spillwayCapacity
range: float
required: false
multivalued: false
description: "The flow capacity of the spillway in cubic meters per second.\r\
\n"
spillwayCrestLength:
slot_uri: cim:Reservoir.spillwayCrestLength
range: Length
required: false
multivalued: false
description: "The length of the spillway crest.\r\n"
spillwayCrestLevel:
slot_uri: cim:Reservoir.spillwayCrestLevel
range: WaterLevel
required: false
multivalued: false
description: "Spillway crest level above which water will spill.\r\n"
spillWayGateType:
slot_uri: cim:Reservoir.spillWayGateType
range: string
required: false
multivalued: false
description: Type of spillway gate, including parameters.
SpillsIntoReservoirs:
slot_uri: cim:Reservoir.SpillsIntoReservoirs
range: Reservoir
required: false
multivalued: true
description: A reservoir may spill into a downstream reservoir.
SpillsFromReservoir:
slot_uri: cim:Reservoir.SpillsFromReservoir
range: Reservoir
required: false
multivalued: false
description: A reservoir may spill into a downstream reservoir.
LevelVsVolumeCurves:
slot_uri: cim:Reservoir.LevelVsVolumeCurves
range: LevelVsVolumeCurve
required: false
multivalued: true
description: A reservoir may have a level versus volume relationship.
InflowForecasts:
slot_uri: cim:Reservoir.InflowForecasts
range: InflowForecast
required: false
multivalued: true
description: A reservoir may have a "natural" inflow forecast.
HydroPowerPlants:
slot_uri: cim:Reservoir.HydroPowerPlants
range: HydroPowerPlant
required: false
multivalued: true
description: Generators discharge water to or pumps are supplied water from
a downstream reservoir.
UpstreamFromHydroPowerPlants:
slot_uri: cim:Reservoir.UpstreamFromHydroPowerPlants
range: HydroPowerPlant
required: false
multivalued: true
description: Generators are supplied water from or pumps discharge water to
an upstream reservoir.
TargetLevelSchedule:
slot_uri: cim:Reservoir.TargetLevelSchedule
range: TargetLevelSchedule
required: false
multivalued: false
description: A reservoir may have a water level target schedule.
LevelVsVolumeCurve:
class_uri: cim:LevelVsVolumeCurve
is_a: Curve
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.Production
description: Relationship between reservoir volume and reservoir level. The volume
is at the Y-axis and the reservoir level at the X-axis.
attributes:
Reservoir:
slot_uri: cim:LevelVsVolumeCurve.Reservoir
range: Reservoir
required: true
multivalued: false
description: A reservoir may have a level versus volume relationship.
InflowForecast:
class_uri: cim:InflowForecast
is_a: RegularIntervalSchedule
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.Production
description: Natural water inflow to a reservoir, usually forecasted from predicted
rain and snowmelt. Typically in one hour increments for up to 10 days. The forecast
is given in average cubic meters per second over the time increment.
attributes:
Reservoir:
slot_uri: cim:InflowForecast.Reservoir
range: Reservoir
required: true
multivalued: false
description: A reservoir may have a "natural" inflow forecast.
TargetLevelSchedule:
class_uri: cim:TargetLevelSchedule
is_a: Curve
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.Production
description: "Reservoir water level targets from advanced studies or \"rule curves\"\
. Typically in one hour increments for up to 10 days.\r\n"
attributes:
highLevelLimit:
slot_uri: cim:TargetLevelSchedule.highLevelLimit
range: WaterLevel
required: false
multivalued: false
description: "High target level limit, above which the reservoir operation\
\ will be penalized.\r\n"
lowLevelLimit:
slot_uri: cim:TargetLevelSchedule.lowLevelLimit
range: WaterLevel
required: false
multivalued: false
description: "Low target level limit, below which the reservoir operation\
\ will be penalized.\r\n"
Reservoir:
slot_uri: cim:TargetLevelSchedule.Reservoir
range: Reservoir
required: true
multivalued: false
description: A reservoir may have a water level target schedule.
HydroGeneratingUnit:
class_uri: cim:HydroGeneratingUnit
is_a: GeneratingUnit
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.Production
description: "A generating unit whose prime mover is a hydraulic turbine (e.g.,\
\ Francis, Pelton, Kaplan).\r\n"
attributes:
dropHeight:
slot_uri: cim:HydroGeneratingUnit.dropHeight
range: Length
required: false
multivalued: false
description: The height water drops from the reservoir mid-point to the turbine.
energyConversionCapability:
slot_uri: cim:HydroGeneratingUnit.energyConversionCapability
range: HydroEnergyConversionKind
required: false
multivalued: false
description: Energy conversion capability for generating.
hydroUnitWaterCost:
slot_uri: cim:HydroGeneratingUnit.hydroUnitWaterCost
range: CostPerVolume
required: false
multivalued: false
description: "The equivalent cost of water that drives the hydro turbine.\r\
\n"
turbineType:
slot_uri: cim:HydroGeneratingUnit.turbineType
range: HydroTurbineKind
required: false
multivalued: false
description: Type of turbine.
TailbayLossCurve:
slot_uri: cim:HydroGeneratingUnit.TailbayLossCurve
range: TailbayLossCurve
required: false
multivalued: true
description: A hydro generating unit has a tailbay loss curve.
HydroPowerPlant:
slot_uri: cim:HydroGeneratingUnit.HydroPowerPlant
range: HydroPowerPlant
required: false
multivalued: false
description: The hydro generating unit belongs to a hydro power plant.
HydroGeneratingEfficiencyCurves:
slot_uri: cim:HydroGeneratingUnit.HydroGeneratingEfficiencyCurves
range: HydroGeneratingEfficiencyCurve
required: false
multivalued: true
description: A hydro generating unit has an efficiency curve.
PenstockLossCurve:
slot_uri: cim:HydroGeneratingUnit.PenstockLossCurve
range: PenstockLossCurve
required: false
multivalued: false
description: A hydro generating unit has a penstock loss curve.
TailbayLossCurve:
class_uri: cim:TailbayLossCurve
is_a: Curve
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.Production
description: Relationship between tailbay head loss height (Y-axis) and the total
discharge into the power station's tailbay volume per time unit (X-axis) . There
could be more than one curve depending on the level of the tailbay reservoir
or river level.
attributes:
HydroGeneratingUnit:
slot_uri: cim:TailbayLossCurve.HydroGeneratingUnit
range: HydroGeneratingUnit
required: true
multivalued: false
description: A hydro generating unit has a tailbay loss curve.
HydroGeneratingEfficiencyCurve:
class_uri: cim:HydroGeneratingEfficiencyCurve
is_a: Curve
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.Production
description: "Relationship between unit efficiency as percentage and unit output\
\ active power for a given net head in meters. The relationship between efficiency,\
\ discharge, head, and power output is expressed as follows: E =KP/HQ\r\n\
where: E is the efficiency, as a percentage; P is the active power; H is the\
\ height; Q is the discharge, volume/time unit; K is a constant.\r\nFor example,\
\ a curve instance for a given net head could show efficiency (Y-axis) versus\
\ active power output (X-axis) or versus discharge on the X-axis."
attributes:
HydroGeneratingUnit:
slot_uri: cim:HydroGeneratingEfficiencyCurve.HydroGeneratingUnit
range: HydroGeneratingUnit
required: true
multivalued: false
description: A hydro generating unit has an efficiency curve.
PenstockLossCurve:
class_uri: cim:PenstockLossCurve
is_a: Curve
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.Production
description: Relationship between penstock head loss (in meters) and total discharge
through the penstock (in cubic meters per second). One or more turbines may
be connected to the same penstock.
attributes:
HydroGeneratingUnit:
slot_uri: cim:PenstockLossCurve.HydroGeneratingUnit
range: HydroGeneratingUnit
required: true
multivalued: false
description: A hydro generating unit has a penstock loss curve.
CogenerationPlant:
class_uri: cim:CogenerationPlant
is_a: PowerSystemResource
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.Production
description: "A set of thermal generating units for the production of electrical\
\ energy and process steam (usually from the output of the steam turbines).\
\ The steam sendout is typically used for industrial purposes or for municipal\
\ heating and cooling.\r\n"
attributes:
cogenHPSendoutRating:
slot_uri: cim:CogenerationPlant.cogenHPSendoutRating
range: float
required: false
multivalued: false
description: "The high pressure steam sendout.\r\n"
cogenHPSteamRating:
slot_uri: cim:CogenerationPlant.cogenHPSteamRating
range: float
required: false
multivalued: false
description: "The high pressure steam rating.\r\n"
cogenLPSendoutRating:
slot_uri: cim:CogenerationPlant.cogenLPSendoutRating
range: float
required: false
multivalued: false
description: "The low pressure steam sendout.\r\n"
cogenLPSteamRating:
slot_uri: cim:CogenerationPlant.cogenLPSteamRating
range: float
required: false
multivalued: false
description: "The low pressure steam rating.\r\n"
ratedP:
slot_uri: cim:CogenerationPlant.ratedP
range: ActivePower
required: false
multivalued: false
description: "The rated output active power of the cogeneration plant.\r\n\
The attribute shall be a positive value.\r\n"
ThermalGeneratingUnits:
slot_uri: cim:CogenerationPlant.ThermalGeneratingUnits
range: ThermalGeneratingUnit
required: false
multivalued: true
description: A thermal generating unit may be a member of a cogeneration plant.
SteamSendoutSchedule:
slot_uri: cim:CogenerationPlant.SteamSendoutSchedule
range: SteamSendoutSchedule
required: true
multivalued: false
description: A cogeneration plant has a steam sendout schedule.
SteamSendoutSchedule:
class_uri: cim:SteamSendoutSchedule
is_a: RegularIntervalSchedule
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.Production
description: The cogeneration plant's steam sendout schedule in volume per time
unit.
attributes:
CogenerationPlant:
slot_uri: cim:SteamSendoutSchedule.CogenerationPlant
range: CogenerationPlant
required: true
multivalued: false
description: A cogeneration plant has a steam sendout schedule.
FuelAllocationSchedule:
class_uri: cim:FuelAllocationSchedule
is_a: Curve
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.Production
description: "The amount of fuel of a given type which is allocated for consumption\
\ over a specified period of time.\r\n"
attributes:
fuelAllocationEndDate:
slot_uri: cim:FuelAllocationSchedule.fuelAllocationEndDate
range: date
required: false
multivalued: false
description: "The end time and date of the fuel allocation schedule.\r\n"
fuelAllocationStartDate:
slot_uri: cim:FuelAllocationSchedule.fuelAllocationStartDate
range: date
required: false
multivalued: false
description: "The start time and date of the fuel allocation schedule.\r\n"
fuelType:
slot_uri: cim:FuelAllocationSchedule.fuelType
range: FuelType
required: false
multivalued: false
description: "The type of fuel, which also indicates the corresponding measurement\
\ unit.\r\n"
maxFuelAllocation:
slot_uri: cim:FuelAllocationSchedule.maxFuelAllocation
range: float
required: false
multivalued: false
description: The maximum amount of fuel that is allocated for consumption
for the scheduled time period.
minFuelAllocation:
slot_uri: cim:FuelAllocationSchedule.minFuelAllocation
range: float
required: false
multivalued: false
description: The minimum amount of fuel that is allocated for consumption
for the scheduled time period, e.g., based on a "take-or-pay" contract.
ThermalGeneratingUnit:
slot_uri: cim:FuelAllocationSchedule.ThermalGeneratingUnit
range: ThermalGeneratingUnit
required: true
multivalued: false
description: A thermal generating unit may have one or more fuel allocation
schedules.
FossilFuel:
slot_uri: cim:FuelAllocationSchedule.FossilFuel
range: FossilFuel
required: true
multivalued: false
description: A fuel allocation schedule shall have a fossil fuel.
FossilFuel:
class_uri: cim:FossilFuel
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.Production
description: The fossil fuel consumed by the non-nuclear thermal generating unit. For
example, coal, oil, gas, etc. These are the specific fuels that the generating
unit can consume.
attributes:
fossilFuelType:
slot_uri: cim:FossilFuel.fossilFuelType
range: FuelType
required: false
multivalued: false
description: The type of fossil fuel, such as coal, oil, or gas.
fuelCost:
slot_uri: cim:FossilFuel.fuelCost
range: CostPerHeatUnit
required: false
multivalued: false
description: "The cost in terms of heat value for the given type of fuel.\r\
\n"
fuelDispatchCost:
slot_uri: cim:FossilFuel.fuelDispatchCost
range: CostPerHeatUnit
required: false
multivalued: false
description: "The cost of fuel used for economic dispatching which includes:\
\ fuel cost, transportation cost, and incremental maintenance cost.\r\n"
fuelEffFactor:
slot_uri: cim:FossilFuel.fuelEffFactor
range: PU
required: false
multivalued: false
description: "The efficiency factor for the fuel (per unit) in terms of the\
\ effective energy absorbed.\r\n"
fuelHandlingCost:
slot_uri: cim:FossilFuel.fuelHandlingCost
range: CostPerHeatUnit
required: false
multivalued: false
description: "Handling and processing cost associated with this fuel.\r\n"
fuelHeatContent:
slot_uri: cim:FossilFuel.fuelHeatContent
range: float
required: false
multivalued: false
description: "The amount of heat per weight (or volume) of the given type\
\ of fuel.\r\n"
fuelMixture:
slot_uri: cim:FossilFuel.fuelMixture
range: PerCent
required: false
multivalued: false
description: Relative amount of the given type of fuel, when multiple fuels
are being consumed.
fuelSulfur:
slot_uri: cim:FossilFuel.fuelSulfur
range: PU
required: false
multivalued: false
description: "The fuel's fraction of pollution credit per unit of heat content.\r\
\n"
highBreakpointP:
slot_uri: cim:FossilFuel.highBreakpointP
range: ActivePower
required: false
multivalued: false
description: The active power output level of the unit at which the given
type of fuel is switched on. This fuel (e.g., oil) is sometimes used to
supplement the base fuel (e.g., coal) at high active power output levels.
lowBreakpointP:
slot_uri: cim:FossilFuel.lowBreakpointP
range: ActivePower
required: false
multivalued: false
description: The active power output level of the unit at which the given
type of fuel is switched off. This fuel (e.g., oil) is sometimes used to
stabilize the base fuel (e.g., coal) at low active power output levels.
FuelAllocationSchedules:
slot_uri: cim:FossilFuel.FuelAllocationSchedules
range: FuelAllocationSchedule
required: false
multivalued: true
description: A fuel allocation schedule shall have a fossil fuel.
ThermalGeneratingUnit:
slot_uri: cim:FossilFuel.ThermalGeneratingUnit
range: ThermalGeneratingUnit
required: true
multivalued: false
description: A thermal generating unit may have one or more fossil fuels.
StartupModel:
class_uri: cim:StartupModel
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.Production
description: "Unit start up characteristics depending on how long the unit has\
\ been off line.\r\n"
attributes:
fixedMaintCost:
slot_uri: cim:StartupModel.fixedMaintCost
range: CostRate
required: false
multivalued: false
description: "Fixed maintenance cost.\r\n"
hotStandbyHeat:
slot_uri: cim:StartupModel.hotStandbyHeat
range: HeatRate
required: false
multivalued: false
description: The amount of heat input per time unit required for hot standby
operation.
incrementalMaintCost:
slot_uri: cim:StartupModel.incrementalMaintCost
range: CostPerEnergyUnit
required: false
multivalued: false
description: "Incremental maintenance cost.\r\n"
minimumDownTime:
slot_uri: cim:StartupModel.minimumDownTime
range: Hours
required: false
multivalued: false
description: "The minimum number of hours the unit must be down before restart.\r\
\n"
minimumRunTime:
slot_uri: cim:StartupModel.minimumRunTime
range: Hours
required: false
multivalued: false
description: "The minimum number of hours the unit must be operating before\
\ being allowed to shut down.\r\n"
riskFactorCost:
slot_uri: cim:StartupModel.riskFactorCost
range: Money
required: false
multivalued: false
description: The opportunity cost associated with the return in monetary unit.
This represents the restart's "share" of the unit depreciation and risk
of an event which would damage the unit.
startupCost:
slot_uri: cim:StartupModel.startupCost
range: Money
required: false
multivalued: false
description: "Total miscellaneous start up costs.\r\n"
startupDate:
slot_uri: cim:StartupModel.startupDate
range: date
required: false
multivalued: false
description: "The date and time of the most recent generating unit startup.\r\
\n"
startupPriority:
slot_uri: cim:StartupModel.startupPriority
range: integer
required: false
multivalued: false
description: Startup priority within control area where lower numbers indicate
higher priorities. More than one unit in an area may be assigned the same
priority.
stbyAuxP:
slot_uri: cim:StartupModel.stbyAuxP
range: ActivePower
required: false
multivalued: false
description: "The unit's auxiliary active power consumption to maintain standby\
\ mode.\r\n"
ThermalGeneratingUnit:
slot_uri: cim:StartupModel.ThermalGeneratingUnit
range: ThermalGeneratingUnit
required: true
multivalued: false
description: A thermal generating unit may have a startup model.
StartRampCurve:
slot_uri: cim:StartupModel.StartRampCurve
range: StartRampCurve
required: false
multivalued: false
description: The unit's startup model may have a startup ramp curve.
StartIgnFuelCurve:
slot_uri: cim:StartupModel.StartIgnFuelCurve
range: StartIgnFuelCurve
required: false
multivalued: false
description: The unit's startup model may have a startup ignition fuel curve.
StartMainFuelCurve:
slot_uri: cim:StartupModel.StartMainFuelCurve
range: StartMainFuelCurve
required: false
multivalued: false
description: The unit's startup model may have a startup main fuel curve.
StartRampCurve:
class_uri: cim:StartRampCurve
is_a: Curve
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.Production
description: Rate in gross active power per minute (Y-axis) at which a unit can
be loaded versus the number of hours (X-axis) the unit was off line.
attributes:
hotStandbyRamp:
slot_uri: cim:StartRampCurve.hotStandbyRamp
range: ActivePowerChangeRate
required: false
multivalued: false
description: "The startup ramp rate in gross for a unit that is on hot standby.\r\
\n"
StartupModel:
slot_uri: cim:StartRampCurve.StartupModel
range: StartupModel
required: true
multivalued: false
description: The unit's startup model may have a startup ramp curve.
StartIgnFuelCurve:
class_uri: cim:StartIgnFuelCurve
is_a: Curve
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.Production
description: "The quantity of ignition fuel (Y-axis) used to restart and repay\
\ the auxiliary power consumed versus the number of hours (X-axis) the unit\
\ was off line.\r\n"
attributes:
ignitionFuelType:
slot_uri: cim:StartIgnFuelCurve.ignitionFuelType
range: FuelType
required: false
multivalued: false
description: "Type of ignition fuel.\r\n"
StartupModel:
slot_uri: cim:StartIgnFuelCurve.StartupModel
range: StartupModel
required: true
multivalued: false
description: The unit's startup model may have a startup ignition fuel curve.
StartMainFuelCurve:
class_uri: cim:StartMainFuelCurve
is_a: Curve
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.Production
description: "The quantity of main fuel (Y-axis) used to restart and repay the\
\ auxiliary power consumed versus the number of hours (X-axis) the unit was\
\ off line.\r\n"
attributes:
mainFuelType:
slot_uri: cim:StartMainFuelCurve.mainFuelType
range: FuelType
required: false
multivalued: false
description: "Type of main fuel.\r\n"
StartupModel:
slot_uri: cim:StartMainFuelCurve.StartupModel
range: StartupModel
required: true
multivalued: false
description: The unit's startup model may have a startup main fuel curve.
EmissionCurve:
class_uri: cim:EmissionCurve
is_a: Curve
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.Production
description: "Relationship between the unit's emission rate in units of mass per\
\ hour (Y-axis) and output active power (X-axis) for a given type of emission.\
\ This curve applies when only one type of fuel is being burned.\r\n"
attributes:
emissionContent:
slot_uri: cim:EmissionCurve.emissionContent
range: Emission
required: false
multivalued: false
description: "The emission content per quantity of fuel burned.\r\n"
emissionType:
slot_uri: cim:EmissionCurve.emissionType
range: EmissionType
required: false
multivalued: false
description: The type of emission, which also gives the production rate measurement
unit. The y1AxisUnits of the curve contains the unit of measure (e.g. kg)
and the emissionType is the type of emission (e.g. sulfur dioxide).
isNetGrossP:
slot_uri: cim:EmissionCurve.isNetGrossP
range: boolean
required: false
multivalued: false
description: "Flag is set to true when output is expressed in net active power.\r\
\n"
ThermalGeneratingUnit:
slot_uri: cim:EmissionCurve.ThermalGeneratingUnit
range: ThermalGeneratingUnit
required: true
multivalued: false
description: A thermal generating unit may have one or more emission curves.
ShutdownCurve:
class_uri: cim:ShutdownCurve
is_a: Curve
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.Production
description: "Relationship between the rate in gross active power/minute (Y-axis)\
\ at which a unit should be shutdown and its present gross MW output (X-axis).\r\
\n"
attributes:
shutdownCost:
slot_uri: cim:ShutdownCurve.shutdownCost
range: Money
required: false
multivalued: false
description: "Fixed shutdown cost.\r\n"
shutdownDate:
slot_uri: cim:ShutdownCurve.shutdownDate
range: date
required: false
multivalued: false
description: "The date and time of the most recent generating unit shutdown.\r\
\n"
ThermalGeneratingUnit:
slot_uri: cim:ShutdownCurve.ThermalGeneratingUnit
range: ThermalGeneratingUnit
required: true
multivalued: false
description: A thermal generating unit may have a shutdown curve.
IncrementalHeatRateCurve:
class_uri: cim:IncrementalHeatRateCurve
is_a: Curve
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.Production
description: Relationship between unit incremental heat rate in (delta energy/time)
per (delta active power) and unit output in active power. The IHR curve represents
the slope of the HeatInputCurve. Note that the "incremental heat rate" and the
"heat rate" have the same engineering units.
attributes:
isNetGrossP:
slot_uri: cim:IncrementalHeatRateCurve.isNetGrossP
range: boolean
required: false
multivalued: false
description: "Flag is set to true when output is expressed in net active power.\r\
\n"
ThermalGeneratingUnit:
slot_uri: cim:IncrementalHeatRateCurve.ThermalGeneratingUnit
range: ThermalGeneratingUnit
required: true
multivalued: false
description: A thermal generating unit may have an incremental heat rate curve.
CAESPlant:
class_uri: cim:CAESPlant
is_a: PowerSystemResource
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.Production
description: "Compressed air energy storage plant.\r\n"
attributes:
energyStorageCapacity:
slot_uri: cim:CAESPlant.energyStorageCapacity
range: RealEnergy
required: false
multivalued: false
description: The rated energy storage capacity. The attribute shall be a positive
value.
ratedCapacityP:
slot_uri: cim:CAESPlant.ratedCapacityP
range: ActivePower
required: false
multivalued: false
description: "The CAES plant's gross rated generating capacity. The attribute\
\ shall be a positive value.\r\n"
ThermalGeneratingUnit:
slot_uri: cim:CAESPlant.ThermalGeneratingUnit
range: ThermalGeneratingUnit
required: false
multivalued: false
description: A thermal generating unit may be a member of a compressed air
energy storage plant.
AirCompressor:
slot_uri: cim:CAESPlant.AirCompressor
range: AirCompressor
required: true
multivalued: false
description: An air compressor may be a member of a compressed air energy
storage plant.
AirCompressor:
class_uri: cim:AirCompressor
is_a: PowerSystemResource
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.Production
description: "Combustion turbine air compressor which is an integral part of a\
\ compressed air energy storage (CAES) plant.\r\n"
attributes:
airCompressorRating:
slot_uri: cim:AirCompressor.airCompressorRating
range: float
required: false
multivalued: false
description: "Rating of the CAES air compressor.\r\n"
CAESPlant:
slot_uri: cim:AirCompressor.CAESPlant
range: CAESPlant
required: true
multivalued: false
description: An air compressor may be a member of a compressed air energy
storage plant.
CombustionTurbine:
slot_uri: cim:AirCompressor.CombustionTurbine
range: CombustionTurbine
required: true
multivalued: false
description: A CAES air compressor is driven by combustion turbine.
CombustionTurbine:
class_uri: cim:CombustionTurbine
is_a: PrimeMover
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.GenerationTrainingSimulation
description: A prime mover that is typically fuelled by gas or light oil.
attributes:
ambientTemp:
slot_uri: cim:CombustionTurbine.ambientTemp
range: Temperature
required: false
multivalued: false
description: Default ambient temperature to be used in modelling applications.
auxPowerVersusFrequency:
slot_uri: cim:CombustionTurbine.auxPowerVersusFrequency
range: PU
required: false
multivalued: false
description: Off-nominal frequency effect on turbine auxiliaries. Per unit
reduction in auxiliary active power consumption versus per unit reduction
in frequency (from rated frequency).
auxPowerVersusVoltage:
slot_uri: cim:CombustionTurbine.auxPowerVersusVoltage
range: PU
required: false
multivalued: false
description: Off-nominal voltage effect on turbine auxiliaries. Per unit reduction
in auxiliary active power consumption versus per unit reduction in auxiliary
bus voltage (from a specified voltage level).
capabilityVersusFrequency:
slot_uri: cim:CombustionTurbine.capabilityVersusFrequency
range: PU
required: false
multivalued: false
description: Off-nominal frequency effect on turbine capability. Per unit
reduction in unit active power capability versus per unit reduction in frequency
(from rated frequency).
heatRecoveryFlag:
slot_uri: cim:CombustionTurbine.heatRecoveryFlag
range: boolean
required: false
multivalued: false
description: "Flag that is set to true if the combustion turbine is associated\
\ with a heat recovery boiler.\r\n"
powerVariationByTemp:
slot_uri: cim:CombustionTurbine.powerVariationByTemp
range: PU
required: false
multivalued: false
description: "Per unit change in power per (versus) unit change in ambient\
\ temperature.\r\n"
referenceTemp:
slot_uri: cim:CombustionTurbine.referenceTemp
range: Temperature
required: false
multivalued: false
description: Reference temperature at which the output of the turbine was
defined.
timeConstant:
slot_uri: cim:CombustionTurbine.timeConstant
range: Seconds
required: false
multivalued: false
description: The time constant for the turbine.
AirCompressor:
slot_uri: cim:CombustionTurbine.AirCompressor
range: AirCompressor
required: false
multivalued: false
description: A CAES air compressor is driven by combustion turbine.
HeatRecoveryBoiler:
slot_uri: cim:CombustionTurbine.HeatRecoveryBoiler
range: HeatRecoveryBoiler
required: false
multivalued: false
description: A combustion turbine may have a heat recovery boiler for making
steam.
CTTempActivePowerCurve:
slot_uri: cim:CombustionTurbine.CTTempActivePowerCurve
range: CTTempActivePowerCurve
required: false
multivalued: false
description: A combustion turbine may have an active power versus ambient
temperature relationship.
PrimeMover:
class_uri: cim:PrimeMover
is_a: PowerSystemResource
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.GenerationTrainingSimulation
description: The machine used to develop mechanical energy used to drive a generator.
attributes:
primeMoverRating:
slot_uri: cim:PrimeMover.primeMoverRating
range: float
required: false
multivalued: false
description: "Rating of prime mover.\r\n"
SynchronousMachines:
slot_uri: cim:PrimeMover.SynchronousMachines
range: SynchronousMachine
required: false
multivalued: true
description: Synchronous machines this Prime mover drives.
SynchronousMachine:
class_uri: cim:SynchronousMachine
is_a: RotatingMachine
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: 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.
attributes:
aVRToManualLag:
slot_uri: cim:SynchronousMachine.aVRToManualLag
range: Seconds
required: false
multivalued: false
description: Time delay required when switching from Automatic Voltage Regulation
(AVR) to Manual for a lagging MVAr violation.
aVRToManualLead:
slot_uri: cim:SynchronousMachine.aVRToManualLead
range: Seconds
required: false
multivalued: false
description: Time delay required when switching from Automatic Voltage Regulation
(AVR) to Manual for a leading MVAr violation.
baseQ:
slot_uri: cim:SynchronousMachine.baseQ
range: ReactivePower
required: false
multivalued: false
description: Default base reactive power value. This value represents the
initial reactive power that can be used by any application function.
condenserP:
slot_uri: cim:SynchronousMachine.condenserP
range: ActivePower
required: false
multivalued: false
description: Active power consumed when in condenser mode operation.
coolantCondition:
slot_uri: cim:SynchronousMachine.coolantCondition
range: float
required: false
multivalued: false
description: Temperature or pressure of coolant medium.
coolantType:
slot_uri: cim:SynchronousMachine.coolantType
range: CoolantType
required: false
multivalued: false
description: Method of cooling the machine.
earthing:
slot_uri: cim:SynchronousMachine.earthing
range: boolean
required: false
multivalued: false
description: Indicates whether or not the generator is earthed. Used for short
circuit data exchange according to IEC 60909.
earthingStarPointR:
slot_uri: cim:SynchronousMachine.earthingStarPointR
range: Resistance
required: false
multivalued: false
description: Generator star point earthing resistance (Re). Used for short
circuit data exchange according to IEC 60909.
earthingStarPointX:
slot_uri: cim:SynchronousMachine.earthingStarPointX
range: Reactance
required: false
multivalued: false
description: Generator star point earthing reactance (Xe). Used for short
circuit data exchange according to IEC 60909.
ikk:
slot_uri: cim:SynchronousMachine.ikk
range: CurrentFlow
required: false
multivalued: false
description: "Steady-state short-circuit current (in A for the profile) of\
\ generator with compound excitation during 3-phase short circuit.\r\n-\
\ Ikk=0: Generator with no compound excitation.\r\n- Ikk<>0: Generator\
\ with compound excitation.\r\nIkk is used to calculate the minimum steady-state\
\ short-circuit current for generators with compound excitation.\r\n(4.6.1.2\
\ in IEC 60909-0:2001).\r\nUsed only for single fed short circuit on a generator.\
\ (4.3.4.2. in IEC 60909-0:2001)."
manualToAVR:
slot_uri: cim:SynchronousMachine.manualToAVR
range: Seconds
required: false
multivalued: false
description: Time delay required when switching from Manual to Automatic Voltage
Regulation. This value is used in the accelerating power reference frame
for powerflow solutions.
maxQ:
slot_uri: cim:SynchronousMachine.maxQ
range: ReactivePower
required: false
multivalued: false
description: Maximum reactive power limit. This is the maximum (nameplate)
limit for the unit.
maxU:
slot_uri: cim:SynchronousMachine.maxU
range: Voltage
required: false
multivalued: false
description: Maximum voltage limit for the unit.
minQ:
slot_uri: cim:SynchronousMachine.minQ
range: ReactivePower
required: false
multivalued: false
description: Minimum reactive power limit for the unit.
minU:
slot_uri: cim:SynchronousMachine.minU
range: Voltage
required: false
multivalued: false
description: Minimum voltage limit for the unit.
mu:
slot_uri: cim:SynchronousMachine.mu
range: float
required: false
multivalued: false
description: "Factor to calculate the breaking current (Section 4.5.2.1 in\
\ IEC 60909-0).\r\nUsed only for single fed short circuit on a generator\
\ (Section 4.3.4.2. in IEC 60909-0)."
operatingMode:
slot_uri: cim:SynchronousMachine.operatingMode
range: SynchronousMachineOperatingMode
required: false
multivalued: false
description: Current mode of operation.
qPercent:
slot_uri: cim:SynchronousMachine.qPercent
range: PerCent
required: false
multivalued: false
description: 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.
r:
slot_uri: cim:SynchronousMachine.r
range: Resistance
required: false
multivalued: false
description: 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.
r0:
slot_uri: cim:SynchronousMachine.r0
range: Resistance
required: false
multivalued: false
description: Zero sequence resistance of the synchronous machine.
r2:
slot_uri: cim:SynchronousMachine.r2
range: Resistance
required: false
multivalued: false
description: Negative sequence resistance.
referencePriority:
slot_uri: cim:SynchronousMachine.referencePriority
range: integer
required: false
multivalued: false
description: "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.\r\n"
satDirectSubtransX:
slot_uri: cim:SynchronousMachine.satDirectSubtransX
range: PU
required: false
multivalued: false
description: Direct-axis subtransient reactance saturated, also known as Xd"sat.
satDirectSyncX:
slot_uri: cim:SynchronousMachine.satDirectSyncX
range: PU
required: false
multivalued: false
description: 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).
satDirectTransX:
slot_uri: cim:SynchronousMachine.satDirectTransX
range: PU
required: false
multivalued: false
description: Saturated Direct-axis transient reactance. The attribute is primarily
used for short circuit calculations according to ANSI.
shortCircuitRotorType:
slot_uri: cim:SynchronousMachine.shortCircuitRotorType
range: ShortCircuitRotorKind
required: false
multivalued: false
description: Type of rotor, used by short circuit applications, only for single
fed short circuit according to IEC 60909.
type:
slot_uri: cim:SynchronousMachine.type
range: SynchronousMachineKind
required: false
multivalued: false
description: Modes that this synchronous machine can operate in.
voltageRegulationRange:
slot_uri: cim:SynchronousMachine.voltageRegulationRange
range: PerCent
required: false
multivalued: false
description: "Range of generator voltage regulation (PG in IEC 60909-0) used\
\ for calculation of the impedance correction factor KG defined in IEC 60909-0.\r\
\nThis attribute is used to describe the operating voltage of the generating\
\ unit."
x0:
slot_uri: cim:SynchronousMachine.x0
range: Reactance
required: false
multivalued: false
description: Zero sequence reactance of the synchronous machine.
x2:
slot_uri: cim:SynchronousMachine.x2
range: Reactance
required: false
multivalued: false
description: Negative sequence reactance.
PrimeMovers:
slot_uri: cim:SynchronousMachine.PrimeMovers
range: PrimeMover
required: false
multivalued: true
description: Prime movers that drive this SynchronousMachine.
InitialReactiveCapabilityCurve:
slot_uri: cim:SynchronousMachine.InitialReactiveCapabilityCurve
range: ReactiveCapabilityCurve
required: false
multivalued: false
description: The default reactive capability curve for use by a synchronous
machine.
ReactiveCapabilityCurves:
slot_uri: cim:SynchronousMachine.ReactiveCapabilityCurves
range: ReactiveCapabilityCurve
required: false
multivalued: true
description: All available reactive capability curves for this synchronous
machine.
SynchronousMachineDynamics:
slot_uri: cim:SynchronousMachine.SynchronousMachineDynamics
range: SynchronousMachineDynamics
required: false
multivalued: false
description: Synchronous machine dynamics model used to describe dynamic behaviour
of this synchronous machine.
ReactiveCapabilityCurve:
class_uri: cim:ReactiveCapabilityCurve
is_a: Curve
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: Reactive power rating envelope versus the synchronous machine's active
power, in both the generating and motoring modes. For each active power value
there is a corresponding high and low reactive power limit value. Typically
there will be a separate curve for each coolant condition, such as hydrogen
pressure. The Y1 axis values represent reactive minimum and the Y2 axis values
represent reactive maximum.
attributes:
coolantTemperature:
slot_uri: cim:ReactiveCapabilityCurve.coolantTemperature
range: Temperature
required: false
multivalued: false
description: The machine's coolant temperature (e.g., ambient air or stator
circulating water).
hydrogenPressure:
slot_uri: cim:ReactiveCapabilityCurve.hydrogenPressure
range: Pressure
required: false
multivalued: false
description: The hydrogen coolant pressure.
EquivalentInjection:
slot_uri: cim:ReactiveCapabilityCurve.EquivalentInjection
range: EquivalentInjection
required: false
multivalued: true
description: The equivalent injection using this reactive capability curve.
InitiallyUsedBySynchronousMachines:
slot_uri: cim:ReactiveCapabilityCurve.InitiallyUsedBySynchronousMachines
range: SynchronousMachine
required: true
multivalued: true
description: Synchronous machines using this curve as default.
SynchronousMachines:
slot_uri: cim:ReactiveCapabilityCurve.SynchronousMachines
range: SynchronousMachine
required: true
multivalued: true
description: Synchronous machines using this curve.
EquivalentInjection:
class_uri: cim:EquivalentInjection
is_a: EquivalentEquipment
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Equivalents
description: This class represents equivalent injections (generation or load). Voltage
regulation is allowed only at the point of connection.
attributes:
maxP:
slot_uri: cim:EquivalentInjection.maxP
range: ActivePower
required: false
multivalued: false
description: Maximum active power of the injection.
maxQ:
slot_uri: cim:EquivalentInjection.maxQ
range: ReactivePower
required: false
multivalued: false
description: '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. '
minP:
slot_uri: cim:EquivalentInjection.minP
range: ActivePower
required: false
multivalued: false
description: Minimum active power of the injection.
minQ:
slot_uri: cim:EquivalentInjection.minQ
range: ReactivePower
required: false
multivalued: false
description: 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.
p:
slot_uri: cim:EquivalentInjection.p
range: ActivePower
required: false
multivalued: false
description: "Equivalent active power injection. Load sign convention is used,\
\ i.e. positive sign means flow out from a node.\r\nStarting value for steady\
\ state solutions."
q:
slot_uri: cim:EquivalentInjection.q
range: ReactivePower
required: false
multivalued: false
description: "Equivalent reactive power injection. Load sign convention is\
\ used, i.e. positive sign means flow out from a node.\r\nStarting value\
\ for steady state solutions."
r:
slot_uri: cim:EquivalentInjection.r
range: Resistance
required: false
multivalued: false
description: "Positive sequence resistance. Used to represent Extended-Ward\
\ (IEC 60909).\r\nUsage : Extended-Ward is a result of network reduction\
\ prior to the data exchange. "
r0:
slot_uri: cim:EquivalentInjection.r0
range: Resistance
required: false
multivalued: false
description: "Zero sequence resistance. Used to represent Extended-Ward (IEC\
\ 60909).\r\nUsage : Extended-Ward is a result of network reduction prior\
\ to the data exchange. "
r2:
slot_uri: cim:EquivalentInjection.r2
range: Resistance
required: false
multivalued: false
description: "Negative sequence resistance. Used to represent Extended-Ward\
\ (IEC 60909).\r\nUsage : Extended-Ward is a result of network reduction\
\ prior to the data exchange. "
regulationCapability:
slot_uri: cim:EquivalentInjection.regulationCapability
range: boolean
required: false
multivalued: false
description: 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.
regulationStatus:
slot_uri: cim:EquivalentInjection.regulationStatus
range: boolean
required: false
multivalued: false
description: Specifies the regulation status of the EquivalentInjection. True
is regulating. False is not regulating.
regulationTarget:
slot_uri: cim:EquivalentInjection.regulationTarget
range: Voltage
required: false
multivalued: false
description: The target voltage for voltage regulation. The attribute shall
be a positive value.
x:
slot_uri: cim:EquivalentInjection.x
range: Reactance
required: false
multivalued: false
description: "Positive sequence reactance. Used to represent Extended-Ward\
\ (IEC 60909).\r\nUsage : Extended-Ward is a result of network reduction\
\ prior to the data exchange. "
x0:
slot_uri: cim:EquivalentInjection.x0
range: Reactance
required: false
multivalued: false
description: "Zero sequence reactance. Used to represent Extended-Ward (IEC\
\ 60909).\r\nUsage : Extended-Ward is a result of network reduction prior\
\ to the data exchange. "
x2:
slot_uri: cim:EquivalentInjection.x2
range: Reactance
required: false
multivalued: false
description: "Negative sequence reactance. Used to represent Extended-Ward\
\ (IEC 60909).\r\nUsage : Extended-Ward is a result of network reduction\
\ prior to the data exchange. "
ReactiveCapabilityCurve:
slot_uri: cim:EquivalentInjection.ReactiveCapabilityCurve
range: ReactiveCapabilityCurve
required: false
multivalued: false
description: The reactive capability curve used by this equivalent injection.
EquivalentEquipment:
class_uri: cim:EquivalentEquipment
is_a: ConductingEquipment
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Equivalents
description: The class represents equivalent objects that are the result of a
network reduction. The class is the base for equivalent objects of different
types.
attributes:
EquivalentNetwork:
slot_uri: cim:EquivalentEquipment.EquivalentNetwork
range: EquivalentNetwork
required: false
multivalued: false
description: The equivalent where the reduced model belongs.
EquivalentNetwork:
class_uri: cim:EquivalentNetwork
is_a: ConnectivityNodeContainer
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Equivalents
description: A class that groups electrical equivalents, including internal nodes,
of a network that has been reduced. The ConnectivityNodes contained in the equivalent
are intended to reflect internal nodes of the equivalent. The boundary Connectivity
nodes where the equivalent connects outside itself are not contained by the
equivalent.
attributes:
EquivalentEquipments:
slot_uri: cim:EquivalentNetwork.EquivalentEquipments
range: EquivalentEquipment
required: false
multivalued: true
description: The associated reduced equivalents.
SynchronousMachineDynamics:
class_uri: cim:SynchronousMachineDynamics
is_a: RotatingMachineDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.SynchronousMachineDynamics
description: "Synchronous machine whose behaviour is described by reference to\
\ a standard model expressed in one of the following forms:\r\n- simplified\
\ (or classical), where a group of generators or motors is not modelled in detail;\r\
\n- detailed, in equivalent circuit form;\r\n- detailed, in time constant reactance\
\ form; or\r\n- by definition of a user-defined model.\r\
\nIt is a common practice to represent small generators\
\ by a negative load rather than by a dynamic generator model when performing\
\ dynamics simulations. In this case, a SynchronousMachine in the static model\
\ is not represented by anything in the dynamics model, instead it is treated\
\ as an ordinary load.\r\nParameter details:\r\
\n\r\n\t- Synchronous machine parameters such\
\ as Xl, Xd, Xp etc. are actually used as inductances in the models,\
\ but are commonly referred to as reactances since, at nominal frequency, the\
\ PU values are the same. However, some references use the symbol L instead\
\ of X.
\r\n
"
attributes:
SynchronousMachine:
slot_uri: cim:SynchronousMachineDynamics.SynchronousMachine
range: SynchronousMachine
required: true
multivalued: false
description: Synchronous machine to which synchronous machine dynamics model
applies.
TurbineGovernorDynamics:
slot_uri: cim:SynchronousMachineDynamics.TurbineGovernorDynamics
range: TurbineGovernorDynamics
required: false
multivalued: true
description: Turbine-governor model associated with this synchronous machine
model. Multiplicity of greater than one is intended to support hydro units
that have multiple turbines on one generator.
GenICompensationForGenJ:
slot_uri: cim:SynchronousMachineDynamics.GenICompensationForGenJ
range: GenICompensationForGenJ
required: false
multivalued: true
description: Compensation of voltage compensator's generator for current flow
out of this generator.
ExcitationSystemDynamics:
slot_uri: cim:SynchronousMachineDynamics.ExcitationSystemDynamics
range: ExcitationSystemDynamics
required: false
multivalued: false
description: Excitation system model associated with this synchronous machine
model.
CrossCompoundTurbineGovernorDynamics:
slot_uri: cim:SynchronousMachineDynamics.CrossCompoundTurbineGovernorDynamics
range: CrossCompoundTurbineGovernorDynamics
required: false
multivalued: false
description: The cross-compound turbine governor with which this low-pressure
synchronous machine is associated.
CrossCompoundTurbineGovernorDyanmics:
slot_uri: cim:SynchronousMachineDynamics.CrossCompoundTurbineGovernorDyanmics
range: CrossCompoundTurbineGovernorDynamics
required: false
multivalued: false
description: The cross-compound turbine governor with which this high-pressure
synchronous machine is associated.
MechanicalLoadDynamics:
slot_uri: cim:SynchronousMachineDynamics.MechanicalLoadDynamics
range: MechanicalLoadDynamics
required: false
multivalued: false
description: Mechanical load model associated with this synchronous machine
model.
RotatingMachineDynamics:
class_uri: cim:RotatingMachineDynamics
is_a: DynamicsFunctionBlock
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels
description: Abstract parent class for all synchronous and asynchronous machine
standard models.
attributes:
damping:
slot_uri: cim:RotatingMachineDynamics.damping
range: float
required: false
multivalued: false
description: Damping torque coefficient (D) (>= 0). A proportionality
constant that, when multiplied by the angular velocity of the rotor poles
with respect to the magnetic field (frequency), results in the damping torque. This
value is often zero when the sources of damping torques (generator damper
windings, load damping effects, etc.) are modelled in detail. Typical value
= 0.
inertia:
slot_uri: cim:RotatingMachineDynamics.inertia
range: Seconds
required: false
multivalued: false
description: Inertia constant of generator or motor and mechanical load (H)
(> 0). This is the specification for the stored energy in the rotating
mass when operating at rated speed. For a generator, this includes the
generator plus all other elements (turbine, exciter) on the same shaft and
has units of MW x s. For a motor, it includes the motor plus its mechanical
load. Conventional units are PU on the generator MVA base, usually expressed
as MW x s / MVA or just s. This value is used in the accelerating power
reference frame for operator training simulator solutions. Typical value
= 3.
saturationFactor:
slot_uri: cim:RotatingMachineDynamics.saturationFactor
range: float
required: false
multivalued: false
description: Saturation factor at rated terminal voltage (S1) (>=
0). Not used by simplified model. Defined by defined by S(E1)
in the SynchronousMachineSaturationParameters diagram. Typical value =
0,02.
saturationFactor120:
slot_uri: cim:RotatingMachineDynamics.saturationFactor120
range: float
required: false
multivalued: false
description: Saturation factor at 120% of rated terminal voltage (S12)
(>= RotatingMachineDynamics.saturationFactor). Not used by the simplified
model, defined by S(E2) in the SynchronousMachineSaturationParameters
diagram. Typical value = 0,12.
statorLeakageReactance:
slot_uri: cim:RotatingMachineDynamics.statorLeakageReactance
range: PU
required: false
multivalued: false
description: Stator leakage reactance (Xl) (>= 0). Typical value
= 0,15.
statorResistance:
slot_uri: cim:RotatingMachineDynamics.statorResistance
range: PU
required: false
multivalued: false
description: Stator (armature) resistance (Rs) (>= 0). Typical value
= 0,005.
DynamicsFunctionBlock:
class_uri: cim:DynamicsFunctionBlock
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels
description: Abstract parent class for all Dynamics function blocks.
attributes:
enabled:
slot_uri: cim:DynamicsFunctionBlock.enabled
range: boolean
required: false
multivalued: false
description: "Function block used indicator.\r\ntrue = use of function block\
\ is enabled\r\nfalse = use of function block is disabled."
GenICompensationForGenJ:
class_uri: cim:GenICompensationForGenJ
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.VoltageCompensatorDynamics
description: Resistive and reactive components of compensation for generator associated
with IEEE type 2 voltage compensator for current flow out of another generator
in the interconnection.
attributes:
rcij:
slot_uri: cim:GenICompensationForGenJ.rcij
range: PU
required: false
multivalued: false
description: Resistive component of compensation of
generator associated with this IEEE type 2 voltage compensator for current
flow out of another generator (Rcij).
xcij:
slot_uri: cim:GenICompensationForGenJ.xcij
range: PU
required: false
multivalued: false
description: Reactive component of compensation of generator
associated with this IEEE type 2 voltage compensator for current flow out
of another generator (Xcij).
VcompIEEEType2:
slot_uri: cim:GenICompensationForGenJ.VcompIEEEType2
range: VCompIEEEType2
required: true
multivalued: false
description: The standard IEEE type 2 voltage compensator of this compensation.
SynchronousMachineDynamics:
slot_uri: cim:GenICompensationForGenJ.SynchronousMachineDynamics
range: SynchronousMachineDynamics
required: true
multivalued: false
description: Standard synchronous machine out of which current flow is being
compensated for.
VCompIEEEType2:
class_uri: cim:VCompIEEEType2
is_a: VoltageCompensatorDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.VoltageCompensatorDynamics
description: "Terminal voltage transducer and load compensator\
\ as defined in IEEE 421.5-2005, 4. This model is designed to cover the following\
\ types of compensation: \r\n\r\n\t- reactive\
\ droop;
\r\n\t- transformer-drop or line-drop\
\ compensation;
\r\n\t- reactive differential\
\ compensation known also as cross-current compensation.
\r\n
\r\
\nReference: IEEE 421.5-2005, 4."
attributes:
tr:
slot_uri: cim:VCompIEEEType2.tr
range: Seconds
required: false
multivalued: false
description: Time constant which is used for the combined
voltage sensing and compensation signal (Tr) (>= 0).
GenICompensationForGenJ:
slot_uri: cim:VCompIEEEType2.GenICompensationForGenJ
range: GenICompensationForGenJ
required: true
multivalued: true
description: Compensation of this voltage compensator's generator for current
flow out of another generator.
VoltageCompensatorDynamics:
class_uri: cim:VoltageCompensatorDynamics
is_a: DynamicsFunctionBlock
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.VoltageCompensatorDynamics
description: Voltage compensator function block whose behaviour is described by
reference to a standard model or by definition of a user-defined
model.
attributes:
ExcitationSystemDynamics:
slot_uri: cim:VoltageCompensatorDynamics.ExcitationSystemDynamics
range: ExcitationSystemDynamics
required: true
multivalued: false
description: Excitation system model with which this voltage compensator is
associated.
RemoteInputSignal:
slot_uri: cim:VoltageCompensatorDynamics.RemoteInputSignal
range: RemoteInputSignal
required: false
multivalued: false
description: Remote input signal used by this voltage compensator model.
ExcitationSystemDynamics:
class_uri: cim:ExcitationSystemDynamics
is_a: DynamicsFunctionBlock
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: Excitation system function block whose behaviour is described by
reference to a standard model or by definition of a user-defined
model.
attributes:
SynchronousMachineDynamics:
slot_uri: cim:ExcitationSystemDynamics.SynchronousMachineDynamics
range: SynchronousMachineDynamics
required: true
multivalued: false
description: Synchronous machine model with which this excitation system model
is associated.
PowerSystemStabilizerDynamics:
slot_uri: cim:ExcitationSystemDynamics.PowerSystemStabilizerDynamics
range: PowerSystemStabilizerDynamics
required: false
multivalued: false
description: Power system stabilizer model associated with this excitation
system model.
PFVArControllerType1Dynamics:
slot_uri: cim:ExcitationSystemDynamics.PFVArControllerType1Dynamics
range: PFVArControllerType1Dynamics
required: false
multivalued: false
description: Power factor or VAr controller type 1 model associated with this
excitation system model.
OverexcitationLimiterDynamics:
slot_uri: cim:ExcitationSystemDynamics.OverexcitationLimiterDynamics
range: OverexcitationLimiterDynamics
required: false
multivalued: false
description: Overexcitation limiter model associated with this excitation
system model.
DiscontinuousExcitationControlDynamics:
slot_uri: cim:ExcitationSystemDynamics.DiscontinuousExcitationControlDynamics
range: DiscontinuousExcitationControlDynamics
required: false
multivalued: false
description: Discontinuous excitation control model associated with this excitation
system model.
PFVArControllerType2Dynamics:
slot_uri: cim:ExcitationSystemDynamics.PFVArControllerType2Dynamics
range: PFVArControllerType2Dynamics
required: false
multivalued: false
description: Power factor or VAr controller type 2 model associated with this
excitation system model.
UnderexcitationLimiterDynamics:
slot_uri: cim:ExcitationSystemDynamics.UnderexcitationLimiterDynamics
range: UnderexcitationLimiterDynamics
required: false
multivalued: false
description: Undrexcitation limiter model associated with this excitation
system model.
VoltageCompensatorDynamics:
slot_uri: cim:ExcitationSystemDynamics.VoltageCompensatorDynamics
range: VoltageCompensatorDynamics
required: true
multivalued: false
description: Voltage compensator model associated with this excitation system
model.
PowerSystemStabilizerDynamics:
class_uri: cim:PowerSystemStabilizerDynamics
is_a: DynamicsFunctionBlock
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.PowerSystemStabilizerDynamics
description: Power system stabilizer function block whose behaviour is described
by reference to a standard model or by definition of a
user-defined model.
attributes:
ExcitationSystemDynamics:
slot_uri: cim:PowerSystemStabilizerDynamics.ExcitationSystemDynamics
range: ExcitationSystemDynamics
required: true
multivalued: false
description: Excitation system model with which this power system stabilizer
model is associated.
RemoteInputSignal:
slot_uri: cim:PowerSystemStabilizerDynamics.RemoteInputSignal
range: RemoteInputSignal
required: false
multivalued: true
description: Remote input signal used by this power system stabilizer model.
RemoteInputSignal:
class_uri: cim:RemoteInputSignal
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardInterconnections
description: Supports connection to a terminal associated with a remote bus from
which an input signal of a specific type is coming.
attributes:
remoteSignalType:
slot_uri: cim:RemoteInputSignal.remoteSignalType
range: RemoteSignalKind
required: false
multivalued: false
description: Type of input signal.
Terminal:
slot_uri: cim:RemoteInputSignal.Terminal
range: Terminal
required: true
multivalued: false
description: Remote terminal with which this input signal is associated.
VoltageCompensatorDynamics:
slot_uri: cim:RemoteInputSignal.VoltageCompensatorDynamics
range: VoltageCompensatorDynamics
required: false
multivalued: false
description: Voltage compensator model using this remote input signal.
WindPlantDynamics:
slot_uri: cim:RemoteInputSignal.WindPlantDynamics
range: WindPlantDynamics
required: false
multivalued: false
description: The wind plant using the remote signal.
UnderexcitationLimiterDynamics:
slot_uri: cim:RemoteInputSignal.UnderexcitationLimiterDynamics
range: UnderexcitationLimiterDynamics
required: false
multivalued: false
description: Underexcitation limiter model using this remote input signal.
DiscontinuousExcitationControlDynamics:
slot_uri: cim:RemoteInputSignal.DiscontinuousExcitationControlDynamics
range: DiscontinuousExcitationControlDynamics
required: false
multivalued: false
description: Discontinuous excitation control model using this remote input
signal.
WindTurbineType1or2Dynamics:
slot_uri: cim:RemoteInputSignal.WindTurbineType1or2Dynamics
range: WindTurbineType1or2Dynamics
required: false
multivalued: false
description: Wind generator type 1 or type 2 model using this remote input
signal.
WindTurbineType3or4Dynamics:
slot_uri: cim:RemoteInputSignal.WindTurbineType3or4Dynamics
range: WindTurbineType3or4Dynamics
required: false
multivalued: false
description: Wind turbine type 3 or type 4 models using this remote input
signal.
PowerSystemStabilizerDynamics:
slot_uri: cim:RemoteInputSignal.PowerSystemStabilizerDynamics
range: PowerSystemStabilizerDynamics
required: false
multivalued: false
description: Power system stabilizer model using this remote input signal.
PFVArControllerType1Dynamics:
slot_uri: cim:RemoteInputSignal.PFVArControllerType1Dynamics
range: PFVArControllerType1Dynamics
required: false
multivalued: false
description: Power factor or VAr controller type 1 model using this remote
input signal.
WindPlantDynamics:
class_uri: cim:WindPlantDynamics
is_a: DynamicsFunctionBlock
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.WindDynamics
description: Parent class supporting relationships to wind turbines type 3 and
type 4 and wind plant IEC and user-defined wind plants including their control
models.
attributes:
WindTurbineType3or4Dynamics:
slot_uri: cim:WindPlantDynamics.WindTurbineType3or4Dynamics
range: WindTurbineType3or4Dynamics
required: true
multivalued: true
description: The wind turbine type 3 or type 4 associated with this wind plant.
RemoteInputSignal:
slot_uri: cim:WindPlantDynamics.RemoteInputSignal
range: RemoteInputSignal
required: false
multivalued: false
description: The remote signal with which this power plant is associated.
WindTurbineType3or4Dynamics:
class_uri: cim:WindTurbineType3or4Dynamics
is_a: DynamicsFunctionBlock
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.WindDynamics
description: Parent class supporting relationships to wind turbines type 3 and
type 4 and wind plant including their control models.
attributes:
PowerElectronicsConnection:
slot_uri: cim:WindTurbineType3or4Dynamics.PowerElectronicsConnection
range: PowerElectronicsConnection
required: true
multivalued: false
description: The power electronics connection associated with this wind turbine
type 3 or type 4 dynamics model.
RemoteInputSignal:
slot_uri: cim:WindTurbineType3or4Dynamics.RemoteInputSignal
range: RemoteInputSignal
required: false
multivalued: false
description: Remote input signal used by these wind turbine type 3 or type
4 models.
WindPlantDynamics:
slot_uri: cim:WindTurbineType3or4Dynamics.WindPlantDynamics
range: WindPlantDynamics
required: false
multivalued: false
description: The wind plant with which the wind turbines type 3 or type 4
are associated.
PowerElectronicsConnection:
class_uri: cim:PowerElectronicsConnection
is_a: RegulatingCondEq
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: A connection to the AC network for energy production or consumption
that uses power electronics rather than rotating machines.
attributes:
maxIFault:
slot_uri: cim:PowerElectronicsConnection.maxIFault
range: PU
required: false
multivalued: false
description: Maximum fault current this device will contribute, in per-unit
of rated current, before the converter protection will trip or bypass.
maxQ:
slot_uri: cim:PowerElectronicsConnection.maxQ
range: ReactivePower
required: false
multivalued: false
description: Maximum reactive power limit. This is the maximum (nameplate)
limit for the unit.
minQ:
slot_uri: cim:PowerElectronicsConnection.minQ
range: ReactivePower
required: false
multivalued: false
description: Minimum reactive power limit for the unit. This is the minimum
(nameplate) limit for the unit.
p:
slot_uri: cim:PowerElectronicsConnection.p
range: ActivePower
required: false
multivalued: false
description: "Active power injection. Load sign convention is used, i.e. positive\
\ sign means flow out from a node.\r\nStarting value for a steady state\
\ solution."
q:
slot_uri: cim:PowerElectronicsConnection.q
range: ReactivePower
required: false
multivalued: false
description: "Reactive power injection. Load sign convention is used, i.e.\
\ positive sign means flow out from a node.\r\nStarting value for a steady\
\ state solution."
r:
slot_uri: cim:PowerElectronicsConnection.r
range: Resistance
required: false
multivalued: false
description: 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.
r0:
slot_uri: cim:PowerElectronicsConnection.r0
range: Resistance
required: false
multivalued: false
description: Zero sequence resistance of the synchronous machine.
ratedS:
slot_uri: cim:PowerElectronicsConnection.ratedS
range: ApparentPower
required: false
multivalued: false
description: "Nameplate apparent power rating for the unit.\r\nThe attribute\
\ shall have a positive value."
ratedU:
slot_uri: cim:PowerElectronicsConnection.ratedU
range: Voltage
required: false
multivalued: false
description: "Rated voltage (nameplate data, Ur in IEC 60909-0). It is primarily\
\ used for short circuit data exchange according to IEC 60909.\r\nThe attribute\
\ shall be a positive value."
rn:
slot_uri: cim:PowerElectronicsConnection.rn
range: Resistance
required: false
multivalued: false
description: Negative sequence Thevenin resistance.
x:
slot_uri: cim:PowerElectronicsConnection.x
range: Reactance
required: false
multivalued: false
description: Positive sequence Thevenin reactance.
x0:
slot_uri: cim:PowerElectronicsConnection.x0
range: Reactance
required: false
multivalued: false
description: Zero sequence Thevenin reactance.
xn:
slot_uri: cim:PowerElectronicsConnection.xn
range: Reactance
required: false
multivalued: false
description: Negative sequence Thevenin reactance.
PowerElectronicsUnit:
slot_uri: cim:PowerElectronicsConnection.PowerElectronicsUnit
range: PowerElectronicsUnit
required: false
multivalued: true
description: An AC network connection may have several power electronics units
connecting through it.
PowerElectronicsConnectionPhase:
slot_uri: cim:PowerElectronicsConnection.PowerElectronicsConnectionPhase
range: PowerElectronicsConnectionPhase
required: false
multivalued: true
description: The individual phases models for the power electronics connection.
WindTurbineType3or4Dynamics:
slot_uri: cim:PowerElectronicsConnection.WindTurbineType3or4Dynamics
range: WindTurbineType3or4Dynamics
required: false
multivalued: false
description: The wind turbine type 3 or type 4 dynamics model associated with
this power electronics connection.
PowerElectronicsUnit:
class_uri: cim:PowerElectronicsUnit
is_a: Equipment
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.Production
description: A generating unit or battery or aggregation that connects to the
AC network using power electronics rather than rotating machines.
attributes:
maxP:
slot_uri: cim:PowerElectronicsUnit.maxP
range: ActivePower
required: false
multivalued: false
description: Maximum active power limit. This is the maximum (nameplate) limit
for the unit.
minP:
slot_uri: cim:PowerElectronicsUnit.minP
range: ActivePower
required: false
multivalued: false
description: Minimum active power limit. This is the minimum (nameplate) limit
for the unit.
PowerElectronicsConnection:
slot_uri: cim:PowerElectronicsUnit.PowerElectronicsConnection
range: PowerElectronicsConnection
required: true
multivalued: false
description: A power electronics unit has a connection to the AC network.
PowerElectronicsConnectionPhase:
class_uri: cim:PowerElectronicsConnectionPhase
is_a: PowerSystemResource
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: A single phase of a power electronics connection.
attributes:
p:
slot_uri: cim:PowerElectronicsConnectionPhase.p
range: ActivePower
required: false
multivalued: false
description: Active power injection. Load sign convention is used, i.e. positive
sign means flow into the equipment from the network.
phase:
slot_uri: cim:PowerElectronicsConnectionPhase.phase
range: SinglePhaseKind
required: false
multivalued: false
description: 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.
q:
slot_uri: cim:PowerElectronicsConnectionPhase.q
range: ReactivePower
required: false
multivalued: false
description: Reactive power injection. Load sign convention is used, i.e.
positive sign means flow into the equipment from the network.
PowerElectronicsConnection:
slot_uri: cim:PowerElectronicsConnectionPhase.PowerElectronicsConnection
range: PowerElectronicsConnection
required: true
multivalued: false
description: Power electronics connection of this power electronics connection
phase.
UnderexcitationLimiterDynamics:
class_uri: cim:UnderexcitationLimiterDynamics
is_a: DynamicsFunctionBlock
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.UnderexcitationLimiterDynamics
description: Underexcitation limiter function block whose behaviour is described
by reference to a standard model or by definition of a
user-defined model.
attributes:
ExcitationSystemDynamics:
slot_uri: cim:UnderexcitationLimiterDynamics.ExcitationSystemDynamics
range: ExcitationSystemDynamics
required: true
multivalued: false
description: Excitation system model with which this underexcitation limiter
model is associated.
RemoteInputSignal:
slot_uri: cim:UnderexcitationLimiterDynamics.RemoteInputSignal
range: RemoteInputSignal
required: false
multivalued: false
description: Remote input signal used by this underexcitation limiter model.
DiscontinuousExcitationControlDynamics:
class_uri: cim:DiscontinuousExcitationControlDynamics
is_a: DynamicsFunctionBlock
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.DiscontinuousExcitationControlDynamics
description: Discontinuous excitation control function block whose behaviour is
described by reference to a standard model or by definition
of a user-defined model.
attributes:
ExcitationSystemDynamics:
slot_uri: cim:DiscontinuousExcitationControlDynamics.ExcitationSystemDynamics
range: ExcitationSystemDynamics
required: true
multivalued: false
description: Excitation system model with which this discontinuous excitation
control model is associated.
RemoteInputSignal:
slot_uri: cim:DiscontinuousExcitationControlDynamics.RemoteInputSignal
range: RemoteInputSignal
required: false
multivalued: false
description: Remote input signal used by this discontinuous excitation control
system model.
WindTurbineType1or2Dynamics:
class_uri: cim:WindTurbineType1or2Dynamics
is_a: DynamicsFunctionBlock
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.WindDynamics
description: "Parent class supporting relationships to wind turbines type 1 and\
\ type 2 and their control models. Generator model for wind turbine of type\
\ 1 or type 2 is a standard asynchronous generator model.\r\n"
attributes:
AsynchronousMachineDynamics:
slot_uri: cim:WindTurbineType1or2Dynamics.AsynchronousMachineDynamics
range: AsynchronousMachineDynamics
required: true
multivalued: false
description: Asynchronous machine model with which this wind generator type
1 or type 2 model is associated.
RemoteInputSignal:
slot_uri: cim:WindTurbineType1or2Dynamics.RemoteInputSignal
range: RemoteInputSignal
required: false
multivalued: false
description: Remote input signal used by this wind generator type 1 or type
2 model.
AsynchronousMachineDynamics:
class_uri: cim:AsynchronousMachineDynamics
is_a: RotatingMachineDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.AsynchronousMachineDynamics
description: "Asynchronous machine whose behaviour is described by reference to\
\ a standard model expressed in either time constant reactance form or equivalent\
\ circuit form or by definition of a user-defined model.\r\
\nParameter details:\r\n\r\n\t- Asynchronous machine parameters such as\
\ Xl, Xs, etc. are actually used as inductances in the model, but are\
\ commonly referred to as reactances since, at nominal frequency, the PU values\
\ are the same. However, some references use the symbol L instead of\
\ X.
\r\n
"
attributes:
AsynchronousMachine:
slot_uri: cim:AsynchronousMachineDynamics.AsynchronousMachine
range: AsynchronousMachine
required: true
multivalued: false
description: Asynchronous machine to which this asynchronous machine dynamics
model applies.
TurbineGovernorDynamics:
slot_uri: cim:AsynchronousMachineDynamics.TurbineGovernorDynamics
range: TurbineGovernorDynamics
required: false
multivalued: false
description: Turbine-governor model associated with this asynchronous machine
model.
MechanicalLoadDynamics:
slot_uri: cim:AsynchronousMachineDynamics.MechanicalLoadDynamics
range: MechanicalLoadDynamics
required: false
multivalued: false
description: Mechanical load model associated with this asynchronous machine
model.
WindTurbineType1or2Dynamics:
slot_uri: cim:AsynchronousMachineDynamics.WindTurbineType1or2Dynamics
range: WindTurbineType1or2Dynamics
required: false
multivalued: false
description: Wind generator type 1 or type 2 model associated with this asynchronous
machine model.
TurbineGovernorDynamics:
class_uri: cim:TurbineGovernorDynamics
is_a: DynamicsFunctionBlock
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.TurbineGovernorDynamics
description: Turbine-governor function block whose behaviour is described by reference
to a standard model or by definition of a user-defined
model.
attributes:
AsynchronousMachineDynamics:
slot_uri: cim:TurbineGovernorDynamics.AsynchronousMachineDynamics
range: AsynchronousMachineDynamics
required: false
multivalued: false
description: Asynchronous machine model with which this turbine-governor model
is associated. TurbineGovernorDynamics shall have either an association
to SynchronousMachineDynamics or to AsynchronousMachineDynamics.
TurbineLoadControllerDynamics:
slot_uri: cim:TurbineGovernorDynamics.TurbineLoadControllerDynamics
range: TurbineLoadControllerDynamics
required: false
multivalued: false
description: Turbine load controller providing input to this turbine-governor.
SynchronousMachineDynamics:
slot_uri: cim:TurbineGovernorDynamics.SynchronousMachineDynamics
range: SynchronousMachineDynamics
required: false
multivalued: false
description: Synchronous machine model with which this turbine-governor model
is associated. TurbineGovernorDynamics shall have either an association
to SynchronousMachineDynamics or to AsynchronousMachineDynamics.
TurbineLoadControllerDynamics:
class_uri: cim:TurbineLoadControllerDynamics
is_a: DynamicsFunctionBlock
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.TurbineLoadControllerDynamics
description: Turbine load controller function block whose behaviour is described
by reference to a standard model or by definition of a
user-defined model.
attributes:
TurbineGovernorDynamics:
slot_uri: cim:TurbineLoadControllerDynamics.TurbineGovernorDynamics
range: TurbineGovernorDynamics
required: true
multivalued: false
description: Turbine-governor controlled by this turbine load controller.
MechanicalLoadDynamics:
class_uri: cim:MechanicalLoadDynamics
is_a: DynamicsFunctionBlock
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.MechanicalLoadDynamics
description: Mechanical load function block whose behaviour is described by reference
to a standard model or by definition of a user-defined
model.
attributes:
AsynchronousMachineDynamics:
slot_uri: cim:MechanicalLoadDynamics.AsynchronousMachineDynamics
range: AsynchronousMachineDynamics
required: false
multivalued: false
description: Asynchronous machine model with which this mechanical load model
is associated. MechanicalLoadDynamics shall have either an association to
SynchronousMachineDynamics or to AsynchronousMachineDynamics.
SynchronousMachineDynamics:
slot_uri: cim:MechanicalLoadDynamics.SynchronousMachineDynamics
range: SynchronousMachineDynamics
required: false
multivalued: false
description: Synchronous machine model with which this mechanical load model
is associated. MechanicalLoadDynamics shall have either an association to
SynchronousMachineDynamics or AsynchronousMachineDyanmics.
AsynchronousMachine:
class_uri: cim:AsynchronousMachine
is_a: RotatingMachine
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: 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.
attributes:
asynchronousMachineType:
slot_uri: cim:AsynchronousMachine.asynchronousMachineType
range: AsynchronousMachineKind
required: false
multivalued: false
description: Indicates the type of Asynchronous Machine (motor or generator).
converterFedDrive:
slot_uri: cim:AsynchronousMachine.converterFedDrive
range: boolean
required: false
multivalued: false
description: Indicates whether the machine is a converter fed drive. Used
for short circuit data exchange according to IEC 60909.
efficiency:
slot_uri: cim:AsynchronousMachine.efficiency
range: PerCent
required: false
multivalued: false
description: 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.
iaIrRatio:
slot_uri: cim:AsynchronousMachine.iaIrRatio
range: float
required: false
multivalued: false
description: Ratio of locked-rotor current to the rated current of the motor
(Ia/Ir). Used for short circuit data exchange according to IEC 60909.
nominalFrequency:
slot_uri: cim:AsynchronousMachine.nominalFrequency
range: Frequency
required: false
multivalued: false
description: Nameplate data indicates if the machine is 50 Hz or 60 Hz.
nominalSpeed:
slot_uri: cim:AsynchronousMachine.nominalSpeed
range: RotationSpeed
required: false
multivalued: false
description: Nameplate data. Depends on the slip and number of pole pairs.
polePairNumber:
slot_uri: cim:AsynchronousMachine.polePairNumber
range: integer
required: false
multivalued: false
description: Number of pole pairs of stator. Used for short circuit data exchange
according to IEC 60909.
ratedMechanicalPower:
slot_uri: cim:AsynchronousMachine.ratedMechanicalPower
range: ActivePower
required: false
multivalued: false
description: Rated mechanical power (Pr in IEC 60909-0). Used for short circuit
data exchange according to IEC 60909.
reversible:
slot_uri: cim:AsynchronousMachine.reversible
range: boolean
required: false
multivalued: false
description: Indicates for converter drive motors if the power can be reversible.
Used for short circuit data exchange according to IEC 60909.
rr1:
slot_uri: cim:AsynchronousMachine.rr1
range: Resistance
required: false
multivalued: false
description: "Damper 1 winding resistance.\r\n"
rr2:
slot_uri: cim:AsynchronousMachine.rr2
range: Resistance
required: false
multivalued: false
description: "Damper 2 winding resistance.\r\n"
rxLockedRotorRatio:
slot_uri: cim:AsynchronousMachine.rxLockedRotorRatio
range: float
required: false
multivalued: false
description: Locked rotor ratio (R/X). Used for short circuit data exchange
according to IEC 60909.
tpo:
slot_uri: cim:AsynchronousMachine.tpo
range: Seconds
required: false
multivalued: false
description: Transient rotor time constant (greater than tppo).
tppo:
slot_uri: cim:AsynchronousMachine.tppo
range: Seconds
required: false
multivalued: false
description: "Sub-transient rotor time constant (greater than 0).\r\n"
xlr1:
slot_uri: cim:AsynchronousMachine.xlr1
range: Reactance
required: false
multivalued: false
description: "Damper 1 winding leakage reactance.\r\n"
xlr2:
slot_uri: cim:AsynchronousMachine.xlr2
range: Reactance
required: false
multivalued: false
description: "Damper 2 winding leakage reactance.\r\n"
xm:
slot_uri: cim:AsynchronousMachine.xm
range: Reactance
required: false
multivalued: false
description: "Magnetizing reactance.\r\n"
xp:
slot_uri: cim:AsynchronousMachine.xp
range: Reactance
required: false
multivalued: false
description: "Transient reactance (unsaturated) (greater than or equal to\
\ xpp).\r\n"
xpp:
slot_uri: cim:AsynchronousMachine.xpp
range: Reactance
required: false
multivalued: false
description: Sub-transient reactance (unsaturated).
xs:
slot_uri: cim:AsynchronousMachine.xs
range: Reactance
required: false
multivalued: false
description: Synchronous reactance (greater than xp).
AsynchronousMachineDynamics:
slot_uri: cim:AsynchronousMachine.AsynchronousMachineDynamics
range: AsynchronousMachineDynamics
required: false
multivalued: false
description: Asynchronous machine dynamics model used to describe dynamic
behaviour of this asynchronous machine.
PFVArControllerType1Dynamics:
class_uri: cim:PFVArControllerType1Dynamics
is_a: DynamicsFunctionBlock
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.PFVArControllerType1Dynamics
description: Power factor or VAr controller type 1 function block whose behaviour
is described by reference to a standard model or by definition
of a user-defined model.
attributes:
ExcitationSystemDynamics:
slot_uri: cim:PFVArControllerType1Dynamics.ExcitationSystemDynamics
range: ExcitationSystemDynamics
required: true
multivalued: false
description: Excitation system model with which this power actor or VAr controller
type 1 model is associated.
RemoteInputSignal:
slot_uri: cim:PFVArControllerType1Dynamics.RemoteInputSignal
range: RemoteInputSignal
required: false
multivalued: false
description: Remote input signal used by this power factor or VAr controller
type 1 model.
VoltageAdjusterDynamics:
slot_uri: cim:PFVArControllerType1Dynamics.VoltageAdjusterDynamics
range: VoltageAdjusterDynamics
required: false
multivalued: false
description: Voltage adjuster model associated with this power factor or VAr
controller type 1 model.
VoltageAdjusterDynamics:
class_uri: cim:VoltageAdjusterDynamics
is_a: DynamicsFunctionBlock
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.VoltageAdjusterDynamics
description: Voltage adjuster function block whose behaviour is described by reference
to a standard model or by definition of a user-defined
model.
attributes:
PFVArControllerType1Dynamics:
slot_uri: cim:VoltageAdjusterDynamics.PFVArControllerType1Dynamics
range: PFVArControllerType1Dynamics
required: true
multivalued: false
description: Power factor or VAr controller type 1 model with which this voltage
adjuster is associated.
OverexcitationLimiterDynamics:
class_uri: cim:OverexcitationLimiterDynamics
is_a: DynamicsFunctionBlock
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.OverexcitationLimiterDynamics
description: Overexcitation limiter function block whose behaviour is described
by reference to a standard model or by definition of a
user-defined model.
attributes:
ExcitationSystemDynamics:
slot_uri: cim:OverexcitationLimiterDynamics.ExcitationSystemDynamics
range: ExcitationSystemDynamics
required: true
multivalued: false
description: Excitation system model with which this overexcitation limiter
model is associated.
PFVArControllerType2Dynamics:
class_uri: cim:PFVArControllerType2Dynamics
is_a: DynamicsFunctionBlock
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.PFVArControllerType2Dynamics
description: Power factor or VAr controller type 2 function block whose behaviour
is described by reference to a standard model or by definition
of a user-defined model.
attributes:
ExcitationSystemDynamics:
slot_uri: cim:PFVArControllerType2Dynamics.ExcitationSystemDynamics
range: ExcitationSystemDynamics
required: true
multivalued: false
description: Excitation system model with which this power factor or VAr controller
type 2 is associated.
CrossCompoundTurbineGovernorDynamics:
class_uri: cim:CrossCompoundTurbineGovernorDynamics
is_a: DynamicsFunctionBlock
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.TurbineGovernorDynamics
description: Turbine-governor cross-compound function block whose behaviour is
described by reference to a standard model or by definition
of a user-defined model.
attributes:
LowPressureSynchronousMachineDynamics:
slot_uri: cim:CrossCompoundTurbineGovernorDynamics.LowPressureSynchronousMachineDynamics
range: SynchronousMachineDynamics
required: true
multivalued: false
description: 'Low-pressure synchronous machine with which this cross-compound
turbine governor is associated. '
HighPressureSynchronousMachineDynamics:
slot_uri: cim:CrossCompoundTurbineGovernorDynamics.HighPressureSynchronousMachineDynamics
range: SynchronousMachineDynamics
required: true
multivalued: false
description: 'High-pressure synchronous machine with which this cross-compound
turbine governor is associated. '
HeatRecoveryBoiler:
class_uri: cim:HeatRecoveryBoiler
is_a: FossilSteamSupply
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.GenerationTrainingSimulation
description: "The heat recovery system associated with combustion turbines in\
\ order to produce steam for combined cycle plants.\r\n"
attributes:
steamSupplyRating2:
slot_uri: cim:HeatRecoveryBoiler.steamSupplyRating2
range: float
required: false
multivalued: false
description: "The steam supply rating in kilopounds per hour, if dual pressure\
\ boiler.\r\n"
CombustionTurbines:
slot_uri: cim:HeatRecoveryBoiler.CombustionTurbines
range: CombustionTurbine
required: false
multivalued: true
description: A combustion turbine may have a heat recovery boiler for making
steam.
FossilSteamSupply:
class_uri: cim:FossilSteamSupply
is_a: SteamSupply
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.GenerationTrainingSimulation
description: Fossil fuelled boiler (e.g., coal, oil, gas).
attributes:
auxPowerVersusFrequency:
slot_uri: cim:FossilSteamSupply.auxPowerVersusFrequency
range: PU
required: false
multivalued: false
description: Off nominal frequency effect on auxiliary real power. Per unit
active power variation versus per unit frequency variation.
auxPowerVersusVoltage:
slot_uri: cim:FossilSteamSupply.auxPowerVersusVoltage
range: PU
required: false
multivalued: false
description: Off nominal voltage effect on auxiliary real power. Per unit
active power variation versus per unit voltage variation.
boilerControlMode:
slot_uri: cim:FossilSteamSupply.boilerControlMode
range: BoilerControlMode
required: false
multivalued: false
description: "The control mode of the boiler.\r\n"
controlErrorBiasP:
slot_uri: cim:FossilSteamSupply.controlErrorBiasP
range: float
required: false
multivalued: false
description: "Active power error bias ratio.\r\n"
controlIC:
slot_uri: cim:FossilSteamSupply.controlIC
range: float
required: false
multivalued: false
description: "Integral constant.\r\n"
controlPC:
slot_uri: cim:FossilSteamSupply.controlPC
range: float
required: false
multivalued: false
description: "Proportional constant.\r\n"
controlPEB:
slot_uri: cim:FossilSteamSupply.controlPEB
range: float
required: false
multivalued: false
description: "Pressure error bias ratio.\r\n"
controlPED:
slot_uri: cim:FossilSteamSupply.controlPED
range: PU
required: false
multivalued: false
description: "Pressure error deadband.\r\n"
controlTC:
slot_uri: cim:FossilSteamSupply.controlTC
range: float
required: false
multivalued: false
description: "Time constant.\r\n"
feedWaterIG:
slot_uri: cim:FossilSteamSupply.feedWaterIG
range: float
required: false
multivalued: false
description: "Feedwater integral gain ratio.\r\n"
feedWaterPG:
slot_uri: cim:FossilSteamSupply.feedWaterPG
range: float
required: false
multivalued: false
description: "Feedwater proportional gain ratio.\r\n"
feedWaterTC:
slot_uri: cim:FossilSteamSupply.feedWaterTC
range: Seconds
required: false
multivalued: false
description: Feedwater time constant ratio.
fuelDemandLimit:
slot_uri: cim:FossilSteamSupply.fuelDemandLimit
range: PU
required: false
multivalued: false
description: "Fuel demand limit.\r\n"
fuelSupplyDelay:
slot_uri: cim:FossilSteamSupply.fuelSupplyDelay
range: Seconds
required: false
multivalued: false
description: "Fuel delay.\r\n"
fuelSupplyTC:
slot_uri: cim:FossilSteamSupply.fuelSupplyTC
range: Seconds
required: false
multivalued: false
description: "Fuel supply time constant.\r\n"
maxErrorRateP:
slot_uri: cim:FossilSteamSupply.maxErrorRateP
range: float
required: false
multivalued: false
description: "Active power maximum error rate limit.\r\n"
mechPowerSensorLag:
slot_uri: cim:FossilSteamSupply.mechPowerSensorLag
range: Seconds
required: false
multivalued: false
description: "Mechanical power sensor lag.\r\n"
minErrorRateP:
slot_uri: cim:FossilSteamSupply.minErrorRateP
range: float
required: false
multivalued: false
description: "Active power minimum error rate limit.\r\n"
pressureCtrlDG:
slot_uri: cim:FossilSteamSupply.pressureCtrlDG
range: float
required: false
multivalued: false
description: "Pressure control derivative gain ratio.\r\n"
pressureCtrlIG:
slot_uri: cim:FossilSteamSupply.pressureCtrlIG
range: float
required: false
multivalued: false
description: "Pressure control integral gain ratio.\r\n"
pressureCtrlPG:
slot_uri: cim:FossilSteamSupply.pressureCtrlPG
range: float
required: false
multivalued: false
description: "Pressure control proportional gain ratio.\r\n"
pressureFeedback:
slot_uri: cim:FossilSteamSupply.pressureFeedback
range: integer
required: false
multivalued: false
description: "Pressure feedback indicator.\r\n"
superHeater1Capacity:
slot_uri: cim:FossilSteamSupply.superHeater1Capacity
range: float
required: false
multivalued: false
description: "Drum/primary superheater capacity.\r\n"
superHeater2Capacity:
slot_uri: cim:FossilSteamSupply.superHeater2Capacity
range: float
required: false
multivalued: false
description: "Secondary superheater capacity.\r\n"
superHeaterPipePD:
slot_uri: cim:FossilSteamSupply.superHeaterPipePD
range: float
required: false
multivalued: false
description: "Superheater pipe pressure drop constant.\r\n"
throttlePressureSP:
slot_uri: cim:FossilSteamSupply.throttlePressureSP
range: PU
required: false
multivalued: false
description: "Throttle pressure setpoint.\r\n"
SteamSupply:
class_uri: cim:SteamSupply
is_a: PowerSystemResource
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.GenerationTrainingSimulation
description: "Steam supply for steam turbine.\r\n"
attributes:
steamSupplyRating:
slot_uri: cim:SteamSupply.steamSupplyRating
range: float
required: false
multivalued: false
description: "Rating of steam supply.\r\n"
SteamTurbines:
slot_uri: cim:SteamSupply.SteamTurbines
range: SteamTurbine
required: false
multivalued: true
description: Steam turbines may have steam supplied by a steam supply.
SteamTurbine:
class_uri: cim:SteamTurbine
is_a: PrimeMover
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.GenerationTrainingSimulation
description: "Steam turbine.\r\n"
attributes:
crossoverTC:
slot_uri: cim:SteamTurbine.crossoverTC
range: Seconds
required: false
multivalued: false
description: "Crossover time constant.\r\n"
reheater1TC:
slot_uri: cim:SteamTurbine.reheater1TC
range: Seconds
required: false
multivalued: false
description: "First reheater time constant.\r\n"
reheater2TC:
slot_uri: cim:SteamTurbine.reheater2TC
range: Seconds
required: false
multivalued: false
description: "Second reheater time constant.\r\n"
shaft1PowerHP:
slot_uri: cim:SteamTurbine.shaft1PowerHP
range: float
required: false
multivalued: false
description: "Fraction of power from shaft 1 high pressure turbine output.\r\
\n"
shaft1PowerIP:
slot_uri: cim:SteamTurbine.shaft1PowerIP
range: float
required: false
multivalued: false
description: "Fraction of power from shaft 1 intermediate pressure turbine\
\ output.\r\n"
shaft1PowerLP1:
slot_uri: cim:SteamTurbine.shaft1PowerLP1
range: float
required: false
multivalued: false
description: "Fraction of power from shaft 1 first low pressure turbine output.\r\
\n"
shaft1PowerLP2:
slot_uri: cim:SteamTurbine.shaft1PowerLP2
range: float
required: false
multivalued: false
description: "Fraction of power from shaft 1 second low pressure turbine output.\r\
\n"
shaft2PowerHP:
slot_uri: cim:SteamTurbine.shaft2PowerHP
range: float
required: false
multivalued: false
description: "Fraction of power from shaft 2 high pressure turbine output.\r\
\n"
shaft2PowerIP:
slot_uri: cim:SteamTurbine.shaft2PowerIP
range: float
required: false
multivalued: false
description: "Fraction of power from shaft 2 intermediate pressure turbine\
\ output.\r\n"
shaft2PowerLP1:
slot_uri: cim:SteamTurbine.shaft2PowerLP1
range: float
required: false
multivalued: false
description: "Fraction of power from shaft 2 first low pressure turbine output.\r\
\n"
shaft2PowerLP2:
slot_uri: cim:SteamTurbine.shaft2PowerLP2
range: float
required: false
multivalued: false
description: "Fraction of power from shaft 2 second low pressure turbine output.\r\
\n"
steamChestTC:
slot_uri: cim:SteamTurbine.steamChestTC
range: Seconds
required: false
multivalued: false
description: "Steam chest time constant.\r\n"
SteamSupplys:
slot_uri: cim:SteamTurbine.SteamSupplys
range: SteamSupply
required: false
multivalued: true
description: Steam turbines may have steam supplied by a steam supply.
CTTempActivePowerCurve:
class_uri: cim:CTTempActivePowerCurve
is_a: Curve
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.GenerationTrainingSimulation
description: "Relationship between the combustion turbine's power output rating\
\ in gross active power (X-axis) and the ambient air temperature (Y-axis).\r\
\n"
attributes:
CombustionTurbine:
slot_uri: cim:CTTempActivePowerCurve.CombustionTurbine
range: CombustionTurbine
required: true
multivalued: false
description: A combustion turbine may have an active power versus ambient
temperature relationship.
CombinedCyclePlant:
class_uri: cim:CombinedCyclePlant
is_a: PowerSystemResource
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.Production
description: "A set of combustion turbines and steam turbines where the exhaust\
\ heat from the combustion turbines is recovered to make steam for the steam\
\ turbines, resulting in greater overall plant efficiency.\r\n"
attributes:
combCyclePlantRating:
slot_uri: cim:CombinedCyclePlant.combCyclePlantRating
range: ActivePower
required: false
multivalued: false
description: "The combined cycle plant's active power output rating.\r\n"
ThermalGeneratingUnits:
slot_uri: cim:CombinedCyclePlant.ThermalGeneratingUnits
range: ThermalGeneratingUnit
required: false
multivalued: true
description: A thermal generating unit may be a member of a combined cycle
plant.
EmissionAccount:
class_uri: cim:EmissionAccount
is_a: Curve
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.Production
description: "Accounts for tracking emissions usage and credits for thermal generating\
\ units. A unit may have zero or more emission accounts, and will typically\
\ have one for tracking usage and one for tracking credits.\r\n"
attributes:
emissionType:
slot_uri: cim:EmissionAccount.emissionType
range: EmissionType
required: false
multivalued: false
description: The type of emission, for example sulfur dioxide (SO2). The y1AxisUnits
of the curve contains the unit of measure (e.g. kg) and the emissionType
is the type of emission (e.g. sulfur dioxide).
emissionValueSource:
slot_uri: cim:EmissionAccount.emissionValueSource
range: EmissionValueSource
required: false
multivalued: false
description: The source of the emission value.
ThermalGeneratingUnit:
slot_uri: cim:EmissionAccount.ThermalGeneratingUnit
range: ThermalGeneratingUnit
required: true
multivalued: false
description: A thermal generating unit may have one or more emission allowance
accounts.
HeatInputCurve:
class_uri: cim:HeatInputCurve
is_a: Curve
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.Production
description: "Relationship between unit heat input in energy per time for main\
\ fuel (Y1-axis) and supplemental fuel (Y2-axis) versus unit output in active\
\ power (X-axis). The quantity of main fuel used to sustain generation at this\
\ output level is prorated for throttling between definition points. The quantity\
\ of supplemental fuel used at this output level is fixed and not prorated.\r\
\n"
attributes:
auxPowerMult:
slot_uri: cim:HeatInputCurve.auxPowerMult
range: PU
required: false
multivalued: false
description: Power output - auxiliary power multiplier adjustment factor.
auxPowerOffset:
slot_uri: cim:HeatInputCurve.auxPowerOffset
range: ActivePower
required: false
multivalued: false
description: "Power output - auxiliary power offset adjustment factor.\r\n"
heatInputEff:
slot_uri: cim:HeatInputCurve.heatInputEff
range: PU
required: false
multivalued: false
description: Heat input - efficiency multiplier adjustment factor.
heatInputOffset:
slot_uri: cim:HeatInputCurve.heatInputOffset
range: HeatRate
required: false
multivalued: false
description: Heat input - offset adjustment factor.
isNetGrossP:
slot_uri: cim:HeatInputCurve.isNetGrossP
range: boolean
required: false
multivalued: false
description: "Flag is set to true when output is expressed in net active power.\r\
\n"
ThermalGeneratingUnit:
slot_uri: cim:HeatInputCurve.ThermalGeneratingUnit
range: ThermalGeneratingUnit
required: true
multivalued: false
description: A thermal generating unit may have a heat input curve.
ResourceVerifiableCosts:
class_uri: cim:ResourceVerifiableCosts
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: "This class is defined to describe the verifiable costs associated\
\ with a generation resource.\r\n"
attributes:
MktHeatRateCurve:
slot_uri: cim:ResourceVerifiableCosts.MktHeatRateCurve
range: MktHeatRateCurve
required: true
multivalued: false
RegisteredResource:
slot_uri: cim:ResourceVerifiableCosts.RegisteredResource
range: RegisteredResource
required: true
multivalued: false
ResourceStartupCost:
slot_uri: cim:ResourceVerifiableCosts.ResourceStartupCost
range: ResourceStartupCost
required: false
multivalued: true
ResourceOperationMaintenanceCost:
slot_uri: cim:ResourceVerifiableCosts.ResourceOperationMaintenanceCost
range: ResourceOperationMaintenanceCost
required: true
multivalued: false
ResourceStartupCost:
class_uri: cim:ResourceStartupCost
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: "To model the startup costs of a generation resource.\r\n"
attributes:
fuelColdStartup:
slot_uri: cim:ResourceStartupCost.fuelColdStartup
range: float
required: false
multivalued: false
description: "Verifiable Cold Start Up Fuel (MMBtu per start)\r\n"
fuelHotStartup:
slot_uri: cim:ResourceStartupCost.fuelHotStartup
range: float
required: false
multivalued: false
description: "Verifiable Hot Start Up Fuel (MMBtu per start)\r\n"
fuelIntermediateStartup:
slot_uri: cim:ResourceStartupCost.fuelIntermediateStartup
range: float
required: false
multivalued: false
description: "Verifiable Intermediate Start Up Fuel (MMBtu per start)\r\n"
fuelLowSustainedLimit:
slot_uri: cim:ResourceStartupCost.fuelLowSustainedLimit
range: float
required: false
multivalued: false
description: "Minimum-Energy fuel, MMBtu/MWh\r\n"
gasPercentColdStartup:
slot_uri: cim:ResourceStartupCost.gasPercentColdStartup
range: PerCent
required: false
multivalued: false
description: "Percentage of Fuel Index Price (gas) for cold startup\r\n"
gasPercentHotStartup:
slot_uri: cim:ResourceStartupCost.gasPercentHotStartup
range: PerCent
required: false
multivalued: false
description: "Percentage of Fuel Index Price (gas) for hot startup\r\n"
gasPercentIntermediateStartup:
slot_uri: cim:ResourceStartupCost.gasPercentIntermediateStartup
range: PerCent
required: false
multivalued: false
description: "Percentage of Fuel Index Price (gas) for intermediate startup\r\
\n"
gasPercentLowSustainedLimit:
slot_uri: cim:ResourceStartupCost.gasPercentLowSustainedLimit
range: PerCent
required: false
multivalued: false
description: "Percentage of FIP (gas) for operating at LSL\r\n"
oilPercentColdStartup:
slot_uri: cim:ResourceStartupCost.oilPercentColdStartup
range: PerCent
required: false
multivalued: false
description: "Percentage of Fuel Oil Price (FOP) for cold startup\r\n"
oilPercentHotStartup:
slot_uri: cim:ResourceStartupCost.oilPercentHotStartup
range: PerCent
required: false
multivalued: false
description: "Percentage of Fuel Oil Price (FOP) for hot startup\r\n"
oilPercentIntermediateStartup:
slot_uri: cim:ResourceStartupCost.oilPercentIntermediateStartup
range: PerCent
required: false
multivalued: false
description: "Percentage of Fuel Oil Price (FOP) for intermediate startup\r\
\n"
oilPercentLowSustainedLimit:
slot_uri: cim:ResourceStartupCost.oilPercentLowSustainedLimit
range: PerCent
required: false
multivalued: false
description: "Percentage of FOP (oil) for operating at LSL\r\n"
solidfuelPercentColdStartup:
slot_uri: cim:ResourceStartupCost.solidfuelPercentColdStartup
range: PerCent
required: false
multivalued: false
description: "Percentage of Solid Fuel for cold startup\r\n"
solidfuelPercentHotStartup:
slot_uri: cim:ResourceStartupCost.solidfuelPercentHotStartup
range: PerCent
required: false
multivalued: false
description: "Percentage of Solid Fuel for hot startup\r\n"
solidfuelPercentIntermediateStartup:
slot_uri: cim:ResourceStartupCost.solidfuelPercentIntermediateStartup
range: PerCent
required: false
multivalued: false
description: "Percentage of Solid Fuel for intermedite startup\r\n"
solidfuelPercentLowSustainedLimit:
slot_uri: cim:ResourceStartupCost.solidfuelPercentLowSustainedLimit
range: PerCent
required: false
multivalued: false
description: "Percentage of Solid Fuel for operating at LSL\r\n"
ResourceVerifiableCosts:
slot_uri: cim:ResourceStartupCost.ResourceVerifiableCosts
range: ResourceVerifiableCosts
required: true
multivalued: false
ResourceOperationMaintenanceCost:
class_uri: cim:ResourceOperationMaintenanceCost
is_a: Curve
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: To model the Operation and Maintenance (O and M) costs of a generation
resource.
attributes:
gasPercentAboveLowSustainedLimit:
slot_uri: cim:ResourceOperationMaintenanceCost.gasPercentAboveLowSustainedLimit
range: PerCent
required: false
multivalued: false
description: "Percentage of Fuel Index Price (gas) for operating above Low\
\ Sustained Limit (LSL)\r\n"
oilPercentAboveLowSustainedLimit:
slot_uri: cim:ResourceOperationMaintenanceCost.oilPercentAboveLowSustainedLimit
range: PerCent
required: false
multivalued: false
description: "Percentage of Fuel Oil Price (FOP) for operating above Low Sustained\
\ Limit (LSL)\r\n"
omCostColdStartup:
slot_uri: cim:ResourceOperationMaintenanceCost.omCostColdStartup
range: float
required: false
multivalued: false
description: "Verifiable O&M Cost ($), Cold Startup\r\n"
omCostHotStartup:
slot_uri: cim:ResourceOperationMaintenanceCost.omCostHotStartup
range: float
required: false
multivalued: false
description: "Verifiable O&M Cost ($), Hot Startup\r\n"
omCostIntermediateStartup:
slot_uri: cim:ResourceOperationMaintenanceCost.omCostIntermediateStartup
range: float
required: false
multivalued: false
description: "Verifiable O&M Cost ($), Intermediate Startup\r\n"
omCostLowSustainedLimit:
slot_uri: cim:ResourceOperationMaintenanceCost.omCostLowSustainedLimit
range: float
required: false
multivalued: false
description: "Verifiable O&M Cost ($/MWh), LSL\r\n"
solidfuelPercentAboveLowSustainedLimit:
slot_uri: cim:ResourceOperationMaintenanceCost.solidfuelPercentAboveLowSustainedLimit
range: PerCent
required: false
multivalued: false
description: "Percentage of Solid Fuel for operating above Low Sustained Limit\
\ (LSL)\r\n"
ResourceVerifiableCosts:
slot_uri: cim:ResourceOperationMaintenanceCost.ResourceVerifiableCosts
range: ResourceVerifiableCosts
required: false
multivalued: false
RMRStartUpEnergyCurve:
class_uri: cim:RMRStartUpEnergyCurve
is_a: Curve
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: Model to support processing of reliability must run units.
attributes:
RegisteredGenerator:
slot_uri: cim:RMRStartUpEnergyCurve.RegisteredGenerator
range: RegisteredGenerator
required: false
multivalued: false
RMRStartUpTimeCurve:
class_uri: cim:RMRStartUpTimeCurve
is_a: Curve
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: Model to support processing of reliability must run units.
attributes:
RegisteredGenerator:
slot_uri: cim:RMRStartUpTimeCurve.RegisteredGenerator
range: RegisteredGenerator
required: false
multivalued: false
StartUpEnergyCurve:
class_uri: cim:StartUpEnergyCurve
is_a: Curve
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: "The energy consumption of a generating resource to complete a start-up\
\ from the StartUpEnergyCurve. Definition of the StartUpEnergyCurve includes,\
\ xvalue as the cooling time and y1value as the MW value.\r\n"
attributes:
RegisteredGenerator:
slot_uri: cim:StartUpEnergyCurve.RegisteredGenerator
range: RegisteredGenerator
required: false
multivalued: false
RegulatingLimit:
class_uri: cim:RegulatingLimit
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: "This class represents the physical characteristic of a generator\
\ regarding the regulating limit.\r\n"
attributes:
highLimit:
slot_uri: cim:RegulatingLimit.highLimit
range: ActivePower
required: false
multivalued: false
lowLimit:
slot_uri: cim:RegulatingLimit.lowLimit
range: ActivePower
required: false
multivalued: false
RegisteredGenerator:
slot_uri: cim:RegulatingLimit.RegisteredGenerator
range: RegisteredGenerator
required: false
multivalued: false
StartUpFuelCurve:
class_uri: cim:StartUpFuelCurve
is_a: Curve
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: "The fuel consumption of a Generating Resource to complete a Start-Up.(x=cooling\
\ time) Form Startup Fuel Curve. xAxisData -> cooling time, y1AxisData ->\
\ MBtu.\r\n"
attributes:
RegisteredGenerator:
slot_uri: cim:StartUpFuelCurve.RegisteredGenerator
range: RegisteredGenerator
required: false
multivalued: false
RMRStartUpCostCurve:
class_uri: cim:RMRStartUpCostCurve
is_a: Curve
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: Model to support processing of reliability must run units.
attributes:
RegisteredGenerator:
slot_uri: cim:RMRStartUpCostCurve.RegisteredGenerator
range: RegisteredGenerator
required: false
multivalued: false
RMRStartUpFuelCurve:
class_uri: cim:RMRStartUpFuelCurve
is_a: Curve
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: Model to support processing of reliability must run units.
attributes:
RegisteredGenerator:
slot_uri: cim:RMRStartUpFuelCurve.RegisteredGenerator
range: RegisteredGenerator
required: false
multivalued: false
RMRHeatRateCurve:
class_uri: cim:RMRHeatRateCurve
is_a: Curve
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: Model to support processing of reliability must run units.
attributes:
RegisteredGenerator:
slot_uri: cim:RMRHeatRateCurve.RegisteredGenerator
range: RegisteredGenerator
required: false
multivalued: false
ActionRequest:
class_uri: cim:ActionRequest
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ParticipantInterfaces
description: Action request against an existing Trade.
attributes:
actionName:
slot_uri: cim:ActionRequest.actionName
range: ActionType
required: false
multivalued: false
description: "Action name type for the action request.\r\n"
Trade:
slot_uri: cim:ActionRequest.Trade
range: Trade
required: false
multivalued: true
Bid:
slot_uri: cim:ActionRequest.Bid
range: Bid
required: false
multivalued: true
TradeProduct:
class_uri: cim:TradeProduct
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ParticipantInterfaces
description: "TradeType TradeProduct\r\
\nIST (InterSC Trade) PHY (Physical Energy Trade)\r\
\nIST APN (Energy Trades at\
\ Aggregated Pricing Nodes)\r\nIST \
\ CPT (Converted Physical Energy Trade)\r\nAST (Ancilliary Services\
\ Trade) RUT (Regulation Up Trade)\r\nAST \
\ RDT (Regulation Down Trade)\r\nAST \
\ SRT (Spinning Reserve Trade)\r\nAST \
\ NRT (Non-Spinning Reserve Trade)\r\
\nUCT (Unit Commitment Trade) null"
attributes:
tradeProductType:
slot_uri: cim:TradeProduct.tradeProductType
range: string
required: false
multivalued: false
description: "PHY (Physical Energy Trade); \r\nAPN (Energy Trades at Aggregated\
\ Pricing Nodes); \r\nCPT (Converted Physical Energy Trade); \r\nRUT (Regulation\
\ Up Trade); \r\nRDT (Regulation Down Trade); \r\nSRT (Spinning Reserve\
\ Trade); \r\nNRT (Non-Spinning Reserve Trade)\r\n"
tradeType:
slot_uri: cim:TradeProduct.tradeType
range: TradeType
required: false
multivalued: false
description: "IST - InterSC Trade; \r\nAST - Ancilliary Services Trade;\
\ \r\nUCT - Unit Commitment Trade"
Trade:
slot_uri: cim:TradeProduct.Trade
range: Trade
required: false
multivalued: true
TradeError:
class_uri: cim:TradeError
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ParticipantInterfaces
description: "Trade error and warning messages associated with the rule engine\
\ processing of the submitted trade.\r\n"
attributes:
endTime:
slot_uri: cim:TradeError.endTime
range: date
required: false
multivalued: false
description: "hour wihthin the trade for which the error applies\r\n"
errMessage:
slot_uri: cim:TradeError.errMessage
range: string
required: false
multivalued: false
description: "error message\r\n"
errPriority:
slot_uri: cim:TradeError.errPriority
range: integer
required: false
multivalued: false
description: "Priority number for the error message\r\n"
logTimeStamp:
slot_uri: cim:TradeError.logTimeStamp
range: date
required: false
multivalued: false
description: "Timestamp of logged error/warning message\r\n"
ruleID:
slot_uri: cim:TradeError.ruleID
range: integer
required: false
multivalued: false
description: "Rule identifier which triggered the error/warning message\r\n"
startTime:
slot_uri: cim:TradeError.startTime
range: date
required: false
multivalued: false
description: "hour wihthin the trade for which the error applies\r\n"
Trade:
slot_uri: cim:TradeError.Trade
range: Trade
required: false
multivalued: false
TransmissionInterfaceRightEntitlement:
class_uri: cim:TransmissionInterfaceRightEntitlement
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.ExternalInputs
description: This is formally called the branch group ETC/TOR entitlement with
the inclusion of CVR as ETC. This could be also used to represent the TR entitlement
on a POR/POD.
attributes:
entitlement:
slot_uri: cim:TransmissionInterfaceRightEntitlement.entitlement
range: float
required: false
multivalued: false
description: "the entitlement\r\n"
POD:
slot_uri: cim:TransmissionInterfaceRightEntitlement.POD
range: string
required: false
multivalued: false
description: "point of delivery\r\n"
POR:
slot_uri: cim:TransmissionInterfaceRightEntitlement.POR
range: string
required: false
multivalued: false
description: "point of receipt\r\n"
startOperatingDate:
slot_uri: cim:TransmissionInterfaceRightEntitlement.startOperatingDate
range: date
required: false
multivalued: false
description: Operating date and hour when the entitlement applies
ContractRight:
slot_uri: cim:TransmissionInterfaceRightEntitlement.ContractRight
range: ContractRight
required: true
multivalued: false
Flowgate:
slot_uri: cim:TransmissionInterfaceRightEntitlement.Flowgate
range: Flowgate
required: false
multivalued: false
TREntitlement:
class_uri: cim:TREntitlement
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.ExternalInputs
description: "A Transmission Right(TR) can be a chain of TR's or on individual.\
\ \r\n\r\nWhen a transmission right is not a chain, this is formally the ETC/TOR\
\ Entitlement for each ETC/TOR contract with the inclusion of CVR(Converted\
\ Rights) as an ETC. This is the sum of all entitlements on all related transmission\
\ interfaces for the same TR.\r\n\r\nWhen TR is a chain, its entitlement is\
\ the minimum of all entitlements for the individual TRs in the chain."
attributes:
entitlement:
slot_uri: cim:TREntitlement.entitlement
range: float
required: false
multivalued: false
description: "The entitlement\r\n"
startOperatingDate:
slot_uri: cim:TREntitlement.startOperatingDate
range: date
required: false
multivalued: false
description: Operating date and hour when the entitlement applies
TransmissionContractRight:
slot_uri: cim:TREntitlement.TransmissionContractRight
range: ContractRight
required: true
multivalued: false
ContractDistributionFactor:
class_uri: cim:ContractDistributionFactor
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: "Distribution among resources at the sink point or source point.\r\
\n"
attributes:
factor:
slot_uri: cim:ContractDistributionFactor.factor
range: float
required: false
multivalued: false
description: "MW value that this resource provides to the overall contract.\r\
\n"
sinkFlag:
slot_uri: cim:ContractDistributionFactor.sinkFlag
range: YesNo
required: false
multivalued: false
description: This value will be set to YES if the referenced Cnode is defined
as the sink point in the contract.
sourceFlag:
slot_uri: cim:ContractDistributionFactor.sourceFlag
range: YesNo
required: false
multivalued: false
description: This value will be set to YES if the referenced Cnode is defined
as the source point in the contract.
Flowgate:
slot_uri: cim:ContractDistributionFactor.Flowgate
range: Flowgate
required: false
multivalued: false
TransmissionContractRight:
slot_uri: cim:ContractDistributionFactor.TransmissionContractRight
range: ContractRight
required: false
multivalued: false
RegisteredResource:
slot_uri: cim:ContractDistributionFactor.RegisteredResource
range: RegisteredResource
required: false
multivalued: false
SubstitutionResourceList:
class_uri: cim:SubstitutionResourceList
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: "List of resources that can be substituted for within the bounds\
\ of a Contract definition. This class has a precedence and a resource.\r\n"
attributes:
precedence:
slot_uri: cim:SubstitutionResourceList.precedence
range: integer
required: false
multivalued: false
description: "An indicator of the order a resource should be substituted.\
\ The lower the number the higher the precedence.\r\n"
TransmissionContractRight:
slot_uri: cim:SubstitutionResourceList.TransmissionContractRight
range: ContractRight
required: false
multivalued: false
RegisteredResource:
slot_uri: cim:SubstitutionResourceList.RegisteredResource
range: RegisteredResource
required: false
multivalued: false
BidPriceSchedule:
class_uri: cim:BidPriceSchedule
is_a: RegularIntervalSchedule
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ParticipantInterfaces
description: "Defines bid schedules to allow a product bid to use specified bid\
\ price curves for different time intervals.\r\n"
attributes:
bidType:
slot_uri: cim:BidPriceSchedule.bidType
range: BidMitigationType
required: false
multivalued: false
description: "BID Type: \r\n\r\nI - Initial Bid; \r\nF - Final Bid"
mitigationStatus:
slot_uri: cim:BidPriceSchedule.mitigationStatus
range: BidMitigationStatus
required: false
multivalued: false
description: "Mitigation Status:\r\n\r\n'S' - Mitigated by SMPM because of\
\ \"misconduct\"\r\n'L; - Mitigated by LMPM because of \"misconduct\"\r\n\
'R' - Modified by LMPM because of RMR rules\r\n'M' - Mitigated because of\
\ \"misconduct\" both by SMPM and LMPM\r\n'B' - Mitigated because of \"\
misconduct\" both by SMPM and modified by LMLM because of RMR rules\r\n\
'O' - original"
BidPriceCurve:
slot_uri: cim:BidPriceSchedule.BidPriceCurve
range: BidPriceCurve
required: true
multivalued: false
ProductBid:
slot_uri: cim:BidPriceSchedule.ProductBid
range: ProductBid
required: true
multivalued: false
BidPriceCurve:
class_uri: cim:BidPriceCurve
is_a: Curve
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ParticipantInterfaces
description: "Relationship between unit operating price in $/hour (Y-axis) and\
\ unit output in MW (X-axis).\r\n"
attributes:
BidSchedule:
slot_uri: cim:BidPriceCurve.BidSchedule
range: BidPriceSchedule
required: false
multivalued: true
MktConnectivityNode:
class_uri: cim:MktConnectivityNode
is_a: ConnectivityNode
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketOpCommon
description: Subclass of IEC61970:Topology:ConnectivityNode.
attributes:
RegisteredResource:
slot_uri: cim:MktConnectivityNode.RegisteredResource
range: RegisteredResource
required: false
multivalued: true
IndividualPnode:
slot_uri: cim:MktConnectivityNode.IndividualPnode
range: IndividualPnode
required: false
multivalued: false
CnodeDistributionFactor:
slot_uri: cim:MktConnectivityNode.CnodeDistributionFactor
range: CnodeDistributionFactor
required: false
multivalued: true
SysLoadDistribuFactor:
slot_uri: cim:MktConnectivityNode.SysLoadDistribuFactor
range: SysLoadDistributionFactor
required: false
multivalued: false
LossPenaltyFactor:
slot_uri: cim:MktConnectivityNode.LossPenaltyFactor
range: LossSensitivity
required: false
multivalued: true
RTO:
slot_uri: cim:MktConnectivityNode.RTO
range: RTO
required: true
multivalued: false
NodeConstraintTerm:
slot_uri: cim:MktConnectivityNode.NodeConstraintTerm
range: NodeConstraintTerm
required: false
multivalued: true
CnodeDistributionFactor:
class_uri: cim:CnodeDistributionFactor
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: "Participation factors per Cnode. Used to calculate \"participation\"\
\ of Cnode in an AggregateNode. Each Cnode associated to an AggregateNode would\
\ be assigned a participation factor for its participation within the AggregateNode.\
\ \r\n"
attributes:
factor:
slot_uri: cim:CnodeDistributionFactor.factor
range: float
required: false
multivalued: false
description: "Used to calculate \"participation\" of Cnode in an AggregateNode\r\
\n"
podLossFactor:
slot_uri: cim:CnodeDistributionFactor.podLossFactor
range: float
required: false
multivalued: false
description: "Point of delivery loss factor\r\n"
MktConnectivityNode:
slot_uri: cim:CnodeDistributionFactor.MktConnectivityNode
range: MktConnectivityNode
required: true
multivalued: false
SubControlArea:
slot_uri: cim:CnodeDistributionFactor.SubControlArea
range: SubControlArea
required: false
multivalued: false
AggregateNode:
slot_uri: cim:CnodeDistributionFactor.AggregateNode
range: AggregateNode
required: false
multivalued: false
HostControlArea:
slot_uri: cim:CnodeDistributionFactor.HostControlArea
range: HostControlArea
required: false
multivalued: false
AggregateNode:
class_uri: cim:AggregateNode
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: "An aggregated node can define a typed grouping further defined by\
\ the AnodeType enumeratuion. Types range from System Zone/Regions to Market\
\ Energy Regions to Aggregated Loads and Aggregated Generators.\r\n"
attributes:
anodeType:
slot_uri: cim:AggregateNode.anodeType
range: AnodeType
required: false
multivalued: false
description: "Type of aggregated node\r\n"
qualifASOrder:
slot_uri: cim:AggregateNode.qualifASOrder
range: integer
required: false
multivalued: false
description: "Processing Order for AS self-provisions for this region. The\
\ priority of this attribute directs the awards of any resource that resides\
\ in overlapping regions. The regions are processed in priority manner.\r\
\n"
CnodeDistributionFactor:
slot_uri: cim:AggregateNode.CnodeDistributionFactor
range: CnodeDistributionFactor
required: false
multivalued: true
SubControlArea:
slot_uri: cim:AggregateNode.SubControlArea
range: SubControlArea
required: false
multivalued: true
Pnode:
slot_uri: cim:AggregateNode.Pnode
range: Pnode
required: false
multivalued: true
AreaLoadCurve:
slot_uri: cim:AggregateNode.AreaLoadCurve
range: AreaLoadCurve
required: false
multivalued: true
Instruction:
slot_uri: cim:AggregateNode.Instruction
range: Instructions
required: false
multivalued: true
RTO:
slot_uri: cim:AggregateNode.RTO
range: RTO
required: true
multivalued: false
RegisteredResource:
slot_uri: cim:AggregateNode.RegisteredResource
range: RegisteredResource
required: false
multivalued: true
description: A RegisteredResource can be associated to only one AggregateNode
if not connected to a Pnode or MktConnectivityNode.
AreaLoadCurve:
class_uri: cim:AreaLoadCurve
is_a: RegularIntervalSchedule
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.ExternalInputs
description: "Area load curve definition.\r\n"
attributes:
forecastType:
slot_uri: cim:AreaLoadCurve.forecastType
range: LoadForecastType
required: false
multivalued: false
description: "Load forecast area type.\r\n"
AggregateNode:
slot_uri: cim:AreaLoadCurve.AggregateNode
range: AggregateNode
required: false
multivalued: false
TACArea:
slot_uri: cim:AreaLoadCurve.TACArea
range: TACArea
required: false
multivalued: false
TACArea:
class_uri: cim:TACArea
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: Transmission Access Charge Area. Charges assessed, on behalf of the
Participating Transmission Owner, to parties who require access to the controlled
grid.
attributes:
AreaLoadCurve:
slot_uri: cim:TACArea.AreaLoadCurve
range: AreaLoadCurve
required: false
multivalued: true
AggregatedPnode:
slot_uri: cim:TACArea.AggregatedPnode
range: AggregatedPnode
required: false
multivalued: true
Instructions:
class_uri: cim:Instructions
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: Provides the necessary information (on a resource basis) to capture
the Startup/Shutdown instruction results. This information is relevant to the
DA Market (RUC only) as well as the RT Market (HASP, Pre-dispatch, and Interval).
attributes:
bindingDOD:
slot_uri: cim:Instructions.bindingDOD
range: float
required: false
multivalued: false
description: Binding dispatch operating delta provides a relative delta to
be applied. Typically used in demand response instructions. The bindingDOD instructions are cumulative; in other words a second
DOD instruction does not replace the previous DOD, instead the second DOD
adds to the previous DODs.
bindingDOT:
slot_uri: cim:Instructions.bindingDOT
range: float
required: false
multivalued: false
bindingInstruction:
slot_uri: cim:Instructions.bindingInstruction
range: YesNo
required: false
multivalued: false
instructionCost:
slot_uri: cim:Instructions.instructionCost
range: float
required: false
multivalued: false
description: "Total cost associated with changing the status of the resource.\r\
\n"
instructionSource:
slot_uri: cim:Instructions.instructionSource
range: MQSInstructionSource
required: false
multivalued: false
description: "instruction source for market quality results (INS, ACT)\r\n"
instructionStartTime:
slot_uri: cim:Instructions.instructionStartTime
range: date
required: false
multivalued: false
description: "Time the resource should be at Pmin (for start ups).\r\n\r\n\
Time the resource is off line.\r\n"
instructionType:
slot_uri: cim:Instructions.instructionType
range: AutomaticDispInstTypeCommitment
required: false
multivalued: false
description: Indicator of either a Start-Up or a Shut-Down.
manuallyBlocked:
slot_uri: cim:Instructions.manuallyBlocked
range: YesNo
required: false
multivalued: false
description: Manually Blocked Indicator (Yes/No). The instruction has been
blocked by an Operator.
minStatusChangeTime:
slot_uri: cim:Instructions.minStatusChangeTime
range: integer
required: false
multivalued: false
description: "Minimum start up time required to bring the unit online (minutes).\r\
\n\r\nSCUC commitment period start-up time. Calculated start up time based\
\ on the StartUpTimeCurve provided with the Bid.\r\n\r\nThis is a combination\
\ of StartUp time bid and Unit down time. \r\n\r\nUnits is minutes\r\n"
updateTimeStamp:
slot_uri: cim:Instructions.updateTimeStamp
range: date
required: false
multivalued: false
updateType:
slot_uri: cim:Instructions.updateType
range: MQSCHGType
required: false
multivalued: false
updateUser:
slot_uri: cim:Instructions.updateUser
range: string
required: false
multivalued: false
RegisteredResource:
slot_uri: cim:Instructions.RegisteredResource
range: RegisteredResource
required: true
multivalued: false
AggregateNode:
slot_uri: cim:Instructions.AggregateNode
range: AggregateNode
required: false
multivalued: false
InstructionClearing:
slot_uri: cim:Instructions.InstructionClearing
range: InstructionClearing
required: true
multivalued: true
InstructionClearing:
class_uri: cim:InstructionClearing
is_a: MarketFactors
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: "Model of market clearing, relating to commitment instructions. Identifies\
\ interval.\r\n"
attributes:
ResourceDeploymentStatus:
slot_uri: cim:InstructionClearing.ResourceDeploymentStatus
range: ResourceDeploymentStatus
required: false
multivalued: true
ActualDemandResponseEvent:
slot_uri: cim:InstructionClearing.ActualDemandResponseEvent
range: DistributedResourceActualEvent
required: false
multivalued: false
description: ActualDemandResponseEvents may exist that are not part of a cordinated
MarketActualEvent associated to a Market. These ActualDemandResponseEvents
can have many InstructionClearing Instructions for specified RegisteredResources
or Distributed Energy Resource type of AggregateNodes.
Instructions:
slot_uri: cim:InstructionClearing.Instructions
range: Instructions
required: true
multivalued: true
DistributedResourceActualEvent:
class_uri: cim:DistributedResourceActualEvent
is_a: MarketActualEvent
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketPlan
description: A demand response event is created when there is a need to call upon
resources to respond to demand adjustment requests. These events are created
by ISO/RTO system operations and managed by a demand response management system
(DRMS). These events may or may not be coordinated with the Market Events and
a defined Energy Market. The event will call for the deployment of a number
of registered resources, or for deployment of resources within a zone (an organizational
area within the power system that contains a number of resources).
attributes:
totalPowerAdjustment:
slot_uri: cim:DistributedResourceActualEvent.totalPowerAdjustment
range: ActivePower
required: false
multivalued: false
description: Total active power adjustment (e.g. load reduction) requested
for this demand response event.
InstructionClearingDOT:
slot_uri: cim:DistributedResourceActualEvent.InstructionClearingDOT
range: InstructionClearingDOT
required: false
multivalued: true
InstructionClearing:
slot_uri: cim:DistributedResourceActualEvent.InstructionClearing
range: InstructionClearing
required: false
multivalued: true
description: ActualDemandResponseEvents may exist that are not part of a coordinated
MarketActualEvent associated to a Market. These ActualDemandResponseEvents
can have many InstructionClearing Instructions for specified RegisteredResources
or DemandResponse AggregateNodes.
ResourcePerformanceEvaluations:
slot_uri: cim:DistributedResourceActualEvent.ResourcePerformanceEvaluations
range: ResourcePerformanceEvaluation
required: false
multivalued: true
ResourcePerformanceEvaluation:
class_uri: cim:ResourcePerformanceEvaluation
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: Represents an the performance evaluation of a resource deployment.
Every resource deployment may have many performance evaluations, using different
evaluation metrics or algorithms, or produced by different evaluation authorities.
attributes:
effectiveEndTime:
slot_uri: cim:ResourcePerformanceEvaluation.effectiveEndTime
range: date
required: false
multivalued: false
effectiveStartTime:
slot_uri: cim:ResourcePerformanceEvaluation.effectiveStartTime
range: date
required: false
multivalued: false
evaluationDescription:
slot_uri: cim:ResourcePerformanceEvaluation.evaluationDescription
range: string
required: false
multivalued: false
description: Description of the performance evaluation, e.g. the rating classification
used (any is allowed), why the evaluation was performed, anything that describes
the demand response performance evaluation.
evaluationValue:
slot_uri: cim:ResourcePerformanceEvaluation.evaluationValue
range: string
required: false
multivalued: false
description: The value of the performance. as a String, any rating scheme
is supported (e.g. "1","2","3" or "low", "medium", "high"). The rating scheme
is described in the performanceValueDescription attribute.
ResourcePerformanceTimeSeriesFactors:
slot_uri: cim:ResourcePerformanceEvaluation.ResourcePerformanceTimeSeriesFactors
range: ResourcePerformanceTimeSeriesFactor
required: false
multivalued: true
DemandResponseActualEvent:
slot_uri: cim:ResourcePerformanceEvaluation.DemandResponseActualEvent
range: DistributedResourceActualEvent
required: true
multivalued: false
ResorcePerformanceGlobalFactor:
slot_uri: cim:ResourcePerformanceEvaluation.ResorcePerformanceGlobalFactor
range: ResourcePerformanceGlobalFactor
required: false
multivalued: true
ResourcePerformanceGlobalFactor:
class_uri: cim:ResourcePerformanceGlobalFactor
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: Global factors are property/value pairs that are used to adjust resource
performance values. Example include scale factors (e.g. scale a baseline up
or down), adders (positive or negative), etc.
attributes:
factorDescription:
slot_uri: cim:ResourcePerformanceGlobalFactor.factorDescription
range: string
required: false
multivalued: false
description: Description (name) of the property (factor).
factorValue:
slot_uri: cim:ResourcePerformanceGlobalFactor.factorValue
range: string
required: false
multivalued: false
description: Value of the property (factor).
ResourcePerformanceEvaluation:
slot_uri: cim:ResourcePerformanceGlobalFactor.ResourcePerformanceEvaluation
range: ResourcePerformanceEvaluation
required: false
multivalued: true
ResourcePerformanceTimeSeriesFactor:
class_uri: cim:ResourcePerformanceTimeSeriesFactor
is_a: RegularIntervalSchedule
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: Represents the performance of a resource as time series data for
a specified time period, time interval, and evaluation criteria.
attributes:
timeSeriesDataType:
slot_uri: cim:ResourcePerformanceTimeSeriesFactor.timeSeriesDataType
range: string
required: false
multivalued: false
description: Type of the time series data, e.g. baseline data, meter read
data, computed performance data.
timeSeriesDescription:
slot_uri: cim:ResourcePerformanceTimeSeriesFactor.timeSeriesDescription
range: string
required: false
multivalued: false
description: Optional description of the time series data, e.g. baseline data,
meter read data, computed performance data.
value1Description:
slot_uri: cim:ResourcePerformanceTimeSeriesFactor.value1Description
range: string
required: false
multivalued: false
description: Description for the value1 contained within the TimeSeriesFactor.
value2Description:
slot_uri: cim:ResourcePerformanceTimeSeriesFactor.value2Description
range: string
required: false
multivalued: false
description: Description for the value2 contained within the TimeSeriesFactor.
ResourcePerformanceEvaluation:
slot_uri: cim:ResourcePerformanceTimeSeriesFactor.ResourcePerformanceEvaluation
range: ResourcePerformanceEvaluation
required: true
multivalued: false
ResourceDeploymentStatus:
class_uri: cim:ResourceDeploymentStatus
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
attributes:
acceptComments:
slot_uri: cim:ResourceDeploymentStatus.acceptComments
range: string
required: false
multivalued: false
description: Commenst to explain why the acceptance status. For example, to
explain why a request is accepted only partially, instead of fully.
acceptStatus:
slot_uri: cim:ResourceDeploymentStatus.acceptStatus
range: string
required: false
multivalued: false
description: Status of the resource for this deployment. Values include (full
compliance, partial compliance, opt-out, etc.)
resourceResponseMW:
slot_uri: cim:ResourceDeploymentStatus.resourceResponseMW
range: float
required: false
multivalued: false
description: The MW amount the resource can contribute for this deployment.
This is from the DR provider - as a response? Or actual? Does this belong
in settlement? Discuss more.
InstructionClearing:
slot_uri: cim:ResourceDeploymentStatus.InstructionClearing
range: InstructionClearing
required: false
multivalued: false
LossSensitivity:
class_uri: cim:LossSensitivity
is_a: MarketFactors
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.ExternalInputs
description: Loss sensitivity applied to a ConnectivityNode for a given time interval.
attributes:
lossFactor:
slot_uri: cim:LossSensitivity.lossFactor
range: float
required: false
multivalued: false
description: "Loss penalty factor.\r\nDefined 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)."
MktConnectivityNode:
slot_uri: cim:LossSensitivity.MktConnectivityNode
range: MktConnectivityNode
required: true
multivalued: false
NodeConstraintTerm:
class_uri: cim:NodeConstraintTerm
is_a: ConstraintTerm
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.ExternalInputs
description: "To be used only to constrain a quantity that cannot be associated\
\ with a terminal. For example, a registered generating unit that is not electrically\
\ connected to the network.\r\n"
attributes:
MktConnectivityNode:
slot_uri: cim:NodeConstraintTerm.MktConnectivityNode
range: MktConnectivityNode
required: true
multivalued: false
ConstraintTerm:
class_uri: cim:ConstraintTerm
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.ExternalInputs
description: "A constraint term is one element of a linear constraint.\r\n"
attributes:
factor:
slot_uri: cim:ConstraintTerm.factor
range: string
required: false
multivalued: false
function:
slot_uri: cim:ConstraintTerm.function
range: string
required: false
multivalued: false
description: "The function is an enumerated value that can be 'active', 'reactive',\
\ or 'VA' to indicate the type of flow.\r\n"
SecurityConstraintSum:
slot_uri: cim:ConstraintTerm.SecurityConstraintSum
range: SecurityConstraintSum
required: true
multivalued: false
SecurityConstraintSum:
class_uri: cim:SecurityConstraintSum
is_a: MarketFactors
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.ExternalInputs
description: "Typically provided by RTO systems, constraints identified in both\
\ base case and critical contingency cases have to be transferred.\r\nA constraint\
\ has N (>=1) constraint terms. A term is represented by an instance of TerminalConstraintTerm.\
\ \r\nThe constraint expression is:\r\nminValue <= c1*x1 + c2*x2 + .... cn*xn\
\ + k <= maxValue\r\nwhere:\r\n- cn is ConstraintTerm.factor \r\n- xn is\
\ the flow at the terminal\r\nFlow into the associated equipment is positive\
\ for the purpose of ConnectivityNode NodeConstraintTerm.\r\n\r\nk is SecurityConstraintsLinear.resourceMW.\r\
\nThe units of k are assumed to be same as the units of the flows, xn. The\
\ constants, cn, are dimensionless.\r\nWith these conventions, cn and k are\
\ all positive for a typical constraint such as \"weighted sum of generation\
\ shall be less than limit\". Furthermore, cn are all 1.0 for a case such as\
\ \"interface flow shall be less than limit\", assuming the terminals are chosen\
\ on the importing side of the interface."
attributes:
RTO:
slot_uri: cim:SecurityConstraintSum.RTO
range: RTO
required: false
multivalued: false
ConstraintTerms:
slot_uri: cim:SecurityConstraintSum.ConstraintTerms
range: ConstraintTerm
required: false
multivalued: true
DefaultConstraintLimit:
slot_uri: cim:SecurityConstraintSum.DefaultConstraintLimit
range: DefaultConstraintLimit
required: false
multivalued: false
BaseCaseConstraintLimit:
slot_uri: cim:SecurityConstraintSum.BaseCaseConstraintLimit
range: BaseCaseConstraintLimit
required: false
multivalued: false
ContingencyConstraintLimits:
slot_uri: cim:SecurityConstraintSum.ContingencyConstraintLimits
range: ContingencyConstraintLimit
required: false
multivalued: true
DefaultConstraintLimit:
class_uri: cim:DefaultConstraintLimit
is_a: Curve
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.ExternalInputs
description: "Possibly time-varying max MW or MVA and optionally Min MW limit\
\ or MVA limit (Y1 and Y2, respectively) applied as a default value if no specific\
\ constraint limits are specified for a contingency analysis. Use CurveSchedule\
\ XAxisUnits to specify MW or MVA.\r\n"
attributes:
SecurityConstraintSum:
slot_uri: cim:DefaultConstraintLimit.SecurityConstraintSum
range: SecurityConstraintSum
required: true
multivalued: false
BaseCaseConstraintLimit:
class_uri: cim:BaseCaseConstraintLimit
is_a: Curve
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.ExternalInputs
description: "Possibly time-varying max MW or MVA and optionally Min MW limit\
\ or MVA limit (Y1 and Y2, respectively) assigned to a contingency analysis\
\ base case. Use CurveSchedule XAxisUnits to specify MW or MVA. To be used only\
\ if the BaseCaseConstraintLimit differs from the DefaultConstraintLimit.\r\n"
attributes:
SecurityConstraintSum:
slot_uri: cim:BaseCaseConstraintLimit.SecurityConstraintSum
range: SecurityConstraintSum
required: true
multivalued: false
ContingencyConstraintLimit:
class_uri: cim:ContingencyConstraintLimit
is_a: Curve
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.ExternalInputs
description: "Possibly time-varying max MW or MVA and optionally Min MW limit\
\ or MVA limit (Y1 and Y2, respectively) assigned to a constraint for a specific\
\ contingency. Use CurveSchedule XAxisUnits to specify MW or MVA.\r\n"
attributes:
MktContingency:
slot_uri: cim:ContingencyConstraintLimit.MktContingency
range: MktContingency
required: true
multivalued: false
MWLimitSchedules:
slot_uri: cim:ContingencyConstraintLimit.MWLimitSchedules
range: MWLimitSchedule
required: true
multivalued: false
SecurityConstraintSum:
slot_uri: cim:ContingencyConstraintLimit.SecurityConstraintSum
range: SecurityConstraintSum
required: true
multivalued: false
MktContingency:
class_uri: cim:MktContingency
is_a: Contingency
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: Subclass of IEC 61970:Contingency.
attributes:
loadRolloverFlag:
slot_uri: cim:MktContingency.loadRolloverFlag
range: boolean
required: false
multivalued: false
description: "load change flag \r\nFlag that indicates whether load rollover\
\ and load pickup should be processed for this contingency\r\n"
ltcControlFlag:
slot_uri: cim:MktContingency.ltcControlFlag
range: boolean
required: false
multivalued: false
description: "ltc enable flag \r\nFlag that indicates if LTCs regulate voltage\
\ during the solution of the contingency\r\n"
participationFactorSet:
slot_uri: cim:MktContingency.participationFactorSet
range: string
required: false
multivalued: false
description: "Participation Factor flag \r\nAn indication which set of generator\
\ participation factors should be used to re-allocate generation in this\
\ contingency\r\n"
screeningFlag:
slot_uri: cim:MktContingency.screeningFlag
range: boolean
required: false
multivalued: false
description: "sceening flag for outage \r\nFlag that indicated whether screening\
\ is bypassed for the contingency\r\n"
ConstraintResults:
slot_uri: cim:MktContingency.ConstraintResults
range: ConstraintResults
required: false
multivalued: true
ContingencyConstraintLimit:
slot_uri: cim:MktContingency.ContingencyConstraintLimit
range: ContingencyConstraintLimit
required: false
multivalued: true
TransferInterfaceSolutionB:
slot_uri: cim:MktContingency.TransferInterfaceSolutionB
range: TransferInterfaceSolution
required: false
multivalued: false
TransferInterfaceSolutionA:
slot_uri: cim:MktContingency.TransferInterfaceSolutionA
range: TransferInterfaceSolution
required: false
multivalued: false
ConstraintResults:
class_uri: cim:ConstraintResults
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: "Provides the Market results for the constraint processing for either\
\ the DAM or RTM. The data includes the constraint type (binding or violated),\
\ the solved value for the constraint, and the associated shadow price.\r\n"
attributes:
baseFlow:
slot_uri: cim:ConstraintResults.baseFlow
range: float
required: false
multivalued: false
description: "Branch base Power Flow.\r\n"
BGLimit:
slot_uri: cim:ConstraintResults.BGLimit
range: float
required: false
multivalued: false
description: "This value is determined in DA and RTM. The SCUC optimization\
\ ensures that the MW flow on the Branch Group will not exceed this limit\
\ in the relevant direction. \r\n"
BGTRResCap:
slot_uri: cim:ConstraintResults.BGTRResCap
range: float
required: false
multivalued: false
description: "Branch Group TR Reservation Capacity - This value is determined\
\ in DA and RTM. It is the amount of spare transmission capacity that is\
\ left for the TR holder to use. \r\n"
bindingLimit:
slot_uri: cim:ConstraintResults.bindingLimit
range: float
required: false
multivalued: false
description: "MW Limit.\r\n"
clearedValue:
slot_uri: cim:ConstraintResults.clearedValue
range: float
required: false
multivalued: false
description: "Cleared MW.\r\n"
competitivePathConstraint:
slot_uri: cim:ConstraintResults.competitivePathConstraint
range: YesNo
required: false
multivalued: false
description: "Non-competitive path constraint Flag\"(Y/N) indicating whether\
\ the shadow price on a non-competitive path was non-zero.\r\n"
constraintType:
slot_uri: cim:ConstraintResults.constraintType
range: ResultsConstraintType
required: false
multivalued: false
description: "Type of constraint.\r\n"
limitFlag:
slot_uri: cim:ConstraintResults.limitFlag
range: ConstraintLimitType
required: false
multivalued: false
description: "Limit flag ('Maximum', 'Minimum').\r\n"
optimizationFlag:
slot_uri: cim:ConstraintResults.optimizationFlag
range: YesNo
required: false
multivalued: false
description: "Included in optimization Y/N.\r\n"
overloadMW:
slot_uri: cim:ConstraintResults.overloadMW
range: float
required: false
multivalued: false
description: "Transmission overload MW.\r\n"
percentMW:
slot_uri: cim:ConstraintResults.percentMW
range: float
required: false
multivalued: false
description: "Actual MW flow as percent of limit.\r\n"
shadowPrice:
slot_uri: cim:ConstraintResults.shadowPrice
range: float
required: false
multivalued: false
description: "Shadow Price ($/MW) for the commodity. Shadow price for the\
\ corresponding constraint.\r\n"
updateTimeStamp:
slot_uri: cim:ConstraintResults.updateTimeStamp
range: date
required: false
multivalued: false
description: "Update time stamp.\r\n"
updateType:
slot_uri: cim:ConstraintResults.updateType
range: MQSCHGType
required: false
multivalued: false
description: "MQS change type.\r\n"
updateUser:
slot_uri: cim:ConstraintResults.updateUser
range: string
required: false
multivalued: false
description: "Updated user.\r\n"
MktContingency:
slot_uri: cim:ConstraintResults.MktContingency
range: MktContingency
required: true
multivalued: false
Flowgate:
slot_uri: cim:ConstraintResults.Flowgate
range: Flowgate
required: true
multivalued: false
ConstraintClearing:
slot_uri: cim:ConstraintResults.ConstraintClearing
range: ConstraintClearing
required: false
multivalued: false
ConstraintClearing:
class_uri: cim:ConstraintClearing
is_a: MarketFactors
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: "Groups all items associated with Binding Constraints and Constraint\
\ Violations per interval and market.\r\n"
attributes:
ConstraintResults:
slot_uri: cim:ConstraintClearing.ConstraintResults
range: ConstraintResults
required: false
multivalued: true
TransferInterfaceSolution:
class_uri: cim:TransferInterfaceSolution
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.ExternalInputs
description: "TNA Interface Definitions from OPF for VSA.\r\n"
attributes:
interfaceMargin:
slot_uri: cim:TransferInterfaceSolution.interfaceMargin
range: float
required: false
multivalued: false
description: "The margin for the interface\r\n"
postTransferMW:
slot_uri: cim:TransferInterfaceSolution.postTransferMW
range: float
required: false
multivalued: false
description: "Post Transfer MW for step\r\n"
transferLimit:
slot_uri: cim:TransferInterfaceSolution.transferLimit
range: float
required: false
multivalued: false
description: "Transfer Interface + Limit \r\nAttribute Usage: The absoloute\
\ of the maximum flow on the transfer interface. This is a positive MW value.\r\
\n"
MktContingencyB:
slot_uri: cim:TransferInterfaceSolution.MktContingencyB
range: MktContingency
required: false
multivalued: false
TransferInterface:
slot_uri: cim:TransferInterfaceSolution.TransferInterface
range: TransferInterface
required: true
multivalued: false
' MktContingencyA':
slot_uri: cim:TransferInterfaceSolution.%20MktContingencyA
range: MktContingency
required: false
multivalued: false
TransferInterface:
class_uri: cim:TransferInterface
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.ExternalInputs
description: "A Transfer Interface is made up of branches such as transmission\
\ lines and transformers.\r\n"
attributes:
HostControlArea:
slot_uri: cim:TransferInterface.HostControlArea
range: HostControlArea
required: false
multivalued: false
TransferInterfaceSolution:
slot_uri: cim:TransferInterface.TransferInterfaceSolution
range: TransferInterfaceSolution
required: true
multivalued: false
MWLimitSchedule:
class_uri: cim:MWLimitSchedule
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.ExternalInputs
description: "Maximum MW and optionally Minimum MW (Y1 and Y2, respectively).\r\
\n"
attributes:
SecurityConstraintLimit:
slot_uri: cim:MWLimitSchedule.SecurityConstraintLimit
range: ContingencyConstraintLimit
required: true
multivalued: false
LossClearingResults:
class_uri: cim:LossClearingResults
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: "Provides the MW loss for RUC Zones, subcontrol areas, and the total\
\ loss.\r\n"
attributes:
lossMW:
slot_uri: cim:LossClearingResults.lossMW
range: float
required: false
multivalued: false
SubControlArea:
slot_uri: cim:LossClearingResults.SubControlArea
range: SubControlArea
required: false
multivalued: false
RUCZone:
slot_uri: cim:LossClearingResults.RUCZone
range: RUCZone
required: false
multivalued: false
LossClearing:
slot_uri: cim:LossClearingResults.LossClearing
range: LossClearing
required: false
multivalued: false
HostControlArea:
slot_uri: cim:LossClearingResults.HostControlArea
range: HostControlArea
required: false
multivalued: false
RUCZone:
class_uri: cim:RUCZone
is_a: AggregateNode
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: A specialized class of type AggregatedNode type. Defines RUC Zones.
A forecast region represents a collection of Nodes for which the Market operator
has developed sufficient historical demand and relevant weather data to perform
a demand forecast for such area. The Market Operator may further adjust this
forecast to ensure that the Reliability Unit Commitment produces adequate local
capacity procurement.
attributes:
LossClearingResults:
slot_uri: cim:RUCZone.LossClearingResults
range: LossClearingResults
required: false
multivalued: true
LossClearing:
class_uri: cim:LossClearing
is_a: MarketFactors
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: "RT only and is published on 5 minute intervals for the previous\
\ RT time interval results.\r\n"
attributes:
LossClearingResults:
slot_uri: cim:LossClearing.LossClearingResults
range: LossClearingResults
required: false
multivalued: true
InadvertentAccount:
class_uri: cim:InadvertentAccount
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfEnergyScheduling
description: "An account for tracking inadvertent interchange versus time for\
\ each control area. A control area may have more than one inadvertent account\
\ in order to track inadvertent over one or more specific tie points in addition\
\ to the usual overall net inadvertent. Separate accounts would also be used\
\ to track designated time periods, such as on-peak and off-peak.\r\n"
attributes:
SubControlArea:
slot_uri: cim:InadvertentAccount.SubControlArea
range: SubControlArea
required: true
multivalued: false
description: A control area can have one or more net inadvertent interchange
accounts
ExPostLossResults:
class_uri: cim:ExPostLossResults
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: "Model results of ex-post calculation of MW losses. Summarizes loss\
\ in two categories losses on the the extra high voltage transmission and total\
\ losses. Calculated for each subcontrol area.\r\n"
attributes:
ehvLossMW:
slot_uri: cim:ExPostLossResults.ehvLossMW
range: float
required: false
multivalued: false
description: "EHV MW losses in the company \r\nAttribute Usage: Information\
\ purposes - Output of LPA engine.\r\n"
totalLossMW:
slot_uri: cim:ExPostLossResults.totalLossMW
range: float
required: false
multivalued: false
description: "Total MW losses in the company \r\nAttribute Usage: Information\
\ purposes - Output of LPA engine.\r\n"
ExPostLoss:
slot_uri: cim:ExPostLossResults.ExPostLoss
range: ExPostLoss
required: true
multivalued: false
SubControlArea:
slot_uri: cim:ExPostLossResults.SubControlArea
range: SubControlArea
required: false
multivalued: false
ExPostLoss:
class_uri: cim:ExPostLoss
is_a: MarketFactors
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: "Model of ex-post calcultion of MW losses. \r\n"
attributes:
ExPostLossResults:
slot_uri: cim:ExPostLoss.ExPostLossResults
range: ExPostLossResults
required: false
multivalued: true
ControlAreaDesignation:
class_uri: cim:ControlAreaDesignation
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: Indicates Control Area associated with self-schedule.
attributes:
attained:
slot_uri: cim:ControlAreaDesignation.attained
range: YesNo
required: false
multivalued: false
description: Attained.
native:
slot_uri: cim:ControlAreaDesignation.native
range: YesNo
required: false
multivalued: false
description: Native.
SubControlArea:
slot_uri: cim:ControlAreaDesignation.SubControlArea
range: SubControlArea
required: false
multivalued: true
RegisteredResource:
slot_uri: cim:ControlAreaDesignation.RegisteredResource
range: RegisteredResource
required: false
multivalued: true
AreaReserveSpec:
class_uri: cim:AreaReserveSpec
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfEnergyScheduling
description: "The control area's reserve specification.\r\n"
attributes:
Description:
slot_uri: cim:AreaReserveSpec.Description
range: string
required: false
multivalued: false
description: "Description of the object or instance.\r\n"
lowerRegMarginReqt:
slot_uri: cim:AreaReserveSpec.lowerRegMarginReqt
range: ActivePower
required: false
multivalued: false
description: "Lower regulating margin requirement in MW, the amount of generation\
\ that can be dropped by control in 10 minutes\r\n"
opReserveReqt:
slot_uri: cim:AreaReserveSpec.opReserveReqt
range: ActivePower
required: false
multivalued: false
description: "Operating reserve requirement in MW, where operating reserve\
\ is the generating capability that is fully available within 30 minutes.\
\ Operating reserve is composed of primary reserve (t less than 10 min)\
\ and secondary reserve (10 less than t less than 30 min).\r\n"
primaryReserveReqt:
slot_uri: cim:AreaReserveSpec.primaryReserveReqt
range: ActivePower
required: false
multivalued: false
description: "Primary reserve requirement in MW, where primary reserve is\
\ generating capability that is fully available within 10 minutes. Primary\
\ reserve is composed of spinning reserve and quick-start reserve.\r\n"
raiseRegMarginReqt:
slot_uri: cim:AreaReserveSpec.raiseRegMarginReqt
range: ActivePower
required: false
multivalued: false
description: "Raise regulating margin requirement in MW, the amount of generation\
\ that can be picked up by control in 10 minutes\r\n"
spinningReserveReqt:
slot_uri: cim:AreaReserveSpec.spinningReserveReqt
range: ActivePower
required: false
multivalued: false
description: "Spinning reserve requirement in MW, spinning reserve is generating\
\ capability that is presently synchronized to the network and is fully\
\ available within 10 minutes\r\n"
SubControlArea:
slot_uri: cim:AreaReserveSpec.SubControlArea
range: SubControlArea
required: false
multivalued: true
GeneralClearingResults:
class_uri: cim:GeneralClearingResults
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: "Provides the adjusted load forecast value on a load forecast zone\
\ basis. \r\n"
attributes:
loadForecast:
slot_uri: cim:GeneralClearingResults.loadForecast
range: ActivePower
required: false
multivalued: false
description: "Load Prediction/Forecast (MW), by Time Period (5', 10', 15')\r\
\n"
totalLoad:
slot_uri: cim:GeneralClearingResults.totalLoad
range: float
required: false
multivalued: false
description: "Amount of load in the control zone \r\nAttribute Usage: hourly\
\ load value for the specific area\r\n"
totalNetInterchange:
slot_uri: cim:GeneralClearingResults.totalNetInterchange
range: float
required: false
multivalued: false
description: "Amount of interchange for the control zone \r\nAttribute Usage:\
\ hourly interchange value for the specific area\r\n"
SubControlArea:
slot_uri: cim:GeneralClearingResults.SubControlArea
range: SubControlArea
required: false
multivalued: false
GeneralClearing:
slot_uri: cim:GeneralClearingResults.GeneralClearing
range: GeneralClearing
required: false
multivalued: false
GeneralClearing:
class_uri: cim:GeneralClearing
is_a: MarketFactors
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: "Model of clearing result of the market run at the market level.\
\ Identifies interval.\r\n"
attributes:
GeneralClearingResults:
slot_uri: cim:GeneralClearing.GeneralClearingResults
range: GeneralClearingResults
required: false
multivalued: true
TiePoint:
class_uri: cim:TiePoint
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfReservation
description: "Site of an interface between interchange areas. The tie point can\
\ be a network branch (e.g., transmission line or transformer) or a switching\
\ device. For transmission lines, the interchange area boundary is usually at\
\ a designated point such as the middle of the line. Line end metering is then\
\ corrected for line losses.\r\n"
attributes:
tiePointMWRating:
slot_uri: cim:TiePoint.tiePointMWRating
range: ActivePower
required: false
multivalued: false
description: "The MW rating of the tie point.\r\n"
ByMktMeasurement:
slot_uri: cim:TiePoint.ByMktMeasurement
range: MktMeasurement
required: true
multivalued: true
description: A measurement is made on the B side of a tie point
ForMktMeasurement:
slot_uri: cim:TiePoint.ForMktMeasurement
range: MktMeasurement
required: true
multivalued: true
description: A measurement is made on the A side of a tie point
GeneratingUnitDynamicValues:
class_uri: cim:GeneratingUnitDynamicValues
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.ExternalInputs
description: "Optimal Power Flow or State Estimator Unit Data for Operator Training\
\ Simulator. This is used for RealTime, Study and Maintenance Users.\r\n"
attributes:
lossFactor:
slot_uri: cim:GeneratingUnitDynamicValues.lossFactor
range: float
required: false
multivalued: false
description: "Loss Factor\r\n"
maximumMW:
slot_uri: cim:GeneratingUnitDynamicValues.maximumMW
range: float
required: false
multivalued: false
description: "The maximum active power generation of the unit in MW\r\n"
minimumMW:
slot_uri: cim:GeneratingUnitDynamicValues.minimumMW
range: float
required: false
multivalued: false
description: "The minimum active power generation of the unit in MW\r\n"
mVAR:
slot_uri: cim:GeneratingUnitDynamicValues.mVAR
range: float
required: false
multivalued: false
description: "Unit reactive power generation in MVAR\r\n"
mw:
slot_uri: cim:GeneratingUnitDynamicValues.mw
range: float
required: false
multivalued: false
description: "Unit active power generation in MW\r\n"
sensitivity:
slot_uri: cim:GeneratingUnitDynamicValues.sensitivity
range: float
required: false
multivalued: false
description: "Unit sencivity factor. The distribution factors (DFAX) for the\
\ unit\r\n"
MktGeneratingUnit:
slot_uri: cim:GeneratingUnitDynamicValues.MktGeneratingUnit
range: MktGeneratingUnit
required: true
multivalued: false
Flowgate:
slot_uri: cim:GeneratingUnitDynamicValues.Flowgate
range: Flowgate
required: false
multivalued: false
MktGeneratingUnit:
class_uri: cim:MktGeneratingUnit
is_a: GeneratingUnit
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketCommon
description: Subclass of IEC61970:Production:GeneratingUnit.
attributes:
GeneratingUnitDynamicValues:
slot_uri: cim:MktGeneratingUnit.GeneratingUnitDynamicValues
range: GeneratingUnitDynamicValues
required: false
multivalued: true
CongestionRevenueRight:
class_uri: cim:CongestionRevenueRight
is_a: Document
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.CongestionRevenueRights
description: "Congestion Revenue Rights (CRR) class that is inherited from a Document\
\ class.\r\n\r\nA CRR is a financial concept that is used to hedge congestion\
\ charges.\r\n\r\nThe CRR is usually settled based on the Locational Marginal\
\ Prices (LMPs) that are calculated in the day-ahead market. These LMPs are\
\ determined by the Day-ahead resource schedules/bids. CRRs will not hedge against\
\ marginal losses. If the congestion component of LMP at the sink is greater\
\ than at the source, then the CRR owner is entitled to receive a portion of\
\ congestion revenues. If the congestion component at the sink is less than\
\ at the source, then an obligation-type CRR owner will be charged, but an option-type\
\ CRR owner will not."
attributes:
cRRcategory:
slot_uri: cim:CongestionRevenueRight.cRRcategory
range: CRRCategoryType
required: false
multivalued: false
description: CRR category represents 'PTP' for a point-to-point CRR, or 'NSR'
for a Network Service Right. If CRR category is 'PTP', both Source ID and
Sink ID fields are required. If CRR category is 'NSR' only one field, either
Source ID or Sink ID, shall be not null and the other shall be null. However,
the 'NSR' category will include at least three records.
cRRtype:
slot_uri: cim:CongestionRevenueRight.cRRtype
range: CRRSegmentType
required: false
multivalued: false
description: Type of the CRR, from the possible type definitions in the CRR
System (e.g. 'LSE', 'ETC').
hedgeType:
slot_uri: cim:CongestionRevenueRight.hedgeType
range: CRRHedgeType
required: false
multivalued: false
description: Hedge type Obligation or Option. An obligation type requires
the holder to receive or pay the congestion rent. An option type gives the
holder the option of receiving or paying the congestion rent.
timeOfUse:
slot_uri: cim:CongestionRevenueRight.timeOfUse
range: TimeOfUse
required: false
multivalued: false
description: Time of Use flag of the CRR - Peak (ON), Offpeak (OFF) or all
24 hours (24HR).
tradeSliceID:
slot_uri: cim:CongestionRevenueRight.tradeSliceID
range: string
required: false
multivalued: false
description: "Segment of the CRR described in the current record.\r\n"
CRRSegment:
slot_uri: cim:CongestionRevenueRight.CRRSegment
range: CRRSegment
required: true
multivalued: true
CRRMarket:
slot_uri: cim:CongestionRevenueRight.CRRMarket
range: CRRMarket
required: true
multivalued: false
Flowgate:
slot_uri: cim:CongestionRevenueRight.Flowgate
range: Flowgate
required: false
multivalued: false
CRROrgRole:
slot_uri: cim:CongestionRevenueRight.CRROrgRole
range: CRROrgRole
required: true
multivalued: true
CRROrgRole:
class_uri: cim:CRROrgRole
is_a: OrganisationRole
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.CongestionRevenueRights
description: Identifies a way in which an organisation may participate with a
defined Congestion Revenue Right (CRR).
attributes:
kind:
slot_uri: cim:CRROrgRole.kind
range: CRRRoleType
required: false
multivalued: false
description: Kind of role the organisation is with regards to the congestion
revenue rights.
status:
slot_uri: cim:CRROrgRole.status
range: Status
required: false
multivalued: false
description: Status of congestion revenue rights organisation role.
CongestionRevenueRight:
slot_uri: cim:CRROrgRole.CongestionRevenueRight
range: CongestionRevenueRight
required: true
multivalued: false
CRRSegment:
class_uri: cim:CRRSegment
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.CongestionRevenueRights
description: "CRRSegment represents a segment of a CRR in a particular time frame.\
\ \r\n\r\nThe segment class contains amount, clearing price, start date and\
\ time, end date and time."
attributes:
amount:
slot_uri: cim:CRRSegment.amount
range: Money
required: false
multivalued: false
description: "Dollar amount = quantity x clearingPrice\r\n"
clearingPrice:
slot_uri: cim:CRRSegment.clearingPrice
range: Money
required: false
multivalued: false
description: "Clearing price of a CRR\r\n"
endDateTime:
slot_uri: cim:CRRSegment.endDateTime
range: date
required: false
multivalued: false
description: "segment end date time\r\n"
quantity:
slot_uri: cim:CRRSegment.quantity
range: float
required: false
multivalued: false
description: "The MW amount associated with the CRR\r\n"
startDateTime:
slot_uri: cim:CRRSegment.startDateTime
range: date
required: false
multivalued: false
description: "segment start date time\r\n"
CongestionRevenueRight:
slot_uri: cim:CRRSegment.CongestionRevenueRight
range: CongestionRevenueRight
required: true
multivalued: false
Sink:
slot_uri: cim:CRRSegment.Sink
range: Pnode
required: false
multivalued: true
Source:
slot_uri: cim:CRRSegment.Source
range: Pnode
required: false
multivalued: true
CRRMarket:
class_uri: cim:CRRMarket
is_a: Market
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketPlan
description: "Model that describes the Congestion Revenue Rights Auction Market.\r\
\n"
attributes:
labelID:
slot_uri: cim:CRRMarket.labelID
range: string
required: false
multivalued: false
description: "labelID - an ID for a set of apnodes/pnodes used in a CRR market\r\
\n"
CongestionRevenueRight:
slot_uri: cim:CRRMarket.CongestionRevenueRight
range: CongestionRevenueRight
required: true
multivalued: true
GenericConstraints:
class_uri: cim:GenericConstraints
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.ExternalInputs
description: "Generic constraints can represent secure areas, voltage profile,\
\ transient stability and voltage collapse limits.\r\n\r\nThe generic constraints\
\ can be one of the following forms:\r\na)\tThermal MW limit constraints type\r\
\nb)\tGroup line flow constraint type\r\n"
attributes:
intervalEndTime:
slot_uri: cim:GenericConstraints.intervalEndTime
range: date
required: false
multivalued: false
description: "Interval End Time\r\n"
intervalStartTime:
slot_uri: cim:GenericConstraints.intervalStartTime
range: date
required: false
multivalued: false
description: "Interval Start Time\r\n"
maxLimit:
slot_uri: cim:GenericConstraints.maxLimit
range: float
required: false
multivalued: false
description: "Maximum Limit (MW)\r\n"
minLimit:
slot_uri: cim:GenericConstraints.minLimit
range: float
required: false
multivalued: false
description: "Minimum Limit (MW)\r\n"
TransmissionCapacity:
slot_uri: cim:GenericConstraints.TransmissionCapacity
range: TransmissionCapacity
required: false
multivalued: true
Flowgate:
slot_uri: cim:GenericConstraints.Flowgate
range: Flowgate
required: false
multivalued: true
TransmissionCapacity:
class_uri: cim:TransmissionCapacity
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.ExternalInputs
description: "This class models the transmission (either a transmission interface\
\ or a POR/POD pair) capacity including Total Transfer Capacity (TTC), Operating\
\ Transfer Capacity (OTC), and Capacity Benefit Margin (CBM).\r\n"
attributes:
capacityBenefitMargin:
slot_uri: cim:TransmissionCapacity.capacityBenefitMargin
range: float
required: false
multivalued: false
description: "Capacity Benefit Margin (CBM) is used by Markets to calculate\
\ the transmission interface limits. This number could be manually or procedurally\
\ determined. The CBM is defined per transmission interface (branch group).\r\
\n"
operationalTransmissionCapacity:
slot_uri: cim:TransmissionCapacity.operationalTransmissionCapacity
range: float
required: false
multivalued: false
description: "The Operational Transmission Capacity (OTC) is the transmission\
\ capacity under the operating condition during a specific time period,\
\ incorporating the effects of derates and current settings of operation\
\ controls. The OTCs for all transmission interface (branch group) are always\
\ provided regardless of outage or switching conditions.\r\n"
OTC15min_emergency:
slot_uri: cim:TransmissionCapacity.OTC15min_emergency
range: float
required: false
multivalued: false
description: "The Operational Transmission Capacity (OTC) 15 minute Emergency\
\ Limit\r\n"
OTCemergency:
slot_uri: cim:TransmissionCapacity.OTCemergency
range: float
required: false
multivalued: false
description: "The Operational Transmission Capacity (OTC) Emergency Limit.\r\
\n"
POD:
slot_uri: cim:TransmissionCapacity.POD
range: string
required: false
multivalued: false
description: "point of delivery\r\n"
POR:
slot_uri: cim:TransmissionCapacity.POR
range: string
required: false
multivalued: false
description: "point of receipt\r\n"
startOperatingDate:
slot_uri: cim:TransmissionCapacity.startOperatingDate
range: date
required: false
multivalued: false
description: "Operating date & hour when the entitlement applies\r\n"
totalTransmissionCapacity:
slot_uri: cim:TransmissionCapacity.totalTransmissionCapacity
range: float
required: false
multivalued: false
description: "Total Transmission Capacity\r\n"
GenericConstraints:
slot_uri: cim:TransmissionCapacity.GenericConstraints
range: GenericConstraints
required: false
multivalued: false
Flowgate:
slot_uri: cim:TransmissionCapacity.Flowgate
range: Flowgate
required: false
multivalued: false
MktTerminal:
class_uri: cim:MktTerminal
is_a: Terminal
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketOpCommon
description: Subclass of IEC61970:Core:Terminal.
attributes:
Flowgate:
slot_uri: cim:MktTerminal.Flowgate
range: Flowgate
required: false
multivalued: false
TerminalConstraintTerm:
slot_uri: cim:MktTerminal.TerminalConstraintTerm
range: TerminalConstraintTerm
required: false
multivalued: true
TerminalConstraintTerm:
class_uri: cim:TerminalConstraintTerm
is_a: ConstraintTerm
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.ExternalInputs
description: "A constraint term associated with a specific terminal on a physical\
\ piece of equipment.\r\n"
attributes:
MktTerminal:
slot_uri: cim:TerminalConstraintTerm.MktTerminal
range: MktTerminal
required: true
multivalued: false
FlowgateValue:
class_uri: cim:FlowgateValue
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: "Day Ahead, Network Native Load, Economic Dispatch, values used\
\ for calculation of Network Native Load (NNL) Determinator process.\r\n"
attributes:
economicDispatchLimit:
slot_uri: cim:FlowgateValue.economicDispatchLimit
range: integer
required: false
multivalued: false
description: "Limit for Economic Dispatch priority 6 energy flow on the specified\
\ flowgate for the specified time period.\r\n"
effectiveDate:
slot_uri: cim:FlowgateValue.effectiveDate
range: date
required: false
multivalued: false
description: "Date/Time when record becomes effective \r\nUsed to determine\
\ when a record becomes effective\r\n"
firmNetworkLimit:
slot_uri: cim:FlowgateValue.firmNetworkLimit
range: integer
required: false
multivalued: false
description: "Limit for firm flow on the specified flowgate for the specified\
\ time period. The amount of energy flow over a specifed flowgate due to\
\ generation in the market which can be classified as Firm Network priority.\r\
\n"
flowDirectionFlag:
slot_uri: cim:FlowgateValue.flowDirectionFlag
range: FlowDirectionType
required: false
multivalued: false
description: Specifies the direction of energy flow in the flowgate
mktFlow:
slot_uri: cim:FlowgateValue.mktFlow
range: integer
required: false
multivalued: false
description: "The amount of energy flow over a specifed flowgate due to generation\
\ in the market.\r\n"
netFirmNetworkLimit:
slot_uri: cim:FlowgateValue.netFirmNetworkLimit
range: integer
required: false
multivalued: false
description: "Net Energy flow in flowgate for the associated FlowgatePartner\r\
\n"
Flowgate:
slot_uri: cim:FlowgateValue.Flowgate
range: Flowgate
required: true
multivalued: false
FlowgatePartner:
slot_uri: cim:FlowgateValue.FlowgatePartner
range: FlowgatePartner
required: false
multivalued: false
FlowgatePartner:
class_uri: cim:FlowgatePartner
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: "Flowgate defined partner.\r\n"
attributes:
FlowgateValue:
slot_uri: cim:FlowgatePartner.FlowgateValue
range: FlowgateValue
required: false
multivalued: false
FlowgateRelief:
class_uri: cim:FlowgateRelief
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: "IDC (Interchange Distribution Calulator) sends data for a TLR (Transmission\
\ Loading Relief).\r\n"
attributes:
effectiveDate:
slot_uri: cim:FlowgateRelief.effectiveDate
range: date
required: false
multivalued: false
description: "Date/Time when record becomes effective \r\nUsed to determine\
\ when a record becomes effective.\r\n"
idcTargetMktFlow:
slot_uri: cim:FlowgateRelief.idcTargetMktFlow
range: integer
required: false
multivalued: false
description: "Energy Flow level that should be maintained according to the\
\ TLR rules as specified by the IDC. \r\nFor Realtime Markets use in dispatch\
\ to control constraints under TLR and calculate unconstrained market flows\r\
\n"
terminateDate:
slot_uri: cim:FlowgateRelief.terminateDate
range: date
required: false
multivalued: false
description: "Date/Time when record is no longer effective \r\nUsed to determine\
\ when a record is no longer effective\r\n"
Flowgate:
slot_uri: cim:FlowgateRelief.Flowgate
range: Flowgate
required: true
multivalued: false
MktPowerTransformer:
class_uri: cim:MktPowerTransformer
is_a: PowerTransformer
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketOpCommon
description: Subclass of IEC61970:Wires:PowerTransformer.
attributes:
EndAFlow:
slot_uri: cim:MktPowerTransformer.EndAFlow
range: BranchEndFlow
required: false
multivalued: false
EndBFlow:
slot_uri: cim:MktPowerTransformer.EndBFlow
range: BranchEndFlow
required: false
multivalued: false
Flowgate:
slot_uri: cim:MktPowerTransformer.Flowgate
range: Flowgate
required: false
multivalued: true
BranchEndFlow:
class_uri: cim:BranchEndFlow
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.ExternalInputs
description: "Dynamic flows and ratings associated with a branch end.\r\n"
attributes:
loadDumpRating:
slot_uri: cim:BranchEndFlow.loadDumpRating
range: float
required: false
multivalued: false
description: "The Load Dump Rating for the branch\r\n"
longTermRating:
slot_uri: cim:BranchEndFlow.longTermRating
range: float
required: false
multivalued: false
description: "The Long Term Rating for the branch\r\n"
mVARFlow:
slot_uri: cim:BranchEndFlow.mVARFlow
range: float
required: false
multivalued: false
description: "The MVAR flow on the branch \r\nAttribute Usage: Reactive power\
\ flow at the series device, transformer, phase shifter, or line end\r\n"
mwFlow:
slot_uri: cim:BranchEndFlow.mwFlow
range: float
required: false
multivalued: false
description: "The MW flow on the branch \r\nAttribute Usage: Active power\
\ flow at the series device, transformer, phase shifter, or line end\r\n"
normalRating:
slot_uri: cim:BranchEndFlow.normalRating
range: float
required: false
multivalued: false
description: "The Normal Rating for the branch\r\n"
shortTermRating:
slot_uri: cim:BranchEndFlow.shortTermRating
range: float
required: false
multivalued: false
description: "The Short Term Rating for the branch\r\n"
MktSeriresCompensatorEndAFlow:
slot_uri: cim:BranchEndFlow.MktSeriresCompensatorEndAFlow
range: MktSeriesCompensator
required: false
multivalued: true
MktPowerTransformerEndAFlow:
slot_uri: cim:BranchEndFlow.MktPowerTransformerEndAFlow
range: MktPowerTransformer
required: false
multivalued: true
MktACLineSegmentEndBFlow:
slot_uri: cim:BranchEndFlow.MktACLineSegmentEndBFlow
range: MktACLineSegment
required: false
multivalued: true
MktSeriesCompensatorEndBFlow:
slot_uri: cim:BranchEndFlow.MktSeriesCompensatorEndBFlow
range: MktSeriesCompensator
required: false
multivalued: true
MktACLineSegmentEndAFlow:
slot_uri: cim:BranchEndFlow.MktACLineSegmentEndAFlow
range: MktACLineSegment
required: false
multivalued: true
MktPowerTransformerEndBFlow:
slot_uri: cim:BranchEndFlow.MktPowerTransformerEndBFlow
range: MktPowerTransformer
required: false
multivalued: true
MktSeriesCompensator:
class_uri: cim:MktSeriesCompensator
is_a: SeriesCompensator
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.ExternalInputs
description: Subclass of IEC 61970:Wires:SeriesCompensator.
attributes:
EndAFlow:
slot_uri: cim:MktSeriesCompensator.EndAFlow
range: BranchEndFlow
required: false
multivalued: false
EndBFlow:
slot_uri: cim:MktSeriesCompensator.EndBFlow
range: BranchEndFlow
required: false
multivalued: false
SeriesCompensator:
class_uri: cim:SeriesCompensator
is_a: ConductingEquipment
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: "A Series Compensator is a series capacitor or reactor or an AC transmission\
\ line without charging susceptance. It is a two terminal device.\r\n"
attributes:
r:
slot_uri: cim:SeriesCompensator.r
range: Resistance
required: false
multivalued: false
description: Positive sequence resistance.
r0:
slot_uri: cim:SeriesCompensator.r0
range: Resistance
required: false
multivalued: false
description: "Zero sequence resistance.\r\n"
varistorPresent:
slot_uri: cim:SeriesCompensator.varistorPresent
range: boolean
required: false
multivalued: false
description: Describe if a metal oxide varistor (mov) for over voltage protection
is configured in parallel with the series compensator. It is used for short
circuit calculations.
varistorRatedCurrent:
slot_uri: cim:SeriesCompensator.varistorRatedCurrent
range: CurrentFlow
required: false
multivalued: false
description: "The maximum current the varistor is designed to handle at specified\
\ duration. It is used for short circuit calculations and exchanged only\
\ if SeriesCompensator.varistorPresent is true.\r\nThe attribute shall be\
\ a positive value."
varistorVoltageThreshold:
slot_uri: cim:SeriesCompensator.varistorVoltageThreshold
range: Voltage
required: false
multivalued: false
description: The dc voltage at which the varistor starts conducting. It is
used for short circuit calculations and exchanged only if SeriesCompensator.varistorPresent
is true.
x:
slot_uri: cim:SeriesCompensator.x
range: Reactance
required: false
multivalued: false
description: Positive sequence reactance.
x0:
slot_uri: cim:SeriesCompensator.x0
range: Reactance
required: false
multivalued: false
description: "Zero sequence reactance.\r\n"
MktACLineSegment:
class_uri: cim:MktACLineSegment
is_a: ACLineSegment
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.ExternalInputs
description: Subclass of IEC 61970:Wires:ACLineSegment.
attributes:
EndBFlow:
slot_uri: cim:MktACLineSegment.EndBFlow
range: BranchEndFlow
required: false
multivalued: false
EndAFlow:
slot_uri: cim:MktACLineSegment.EndAFlow
range: BranchEndFlow
required: false
multivalued: false
InterTieResults:
class_uri: cim:InterTieResults
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfMarketResults
description: "Provides the tie point specific output from the market applications.\
\ Currently, this is defined as the loop flow compensation MW value.\r\n"
attributes:
baseMW:
slot_uri: cim:InterTieResults.baseMW
range: float
required: false
multivalued: false
description: "Net Actual MW Flow\r\n"
clearedValue:
slot_uri: cim:InterTieResults.clearedValue
range: float
required: false
multivalued: false
description: "Net Dispatched MW\r\n"
InterTieClearing:
slot_uri: cim:InterTieResults.InterTieClearing
range: InterTieClearing
required: false
multivalued: false
Flowgate:
slot_uri: cim:InterTieResults.Flowgate
range: Flowgate
required: true
multivalued: false
InterTieClearing:
class_uri: cim:InterTieClearing
is_a: MarketFactors
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfMarketResults
description: "Model of market clearing related to results at the inter-ties. Identifies\
\ interval\r\n"
attributes:
InterTieResults:
slot_uri: cim:InterTieClearing.InterTieResults
range: InterTieResults
required: false
multivalued: true
CurtailmentProfile:
class_uri: cim:CurtailmentProfile
is_a: Profile
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfEnergyScheduling
description: "Curtailing entity must be providing at least one service to the\
\ EnergyTransaction. The CurtailmentProfile must be completely contained within\
\ the EnergyProfile timeframe for this EnergyTransaction.\r\n"
attributes:
EnergyTransaction:
slot_uri: cim:CurtailmentProfile.EnergyTransaction
range: EnergyTransaction
required: true
multivalued: false
description: An EnergyTransaction may be curtailed by any of the participating
entities.
EnergyProduct:
class_uri: cim:EnergyProduct
is_a: Agreement
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfEnergyScheduling
description: "An EnergyProduct is offered commercially as a ContractOrTariff.\r\
\n"
attributes:
TitleHeldBy_Marketer:
slot_uri: cim:EnergyProduct.TitleHeldBy_Marketer
range: Marketer
required: false
multivalued: false
description: A Marketer holds title to an EnergyProduct.
GenerationProvider:
slot_uri: cim:EnergyProduct.GenerationProvider
range: GenerationProvider
required: true
multivalued: false
ResoldBy_Marketer:
slot_uri: cim:EnergyProduct.ResoldBy_Marketer
range: Marketer
required: false
multivalued: true
description: A Marketer may resell an EnergyProduct.
EnergyTransactions:
slot_uri: cim:EnergyProduct.EnergyTransactions
range: EnergyTransaction
required: true
multivalued: true
description: The "Source" for an EnergyTransaction is an EnergyProduct which
is injected into a ControlArea. Typically this is a ServicePoint.
Marketer:
class_uri: cim:Marketer
is_a: Organisation
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfFinancial
description: "Matches buyers and sellers, and secures transmission (and other\
\ ancillary services) needed to complete the energy transaction.\r\n"
attributes:
HoldsTitleTo_EnergyProducts:
slot_uri: cim:Marketer.HoldsTitleTo_EnergyProducts
range: EnergyProduct
required: false
multivalued: true
description: A Marketer holds title to an EnergyProduct.
Resells_EnergyProduct:
slot_uri: cim:Marketer.Resells_EnergyProduct
range: EnergyProduct
required: false
multivalued: true
description: A Marketer may resell an EnergyProduct.
GenerationProvider:
class_uri: cim:GenerationProvider
is_a: Organisation
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfFinancial
description: "The energy seller in the energy marketplace.\r\n"
attributes:
ProvidedBy:
slot_uri: cim:GenerationProvider.ProvidedBy
range: EnergyProduct
required: true
multivalued: true
OrgPnodeAllocation:
class_uri: cim:OrgPnodeAllocation
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: This class models the allocation between asset owners and pricing
nodes.
attributes:
maxMWAllocation:
slot_uri: cim:OrgPnodeAllocation.maxMWAllocation
range: ActivePower
required: false
multivalued: false
description: "Maximum MW for the Source/Sink for the Allocation \r\n"
Pnode:
slot_uri: cim:OrgPnodeAllocation.Pnode
range: Pnode
required: true
multivalued: false
PnodeResults:
class_uri: cim:PnodeResults
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: "Provides the total price, the cost component, the loss component,\
\ and the congestion component for Pnodes for the forward and real time markets.\
\ There are several prices produced based on the run type (MPM, RUC, Pricing,\
\ or Scheduling/Dispatch).\r\n"
attributes:
congestLMP:
slot_uri: cim:PnodeResults.congestLMP
range: float
required: false
multivalued: false
description: "Congestion component of Location Marginal Price (LMP) in monetary\
\ units per MW.\r\n"
costLMP:
slot_uri: cim:PnodeResults.costLMP
range: float
required: false
multivalued: false
description: "Cost component of Locational Marginal Pricing (LMP) in monetary\
\ units per MW.\r\n"
lossLMP:
slot_uri: cim:PnodeResults.lossLMP
range: float
required: false
multivalued: false
description: "Loss component of Location Marginal Price (LMP) in monetary\
\ units per MW.\r\n"
marginalClearingPrice:
slot_uri: cim:PnodeResults.marginalClearingPrice
range: float
required: false
multivalued: false
description: "Locational Marginal Price (LMP) ($/MWh)\r\n"
scheduledMW:
slot_uri: cim:PnodeResults.scheduledMW
range: float
required: false
multivalued: false
description: "total MW schedule at the pnode\r\n"
updateTimeStamp:
slot_uri: cim:PnodeResults.updateTimeStamp
range: date
required: false
multivalued: false
updateType:
slot_uri: cim:PnodeResults.updateType
range: MQSCHGType
required: false
multivalued: false
updateUser:
slot_uri: cim:PnodeResults.updateUser
range: string
required: false
multivalued: false
Pnode:
slot_uri: cim:PnodeResults.Pnode
range: Pnode
required: false
multivalued: false
PnodeClearing:
slot_uri: cim:PnodeResults.PnodeClearing
range: PnodeClearing
required: false
multivalued: false
PnodeClearing:
class_uri: cim:PnodeClearing
is_a: MarketFactors
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: "Pricing node clearing results posted for a given settlement period.\r\
\n"
attributes:
CommodityPrice:
slot_uri: cim:PnodeClearing.CommodityPrice
range: CommodityPrice
required: false
multivalued: true
PnodeResults:
slot_uri: cim:PnodeClearing.PnodeResults
range: PnodeResults
required: true
multivalued: true
CommodityPrice:
class_uri: cim:CommodityPrice
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: The CommodityPrice class is used to define the price of a commodity
during a given time interval. The interval may be long, e.g. a year, or very
short, e.g. 5 minutes. There will be many instances of the CommodityPrice class
for each instance of the CommodityDefinition to which it is associated. Note
that there may be more than once price associated with a given interval and
these variances are described by the association (or associations) with the
PriceDescriptor class.
attributes:
timeIntervalPeriod:
slot_uri: cim:CommodityPrice.timeIntervalPeriod
range: DateTimeInterval
required: false
multivalued: false
description: The time interval over which the CommodityPrice is valid, using
the standard conventions associated with the DateTimeInterval class.
value:
slot_uri: cim:CommodityPrice.value
range: float
required: false
multivalued: false
description: The price of the Commodity, expressed as a floating point value
with the currency and unit of measure defined in the associated CommodityDefinition
class.
PriceDescriptor:
slot_uri: cim:CommodityPrice.PriceDescriptor
range: PriceDescriptor
required: true
multivalued: false
CommodityDefinition:
slot_uri: cim:CommodityPrice.CommodityDefinition
range: CommodityDefinition
required: true
multivalued: false
PnodeClearing:
slot_uri: cim:CommodityPrice.PnodeClearing
range: PnodeClearing
required: false
multivalued: false
PriceDescriptor:
class_uri: cim:PriceDescriptor
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: The price of a Commodity during a given time interval may change
over time. For example, a price may be forecasted a year ahead, a month ahead,
a day ahead, an hour ahead, and in real time; this is defined using the MarketType.
Additionally a price may have one or more components. For example, a locational
marginal energy price may be the arithmetic sum of the system price, the congestion
price, and the loss price. The priceType enumeration is used determine if the
price is the complete price (priceType="total") or one of potentially many constituent
components.
attributes:
marketType:
slot_uri: cim:PriceDescriptor.marketType
range: MarketType
required: false
multivalued: false
description: The time frame for the price, using the standard conventions
associated with the MarketType enumeration.
priceType:
slot_uri: cim:PriceDescriptor.priceType
range: PriceTypeKind
required: false
multivalued: false
description: The "kind" of price being described. In general, the priceType
will either be "total" to signify that the price is the price paid to buy
or sell the commodity, sometimes referred to as an "all-in" price, or one
of potentially many components.
CommodityPrice:
slot_uri: cim:PriceDescriptor.CommodityPrice
range: CommodityPrice
required: true
multivalued: true
ExPostPricingResults:
class_uri: cim:ExPostPricingResults
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: "Model of ex-post pricing of nodes. Includes LMP information, pnode\
\ based.\r\n"
attributes:
congestLMP:
slot_uri: cim:ExPostPricingResults.congestLMP
range: float
required: false
multivalued: false
description: "Congestion component of Location Marginal Price (LMP) in monetary\
\ units per MW; congestion component of the hourly LMP at a specific pricing\
\ node \r\nAttribute Usage: Result of the Security, Pricing, and Dispatch(SPD)/Simultaneous\
\ Feasibility Test(SFT) software and denotes the hourly congestion component\
\ of LMP for each pricing node.\r\n"
lmp:
slot_uri: cim:ExPostPricingResults.lmp
range: float
required: false
multivalued: false
description: "5 min weighted average LMP; the Location Marginal Price of the\
\ Pnode for which price calculation is carried out. \r\nAttribute Usage:\
\ 5 min weighted average LMP to be displayed on UI\r\n"
lossLMP:
slot_uri: cim:ExPostPricingResults.lossLMP
range: float
required: false
multivalued: false
description: "Loss component of Location Marginal Price (LMP) in monetary\
\ units per MW; loss component of the hourly LMP at a specific pricing node\
\ \r\nAttribute Usage: Result of the Security, Pricing, and Dispatch(SPD)/Simultaneous\
\ Feasibility Test(SFT) software and denotes the hourly loss component of\
\ LMP for each pricing node.\r\n"
ExPostPricing:
slot_uri: cim:ExPostPricingResults.ExPostPricing
range: ExPostPricing
required: true
multivalued: false
Pnode:
slot_uri: cim:ExPostPricingResults.Pnode
range: Pnode
required: true
multivalued: false
ExPostPricing:
class_uri: cim:ExPostPricing
is_a: MarketFactors
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: "Model of ex-post pricing of nodes.\r\n"
attributes:
energyPrice:
slot_uri: cim:ExPostPricing.energyPrice
range: float
required: false
multivalued: false
description: "market energy price\r\n"
ExPostResults:
slot_uri: cim:ExPostPricing.ExPostResults
range: ExPostPricingResults
required: false
multivalued: true
TradingHubValues:
class_uri: cim:TradingHubValues
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketQualitySystem
description: "Models prices at Trading Hubs.\r\n"
attributes:
price:
slot_uri: cim:TradingHubValues.price
range: float
required: false
multivalued: false
description: "Utilizes the Market type. For DA, the price is hourly. For RTM\
\ the price is a 5 minute price.\r\n"
AggregatedPnode:
slot_uri: cim:TradingHubValues.AggregatedPnode
range: AggregatedPnode
required: true
multivalued: false
TradingHubPrice:
slot_uri: cim:TradingHubValues.TradingHubPrice
range: TradingHubPrice
required: true
multivalued: false
TradingHubPrice:
class_uri: cim:TradingHubPrice
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketQualitySystem
description: "Models prices at Trading Hubs, interval based.\r\n"
attributes:
intervalStartTime:
slot_uri: cim:TradingHubPrice.intervalStartTime
range: date
required: false
multivalued: false
marketType:
slot_uri: cim:TradingHubPrice.marketType
range: MarketType
required: false
multivalued: false
updateTimeStamp:
slot_uri: cim:TradingHubPrice.updateTimeStamp
range: date
required: false
multivalued: false
updateUser:
slot_uri: cim:TradingHubPrice.updateUser
range: string
required: false
multivalued: false
TradingHubValues:
slot_uri: cim:TradingHubPrice.TradingHubValues
range: TradingHubValues
required: true
multivalued: true
MktCombinedCyclePlant:
class_uri: cim:MktCombinedCyclePlant
is_a: CombinedCyclePlant
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: "Subclass of Production: CombinedCyclePlant from IEC 61970 package.\r\
\nA set of combustion turbines and steam turbines where the exhaust heat from\
\ the combustion turbines is recovered to make steam for the steam turbines,\
\ resulting in greater overall plant efficiency."
attributes:
AggregatedPnode:
slot_uri: cim:MktCombinedCyclePlant.AggregatedPnode
range: AggregatedPnode
required: false
multivalued: false
CombinedCycleLogicalConfiguration:
slot_uri: cim:MktCombinedCyclePlant.CombinedCycleLogicalConfiguration
range: CombinedCycleLogicalConfiguration
required: true
multivalued: true
CombinedCycleLogicalConfiguration:
class_uri: cim:CombinedCycleLogicalConfiguration
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: "Logical Configuration of a Combined Cycle plant.\r\n\r\nOperating\
\ Combined Cycle Plant (CCP) configurations are represented as Logical CCP Resources.\
\ Logical representation shall be used for Market applications to optimize and\
\ control Market Operations. Logical representation is also necessary for controlling\
\ the number of CCP configurations and to temper performance issues that may\
\ otherwise occur. \r\n\r\nFor example,(2CT configuration),(1CT + 1ST configuration)\
\ are examples of logical configuration, without specifying the specific CT\
\ and ST participating in the configuration."
attributes:
CombinedCycleConfiguration:
slot_uri: cim:CombinedCycleLogicalConfiguration.CombinedCycleConfiguration
range: CombinedCycleConfiguration
required: true
multivalued: true
MktCombinedCyclePlant:
slot_uri: cim:CombinedCycleLogicalConfiguration.MktCombinedCyclePlant
range: MktCombinedCyclePlant
required: false
multivalued: false
CombinedCycleConfiguration:
class_uri: cim:CombinedCycleConfiguration
is_a: RegisteredGenerator
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: "Configuration options for combined cycle units.\r\nFor example,\
\ a Combined Cycle with (CT1, CT2, ST1) will have (CT1, ST1) and (CT2, ST1)\
\ configurations as part of(1CT + 1STlogicalconfiguration)."
attributes:
primaryConfiguration:
slot_uri: cim:CombinedCycleConfiguration.primaryConfiguration
range: boolean
required: false
multivalued: false
description: Whether this CombinedCycleConfiguration is the primary configuration
in the associated Logical configuration?
ShutdownFlag:
slot_uri: cim:CombinedCycleConfiguration.ShutdownFlag
range: boolean
required: false
multivalued: false
description: Whether Combined Cycle Plant can be shut-down in this Configuration?
StartupFlag:
slot_uri: cim:CombinedCycleConfiguration.StartupFlag
range: boolean
required: false
multivalued: false
description: "Whether Combined Cycle Plant can be started in this Logical\
\ Configuration?\r\n"
FromTransitionState:
slot_uri: cim:CombinedCycleConfiguration.FromTransitionState
range: CombinedCycleTransitionState
required: false
multivalued: true
ToTransitionState:
slot_uri: cim:CombinedCycleConfiguration.ToTransitionState
range: CombinedCycleTransitionState
required: false
multivalued: true
CombinedCycleConfigurationMember:
slot_uri: cim:CombinedCycleConfiguration.CombinedCycleConfigurationMember
range: CombinedCycleConfigurationMember
required: false
multivalued: true
CombinedCycleLogicalConfiguration:
slot_uri: cim:CombinedCycleConfiguration.CombinedCycleLogicalConfiguration
range: CombinedCycleLogicalConfiguration
required: false
multivalued: false
CombinedCycleTransitionState:
class_uri: cim:CombinedCycleTransitionState
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: Defines the available from and to Transition States for the Combine
Cycle Configurations.
attributes:
upTransition:
slot_uri: cim:CombinedCycleTransitionState.upTransition
range: boolean
required: false
multivalued: false
description: "Flag indicating whether this is an UP transition.\r\nIf not,\
\ it is a DOWN transition."
FromConfiguration:
slot_uri: cim:CombinedCycleTransitionState.FromConfiguration
range: CombinedCycleConfiguration
required: true
multivalued: false
ToConfiguration:
slot_uri: cim:CombinedCycleTransitionState.ToConfiguration
range: CombinedCycleConfiguration
required: true
multivalued: false
CombinedCycleConfigurationMember:
class_uri: cim:CombinedCycleConfigurationMember
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: Configuration Member of CCP Configuration.
attributes:
primary:
slot_uri: cim:CombinedCycleConfigurationMember.primary
range: boolean
required: false
multivalued: false
description: "primary configuration.\r\n"
steam:
slot_uri: cim:CombinedCycleConfigurationMember.steam
range: boolean
required: false
multivalued: false
description: "Steam plant.\r\n"
MktThermalGeneratingUnit:
slot_uri: cim:CombinedCycleConfigurationMember.MktThermalGeneratingUnit
range: MktThermalGeneratingUnit
required: true
multivalued: false
CombinedCycleConfiguration:
slot_uri: cim:CombinedCycleConfigurationMember.CombinedCycleConfiguration
range: CombinedCycleConfiguration
required: true
multivalued: false
MktThermalGeneratingUnit:
class_uri: cim:MktThermalGeneratingUnit
is_a: ThermalGeneratingUnit
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: Subclass of ThermalGeneratingUnit from Production Package in IEC
61970.
attributes:
CombinedCycleConfigurationMember:
slot_uri: cim:MktThermalGeneratingUnit.CombinedCycleConfigurationMember
range: CombinedCycleConfigurationMember
required: false
multivalued: true
MPMTestResults:
class_uri: cim:MPMTestResults
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: "Provides the outcome and margin percent (as appropriate) result\
\ data for the MPM tests. There are relationships to Zone for Designated Congestion\
\ Area Tests, CurveSchedData for bid segment tests, to the SubControlArea for\
\ the system wide level tests, and Pnodes for the LMPM impact tests.\r\n"
attributes:
marginPercent:
slot_uri: cim:MPMTestResults.marginPercent
range: PerCent
required: false
multivalued: false
description: "Used to show the Margin % result of the Impact test\r\n"
outcome:
slot_uri: cim:MPMTestResults.outcome
range: MPMTestOutcome
required: false
multivalued: false
description: 'The results of the test. For the Price, Impact, and Conduct
tests, typical values are NA, Pass, Fail, Disable, or Skip. '
MPMClearing:
slot_uri: cim:MPMTestResults.MPMClearing
range: MPMClearing
required: false
multivalued: false
MPMTestCategory:
slot_uri: cim:MPMTestResults.MPMTestCategory
range: MPMTestCategory
required: true
multivalued: false
AggregatedPnode:
slot_uri: cim:MPMTestResults.AggregatedPnode
range: AggregatedPnode
required: true
multivalued: false
MPMClearing:
class_uri: cim:MPMClearing
is_a: MarketFactors
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: "Model of results of Market Power tests, and possible mitigation.\
\ Interval based.\r\n"
attributes:
LMPMFinalFlag:
slot_uri: cim:MPMClearing.LMPMFinalFlag
range: YesNo
required: false
multivalued: false
mitigationOccuredFlag:
slot_uri: cim:MPMClearing.mitigationOccuredFlag
range: YesNo
required: false
multivalued: false
SMPMFinalFlag:
slot_uri: cim:MPMClearing.SMPMFinalFlag
range: YesNo
required: false
multivalued: false
MPMTestResults:
slot_uri: cim:MPMClearing.MPMTestResults
range: MPMTestResults
required: false
multivalued: true
BidHourlySchedule:
class_uri: cim:BidHourlySchedule
is_a: RegularIntervalSchedule
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ParticipantInterfaces
description: "Containment for bid hourly parameters that are not product dependent.\r\
\n"
attributes:
Bid:
slot_uri: cim:BidHourlySchedule.Bid
range: Bid
required: true
multivalued: false
EnergyMarket:
class_uri: cim:EnergyMarket
is_a: Market
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketPlan
description: Energy and Ancillary Market (e.g. Energy, Spinning Reserve, Non-Spinning
Reserve) with a description of the Market operation control parameters.
attributes:
MarketResults:
slot_uri: cim:EnergyMarket.MarketResults
range: MarketResults
required: false
multivalued: false
RegisteredResources:
slot_uri: cim:EnergyMarket.RegisteredResources
range: RegisteredResource
required: false
multivalued: true
RTO:
slot_uri: cim:EnergyMarket.RTO
range: RTO
required: false
multivalued: false
Settlements:
slot_uri: cim:EnergyMarket.Settlements
range: Settlement
required: false
multivalued: true
Bids:
slot_uri: cim:EnergyMarket.Bids
range: Bid
required: false
multivalued: true
MarketResults:
class_uri: cim:MarketResults
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: "This class holds elements that are single values for the entire\
\ market time horizon. That is, for the Day Ahead market, there is 1 value for\
\ each element, not hourly based. Is a summary of the market run.\r\n"
attributes:
ancillarySvcCost:
slot_uri: cim:MarketResults.ancillarySvcCost
range: float
required: false
multivalued: false
description: "Total AS Cost (i.e., payment) ($) over the time horizon\r\n"
contingentOperatingResAvail:
slot_uri: cim:MarketResults.contingentOperatingResAvail
range: YesNo
required: false
multivalued: false
description: Global Contingent Operating Reserve Availability Indicator (Yes/No)
energyCost:
slot_uri: cim:MarketResults.energyCost
range: float
required: false
multivalued: false
description: "Total Energy Cost ($) over the time horizon\r\n"
minimumLoadCost:
slot_uri: cim:MarketResults.minimumLoadCost
range: float
required: false
multivalued: false
description: "Total Minimum Load Cost ($) over the time horizon\r\n"
startUpCost:
slot_uri: cim:MarketResults.startUpCost
range: float
required: false
multivalued: false
description: "Total Start-up Cost ($) over the time horizon\r\n"
totalCost:
slot_uri: cim:MarketResults.totalCost
range: float
required: false
multivalued: false
description: "Total Cost (Energy + AS) cost ($) by over the time horizon\r\
\n"
totalRucCost:
slot_uri: cim:MarketResults.totalRucCost
range: float
required: false
multivalued: false
description: "The total RUC capacity cost for this interval\r\n"
EnergyMarket:
slot_uri: cim:MarketResults.EnergyMarket
range: EnergyMarket
required: true
multivalued: false
Settlement:
class_uri: cim:Settlement
is_a: Document
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: "Specifies a settlement run.\r\n"
attributes:
tradeDate:
slot_uri: cim:Settlement.tradeDate
range: date
required: false
multivalued: false
description: "The trade date on which the settlement is run. \r\n"
EnergyMarket:
slot_uri: cim:Settlement.EnergyMarket
range: EnergyMarket
required: false
multivalued: false
MajorChargeGroup:
slot_uri: cim:Settlement.MajorChargeGroup
range: MajorChargeGroup
required: true
multivalued: true
MarketInvoiceLineItem:
slot_uri: cim:Settlement.MarketInvoiceLineItem
range: MarketInvoiceLineItem
required: false
multivalued: true
MarketLedgerEntry:
slot_uri: cim:Settlement.MarketLedgerEntry
range: MarketLedgerEntry
required: false
multivalued: true
MajorChargeGroup:
class_uri: cim:MajorChargeGroup
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ParticipantInterfaces
description: "A Major Charge Group is the same as Invoice Type which provides\
\ the highest level of grouping for charge types configuration. Examples: Market,\
\ FERC, RMR.\r\n"
attributes:
effectiveDate:
slot_uri: cim:MajorChargeGroup.effectiveDate
range: date
required: false
multivalued: false
frequencyType:
slot_uri: cim:MajorChargeGroup.frequencyType
range: string
required: false
multivalued: false
invoiceType:
slot_uri: cim:MajorChargeGroup.invoiceType
range: string
required: false
multivalued: false
requireAutorun:
slot_uri: cim:MajorChargeGroup.requireAutorun
range: string
required: false
multivalued: false
revisionNumber:
slot_uri: cim:MajorChargeGroup.revisionNumber
range: string
required: false
multivalued: false
description: "Revision number for the major charge group\r\n"
runType:
slot_uri: cim:MajorChargeGroup.runType
range: string
required: false
multivalued: false
runVersion:
slot_uri: cim:MajorChargeGroup.runVersion
range: string
required: false
multivalued: false
terminationDate:
slot_uri: cim:MajorChargeGroup.terminationDate
range: date
required: false
multivalued: false
Settlement:
slot_uri: cim:MajorChargeGroup.Settlement
range: Settlement
required: false
multivalued: true
MktScheduledEvent:
slot_uri: cim:MajorChargeGroup.MktScheduledEvent
range: MarketScheduledEvent
required: false
multivalued: true
ChargeType:
slot_uri: cim:MajorChargeGroup.ChargeType
range: ChargeType
required: false
multivalued: true
description: A MajorChargeGroup can have 0-n ChargeType. A ChargeType can
associate to 0-n MajorChargeGroup.
MarketInvoice:
slot_uri: cim:MajorChargeGroup.MarketInvoice
range: MarketInvoice
required: false
multivalued: true
MarketInvoice:
class_uri: cim:MarketInvoice
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketOpCommon
description: "A roll up of invoice line items. The whole invoice has a due date\
\ and amount to be paid, with information such as customer, banks etc. being\
\ obtained through associations. The invoice roll up is based on individual\
\ line items that each contain amounts and descriptions for specific services\
\ or products.\r\n"
attributes:
amount:
slot_uri: cim:MarketInvoice.amount
range: Money
required: false
multivalued: false
description: Total amount due on this invoice based on line items and applicable
adjustments.
billMediaKind:
slot_uri: cim:MarketInvoice.billMediaKind
range: MktBillMediaKind
required: false
multivalued: false
description: "Kind of media by which the CustomerBillingInfo was delivered.\r\
\n"
dueDate:
slot_uri: cim:MarketInvoice.dueDate
range: date
required: false
multivalued: false
description: Calculated date upon which the Invoice amount is due.
kind:
slot_uri: cim:MarketInvoice.kind
range: MktAccountKind
required: false
multivalued: false
description: "Kind of invoice (default is 'sales').\r\n"
mailedDate:
slot_uri: cim:MarketInvoice.mailedDate
range: date
required: false
multivalued: false
description: Date on which the customer billing statement/invoice was printed/mailed.
proForma:
slot_uri: cim:MarketInvoice.proForma
range: boolean
required: false
multivalued: false
description: True if payment is to be paid by a Customer to accept a particular
ErpQuote (with associated Design) and have work initiated, at which time
an associated ErpInvoice should automatically be generated. EprPayment.subjectStatus
satisfies terms specificed in the ErpQuote.
referenceNumber:
slot_uri: cim:MarketInvoice.referenceNumber
range: string
required: false
multivalued: false
description: Number of an invoice to be reference by this invoice.
transactionDateTime:
slot_uri: cim:MarketInvoice.transactionDateTime
range: date
required: false
multivalued: false
description: Date and time when the invoice is issued.
transferType:
slot_uri: cim:MarketInvoice.transferType
range: string
required: false
multivalued: false
description: Type of invoice transfer.
MajorChargeGroup:
slot_uri: cim:MarketInvoice.MajorChargeGroup
range: MajorChargeGroup
required: true
multivalued: true
MarketInvoiceLineItems:
slot_uri: cim:MarketInvoice.MarketInvoiceLineItems
range: MarketInvoiceLineItem
required: false
multivalued: true
MarketInvoiceLineItem:
class_uri: cim:MarketInvoiceLineItem
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketOpCommon
description: An individual line item on an invoice.
attributes:
billPeriod:
slot_uri: cim:MarketInvoiceLineItem.billPeriod
range: DateTimeInterval
required: false
multivalued: false
description: Bill period for the line item.
glAccount:
slot_uri: cim:MarketInvoiceLineItem.glAccount
range: string
required: false
multivalued: false
description: General Ledger account code, shall be a valid combination.
glDateTime:
slot_uri: cim:MarketInvoiceLineItem.glDateTime
range: date
required: false
multivalued: false
description: 'Date and time line item will be posted to the General Ledger. '
kind:
slot_uri: cim:MarketInvoiceLineItem.kind
range: MktInvoiceLineItemKind
required: false
multivalued: false
description: "Kind of line item.\r\n"
lineAmount:
slot_uri: cim:MarketInvoiceLineItem.lineAmount
range: float
required: false
multivalued: false
description: Amount due for this line item.
lineNumber:
slot_uri: cim:MarketInvoiceLineItem.lineNumber
range: string
required: false
multivalued: false
description: Line item number on invoice statement.
lineVersion:
slot_uri: cim:MarketInvoiceLineItem.lineVersion
range: string
required: false
multivalued: false
description: Version number of the bill run.
netAmount:
slot_uri: cim:MarketInvoiceLineItem.netAmount
range: float
required: false
multivalued: false
description: Net line item charge amount.
previousAmount:
slot_uri: cim:MarketInvoiceLineItem.previousAmount
range: float
required: false
multivalued: false
description: 'Previous line item charge amount. '
MarketInvoice:
slot_uri: cim:MarketInvoiceLineItem.MarketInvoice
range: MarketInvoice
required: true
multivalued: false
ContainerMarketInvoiceLineItem:
slot_uri: cim:MarketInvoiceLineItem.ContainerMarketInvoiceLineItem
range: MarketInvoiceLineItem
required: false
multivalued: false
Settlement:
slot_uri: cim:MarketInvoiceLineItem.Settlement
range: Settlement
required: false
multivalued: true
ComponentMarketInvoiceLineItems:
slot_uri: cim:MarketInvoiceLineItem.ComponentMarketInvoiceLineItems
range: MarketInvoiceLineItem
required: false
multivalued: true
MarketScheduledEvent:
class_uri: cim:MarketScheduledEvent
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ParticipantInterfaces
description: Signifies an event to trigger one or more activities, such as reading
a meter, recalculating a bill, requesting work, when generating units shall
be scheduled for maintenance, when a transformer is scheduled to be refurbished,
etc.
attributes:
category:
slot_uri: cim:MarketScheduledEvent.category
range: string
required: false
multivalued: false
description: Category of scheduled event.
duration:
slot_uri: cim:MarketScheduledEvent.duration
range: Seconds
required: false
multivalued: false
description: Duration of the scheduled event, for example, the time to ramp
between values.
status:
slot_uri: cim:MarketScheduledEvent.status
range: Status
required: false
multivalued: false
MajorChargeGroup:
slot_uri: cim:MarketScheduledEvent.MajorChargeGroup
range: MajorChargeGroup
required: false
multivalued: false
ChargeType:
class_uri: cim:ChargeType
is_a: Document
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ParticipantInterfaces
description: "Charge Type is the basic level configuration for settlement to process\
\ specific charges for invoicing purpose. Examples such as: Day Ahead Spinning\
\ Reserve Default Invoice Interest Charge, etc.\r\n"
attributes:
chargeOrder:
slot_uri: cim:ChargeType.chargeOrder
range: string
required: false
multivalued: false
chargeVersion:
slot_uri: cim:ChargeType.chargeVersion
range: string
required: false
multivalued: false
effectiveDate:
slot_uri: cim:ChargeType.effectiveDate
range: date
required: false
multivalued: false
factor:
slot_uri: cim:ChargeType.factor
range: string
required: false
multivalued: false
frequencyType:
slot_uri: cim:ChargeType.frequencyType
range: string
required: false
multivalued: false
terminationDate:
slot_uri: cim:ChargeType.terminationDate
range: date
required: false
multivalued: false
totalInterval:
slot_uri: cim:ChargeType.totalInterval
range: string
required: false
multivalued: false
ChargeGroup:
slot_uri: cim:ChargeType.ChargeGroup
range: ChargeGroup
required: false
multivalued: true
description: A ChargeGroup can have 0-n ChargeType. A ChargeType can associate
to 0-n ChargeGroup.
ChargeComponents:
slot_uri: cim:ChargeType.ChargeComponents
range: ChargeComponent
required: false
multivalued: true
description: A ChargeType can have 0-n ChargeComponent and a ChargeComponent
can associate to 0-n ChargeType
MktUserAttribute:
slot_uri: cim:ChargeType.MktUserAttribute
range: MktUserAttribute
required: false
multivalued: true
MajorChargeGroup:
slot_uri: cim:ChargeType.MajorChargeGroup
range: MajorChargeGroup
required: false
multivalued: true
description: A MajorChargeGroup can have 0-n ChargeType. A ChargeType can
associate to 0-n MajorChargeGroup.
ChargeGroup:
class_uri: cim:ChargeGroup
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ParticipantInterfaces
description: "Charge Group is the grouping of Charge Types for settlement invoicing\
\ purpose. Examples such as Ancillary Services, Interests, etc.\r\n"
attributes:
effectiveDate:
slot_uri: cim:ChargeGroup.effectiveDate
range: date
required: false
multivalued: false
marketCode:
slot_uri: cim:ChargeGroup.marketCode
range: string
required: false
multivalued: false
terminationDate:
slot_uri: cim:ChargeGroup.terminationDate
range: date
required: false
multivalued: false
ChargeGroupParent:
slot_uri: cim:ChargeGroup.ChargeGroupParent
range: ChargeGroup
required: false
multivalued: false
description: A ChargeGroup instance can have relationships with other ChargeGroup
instances.
MktUserAttribute:
slot_uri: cim:ChargeGroup.MktUserAttribute
range: MktUserAttribute
required: false
multivalued: true
ChargeGroupChild:
slot_uri: cim:ChargeGroup.ChargeGroupChild
range: ChargeGroup
required: false
multivalued: true
description: A ChargeGroup instance can have relationships with other ChargeGroup
instances.
ChargeType:
slot_uri: cim:ChargeGroup.ChargeType
range: ChargeType
required: false
multivalued: true
description: A ChargeGroup can have 0-n ChargeType. A ChargeType can associate
to 0-n ChargeGroup.
MktUserAttribute:
class_uri: cim:MktUserAttribute
is_a: UserAttribute
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketOpCommon
description: Subclass of IEC61968:Domain2:UserAttribute.
attributes:
BillDeterminant:
slot_uri: cim:MktUserAttribute.BillDeterminant
range: BillDeterminant
required: false
multivalued: true
AttributeProperty:
slot_uri: cim:MktUserAttribute.AttributeProperty
range: AttributeProperty
required: false
multivalued: true
ChargeGroup:
slot_uri: cim:MktUserAttribute.ChargeGroup
range: ChargeGroup
required: false
multivalued: true
PassThroughBill:
slot_uri: cim:MktUserAttribute.PassThroughBill
range: PassThroughBill
required: false
multivalued: true
ChargeType:
slot_uri: cim:MktUserAttribute.ChargeType
range: ChargeType
required: false
multivalued: true
MarketStatementLineItem:
slot_uri: cim:MktUserAttribute.MarketStatementLineItem
range: MarketStatementLineItem
required: false
multivalued: true
BillDeterminant:
class_uri: cim:BillDeterminant
is_a: Document
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: "Models various charges to support billing and settlement.\r\n"
attributes:
calculationLevel:
slot_uri: cim:BillDeterminant.calculationLevel
range: string
required: false
multivalued: false
description: "Level in charge calculation order.\r\n"
configVersion:
slot_uri: cim:BillDeterminant.configVersion
range: string
required: false
multivalued: false
description: "The version of configuration of calculation logic in the settlement.\r\
\n"
deleteStatus:
slot_uri: cim:BillDeterminant.deleteStatus
range: string
required: false
multivalued: false
effectiveDate:
slot_uri: cim:BillDeterminant.effectiveDate
range: date
required: false
multivalued: false
exception:
slot_uri: cim:BillDeterminant.exception
range: string
required: false
multivalued: false
factor:
slot_uri: cim:BillDeterminant.factor
range: string
required: false
multivalued: false
frequency:
slot_uri: cim:BillDeterminant.frequency
range: string
required: false
multivalued: false
numberInterval:
slot_uri: cim:BillDeterminant.numberInterval
range: integer
required: false
multivalued: false
description: "Number of intervals of bill determiant in trade day, e.g. 300\
\ for five minute intervals.\r\n"
offset:
slot_uri: cim:BillDeterminant.offset
range: string
required: false
multivalued: false
precisionLevel:
slot_uri: cim:BillDeterminant.precisionLevel
range: string
required: false
multivalued: false
description: "The level of precision in the current value. \r\n"
primaryYN:
slot_uri: cim:BillDeterminant.primaryYN
range: string
required: false
multivalued: false
referenceFlag:
slot_uri: cim:BillDeterminant.referenceFlag
range: string
required: false
multivalued: false
reportable:
slot_uri: cim:BillDeterminant.reportable
range: string
required: false
multivalued: false
roundOff:
slot_uri: cim:BillDeterminant.roundOff
range: string
required: false
multivalued: false
source:
slot_uri: cim:BillDeterminant.source
range: string
required: false
multivalued: false
terminationDate:
slot_uri: cim:BillDeterminant.terminationDate
range: date
required: false
multivalued: false
unitOfMeasure:
slot_uri: cim:BillDeterminant.unitOfMeasure
range: string
required: false
multivalued: false
description: "The UOM for the current value of the Bill Determinant. \r\n"
MktUserAttribute:
slot_uri: cim:BillDeterminant.MktUserAttribute
range: MktUserAttribute
required: false
multivalued: true
ChargeProfileData:
slot_uri: cim:BillDeterminant.ChargeProfileData
range: ChargeProfileData
required: false
multivalued: true
ChargeProfile:
slot_uri: cim:BillDeterminant.ChargeProfile
range: ChargeProfile
required: false
multivalued: false
ChargeComponents:
slot_uri: cim:BillDeterminant.ChargeComponents
range: ChargeComponent
required: false
multivalued: true
description: A BillDeterminant can have 0-n ChargeComponent and a ChargeComponent
can associate to 0-n BillDeterminant.
ChargeProfile:
class_uri: cim:ChargeProfile
is_a: Profile
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: "A type of profile for financial charges.\r\n"
attributes:
frequency:
slot_uri: cim:ChargeProfile.frequency
range: string
required: false
multivalued: false
description: "The calculation frequency, daily or monthly. \r\n"
numberInterval:
slot_uri: cim:ChargeProfile.numberInterval
range: integer
required: false
multivalued: false
description: "The number of intervals in the profile data.\r\n"
type:
slot_uri: cim:ChargeProfile.type
range: string
required: false
multivalued: false
description: "The type of profile. It could be amount, price, or quantity.\r\
\n"
unitOfMeasure:
slot_uri: cim:ChargeProfile.unitOfMeasure
range: string
required: false
multivalued: false
description: "The unit of measure applied to the value attribute of the profile\
\ data.\r\n"
BillDeterminant:
slot_uri: cim:ChargeProfile.BillDeterminant
range: BillDeterminant
required: false
multivalued: false
PassTroughBill:
slot_uri: cim:ChargeProfile.PassTroughBill
range: PassThroughBill
required: false
multivalued: false
ChargeProfileData:
slot_uri: cim:ChargeProfile.ChargeProfileData
range: ChargeProfileData
required: false
multivalued: true
Bid:
slot_uri: cim:ChargeProfile.Bid
range: Bid
required: false
multivalued: false
PassThroughBill:
class_uri: cim:PassThroughBill
is_a: Document
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: "Pass Through Bill is used for:\r\n1)Two sided charge transactions\
\ with or without ISO involvement\r\n2) Specific direct charges or payments\
\ that are calculated outside or provided directly to settlements\r\n3) Specific\
\ charge bill determinants that are externally supplied and used in charge calculations\r\
\n"
attributes:
adjustedAmount:
slot_uri: cim:PassThroughBill.adjustedAmount
range: Money
required: false
multivalued: false
amount:
slot_uri: cim:PassThroughBill.amount
range: Money
required: false
multivalued: false
description: "The charge amount of the product/service.\r\n"
billedTo:
slot_uri: cim:PassThroughBill.billedTo
range: string
required: false
multivalued: false
description: "The company to which the PTB transaction is billed.\r\n"
billEnd:
slot_uri: cim:PassThroughBill.billEnd
range: date
required: false
multivalued: false
description: "Bill period end date\r\n"
billRunType:
slot_uri: cim:PassThroughBill.billRunType
range: string
required: false
multivalued: false
description: "The settlement run type, for example: prelim, final, and rerun.\r\
\n"
billStart:
slot_uri: cim:PassThroughBill.billStart
range: date
required: false
multivalued: false
description: "Bill period start date\r\n"
effectiveDate:
slot_uri: cim:PassThroughBill.effectiveDate
range: date
required: false
multivalued: false
description: "The effective date of the transaction\r\n"
isDisputed:
slot_uri: cim:PassThroughBill.isDisputed
range: boolean
required: false
multivalued: false
description: "Disputed transaction indicator \r\n"
isProfiled:
slot_uri: cim:PassThroughBill.isProfiled
range: boolean
required: false
multivalued: false
description: "A flag indicating whether there is a profile data associated\
\ with the PTB.\r\n"
paidTo:
slot_uri: cim:PassThroughBill.paidTo
range: string
required: false
multivalued: false
description: "The company to which the PTB transaction is paid.\r\n"
previousEnd:
slot_uri: cim:PassThroughBill.previousEnd
range: date
required: false
multivalued: false
description: "The previous bill period end date\r\n"
previousStart:
slot_uri: cim:PassThroughBill.previousStart
range: date
required: false
multivalued: false
description: "The previous bill period start date\r\n"
price:
slot_uri: cim:PassThroughBill.price
range: Money
required: false
multivalued: false
description: "The price of product/service.\r\n"
productCode:
slot_uri: cim:PassThroughBill.productCode
range: string
required: false
multivalued: false
description: "The product identifier for determining the charge type of the\
\ transaction. \r\n"
providedBy:
slot_uri: cim:PassThroughBill.providedBy
range: string
required: false
multivalued: false
description: "The company by which the PTB transaction service is provided.\r\
\n"
quantity:
slot_uri: cim:PassThroughBill.quantity
range: FloatQuantity
required: false
multivalued: false
description: "The product quantity.\r\n"
serviceEnd:
slot_uri: cim:PassThroughBill.serviceEnd
range: date
required: false
multivalued: false
description: "The end date of service provided, if periodic.\r\n"
serviceStart:
slot_uri: cim:PassThroughBill.serviceStart
range: date
required: false
multivalued: false
description: "The start date of service provided, if periodic. \r\n"
soldTo:
slot_uri: cim:PassThroughBill.soldTo
range: string
required: false
multivalued: false
description: "The company to which the PTB transaction is sold.\r\n"
taxAmount:
slot_uri: cim:PassThroughBill.taxAmount
range: Money
required: false
multivalued: false
description: "The tax on services taken.\r\n"
timeZone:
slot_uri: cim:PassThroughBill.timeZone
range: string
required: false
multivalued: false
description: "The time zone code\r\n"
tradeDate:
slot_uri: cim:PassThroughBill.tradeDate
range: date
required: false
multivalued: false
description: "The trade date\r\n"
transactionDate:
slot_uri: cim:PassThroughBill.transactionDate
range: date
required: false
multivalued: false
description: "The date the transaction occurs.\r\n"
transactionType:
slot_uri: cim:PassThroughBill.transactionType
range: string
required: false
multivalued: false
description: "The type of transaction. For example, charge customer, bill\
\ customer, matching AR/AP, or bill determinant \r\n"
MktUserAttribute:
slot_uri: cim:PassThroughBill.MktUserAttribute
range: MktUserAttribute
required: false
multivalued: true
MarketStatementLineItem:
slot_uri: cim:PassThroughBill.MarketStatementLineItem
range: MarketStatementLineItem
required: false
multivalued: false
ChargeProfiles:
slot_uri: cim:PassThroughBill.ChargeProfiles
range: ChargeProfile
required: false
multivalued: true
MarketStatementLineItem:
class_uri: cim:MarketStatementLineItem
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: An individual line item on an ISO settlement statement.
attributes:
currentAmount:
slot_uri: cim:MarketStatementLineItem.currentAmount
range: float
required: false
multivalued: false
description: "Current settlement amount.\r\n"
currentISOAmount:
slot_uri: cim:MarketStatementLineItem.currentISOAmount
range: float
required: false
multivalued: false
description: "Current ISO settlement amount.\r\n"
currentISOQuantity:
slot_uri: cim:MarketStatementLineItem.currentISOQuantity
range: float
required: false
multivalued: false
description: "Current ISO settlement quantity. \r\n"
currentPrice:
slot_uri: cim:MarketStatementLineItem.currentPrice
range: float
required: false
multivalued: false
description: "Current settlement price.\r\n"
currentQuantity:
slot_uri: cim:MarketStatementLineItem.currentQuantity
range: float
required: false
multivalued: false
description: "Current settlement quantity, subject to the UOM. \r\n"
intervalDate:
slot_uri: cim:MarketStatementLineItem.intervalDate
range: date
required: false
multivalued: false
description: "The date of which the settlement is run.\r\n"
intervalNumber:
slot_uri: cim:MarketStatementLineItem.intervalNumber
range: string
required: false
multivalued: false
description: "The number of intervals. \r\n"
netAmount:
slot_uri: cim:MarketStatementLineItem.netAmount
range: float
required: false
multivalued: false
description: "Net settlement amount.\r\n"
netISOAmount:
slot_uri: cim:MarketStatementLineItem.netISOAmount
range: float
required: false
multivalued: false
description: "Net ISO settlement amount.\r\n"
netISOQuantity:
slot_uri: cim:MarketStatementLineItem.netISOQuantity
range: float
required: false
multivalued: false
description: "Net ISO settlement quantity. \r\n"
netPrice:
slot_uri: cim:MarketStatementLineItem.netPrice
range: float
required: false
multivalued: false
description: "Net settlement price.\r\n"
netQuantity:
slot_uri: cim:MarketStatementLineItem.netQuantity
range: float
required: false
multivalued: false
description: "Net settlement quantity, subject to the UOM. \r\n"
previousAmount:
slot_uri: cim:MarketStatementLineItem.previousAmount
range: float
required: false
multivalued: false
description: "Previous settlement amount.\r\n"
previousISOAmount:
slot_uri: cim:MarketStatementLineItem.previousISOAmount
range: float
required: false
multivalued: false
description: "Previous ISO settlement amount.\r\n"
previousISOQuantity:
slot_uri: cim:MarketStatementLineItem.previousISOQuantity
range: float
required: false
multivalued: false
description: "Previous ISO settlement quantity. \r\n"
previousPrice:
slot_uri: cim:MarketStatementLineItem.previousPrice
range: float
required: false
multivalued: false
description: Previous settlement price.
previousQuantity:
slot_uri: cim:MarketStatementLineItem.previousQuantity
range: float
required: false
multivalued: false
description: "Previous settlement quantity, subject to the UOM. \r\n"
quantityUOM:
slot_uri: cim:MarketStatementLineItem.quantityUOM
range: string
required: false
multivalued: false
description: "The unit of measure for the quantity element of the line item.\
\ \r\n"
ContainerMarketStatementLineItem:
slot_uri: cim:MarketStatementLineItem.ContainerMarketStatementLineItem
range: MarketStatementLineItem
required: false
multivalued: false
MarketStatement:
slot_uri: cim:MarketStatementLineItem.MarketStatement
range: MarketStatement
required: true
multivalued: false
MktUserAttribute:
slot_uri: cim:MarketStatementLineItem.MktUserAttribute
range: MktUserAttribute
required: false
multivalued: true
ComponentMarketStatementLineItem:
slot_uri: cim:MarketStatementLineItem.ComponentMarketStatementLineItem
range: MarketStatementLineItem
required: false
multivalued: true
PassThroughBill:
slot_uri: cim:MarketStatementLineItem.PassThroughBill
range: PassThroughBill
required: false
multivalued: false
MarketStatement:
class_uri: cim:MarketStatement
is_a: Document
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: "A statement is a roll up of statement line items. Each statement\
\ along with its line items provide the details of specific charges at any given\
\ time. Used by Billing and Settlement.\r\n"
attributes:
end:
slot_uri: cim:MarketStatement.end
range: date
required: false
multivalued: false
description: "The end of a bill period.\r\n"
referenceNumber:
slot_uri: cim:MarketStatement.referenceNumber
range: string
required: false
multivalued: false
description: "The version number of previous statement (in the case of true\
\ up).\r\n"
start:
slot_uri: cim:MarketStatement.start
range: date
required: false
multivalued: false
description: "The start of a bill period.\r\n"
tradeDate:
slot_uri: cim:MarketStatement.tradeDate
range: date
required: false
multivalued: false
description: "The date of which Settlement is run.\r\n"
transactionDate:
slot_uri: cim:MarketStatement.transactionDate
range: date
required: false
multivalued: false
description: "The date of which this statement is issued. \r\n"
MarketStatementLineItem:
slot_uri: cim:MarketStatement.MarketStatementLineItem
range: MarketStatementLineItem
required: false
multivalued: true
ChargeProfileData:
class_uri: cim:ChargeProfileData
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: "Model of various charges associated with an energy profile to support\
\ billing and settlement.\r\n"
attributes:
sequence:
slot_uri: cim:ChargeProfileData.sequence
range: integer
required: false
multivalued: false
description: "The sequence number of the profile.\r\n"
timeStamp:
slot_uri: cim:ChargeProfileData.timeStamp
range: date
required: false
multivalued: false
description: "The date and time of an interval.\r\n"
value:
slot_uri: cim:ChargeProfileData.value
range: float
required: false
multivalued: false
description: "The value of an interval given a profile type (amount, price,\
\ or quantity), subject to the UOM. \r\n"
BillDeterminant:
slot_uri: cim:ChargeProfileData.BillDeterminant
range: BillDeterminant
required: false
multivalued: false
ChargeProfile:
slot_uri: cim:ChargeProfileData.ChargeProfile
range: ChargeProfile
required: false
multivalued: false
ChargeComponent:
class_uri: cim:ChargeComponent
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ParticipantInterfaces
description: "A Charge Component is a list of configurable charge quality items\
\ to feed into settlement calculation and/or bill determinants.\r\n"
attributes:
deleteStatus:
slot_uri: cim:ChargeComponent.deleteStatus
range: string
required: false
multivalued: false
effectiveDate:
slot_uri: cim:ChargeComponent.effectiveDate
range: date
required: false
multivalued: false
equation:
slot_uri: cim:ChargeComponent.equation
range: string
required: false
multivalued: false
message:
slot_uri: cim:ChargeComponent.message
range: string
required: false
multivalued: false
roundOff:
slot_uri: cim:ChargeComponent.roundOff
range: string
required: false
multivalued: false
sum:
slot_uri: cim:ChargeComponent.sum
range: string
required: false
multivalued: false
terminationDate:
slot_uri: cim:ChargeComponent.terminationDate
range: date
required: false
multivalued: false
type:
slot_uri: cim:ChargeComponent.type
range: string
required: false
multivalued: false
BillDeterminants:
slot_uri: cim:ChargeComponent.BillDeterminants
range: BillDeterminant
required: false
multivalued: true
description: A BillDeterminant can have 0-n ChargeComponent and a ChargeComponent
can associate to 0-n BillDeterminant.
ChargeTypes:
slot_uri: cim:ChargeComponent.ChargeTypes
range: ChargeType
required: false
multivalued: true
description: A ChargeType can have 0-n ChargeComponent and a ChargeComponent
can associate to 0-n ChargeType
AttributeProperty:
class_uri: cim:AttributeProperty
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ParticipantInterfaces
description: "Property for a particular attribute that contains name and value.\r\
\n"
attributes:
propertyName:
slot_uri: cim:AttributeProperty.propertyName
range: string
required: false
multivalued: false
propertyValue:
slot_uri: cim:AttributeProperty.propertyValue
range: string
required: false
multivalued: false
sequence:
slot_uri: cim:AttributeProperty.sequence
range: string
required: false
multivalued: false
MktUserAttribute:
slot_uri: cim:AttributeProperty.MktUserAttribute
range: MktUserAttribute
required: true
multivalued: false
MarketLedgerEntry:
class_uri: cim:MarketLedgerEntry
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketOpCommon
description: "Details of an individual entry in a ledger, which was posted from\
\ a journal on the posted date.\r\n"
attributes:
accountID:
slot_uri: cim:MarketLedgerEntry.accountID
range: string
required: false
multivalued: false
description: Account identifier for this entry.
accountKind:
slot_uri: cim:MarketLedgerEntry.accountKind
range: MktAccountKind
required: false
multivalued: false
description: "Kind of account for this entry.\r\n"
amount:
slot_uri: cim:MarketLedgerEntry.amount
range: Money
required: false
multivalued: false
description: The amount of the debit or credit for this account.
postedDateTime:
slot_uri: cim:MarketLedgerEntry.postedDateTime
range: date
required: false
multivalued: false
description: Date and time this entry was posted to the ledger.
status:
slot_uri: cim:MarketLedgerEntry.status
range: Status
required: false
multivalued: false
description: "Status of ledger entry.\r\n"
transactionDateTime:
slot_uri: cim:MarketLedgerEntry.transactionDateTime
range: date
required: false
multivalued: false
description: Date and time journal entry was recorded.
Settlement:
slot_uri: cim:MarketLedgerEntry.Settlement
range: Settlement
required: false
multivalued: true
MarketLedger:
slot_uri: cim:MarketLedgerEntry.MarketLedger
range: MarketLedger
required: true
multivalued: false
MarketLedger:
class_uri: cim:MarketLedger
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketOpCommon
description: "In accounting transactions, a ledger is a book containing accounts\
\ to which debits and credits are posted from journals, where transactions are\
\ initially recorded. Journal entries are periodically posted to the ledger.\
\ Ledger actual represents actual amounts by account within ledger within company\
\ or within business area. Actual amounts may be generated in a source application\
\ and then loaded to a specific ledger within the enterprise general ledger\
\ or budget application.\r\n"
attributes:
MarketLedgerEntries:
slot_uri: cim:MarketLedger.MarketLedgerEntries
range: MarketLedgerEntry
required: false
multivalued: true
MitigatedBidSegment:
class_uri: cim:MitigatedBidSegment
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: "Model of mitigated bid. Indicates segment of piece-wise linear bid,\
\ that has been mitigated.\r\n"
attributes:
intervalStartTime:
slot_uri: cim:MitigatedBidSegment.intervalStartTime
range: date
required: false
multivalued: false
segmentMW:
slot_uri: cim:MitigatedBidSegment.segmentMW
range: float
required: false
multivalued: false
description: "Mitigated bid segment MW value\r\n"
segmentNumber:
slot_uri: cim:MitigatedBidSegment.segmentNumber
range: integer
required: false
multivalued: false
description: "Mitigated Bid Segment Number\r\n"
thresholdType:
slot_uri: cim:MitigatedBidSegment.thresholdType
range: string
required: false
multivalued: false
Bid:
slot_uri: cim:MitigatedBidSegment.Bid
range: Bid
required: true
multivalued: false
MarketRole:
class_uri: cim:MarketRole
is_a: OrganisationRole
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketCommon
description: The external intended behavior played by a party within the electricity
market.
attributes:
type:
slot_uri: cim:MarketRole.type
range: string
required: false
multivalued: false
description: "The kind of market roles that can be played by parties for given\
\ domains within the electricity market. Types are flexible using dataType\
\ of string for free-entry of role types.\r\n"
MarketParticipant:
slot_uri: cim:MarketRole.MarketParticipant
range: MarketParticipant
required: false
multivalued: true
MarketPerson:
class_uri: cim:MarketPerson
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: General purpose information for name and other information to contact
people.
attributes:
category:
slot_uri: cim:MarketPerson.category
range: string
required: false
multivalued: false
description: "Category of this person relative to utility operations, classified\
\ according to the utility's corporate standards and practices. Examples\
\ include employee, contractor, agent, not affiliated, etc.\r\nThis field\
\ is not used to indicate whether this person is a customer of the utility.\
\ Often an employee or contractor is also a customer. Customer information\
\ is gained with relationship to Organisation and CustomerData. In similar\
\ fashion, this field does not indicate the various roles this person may\
\ fill as part of utility operations."
electronicAddressAlternate:
slot_uri: cim:MarketPerson.electronicAddressAlternate
range: ElectronicAddress
required: false
multivalued: false
description: "Alternate Electronic address.\r\n"
electronicAddressPrimary:
slot_uri: cim:MarketPerson.electronicAddressPrimary
range: ElectronicAddress
required: false
multivalued: false
description: "Primary Electronic address.\r\n"
firstName:
slot_uri: cim:MarketPerson.firstName
range: string
required: false
multivalued: false
description: Person's first name.
governmentID:
slot_uri: cim:MarketPerson.governmentID
range: string
required: false
multivalued: false
description: Unique identifier for person relative to its governing authority,
for example a federal tax identifier (such as a Social Security number in
the United States).
landlinePhone:
slot_uri: cim:MarketPerson.landlinePhone
range: TelephoneNumber
required: false
multivalued: false
description: Landline phone number.
lastName:
slot_uri: cim:MarketPerson.lastName
range: string
required: false
multivalued: false
description: ' Person''s last (family, sir) name.'
mName:
slot_uri: cim:MarketPerson.mName
range: string
required: false
multivalued: false
description: ' Middle name(s) or initial(s).'
mobilePhone:
slot_uri: cim:MarketPerson.mobilePhone
range: TelephoneNumber
required: false
multivalued: false
description: Mobile phone number.
prefix:
slot_uri: cim:MarketPerson.prefix
range: string
required: false
multivalued: false
description: A prefix or title for the person's name, such as Miss, Mister,
Doctor, etc.
specialNeed:
slot_uri: cim:MarketPerson.specialNeed
range: string
required: false
multivalued: false
description: Special service needs for the person (contact) are described;
examples include life support, etc.
status:
slot_uri: cim:MarketPerson.status
range: Status
required: false
multivalued: false
suffix:
slot_uri: cim:MarketPerson.suffix
range: string
required: false
multivalued: false
description: A suffix for the person's name, such as II, III, etc.
userID:
slot_uri: cim:MarketPerson.userID
range: string
required: false
multivalued: false
description: "The user name for the person; required to log in.\r\n"
MarketSkills:
slot_uri: cim:MarketPerson.MarketSkills
range: MarketSkill
required: false
multivalued: true
MarketParticipant:
slot_uri: cim:MarketPerson.MarketParticipant
range: MarketParticipant
required: false
multivalued: true
MarketSkill:
class_uri: cim:MarketSkill
is_a: Document
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: "Proficiency level of a craft, which is required to operate or maintain\
\ a particular type of asset and/or perform certain types of work. \r\n"
attributes:
certificationPeriod:
slot_uri: cim:MarketSkill.certificationPeriod
range: DateTimeInterval
required: false
multivalued: false
description: Interval between the certification and its expiry.
effectiveDateTime:
slot_uri: cim:MarketSkill.effectiveDateTime
range: date
required: false
multivalued: false
description: Date and time the skill became effective.
level:
slot_uri: cim:MarketSkill.level
range: string
required: false
multivalued: false
description: "Level of skill for a Craft.\r\n"
MarketQualificationRequirements:
slot_uri: cim:MarketSkill.MarketQualificationRequirements
range: MarketQualificationRequirement
required: false
multivalued: true
MarketPerson:
slot_uri: cim:MarketSkill.MarketPerson
range: MarketPerson
required: false
multivalued: false
MarketQualificationRequirement:
class_uri: cim:MarketQualificationRequirement
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: Certain skills are required and shall be certified in order for a
person (typically a member of a crew) to be qualified to work on types of equipment.
attributes:
effectiveDate:
slot_uri: cim:MarketQualificationRequirement.effectiveDate
range: date
required: false
multivalued: false
description: "Effective date of the privilege, terminate date of the privilege,\
\ or effective date of the application for the organization\r\n"
expirationDate:
slot_uri: cim:MarketQualificationRequirement.expirationDate
range: date
required: false
multivalued: false
description: "This is the terminate date of the application for the organization\r\
\nThe specific organization can no longer access the application as of the\
\ terminate date\r\n"
qualificationID:
slot_uri: cim:MarketQualificationRequirement.qualificationID
range: string
required: false
multivalued: false
description: Qualification identifier.
status:
slot_uri: cim:MarketQualificationRequirement.status
range: integer
required: false
multivalued: false
description: "The status of the privilege. Shows the status of the user\xB4\
s qualification. \r\nThe current statuses are: 1=New, 2=Active, 3=Refused,\
\ 4=Terminated, 5=Withdrawn\r\nand it is subject to update.\r\n"
statusType:
slot_uri: cim:MarketQualificationRequirement.statusType
range: string
required: false
multivalued: false
description: "This is the name of the status of the qualification and is used\
\ to display the status of the user's or organization's status.\r\n"
MarketSkills:
slot_uri: cim:MarketQualificationRequirement.MarketSkills
range: MarketSkill
required: false
multivalued: true
ResourceGroupReq:
class_uri: cim:ResourceGroupReq
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfExternalInputs
description: "Ancillary service requirements for a market.\r\n"
attributes:
RTOs:
slot_uri: cim:ResourceGroupReq.RTOs
range: RTO
required: false
multivalued: true
ResourceGroup:
slot_uri: cim:ResourceGroupReq.ResourceGroup
range: ResourceGroup
required: true
multivalued: false
ResourceGroup:
class_uri: cim:ResourceGroup
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfExternalInputs
description: "A logical grouping of resources that are used to model location\
\ of types of requirements for ancillary services such as spinning reserve zones,\
\ regulation zones, etc. \r\n"
attributes:
status:
slot_uri: cim:ResourceGroup.status
range: Status
required: false
multivalued: false
description: "Status of this group.\r\n"
type:
slot_uri: cim:ResourceGroup.type
range: string
required: false
multivalued: false
description: "Type of this group.\r\n"
ResourceGroupReqs:
slot_uri: cim:ResourceGroup.ResourceGroupReqs
range: ResourceGroupReq
required: false
multivalued: true
RegisteredResources:
slot_uri: cim:ResourceGroup.RegisteredResources
range: RegisteredResource
required: true
multivalued: true
MSSAggregation:
class_uri: cim:MSSAggregation
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: Metered Sub-System aggregation of MSS Zones.
attributes:
costRecovery:
slot_uri: cim:MSSAggregation.costRecovery
range: YesNo
required: false
multivalued: false
description: Charge for Emission Costs, Start Up Costs, or Minimum Load Costs.
grossSettlement:
slot_uri: cim:MSSAggregation.grossSettlement
range: YesNo
required: false
multivalued: false
description: 'MSS Load Following may select Net vs. Gross settlement. Net
Settlement requires the net Demand settled at the MSS LAP and Net Supply
needs to settle at the equivalent to the weighted average price of the MSS
generation. Gross load will be settled at the System LAP and the Gross
supply will be settled at the LMP. MSS Aggregation that elects gross settlement
shall have to identify if its resources are Load Following or not. '
ignoreLosses:
slot_uri: cim:MSSAggregation.ignoreLosses
range: YesNo
required: false
multivalued: false
description: Provides an indication if losses are to be ignored for this zone.
Also refered to as Exclude Marginal Losses.
ignoreMarginalLosses:
slot_uri: cim:MSSAggregation.ignoreMarginalLosses
range: YesNo
required: false
multivalued: false
description: 'Provides an indication if marginal losses are to be ignored
for this zone. '
loadFollowing:
slot_uri: cim:MSSAggregation.loadFollowing
range: YesNo
required: false
multivalued: false
description: Indication that this particular MSSA participates in the Load
Following function.
rucProcurement:
slot_uri: cim:MSSAggregation.rucProcurement
range: YesNo
required: false
multivalued: false
description: Indicates that RUC will be procured by the ISO or self provided.
RTO:
slot_uri: cim:MSSAggregation.RTO
range: RTO
required: true
multivalued: false
MeteredSubSystem:
slot_uri: cim:MSSAggregation.MeteredSubSystem
range: MeteredSubSystem
required: true
multivalued: true
MeteredSubSystem:
class_uri: cim:MeteredSubSystem
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: "A metered subsystem.\r\n"
attributes:
MSSZone:
slot_uri: cim:MeteredSubSystem.MSSZone
range: MSSZone
required: false
multivalued: true
MSSAggregation:
slot_uri: cim:MeteredSubSystem.MSSAggregation
range: MSSAggregation
required: false
multivalued: false
MSSZone:
class_uri: cim:MSSZone
is_a: AggregateNode
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: "Model to define a zone within a Metered Sub System.\r\n"
attributes:
ignoreLosses:
slot_uri: cim:MSSZone.ignoreLosses
range: YesNo
required: false
multivalued: false
description: "Provides an indication if losses are to be ignored for this\
\ metered subsystem zone.\r\n"
lossFactor:
slot_uri: cim:MSSZone.lossFactor
range: float
required: false
multivalued: false
description: "This is the default loss factor for the Metered Sub-System (MSS)\
\ zone. The actual losses are calculated during the RT market.\r\n"
rucGrossSettlement:
slot_uri: cim:MSSZone.rucGrossSettlement
range: YesNo
required: false
multivalued: false
description: "Metered Sub-System (MSS) Load Following may select Net vs. Gross\
\ settlement. Net Settlement requires the net Demand settled at the Metered\
\ Sub-Sustem (MSS) Load Aggregation Point (LAP) and Net Supply needs to\
\ settle at the equivalent to the weighted average price of the MSS generation.\
\ Gross load will be settled at the System LAP and the Gross supply will\
\ be settled at the LMP. MSS Aggregation that elects gross settlement shall\
\ have to identify if its resources are Load Following or not. \r\n"
MeteredSubSystem:
slot_uri: cim:MSSZone.MeteredSubSystem
range: MeteredSubSystem
required: false
multivalued: false
ReserveReq:
class_uri: cim:ReserveReq
is_a: ResourceGroupReq
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfExternalInputs
description: "Requirements for minimum amount of reserve and/or regulation to\
\ be supplied by a set of qualified resources.\r\n"
attributes:
SensitivityPriceCurve:
slot_uri: cim:ReserveReq.SensitivityPriceCurve
range: SensitivityPriceCurve
required: false
multivalued: false
MarketProduct:
slot_uri: cim:ReserveReq.MarketProduct
range: MarketProduct
required: true
multivalued: false
description: Market product associated with reserve requirement must be a
reserve or regulation product.
ReserveReqCurve:
slot_uri: cim:ReserveReq.ReserveReqCurve
range: ReserveReqCurve
required: true
multivalued: false
ReserveReqCurve:
class_uri: cim:ReserveReqCurve
is_a: Curve
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfExternalInputs
description: "A curve relating reserve requirement versus time, showing the values\
\ of a specific reserve requirement for each unit of the period covered. The\
\ curve can be based on \"absolute\" time or on \"normalized' time. \r\nX is\
\ time, typically expressed in absolute time\r\nY1 is reserve requirement, typically\
\ expressed in MW\r\n"
attributes:
ReserveReq:
slot_uri: cim:ReserveReqCurve.ReserveReq
range: ReserveReq
required: true
multivalued: false
SensitivityPriceCurve:
class_uri: cim:SensitivityPriceCurve
is_a: Curve
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfExternalInputs
description: "Optionally, this curve expresses elasticity of the associated requirement.\
\ For example, used to reduce requirements when clearing price exceeds reasonable\
\ values when the supply quantity becomes scarce. For example, a single point\
\ value of $1000/MW for a spinning reserve will cause a reduction in the required\
\ spinning reserve. \r\nX axis is constrained quantity (e.g., MW)\r\nY1 axis\
\ is money per constrained quantity\r\n"
attributes:
ReserveReq:
slot_uri: cim:SensitivityPriceCurve.ReserveReq
range: ReserveReq
required: false
multivalued: false
MarketRegionResults:
class_uri: cim:MarketRegionResults
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: "Provides all Region Ancillary Service results for the DA and RT\
\ markets. The specific data is commodity type (Regulation Up, Regulation Down,\
\ Spinning Reserve, Non-spinning Reserve, or Total Up reserves) based for the\
\ cleared MW, cleared price, and total capacity required for the region.\r\n"
attributes:
clearedMW:
slot_uri: cim:MarketRegionResults.clearedMW
range: float
required: false
multivalued: false
description: "Cleared generation Value in MW. For AS, this value is clearedMW\
\ = AS Total. For AS, clearedMW - selfScheduleMW = AS Procured\r\n"
clearedPrice:
slot_uri: cim:MarketRegionResults.clearedPrice
range: float
required: false
multivalued: false
description: "Marginal Price ($/MW) for the commodity (Energy, Regulation\
\ Up, Regulation Down, Spinning Reserve, or Non-spinning reserve) based\
\ on the pricing run.\r\n"
dispatchCtMW:
slot_uri: cim:MarketRegionResults.dispatchCtMW
range: float
required: false
multivalued: false
description: "Dispatchable MW for Combustion units.\r\n"
dispatchHydroMW:
slot_uri: cim:MarketRegionResults.dispatchHydroMW
range: float
required: false
multivalued: false
description: "Dispatchable MW for Hydro units.\r\n"
dispatchRate:
slot_uri: cim:MarketRegionResults.dispatchRate
range: float
required: false
multivalued: false
description: "Dispatch rate in MW/minutes.\r\n"
dispatchSteamMW:
slot_uri: cim:MarketRegionResults.dispatchSteamMW
range: float
required: false
multivalued: false
description: "Dispatchable MW for Steam units.\r\n"
imbalanceEnergyBias:
slot_uri: cim:MarketRegionResults.imbalanceEnergyBias
range: float
required: false
multivalued: false
description: "Imbalance Energy Bias (MW) by Time Period (5' only)\r\n"
limitFlag:
slot_uri: cim:MarketRegionResults.limitFlag
range: ResourceLimitIndicator
required: false
multivalued: false
description: Locational AS Flags indicating whether the Upper or Lower Bound
limit of the AS regional procurment is binding
lumpyIndicator:
slot_uri: cim:MarketRegionResults.lumpyIndicator
range: YesNo
required: false
multivalued: false
description: "The \"Lumpy Flag\"(Y/N) indicates whether the resource that\
\ sets the price is a lumpy generator by hour over the time horizon.\r\n\
\r\nOnly applicable for the Day Ahead Market"
maxSufficiencyIndex:
slot_uri: cim:MarketRegionResults.maxSufficiencyIndex
range: float
required: false
multivalued: false
description: "Region requirement maximum limit\r\n"
minSufficiencyIndex:
slot_uri: cim:MarketRegionResults.minSufficiencyIndex
range: float
required: false
multivalued: false
description: "Region requirement minimum limit\r\n"
reqMaxMW:
slot_uri: cim:MarketRegionResults.reqMaxMW
range: float
required: false
multivalued: false
description: "Region requirement maximum limit\r\n"
reqMinMW:
slot_uri: cim:MarketRegionResults.reqMinMW
range: float
required: false
multivalued: false
description: "Region requirement minimum limit\r\n"
selfScheduleMW:
slot_uri: cim:MarketRegionResults.selfScheduleMW
range: float
required: false
multivalued: false
description: "Aof AS, selfScheduleMW = AS Self-Provided\r\n"
MarketRegion:
slot_uri: cim:MarketRegionResults.MarketRegion
range: MarketRegion
required: true
multivalued: false
MarketProduct:
slot_uri: cim:MarketRegionResults.MarketProduct
range: MarketProduct
required: false
multivalued: false
AncillaryServiceClearing:
slot_uri: cim:MarketRegionResults.AncillaryServiceClearing
range: AncillaryServiceClearing
required: false
multivalued: false
MarketRegion:
class_uri: cim:MarketRegion
is_a: AggregateNode
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: "A specialized class of AggregatedNode type. Defines the MarketRegions.\
\ Regions could be system Market Regions, Energy Regions or Ancillary Service\
\ Regions.\r\n"
attributes:
MarketRegionResults:
slot_uri: cim:MarketRegion.MarketRegionResults
range: MarketRegionResults
required: true
multivalued: true
ReserveDemandCurve:
slot_uri: cim:MarketRegion.ReserveDemandCurve
range: ReserveDemandCurve
required: false
multivalued: true
ExPostMarketRegionResults:
slot_uri: cim:MarketRegion.ExPostMarketRegionResults
range: ExPostMarketRegionResults
required: false
multivalued: true
ExPostMarketRegionResults:
class_uri: cim:ExPostMarketRegionResults
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: "Model of expost calculation of cleared MW on a region basis. Includes\
\ cleared price.\r\n"
attributes:
exPostClearedPrice:
slot_uri: cim:ExPostMarketRegionResults.exPostClearedPrice
range: float
required: false
multivalued: false
ExPostMarketRegion:
slot_uri: cim:ExPostMarketRegionResults.ExPostMarketRegion
range: ExPostMarketRegion
required: true
multivalued: false
MarketRegion:
slot_uri: cim:ExPostMarketRegionResults.MarketRegion
range: MarketRegion
required: true
multivalued: false
ExPostMarketRegion:
class_uri: cim:ExPostMarketRegion
is_a: MarketFactors
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: "Model of ex-post calculation of cleared MW on a regional basis.\r\
\n"
attributes:
ExPostMarketRegionResults:
slot_uri: cim:ExPostMarketRegion.ExPostMarketRegionResults
range: ExPostMarketRegionResults
required: false
multivalued: false
ReserveDemandCurve:
class_uri: cim:ReserveDemandCurve
is_a: Curve
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.ExternalInputs
description: Reserve demand curve. Models maximum quantities of reserve required
per Market Region and models a reserve demand curve for the minimum quantities
of reserve. The ReserveDemandCurve is a relationship between unit operating
reserve price in $/MWhr (Y-axis) and unit reserves in MW (X-axis).
attributes:
reqMaxMW:
slot_uri: cim:ReserveDemandCurve.reqMaxMW
range: float
required: false
multivalued: false
description: "Region requirement maximum limit\r\n"
reserveRequirementType:
slot_uri: cim:ReserveDemandCurve.reserveRequirementType
range: ReserveRequirementType
required: false
multivalued: false
description: Reserve requirement type that the max and curve apply to. For
example, operating reserve, regulation and contingency.
ASRequirements:
slot_uri: cim:ReserveDemandCurve.ASRequirements
range: ASRequirements
required: true
multivalued: false
MarketRegion:
slot_uri: cim:ReserveDemandCurve.MarketRegion
range: MarketRegion
required: true
multivalued: false
ASRequirements:
class_uri: cim:ASRequirements
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.ExternalInputs
description: "Models Ancillary Service Requirements. Describes interval for which\
\ the requirement is applicable.\r\n"
attributes:
intervalStartTime:
slot_uri: cim:ASRequirements.intervalStartTime
range: date
required: false
multivalued: false
description: "The start of the time interval for which requirement is defined.\r\
\n"
ReserveDemandCurve:
slot_uri: cim:ASRequirements.ReserveDemandCurve
range: ReserveDemandCurve
required: true
multivalued: true
AncillaryServiceClearing:
class_uri: cim:AncillaryServiceClearing
is_a: MarketFactors
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: "Model of results of market clearing with respect to Ancillary Service\
\ products.\r\n"
attributes:
MarketCaseClearing:
slot_uri: cim:AncillaryServiceClearing.MarketCaseClearing
range: MarketCaseClearing
required: false
multivalued: false
MarketRegionResults:
slot_uri: cim:AncillaryServiceClearing.MarketRegionResults
range: MarketRegionResults
required: true
multivalued: true
MarketCaseClearing:
class_uri: cim:MarketCaseClearing
is_a: MarketFactors
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfMarketResults
description: "Market case clearing results are posted for a given settlement period.\r\
\n"
attributes:
caseType:
slot_uri: cim:MarketCaseClearing.caseType
range: string
required: false
multivalued: false
description: "Settlement period:\r\n'DA - Bid-in'\r\n'DA - Reliability'\r\n\
'DA - Amp1'\r\n'DA - Amp2'\r\n'RT - Ex-Ante'\r\n'RT - Ex-Post'\r\n'RT -\
\ Amp1'\r\n'RT - Amp2'\r\n"
modifiedDate:
slot_uri: cim:MarketCaseClearing.modifiedDate
range: date
required: false
multivalued: false
description: "Last time and date clearing results were manually modified.\r\
\n"
postedDate:
slot_uri: cim:MarketCaseClearing.postedDate
range: date
required: false
multivalued: false
description: "Bid clearing results posted time and date.\r\n"
MarketProductClearing:
slot_uri: cim:MarketCaseClearing.MarketProductClearing
range: AncillaryServiceClearing
required: false
multivalued: true
BidPriceCap:
class_uri: cim:BidPriceCap
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: "This class represent the bid price cap.\r\n"
attributes:
bidCeiling:
slot_uri: cim:BidPriceCap.bidCeiling
range: CostPerEnergyUnit
required: false
multivalued: false
description: "Bid Ceiling ($/MWH)\r\n"
bidCeilingAS:
slot_uri: cim:BidPriceCap.bidCeilingAS
range: CostPerEnergyUnit
required: false
multivalued: false
description: "Bid Ceiling ($/MWH) for generic AS versus a specific market\
\ product\r\n"
bidFloor:
slot_uri: cim:BidPriceCap.bidFloor
range: CostPerEnergyUnit
required: false
multivalued: false
description: "Bid Floor, ($/MWH)\r\n"
bidFloorAS:
slot_uri: cim:BidPriceCap.bidFloorAS
range: CostPerEnergyUnit
required: false
multivalued: false
description: "Bid Floor ($/MWH) for generic AS versus a specific market product\r\
\n"
defaultPrice:
slot_uri: cim:BidPriceCap.defaultPrice
range: CostPerEnergyUnit
required: false
multivalued: false
description: "Bid Default Price($/MWH)\r\n"
marketType:
slot_uri: cim:BidPriceCap.marketType
range: MarketType
required: false
multivalued: false
description: Market Type of the cap (DAM or RTM)
MarketProduct:
slot_uri: cim:BidPriceCap.MarketProduct
range: MarketProduct
required: false
multivalued: false
ResourceAwardInstruction:
class_uri: cim:ResourceAwardInstruction
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: "Model of market results, instruction for resource. Contains details\
\ of award as attributes.\r\n"
attributes:
awardMW:
slot_uri: cim:ResourceAwardInstruction.awardMW
range: float
required: false
multivalued: false
description: "For DA Energy: Not Applicable; \r\n\r\nFor DA AS: DA AS market\
\ award; \r\n\r\nFor RT Energy: Not Applicable; \r\n\r\nFor RT AS: RT\
\ AS market award (excluding DA AS market or self-proviison awards)\r\n"
clearedMW:
slot_uri: cim:ResourceAwardInstruction.clearedMW
range: float
required: false
multivalued: false
description: "For DA Energy: Total Schedule = DA market schedule + DA self-schedule\
\ award; \r\n\r\nFor DA AS: DA Ancillary Service Awards = DA AS market\
\ award + DA AS self-provision award; \r\n\r\nFor RT Energy: Total Schedule\
\ = RT market schedule + RT self-schedule award; \r\n\r\nFor RT AS: RT\
\ Ancillary Service Awards = RT AS self-provision award + RT AS market award\
\ + DA AS market award + DA AS self-provision award;\r\n"
clearedPrice:
slot_uri: cim:ResourceAwardInstruction.clearedPrice
range: float
required: false
multivalued: false
description: "Marginal Price ($/MW) for the commodity (Regulation Up, Regulation\
\ Down, Spinning Reserve, or Non-spinning reserve) for pricing run.\r\n"
congestLMP:
slot_uri: cim:ResourceAwardInstruction.congestLMP
range: float
required: false
multivalued: false
description: "Congestion component of Location Marginal Price (LMP) in monetary\
\ units per MW.\r\n"
costLMP:
slot_uri: cim:ResourceAwardInstruction.costLMP
range: float
required: false
multivalued: false
description: "Cost component of Locational Marginal Pricing (LMP) in monetary\
\ units per MW.\r\n"
dispatcherAddedMW:
slot_uri: cim:ResourceAwardInstruction.dispatcherAddedMW
range: float
required: false
multivalued: false
description: "The tier2 mw added by dispatcher action \r\nMarket results of\
\ the synchronized reserve market\r\n"
economicMax:
slot_uri: cim:ResourceAwardInstruction.economicMax
range: float
required: false
multivalued: false
description: "Unit max output for dispatch; bid in economic maximum\r\n"
economicMin:
slot_uri: cim:ResourceAwardInstruction.economicMin
range: float
required: false
multivalued: false
description: "Unit min output for dispatch; bid in economic minimum\r\n"
effRegulationDownLimit:
slot_uri: cim:ResourceAwardInstruction.effRegulationDownLimit
range: float
required: false
multivalued: false
description: "Effective Regulation Down Limit (MW)\r\n"
effRegulationUpLimit:
slot_uri: cim:ResourceAwardInstruction.effRegulationUpLimit
range: float
required: false
multivalued: false
description: "Effective Regulation Up Limit \r\n"
lmp:
slot_uri: cim:ResourceAwardInstruction.lmp
range: float
required: false
multivalued: false
description: "Locational marginal price value\r\n"
lossLMP:
slot_uri: cim:ResourceAwardInstruction.lossLMP
range: float
required: false
multivalued: false
description: "Loss component of Location Marginal Price (LMP) in monetary\
\ units per MW.\r\n"
manuallyBlocked:
slot_uri: cim:ResourceAwardInstruction.manuallyBlocked
range: YesNo
required: false
multivalued: false
description: Indicates if an award was manually blocked (Y/N). Valid for Spinning
and Non-spinning.
marginalResourceIndicator:
slot_uri: cim:ResourceAwardInstruction.marginalResourceIndicator
range: YesNo
required: false
multivalued: false
description: Indicator (Yes / No) that this resource set the price for this
dispatch / schedule.
mustRunInd:
slot_uri: cim:ResourceAwardInstruction.mustRunInd
range: boolean
required: false
multivalued: false
description: "Identifes if the unit was set to must run by the market participant\
\ responsible for bidding in the unit\r\n"
noLoadCost:
slot_uri: cim:ResourceAwardInstruction.noLoadCost
range: float
required: false
multivalued: false
description: "Unit no-load cost in case of energy commodity\r\n"
optimalBidCost:
slot_uri: cim:ResourceAwardInstruction.optimalBidCost
range: float
required: false
multivalued: false
description: "Optimal Bid cost\r\n"
optimalBidPay:
slot_uri: cim:ResourceAwardInstruction.optimalBidPay
range: float
required: false
multivalued: false
description: "Optimal Bid production payment based on LMP\r\n"
optimalMargin:
slot_uri: cim:ResourceAwardInstruction.optimalMargin
range: float
required: false
multivalued: false
description: "Optimal Bid production margin\r\n"
overrideTimeStamp:
slot_uri: cim:ResourceAwardInstruction.overrideTimeStamp
range: date
required: false
multivalued: false
description: "Time the manual data entry occured.\r\n"
overrideValue:
slot_uri: cim:ResourceAwardInstruction.overrideValue
range: float
required: false
multivalued: false
description: "Provides the ability for the grid operator to override items,\
\ such as spin capacity requirements, prior to running the algorithm. This\
\ value is market product based (spin, non-spin, reg up, reg down, or RUC).\r\
\n"
selfSchedMW:
slot_uri: cim:ResourceAwardInstruction.selfSchedMW
range: float
required: false
multivalued: false
description: "For DA Energy: DA total self-schedule award; \r\nFor DA AS:\
\ DA AS self-provision award; \r\nFor RT Energy: RT total self-schedule\
\ award; \r\nFor RT AS: RT AS self-provision award (excluding DA AS market\
\ or self-provision awards)\r\n"
startUpCost:
slot_uri: cim:ResourceAwardInstruction.startUpCost
range: float
required: false
multivalued: false
description: "Unit start up cost in case of energy commodity\r\n"
status:
slot_uri: cim:ResourceAwardInstruction.status
range: string
required: false
multivalued: false
description: "In or out status of resource\r\n"
totalRevenue:
slot_uri: cim:ResourceAwardInstruction.totalRevenue
range: float
required: false
multivalued: false
description: "Total bid revenue (startup_cost + no_load_cost + bid_pay)\r\n"
updateTimeStamp:
slot_uri: cim:ResourceAwardInstruction.updateTimeStamp
range: date
required: false
multivalued: false
updateType:
slot_uri: cim:ResourceAwardInstruction.updateType
range: MQSCHGType
required: false
multivalued: false
updateUser:
slot_uri: cim:ResourceAwardInstruction.updateUser
range: string
required: false
multivalued: false
SelfScheduleBreakdown:
slot_uri: cim:ResourceAwardInstruction.SelfScheduleBreakdown
range: SelfScheduleBreakdown
required: false
multivalued: true
RegisteredResource:
slot_uri: cim:ResourceAwardInstruction.RegisteredResource
range: RegisteredResource
required: false
multivalued: false
ClearingResourceAward:
slot_uri: cim:ResourceAwardInstruction.ClearingResourceAward
range: ResourceAwardClearing
required: true
multivalued: true
MarketProduct:
slot_uri: cim:ResourceAwardInstruction.MarketProduct
range: MarketProduct
required: true
multivalued: false
ResourceAwardClearing:
class_uri: cim:ResourceAwardClearing
is_a: MarketFactors
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: "Models details of bid and offer market clearing. Class indicates\
\ whether a contingency is active and whether the automatic dispatching system\
\ is active for this interval of the market solution.\r\n"
attributes:
contingencyActive:
slot_uri: cim:ResourceAwardClearing.contingencyActive
range: YesNo
required: false
multivalued: false
description: Indication that the system is currently operating in a contingency
mode.
dispatchMode:
slot_uri: cim:ResourceAwardClearing.dispatchMode
range: AutomaticDispatchMode
required: false
multivalued: false
RUCAwardInstruction:
slot_uri: cim:ResourceAwardClearing.RUCAwardInstruction
range: RUCAwardInstruction
required: true
multivalued: true
ResourceAwardInstruction:
slot_uri: cim:ResourceAwardClearing.ResourceAwardInstruction
range: ResourceAwardInstruction
required: true
multivalued: true
RUCAwardInstruction:
class_uri: cim:RUCAwardInstruction
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: "This class models the information about the RUC awards.\r\n"
attributes:
clearedPrice:
slot_uri: cim:RUCAwardInstruction.clearedPrice
range: float
required: false
multivalued: false
description: "Marginal Price ($/MW) for the commodity (Regulation Up, Regulation\
\ Down, Spinning Reserve, or Non-spinning reserve) for pricing run.\r\n"
marketProductType:
slot_uri: cim:RUCAwardInstruction.marketProductType
range: MarketProductType
required: false
multivalued: false
description: "major product type may include the following but not limited\
\ to:\r\n\r\nEnergy\r\nRegulation Up\r\nRegulation Dn\r\nSpinning Reserve\r\
\nNon-Spinning Reserve\r\nOperating Reserve"
RUCAward:
slot_uri: cim:RUCAwardInstruction.RUCAward
range: float
required: false
multivalued: false
description: "The RUC Award of a resource is the portion of the RUC Capacity\
\ that is not under RA or RMR contracts. The RUC Award of a resource is\
\ the portion of the RUC Capacity that is eligible for RUC Availability\
\ payment.\r\n"
RUCCapacity:
slot_uri: cim:RUCAwardInstruction.RUCCapacity
range: float
required: false
multivalued: false
description: "The RUC Capacity of a resource is the difference between (i)\
\ the RUC Schedule and (ii) the higher of the DA Schedule and the Minimum\
\ Load.\r\n"
RUCSchedule:
slot_uri: cim:RUCAwardInstruction.RUCSchedule
range: float
required: false
multivalued: false
description: "The RUC Schedule of a resource is its output level that balances\
\ the load forecast used in RUC. The RUC Schedule in RUC is similar to the\
\ DA Schedule in DAM.\r\n"
updateTimeStamp:
slot_uri: cim:RUCAwardInstruction.updateTimeStamp
range: date
required: false
multivalued: false
updateType:
slot_uri: cim:RUCAwardInstruction.updateType
range: MQSCHGType
required: false
multivalued: false
updateUser:
slot_uri: cim:RUCAwardInstruction.updateUser
range: string
required: false
multivalued: false
RegisteredResource:
slot_uri: cim:RUCAwardInstruction.RegisteredResource
range: RegisteredResource
required: false
multivalued: false
ClearingResourceAward:
slot_uri: cim:RUCAwardInstruction.ClearingResourceAward
range: ResourceAwardClearing
required: true
multivalued: true
SelfScheduleBreakdown:
class_uri: cim:SelfScheduleBreakdown
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: "Model of Self Schedules Results. Includes self schedule MW,and\
\ type of self schedule for each self schedule type included in total self schedule\
\ MW value found in ResourceAwardInstruction.\r\n"
attributes:
selfSchedMW:
slot_uri: cim:SelfScheduleBreakdown.selfSchedMW
range: float
required: false
multivalued: false
description: "Cleared value for the specific self schedule type listed. \r\
\n"
selfSchedType:
slot_uri: cim:SelfScheduleBreakdown.selfSchedType
range: SelfScheduleBreakdownType
required: false
multivalued: false
description: "Self schedule breakdown type.\r\n"
ResourceAwardInstruction:
slot_uri: cim:SelfScheduleBreakdown.ResourceAwardInstruction
range: ResourceAwardInstruction
required: true
multivalued: false
Domain:
class_uri: cim:Domain
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketManagement
description: "An area of activity defined within the energy market.\r\n"
attributes:
RegisteredResource:
slot_uri: cim:Domain.RegisteredResource
range: RegisteredResource
required: false
multivalued: true
TimeSeries:
slot_uri: cim:Domain.TimeSeries
range: TimeSeries
required: false
multivalued: true
Quantity:
slot_uri: cim:Domain.Quantity
range: Quantity
required: false
multivalued: true
Price:
slot_uri: cim:Domain.Price
range: Price
required: false
multivalued: true
MarketDocument:
slot_uri: cim:Domain.MarketDocument
range: MarketDocument
required: false
multivalued: true
Quantity:
class_uri: cim:Quantity
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketManagement
description: "Description of quantities needed in the data exchange. \r\nThe type\
\ of the quantity is described either by the role of the association or the\
\ type attribute.\r\nThe quality attribute provides the information about the\
\ quality of the quantity (measured, estimated, etc.)."
attributes:
quality:
slot_uri: cim:Quantity.quality
range: string
required: false
multivalued: false
description: 'The quality of the information being provided. This quality
may be estimated, not available, as provided, etc. '
quantity:
slot_uri: cim:Quantity.quantity
range: Quantity
required: false
multivalued: false
type:
slot_uri: cim:Quantity.type
range: string
required: false
multivalued: false
description: The description of the type of the quantity.
Domain:
slot_uri: cim:Quantity.Domain
range: Domain
required: false
multivalued: true
Point:
slot_uri: cim:Quantity.Point
range: Point
required: false
multivalued: true
TimeSeries:
slot_uri: cim:Quantity.TimeSeries
range: TimeSeries
required: false
multivalued: true
Detail_Quantity:
slot_uri: cim:Quantity.Detail_Quantity
range: Quantity
required: false
multivalued: true
description: Additional information related to the associated quantity.
Price:
class_uri: cim:Price
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketManagement
description: The cost corresponding to a specific measure and expressed in a currency.
attributes:
amount:
slot_uri: cim:Price.amount
range: double
required: false
multivalued: false
description: A number of monetary units specified in a unit of currency.
category:
slot_uri: cim:Price.category
range: string
required: false
multivalued: false
description: The category of a price to be used in a price calculation. The
price category is mutually agreed between System Operators.
direction:
slot_uri: cim:Price.direction
range: string
required: false
multivalued: false
description: The direction indicates whether a System Operator pays the Market
Parties or inverse.
TimeSeries:
slot_uri: cim:Price.TimeSeries
range: TimeSeries
required: false
multivalued: true
Domain:
slot_uri: cim:Price.Domain
range: Domain
required: false
multivalued: true
Point:
slot_uri: cim:Price.Point
range: Point
required: false
multivalued: false
ExPostResourceResults:
class_uri: cim:ExPostResourceResults
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: "Model of ex-post pricing of resources contains components of LMPs:\
\ energy, congestion, loss. Resource based.\r\n"
attributes:
congestionLMP:
slot_uri: cim:ExPostResourceResults.congestionLMP
range: float
required: false
multivalued: false
description: "LMP component in USD (deprecated)\r\n"
desiredMW:
slot_uri: cim:ExPostResourceResults.desiredMW
range: float
required: false
multivalued: false
description: "Desired output of unit\r\n"
dispatchRate:
slot_uri: cim:ExPostResourceResults.dispatchRate
range: float
required: false
multivalued: false
description: "Unit Dispatch rate from real time unit dispatch.\r\n"
lmp:
slot_uri: cim:ExPostResourceResults.lmp
range: float
required: false
multivalued: false
description: "LMP (Local Marginal Price) in USD at the equipment (deprecated)\r\
\n"
lossLMP:
slot_uri: cim:ExPostResourceResults.lossLMP
range: float
required: false
multivalued: false
description: "loss lmp (deprecated)\r\n"
maxEconomicMW:
slot_uri: cim:ExPostResourceResults.maxEconomicMW
range: float
required: false
multivalued: false
description: "Economic Maximum MW\r\n"
minEconomicMW:
slot_uri: cim:ExPostResourceResults.minEconomicMW
range: float
required: false
multivalued: false
description: "Economic Minimum MW\r\n"
resourceMW:
slot_uri: cim:ExPostResourceResults.resourceMW
range: float
required: false
multivalued: false
description: "Current MW output of the equipment \r\nAttribute Usage: Information\
\ purposes - Information purposes - Output of LPA engine.\r\n"
status:
slot_uri: cim:ExPostResourceResults.status
range: EquipmentStatusType
required: false
multivalued: false
description: 'Status of equipment '
RegisteredResource:
slot_uri: cim:ExPostResourceResults.RegisteredResource
range: RegisteredResource
required: false
multivalued: false
ExPostResource:
slot_uri: cim:ExPostResourceResults.ExPostResource
range: ExPostResource
required: true
multivalued: false
ExPostResource:
class_uri: cim:ExPostResource
is_a: MarketFactors
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: "Model of ex-post pricing of resources. \r\n"
attributes:
ExPostResourceResults:
slot_uri: cim:ExPostResource.ExPostResourceResults
range: ExPostResourceResults
required: false
multivalued: true
LoadFollowingOperatorInput:
class_uri: cim:LoadFollowingOperatorInput
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: "Model of load following capabilities that are entered by operators\
\ on a temporary basis. Related to Registered Resources in Metered Subsystems.\r\
\n"
attributes:
dataEntryTimeStamp:
slot_uri: cim:LoadFollowingOperatorInput.dataEntryTimeStamp
range: date
required: false
multivalued: false
description: "Time the data entry was performed\r\n"
tempLoadFollowingDownManualCap:
slot_uri: cim:LoadFollowingOperatorInput.tempLoadFollowingDownManualCap
range: float
required: false
multivalued: false
description: "temporarily manually entered LFD capacity\r\n"
tempLoadFollowingUpManualCap:
slot_uri: cim:LoadFollowingOperatorInput.tempLoadFollowingUpManualCap
range: float
required: false
multivalued: false
description: "temporarily manually entered LFU capacity.\r\n"
updateTimeStamp:
slot_uri: cim:LoadFollowingOperatorInput.updateTimeStamp
range: date
required: false
multivalued: false
updateType:
slot_uri: cim:LoadFollowingOperatorInput.updateType
range: MQSCHGType
required: false
multivalued: false
updateUser:
slot_uri: cim:LoadFollowingOperatorInput.updateUser
range: string
required: false
multivalued: false
RegisteredResource:
slot_uri: cim:LoadFollowingOperatorInput.RegisteredResource
range: RegisteredResource
required: false
multivalued: false
MarketObjectStatus:
class_uri: cim:MarketObjectStatus
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketManagement
description: The condition or position of an object with regard to its standing.
attributes:
status:
slot_uri: cim:MarketObjectStatus.status
range: string
required: false
multivalued: false
description: The coded condition or position of an object with regard to its
standing.
TimeSeries:
slot_uri: cim:MarketObjectStatus.TimeSeries
range: TimeSeries
required: false
multivalued: true
RegisteredResource:
slot_uri: cim:MarketObjectStatus.RegisteredResource
range: RegisteredResource
required: false
multivalued: true
DefaultBid:
class_uri: cim:DefaultBid
is_a: Bid
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.ExternalInputs
description: "DefaultBid is a generic class to hold Default Energy Bid, Default\
\ Startup Bid, and Default Minimum Load Bid:\r\n\r\nDefault Energy Bid\r\nA\
\ Default Energy Bid is a monotonically increasing staircase function consisting\
\ at maximum 10 economic bid segments, or 10 ($/MW, MW) pairs. There are three\
\ methods for determining the Default Energy Bid:\r\n\r\n\t- Cost Based:\
\ derived from the Heat Rate or Average Cost multiplied by the Gas Price Index\
\ plus 10%.
\r\n\t- LMP Based: a weighted average of LMPs in the preceding\
\ 90 days.
\r\n\t- Negotiated: an amount negotiated with the designated\
\ Independent Entity.
\r\n
\r\n\r\nDefault Startup Bid\r\nA Default\
\ Startup Bid (DSUB) shall be calculated for each RMR unit based on the Startup\
\ Cost stored in the Master File and the applicable GPI and EPI.\r\n\r\nDefault\
\ Minimum Load Bid\r\nA Default Minimum Load Bid (DMLB) shall be calculated\
\ for each RMR unit based on the Minimum Load Cost stored in the Master File\
\ and the applicable GPI."
attributes:
bidType:
slot_uri: cim:DefaultBid.bidType
range: BidType
required: false
multivalued: false
description: Default bid type such as Default Energy Bid, Default Minimum
Load Bid, and Default Startup Bid
minLoadCost:
slot_uri: cim:DefaultBid.minLoadCost
range: CostRate
required: false
multivalued: false
description: "Minimum load cost in $/hr\r\n"
peakFlag:
slot_uri: cim:DefaultBid.peakFlag
range: OnOff
required: false
multivalued: false
description: on-peak, off-peak, or all
DefaultBidCurve:
slot_uri: cim:DefaultBid.DefaultBidCurve
range: DefaultBidCurve
required: false
multivalued: false
RegisteredResource:
slot_uri: cim:DefaultBid.RegisteredResource
range: RegisteredResource
required: true
multivalued: false
DefaultBidCurve:
class_uri: cim:DefaultBidCurve
is_a: Curve
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.ExternalInputs
description: "Default bid curve for default energy bid curve and default startup\
\ curves (cost and time).\r\n"
attributes:
curveType:
slot_uri: cim:DefaultBidCurve.curveType
range: string
required: false
multivalued: false
description: "To indicate a type used for a default energy bid curve, such\
\ as LMP, cost or consultative based.\r\n"
debAdderFlag:
slot_uri: cim:DefaultBidCurve.debAdderFlag
range: YesNo
required: false
multivalued: false
description: "Default energy bid adder flag\r\n"
DefaultBid:
slot_uri: cim:DefaultBidCurve.DefaultBid
range: DefaultBid
required: false
multivalued: false
DopInstruction:
class_uri: cim:DopInstruction
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: "Provides the necessary information (on a resource basis) to capture\
\ the Dispatch Operating Point (DOP) results on a Dispatch interval. This information\
\ is only relevant to the RT interval market.\r\n"
attributes:
mwDOP:
slot_uri: cim:DopInstruction.mwDOP
range: ActivePower
required: false
multivalued: false
description: "Dispatched Operating Point (MW)\r\n"
plotPriority:
slot_uri: cim:DopInstruction.plotPriority
range: integer
required: false
multivalued: false
description: "A value used to establish priority of the DOP when plotting.\
\ This is only applicable when two DOPs exist for the same time, but with\
\ different MW values. E.g. when indicating a step in the curve. Its used\
\ to determine if the curve steps up or down.\r\n"
runIndicatorDOP:
slot_uri: cim:DopInstruction.runIndicatorDOP
range: YesNo
required: false
multivalued: false
description: "Indication of DOP validity. \r\n\r\nShows the DOP is calculated\
\ from the latest run (YES). A NO indicator shows that the DOP is copied\
\ from a previous execution.\r\n\r\nUp to 2 intervals can be missed."
timestampDOP:
slot_uri: cim:DopInstruction.timestampDOP
range: date
required: false
multivalued: false
description: "DOP time stamp\r\n"
updateTimeStamp:
slot_uri: cim:DopInstruction.updateTimeStamp
range: date
required: false
multivalued: false
updateType:
slot_uri: cim:DopInstruction.updateType
range: MQSCHGType
required: false
multivalued: false
updateUser:
slot_uri: cim:DopInstruction.updateUser
range: string
required: false
multivalued: false
RegisteredResouce:
slot_uri: cim:DopInstruction.RegisteredResouce
range: RegisteredResource
required: false
multivalued: false
InstructionClearingDOP:
slot_uri: cim:DopInstruction.InstructionClearingDOP
range: InstructionClearingDOP
required: true
multivalued: true
InstructionClearingDOP:
class_uri: cim:InstructionClearingDOP
is_a: MarketFactors
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: "Model of market clearing, related to Dispatch Operating Point. Identifies\
\ interval.\r\n"
attributes:
DopInstruction:
slot_uri: cim:InstructionClearingDOP.DopInstruction
range: DopInstruction
required: true
multivalued: true
ResourceCertification:
class_uri: cim:ResourceCertification
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: Specifies certification for a resource to participate in a specific
markets.
attributes:
market:
slot_uri: cim:ResourceCertification.market
range: MarketType
required: false
multivalued: false
description: "market type\r\n"
qualificationFlag:
slot_uri: cim:ResourceCertification.qualificationFlag
range: YesNo
required: false
multivalued: false
description: "Status of the qualification ('Y' = Active, 'N' = Inactive)\r\
\n"
type:
slot_uri: cim:ResourceCertification.type
range: ResourceCertificationKind
required: false
multivalued: false
description: "Type of service based on ResourceAncillaryServiceType enumeration\r\
\n"
RegisteredResource:
slot_uri: cim:ResourceCertification.RegisteredResource
range: RegisteredResource
required: true
multivalued: false
description: RegisteredResources are qualified for resource ancillary service
types (which include market product types as well as other types such as
BlackStart) by the association to the class ResourceAncillaryServiceQualification.
FormerReference:
class_uri: cim:FormerReference
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: Used to indicate former references to the same piece of equipment.
The ID, name, and effectivity dates are utilized.
attributes:
RegisteredResource:
slot_uri: cim:FormerReference.RegisteredResource
range: RegisteredResource
required: true
multivalued: false
IntermittentResourceEligibility:
class_uri: cim:IntermittentResourceEligibility
is_a: MarketFactors
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.ExternalInputs
description: "Indicates whether unit is eligible for treatment as a intermittent\
\ variable renewable resource.\r\n"
attributes:
eligibilityStatus:
slot_uri: cim:IntermittentResourceEligibility.eligibilityStatus
range: string
required: false
multivalued: false
description: "Indicates whether a resource is eligible for PIRP program for\
\ a given hour\r\n"
RegisteredResource:
slot_uri: cim:IntermittentResourceEligibility.RegisteredResource
range: RegisteredResource
required: true
multivalued: false
ResourceCapacity:
class_uri: cim:ResourceCapacity
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketCommon
description: This class model the various capacities of a resource. A resource
may have numbers of capacities related to operating, ancillary services, energy
trade and so forth. Capacities may be defined for active power or reactive power.
attributes:
capacityType:
slot_uri: cim:ResourceCapacity.capacityType
range: ResourceCapacityType
required: false
multivalued: false
description: "capacity type\r\n\r\nThe types are but not limited to:\r\n\r\
\nRegulation Up\r\nRegulation Dn\r\nSpinning Reserve\r\nNon-Spinning Reserve\r\
\nFOO capacity\r\nMOO capacity"
defaultCapacity:
slot_uri: cim:ResourceCapacity.defaultCapacity
range: double
required: false
multivalued: false
description: default capacity
maximumCapacity:
slot_uri: cim:ResourceCapacity.maximumCapacity
range: double
required: false
multivalued: false
description: maximum capacity
minimumCapacity:
slot_uri: cim:ResourceCapacity.minimumCapacity
range: double
required: false
multivalued: false
description: minimum capacity
unitSymbol:
slot_uri: cim:ResourceCapacity.unitSymbol
range: UnitSymbol
required: false
multivalued: false
description: Unit selection for the capacity values.
RegisteredResource:
slot_uri: cim:ResourceCapacity.RegisteredResource
range: RegisteredResource
required: false
multivalued: true
ExpectedEnergyValues:
class_uri: cim:ExpectedEnergyValues
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketQualitySystem
description: "Model Expected Energy from Market Clearing.\r\n"
attributes:
energyTypeCode:
slot_uri: cim:ExpectedEnergyValues.energyTypeCode
range: string
required: false
multivalued: false
expectedMwh:
slot_uri: cim:ExpectedEnergyValues.expectedMwh
range: float
required: false
multivalued: false
ExpectedEnergy:
slot_uri: cim:ExpectedEnergyValues.ExpectedEnergy
range: ExpectedEnergy
required: true
multivalued: false
RegisteredResource:
slot_uri: cim:ExpectedEnergyValues.RegisteredResource
range: RegisteredResource
required: false
multivalued: false
ExpectedEnergy:
class_uri: cim:ExpectedEnergy
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketQualitySystem
description: "Model Expected Energy from Market Clearing, interval based.\r\n"
attributes:
intervalStartTime:
slot_uri: cim:ExpectedEnergy.intervalStartTime
range: date
required: false
multivalued: false
updateTimeStamp:
slot_uri: cim:ExpectedEnergy.updateTimeStamp
range: date
required: false
multivalued: false
updateUser:
slot_uri: cim:ExpectedEnergy.updateUser
range: string
required: false
multivalued: false
ExpectedEnergyValues:
slot_uri: cim:ExpectedEnergy.ExpectedEnergyValues
range: ExpectedEnergyValues
required: true
multivalued: true
ResourceLoadFollowingInst:
class_uri: cim:ResourceLoadFollowingInst
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: "Model of market clearing results for resources that bid to follow\
\ load.\r\n"
attributes:
calcLoadFollowingMW:
slot_uri: cim:ResourceLoadFollowingInst.calcLoadFollowingMW
range: float
required: false
multivalued: false
description: "weighted average for RTPD and RTCD and same for RTID\r\n"
dispWindowHighLimt:
slot_uri: cim:ResourceLoadFollowingInst.dispWindowHighLimt
range: float
required: false
multivalued: false
dispWindowLowLimt:
slot_uri: cim:ResourceLoadFollowingInst.dispWindowLowLimt
range: float
required: false
multivalued: false
instructionID:
slot_uri: cim:ResourceLoadFollowingInst.instructionID
range: string
required: false
multivalued: false
description: "Unique instruction id per instruction, assigned by the SC and\
\ provided to ADS. ADS passes through.\r\n"
intervalStartTime:
slot_uri: cim:ResourceLoadFollowingInst.intervalStartTime
range: date
required: false
multivalued: false
description: "The start of the time interval for which requirement is defined.\r\
\n"
RegisteredResource:
slot_uri: cim:ResourceLoadFollowingInst.RegisteredResource
range: RegisteredResource
required: false
multivalued: false
ResourceClearing:
slot_uri: cim:ResourceLoadFollowingInst.ResourceClearing
range: ResourceClearing
required: false
multivalued: false
ResourceClearing:
class_uri: cim:ResourceClearing
is_a: MarketFactors
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: "Model of market results, including cleaing result of resources.\
\ Associated with ResourceDispatchResults.\r\n"
attributes:
ResourceDispatchResults:
slot_uri: cim:ResourceClearing.ResourceDispatchResults
range: ResourceDispatchResults
required: true
multivalued: true
ResourceLoadFollowingInst:
slot_uri: cim:ResourceClearing.ResourceLoadFollowingInst
range: ResourceLoadFollowingInst
required: false
multivalued: true
ResourceDispatchResults:
class_uri: cim:ResourceDispatchResults
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: "The ResourceDispatchResults class provides market results that can\
\ be provided to a SC. The specific data provided consists of several indicators\
\ such as contingency flags, blocked start up, and RMR dispatch. It also provides\
\ the projected overall and the regulating status of the resource.\r\n"
attributes:
blockedDispatch:
slot_uri: cim:ResourceDispatchResults.blockedDispatch
range: string
required: false
multivalued: false
description: "Blocked Dispatch Indicator (Yes/No)\r\n"
blockedPublishDOP:
slot_uri: cim:ResourceDispatchResults.blockedPublishDOP
range: string
required: false
multivalued: false
description: "Block sending DOP to ADS (Y/N)\r\n"
contingencyFlag:
slot_uri: cim:ResourceDispatchResults.contingencyFlag
range: YesNo
required: false
multivalued: false
description: Contingent Operating Reserve Indicator (Yes/No). Resource participating
with AS capacity in contingency dispatch.
limitIndicator:
slot_uri: cim:ResourceDispatchResults.limitIndicator
range: string
required: false
multivalued: false
description: "indicate which limit is the constraints\r\n"
lowerLimit:
slot_uri: cim:ResourceDispatchResults.lowerLimit
range: float
required: false
multivalued: false
description: "resource energy ramping lower limit\r\n"
maxRampRate:
slot_uri: cim:ResourceDispatchResults.maxRampRate
range: float
required: false
multivalued: false
description: "maximum ramp rate\r\n"
operatingLimitHigh:
slot_uri: cim:ResourceDispatchResults.operatingLimitHigh
range: float
required: false
multivalued: false
description: "The upper operating limit incorporating any derate used by the\
\ RTD for the Binding Interval. \r\n"
operatingLimitLow:
slot_uri: cim:ResourceDispatchResults.operatingLimitLow
range: float
required: false
multivalued: false
description: "The lower operating limit incorporating any derate used by the\
\ RTD for the Binding Interval. \r\n"
penaltyDispatchIndicator:
slot_uri: cim:ResourceDispatchResults.penaltyDispatchIndicator
range: YesNo
required: false
multivalued: false
description: Penalty Dispatch Indicator (Yes / No) indicating an un-economic
adjustment.
regulatingLimitHigh:
slot_uri: cim:ResourceDispatchResults.regulatingLimitHigh
range: float
required: false
multivalued: false
description: "The upper regulating limit incorporating any derate used by\
\ the RTD for the Binding Interval. \r\n"
regulatingLimitLow:
slot_uri: cim:ResourceDispatchResults.regulatingLimitLow
range: float
required: false
multivalued: false
description: "The lower regulating limit incorporating any derate used by\
\ the RTD for the Binding Interval. \r\n"
resourceStatus:
slot_uri: cim:ResourceDispatchResults.resourceStatus
range: string
required: false
multivalued: false
description: "Unit Commitment Status (On/Off/Starting)\r\n"
totalSchedule:
slot_uri: cim:ResourceDispatchResults.totalSchedule
range: float
required: false
multivalued: false
description: "Resource total upward schedule. total schedule = En + all AS\
\ per resource per interval\r\n"
updateTimeStamp:
slot_uri: cim:ResourceDispatchResults.updateTimeStamp
range: date
required: false
multivalued: false
updateType:
slot_uri: cim:ResourceDispatchResults.updateType
range: MQSCHGType
required: false
multivalued: false
updateUser:
slot_uri: cim:ResourceDispatchResults.updateUser
range: string
required: false
multivalued: false
upperLimit:
slot_uri: cim:ResourceDispatchResults.upperLimit
range: float
required: false
multivalued: false
description: "resource energy ramping upper limit\r\n"
ResourceClearing:
slot_uri: cim:ResourceDispatchResults.ResourceClearing
range: ResourceClearing
required: false
multivalued: false
RegisteredResource:
slot_uri: cim:ResourceDispatchResults.RegisteredResource
range: RegisteredResource
required: false
multivalued: false
LoadFollowingInst:
class_uri: cim:LoadFollowingInst
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ParticipantInterfaces
description: "Metered SubSystem Load Following Instruction.\r\n"
attributes:
endTime:
slot_uri: cim:LoadFollowingInst.endTime
range: date
required: false
multivalued: false
description: "Instruction End Time\r\n"
loadFollowingMW:
slot_uri: cim:LoadFollowingInst.loadFollowingMW
range: float
required: false
multivalued: false
description: "Load Following MW Positive for follow-up and negative for follow-down\r\
\n"
mssInstructionID:
slot_uri: cim:LoadFollowingInst.mssInstructionID
range: string
required: false
multivalued: false
description: "Unique instruction id per instruction, assigned by the SC and\
\ provided to ADS. ADS passes through.\r\n"
startTime:
slot_uri: cim:LoadFollowingInst.startTime
range: date
required: false
multivalued: false
description: "Instruction Start Time\r\n"
RegisteredResource:
slot_uri: cim:LoadFollowingInst.RegisteredResource
range: RegisteredResource
required: true
multivalued: false
AllocationResultValues:
class_uri: cim:AllocationResultValues
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketQualitySystem
description: "Models Market clearing results in terms of price and MW values.\r\
\n"
attributes:
aggregateType:
slot_uri: cim:AllocationResultValues.aggregateType
range: string
required: false
multivalued: false
description: "\"1\" -- \"Detail\",\r\n\"2\" -- \"Aggregate by Market service\
\ type\", in which case, the \"AllocationEnergyType\" field will not be\
\ filled;\r\n\"3\" -- \"Aggregate by \"AllocationEnergyType\", in which\
\ case \"MarketServiceType\" will not be filled.\r\n"
allocationMwHour:
slot_uri: cim:AllocationResultValues.allocationMwHour
range: float
required: false
multivalued: false
allocationPrice:
slot_uri: cim:AllocationResultValues.allocationPrice
range: float
required: false
multivalued: false
energyTypeCode:
slot_uri: cim:AllocationResultValues.energyTypeCode
range: string
required: false
multivalued: false
marketServiceType:
slot_uri: cim:AllocationResultValues.marketServiceType
range: string
required: false
multivalued: false
description: "Choices are: \r\nME - Market Energy Capacity; \r\nSR - Spinning\
\ Reserve Capacity; \r\nNR - Non-Spinning Reserve Capacity; \r\nDAC - Day\
\ Ahead Capacity; \r\nDEC - Derate Capacity\r\n"
RegisteredResource:
slot_uri: cim:AllocationResultValues.RegisteredResource
range: RegisteredResource
required: false
multivalued: false
AllocationResult:
slot_uri: cim:AllocationResultValues.AllocationResult
range: AllocationResult
required: true
multivalued: false
AllocationResult:
class_uri: cim:AllocationResult
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketQualitySystem
description: "Models Market clearing results. Indicates market horizon, interval\
\ based. Used by a market quality system for billing and settlement purposes.\r\
\n"
attributes:
intervalStartTime:
slot_uri: cim:AllocationResult.intervalStartTime
range: date
required: false
multivalued: false
updateTimeStamp:
slot_uri: cim:AllocationResult.updateTimeStamp
range: date
required: false
multivalued: false
updateUser:
slot_uri: cim:AllocationResult.updateUser
range: string
required: false
multivalued: false
AllocationResultValues:
slot_uri: cim:AllocationResult.AllocationResultValues
range: AllocationResultValues
required: true
multivalued: true
Commitments:
class_uri: cim:Commitments
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: "Provides the necessary information (on a resource basis) to capture\
\ the Startup/Shutdown commitment results. This information is relevant to all\
\ markets.\r\n"
attributes:
commitmentType:
slot_uri: cim:Commitments.commitmentType
range: CommitmentType
required: false
multivalued: false
description: "the type of UC status (self commitment, ISO commitment, or SCUC\
\ commitment)\r\n"
instructionCost:
slot_uri: cim:Commitments.instructionCost
range: float
required: false
multivalued: false
description: "Total cost associated with changing the status of the resource.\r\
\n"
instructionType:
slot_uri: cim:Commitments.instructionType
range: AutomaticDispInstTypeCommitment
required: false
multivalued: false
description: Indicator of either a Start-Up or a Shut-Down.
intervalEndTime:
slot_uri: cim:Commitments.intervalEndTime
range: date
required: false
multivalued: false
description: "End time for the commitment period. This will be on an interval\
\ boundary.\r\n"
intervalStartTime:
slot_uri: cim:Commitments.intervalStartTime
range: date
required: false
multivalued: false
description: "Start time for the commitment period. This will be on an interval\
\ boundary.\r\n"
minStatusChangeTime:
slot_uri: cim:Commitments.minStatusChangeTime
range: integer
required: false
multivalued: false
description: "SCUC commitment period start-up time. Calculated start up time\
\ based on the StartUpTimeCurve provided with the Bid.\r\n\r\nThis is a\
\ combination of StartUp time bid and Unit down time. \r\n\r\nUnits is minutes\r\
\n"
noLoadCost:
slot_uri: cim:Commitments.noLoadCost
range: float
required: false
multivalued: false
description: "Unit no load cost in case of energy commodity\r\n"
updateTimeStamp:
slot_uri: cim:Commitments.updateTimeStamp
range: date
required: false
multivalued: false
updateType:
slot_uri: cim:Commitments.updateType
range: MQSCHGType
required: false
multivalued: false
updateUser:
slot_uri: cim:Commitments.updateUser
range: string
required: false
multivalued: false
CommitmentClearing:
slot_uri: cim:Commitments.CommitmentClearing
range: CommitmentClearing
required: true
multivalued: true
RegisteredResource:
slot_uri: cim:Commitments.RegisteredResource
range: RegisteredResource
required: true
multivalued: false
CommitmentClearing:
class_uri: cim:CommitmentClearing
is_a: MarketFactors
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: "Models results of market clearing which call for commitment of units.\r\
\n"
attributes:
Commitments:
slot_uri: cim:CommitmentClearing.Commitments
range: Commitments
required: true
multivalued: true
RMROperatorInput:
class_uri: cim:RMROperatorInput
is_a: MarketFactors
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: RMR Operator's entry of the RMR requirement per market interval.
attributes:
manuallySchedRMRMw:
slot_uri: cim:RMROperatorInput.manuallySchedRMRMw
range: float
required: false
multivalued: false
description: "The lower of the original pre-dispatch or the AC run schedule\
\ (Also known as the RMR Reguirement) becomes the pre-dispatch value. \r\
\n"
updateTimeStamp:
slot_uri: cim:RMROperatorInput.updateTimeStamp
range: date
required: false
multivalued: false
updateType:
slot_uri: cim:RMROperatorInput.updateType
range: MQSCHGType
required: false
multivalued: false
updateUser:
slot_uri: cim:RMROperatorInput.updateUser
range: string
required: false
multivalued: false
RegisteredResource:
slot_uri: cim:RMROperatorInput.RegisteredResource
range: RegisteredResource
required: false
multivalued: false
OrgResOwnership:
class_uri: cim:OrgResOwnership
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: This class model the ownership percent and type of ownership between
resource and organisation.
attributes:
asscType:
slot_uri: cim:OrgResOwnership.asscType
range: ResourceAssnType
required: false
multivalued: false
description: 'association type for the association between Organisation and
Resource:'
masterSchedulingCoordinatorFlag:
slot_uri: cim:OrgResOwnership.masterSchedulingCoordinatorFlag
range: YesNo
required: false
multivalued: false
description: "Flag to indicate that the SC representing the Resource is the\
\ Master SC.\r\n"
ownershipPercent:
slot_uri: cim:OrgResOwnership.ownershipPercent
range: PerCent
required: false
multivalued: false
description: "ownership percentage for each resource\r\n"
RegisteredResource:
slot_uri: cim:OrgResOwnership.RegisteredResource
range: RegisteredResource
required: true
multivalued: false
DispatchInstReply:
class_uri: cim:DispatchInstReply
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ParticipantInterfaces
description: "Response from registered resource acknowledging receipt of dispatch\
\ instructions.\r\n"
attributes:
acceptMW:
slot_uri: cim:DispatchInstReply.acceptMW
range: ActivePower
required: false
multivalued: false
description: "The accepted mw amount by the responder. aka response mw.\r\n"
acceptStatus:
slot_uri: cim:DispatchInstReply.acceptStatus
range: DispatchResponseType
required: false
multivalued: false
description: The accept status submitted by the responder. enumeration type
needs to be defined
certificationName:
slot_uri: cim:DispatchInstReply.certificationName
range: string
required: false
multivalued: false
description: "The Subject DN is the X509 Certificate Subject DN. This is the\
\ essentially the certificate name presented by the client. In the case\
\ of ADS Certificates, this will be the user name. It may be from an API\
\ Client or the MP Client (GUI).\r\n\r\nThe Subject ID normally includes\
\ more than just the user name (Common Name), it can also contain information\
\ such as City, Company ID, etc.\r\n"
clearedMW:
slot_uri: cim:DispatchInstReply.clearedMW
range: ActivePower
required: false
multivalued: false
description: "MW amount associated with instruction. For 5 minute binding\
\ dispatches, this is the Goto MW or DOT\r\n"
instructionTime:
slot_uri: cim:DispatchInstReply.instructionTime
range: date
required: false
multivalued: false
description: "The target date/time for the received instruction.\r\n"
instructionType:
slot_uri: cim:DispatchInstReply.instructionType
range: string
required: false
multivalued: false
description: "instruction type:\r\n\r\ncommitment\r\nout of sequence\r\ndispatch\r\
\n"
passIndicator:
slot_uri: cim:DispatchInstReply.passIndicator
range: PassIndicatorType
required: false
multivalued: false
description: "The type of run for the market clearing.\r\n"
receivedTime:
slot_uri: cim:DispatchInstReply.receivedTime
range: date
required: false
multivalued: false
description: "Timestamp indicating the time at which the instruction was received.\
\ \r\n"
startTime:
slot_uri: cim:DispatchInstReply.startTime
range: date
required: false
multivalued: false
description: "start time\r\n"
RegisteredResource:
slot_uri: cim:DispatchInstReply.RegisteredResource
range: RegisteredResource
required: true
multivalued: false
ForbiddenRegion:
class_uri: cim:ForbiddenRegion
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: "Forbbiden region is operating ranges where the units are unable\
\ to maintain steady operation without causing equipment damage. The four attributes\
\ that define a forbidden region are the low MW, the High MW, the crossing time,\
\ and the crossing cost.\r\n"
attributes:
crossingCost:
slot_uri: cim:ForbiddenRegion.crossingCost
range: float
required: false
multivalued: false
description: "Cost associated with crossing the forbidden region\r\n"
crossTime:
slot_uri: cim:ForbiddenRegion.crossTime
range: integer
required: false
multivalued: false
description: "Time to cross the forbidden region in minutes.\r\n"
highMW:
slot_uri: cim:ForbiddenRegion.highMW
range: float
required: false
multivalued: false
description: "High end of the region definition\r\n"
lowMW:
slot_uri: cim:ForbiddenRegion.lowMW
range: float
required: false
multivalued: false
description: "Low end of the region definition.\r\n"
RegisteredResource:
slot_uri: cim:ForbiddenRegion.RegisteredResource
range: RegisteredResource
required: false
multivalued: true
Period:
class_uri: cim:Period
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketManagement
description: An identification of a time interval that may have a given resolution.
attributes:
resolution:
slot_uri: cim:Period.resolution
range: integer
required: false
multivalued: false
description: "The number of units of time that compose an individual step\
\ within a period.\r\n"
timeInterval:
slot_uri: cim:Period.timeInterval
range: DateTimeInterval
required: false
multivalued: false
description: "The start and end date and time for a given interval.\r\n"
Reason:
slot_uri: cim:Period.Reason
range: Reason
required: false
multivalued: true
MarketDocument:
slot_uri: cim:Period.MarketDocument
range: MarketDocument
required: false
multivalued: true
TimeSeries:
slot_uri: cim:Period.TimeSeries
range: TimeSeries
required: false
multivalued: true
Point:
slot_uri: cim:Period.Point
range: Point
required: false
multivalued: true
FlowDirection:
class_uri: cim:FlowDirection
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketManagement
description: The coded identification of the direction of energy flow.
attributes:
direction:
slot_uri: cim:FlowDirection.direction
range: string
required: false
multivalued: false
description: The coded identification of the direction of energy flow.
Point:
slot_uri: cim:FlowDirection.Point
range: Point
required: false
multivalued: true
TimeSeries:
slot_uri: cim:FlowDirection.TimeSeries
range: TimeSeries
required: false
multivalued: true
Unit:
class_uri: cim:Unit
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketManagement
description: "The identification of the unit name for the time series quantities.\r\
\n"
attributes:
name:
slot_uri: cim:Unit.name
range: string
required: false
multivalued: false
description: "The coded representation of the unit.\r\n"
TimeSeries:
slot_uri: cim:Unit.TimeSeries
range: TimeSeries
required: false
multivalued: true
AceTariffType:
slot_uri: cim:Unit.AceTariffType
range: AceTariffType
required: false
multivalued: true
DateAndOrTime:
class_uri: cim:DateAndOrTime
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketManagement
description: The date and/or the time.
attributes:
date:
slot_uri: cim:DateAndOrTime.date
range: date
required: false
multivalued: false
description: Date as "yyyy-mm-dd", which conforms with ISO 8601
time:
slot_uri: cim:DateAndOrTime.time
range: time
required: false
multivalued: false
description: Time as "hh:mm:ss.sssZ", which conforms with ISO 8601.
MarketDocument:
slot_uri: cim:DateAndOrTime.MarketDocument
range: MarketDocument
required: false
multivalued: true
TimeSeries:
slot_uri: cim:DateAndOrTime.TimeSeries
range: TimeSeries
required: false
multivalued: true
Auction:
class_uri: cim:Auction
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketManagement
description: A class providing the identification and type of an auction.
attributes:
allocationMode:
slot_uri: cim:Auction.allocationMode
range: string
required: false
multivalued: false
description: Identification of the method of allocation in an auction.
cancelled:
slot_uri: cim:Auction.cancelled
range: string
required: false
multivalued: false
description: An indicator that signifies that the auction has been cancelled.
category:
slot_uri: cim:Auction.category
range: string
required: false
multivalued: false
description: The product category of an auction.
paymentTerms:
slot_uri: cim:Auction.paymentTerms
range: string
required: false
multivalued: false
description: The terms which dictate the determination of the bid payment
price.
rights:
slot_uri: cim:Auction.rights
range: string
required: false
multivalued: false
description: The rights of use the transmission capacity acquired in an auction.
type:
slot_uri: cim:Auction.type
range: string
required: false
multivalued: false
description: "The kind of the Auction (e.g. implicit, explicit ...).\r\n"
TimeSeries:
slot_uri: cim:Auction.TimeSeries
range: TimeSeries
required: false
multivalued: true
MktPSRType:
class_uri: cim:MktPSRType
is_a: PSRType
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketManagement
description: The type of a power system resource.
attributes:
psrType:
slot_uri: cim:MktPSRType.psrType
range: string
required: false
multivalued: false
description: The coded type of a power system resource.
TimeSeries:
slot_uri: cim:MktPSRType.TimeSeries
range: TimeSeries
required: false
multivalued: true
PSRType:
class_uri: cim:PSRType
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Core
description: Classifying instances of the same class, e.g. overhead and underground
ACLineSegments. This classification mechanism is intended to provide flexibility
outside the scope of this document, i.e. provide customisation that is non standard.
attributes:
PowerSystemResources:
slot_uri: cim:PSRType.PowerSystemResources
range: PowerSystemResource
required: false
multivalued: true
description: Power system resources classified with this power system resource
type.
MarketEvaluationPoint:
class_uri: cim:MarketEvaluationPoint
is_a: UsagePoint
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketManagement
description: The identification of an entity where energy products are measured
or computed.
attributes:
TimeSeries:
slot_uri: cim:MarketEvaluationPoint.TimeSeries
range: TimeSeries
required: false
multivalued: true
ReportingCapability:
class_uri: cim:ReportingCapability
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental
description: Definition of one set of reporting capabilities
for this monitoring station. The associated EnvironmentalValueSets describe
the maximum range of possible environmental values the station is capable of
returning. This attribute is intended primarily to assist a utility in managing
its stations.
attributes:
reportingIntervalPeriod:
slot_uri: cim:ReportingCapability.reportingIntervalPeriod
range: integer
required: false
multivalued: false
description: Number of units of time making up reporting period.
reportingIntervalType:
slot_uri: cim:ReportingCapability.reportingIntervalType
range: CalculationIntervalUnitKind
required: false
multivalued: false
description: 'Unit of time in which reporting period is expressed. '
reportingMethod:
slot_uri: cim:ReportingCapability.reportingMethod
range: ReportingMethodKind
required: false
multivalued: false
description: Indicates how the weather station reports observations.
EnvironmentalMonitoringStation:
slot_uri: cim:ReportingCapability.EnvironmentalMonitoringStation
range: EnvironmentalMonitoringStation
required: true
multivalued: false
description: The environmental monitoring station to which this set of reporting
capabilities belong.
EnvironmentalAnalog:
slot_uri: cim:ReportingCapability.EnvironmentalAnalog
range: EnvironmentalAnalog
required: false
multivalued: true
description: One of the environmental value sets expressing one of the reporting
capabilities.
EnvironmentalAnalog:
class_uri: cim:EnvironmentalAnalog
is_a: Analog
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental
description: Analog (float) measurement of relevance in the environmental domain.
attributes:
ReportingCapability:
slot_uri: cim:EnvironmentalAnalog.ReportingCapability
range: ReportingCapability
required: false
multivalued: false
description: The reporting capability this environmental value set helps define.
EnvironmentalInformation:
slot_uri: cim:EnvironmentalAnalog.EnvironmentalInformation
range: EnvironmentalInformation
required: false
multivalued: false
description: Observation or forecast with which this environmental analog
measurement is associated.
ClassificationCondition:
slot_uri: cim:EnvironmentalAnalog.ClassificationCondition
range: ClassificationCondition
required: false
multivalued: false
description: Classification condition which this analog helps define.
EnvironmentalMonitoringStation:
slot_uri: cim:EnvironmentalAnalog.EnvironmentalMonitoringStation
range: EnvironmentalMonitoringStation
required: false
multivalued: false
description: Monitoring station which provides this environmental analog measurement.
EnvironmentalInformation:
class_uri: cim:EnvironmentalInformation
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental
description: 'Abstract class (with concrete child classes of Observation and Forecast)
that groups phenomenon and/or environmental value sets. '
attributes:
created:
slot_uri: cim:EnvironmentalInformation.created
range: date
required: false
multivalued: false
description: The timestamp of when the forecast was created
EnvironmentalDataProvider:
slot_uri: cim:EnvironmentalInformation.EnvironmentalDataProvider
range: EnvironmentalDataProvider
required: false
multivalued: false
description: Environmental data provider supplying this environmental information.
EnvironmentalStringMeasurement:
slot_uri: cim:EnvironmentalInformation.EnvironmentalStringMeasurement
range: EnvironmentalStringMeasurement
required: false
multivalued: true
description: Environmental string measurement associated with this forecast
or observation.
EnvironmentalAnalog:
slot_uri: cim:EnvironmentalInformation.EnvironmentalAnalog
range: EnvironmentalAnalog
required: false
multivalued: true
description: Environmental analog associated with this observation or forecast.
EnvironmentalEvent:
slot_uri: cim:EnvironmentalInformation.EnvironmentalEvent
range: EnvironmentalEvent
required: false
multivalued: true
description: Environmental event to which this forecast or observation relates.
EnvironmentalDiscrete:
slot_uri: cim:EnvironmentalInformation.EnvironmentalDiscrete
range: EnvironmentalDiscrete
required: false
multivalued: true
description: Environmental discrete (integer) associated with this observation
or forecast.
EnvironmentalPhenomenon:
slot_uri: cim:EnvironmentalInformation.EnvironmentalPhenomenon
range: EnvironmentalPhenomenon
required: false
multivalued: true
EnvironmentalStringMeasurement:
class_uri: cim:EnvironmentalStringMeasurement
is_a: StringMeasurement
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental
description: String measurement of relevance in the environmental domain.
attributes:
EnvironmentalInformation:
slot_uri: cim:EnvironmentalStringMeasurement.EnvironmentalInformation
range: EnvironmentalInformation
required: false
multivalued: false
description: Observation or forecast with which this environmental string
is associated.
ClassificationCondition:
slot_uri: cim:EnvironmentalStringMeasurement.ClassificationCondition
range: ClassificationCondition
required: false
multivalued: false
description: Classification condition which this string measurement helps
define.
StringMeasurement:
class_uri: cim:StringMeasurement
is_a: Measurement
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Meas
description: StringMeasurement represents a measurement with values of type string.
attributes:
StringMeasurementValues:
slot_uri: cim:StringMeasurement.StringMeasurementValues
range: StringMeasurementValue
required: false
multivalued: true
description: The values connected to this measurement.
StringMeasurementValue:
class_uri: cim:StringMeasurementValue
is_a: MeasurementValue
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Meas
description: StringMeasurementValue represents a measurement value of type string.
attributes:
value:
slot_uri: cim:StringMeasurementValue.value
range: string
required: false
multivalued: false
description: The value to supervise.
StringMeasurement:
slot_uri: cim:StringMeasurementValue.StringMeasurement
range: StringMeasurement
required: true
multivalued: false
description: Measurement to which this value is connected.
ClassificationCondition:
class_uri: cim:ClassificationCondition
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental
description: A classification condition used to define preconditions that must
be met by a phenomena classification.
attributes:
duration:
slot_uri: cim:ClassificationCondition.duration
range: Seconds
required: false
multivalued: false
description: The duration of the of the condition in seconds
test:
slot_uri: cim:ClassificationCondition.test
range: TestKind
required: false
multivalued: false
description: The test applied to the value.
PhenomenonClassification:
slot_uri: cim:ClassificationCondition.PhenomenonClassification
range: PhenomenonClassification
required: false
multivalued: false
description: Phenomenon classification to which this condition relates.
EnvironmentalStringMeasurement:
slot_uri: cim:ClassificationCondition.EnvironmentalStringMeasurement
range: EnvironmentalStringMeasurement
required: false
multivalued: true
description: String measurement which contributes to the definition of this
classification condition.
EnvironmentalAnalog:
slot_uri: cim:ClassificationCondition.EnvironmentalAnalog
range: EnvironmentalAnalog
required: false
multivalued: true
description: Analog which contributes to the definition of this classification
condition.
PhenomenonClassification:
class_uri: cim:PhenomenonClassification
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental
description: A pre-defined phenomenon classification as defined by a particular
authority.
attributes:
EnvironmentalDataAuthority:
slot_uri: cim:PhenomenonClassification.EnvironmentalDataAuthority
range: EnvironmentalDataAuthority
required: false
multivalued: false
description: Authority defining this environmental phenomenon.
ClassificationCondition:
slot_uri: cim:PhenomenonClassification.ClassificationCondition
range: ClassificationCondition
required: false
multivalued: true
description: Condition contributing to the classification of this phenomenon.
EnvironmentalPhenomenon:
slot_uri: cim:PhenomenonClassification.EnvironmentalPhenomenon
range: EnvironmentalPhenomenon
required: false
multivalued: true
EnvironmentalPhenomenon:
class_uri: cim:EnvironmentalPhenomenon
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental
description: 'The actual or forecast characteristics of an environmental phenomenon
at a specific point in time (or during a specific time interval) that may have
both a center and area/line location. '
attributes:
timeInterval:
slot_uri: cim:EnvironmentalPhenomenon.timeInterval
range: DateTimeInterval
required: false
multivalued: false
description: The timestamp of the phenomenon as a single point or time interval.
EnvironmentalLocationKind:
slot_uri: cim:EnvironmentalPhenomenon.EnvironmentalLocationKind
range: EnvironmentalLocationType
required: false
multivalued: true
description: Location of relevance to this environmental phenomenon.
PhenomenonClassification:
slot_uri: cim:EnvironmentalPhenomenon.PhenomenonClassification
range: PhenomenonClassification
required: false
multivalued: false
description: The classification of this phenomenon.
EnvironmentalInformation:
slot_uri: cim:EnvironmentalPhenomenon.EnvironmentalInformation
range: EnvironmentalInformation
required: false
multivalued: false
description: The forecast or observation of which this phenomenon description
is a part.
EnvironmentalLocationType:
class_uri: cim:EnvironmentalLocationType
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental
description: Type of environmental location. Used when an environmental alert
or phenomenon has multiple locations associated with it.
attributes:
kind:
slot_uri: cim:EnvironmentalLocationType.kind
range: LocationKind
required: false
multivalued: false
description: 'The kind of location. Typical values might be center, extent,
primary, secondary, etc. '
Location:
slot_uri: cim:EnvironmentalLocationType.Location
range: Location
required: false
multivalued: false
description: 'Location of this instance of ths kind of environmental location. '
EnvironmentalPhenomenon:
slot_uri: cim:EnvironmentalLocationType.EnvironmentalPhenomenon
range: EnvironmentalPhenomenon
required: false
multivalued: true
description: Environmental phenomenon for which this location is of relevance.
EnvironmentalAlert:
slot_uri: cim:EnvironmentalLocationType.EnvironmentalAlert
range: EnvironmentalAlert
required: false
multivalued: true
description: Environmental alert applying to location of this type.
EnvironmentalAlert:
class_uri: cim:EnvironmentalAlert
is_a: ActivityRecord
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental
description: An environmental alert issued by a provider or system.
attributes:
alertType:
slot_uri: cim:EnvironmentalAlert.alertType
range: string
required: false
multivalued: false
description: 'The type of the issued alert which is drawn from the specified
alert type list. '
cancelledDateTime:
slot_uri: cim:EnvironmentalAlert.cancelledDateTime
range: date
required: false
multivalued: false
description: Time and date alert cancelled. Used only if alert is cancelled
before it expires.
headline:
slot_uri: cim:EnvironmentalAlert.headline
range: string
required: false
multivalued: false
description: "An abbreviated textual description of the alert issued. \r\n\
Note: the full text of the alert appears in the .description attribute (inherited\
\ from IdentifiedObject)."
inEffect:
slot_uri: cim:EnvironmentalAlert.inEffect
range: DateTimeInterval
required: false
multivalued: false
description: The interval for which this weather alert is in effect.
AlertTypeList:
slot_uri: cim:EnvironmentalAlert.AlertTypeList
range: AlertTypeList
required: true
multivalued: false
description: The list of alert types from which the type of this alert is
drawn.
EnvironmentalLocationKind:
slot_uri: cim:EnvironmentalAlert.EnvironmentalLocationKind
range: EnvironmentalLocationType
required: true
multivalued: true
description: Type of location to which this environmental alert applies.
EnvironmentalDataProvider:
slot_uri: cim:EnvironmentalAlert.EnvironmentalDataProvider
range: EnvironmentalDataProvider
required: false
multivalued: false
description: Environmental data provider for this alert.
AlertTypeList:
class_uri: cim:AlertTypeList
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental
description: "A named list of alert types.\r\nNote: the name of the list is reflected\
\ in the .name attribute (inherited from IdentifiedObject)."
attributes:
version:
slot_uri: cim:AlertTypeList.version
range: string
required: false
multivalued: false
description: The version of the named list of alert types.
EnvironmentalDataAuthority:
slot_uri: cim:AlertTypeList.EnvironmentalDataAuthority
range: EnvironmentalDataAuthority
required: false
multivalued: false
description: The environmental data authority responsible for publishing this
list of alert types.
EnvironmentalAlert:
slot_uri: cim:AlertTypeList.EnvironmentalAlert
range: EnvironmentalAlert
required: false
multivalued: true
description: An alert whose type is drawn from this alert type list.
EnvironmentalDataAuthority:
class_uri: cim:EnvironmentalDataAuthority
is_a: OrganisationRole
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental
description: An entity defining classifications or categories of environmental
information, like phenomena or alerts.
attributes:
AlertTypeList:
slot_uri: cim:EnvironmentalDataAuthority.AlertTypeList
range: AlertTypeList
required: false
multivalued: true
description: A specific version of a list of alerts published by this environmental
data authority.
PhenomenonClassification:
slot_uri: cim:EnvironmentalDataAuthority.PhenomenonClassification
range: PhenomenonClassification
required: false
multivalued: true
description: Phenomenon classification defined by this environmental data
authority.
EnvironmentalDataProvider:
class_uri: cim:EnvironmentalDataProvider
is_a: OrganisationRole
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental
description: Entity providing environmental data. Could be an observed weather
data provider, an entity providing forecasts, an authority providing alerts,
etc.
attributes:
EnvironmentalAlert:
slot_uri: cim:EnvironmentalDataProvider.EnvironmentalAlert
range: EnvironmentalAlert
required: false
multivalued: true
description: Alert issued by this environmental data provider.
EnvironmentalInformation:
slot_uri: cim:EnvironmentalDataProvider.EnvironmentalInformation
range: EnvironmentalInformation
required: false
multivalued: true
description: Environmental information provided by this environmental data
provider.
EnvironmentalEvent:
class_uri: cim:EnvironmentalEvent
is_a: ActivityRecord
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental
description: "An environmental event to which one or more forecasts or observations\
\ may be tied and which may relate to or affect one or more assets.\r\nThis\
\ class is intended to be used as a means of grouping forecasts and/or observations\
\ and could be used for a variety of purposes, including:\r\n\r\n\t- to\
\ define a 'named' event like Hurricane Katrina and allow the historic (or forecast)\
\ values for phenomena and measurements (precipitation, temperature) across\
\ time to be associated with it
\r\n\t- to identify assets that were\
\ (or are forecast to be) affected by a phenomenon or set of measurements
\r\
\n
"
attributes:
EnvironmentalInformation:
slot_uri: cim:EnvironmentalEvent.EnvironmentalInformation
range: EnvironmentalInformation
required: false
multivalued: true
description: Forecast or observation related to this environmental event.
EnvironmentalDiscrete:
class_uri: cim:EnvironmentalDiscrete
is_a: Discrete
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental
description: Discrete (integer) measurement of relevance in the environmental
domain.
attributes:
kind:
slot_uri: cim:EnvironmentalDiscrete.kind
range: EnvironmentalDiscreteKind
required: true
multivalued: false
description: Kind of environmental discrete (integer).
EnvironmentalInformation:
slot_uri: cim:EnvironmentalDiscrete.EnvironmentalInformation
range: EnvironmentalInformation
required: false
multivalued: false
description: Observation or forecast with which this environmental discrete
(integer) is associated.
Discrete:
class_uri: cim:Discrete
is_a: Measurement
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Meas
description: Discrete represents a discrete Measurement, i.e. a Measurement representing
discrete values, e.g. a Breaker position.
attributes:
maxValue:
slot_uri: cim:Discrete.maxValue
range: integer
required: false
multivalued: false
description: Normal value range maximum for any of the MeasurementValue.values.
Used for scaling, e.g. in bar graphs or of telemetered raw values.
minValue:
slot_uri: cim:Discrete.minValue
range: integer
required: false
multivalued: false
description: "Normal value range minimum for any of the MeasurementValue.values.\
\ Used for scaling, e.g. in bar graphs or of telemetered raw values.\r\n"
normalValue:
slot_uri: cim:Discrete.normalValue
range: integer
required: false
multivalued: false
description: Normal measurement value, e.g., used for percentage calculations.
DiscreteValues:
slot_uri: cim:Discrete.DiscreteValues
range: DiscreteValue
required: false
multivalued: true
description: The values connected to this measurement.
ValueAliasSet:
slot_uri: cim:Discrete.ValueAliasSet
range: ValueAliasSet
required: false
multivalued: false
description: The ValueAliasSet used for translation of a MeasurementValue.value
to a name.
ValueAliasSet:
class_uri: cim:ValueAliasSet
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Meas
description: Describes the translation of a set of values into a name and is intendend
to facilitate custom translations. Each ValueAliasSet has a name, description
etc. A specific Measurement may represent a discrete state like Open, Closed,
Intermediate etc. This requires a translation from the MeasurementValue.value
number to a string, e.g. 0->"Invalid", 1->"Open", 2->"Closed", 3->"Intermediate".
Each ValueToAlias member in ValueAliasSet.Value describe a mapping for one particular
value to a name.
attributes:
Values:
slot_uri: cim:ValueAliasSet.Values
range: ValueToAlias
required: true
multivalued: true
description: The ValueToAlias mappings included in the set.
Discretes:
slot_uri: cim:ValueAliasSet.Discretes
range: Discrete
required: false
multivalued: true
description: The Measurements using the set for translation.
Commands:
slot_uri: cim:ValueAliasSet.Commands
range: Command
required: false
multivalued: true
description: The Commands using the set for translation.
RaiseLowerCommands:
slot_uri: cim:ValueAliasSet.RaiseLowerCommands
range: RaiseLowerCommand
required: false
multivalued: true
description: The Commands using the set for translation.
Command:
class_uri: cim:Command
is_a: Control
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Meas
description: A Command is a discrete control used for supervisory control.
attributes:
normalValue:
slot_uri: cim:Command.normalValue
range: integer
required: false
multivalued: false
description: "Normal value for Control.value e.g. used for percentage scaling.\r\
\n"
value:
slot_uri: cim:Command.value
range: integer
required: false
multivalued: false
description: "The value representing the actuator output.\r\n"
ValueAliasSet:
slot_uri: cim:Command.ValueAliasSet
range: ValueAliasSet
required: false
multivalued: false
description: The ValueAliasSet used for translation of a Control value to
a name.
DiscreteValue:
slot_uri: cim:Command.DiscreteValue
range: DiscreteValue
required: true
multivalued: false
description: The MeasurementValue that is controlled.
DiscreteValue:
class_uri: cim:DiscreteValue
is_a: MeasurementValue
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Meas
description: DiscreteValue represents a discrete MeasurementValue.
attributes:
value:
slot_uri: cim:DiscreteValue.value
range: integer
required: false
multivalued: false
description: The value to supervise.
Command:
slot_uri: cim:DiscreteValue.Command
range: Command
required: false
multivalued: false
description: The Control variable associated with the MeasurementValue.
Discrete:
slot_uri: cim:DiscreteValue.Discrete
range: Discrete
required: true
multivalued: false
description: Measurement to which this value is connected.
RaiseLowerCommand:
class_uri: cim:RaiseLowerCommand
is_a: AnalogControl
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Meas
description: 'An analog control that increases or decreases a set point value
with pulses. Unless otherwise specified, one pulse moves the set point by one. '
attributes:
ValueAliasSet:
slot_uri: cim:RaiseLowerCommand.ValueAliasSet
range: ValueAliasSet
required: false
multivalued: false
description: The ValueAliasSet used for translation of a Control value to
a name.
ValueToAlias:
class_uri: cim:ValueToAlias
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Meas
description: Describes the translation of one particular value into a name, e.g.
1 as "Open".
attributes:
value:
slot_uri: cim:ValueToAlias.value
range: integer
required: false
multivalued: false
description: "The value that is mapped.\r\n"
ValueAliasSet:
slot_uri: cim:ValueToAlias.ValueAliasSet
range: ValueAliasSet
required: true
multivalued: false
description: The ValueAliasSet having the ValueToAlias mappings.
ServiceMultiplier:
class_uri: cim:ServiceMultiplier
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
description: "Multiplier applied at the usage point.\r\n"
attributes:
kind:
slot_uri: cim:ServiceMultiplier.kind
range: ServiceMultiplierKind
required: false
multivalued: false
description: "Kind of multiplier.\r\n"
value:
slot_uri: cim:ServiceMultiplier.value
range: float
required: false
multivalued: false
description: "Multiplier value.\r\n"
UsagePoint:
slot_uri: cim:ServiceMultiplier.UsagePoint
range: UsagePoint
required: false
multivalued: false
description: Usage point applying this multiplier.
TimePoint:
class_uri: cim:TimePoint
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Common
description: A point in time within a sequence of points in time relative to a
time schedule.
attributes:
dateTime:
slot_uri: cim:TimePoint.dateTime
range: date
required: false
multivalued: false
description: "Absolute date and time for this time point. For calendar-based\
\ time point, it is typically manually entered, while for interval-based\
\ or sequence-based time point it is derived.\r\n"
relativeTimeInterval:
slot_uri: cim:TimePoint.relativeTimeInterval
range: Seconds
required: false
multivalued: false
description: (if interval-based) A point in time relative to scheduled start
time in 'TimeSchedule.scheduleInterval.start'.
sequenceNumber:
slot_uri: cim:TimePoint.sequenceNumber
range: integer
required: false
multivalued: false
description: (if sequence-based) Relative sequence number for this time point.
status:
slot_uri: cim:TimePoint.status
range: Status
required: false
multivalued: false
description: Status of this time point.
window:
slot_uri: cim:TimePoint.window
range: DateTimeInterval
required: false
multivalued: false
description: Interval defining the window of time for which this time point
is valid.
TimeSchedule:
slot_uri: cim:TimePoint.TimeSchedule
range: TimeSchedule
required: true
multivalued: false
description: Time schedule owning this time point.
WorkActivityRecord:
class_uri: cim:WorkActivityRecord
is_a: ActivityRecord
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Work
description: 'Records information about the status of work or work task at a point
in time. '
attributes:
percentComplete:
slot_uri: cim:WorkActivityRecord.percentComplete
range: PerCent
required: false
multivalued: false
description: Estimated percentage of completion of this individual work task
or overall work order.
BaseWork:
slot_uri: cim:WorkActivityRecord.BaseWork
range: BaseWork
required: false
multivalued: false
description: Base work that this activity record tracks.
AssetLocationHazard:
class_uri: cim:AssetLocationHazard
is_a: Hazard
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: Potential hazard related to the location of an asset. Examples are
trees growing under overhead power lines, a park being located by a substation
(i.e., children climb fence to recover a ball), a lake near an overhead distribution
line (fishing pole/line contacting power lines), dangerous neighbour, etc.
attributes:
kind:
slot_uri: cim:AssetLocationHazard.kind
range: AssetHazardKind
required: false
multivalued: false
description: Kind of hazard.
Locations:
slot_uri: cim:AssetLocationHazard.Locations
range: Location
required: false
multivalued: true
description: The location of this hazard.
CoordinateSystem:
class_uri: cim:CoordinateSystem
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Common
description: "Coordinate reference system.\r\n"
attributes:
crsUrn:
slot_uri: cim:CoordinateSystem.crsUrn
range: string
required: false
multivalued: false
description: "A Uniform Resource Name (URN) for the coordinate reference system\
\ (crs) used to define 'Location.PositionPoints'.\r\nAn example would be\
\ the European Petroleum Survey Group (EPSG) code for a coordinate reference\
\ system, defined in URN under the Open Geospatial Consortium (OGC) namespace\
\ as: urn:ogc:def:crs:EPSG::XXXX, where XXXX is an EPSG code (a full list\
\ of codes can be found at the EPSG Registry web site http://www.epsg-registry.org/).\
\ To define the coordinate system as being WGS84 (latitude, longitude) using\
\ an EPSG OGC, this attribute would be urn:ogc:def:crs:EPSG::4.3.2.6\r\n\
A profile should limit this code to a set of allowed URNs agreed to by all\
\ sending and receiving parties."
Locations:
slot_uri: cim:CoordinateSystem.Locations
range: Location
required: false
multivalued: true
description: All locations described with position points in this coordinate
system.
PositionPoint:
class_uri: cim:PositionPoint
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Common
description: Set of spatial coordinates that determine a point, defined in the
coordinate system specified in 'Location.CoordinateSystem'. Use a single position
point instance to describe a point-oriented location. Use a sequence of position
points to describe a line-oriented object (physical location of non-point oriented
objects like cables or lines), or area of an object (like a substation or a
geographical zone - in this case, have first and last position point with the
same values).
attributes:
groupNumber:
slot_uri: cim:PositionPoint.groupNumber
range: integer
required: false
multivalued: false
description: Zero-relative sequence number of this group within a series of
points; used when there is a need to express disjoint groups of points that
are considered to be part of a single location.
sequenceNumber:
slot_uri: cim:PositionPoint.sequenceNumber
range: integer
required: false
multivalued: false
description: Zero-relative sequence number of this point within a series of
points.
xPosition:
slot_uri: cim:PositionPoint.xPosition
range: string
required: false
multivalued: false
description: X axis position.
yPosition:
slot_uri: cim:PositionPoint.yPosition
range: string
required: false
multivalued: false
description: Y axis position.
zPosition:
slot_uri: cim:PositionPoint.zPosition
range: string
required: false
multivalued: false
description: (if applicable) Z axis position.
Location:
slot_uri: cim:PositionPoint.Location
range: Location
required: true
multivalued: false
description: Location described by this position point.
SafetyDocument:
class_uri: cim:SafetyDocument
is_a: Document
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Operations
description: Document restricting or authorising works on electrical equipment
(for example a permit to work, sanction for test, limitation of access, or certificate
of isolation), defined based upon organisational practices.
attributes:
issuedDateTime:
slot_uri: cim:SafetyDocument.issuedDateTime
range: date
required: false
multivalued: false
description: Date and time this safety document has been issued.
releasedDateTime:
slot_uri: cim:SafetyDocument.releasedDateTime
range: date
required: false
multivalued: false
description: Date and time this safety document has been released.
IssuedBySupervisor:
slot_uri: cim:SafetyDocument.IssuedBySupervisor
range: OperationsSafetySupervisor
required: false
multivalued: false
description: Supervisor that issued this safety document.
IssuedToSupervisor:
slot_uri: cim:SafetyDocument.IssuedToSupervisor
range: FieldSafetySupervisor
required: false
multivalued: false
description: Supervisor to whom this safety document is issued.
SwitchingPlan:
slot_uri: cim:SafetyDocument.SwitchingPlan
range: SwitchingPlan
required: false
multivalued: false
description: Switching plan to which this safety document applies.
ReleasedToSupervisor:
slot_uri: cim:SafetyDocument.ReleasedToSupervisor
range: OperationsSafetySupervisor
required: false
multivalued: false
description: Supervisor to which this safety document is released.
ReleasedBySupervisor:
slot_uri: cim:SafetyDocument.ReleasedBySupervisor
range: FieldSafetySupervisor
required: false
multivalued: false
description: Supervisor that released this safety document.
OperationsSafetySupervisor:
class_uri: cim:OperationsSafetySupervisor
is_a: Operator
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Operations
description: Operator with responsibility that the work in high voltage installation
is executed in a safe manner and according to safety regulation.
attributes:
IssuedSafetyDocuments:
slot_uri: cim:OperationsSafetySupervisor.IssuedSafetyDocuments
range: SafetyDocument
required: false
multivalued: true
description: All safety documents issued by this supervisor.
ReleasedSafetyDocuments:
slot_uri: cim:OperationsSafetySupervisor.ReleasedSafetyDocuments
range: SafetyDocument
required: false
multivalued: true
description: All safety documents released to this supervisor.
FieldSafetySupervisor:
class_uri: cim:FieldSafetySupervisor
is_a: CrewMember
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Operations
description: Crew member on work site responsible for all local safety measures
for the work crew doing maintenance, construction and repair in a substation
or on a power line/cable.
attributes:
IssuedSafetyDocuments:
slot_uri: cim:FieldSafetySupervisor.IssuedSafetyDocuments
range: SafetyDocument
required: false
multivalued: true
description: All safety documents issued to this supervisor.
ReleasedSafetyDocuments:
slot_uri: cim:FieldSafetySupervisor.ReleasedSafetyDocuments
range: SafetyDocument
required: false
multivalued: true
description: All safety documents released by this supervisor.
ParentOrganization:
class_uri: cim:ParentOrganization
is_a: Organisation
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Common
attributes:
Organisation:
slot_uri: cim:ParentOrganization.Organisation
range: Organisation
required: false
multivalued: true
description: Organisation that is part of this parent organisation.
Editor:
class_uri: cim:Editor
is_a: DocumentPersonRole
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Common
description: Person who modified the document.
attributes:
Documents:
slot_uri: cim:Editor.Documents
range: Document
required: false
multivalued: true
description: All documents for this editor.
Approver:
class_uri: cim:Approver
is_a: DocumentPersonRole
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Common
description: Person who accepted/signed or rejected the document.
attributes:
Documents:
slot_uri: cim:Approver.Documents
range: Document
required: false
multivalued: true
description: All documents for this approver.
Issuer:
class_uri: cim:Issuer
is_a: DocumentPersonRole
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Common
description: ' Person who issued the document and is responsible for its content.'
attributes:
Documents:
slot_uri: cim:Issuer.Documents
range: Document
required: false
multivalued: true
description: All documents for this issuer.
AnalyticScore:
class_uri: cim:AnalyticScore
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: An indicative scoring by an analytic that can be used to characterize
the health of or the risk associated with one or more assets. The analytic
score reflects the results of an execution of an analytic against an asset or
group of assets.
attributes:
calculationDateTime:
slot_uri: cim:AnalyticScore.calculationDateTime
range: date
required: false
multivalued: false
description: Timestamp of when the score was calculated.
effectiveDateTime:
slot_uri: cim:AnalyticScore.effectiveDateTime
range: date
required: false
multivalued: false
description: Date-time for when the score applies.
value:
slot_uri: cim:AnalyticScore.value
range: float
required: false
multivalued: false
description: Asset health score value.
Asset:
slot_uri: cim:AnalyticScore.Asset
range: Asset
required: false
multivalued: false
description: Asset to which this analytic score applies.
AssetAggregateScore:
slot_uri: cim:AnalyticScore.AssetAggregateScore
range: AggregateScore
required: false
multivalued: false
description: Aggregate score to which this analytic score contributed.
Analytic:
slot_uri: cim:AnalyticScore.Analytic
range: Analytic
required: false
multivalued: false
description: Analytic which was executed to arrive at this analytic score..
AssetGroup:
slot_uri: cim:AnalyticScore.AssetGroup
range: AssetGroup
required: false
multivalued: false
description: Asset group to which this analytic score applies..
AggregateScore:
class_uri: cim:AggregateScore
is_a: AnalyticScore
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: An aggregated indicative scoring by an analytic, which is based on
other analytic scores, that can be used to characterize the health of or the
risk associated with one or more assets.
attributes:
AnalyticScore:
slot_uri: cim:AggregateScore.AnalyticScore
range: AnalyticScore
required: true
multivalued: true
description: Analytic score contributing to this aggregate score.
Analytic:
class_uri: cim:Analytic
is_a: Document
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: An algorithm or calculation for making an assessment about an asset
or asset grouping for lifecycle decision making.
attributes:
bestValue:
slot_uri: cim:Analytic.bestValue
range: float
required: false
multivalued: false
description: Value that indicates best possible numeric value.
kind:
slot_uri: cim:Analytic.kind
range: AnalyticKind
required: true
multivalued: false
description: Kind of analytic this analytic is.
scaleKind:
slot_uri: cim:Analytic.scaleKind
range: ScaleKind
required: false
multivalued: false
description: The scoring scale kind.
worstValue:
slot_uri: cim:Analytic.worstValue
range: float
required: false
multivalued: false
description: Value that indicates worst possible numeric value.
Asset:
slot_uri: cim:Analytic.Asset
range: Asset
required: false
multivalued: true
description: Asset on which this analytic can be performed.
AnalyticScore:
slot_uri: cim:Analytic.AnalyticScore
range: AnalyticScore
required: false
multivalued: true
description: Analytic score produced by this analytic.
AssetHealthEvent:
slot_uri: cim:Analytic.AssetHealthEvent
range: AssetHealthEvent
required: false
multivalued: true
description: Asset health event which can be generated by this analytic.
AssetGroup:
slot_uri: cim:Analytic.AssetGroup
range: AssetGroup
required: false
multivalued: true
description: Asset group on which this analytic can be performed.
AssetHealthEvent:
class_uri: cim:AssetHealthEvent
is_a: ActivityRecord
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: An asset health-related event that is created by an analytic. The
event is a record of a change in asset health.
attributes:
actionRecommendation:
slot_uri: cim:AssetHealthEvent.actionRecommendation
range: string
required: false
multivalued: false
description: Recommendation for action.
actionTimeline:
slot_uri: cim:AssetHealthEvent.actionTimeline
range: integer
required: false
multivalued: false
description: Time horizon for action.
effectiveDateTime:
slot_uri: cim:AssetHealthEvent.effectiveDateTime
range: date
required: false
multivalued: false
description: The date and time when the event is effective.
Analytic:
slot_uri: cim:AssetHealthEvent.Analytic
range: Analytic
required: true
multivalued: false
description: Analytic that initiated this asset health event.
AssetGroup:
class_uri: cim:AssetGroup
is_a: Document
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: A grouping of assets created for a purpose such as fleet analytics,
inventory or compliance management.
attributes:
kind:
slot_uri: cim:AssetGroup.kind
range: AssetGroupKind
required: true
multivalued: false
description: Kind of asset group this asset group is.
AnalyticScore:
slot_uri: cim:AssetGroup.AnalyticScore
range: AnalyticScore
required: false
multivalued: true
description: Analytic score for this asset group.
Asset:
slot_uri: cim:AssetGroup.Asset
range: Asset
required: false
multivalued: true
description: Asset which is a part of this asset group.
Analytic:
slot_uri: cim:AssetGroup.Analytic
range: Analytic
required: false
multivalued: true
description: Analytic which can be performed on this asset group.
OperationalTag:
class_uri: cim:OperationalTag
is_a: Document
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Operations
description: Operational tag placed on a power system resource or asset in the
context of switching plan execution or other work in the field.
attributes:
Asset:
slot_uri: cim:OperationalTag.Asset
range: Asset
required: false
multivalued: false
description: Asset on which this tag has been placed.
PowerSystemResource:
slot_uri: cim:OperationalTag.PowerSystemResource
range: PowerSystemResource
required: false
multivalued: false
description: Power system resource on which this tag has been placed.
TagAction:
slot_uri: cim:OperationalTag.TagAction
range: TagAction
required: false
multivalued: false
description: Tag action associated with this tag.
TagAction:
class_uri: cim:TagAction
is_a: SwitchingAction
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Operations
description: Action on operation tag as a switching step.
attributes:
kind:
slot_uri: cim:TagAction.kind
range: TagActionKind
required: false
multivalued: false
description: Kind of tag action.
OperationalTag:
slot_uri: cim:TagAction.OperationalTag
range: OperationalTag
required: false
multivalued: false
description: Tag associated with this tag action.
Ownership:
class_uri: cim:Ownership
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Common
description: Ownership of e.g. asset.
attributes:
share:
slot_uri: cim:Ownership.share
range: PerCent
required: false
multivalued: false
description: Share of this ownership.
AssetOwner:
slot_uri: cim:Ownership.AssetOwner
range: AssetOwner
required: false
multivalued: false
description: Asset owner that is subject in this ownership.
Asset:
slot_uri: cim:Ownership.Asset
range: Asset
required: false
multivalued: false
description: Asset that is object of this ownership.
AssetOwner:
class_uri: cim:AssetOwner
is_a: AssetOrganisationRole
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: "Owner of the asset.\r\n"
attributes:
Ownerships:
slot_uri: cim:AssetOwner.Ownerships
range: Ownership
required: false
multivalued: true
description: All ownerships of this owner.
AssetOrganisationRole:
class_uri: cim:AssetOrganisationRole
is_a: OrganisationRole
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: Role an organisation plays with respect to asset.
attributes:
Assets:
slot_uri: cim:AssetOrganisationRole.Assets
range: Asset
required: false
multivalued: true
description: All assets for this organisation role.
ErpItemMaster:
class_uri: cim:ErpItemMaster
is_a: ErpIdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfERPSupport
description: "Any unique purchased part for manufactured product tracked by ERP\
\ systems for a utility.\r\nItem, as used by the OAG, refers to the basic information\
\ about an item, including its attributes, cost, and locations. It does not\
\ include item quantities. Compare to the Inventory, which includes all quantities\
\ and other location-specific information."
attributes:
status:
slot_uri: cim:ErpItemMaster.status
range: Status
required: false
multivalued: false
Asset:
slot_uri: cim:ErpItemMaster.Asset
range: Asset
required: false
multivalued: false
SwitchOperationSummary:
class_uri: cim:SwitchOperationSummary
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: 'Up-to-date, of-record summary of switch operation information, distilled
from a variety of sources (real-time data or real-time data historian, field
inspections, etc.) of use to asset health analytics. '
attributes:
lifetimeFaultOperations:
slot_uri: cim:SwitchOperationSummary.lifetimeFaultOperations
range: integer
required: false
multivalued: false
description: Total breaker fault operations to date.
lifetimeMotorStarts:
slot_uri: cim:SwitchOperationSummary.lifetimeMotorStarts
range: integer
required: false
multivalued: false
description: Total motor starts to date.
lifetimeTotalOperations:
slot_uri: cim:SwitchOperationSummary.lifetimeTotalOperations
range: integer
required: false
multivalued: false
description: Total breaker operations to date (including fault and non-fault).
mostRecentFaultOperationDate:
slot_uri: cim:SwitchOperationSummary.mostRecentFaultOperationDate
range: date
required: false
multivalued: false
description: Date of most recent breaker fault operation.
mostRecentMotorStartDate:
slot_uri: cim:SwitchOperationSummary.mostRecentMotorStartDate
range: date
required: false
multivalued: false
description: Date of most recent motor start.
mostRecentOperationDate:
slot_uri: cim:SwitchOperationSummary.mostRecentOperationDate
range: date
required: false
multivalued: false
description: Date of most recent breaker operation (fault or non-fault).
Breaker:
slot_uri: cim:SwitchOperationSummary.Breaker
range: Asset
required: true
multivalued: false
description: Breaker asset to which this operation information applies.
ScheduledEvent:
class_uri: cim:ScheduledEvent
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Common
description: An event to trigger one or more activities, such as reading a meter,
recalculating a bill, requesting work, when generating units must be scheduled
for maintenance, when a transformer is scheduled to be refurbished, etc.
attributes:
duration:
slot_uri: cim:ScheduledEvent.duration
range: Seconds
required: false
multivalued: false
description: Duration of the scheduled event, for example, the time to ramp
between values.
status:
slot_uri: cim:ScheduledEvent.status
range: Status
required: false
multivalued: false
description: Current status information relevant to a scheduled event
type:
slot_uri: cim:ScheduledEvent.type
range: string
required: false
multivalued: false
description: "Type of scheduled event.\r\n"
Assets:
slot_uri: cim:ScheduledEvent.Assets
range: Asset
required: false
multivalued: true
description: Assets associated with the scheduled event.
ScheduledEventData:
slot_uri: cim:ScheduledEvent.ScheduledEventData
range: ScheduledEventData
required: false
multivalued: false
description: Specification for this scheduled event.
ScheduledEventData:
class_uri: cim:ScheduledEventData
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Common
description: "Schedule parameters for an activity that is to occur, is occurring,\
\ or has completed.\r\n"
attributes:
estimatedWindow:
slot_uri: cim:ScheduledEventData.estimatedWindow
range: DateTimeInterval
required: false
multivalued: false
description: Estimated date and time for activity execution (with earliest
possibility of activity initiation and latest possibility of activity completion).
requestedWindow:
slot_uri: cim:ScheduledEventData.requestedWindow
range: DateTimeInterval
required: false
multivalued: false
description: Requested date and time interval for activity execution.
status:
slot_uri: cim:ScheduledEventData.status
range: Status
required: false
multivalued: false
description: Current status information relevant to the data for a scheduled
event
ScheduledEvents:
slot_uri: cim:ScheduledEventData.ScheduledEvents
range: ScheduledEvent
required: false
multivalued: true
description: All scheduled events with this specification.
InspectionDataSet:
slot_uri: cim:ScheduledEventData.InspectionDataSet
range: InspectionDataSet
required: true
multivalued: false
InspectionDataSet:
class_uri: cim:InspectionDataSet
is_a: ProcedureDataSet
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: Documents the result of one inspection, for a given attribute of
an asset.
attributes:
locationCondition:
slot_uri: cim:InspectionDataSet.locationCondition
range: string
required: false
multivalued: false
description: Description of the conditions of the location where the asset
resides.
AccordingToSchedules:
slot_uri: cim:InspectionDataSet.AccordingToSchedules
range: ScheduledEventData
required: false
multivalued: true
ErpInventory:
class_uri: cim:ErpInventory
is_a: ErpIdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfERPSupport
description: Utility inventory-related information about an item or part (and
not for description of the item and its attributes). It is used by ERP applications
to enable the synchronization of Inventory data that exists on separate Item
Master databases. This data is not the master data that describes the attributes
of the item such as dimensions, weight, or unit of measure - it describes the
item as it exists at a specific location.
attributes:
status:
slot_uri: cim:ErpInventory.status
range: Status
required: false
multivalued: false
Asset:
slot_uri: cim:ErpInventory.Asset
range: Asset
required: false
multivalued: false
ShortCircuitTest:
class_uri: cim:ShortCircuitTest
is_a: TransformerTest
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetInfo
description: Short-circuit test results determine mesh impedance parameters. They
include load losses and leakage impedances. For three-phase windings, the excitation
can be a positive sequence (the default) or a zero sequence. There shall be
at least one grounded winding.
attributes:
current:
slot_uri: cim:ShortCircuitTest.current
range: CurrentFlow
required: false
multivalued: false
description: Short circuit current..
energisedEndStep:
slot_uri: cim:ShortCircuitTest.energisedEndStep
range: integer
required: false
multivalued: false
description: "Tap step number for the energised end of the test pair.\r\n"
groundedEndStep:
slot_uri: cim:ShortCircuitTest.groundedEndStep
range: integer
required: false
multivalued: false
description: "Tap step number for the grounded end of the test pair.\r\n"
leakageImpedance:
slot_uri: cim:ShortCircuitTest.leakageImpedance
range: Impedance
required: false
multivalued: false
description: Leakage impedance measured from a positive-sequence or single-phase
short-circuit test.
leakageImpedanceZero:
slot_uri: cim:ShortCircuitTest.leakageImpedanceZero
range: Impedance
required: false
multivalued: false
description: Leakage impedance measured from a zero-sequence short-circuit
test.
loss:
slot_uri: cim:ShortCircuitTest.loss
range: KiloActivePower
required: false
multivalued: false
description: "Load losses from a positive-sequence or single-phase short-circuit\
\ test.\r\n"
lossZero:
slot_uri: cim:ShortCircuitTest.lossZero
range: KiloActivePower
required: false
multivalued: false
description: "Load losses from a zero-sequence short-circuit test.\r\n"
power:
slot_uri: cim:ShortCircuitTest.power
range: ApparentPower
required: false
multivalued: false
description: Short circuit apparent power.
voltage:
slot_uri: cim:ShortCircuitTest.voltage
range: PerCent
required: false
multivalued: false
description: Short circuit voltage..
EnergisedEnd:
slot_uri: cim:ShortCircuitTest.EnergisedEnd
range: TransformerEndInfo
required: true
multivalued: false
description: Transformer end that voltage is applied to in this short-circuit
test. The test voltage is chosen to induce rated current in the energised
end.
GroundedEnds:
slot_uri: cim:ShortCircuitTest.GroundedEnds
range: TransformerEndInfo
required: true
multivalued: true
description: All ends short-circuited in this short-circuit test.
TransformerTest:
class_uri: cim:TransformerTest
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetInfo
description: "Test result for transformer ends, such as short-circuit, open-circuit\
\ (excitation) or no-load test.\r\n"
attributes:
basePower:
slot_uri: cim:TransformerTest.basePower
range: ApparentPower
required: false
multivalued: false
description: "Base power at which the tests are conducted, usually equal to\
\ the rateds of one of the involved transformer ends.\r\n"
temperature:
slot_uri: cim:TransformerTest.temperature
range: Temperature
required: false
multivalued: false
description: "Temperature at which the test is conducted.\r\n"
TransformerTankInfo:
class_uri: cim:TransformerTankInfo
is_a: AssetInfo
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetInfo
description: "Set of transformer tank data, from an equipment library.\r\n"
attributes:
TransformerEndInfos:
slot_uri: cim:TransformerTankInfo.TransformerEndInfos
range: TransformerEndInfo
required: true
multivalued: true
description: Data for all the ends described by this transformer tank data.
PowerTransformerInfo:
slot_uri: cim:TransformerTankInfo.PowerTransformerInfo
range: PowerTransformerInfo
required: true
multivalued: false
description: Power transformer data that this tank description is part of.
PowerTransformerInfo:
class_uri: cim:PowerTransformerInfo
is_a: AssetInfo
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetInfo
description: "Set of power transformer data, from an equipment library.\r\n"
attributes:
TransformerTankInfos:
slot_uri: cim:PowerTransformerInfo.TransformerTankInfos
range: TransformerTankInfo
required: true
multivalued: true
description: Data for all the tanks described by this power transformer data.
OpenCircuitTest:
class_uri: cim:OpenCircuitTest
is_a: TransformerTest
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetInfo
description: Open-circuit test results verify winding turn ratios and phase shifts.
They include induced voltage and phase shift measurements on open-circuit windings,
with voltage applied to the energised end. For three-phase windings, the excitation
can be a positive sequence (the default) or a zero sequence.
attributes:
energisedEndStep:
slot_uri: cim:OpenCircuitTest.energisedEndStep
range: integer
required: false
multivalued: false
description: "Tap step number for the energised end of the test pair.\r\n"
energisedEndVoltage:
slot_uri: cim:OpenCircuitTest.energisedEndVoltage
range: Voltage
required: false
multivalued: false
description: "Voltage applied to the winding (end) during test.\r\n"
openEndStep:
slot_uri: cim:OpenCircuitTest.openEndStep
range: integer
required: false
multivalued: false
description: "Tap step number for the open end of the test pair.\r\n"
openEndVoltage:
slot_uri: cim:OpenCircuitTest.openEndVoltage
range: Voltage
required: false
multivalued: false
description: "Voltage measured at the open-circuited end, with the energised\
\ end set to rated voltage and all other ends open.\r\n"
phaseShift:
slot_uri: cim:OpenCircuitTest.phaseShift
range: AngleDegrees
required: false
multivalued: false
description: "Phase shift measured at the open end with the energised end\
\ set to rated voltage and all other ends open.\r\n"
EnergisedEnd:
slot_uri: cim:OpenCircuitTest.EnergisedEnd
range: TransformerEndInfo
required: true
multivalued: false
description: Transformer end that current is applied to in this open-circuit
test.
OpenEnd:
slot_uri: cim:OpenCircuitTest.OpenEnd
range: TransformerEndInfo
required: true
multivalued: false
description: Transformer end measured for induced voltage and angle in this
open-circuit test.
NoLoadTest:
class_uri: cim:NoLoadTest
is_a: TransformerTest
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetInfo
description: No-load test results determine core admittance parameters. They include
exciting current and core loss measurements from applying voltage to one winding.
The excitation may be positive sequence or zero sequence. The test may be repeated
at different voltages to measure saturation.
attributes:
energisedEndVoltage:
slot_uri: cim:NoLoadTest.energisedEndVoltage
range: Voltage
required: false
multivalued: false
description: "Voltage applied to the winding (end) during test.\r\n"
excitingCurrent:
slot_uri: cim:NoLoadTest.excitingCurrent
range: PerCent
required: false
multivalued: false
description: "Exciting current measured from a positive-sequence or single-phase\
\ excitation test.\r\n"
excitingCurrentZero:
slot_uri: cim:NoLoadTest.excitingCurrentZero
range: PerCent
required: false
multivalued: false
description: "Exciting current measured from a zero-sequence open-circuit\
\ excitation test.\r\n"
loss:
slot_uri: cim:NoLoadTest.loss
range: KiloActivePower
required: false
multivalued: false
description: "Losses measured from a positive-sequence or single-phase excitation\
\ test.\r\n"
lossZero:
slot_uri: cim:NoLoadTest.lossZero
range: KiloActivePower
required: false
multivalued: false
description: "Losses measured from a zero-sequence excitation test.\r\n"
EnergisedEnd:
slot_uri: cim:NoLoadTest.EnergisedEnd
range: TransformerEndInfo
required: false
multivalued: false
description: Transformer end that current is applied to in this no-load test.
TransformerStarImpedance:
class_uri: cim:TransformerStarImpedance
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: "Transformer star impedance (Pi-model) that accurately reflects impedance\
\ for transformers with 2 or 3 windings. For transformers with 4 or more windings,\
\ TransformerMeshImpedance class shall be used.\r\nFor transmission networks\
\ use PowerTransformerEnd impedances (r, r0, x, x0, b, b0, g and g0)."
attributes:
r:
slot_uri: cim:TransformerStarImpedance.r
range: Resistance
required: false
multivalued: false
description: "Resistance of the transformer end.\r\n"
r0:
slot_uri: cim:TransformerStarImpedance.r0
range: Resistance
required: false
multivalued: false
description: "Zero sequence series resistance of the transformer end.\r\n"
x:
slot_uri: cim:TransformerStarImpedance.x
range: Reactance
required: false
multivalued: false
description: "Positive sequence series reactance of the transformer end.\r\
\n"
x0:
slot_uri: cim:TransformerStarImpedance.x0
range: Reactance
required: false
multivalued: false
description: "Zero sequence series reactance of the transformer end.\r\n"
TransformerEnd:
slot_uri: cim:TransformerStarImpedance.TransformerEnd
range: TransformerEnd
required: false
multivalued: true
description: All transformer ends having this star impedance.
TransformerEndInfo:
slot_uri: cim:TransformerStarImpedance.TransformerEndInfo
range: TransformerEndInfo
required: false
multivalued: false
description: Transformer end datasheet used to calculate this transformer
star impedance.
TransformerCoreAdmittance:
class_uri: cim:TransformerCoreAdmittance
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: "The transformer core admittance. Used to specify the core admittance\
\ of a transformer in a manner that can be shared among power transformers.\r\
\n"
attributes:
b:
slot_uri: cim:TransformerCoreAdmittance.b
range: Susceptance
required: false
multivalued: false
description: "Magnetizing branch susceptance (B mag). The value can be positive\
\ or negative.\r\n"
b0:
slot_uri: cim:TransformerCoreAdmittance.b0
range: Susceptance
required: false
multivalued: false
description: "Zero sequence magnetizing branch susceptance.\r\n"
g:
slot_uri: cim:TransformerCoreAdmittance.g
range: Conductance
required: false
multivalued: false
description: "Magnetizing branch conductance (G mag).\r\n"
g0:
slot_uri: cim:TransformerCoreAdmittance.g0
range: Conductance
required: false
multivalued: false
description: "Zero sequence magnetizing branch conductance.\r\n"
TransformerEnd:
slot_uri: cim:TransformerCoreAdmittance.TransformerEnd
range: TransformerEnd
required: false
multivalued: true
description: All transformer ends having this core admittance.
TransformerEndInfo:
slot_uri: cim:TransformerCoreAdmittance.TransformerEndInfo
range: TransformerEndInfo
required: false
multivalued: false
description: Transformer end datasheet used to calculate this core admittance.
PhaseTapChanger:
class_uri: cim:PhaseTapChanger
is_a: TapChanger
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: A transformer phase shifting tap model that controls the phase angle
difference across the power transformer and potentially the active power flow
through the power transformer. This phase tap model may also impact the voltage
magnitude.
attributes:
TransformerEnd:
slot_uri: cim:PhaseTapChanger.TransformerEnd
range: TransformerEnd
required: true
multivalued: false
description: Transformer end to which this phase tap changer belongs.
TapChanger:
class_uri: cim:TapChanger
is_a: PowerSystemResource
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: Mechanism for changing transformer winding tap positions.
attributes:
controlEnabled:
slot_uri: cim:TapChanger.controlEnabled
range: boolean
required: false
multivalued: false
description: Specifies the regulation status of the equipment. True is regulating,
false is not regulating.
highStep:
slot_uri: cim:TapChanger.highStep
range: integer
required: false
multivalued: false
description: "Highest possible tap step position, advance from neutral.\r\n\
The attribute shall be greater than lowStep."
initialDelay:
slot_uri: cim:TapChanger.initialDelay
range: Seconds
required: false
multivalued: false
description: For an LTC, the delay for initial tap changer operation (first
step change).
lowStep:
slot_uri: cim:TapChanger.lowStep
range: integer
required: false
multivalued: false
description: Lowest possible tap step position, retard from neutral.
ltcFlag:
slot_uri: cim:TapChanger.ltcFlag
range: boolean
required: false
multivalued: false
description: Specifies whether or not a TapChanger has load tap changing capabilities.
neutralStep:
slot_uri: cim:TapChanger.neutralStep
range: integer
required: false
multivalued: false
description: "The neutral tap step position for this winding.\r\nThe attribute\
\ shall be equal to or greater than lowStep and equal or less than highStep.\r\
\nIt is the step position where the voltage is neutralU when the other terminals\
\ of the transformer are at the ratedU. If there are other tap changers\
\ on the transformer those taps are kept constant at their neutralStep."
neutralU:
slot_uri: cim:TapChanger.neutralU
range: Voltage
required: false
multivalued: false
description: "Voltage at which the winding operates at the neutral tap setting.\
\ It is the voltage at the terminal of the PowerTransformerEnd associated\
\ with the tap changer when all tap changers on the transformer are at their\
\ neutralStep position. Normally neutralU of the tap changer is the same\
\ as ratedU of the PowerTransformerEnd, but it can differ in special cases\
\ such as when the tapping mechanism is separate from the winding more common\
\ on lower voltage transformers.\r\nThis attribute is not relevant for PhaseTapChangerAsymmetrical,\
\ PhaseTapChangerSymmetrical and PhaseTapChangerLinear. "
normalStep:
slot_uri: cim:TapChanger.normalStep
range: integer
required: false
multivalued: false
description: "The tap step position used in \"normal\" network operation for\
\ this winding. For a \"Fixed\" tap changer indicates the current physical\
\ tap setting.\r\nThe attribute shall be equal to or greater than lowStep\
\ and equal to or less than highStep."
step:
slot_uri: cim:TapChanger.step
range: float
required: false
multivalued: false
description: "Tap changer position.\r\nStarting step for a steady state solution.\
\ Non integer values are allowed to support continuous tap variables. The\
\ reasons for continuous value are to support study cases where no discrete\
\ tap changer has yet been designed, a solution where a narrow voltage band\
\ forces the tap step to oscillate or to accommodate for a continuous solution\
\ as input.\r\nThe attribute shall be equal to or greater than lowStep and\
\ equal to or less than highStep."
subsequentDelay:
slot_uri: cim:TapChanger.subsequentDelay
range: Seconds
required: false
multivalued: false
description: For an LTC, the delay for subsequent tap changer operation (second
and later step changes).
TapChangerControl:
slot_uri: cim:TapChanger.TapChangerControl
range: TapChangerControl
required: false
multivalued: false
description: The regulating control scheme in which this tap changer participates.
SvTapStep:
slot_uri: cim:TapChanger.SvTapStep
range: SvTapStep
required: false
multivalued: false
description: The tap step state associated with the tap changer.
TapSchedules:
slot_uri: cim:TapChanger.TapSchedules
range: TapSchedule
required: false
multivalued: true
description: A TapChanger can have TapSchedules.
SvTapStep:
class_uri: cim:SvTapStep
is_a: StateVariable
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.StateVariables
description: 'State variable for transformer tap step. '
attributes:
position:
slot_uri: cim:SvTapStep.position
range: float
required: false
multivalued: false
description: The floating point tap position. This is not the tap ratio,
but rather the tap step position as defined by the related tap changer model
and normally is constrained to be within the range of minimum and maximum
tap positions.
TapChanger:
slot_uri: cim:SvTapStep.TapChanger
range: TapChanger
required: true
multivalued: false
description: The tap changer associated with the tap step state.
TapSchedule:
class_uri: cim:TapSchedule
is_a: SeasonDayTypeSchedule
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: A pre-established pattern over time for a tap step.
attributes:
TapChanger:
slot_uri: cim:TapSchedule.TapChanger
range: TapChanger
required: true
multivalued: false
description: A TapSchedule is associated with a TapChanger.
TapChangerControl:
class_uri: cim:TapChangerControl
is_a: RegulatingControl
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: Describes behaviour specific to tap changers, e.g. how the voltage
at the end of a line varies with the load level and compensation of the voltage
drop by tap adjustment.
attributes:
limitVoltage:
slot_uri: cim:TapChangerControl.limitVoltage
range: Voltage
required: false
multivalued: false
description: "Maximum allowed regulated voltage on the PT secondary, regardless\
\ of line drop compensation. Sometimes referred to as first-house protection.\r\
\n"
lineDropCompensation:
slot_uri: cim:TapChangerControl.lineDropCompensation
range: boolean
required: false
multivalued: false
description: If true, the line drop compensation is to be applied.
lineDropR:
slot_uri: cim:TapChangerControl.lineDropR
range: Resistance
required: false
multivalued: false
description: Line drop compensator resistance setting for normal (forward)
power flow.
lineDropX:
slot_uri: cim:TapChangerControl.lineDropX
range: Reactance
required: false
multivalued: false
description: Line drop compensator reactance setting for normal (forward)
power flow.
reverseLineDropR:
slot_uri: cim:TapChangerControl.reverseLineDropR
range: Resistance
required: false
multivalued: false
description: Line drop compensator resistance setting for reverse power flow.
reverseLineDropX:
slot_uri: cim:TapChangerControl.reverseLineDropX
range: Reactance
required: false
multivalued: false
description: Line drop compensator reactance setting for reverse power flow.
TapChanger:
slot_uri: cim:TapChangerControl.TapChanger
range: TapChanger
required: true
multivalued: true
description: The tap changers that participates in this regulating tap control
scheme.
RatioTapChanger:
class_uri: cim:RatioTapChanger
is_a: TapChanger
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: "A tap changer that changes the voltage ratio impacting the voltage\
\ magnitude but not the phase angle across the transformer.\r\n\r\nAngle sign\
\ convention (general): Positive value indicates a positive phase shift from\
\ the winding where the tap is located to the other winding (for a two-winding\
\ transformer)."
attributes:
stepVoltageIncrement:
slot_uri: cim:RatioTapChanger.stepVoltageIncrement
range: PerCent
required: false
multivalued: false
description: "Tap step increment, in per cent of rated voltage of the power\
\ transformer end, per step position.\r\nWhen the increment is negative,\
\ the voltage decreases when the tap step increases."
tculControlMode:
slot_uri: cim:RatioTapChanger.tculControlMode
range: TransformerControlMode
required: false
multivalued: false
description: Specifies the regulation control mode (voltage or reactive) of
the RatioTapChanger.
RatioTapChangerTable:
slot_uri: cim:RatioTapChanger.RatioTapChangerTable
range: RatioTapChangerTable
required: false
multivalued: false
description: The tap ratio table for this ratio tap changer.
TransformerEnd:
slot_uri: cim:RatioTapChanger.TransformerEnd
range: TransformerEnd
required: true
multivalued: false
description: Transformer end to which this ratio tap changer belongs.
RatioTapChangerTable:
class_uri: cim:RatioTapChangerTable
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: 'Describes a curve for how the voltage magnitude and impedance varies
with the tap step. '
attributes:
RatioTapChangerTablePoint:
slot_uri: cim:RatioTapChangerTable.RatioTapChangerTablePoint
range: RatioTapChangerTablePoint
required: true
multivalued: true
description: Points of this table.
RatioTapChanger:
slot_uri: cim:RatioTapChangerTable.RatioTapChanger
range: RatioTapChanger
required: false
multivalued: true
description: The ratio tap changer of this tap ratio table.
RatioTapChangerTablePoint:
class_uri: cim:RatioTapChangerTablePoint
is_a: TapChangerTablePoint
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: "Describes each tap step in the ratio tap changer tabular curve.\r\
\n"
attributes:
RatioTapChangerTable:
slot_uri: cim:RatioTapChangerTablePoint.RatioTapChangerTable
range: RatioTapChangerTable
required: true
multivalued: false
description: Table of this point.
TapChangerTablePoint:
class_uri: cim:TapChangerTablePoint
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: Describes each tap step in the tabular curve.
attributes:
b:
slot_uri: cim:TapChangerTablePoint.b
range: PerCent
required: false
multivalued: false
description: "The magnetizing branch susceptance deviation as a percentage\
\ of nominal value. The actual susceptance is calculated as follows:\r\n\
calculated magnetizing susceptance = b(nominal) * (1 + b(from this class)/100).\
\ The b(nominal) is defined as the static magnetizing susceptance on the\
\ associated power transformer end or ends. This model assumes the star\
\ impedance (pi model) form."
g:
slot_uri: cim:TapChangerTablePoint.g
range: PerCent
required: false
multivalued: false
description: "The magnetizing branch conductance deviation as a percentage\
\ of nominal value. The actual conductance is calculated as follows:\r\n\
calculated magnetizing conductance = g(nominal) * (1 + g(from this class)/100).\
\ The g(nominal) is defined as the static magnetizing conductance on the\
\ associated power transformer end or ends. This model assumes the star\
\ impedance (pi model) form."
r:
slot_uri: cim:TapChangerTablePoint.r
range: PerCent
required: false
multivalued: false
description: "The resistance deviation as a percentage of nominal value. The\
\ actual reactance is calculated as follows:\r\ncalculated resistance =\
\ r(nominal) * (1 + r(from this class)/100). The r(nominal) is defined\
\ as the static resistance on the associated power transformer end or ends.\
\ This model assumes the star impedance (pi model) form."
ratio:
slot_uri: cim:TapChangerTablePoint.ratio
range: float
required: false
multivalued: false
description: "The voltage at the tap step divided by rated voltage of the\
\ transformer end having the tap changer. Hence this is a value close to\
\ one.\r\nFor example, if the ratio at step 1 is 1.01, and the rated voltage\
\ of the transformer end is 110kV, then the voltage obtained by setting\
\ the tap changer to step 1 to is 111.1kV.\r\n"
step:
slot_uri: cim:TapChangerTablePoint.step
range: integer
required: false
multivalued: false
description: "The tap step.\r\n"
x:
slot_uri: cim:TapChangerTablePoint.x
range: PerCent
required: false
multivalued: false
description: "The series reactance deviation as a percentage of nominal value.\
\ The actual reactance is calculated as follows:\r\ncalculated reactance\
\ = x(nominal) * (1 + x(from this class)/100). The x(nominal) is defined\
\ as the static series reactance on the associated power transformer end\
\ or ends. This model assumes the star impedance (pi model) form."
BranchGroupTerminal:
class_uri: cim:BranchGroupTerminal
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.OperationalLimits
description: A specific directed terminal flow for a branch group.
attributes:
positiveFlowIn:
slot_uri: cim:BranchGroupTerminal.positiveFlowIn
range: boolean
required: false
multivalued: false
description: The flow into the terminal is summed if set true. The flow
out of the terminal is summed if set false.
BranchGroup:
slot_uri: cim:BranchGroupTerminal.BranchGroup
range: BranchGroup
required: true
multivalued: false
description: The branch group to which the directed branch group terminals
belong.
Terminal:
slot_uri: cim:BranchGroupTerminal.Terminal
range: Terminal
required: true
multivalued: false
description: The terminal to be summed.
BranchGroup:
class_uri: cim:BranchGroup
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.OperationalLimits
description: "A group of branch terminals whose directed flow summation is to\
\ be monitored. A branch group need not form a cutset of the network.\r\n"
attributes:
maximumActivePower:
slot_uri: cim:BranchGroup.maximumActivePower
range: ActivePower
required: false
multivalued: false
description: The maximum active power flow.
maximumReactivePower:
slot_uri: cim:BranchGroup.maximumReactivePower
range: ReactivePower
required: false
multivalued: false
description: The maximum reactive power flow.
minimumActivePower:
slot_uri: cim:BranchGroup.minimumActivePower
range: ActivePower
required: false
multivalued: false
description: The minimum active power flow.
minimumReactivePower:
slot_uri: cim:BranchGroup.minimumReactivePower
range: ReactivePower
required: false
multivalued: false
description: The minimum reactive power flow.
monitorActivePower:
slot_uri: cim:BranchGroup.monitorActivePower
range: boolean
required: false
multivalued: false
description: Monitor the active power flow.
monitorReactivePower:
slot_uri: cim:BranchGroup.monitorReactivePower
range: boolean
required: false
multivalued: false
description: Monitor the reactive power flow.
BranchGroupTerminal:
slot_uri: cim:BranchGroup.BranchGroupTerminal
range: BranchGroupTerminal
required: false
multivalued: true
description: The directed branch group terminals to be summed.
PinBranchGroup:
slot_uri: cim:BranchGroup.PinBranchGroup
range: PinBranchGroup
required: false
multivalued: true
PinBranchGroup:
class_uri: cim:PinBranchGroup
is_a: GateInputPin
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfSIPS
description: Value associated with branch group is used as compare.
attributes:
kind:
slot_uri: cim:PinBranchGroup.kind
range: PinBranchGroupKind
required: false
multivalued: false
description: The compare operation done on the branch group.
BranchGroup:
slot_uri: cim:PinBranchGroup.BranchGroup
range: BranchGroup
required: true
multivalued: false
description: The branch group that should be used in compare.
AuxiliaryEquipment:
class_uri: cim:AuxiliaryEquipment
is_a: Equipment
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.AuxiliaryEquipment
description: "AuxiliaryEquipment describe equipment that is not performing any\
\ primary functions but support for the equipment performing the primary function.\r\
\nAuxiliaryEquipment is attached to primary equipment via an association with\
\ Terminal."
attributes:
Terminal:
slot_uri: cim:AuxiliaryEquipment.Terminal
range: Terminal
required: true
multivalued: false
description: The Terminal at the equipment where the AuxiliaryEquipment is
attached.
EquipmentFault:
class_uri: cim:EquipmentFault
is_a: Fault
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Faults
description: A fault applied at the terminal, external to the equipment. This
class is not used to specify faults internal to the equipment.
attributes:
Terminal:
slot_uri: cim:EquipmentFault.Terminal
range: Terminal
required: false
multivalued: false
description: The terminal connecting to the bus to which the fault is applied.
ACDCConverter:
class_uri: cim:ACDCConverter
is_a: ConductingEquipment
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.DC
description: A unit with valves for three phases, together with unit control equipment,
essential protective and switching devices, DC storage capacitors, phase reactors
and auxiliaries, if any, used for conversion.
attributes:
baseS:
slot_uri: cim:ACDCConverter.baseS
range: ApparentPower
required: false
multivalued: false
description: Base apparent power of the converter pole. The attribute shall
be a positive value.
idc:
slot_uri: cim:ACDCConverter.idc
range: CurrentFlow
required: false
multivalued: false
description: "Converter DC current, also called Id. It is converter\u2019\
s state variable, result from power flow."
idleLoss:
slot_uri: cim:ACDCConverter.idleLoss
range: ActivePower
required: false
multivalued: false
description: "Active power loss in pole at no power transfer. It is converter\u2019\
s configuration data used in power flow. The attribute shall be a positive\
\ value."
maxP:
slot_uri: cim:ACDCConverter.maxP
range: ActivePower
required: false
multivalued: false
description: Maximum active power limit. The value is overwritten by values
of VsCapabilityCurve, if present.
maxUdc:
slot_uri: cim:ACDCConverter.maxUdc
range: Voltage
required: false
multivalued: false
description: "The maximum voltage on the DC side at which the converter should\
\ operate. It is converter\u2019s configuration data used in power flow.\
\ The attribute shall be a positive value."
minP:
slot_uri: cim:ACDCConverter.minP
range: ActivePower
required: false
multivalued: false
description: Minimum active power limit. The value is overwritten by values
of VsCapabilityCurve, if present.
minUdc:
slot_uri: cim:ACDCConverter.minUdc
range: Voltage
required: false
multivalued: false
description: "The minimum voltage on the DC side at which the converter should\
\ operate. It is converter\u2019s configuration data used in power flow.\
\ The attribute shall be a positive value."
numberOfValves:
slot_uri: cim:ACDCConverter.numberOfValves
range: integer
required: false
multivalued: false
description: Number of valves in the converter. Used in loss calculations.
p:
slot_uri: cim:ACDCConverter.p
range: ActivePower
required: false
multivalued: false
description: "Active power at the point of common coupling. Load sign convention\
\ is used, i.e. positive sign means flow out from a node.\r\nStarting value\
\ for a steady state solution in the case a simplified power flow model\
\ is used."
poleLossP:
slot_uri: cim:ACDCConverter.poleLossP
range: ActivePower
required: false
multivalued: false
description: "The active power loss at a DC Pole \r\n= idleLoss + switchingLoss*|Idc|\
\ + resitiveLoss*Idc^2.\r\nFor lossless operation Pdc=Pac.\r\nFor rectifier\
\ operation with losses Pdc=Pac-lossP.\r\nFor inverter operation with losses\
\ Pdc=Pac+lossP.\r\nIt is converter\u2019s state variable used in power\
\ flow. The attribute shall be a positive value."
q:
slot_uri: cim:ACDCConverter.q
range: ReactivePower
required: false
multivalued: false
description: "Reactive power at the point of common coupling. Load sign convention\
\ is used, i.e. positive sign means flow out from a node.\r\nStarting value\
\ for a steady state solution in the case a simplified power flow model\
\ is used."
ratedUdc:
slot_uri: cim:ACDCConverter.ratedUdc
range: Voltage
required: false
multivalued: false
description: "Rated converter DC voltage, also called UdN. The attribute shall\
\ be a positive value. It is converter\u2019s configuration data used in\
\ power flow. For instance a bipolar HVDC link with value 200 kV has a\
\ 400kV difference between the dc lines."
resistiveLoss:
slot_uri: cim:ACDCConverter.resistiveLoss
range: Resistance
required: false
multivalued: false
description: "It is converter\u2019s configuration data used in power flow.\
\ Refer to poleLossP. The attribute shall be a positive value."
switchingLoss:
slot_uri: cim:ACDCConverter.switchingLoss
range: ActivePowerPerCurrentFlow
required: false
multivalued: false
description: Switching losses, relative to the base apparent power 'baseS'.
Refer to poleLossP. The attribute shall be a positive value.
targetPpcc:
slot_uri: cim:ACDCConverter.targetPpcc
range: ActivePower
required: false
multivalued: false
description: Real power injection target in AC grid, at point of common coupling. Load
sign convention is used, i.e. positive sign means flow out from a node.
targetUdc:
slot_uri: cim:ACDCConverter.targetUdc
range: Voltage
required: false
multivalued: false
description: Target value for DC voltage magnitude. The attribute shall be
a positive value.
uc:
slot_uri: cim:ACDCConverter.uc
range: Voltage
required: false
multivalued: false
description: "Line-to-line converter voltage, the voltage at the AC side of\
\ the valve. It is converter\u2019s state variable, result from power flow.\
\ The attribute shall be a positive value."
udc:
slot_uri: cim:ACDCConverter.udc
range: Voltage
required: false
multivalued: false
description: "Converter voltage at the DC side, also called Ud. It is converter\u2019\
s state variable, result from power flow. The attribute shall be a positive\
\ value."
valveU0:
slot_uri: cim:ACDCConverter.valveU0
range: Voltage
required: false
multivalued: false
description: Valve threshold voltage, also called Uvalve. Forward voltage
drop when the valve is conducting. Used in loss calculations, i.e. the switchLoss
depend on numberOfValves * valveU0.
PccTerminal:
slot_uri: cim:ACDCConverter.PccTerminal
range: Terminal
required: false
multivalued: false
description: Point of common coupling terminal for this converter DC side.
It is typically the terminal on the power transformer (or switch) closest
to the AC network.
DCTerminals:
slot_uri: cim:ACDCConverter.DCTerminals
range: ACDCConverterDCTerminal
required: false
multivalued: true
description: A DC converter have DC converter terminals. A converter has two
DC converter terminals.
ACDCConverterDCTerminal:
class_uri: cim:ACDCConverterDCTerminal
is_a: DCBaseTerminal
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.DC
description: A DC electrical connection point at the AC/DC converter. The AC/DC
converter is electrically connected also to the AC side. The AC connection is
inherited from the AC conducting equipment in the same way as any other AC equipment.
The AC/DC converter DC terminal is separate from generic DC terminal to restrict
the connection with the AC side to AC/DC converter and so that no other DC conducting
equipment can be connected to the AC side.
attributes:
polarity:
slot_uri: cim:ACDCConverterDCTerminal.polarity
range: DCPolarityKind
required: false
multivalued: false
description: "Represents the normal network polarity condition. Depending\
\ on the converter configuration the value shall be set as follows:\r\n\
- For a monopole with two converter terminals use DCPolarityKind \u201C\
positive\u201D and \u201Cnegative\u201D.\r\n- For a bi-pole or symmetric\
\ monopole with three converter terminals use DCPolarityKind \u201Cpositive\u201D\
, \u201Cmiddle\u201D and \u201Cnegative\u201D."
DCConductingEquipment:
slot_uri: cim:ACDCConverterDCTerminal.DCConductingEquipment
range: ACDCConverter
required: true
multivalued: false
description: A DC converter terminal belong to an DC converter.
PinTerminal:
class_uri: cim:PinTerminal
is_a: GateInputPin
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfSIPS
description: Value associated with Terminal is used as compare.
attributes:
kind:
slot_uri: cim:PinTerminal.kind
range: PinTerminalKind
required: false
multivalued: false
description: The compare operation done on the terminal.
Terminal:
slot_uri: cim:PinTerminal.Terminal
range: Terminal
required: true
multivalued: false
description: The Terminal that should be used in compare.
EquipmentLimitSeriesComponent:
class_uri: cim:EquipmentLimitSeriesComponent
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfOperationalLimits
description: This represents one instance of an equipment that contributes to
the calculation of an operational limit.
attributes:
SeriesEquipmentDependentLimit:
slot_uri: cim:EquipmentLimitSeriesComponent.SeriesEquipmentDependentLimit
range: SeriesEquipmentDependentLimit
required: true
multivalued: false
description: Calculation in which the refernce to equipment applies.
Equipment:
slot_uri: cim:EquipmentLimitSeriesComponent.Equipment
range: Equipment
required: true
multivalued: false
description: Equipment contributing toward the series limit. The reference
here is to Equipment rather than a specific limit on the equipment so the
grouiping can be reused for multiple limits of different types on the same
instance of equipment.
SeriesEquipmentDependentLimit:
class_uri: cim:SeriesEquipmentDependentLimit
is_a: LimitDependency
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfOperationalLimits
description: "Limit based on most restrictive series equipment limit.\r\nA specification\
\ of of equipment that determines the calculated operational limit values based\
\ upon other equipment and their ratings. The most restrictive limit connected\
\ in series within the group is used. The physical connection based on switch\
\ status for example may also impact which elements in the group are considered.\
\ Any equipment in the group that are presently connected in series with the\
\ equipment of the directly associated operational limit are used. This provides\
\ a means to indicate which potentially series equipment limits are considered\
\ for a computed operational limit. The operational limit of the same operational\
\ limit type is assumed to be used from the grouped equipment. It is also\
\ possible to make assumptions or calculations regarding how flow might split\
\ if the equipment is not simply in series."
attributes:
EquipmentLimitSeriesComponent:
slot_uri: cim:SeriesEquipmentDependentLimit.EquipmentLimitSeriesComponent
range: EquipmentLimitSeriesComponent
required: false
multivalued: true
description: Equipment linkages that participates in the limit calculation.
ProtectiveActionEquipment:
class_uri: cim:ProtectiveActionEquipment
is_a: ProtectiveAction
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfSIPS
description: Protective action to put an Equipment in-service/out-of-service.
attributes:
inService:
slot_uri: cim:ProtectiveActionEquipment.inService
range: boolean
required: false
multivalued: false
description: If true the equipment is put in-service, otherwise out-of-service.
Equipment:
slot_uri: cim:ProtectiveActionEquipment.Equipment
range: Equipment
required: true
multivalued: false
PinEquipment:
class_uri: cim:PinEquipment
is_a: GateInputPin
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfSIPS
description: Value associated with Equipment is used as compare.
attributes:
kind:
slot_uri: cim:PinEquipment.kind
range: PinEquipmentKind
required: false
multivalued: false
description: The compare operation done on the equipment.
Equipment:
slot_uri: cim:PinEquipment.Equipment
range: Equipment
required: true
multivalued: false
description: The Equipment that should be used in compare.
WeatherStation:
class_uri: cim:WeatherStation
is_a: PowerSystemResource
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfOperationalLimits
description: "This represents a source of ambient temperature.\r\n"
attributes:
Equipment:
slot_uri: cim:WeatherStation.Equipment
range: Equipment
required: false
multivalued: true
OperationalLimitType:
class_uri: cim:OperationalLimitType
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.OperationalLimits
description: "The operational meaning of a category of limits.\r\n"
attributes:
acceptableDuration:
slot_uri: cim:OperationalLimitType.acceptableDuration
range: Seconds
required: false
multivalued: false
description: The nominal acceptable duration of the limit. Limits are commonly
expressed in terms of the time limit for which the limit is normally acceptable.
The actual acceptable duration of a specific limit may depend on other local
factors such as temperature or wind speed. The attribute has meaning only
if the flag isInfiniteDuration is set to false, hence it shall not be exchanged
when isInfiniteDuration is set to true.
direction:
slot_uri: cim:OperationalLimitType.direction
range: OperationalLimitDirectionKind
required: false
multivalued: false
description: The direction of the limit.
isInfiniteDuration:
slot_uri: cim:OperationalLimitType.isInfiniteDuration
range: boolean
required: false
multivalued: false
description: Defines if the operational limit type has infinite duration.
If true, the limit has infinite duration. If false, the limit has definite
duration which is defined by the attribute acceptableDuration.
OperationalLimit:
slot_uri: cim:OperationalLimitType.OperationalLimit
range: OperationalLimit
required: false
multivalued: true
description: The operational limits associated with this type of limit.
SourceOperationalLimitTypeScaling:
slot_uri: cim:OperationalLimitType.SourceOperationalLimitTypeScaling
range: OperatonalLimitTypeScaling
required: false
multivalued: true
TargetOperationalLimitmTypeScaling:
slot_uri: cim:OperationalLimitType.TargetOperationalLimitmTypeScaling
range: OperatonalLimitTypeScaling
required: false
multivalued: false
OperatonalLimitTypeScaling:
class_uri: cim:OperatonalLimitTypeScaling
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfOperationalLimits
description: 'One operational limit type scales values of another operational
limit type when under the same operational limit set. This applies to any
operational limit assigned to the target operational limit type and without
other limit dependency models. '
attributes:
scalingPercent:
slot_uri: cim:OperatonalLimitTypeScaling.scalingPercent
range: PerCent
required: false
multivalued: false
description: "The percentage scaling of the source limit to compute the target\
\ limit. Applys to operational limits within an operaitonal limit set when\
\ both source and target operational limit types exist.\r\n"
SourceOperationalLimitType:
slot_uri: cim:OperatonalLimitTypeScaling.SourceOperationalLimitType
range: OperationalLimitType
required: false
multivalued: false
TargetOperationalLimit:
slot_uri: cim:OperatonalLimitTypeScaling.TargetOperationalLimit
range: OperationalLimitType
required: true
multivalued: false
ReportingSuperGroup:
class_uri: cim:ReportingSuperGroup
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Core
description: A reporting super group, groups reporting groups for a higher level
report.
attributes:
ReportingGroup:
slot_uri: cim:ReportingSuperGroup.ReportingGroup
range: ReportingGroup
required: false
multivalued: true
description: Reporting groups that are grouped under this super group.
OperatingShare:
class_uri: cim:OperatingShare
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Core
description: "Specifies the operations contract relationship between a power system\
\ resource and a contract participant.\r\n"
attributes:
percentage:
slot_uri: cim:OperatingShare.percentage
range: PerCent
required: false
multivalued: false
description: Percentage operational ownership between the pair (power system
resource and operating participant) associated with this share. The total
percentage ownership for a power system resource should add to 100%.
OperatingParticipant:
slot_uri: cim:OperatingShare.OperatingParticipant
range: OperatingParticipant
required: true
multivalued: false
description: The operating participant having this share with the associated
power system resource.
PowerSystemResource:
slot_uri: cim:OperatingShare.PowerSystemResource
range: PowerSystemResource
required: true
multivalued: false
description: The power system resource to which the share applies.
OperatingParticipant:
class_uri: cim:OperatingParticipant
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Core
description: "An operator of multiple power system resource objects. Note multple\
\ operating participants may operate the same power system resource object.\
\ This can be used for modeling jointly owned units where each owner operates\
\ as a contractual share.\r\n"
attributes:
OperatingShare:
slot_uri: cim:OperatingParticipant.OperatingShare
range: OperatingShare
required: false
multivalued: true
description: The operating shares of this operating participant. An operating
participant can be resused for any number of power system resources.
VerificationAction:
class_uri: cim:VerificationAction
is_a: SwitchingAction
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Operations
description: Verification of a switch position or other condition as a switching
step
attributes:
verificationCondition:
slot_uri: cim:VerificationAction.verificationCondition
range: string
required: false
multivalued: false
description: freeform description of the condition to be verified
PowerSystemResource:
slot_uri: cim:VerificationAction.PowerSystemResource
range: PowerSystemResource
required: false
multivalued: false
description: The power system resource that the verification action is performed
on
ClearanceDocument:
class_uri: cim:ClearanceDocument
is_a: SafetyDocument
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Operations
description: Safety document used to authorise work on conducting equipment in
the field. Tagged equipment is not allowed to be operated.
attributes:
mustBeDeenergised:
slot_uri: cim:ClearanceDocument.mustBeDeenergised
range: boolean
required: false
multivalued: false
description: If true, the equipment must be deenergised.
mustBeGrounded:
slot_uri: cim:ClearanceDocument.mustBeGrounded
range: boolean
required: false
multivalued: false
description: If true, the equipment must be grounded.
TaggedPSRs:
slot_uri: cim:ClearanceDocument.TaggedPSRs
range: PowerSystemResource
required: false
multivalued: true
description: All power system resources tagged through this clearance.
ClearanceAction:
slot_uri: cim:ClearanceDocument.ClearanceAction
range: ClearanceAction
required: false
multivalued: false
description: Clearance action associated with this clearance.
ClearanceAction:
class_uri: cim:ClearanceAction
is_a: SwitchingAction
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Operations
description: Action on clearance document as a switching step.
attributes:
kind:
slot_uri: cim:ClearanceAction.kind
range: ClearanceActionKind
required: false
multivalued: false
description: Clearance action to perform.
Clearance:
slot_uri: cim:ClearanceAction.Clearance
range: ClearanceDocument
required: false
multivalued: false
description: Clearance associated with this clearance action.
GenericAction:
class_uri: cim:GenericAction
is_a: SwitchingAction
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Operations
description: An arbitrary switching step.
attributes:
PowerSystemResource:
slot_uri: cim:GenericAction.PowerSystemResource
range: PowerSystemResource
required: false
multivalued: false
description: The power system resource that the generic action is performed
on
PSREvent:
class_uri: cim:PSREvent
is_a: ActivityRecord
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Operations
description: Event recording the change in operational status of a power system
resource (PSR); may be for an event that has already occurred or for a planned
activity.
attributes:
kind:
slot_uri: cim:PSREvent.kind
range: PSREventKind
required: false
multivalued: false
description: Kind of event.
PowerSystemResource:
slot_uri: cim:PSREvent.PowerSystemResource
range: PowerSystemResource
required: false
multivalued: false
description: Power system resource that generated this event.
IrregularIntervalSchedule:
class_uri: cim:IrregularIntervalSchedule
is_a: BasicIntervalSchedule
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Core
description: "The schedule has time points where the time between them varies.\r\
\n"
attributes:
TimePoints:
slot_uri: cim:IrregularIntervalSchedule.TimePoints
range: IrregularTimePoint
required: true
multivalued: true
description: The point data values that define a curve.
IrregularTimePoint:
class_uri: cim:IrregularTimePoint
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Core
description: "TimePoints for a schedule where the time between the points varies.\r\
\n"
attributes:
time:
slot_uri: cim:IrregularTimePoint.time
range: Seconds
required: false
multivalued: false
description: "The time is relative to the schedule starting time.\r\n\r\n"
value1:
slot_uri: cim:IrregularTimePoint.value1
range: float
required: false
multivalued: false
description: "The first value at the time. The meaning of the value is defined\
\ by the derived type of the associated schedule.\r\n"
value2:
slot_uri: cim:IrregularTimePoint.value2
range: float
required: false
multivalued: false
description: "The second value at the time. The meaning of the value is defined\
\ by the derived type of the associated schedule.\r\n"
IntervalSchedule:
slot_uri: cim:IrregularTimePoint.IntervalSchedule
range: IrregularIntervalSchedule
required: true
multivalued: false
description: An IrregularTimePoint belongs to an IrregularIntervalSchedule.
BasePower:
class_uri: cim:BasePower
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Core
description: The BasePower class defines the base power used in the per unit calculations.
attributes:
basePower:
slot_uri: cim:BasePower.basePower
range: ApparentPower
required: false
multivalued: false
description: "Value used as base power.\r\n"
BaseFrequency:
class_uri: cim:BaseFrequency
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Core
description: The BaseFrequency class describes a base frequency for a power system
network. In case of multiple power networks with different frequencies, e.g.
50 Hz or 60 Hz each network will have its own base frequency class. Hence it
is assumed that power system objects having different base frequencies appear
in separate documents where each document has a single base frequency instance.
attributes:
frequency:
slot_uri: cim:BaseFrequency.frequency
range: Frequency
required: false
multivalued: false
description: The base frequency.
TextDiagramObject:
class_uri: cim:TextDiagramObject
is_a: DiagramObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.DiagramLayout
description: A diagram object for placing free-text or text derived from an associated
domain object.
attributes:
text:
slot_uri: cim:TextDiagramObject.text
range: string
required: false
multivalued: false
description: "The text that is displayed by this text diagram object.\r\n"
ActivePowerLimit:
class_uri: cim:ActivePowerLimit
is_a: OperationalLimit
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.OperationalLimits
description: Limit on active power flow.
attributes:
normalValue:
slot_uri: cim:ActivePowerLimit.normalValue
range: ActivePower
required: false
multivalued: false
description: The normal value of active power limit. The attribute shall be
a positive value or zero.
value:
slot_uri: cim:ActivePowerLimit.value
range: ActivePower
required: false
multivalued: false
description: Value of active power limit. The attribute shall be a positive
value or zero.
ApparentPowerLimit:
class_uri: cim:ApparentPowerLimit
is_a: OperationalLimit
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.OperationalLimits
description: Apparent power limit.
attributes:
normalValue:
slot_uri: cim:ApparentPowerLimit.normalValue
range: ApparentPower
required: false
multivalued: false
description: The normal apparent power limit. The attribute shall be a positive
value or zero.
value:
slot_uri: cim:ApparentPowerLimit.value
range: ApparentPower
required: false
multivalued: false
description: The apparent power limit. The attribute shall be a positive value
or zero.
CurrentLimit:
class_uri: cim:CurrentLimit
is_a: OperationalLimit
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.OperationalLimits
description: 'Operational limit on current. '
attributes:
normalValue:
slot_uri: cim:CurrentLimit.normalValue
range: CurrentFlow
required: false
multivalued: false
description: The normal value for limit on current flow. The attribute shall
be a positive value or zero.
value:
slot_uri: cim:CurrentLimit.value
range: CurrentFlow
required: false
multivalued: false
description: Limit on current flow. The attribute shall be a positive value
or zero.
VoltageLimit:
class_uri: cim:VoltageLimit
is_a: OperationalLimit
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.OperationalLimits
description: "Operational limit applied to voltage.\r\nThe use of operational\
\ VoltageLimit is preferred instead of limits defined at VoltageLevel. The operational\
\ VoltageLimits are used, if present."
attributes:
normalValue:
slot_uri: cim:VoltageLimit.normalValue
range: Voltage
required: false
multivalued: false
description: The normal limit on voltage. High or low limit nature of the
limit depends upon the properties of the operational limit type. The attribute
shall be a positive value or zero.
value:
slot_uri: cim:VoltageLimit.value
range: Voltage
required: false
multivalued: false
description: Limit on voltage. High or low limit nature of the limit depends
upon the properties of the operational limit type. The attribute shall be
a positive value or zero.
PerLengthSequenceImpedance:
class_uri: cim:PerLengthSequenceImpedance
is_a: PerLengthImpedance
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: Sequence impedance and admittance parameters per unit length, for
transposed lines of 1, 2, or 3 phases. For 1-phase lines, define x=x0=xself.
For 2-phase lines, define x=xs-xm and x0=xs+xm.
attributes:
b0ch:
slot_uri: cim:PerLengthSequenceImpedance.b0ch
range: SusceptancePerLength
required: false
multivalued: false
description: "Zero sequence shunt (charging) susceptance, per unit of length.\r\
\n"
bch:
slot_uri: cim:PerLengthSequenceImpedance.bch
range: SusceptancePerLength
required: false
multivalued: false
description: "Positive sequence shunt (charging) susceptance, per unit of\
\ length.\r\n"
g0ch:
slot_uri: cim:PerLengthSequenceImpedance.g0ch
range: ConductancePerLength
required: false
multivalued: false
description: "Zero sequence shunt (charging) conductance, per unit of length.\r\
\n"
gch:
slot_uri: cim:PerLengthSequenceImpedance.gch
range: ConductancePerLength
required: false
multivalued: false
description: "Positive sequence shunt (charging) conductance, per unit of\
\ length.\r\n"
r:
slot_uri: cim:PerLengthSequenceImpedance.r
range: ResistancePerLength
required: false
multivalued: false
description: "Positive sequence series resistance, per unit of length.\r\n"
r0:
slot_uri: cim:PerLengthSequenceImpedance.r0
range: ResistancePerLength
required: false
multivalued: false
description: "Zero sequence series resistance, per unit of length.\r\n"
x:
slot_uri: cim:PerLengthSequenceImpedance.x
range: ReactancePerLength
required: false
multivalued: false
description: "Positive sequence series reactance, per unit of length.\r\n"
x0:
slot_uri: cim:PerLengthSequenceImpedance.x0
range: ReactancePerLength
required: false
multivalued: false
description: "Zero sequence series reactance, per unit of length.\r\n"
PerLengthPhaseImpedance:
class_uri: cim:PerLengthPhaseImpedance
is_a: PerLengthImpedance
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: Impedance and admittance parameters per unit length for n-wire unbalanced
lines, in matrix form.
attributes:
conductorCount:
slot_uri: cim:PerLengthPhaseImpedance.conductorCount
range: integer
required: false
multivalued: false
description: Number of phase, neutral, and other wires retained. Constrains
the number of matrix elements and the phase codes that can be used with
this matrix.
PhaseImpedanceData:
slot_uri: cim:PerLengthPhaseImpedance.PhaseImpedanceData
range: PhaseImpedanceData
required: true
multivalued: true
description: All data that belong to this conductor phase impedance.
PhaseImpedanceData:
class_uri: cim:PhaseImpedanceData
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: "Impedance and conductance matrix element values. \r\nThe diagonal\
\ elements are described by the elements having the same toPhase and fromPhase\
\ value and the off diagonal elements have different toPhase and fromPhase values.\
\ The matrix can also be stored in symmetric lower triangular format using\
\ the row and column attributes, which map to ACLineSegmentPhase.sequenceNumber."
attributes:
b:
slot_uri: cim:PhaseImpedanceData.b
range: SusceptancePerLength
required: false
multivalued: false
description: "Susceptance matrix element value, per length of unit.\r\n"
column:
slot_uri: cim:PhaseImpedanceData.column
range: integer
required: false
multivalued: false
description: "The matrix element's column number, in the range 1 to row. Only\
\ the lower triangle needs to be stored. This column number matches ACLineSegmentPhase.sequenceNumber.\r\
\n\r\n\r\n"
fromPhase:
slot_uri: cim:PhaseImpedanceData.fromPhase
range: SinglePhaseKind
required: false
multivalued: false
description: Refer to the class description.
g:
slot_uri: cim:PhaseImpedanceData.g
range: ConductancePerLength
required: false
multivalued: false
description: Conductance matrix element value, per length of unit.
r:
slot_uri: cim:PhaseImpedanceData.r
range: ResistancePerLength
required: false
multivalued: false
description: "Resistance matrix element value, per length of unit.\r\n"
row:
slot_uri: cim:PhaseImpedanceData.row
range: integer
required: false
multivalued: false
description: "The matrix element\u2019s row number, in the range 1 to PerLengthPhaseImpedance.conductorCount.\
\ Only the lower triangle needs to be stored. This row number matches ACLineSegmentPhase.sequenceNumber."
toPhase:
slot_uri: cim:PhaseImpedanceData.toPhase
range: SinglePhaseKind
required: false
multivalued: false
description: Refer to the class description.
x:
slot_uri: cim:PhaseImpedanceData.x
range: ReactancePerLength
required: false
multivalued: false
description: "Reactance matrix element value, per length of unit.\r\n"
PhaseImpedance:
slot_uri: cim:PhaseImpedanceData.PhaseImpedance
range: PerLengthPhaseImpedance
required: true
multivalued: false
description: Conductor phase impedance to which this data belongs.
ShuntCompensatorPhase:
class_uri: cim:ShuntCompensatorPhase
is_a: PowerSystemResource
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: Single phase of a multi-phase shunt compensator when its attributes
might be different per phase.
attributes:
maximumSections:
slot_uri: cim:ShuntCompensatorPhase.maximumSections
range: integer
required: false
multivalued: false
description: "The maximum number of sections that may be switched in for this\
\ phase. \r\n"
normalSections:
slot_uri: cim:ShuntCompensatorPhase.normalSections
range: integer
required: false
multivalued: false
description: "For the capacitor phase, the normal number of sections switched\
\ in. The value shall be between zero and ShuntCompensatorPhase.maximumSections.\r\
\n"
phase:
slot_uri: cim:ShuntCompensatorPhase.phase
range: SinglePhaseKind
required: false
multivalued: false
description: "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.\r\n"
sections:
slot_uri: cim:ShuntCompensatorPhase.sections
range: float
required: false
multivalued: false
description: "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.\r\
\nFor 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.\r\n\
For NonlinearShuntCompensator-s shall only be set to one of the NonlinearShuntCompenstorPhasePoint.sectionNumber.\
\ There is no interpolation between NonlinearShuntCompenstorPhasePoint-s."
ShuntCompensator:
slot_uri: cim:ShuntCompensatorPhase.ShuntCompensator
range: ShuntCompensator
required: true
multivalued: false
description: Shunt compensator of this shunt compensator phase.
ShuntCompensator:
class_uri: cim:ShuntCompensator
is_a: RegulatingCondEq
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: 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.
attributes:
aVRDelay:
slot_uri: cim:ShuntCompensator.aVRDelay
range: Seconds
required: false
multivalued: false
description: 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.
grounded:
slot_uri: cim:ShuntCompensator.grounded
range: boolean
required: false
multivalued: false
description: Used for Yn and Zn connections. True if the neutral is solidly
grounded.
maximumSections:
slot_uri: cim:ShuntCompensator.maximumSections
range: integer
required: false
multivalued: false
description: "The maximum number of sections that may be switched in. \r\n"
nomU:
slot_uri: cim:ShuntCompensator.nomU
range: Voltage
required: false
multivalued: false
description: "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.\r\n"
normalSections:
slot_uri: cim:ShuntCompensator.normalSections
range: integer
required: false
multivalued: false
description: "The normal number of sections switched in. The value shall be\
\ between zero and ShuntCompensator.maximumSections.\r\n"
phaseConnection:
slot_uri: cim:ShuntCompensator.phaseConnection
range: PhaseShuntConnectionKind
required: false
multivalued: false
description: "The type of phase connection, such as wye or delta.\r\n"
sections:
slot_uri: cim:ShuntCompensator.sections
range: float
required: false
multivalued: false
description: "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.\
\ \r\nFor 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.\r\n\
For NonlinearShuntCompensator-s shall only be set to one of the NonlinearShuntCompenstorPoint.sectionNumber.\
\ There is no interpolation between NonlinearShuntCompenstorPoint-s."
switchOnCount:
slot_uri: cim:ShuntCompensator.switchOnCount
range: integer
required: false
multivalued: false
description: The switch on count since the capacitor count was last reset
or initialized.
switchOnDate:
slot_uri: cim:ShuntCompensator.switchOnDate
range: date
required: false
multivalued: false
description: The date and time when the capacitor bank was last switched on.
voltageSensitivity:
slot_uri: cim:ShuntCompensator.voltageSensitivity
range: VoltagePerReactivePower
required: false
multivalued: false
description: Voltage sensitivity required for the device to regulate the bus
voltage, in voltage/reactive power.
ShuntCompensatorPhase:
slot_uri: cim:ShuntCompensator.ShuntCompensatorPhase
range: ShuntCompensatorPhase
required: false
multivalued: true
description: The individual phases models for the shunt compensator.
ShuntCompensatorAction:
slot_uri: cim:ShuntCompensator.ShuntCompensatorAction
range: ShuntCompensatorAction
required: false
multivalued: false
description: The shunt compensator action that is performed on the shunt compensator
SvShuntCompensatorSections:
slot_uri: cim:ShuntCompensator.SvShuntCompensatorSections
range: SvShuntCompensatorSections
required: false
multivalued: true
description: The state for the number of shunt compensator sections in service.
SvShuntCompensatorSections:
class_uri: cim:SvShuntCompensatorSections
is_a: StateVariable
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.StateVariables
description: State variable for the number of sections in service for a shunt
compensator.
attributes:
phase:
slot_uri: cim:SvShuntCompensatorSections.phase
range: SinglePhaseKind
required: false
multivalued: false
description: The terminal phase at which the connection is applied. If missing,
the injection is assumed to be balanced among non-neutral phases.
sections:
slot_uri: cim:SvShuntCompensatorSections.sections
range: float
required: false
multivalued: false
description: 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.
ShuntCompensator:
slot_uri: cim:SvShuntCompensatorSections.ShuntCompensator
range: ShuntCompensator
required: true
multivalued: false
description: The shunt compensator for which the state applies.
ShuntCompensatorAction:
class_uri: cim:ShuntCompensatorAction
is_a: SwitchingAction
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Operations
attributes:
kind:
slot_uri: cim:ShuntCompensatorAction.kind
range: TempEquipActionKind
required: false
multivalued: false
description: Switching action to perform
ShuntCompensator:
slot_uri: cim:ShuntCompensatorAction.ShuntCompensator
range: ShuntCompensator
required: false
multivalued: false
description: The shunt compensator that the shunt compensator action is performed
on
Disconnector:
class_uri: cim:Disconnector
is_a: Switch
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: 'A manually operated or motor operated mechanical switching device
used for changing the connections in a circuit, or for isolating a circuit or
equipment from a source of power. It is required to open or close circuits when
negligible current is broken or made. '
EnergyConsumerPhase:
class_uri: cim:EnergyConsumerPhase
is_a: PowerSystemResource
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: "A single phase of an energy consumer.\r\n"
attributes:
p:
slot_uri: cim:EnergyConsumerPhase.p
range: ActivePower
required: false
multivalued: false
description: "Active power of the load. Load sign convention is used, i.e.\
\ positive sign means flow out from a node.\r\nFor voltage dependent loads\
\ the value is at rated voltage.\r\nStarting value for a steady state solution."
pfixed:
slot_uri: cim:EnergyConsumerPhase.pfixed
range: ActivePower
required: false
multivalued: false
description: "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.\r\n"
pfixedPct:
slot_uri: cim:EnergyConsumerPhase.pfixedPct
range: PerCent
required: false
multivalued: false
description: "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.\r\n"
phase:
slot_uri: cim:EnergyConsumerPhase.phase
range: SinglePhaseKind
required: false
multivalued: false
description: "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.\r\n"
q:
slot_uri: cim:EnergyConsumerPhase.q
range: ReactivePower
required: false
multivalued: false
description: "Reactive power of the load. Load sign convention is used, i.e.\
\ positive sign means flow out from a node.\r\nFor voltage dependent loads\
\ the value is at rated voltage.\r\nStarting value for a steady state solution."
qfixed:
slot_uri: cim:EnergyConsumerPhase.qfixed
range: ReactivePower
required: false
multivalued: false
description: "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.\r\n"
qfixedPct:
slot_uri: cim:EnergyConsumerPhase.qfixedPct
range: PerCent
required: false
multivalued: false
description: "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.\r\n"
EnergyConsumer:
slot_uri: cim:EnergyConsumerPhase.EnergyConsumer
range: EnergyConsumer
required: true
multivalued: false
description: The energy consumer to which this phase belongs.
EnergyConsumer:
class_uri: cim:EnergyConsumer
is_a: EnergyConnection
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: "Generic user of energy - a point of consumption on the power system\
\ model.\r\nEnergyConsumer.pfixed, .qfixed, .pfixedPct and .qfixedPct have meaning\
\ only if there is no LoadResponseCharacteristic associated with EnergyConsumer\
\ or if LoadResponseCharacteristic.exponentModel is set to False."
attributes:
customerCount:
slot_uri: cim:EnergyConsumer.customerCount
range: integer
required: false
multivalued: false
description: "Number of individual customers represented by this demand.\r\
\n"
grounded:
slot_uri: cim:EnergyConsumer.grounded
range: boolean
required: false
multivalued: false
description: Used for Yn and Zn connections. True if the neutral is solidly
grounded.
p:
slot_uri: cim:EnergyConsumer.p
range: ActivePower
required: false
multivalued: false
description: "Active power of the load. Load sign convention is used, i.e.\
\ positive sign means flow out from a node.\r\nFor voltage dependent loads\
\ the value is at rated voltage.\r\nStarting value for a steady state solution."
pfixed:
slot_uri: cim:EnergyConsumer.pfixed
range: ActivePower
required: false
multivalued: false
description: '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:
slot_uri: cim:EnergyConsumer.pfixedPct
range: PerCent
required: false
multivalued: false
description: 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:
slot_uri: cim:EnergyConsumer.phaseConnection
range: PhaseShuntConnectionKind
required: false
multivalued: false
description: "The type of phase connection, such as wye or delta.\r\n"
q:
slot_uri: cim:EnergyConsumer.q
range: ReactivePower
required: false
multivalued: false
description: "Reactive power of the load. Load sign convention is used, i.e.\
\ positive sign means flow out from a node.\r\nFor voltage dependent loads\
\ the value is at rated voltage.\r\nStarting value for a steady state solution."
qfixed:
slot_uri: cim:EnergyConsumer.qfixed
range: ReactivePower
required: false
multivalued: false
description: "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.\r\n"
qfixedPct:
slot_uri: cim:EnergyConsumer.qfixedPct
range: PerCent
required: false
multivalued: false
description: 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.
LoadResponse:
slot_uri: cim:EnergyConsumer.LoadResponse
range: LoadResponseCharacteristic
required: false
multivalued: false
description: The load response characteristic of this load. If missing, this
load is assumed to be constant power.
EnergyConsumerPhase:
slot_uri: cim:EnergyConsumer.EnergyConsumerPhase
range: EnergyConsumerPhase
required: false
multivalued: true
description: The individual phase models for this energy consumer.
EnergyConsumerAction:
slot_uri: cim:EnergyConsumer.EnergyConsumerAction
range: EnergyConsumerAction
required: false
multivalued: false
description: The energy consumer action that is performed on the energy consumer
PowerCutZone:
slot_uri: cim:EnergyConsumer.PowerCutZone
range: PowerCutZone
required: false
multivalued: false
description: The energy consumer is assigned to this power cut zone.
LoadDynamics:
slot_uri: cim:EnergyConsumer.LoadDynamics
range: LoadDynamics
required: false
multivalued: false
description: Load dynamics model used to describe dynamic behaviour of this
energy consumer.
PowerCutZone:
class_uri: cim:PowerCutZone
is_a: PowerSystemResource
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.LoadModel
description: An area or zone of the power system which is used for load shedding
purposes.
attributes:
cutLevel1:
slot_uri: cim:PowerCutZone.cutLevel1
range: PerCent
required: false
multivalued: false
description: "First level (amount) of load to cut as a percentage of total\
\ zone load.\r\n"
cutLevel2:
slot_uri: cim:PowerCutZone.cutLevel2
range: PerCent
required: false
multivalued: false
description: "Second level (amount) of load to cut as a percentage of total\
\ zone load.\r\n"
EnergyConsumers:
slot_uri: cim:PowerCutZone.EnergyConsumers
range: EnergyConsumer
required: true
multivalued: true
description: Energy consumer is assigned to the power cut zone.
LoadDynamics:
class_uri: cim:LoadDynamics
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.LoadDynamics
description: "Load whose behaviour is described by reference to a standard model\
\ or by definition of a user-defined model.\r\
\nA standard feature of dynamic load behaviour modelling is the ability to associate\
\ the same behaviour to multiple energy consumers by means of a single load\
\ definition. The load model is always applied to individual bus loads (energy\
\ consumers)."
attributes:
EnergyConsumer:
slot_uri: cim:LoadDynamics.EnergyConsumer
range: EnergyConsumer
required: false
multivalued: true
description: Energy consumer to which this dynamics load model applies.
LoadResponseCharacteristic:
class_uri: cim:LoadResponseCharacteristic
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.LoadModel
description: "Models the characteristic response of the load demand due to changes\
\ in system conditions such as voltage and frequency. It is not related to demand\
\ response.\r\nIf LoadResponseCharacteristic.exponentModel is True, the exponential\
\ voltage or frequency dependent models are specified and used as to calculate\
\ active and reactive power components of the load model.\r\nThe equations to\
\ calculate active and reactive power components of the load model are internal\
\ to the power flow calculation, hence they use different quantities depending\
\ on the use case of the data exchange. \r\nThe equations for exponential voltage\
\ dependent load model injected power are: \r\npInjection= Pnominal* (Voltage/cim:BaseVoltage.nominalVoltage)\
\ ** cim:LoadResponseCharacteristic.pVoltageExponent\r\nqInjection= Qnominal*\
\ (Voltage/cim:BaseVoltage.nominalVoltage) ** cim:LoadResponseCharacteristic.qVoltageExponent\r\
\nWhere: \r\n1) * means \"multiply\" and ** is \"raised to power of\";\r\n2)\
\ Pnominal and Qnominal represent the active power and reactive power at nominal\
\ voltage as any load described by the voltage exponential model shall be given\
\ at nominal voltage. This means that EnergyConsumer.p and EnergyConsumer.q\
\ are at nominal voltage.\r\n3) After power flow is solved: \r\n-pInjection\
\ and qInjection correspond to SvPowerflow.p and SvPowerflow.q respectively.\
\ \r\n- Voltage corresponds to SvVoltage.v at the TopologicalNode where the\
\ load is connected."
attributes:
exponentModel:
slot_uri: cim:LoadResponseCharacteristic.exponentModel
range: boolean
required: false
multivalued: false
description: "Indicates the exponential voltage dependency model is to be\
\ used. If false, the coefficient model is to be used.\r\nThe exponential\
\ voltage dependency model consist of the attributes:\r\n- pVoltageExponent\r\
\n- qVoltageExponent\r\n- pFrequencyExponent\r\n- qFrequencyExponent.\r\n\
The coefficient model consist of the attributes:\r\n- pConstantImpedance\r\
\n- pConstantCurrent\r\n- pConstantPower\r\n- qConstantImpedance\r\n- qConstantCurrent\r\
\n- qConstantPower.\r\nThe sum of pConstantImpedance, pConstantCurrent and\
\ pConstantPower shall equal 1.\r\nThe sum of qConstantImpedance, qConstantCurrent\
\ and qConstantPower shall equal 1."
pConstantCurrent:
slot_uri: cim:LoadResponseCharacteristic.pConstantCurrent
range: float
required: false
multivalued: false
description: Portion of active power load modelled as constant current.
pConstantImpedance:
slot_uri: cim:LoadResponseCharacteristic.pConstantImpedance
range: float
required: false
multivalued: false
description: Portion of active power load modelled as constant impedance.
pConstantPower:
slot_uri: cim:LoadResponseCharacteristic.pConstantPower
range: float
required: false
multivalued: false
description: Portion of active power load modelled as constant power.
pFrequencyExponent:
slot_uri: cim:LoadResponseCharacteristic.pFrequencyExponent
range: float
required: false
multivalued: false
description: "Exponent of per unit frequency effecting active power.\r\n"
pVoltageExponent:
slot_uri: cim:LoadResponseCharacteristic.pVoltageExponent
range: float
required: false
multivalued: false
description: Exponent of per unit voltage effecting real power.
qConstantCurrent:
slot_uri: cim:LoadResponseCharacteristic.qConstantCurrent
range: float
required: false
multivalued: false
description: Portion of reactive power load modelled as constant current.
qConstantImpedance:
slot_uri: cim:LoadResponseCharacteristic.qConstantImpedance
range: float
required: false
multivalued: false
description: Portion of reactive power load modelled as constant impedance.
qConstantPower:
slot_uri: cim:LoadResponseCharacteristic.qConstantPower
range: float
required: false
multivalued: false
description: Portion of reactive power load modelled as constant power.
qFrequencyExponent:
slot_uri: cim:LoadResponseCharacteristic.qFrequencyExponent
range: float
required: false
multivalued: false
description: "Exponent of per unit frequency effecting reactive power.\r\n"
qVoltageExponent:
slot_uri: cim:LoadResponseCharacteristic.qVoltageExponent
range: float
required: false
multivalued: false
description: Exponent of per unit voltage effecting reactive power.
EnergyConsumer:
slot_uri: cim:LoadResponseCharacteristic.EnergyConsumer
range: EnergyConsumer
required: false
multivalued: true
description: The set of loads that have the response characteristics.
EnergyConsumerAction:
class_uri: cim:EnergyConsumerAction
is_a: SwitchingAction
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Operations
description: Action to connect or disconnect the Energy Consumer from its Terminal
attributes:
kind:
slot_uri: cim:EnergyConsumerAction.kind
range: TempEquipActionKind
required: false
multivalued: false
description: Switching action to perform
EnergyConsumer:
slot_uri: cim:EnergyConsumerAction.EnergyConsumer
range: EnergyConsumer
required: false
multivalued: false
description: The energy consumer that the energy consumer action is performed
on
PhaseTapChangerTable:
class_uri: cim:PhaseTapChangerTable
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: Describes a tabular curve for how the phase angle difference and
impedance varies with the tap step.
attributes:
PhaseTapChangerTabular:
slot_uri: cim:PhaseTapChangerTable.PhaseTapChangerTabular
range: PhaseTapChangerTabular
required: false
multivalued: true
description: The phase tap changers to which this phase tap table applies.
PhaseTapChangerTablePoint:
slot_uri: cim:PhaseTapChangerTable.PhaseTapChangerTablePoint
range: PhaseTapChangerTablePoint
required: true
multivalued: true
description: The points of this table.
PhaseTapChangerTablePoint:
class_uri: cim:PhaseTapChangerTablePoint
is_a: TapChangerTablePoint
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: "Describes each tap step in the phase tap changer tabular curve.\r\
\n"
attributes:
angle:
slot_uri: cim:PhaseTapChangerTablePoint.angle
range: AngleDegrees
required: false
multivalued: false
description: "The angle difference in degrees. A positive value indicates\
\ a positive angle variation from the Terminal at the PowerTransformerEnd,\
\ where the TapChanger is located, into the transformer.\r\n"
PhaseTapChangerTable:
slot_uri: cim:PhaseTapChangerTablePoint.PhaseTapChangerTable
range: PhaseTapChangerTable
required: true
multivalued: false
description: The table of this point.
PhaseTapChangerTabular:
class_uri: cim:PhaseTapChangerTabular
is_a: PhaseTapChanger
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: 'Describes a tap changer with a table defining the relation between
the tap step and the phase angle difference across the transformer. '
attributes:
PhaseTapChangerTable:
slot_uri: cim:PhaseTapChangerTabular.PhaseTapChangerTable
range: PhaseTapChangerTable
required: false
multivalued: false
description: The phase tap changer table for this phase tap changer.
Breaker:
class_uri: cim:Breaker
is_a: ProtectedSwitch
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: A mechanical switching device capable of making, carrying, and breaking
currents under normal circuit conditions and also making, carrying for a specified
time, and breaking currents under specified abnormal circuit conditions e.g. those
of short circuit.
attributes:
inTransitTime:
slot_uri: cim:Breaker.inTransitTime
range: Seconds
required: false
multivalued: false
description: "The transition time from open to close.\r\n"
GroundDisconnector:
class_uri: cim:GroundDisconnector
is_a: Switch
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: A manually operated or motor operated mechanical switching device
used for isolating a circuit or equipment from ground.
PhaseTapChangerAsymmetrical:
class_uri: cim:PhaseTapChangerAsymmetrical
is_a: PhaseTapChangerNonLinear
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: Describes the tap model for an asymmetrical phase shifting transformer
in which the difference voltage vector adds to the in-phase winding. The out-of-phase
winding is the transformer end where the tap changer is located. The angle
between the in-phase and out-of-phase windings is named the winding connection
angle. The phase shift depends on both the difference voltage magnitude and
the winding connection angle.
attributes:
windingConnectionAngle:
slot_uri: cim:PhaseTapChangerAsymmetrical.windingConnectionAngle
range: AngleDegrees
required: false
multivalued: false
description: The phase angle between the in-phase winding and the out-of -phase
winding used for creating phase shift. The out-of-phase winding produces
what is known as the difference voltage. Setting this angle to 90 degrees
is not the same as a symmetrical transformer. The attribute can only be
multiples of 30 degrees. The allowed range is -150 degrees to 150 degrees
excluding 0.
PhaseTapChangerNonLinear:
class_uri: cim:PhaseTapChangerNonLinear
is_a: PhaseTapChanger
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: The non-linear phase tap changer describes the non-linear behaviour
of a phase tap changer. This is a base class for the symmetrical and asymmetrical
phase tap changer models. The details of these models can be found in IEC 61970-301.
attributes:
voltageStepIncrement:
slot_uri: cim:PhaseTapChangerNonLinear.voltageStepIncrement
range: PerCent
required: false
multivalued: false
description: "The voltage step increment on the out of phase winding (the\
\ PowerTransformerEnd where the TapChanger is located) specified in percent\
\ of rated voltage of the PowerTransformerEnd. A positive value means a\
\ positive voltage variation from the Terminal at the PowerTransformerEnd,\
\ where the TapChanger is located, into the transformer.\r\nWhen the increment\
\ is negative, the voltage decreases when the tap step increases."
xMax:
slot_uri: cim:PhaseTapChangerNonLinear.xMax
range: Reactance
required: false
multivalued: false
description: "The reactance depends on the tap position according to a \"\
u\" shaped curve. The maximum reactance (xMax) appears at the low and high\
\ tap positions. Depending on the \u201Cu\u201D curve the attribute can\
\ be either higher or lower than PowerTransformerEnd.x.\r\n"
xMin:
slot_uri: cim:PhaseTapChangerNonLinear.xMin
range: Reactance
required: false
multivalued: false
description: "The reactance depend on the tap position according to a \"u\"\
\ shaped curve. The minimum reactance (xMin) appear at the mid tap position.\
\ PowerTransformerEnd.x shall be consistent with PhaseTapChangerLinear.xMin\
\ and PhaseTapChangerNonLinear.xMin. In case of inconsistency, PowerTransformerEnd.x\
\ shall be used.\r\n"
PhaseTapChangerSymmetrical:
class_uri: cim:PhaseTapChangerSymmetrical
is_a: PhaseTapChangerNonLinear
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: Describes a symmetrical phase shifting transformer tap model in which
the voltage magnitude of both sides is the same. The difference voltage magnitude
is the base in an equal-sided triangle where the sides corresponds to the primary
and secondary voltages. The phase angle difference corresponds to the top angle
and can be expressed as twice the arctangent of half the total difference voltage.
Fuse:
class_uri: cim:Fuse
is_a: Switch
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: An overcurrent protective device with a circuit opening fusible part
that is heated and severed by the passage of overcurrent through it. A fuse
is considered a switching device because it breaks current.
PetersenCoil:
class_uri: cim:PetersenCoil
is_a: EarthFaultCompensator
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: A variable impedance device normally used to offset line charging
during single line faults in an ungrounded section of network.
attributes:
mode:
slot_uri: cim:PetersenCoil.mode
range: PetersenCoilModeKind
required: false
multivalued: false
description: The mode of operation of the Petersen coil.
nominalU:
slot_uri: cim:PetersenCoil.nominalU
range: Voltage
required: false
multivalued: false
description: The nominal voltage for which the coil is designed.
offsetCurrent:
slot_uri: cim:PetersenCoil.offsetCurrent
range: CurrentFlow
required: false
multivalued: false
description: The offset current that the Petersen coil controller is operating
from the resonant point. This is normally a fixed amount for which the
controller is configured and could be positive or negative. Typically 0
to 60 A depending on voltage and resonance conditions.
positionCurrent:
slot_uri: cim:PetersenCoil.positionCurrent
range: CurrentFlow
required: false
multivalued: false
description: The control current used to control the Petersen coil also known
as the position current. Typically in the range of 20 mA to 200 mA.
xGroundMax:
slot_uri: cim:PetersenCoil.xGroundMax
range: Reactance
required: false
multivalued: false
description: 'The maximum reactance. '
xGroundMin:
slot_uri: cim:PetersenCoil.xGroundMin
range: Reactance
required: false
multivalued: false
description: The minimum reactance.
xGroundNominal:
slot_uri: cim:PetersenCoil.xGroundNominal
range: Reactance
required: false
multivalued: false
description: The nominal reactance. This is the operating point (normally
over compensation) that is defined based on the resonance point in the healthy
network condition. The impedance is calculated based on nominal voltage
divided by position current.
EarthFaultCompensator:
class_uri: cim:EarthFaultCompensator
is_a: ConductingEquipment
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: A conducting equipment used to represent a connection to ground which
is typically used to compensate earth faults. An earth fault compensator device
modelled with a single terminal implies a second terminal solidly connected
to ground. If two terminals are modelled, the ground is not assumed and normal
connection rules apply.
attributes:
r:
slot_uri: cim:EarthFaultCompensator.r
range: Resistance
required: false
multivalued: false
description: Nominal resistance of device.
GroundingImpedance:
class_uri: cim:GroundingImpedance
is_a: EarthFaultCompensator
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: A fixed impedance device used for grounding.
attributes:
x:
slot_uri: cim:GroundingImpedance.x
range: Reactance
required: false
multivalued: false
description: Reactance of device.
Recloser:
class_uri: cim:Recloser
is_a: ProtectedSwitch
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: "Pole-mounted fault interrupter with built-in phase and ground relays,\
\ current transformer (CT), and supplemental controls.\r\n"
Sectionaliser:
class_uri: cim:Sectionaliser
is_a: Switch
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: "Automatic switch that will lock open to isolate a faulted section.\
\ It may, or may not, have load breaking capability. Its primary purpose is\
\ to provide fault sectionalising at locations where the fault current is either\
\ too high, or too low, for proper coordination of fuses.\r\n"
EnergySource:
class_uri: cim:EnergySource
is_a: EnergyConnection
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: A generic equivalent for an energy supplier on a transmission or
distribution voltage level.
attributes:
activePower:
slot_uri: cim:EnergySource.activePower
range: ActivePower
required: false
multivalued: false
description: "High voltage source active injection. Load sign convention is\
\ used, i.e. positive sign means flow out from a node.\r\nStarting value\
\ for steady state solutions."
nominalVoltage:
slot_uri: cim:EnergySource.nominalVoltage
range: Voltage
required: false
multivalued: false
description: Phase-to-phase nominal voltage.
pMax:
slot_uri: cim:EnergySource.pMax
range: ActivePower
required: false
multivalued: false
description: This is the maximum active power that can be produced by the
source. Load sign convention is used, i.e. positive sign means flow out
from a TopologicalNode (bus) into the conducting equipment.
pMin:
slot_uri: cim:EnergySource.pMin
range: ActivePower
required: false
multivalued: false
description: This is the minimum active power that can be produced by the
source. Load sign convention is used, i.e. positive sign means flow out
from a TopologicalNode (bus) into the conducting equipment.
r:
slot_uri: cim:EnergySource.r
range: Resistance
required: false
multivalued: false
description: Positive sequence Thevenin resistance.
r0:
slot_uri: cim:EnergySource.r0
range: Resistance
required: false
multivalued: false
description: Zero sequence Thevenin resistance.
reactivePower:
slot_uri: cim:EnergySource.reactivePower
range: ReactivePower
required: false
multivalued: false
description: "High voltage source reactive injection. Load sign convention\
\ is used, i.e. positive sign means flow out from a node.\r\nStarting value\
\ for steady state solutions."
rn:
slot_uri: cim:EnergySource.rn
range: Resistance
required: false
multivalued: false
description: Negative sequence Thevenin resistance.
voltageAngle:
slot_uri: cim:EnergySource.voltageAngle
range: AngleRadians
required: false
multivalued: false
description: Phase angle of a-phase open circuit used when voltage characteristics
need to be imposed at the node associated with the terminal of the energy
source, such as when voltages and angles from the transmission level are
used as input to the distribution network. The attribute shall be a positive
value or zero.
voltageMagnitude:
slot_uri: cim:EnergySource.voltageMagnitude
range: Voltage
required: false
multivalued: false
description: Phase-to-phase open circuit voltage magnitude used when voltage
characteristics need to be imposed at the node associated with the terminal
of the energy source, such as when voltages and angles from the transmission
level are used as input to the distribution network. The attribute shall
be a positive value or zero.
x:
slot_uri: cim:EnergySource.x
range: Reactance
required: false
multivalued: false
description: Positive sequence Thevenin reactance.
x0:
slot_uri: cim:EnergySource.x0
range: Reactance
required: false
multivalued: false
description: Zero sequence Thevenin reactance.
xn:
slot_uri: cim:EnergySource.xn
range: Reactance
required: false
multivalued: false
description: Negative sequence Thevenin reactance.
EnergySchedulingType:
slot_uri: cim:EnergySource.EnergySchedulingType
range: EnergySchedulingType
required: false
multivalued: false
description: Energy Scheduling Type of an Energy Source.
EnergySourcePhase:
slot_uri: cim:EnergySource.EnergySourcePhase
range: EnergySourcePhase
required: false
multivalued: true
description: The individual phase information of the energy source.
EnergySourceAction:
slot_uri: cim:EnergySource.EnergySourceAction
range: EnergySourceAction
required: false
multivalued: false
description: Action taken with this energy source.
EnergySourcePhase:
class_uri: cim:EnergySourcePhase
is_a: PowerSystemResource
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: Represents the single phase information of an unbalanced energy source.
attributes:
phase:
slot_uri: cim:EnergySourcePhase.phase
range: SinglePhaseKind
required: false
multivalued: false
description: Phase of this energy source component. If the energy source
wye connected, the connection is from the indicated phase to the central
ground or neutral point. If the energy source is delta connected, the phase
indicates an energy source connected from the indicated phase to the next
logical non-neutral phase.
EnergySource:
slot_uri: cim:EnergySourcePhase.EnergySource
range: EnergySource
required: true
multivalued: false
description: The energy sourceto which the phase belongs.
EnergySourceAction:
class_uri: cim:EnergySourceAction
is_a: SwitchingAction
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Operations
description: Action on energy source as a switching step.
attributes:
kind:
slot_uri: cim:EnergySourceAction.kind
range: TempEquipActionKind
required: false
multivalued: false
description: Switching action to perform.
EnergySource:
slot_uri: cim:EnergySourceAction.EnergySource
range: EnergySource
required: false
multivalued: false
description: Energy source on which this action is taken.
EnergySchedulingType:
class_uri: cim:EnergySchedulingType
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: Used to define the type of generation for scheduling purposes.
attributes:
EnergySource:
slot_uri: cim:EnergySchedulingType.EnergySource
range: EnergySource
required: false
multivalued: true
description: Energy Source of a particular Energy Scheduling Type.
StaticVarCompensator:
class_uri: cim:StaticVarCompensator
is_a: RegulatingCondEq
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: "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.\r\n\r\nThe 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."
attributes:
capacitiveRating:
slot_uri: cim:StaticVarCompensator.capacitiveRating
range: Reactance
required: false
multivalued: false
description: Capacitive reactance at maximum capacitive reactive power. Shall
always be positive.
inductiveRating:
slot_uri: cim:StaticVarCompensator.inductiveRating
range: Reactance
required: false
multivalued: false
description: 'Inductive reactance at maximum inductive reactive power. Shall
always be negative. '
q:
slot_uri: cim:StaticVarCompensator.q
range: ReactivePower
required: false
multivalued: false
description: "Reactive power injection. Load sign convention is used, i.e.\
\ positive sign means flow out from a node.\r\nStarting value for a steady\
\ state solution."
slope:
slot_uri: cim:StaticVarCompensator.slope
range: VoltagePerReactivePower
required: false
multivalued: false
description: "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.\r\nThe attribute shall be a positive\
\ value or zero."
sVCControlMode:
slot_uri: cim:StaticVarCompensator.sVCControlMode
range: SVCControlMode
required: false
multivalued: false
description: SVC control mode.
voltageSetPoint:
slot_uri: cim:StaticVarCompensator.voltageSetPoint
range: Voltage
required: false
multivalued: false
description: 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.
StaticVarCompensatorDynamics:
slot_uri: cim:StaticVarCompensator.StaticVarCompensatorDynamics
range: StaticVarCompensatorDynamics
required: false
multivalued: false
description: Static Var Compensator dynamics model used to describe dynamic
behaviour of this Static Var Compensator.
StaticVarCompensatorDynamics:
class_uri: cim:StaticVarCompensatorDynamics
is_a: DynamicsFunctionBlock
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.StaticVarCompensatorDynamics
description: Static var compensator whose behaviour is described by reference
to a standard model or by definition of a user-defined
model.
attributes:
StaticVarCompensator:
slot_uri: cim:StaticVarCompensatorDynamics.StaticVarCompensator
range: StaticVarCompensator
required: true
multivalued: false
description: Static Var Compensator to which Static Var Compensator dynamics
model applies.
Junction:
class_uri: cim:Junction
is_a: Connector
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: A point where one or more conducting equipments are connected with
zero resistance.
PhaseTapChangerLinear:
class_uri: cim:PhaseTapChangerLinear
is_a: PhaseTapChanger
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: "Describes a tap changer with a linear relation between the tap step\
\ and the phase angle difference across the transformer. This is a mathematical\
\ model that is an approximation of a real phase tap changer.\r\nThe phase angle\
\ is computed as stepPhaseShiftIncrement times the tap position.\r\nThe voltage\
\ magnitude of both sides is the same."
attributes:
stepPhaseShiftIncrement:
slot_uri: cim:PhaseTapChangerLinear.stepPhaseShiftIncrement
range: AngleDegrees
required: false
multivalued: false
description: "Phase shift per step position. A positive value indicates a\
\ positive angle variation from the Terminal at the PowerTransformerEnd,\
\ where the TapChanger is located, into the transformer.\r\nThe actual\
\ phase shift increment might be more accurately computed from the symmetrical\
\ or asymmetrical models or a tap step table lookup if those are available."
xMax:
slot_uri: cim:PhaseTapChangerLinear.xMax
range: Reactance
required: false
multivalued: false
description: "The reactance depends on the tap position according to a \"\
u\" shaped curve. The maximum reactance (xMax) appears at the low and high\
\ tap positions. Depending on the \u201Cu\u201D curve the attribute can\
\ be either higher or lower than PowerTransformerEnd.x."
xMin:
slot_uri: cim:PhaseTapChangerLinear.xMin
range: Reactance
required: false
multivalued: false
description: The reactance depends on the tap position according to a "u"
shaped curve. The minimum reactance (xMin) appears at the mid tap position. PowerTransformerEnd.x
shall be consistent with PhaseTapChangerLinear.xMin and PhaseTapChangerNonLinear.xMin.
In case of inconsistency, PowerTransformerEnd.x shall be used.
FrequencyConverter:
class_uri: cim:FrequencyConverter
is_a: RegulatingCondEq
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: 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.
attributes:
frequency:
slot_uri: cim:FrequencyConverter.frequency
range: Frequency
required: false
multivalued: false
description: Frequency on the AC side.
maxP:
slot_uri: cim:FrequencyConverter.maxP
range: ActivePower
required: false
multivalued: false
description: The maximum active power on the DC side at which the frequency
converter should operate.
maxU:
slot_uri: cim:FrequencyConverter.maxU
range: Voltage
required: false
multivalued: false
description: The maximum voltage on the DC side at which the frequency converter
should operate.
minP:
slot_uri: cim:FrequencyConverter.minP
range: ActivePower
required: false
multivalued: false
description: The minimum active power on the DC side at which the frequency
converter should operate.
minU:
slot_uri: cim:FrequencyConverter.minU
range: Voltage
required: false
multivalued: false
description: The minimum voltage on the DC side at which the frequency converter
should operate.
Plant:
class_uri: cim:Plant
is_a: EquipmentContainer
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: A Plant is a collection of equipment for purposes of generation.
LoadBreakSwitch:
class_uri: cim:LoadBreakSwitch
is_a: ProtectedSwitch
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: A mechanical switching device capable of making, carrying, and breaking
currents under normal operating conditions.
ExternalNetworkInjection:
class_uri: cim:ExternalNetworkInjection
is_a: RegulatingCondEq
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: This class represents the external network and it is used for IEC
60909 calculations.
attributes:
governorSCD:
slot_uri: cim:ExternalNetworkInjection.governorSCD
range: ActivePowerPerFrequency
required: false
multivalued: false
description: 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.
ikSecond:
slot_uri: cim:ExternalNetworkInjection.ikSecond
range: boolean
required: false
multivalued: false
description: 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.
maxInitialSymShCCurrent:
slot_uri: cim:ExternalNetworkInjection.maxInitialSymShCCurrent
range: CurrentFlow
required: false
multivalued: false
description: " 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.\r\n"
maxP:
slot_uri: cim:ExternalNetworkInjection.maxP
range: ActivePower
required: false
multivalued: false
description: Maximum active power of the injection.
maxQ:
slot_uri: cim:ExternalNetworkInjection.maxQ
range: ReactivePower
required: false
multivalued: false
description: "Maximum reactive power limit. It is used for modelling of infeed\
\ for load flow exchange and not for short circuit modelling.\r\n"
maxR0ToX0Ratio:
slot_uri: cim:ExternalNetworkInjection.maxR0ToX0Ratio
range: float
required: false
multivalued: false
description: "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.\r\n"
maxR1ToX1Ratio:
slot_uri: cim:ExternalNetworkInjection.maxR1ToX1Ratio
range: float
required: false
multivalued: false
description: "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.\r\n"
maxZ0ToZ1Ratio:
slot_uri: cim:ExternalNetworkInjection.maxZ0ToZ1Ratio
range: float
required: false
multivalued: false
description: "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.\r\n"
minInitialSymShCCurrent:
slot_uri: cim:ExternalNetworkInjection.minInitialSymShCCurrent
range: CurrentFlow
required: false
multivalued: false
description: "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.\r\n"
minP:
slot_uri: cim:ExternalNetworkInjection.minP
range: ActivePower
required: false
multivalued: false
description: Minimum active power of the injection.
minQ:
slot_uri: cim:ExternalNetworkInjection.minQ
range: ReactivePower
required: false
multivalued: false
description: "Minimum reactive power limit. It is used for modelling of infeed\
\ for load flow exchange and not for short circuit modelling.\r\n"
minR0ToX0Ratio:
slot_uri: cim:ExternalNetworkInjection.minR0ToX0Ratio
range: float
required: false
multivalued: false
description: "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.\r\n"
minR1ToX1Ratio:
slot_uri: cim:ExternalNetworkInjection.minR1ToX1Ratio
range: float
required: false
multivalued: false
description: "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.\r\n"
minZ0ToZ1Ratio:
slot_uri: cim:ExternalNetworkInjection.minZ0ToZ1Ratio
range: float
required: false
multivalued: false
description: "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.\r\n"
p:
slot_uri: cim:ExternalNetworkInjection.p
range: ActivePower
required: false
multivalued: false
description: "Active power injection. Load sign convention is used, i.e. positive\
\ sign means flow out from a node.\r\nStarting value for steady state solutions."
q:
slot_uri: cim:ExternalNetworkInjection.q
range: ReactivePower
required: false
multivalued: false
description: "Reactive power injection. Load sign convention is used, i.e.\
\ positive sign means flow out from a node.\r\nStarting value for steady\
\ state solutions."
referencePriority:
slot_uri: cim:ExternalNetworkInjection.referencePriority
range: integer
required: false
multivalued: false
description: "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.\r\n"
voltageFactor:
slot_uri: cim:ExternalNetworkInjection.voltageFactor
range: PU
required: false
multivalued: false
description: "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.\r\n"
LinearShuntCompensator:
class_uri: cim:LinearShuntCompensator
is_a: ShuntCompensator
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: A linear shunt compensator has banks or sections with equal admittance
values.
attributes:
b0PerSection:
slot_uri: cim:LinearShuntCompensator.b0PerSection
range: Susceptance
required: false
multivalued: false
description: Zero sequence shunt (charging) susceptance per section.
bPerSection:
slot_uri: cim:LinearShuntCompensator.bPerSection
range: Susceptance
required: false
multivalued: false
description: Positive sequence shunt (charging) susceptance per section.
g0PerSection:
slot_uri: cim:LinearShuntCompensator.g0PerSection
range: Conductance
required: false
multivalued: false
description: Zero sequence shunt (charging) conductance per section.
gPerSection:
slot_uri: cim:LinearShuntCompensator.gPerSection
range: Conductance
required: false
multivalued: false
description: Positive sequence shunt (charging) conductance per section.
NonlinearShuntCompensator:
class_uri: cim:NonlinearShuntCompensator
is_a: ShuntCompensator
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: 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.
attributes:
NonlinearShuntCompensatorPoints:
slot_uri: cim:NonlinearShuntCompensator.NonlinearShuntCompensatorPoints
range: NonlinearShuntCompensatorPoint
required: true
multivalued: true
description: All points of the non-linear shunt compensator.
NonlinearShuntCompensatorPoint:
class_uri: cim:NonlinearShuntCompensatorPoint
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: A non linear shunt compensator bank or section admittance value.
The number of NonlinearShuntCompenstorPoint instances associated with a NonlinearShuntCompensator
shall be equal to ShuntCompensator.maximumSections. ShuntCompensator.sections
shall only be set to one of the NonlinearShuntCompenstorPoint.sectionNumber.
There is no interpolation between NonlinearShuntCompenstorPoint-s.
attributes:
b:
slot_uri: cim:NonlinearShuntCompensatorPoint.b
range: Susceptance
required: false
multivalued: false
description: Positive sequence shunt (charging) susceptance per section.
b0:
slot_uri: cim:NonlinearShuntCompensatorPoint.b0
range: Susceptance
required: false
multivalued: false
description: Zero sequence shunt (charging) susceptance per section.
g:
slot_uri: cim:NonlinearShuntCompensatorPoint.g
range: Conductance
required: false
multivalued: false
description: Positive sequence shunt (charging) conductance per section.
g0:
slot_uri: cim:NonlinearShuntCompensatorPoint.g0
range: Conductance
required: false
multivalued: false
description: Zero sequence shunt (charging) conductance per section.
sectionNumber:
slot_uri: cim:NonlinearShuntCompensatorPoint.sectionNumber
range: integer
required: false
multivalued: false
description: The number of the section.
NonlinearShuntCompensator:
slot_uri: cim:NonlinearShuntCompensatorPoint.NonlinearShuntCompensator
range: NonlinearShuntCompensator
required: true
multivalued: false
description: Non-linear shunt compensator owning this point.
LinearShuntCompensatorPhase:
class_uri: cim:LinearShuntCompensatorPhase
is_a: ShuntCompensatorPhase
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: A per phase linear shunt compensator has banks or sections with equal
admittance values.
attributes:
bPerSection:
slot_uri: cim:LinearShuntCompensatorPhase.bPerSection
range: Susceptance
required: false
multivalued: false
description: "Susceptance per section of the phase if shunt compensator is\
\ wye connected. Susceptance per section phase to phase if shunt compensator\
\ is delta connected.\r\n"
gPerSection:
slot_uri: cim:LinearShuntCompensatorPhase.gPerSection
range: Conductance
required: false
multivalued: false
description: "Conductance per section for this phase if shunt compensator\
\ is wye connected. Conductance per section phase to phase if shunt compensator\
\ is delta connected.\r\n"
NonlinearShuntCompensatorPhase:
class_uri: cim:NonlinearShuntCompensatorPhase
is_a: ShuntCompensatorPhase
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: 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.
attributes:
NonlinearShuntCompensatorPhasePoints:
slot_uri: cim:NonlinearShuntCompensatorPhase.NonlinearShuntCompensatorPhasePoints
range: NonlinearShuntCompensatorPhasePoint
required: true
multivalued: true
description: All points of the non-linear shunt compensator phase.
NonlinearShuntCompensatorPhasePoint:
class_uri: cim:NonlinearShuntCompensatorPhasePoint
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: A per phase non linear shunt compensator bank or section admittance
value. The number of NonlinearShuntCompenstorPhasePoint instances associated
with a NonlinearShuntCompensatorPhase shall be equal to ShuntCompensatorPhase.maximumSections.
ShuntCompensator.sections shall only be set to one of the NonlinearShuntCompenstorPhasePoint.sectionNumber.
There is no interpolation between NonlinearShuntCompenstorPhasePoint-s.
attributes:
b:
slot_uri: cim:NonlinearShuntCompensatorPhasePoint.b
range: Susceptance
required: false
multivalued: false
description: Positive sequence shunt (charging) susceptance per section.
g:
slot_uri: cim:NonlinearShuntCompensatorPhasePoint.g
range: Conductance
required: false
multivalued: false
description: Positive sequence shunt (charging) conductance per section.
sectionNumber:
slot_uri: cim:NonlinearShuntCompensatorPhasePoint.sectionNumber
range: integer
required: false
multivalued: false
description: The number of the section.
NonlinearShuntCompensatorPhase:
slot_uri: cim:NonlinearShuntCompensatorPhasePoint.NonlinearShuntCompensatorPhase
range: NonlinearShuntCompensatorPhase
required: true
multivalued: false
description: Non-linear shunt compensator phase owning this point.
WireSegment:
class_uri: cim:WireSegment
is_a: Conductor
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: A two terminal and power conducting device of negligible impedance
and length represented as zero impedance device that can be used to connect
auxiliary equipment to its terminals.
attributes:
WireSegmentPhases:
slot_uri: cim:WireSegment.WireSegmentPhases
range: WireSegmentPhase
required: false
multivalued: true
description: The wire segment phases which belong to the wire segment.
WireSegmentPhase:
class_uri: cim:WireSegmentPhase
is_a: PowerSystemResource
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: Represents a single wire of an alternating current wire segment.
attributes:
phase:
slot_uri: cim:WireSegmentPhase.phase
range: SinglePhaseKind
required: false
multivalued: false
description: The phase connection of the wire at both ends.
sequenceNumber:
slot_uri: cim:WireSegmentPhase.sequenceNumber
range: integer
required: false
multivalued: false
description: Number designation for this wire segment phase. Each wire segment
phase within a wire segment should have a unique sequence number.
WireSegment:
slot_uri: cim:WireSegmentPhase.WireSegment
range: WireSegment
required: true
multivalued: false
description: The wire segment to which the phase belongs.
DisconnectingCircuitBreaker:
class_uri: cim:DisconnectingCircuitBreaker
is_a: Breaker
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
description: A circuit breaking device including disconnecting function, eliminating
the need for separate disconnectors.
PWRSteamSupply:
class_uri: cim:PWRSteamSupply
is_a: SteamSupply
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.GenerationTrainingSimulation
description: "Pressurized water reactor used as a steam supply to a steam turbine.\r\
\n"
attributes:
coldLegFBLagTC:
slot_uri: cim:PWRSteamSupply.coldLegFBLagTC
range: PU
required: false
multivalued: false
description: "Cold leg feedback lag time constant.\r\n"
coldLegFBLeadTC1:
slot_uri: cim:PWRSteamSupply.coldLegFBLeadTC1
range: PU
required: false
multivalued: false
description: "Cold leg feedback lead time constant.\r\n"
coldLegFBLeadTC2:
slot_uri: cim:PWRSteamSupply.coldLegFBLeadTC2
range: PU
required: false
multivalued: false
description: "Cold leg feedback lead time constant.\r\n"
coldLegFG1:
slot_uri: cim:PWRSteamSupply.coldLegFG1
range: PU
required: false
multivalued: false
description: "Cold leg feedback gain 1.\r\n"
coldLegFG2:
slot_uri: cim:PWRSteamSupply.coldLegFG2
range: PU
required: false
multivalued: false
description: "Cold leg feedback gain 2.\r\n"
coldLegLagTC:
slot_uri: cim:PWRSteamSupply.coldLegLagTC
range: PU
required: false
multivalued: false
description: "Cold leg lag time constant.\r\n"
coreHTLagTC1:
slot_uri: cim:PWRSteamSupply.coreHTLagTC1
range: PU
required: false
multivalued: false
description: "Core heat transfer lag time constant.\r\n"
coreHTLagTC2:
slot_uri: cim:PWRSteamSupply.coreHTLagTC2
range: PU
required: false
multivalued: false
description: "Core heat transfer lag time constant.\r\n"
coreNeutronicsEffTC:
slot_uri: cim:PWRSteamSupply.coreNeutronicsEffTC
range: PU
required: false
multivalued: false
description: "Core neutronics effective time constant.\r\n"
coreNeutronicsHT:
slot_uri: cim:PWRSteamSupply.coreNeutronicsHT
range: PU
required: false
multivalued: false
description: "Core neutronics and heat transfer.\r\n"
feedbackFactor:
slot_uri: cim:PWRSteamSupply.feedbackFactor
range: PU
required: false
multivalued: false
description: "Feedback factor.\r\n"
hotLegLagTC:
slot_uri: cim:PWRSteamSupply.hotLegLagTC
range: PU
required: false
multivalued: false
description: "Hot leg lag time constant.\r\n"
hotLegSteamGain:
slot_uri: cim:PWRSteamSupply.hotLegSteamGain
range: PU
required: false
multivalued: false
description: "Hot leg steam gain.\r\n"
hotLegToColdLegGain:
slot_uri: cim:PWRSteamSupply.hotLegToColdLegGain
range: PU
required: false
multivalued: false
description: "Hot leg to cold leg gain.\r\n"
pressureCG:
slot_uri: cim:PWRSteamSupply.pressureCG
range: PU
required: false
multivalued: false
description: "Pressure control gain.\r\n"
steamFlowFG:
slot_uri: cim:PWRSteamSupply.steamFlowFG
range: PU
required: false
multivalued: false
description: "Steam flow feedback gain.\r\n"
steamPressureDropLagTC:
slot_uri: cim:PWRSteamSupply.steamPressureDropLagTC
range: PU
required: false
multivalued: false
description: "Steam pressure drop lag time constant.\r\n"
steamPressureFG:
slot_uri: cim:PWRSteamSupply.steamPressureFG
range: PU
required: false
multivalued: false
description: "Steam pressure feedback gain.\r\n"
throttlePressureFactor:
slot_uri: cim:PWRSteamSupply.throttlePressureFactor
range: PU
required: false
multivalued: false
description: "Throttle pressure factor.\r\n"
throttlePressureSP:
slot_uri: cim:PWRSteamSupply.throttlePressureSP
range: PU
required: false
multivalued: false
description: "Throttle pressure setpoint.\r\n"
BWRSteamSupply:
class_uri: cim:BWRSteamSupply
is_a: SteamSupply
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.GenerationTrainingSimulation
description: "Boiling water reactor used as a steam supply to a steam turbine.\r\
\n"
attributes:
highPowerLimit:
slot_uri: cim:BWRSteamSupply.highPowerLimit
range: PU
required: false
multivalued: false
description: "High power limit.\r\n"
inCoreThermalTC:
slot_uri: cim:BWRSteamSupply.inCoreThermalTC
range: Seconds
required: false
multivalued: false
description: "In-core thermal time constant.\r\n"
integralGain:
slot_uri: cim:BWRSteamSupply.integralGain
range: float
required: false
multivalued: false
description: "Integral gain.\r\n"
lowerLimit:
slot_uri: cim:BWRSteamSupply.lowerLimit
range: PU
required: false
multivalued: false
description: "Initial lower limit.\r\n"
lowPowerLimit:
slot_uri: cim:BWRSteamSupply.lowPowerLimit
range: PU
required: false
multivalued: false
description: "Low power limit.\r\n"
pressureLimit:
slot_uri: cim:BWRSteamSupply.pressureLimit
range: PU
required: false
multivalued: false
description: "Pressure limit.\r\n"
pressureSetpointGA:
slot_uri: cim:BWRSteamSupply.pressureSetpointGA
range: float
required: false
multivalued: false
description: "Pressure setpoint gain adjuster.\r\n"
pressureSetpointTC1:
slot_uri: cim:BWRSteamSupply.pressureSetpointTC1
range: Seconds
required: false
multivalued: false
description: "Pressure setpoint time constant.\r\n"
pressureSetpointTC2:
slot_uri: cim:BWRSteamSupply.pressureSetpointTC2
range: Seconds
required: false
multivalued: false
description: "Pressure setpoint time constant.\r\n"
proportionalGain:
slot_uri: cim:BWRSteamSupply.proportionalGain
range: float
required: false
multivalued: false
description: "Proportional gain.\r\n"
rfAux1:
slot_uri: cim:BWRSteamSupply.rfAux1
range: PU
required: false
multivalued: false
description: Coefficient for modelling the effect of off-nominal frequency
and voltage on recirculation and core flow, which affects the BWR power
output.
rfAux2:
slot_uri: cim:BWRSteamSupply.rfAux2
range: PU
required: false
multivalued: false
description: Coefficient for modelling the effect of off-nominal frequency
and voltage on recirculation and core flow, which affects the BWR power
output.
rfAux3:
slot_uri: cim:BWRSteamSupply.rfAux3
range: PU
required: false
multivalued: false
description: Coefficient for modelling the effect of off-nominal frequency
and voltage on recirculation and core flow, which affects the BWR power
output.
rfAux4:
slot_uri: cim:BWRSteamSupply.rfAux4
range: PU
required: false
multivalued: false
description: Coefficient for modelling the effect of off-nominal frequency
and voltage on recirculation and core flow, which affects the BWR power
output.
rfAux5:
slot_uri: cim:BWRSteamSupply.rfAux5
range: PU
required: false
multivalued: false
description: Coefficient for modelling the effect of off-nominal frequency
and voltage on recirculation and core flow, which affects the BWR power
output.
rfAux6:
slot_uri: cim:BWRSteamSupply.rfAux6
range: PU
required: false
multivalued: false
description: Coefficient for modelling the effect of off-nominal frequency
and voltage on recirculation and core flow, which affects the BWR power
output.
rfAux7:
slot_uri: cim:BWRSteamSupply.rfAux7
range: PU
required: false
multivalued: false
description: Coefficient for modelling the effect of off-nominal frequency
and voltage on recirculation and core flow, which affects the BWR power
output.
rfAux8:
slot_uri: cim:BWRSteamSupply.rfAux8
range: PU
required: false
multivalued: false
description: Coefficient for modelling the effect of off-nominal frequency
and voltage on recirculation and core flow, which affects the BWR power
output.
rodPattern:
slot_uri: cim:BWRSteamSupply.rodPattern
range: PU
required: false
multivalued: false
description: "Rod pattern.\r\n"
rodPatternConstant:
slot_uri: cim:BWRSteamSupply.rodPatternConstant
range: float
required: false
multivalued: false
description: "Constant associated with rod pattern.\r\n"
upperLimit:
slot_uri: cim:BWRSteamSupply.upperLimit
range: PU
required: false
multivalued: false
description: "Initial upper limit.\r\n"
Subcritical:
class_uri: cim:Subcritical
is_a: FossilSteamSupply
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.GenerationTrainingSimulation
description: "Once-through subcritical boiler.\r\n"
DrumBoiler:
class_uri: cim:DrumBoiler
is_a: FossilSteamSupply
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.GenerationTrainingSimulation
description: "Drum boiler.\r\n"
attributes:
drumBoilerRating:
slot_uri: cim:DrumBoiler.drumBoilerRating
range: float
required: false
multivalued: false
description: "Rating of drum boiler in steam units.\r\n"
Supercritical:
class_uri: cim:Supercritical
is_a: FossilSteamSupply
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.GenerationTrainingSimulation
description: "Once-through supercritical boiler.\r\n"
HydroTurbine:
class_uri: cim:HydroTurbine
is_a: PrimeMover
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.GenerationTrainingSimulation
description: "A water driven prime mover. Typical turbine types are: Francis,\
\ Kaplan, and Pelton.\r\n"
attributes:
gateRateLimit:
slot_uri: cim:HydroTurbine.gateRateLimit
range: float
required: false
multivalued: false
description: "Gate rate limit.\r\n"
gateUpperLimit:
slot_uri: cim:HydroTurbine.gateUpperLimit
range: PU
required: false
multivalued: false
description: "Gate upper limit.\r\n"
maxHeadMaxP:
slot_uri: cim:HydroTurbine.maxHeadMaxP
range: ActivePower
required: false
multivalued: false
description: "Maximum efficiency active power at maximum head conditions.\r\
\n"
minHeadMaxP:
slot_uri: cim:HydroTurbine.minHeadMaxP
range: ActivePower
required: false
multivalued: false
description: "Maximum efficiency active power at minimum head conditions.\r\
\n"
speedRating:
slot_uri: cim:HydroTurbine.speedRating
range: RotationSpeed
required: false
multivalued: false
description: Rated speed in number of revolutions. The attribute shall be
a positive value.
speedRegulation:
slot_uri: cim:HydroTurbine.speedRegulation
range: PU
required: false
multivalued: false
description: "Speed regulation.\r\n"
transientDroopTime:
slot_uri: cim:HydroTurbine.transientDroopTime
range: Seconds
required: false
multivalued: false
description: "Transient droop time constant.\r\n"
transientRegulation:
slot_uri: cim:HydroTurbine.transientRegulation
range: PU
required: false
multivalued: false
description: "Transient regulation.\r\n"
turbineRating:
slot_uri: cim:HydroTurbine.turbineRating
range: ActivePower
required: false
multivalued: false
description: "Rated turbine active power. The attribute shall be a positive\
\ value.\r\n"
turbineType:
slot_uri: cim:HydroTurbine.turbineType
range: HydroTurbineKind
required: false
multivalued: false
description: Type of turbine.
waterStartingTime:
slot_uri: cim:HydroTurbine.waterStartingTime
range: Seconds
required: false
multivalued: false
description: "Water starting time.\r\n"
NuclearGeneratingUnit:
class_uri: cim:NuclearGeneratingUnit
is_a: GeneratingUnit
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.Production
description: A nuclear generating unit.
WindGeneratingUnit:
class_uri: cim:WindGeneratingUnit
is_a: GeneratingUnit
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.Production
description: '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. '
attributes:
windGenUnitType:
slot_uri: cim:WindGeneratingUnit.windGenUnitType
range: WindGenUnitKind
required: false
multivalued: false
description: The kind of wind generating unit.
SolarGeneratingUnit:
class_uri: cim:SolarGeneratingUnit
is_a: GeneratingUnit
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.Production
description: A solar thermal generating unit, connected to the grid by means of
a rotating machine. This class does not represent photovoltaic (PV) generation.
BatteryUnit:
class_uri: cim:BatteryUnit
is_a: PowerElectronicsUnit
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.Production
description: An electrochemical energy storage device.
attributes:
batteryState:
slot_uri: cim:BatteryUnit.batteryState
range: BatteryStateKind
required: false
multivalued: false
description: The current state of the battery (charging, full, etc.).
ratedE:
slot_uri: cim:BatteryUnit.ratedE
range: RealEnergy
required: false
multivalued: false
description: Full energy storage capacity of the battery. The attribute shall
be a positive value.
storedE:
slot_uri: cim:BatteryUnit.storedE
range: RealEnergy
required: false
multivalued: false
description: Amount of energy currently stored. The attribute shall be a positive
value or zero and lower than BatteryUnit.ratedE.
PhotoVoltaicUnit:
class_uri: cim:PhotoVoltaicUnit
is_a: PowerElectronicsUnit
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.Production
description: A photovoltaic device or an aggregation of such devices.
PowerElectronicsWindUnit:
class_uri: cim:PowerElectronicsWindUnit
is_a: PowerElectronicsUnit
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.Production
description: A wind generating unit that connects to the AC network with power
electronics rather than rotating machines or an aggregation of such units.
ConformLoadSchedule:
class_uri: cim:ConformLoadSchedule
is_a: SeasonDayTypeSchedule
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.LoadModel
description: A curve of load versus time (X-axis) showing the active power values
(Y1-axis) and reactive power (Y2-axis) for each unit of the period covered.
This curve represents a typical pattern of load over the time period for a given
day type and season.
attributes:
ConformLoadGroup:
slot_uri: cim:ConformLoadSchedule.ConformLoadGroup
range: ConformLoadGroup
required: true
multivalued: false
description: The ConformLoadGroup where the ConformLoadSchedule belongs.
ConformLoadGroup:
class_uri: cim:ConformLoadGroup
is_a: LoadGroup
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.LoadModel
description: 'A group of loads conforming to an allocation pattern. '
attributes:
EnergyConsumers:
slot_uri: cim:ConformLoadGroup.EnergyConsumers
range: ConformLoad
required: false
multivalued: true
description: Conform loads assigned to this ConformLoadGroup.
ConformLoadSchedules:
slot_uri: cim:ConformLoadGroup.ConformLoadSchedules
range: ConformLoadSchedule
required: false
multivalued: true
description: The ConformLoadSchedules in the ConformLoadGroup.
LoadGroup:
class_uri: cim:LoadGroup
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.LoadModel
description: The class is the third level in a hierarchical structure for grouping
of loads for the purpose of load flow load scaling.
attributes:
SubLoadArea:
slot_uri: cim:LoadGroup.SubLoadArea
range: SubLoadArea
required: true
multivalued: false
description: The SubLoadArea where the Loadgroup belongs.
SubLoadArea:
class_uri: cim:SubLoadArea
is_a: EnergyArea
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.LoadModel
description: The class is the second level in a hierarchical structure for grouping
of loads for the purpose of load flow load scaling.
attributes:
LoadGroups:
slot_uri: cim:SubLoadArea.LoadGroups
range: LoadGroup
required: true
multivalued: true
description: The Loadgroups in the SubLoadArea.
LoadArea:
slot_uri: cim:SubLoadArea.LoadArea
range: LoadArea
required: true
multivalued: false
description: The LoadArea where the SubLoadArea belongs.
LoadArea:
class_uri: cim:LoadArea
is_a: EnergyArea
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.LoadModel
description: The class is the root or first level in a hierarchical structure
for grouping of loads for the purpose of load flow load scaling.
attributes:
SubLoadAreas:
slot_uri: cim:LoadArea.SubLoadAreas
range: SubLoadArea
required: true
multivalued: true
description: The SubLoadAreas in the LoadArea.
ConformLoad:
class_uri: cim:ConformLoad
is_a: EnergyConsumer
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.LoadModel
description: ConformLoad represent loads that follow a daily load change pattern
where the pattern can be used to scale the load with a system load.
attributes:
LoadGroup:
slot_uri: cim:ConformLoad.LoadGroup
range: ConformLoadGroup
required: false
multivalued: false
description: Group of this ConformLoad.
NonConformLoadSchedule:
class_uri: cim:NonConformLoadSchedule
is_a: SeasonDayTypeSchedule
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.LoadModel
description: An active power (Y1-axis) and reactive power (Y2-axis) schedule (curves)
versus time (X-axis) for non-conforming loads, e.g., large industrial load or
power station service (where modelled).
attributes:
NonConformLoadGroup:
slot_uri: cim:NonConformLoadSchedule.NonConformLoadGroup
range: NonConformLoadGroup
required: true
multivalued: false
description: The NonConformLoadGroup where the NonConformLoadSchedule belongs.
NonConformLoadGroup:
class_uri: cim:NonConformLoadGroup
is_a: LoadGroup
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.LoadModel
description: Loads that do not follow a daily and seasonal load variation pattern.
attributes:
EnergyConsumers:
slot_uri: cim:NonConformLoadGroup.EnergyConsumers
range: NonConformLoad
required: false
multivalued: true
description: Conform loads assigned to this ConformLoadGroup.
NonConformLoadSchedules:
slot_uri: cim:NonConformLoadGroup.NonConformLoadSchedules
range: NonConformLoadSchedule
required: false
multivalued: true
description: The NonConformLoadSchedules in the NonConformLoadGroup.
NonConformLoad:
class_uri: cim:NonConformLoad
is_a: EnergyConsumer
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.LoadModel
description: NonConformLoad represents loads that do not follow a daily load change
pattern and whose changes are not correlated with the daily load change pattern.
attributes:
LoadGroup:
slot_uri: cim:NonConformLoad.LoadGroup
range: NonConformLoadGroup
required: false
multivalued: false
description: Group of this ConformLoad.
StationSupply:
class_uri: cim:StationSupply
is_a: EnergyConsumer
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.LoadModel
description: Station supply with load derived from the station output.
Sensor:
class_uri: cim:Sensor
is_a: AuxiliaryEquipment
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.AuxiliaryEquipment
description: "This class describe devices that transform a measured quantity into\
\ signals that can be presented at displays, used in control or be recorded.\r\
\n"
CurrentTransformer:
class_uri: cim:CurrentTransformer
is_a: Sensor
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.AuxiliaryEquipment
description: Instrument transformer used to measure electrical qualities of the
circuit that is being protected and/or monitored. Typically used as current
transducer for the purpose of metering or protection. A typical secondary current
rating would be 5A.
attributes:
accuracyClass:
slot_uri: cim:CurrentTransformer.accuracyClass
range: string
required: false
multivalued: false
description: CT accuracy classification.
accuracyLimit:
slot_uri: cim:CurrentTransformer.accuracyLimit
range: PerCent
required: false
multivalued: false
description: "Percent of rated current for which the CT remains accurate within\
\ specified limits.\r\n"
coreBurden:
slot_uri: cim:CurrentTransformer.coreBurden
range: ActivePower
required: false
multivalued: false
description: "Power burden of the CT core.\r\n"
ctClass:
slot_uri: cim:CurrentTransformer.ctClass
range: string
required: false
multivalued: false
description: CT classification; i.e. class 10P.
usage:
slot_uri: cim:CurrentTransformer.usage
range: string
required: false
multivalued: false
description: Intended usage of the CT; i.e. metering, protection.
WaveTrap:
class_uri: cim:WaveTrap
is_a: AuxiliaryEquipment
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.AuxiliaryEquipment
description: Line traps are devices that impede high frequency power line carrier
signals yet present a negligible impedance at the main power frequency.
SurgeArrester:
class_uri: cim:SurgeArrester
is_a: AuxiliaryEquipment
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.AuxiliaryEquipment
description: Shunt device, installed on the network, usually in the proximity
of electrical equipment in order to protect the said equipment against transient
voltage transients caused by lightning or switching activity.
PostLineSensor:
class_uri: cim:PostLineSensor
is_a: Sensor
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.AuxiliaryEquipment
description: " A sensor used mainly in overhead distribution networks as the source\
\ of both current and voltage measurements.\r\n"
PotentialTransformer:
class_uri: cim:PotentialTransformer
is_a: Sensor
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.AuxiliaryEquipment
description: Instrument transformer (also known as Voltage Transformer) used to
measure electrical qualities of the circuit that is being protected and/or monitored.
Typically used as voltage transducer for the purpose of metering, protection,
or sometimes auxiliary substation supply. A typical secondary voltage rating
would be 120V.
attributes:
accuracyClass:
slot_uri: cim:PotentialTransformer.accuracyClass
range: string
required: false
multivalued: false
description: PT accuracy classification.
nominalRatio:
slot_uri: cim:PotentialTransformer.nominalRatio
range: float
required: false
multivalued: false
description: Nominal ratio between the primary and secondary voltage.
ptClass:
slot_uri: cim:PotentialTransformer.ptClass
range: string
required: false
multivalued: false
description: Potential transformer (PT) classification covering burden.
type:
slot_uri: cim:PotentialTransformer.type
range: PotentialTransformerKind
required: false
multivalued: false
description: Potential transformer construction type.
FaultIndicator:
class_uri: cim:FaultIndicator
is_a: AuxiliaryEquipment
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.AuxiliaryEquipment
description: A FaultIndicator is typically only an indicator (which may or may
not be remotely monitored), and not a piece of equipment that actually initiates
a protection event. It is used for FLISR (Fault Location, Isolation and Restoration)
purposes, assisting with the dispatch of crews to "most likely" part of the
network (i.e. assists with determining circuit section where the fault most
likely happened).
CurrentRelay:
class_uri: cim:CurrentRelay
is_a: ProtectionEquipment
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Protection
description: A device that checks current flow values in any direction or designated
direction.
attributes:
currentLimit1:
slot_uri: cim:CurrentRelay.currentLimit1
range: CurrentFlow
required: false
multivalued: false
description: "Current limit number one 1 for inverse time pickup.\r\n"
currentLimit2:
slot_uri: cim:CurrentRelay.currentLimit2
range: CurrentFlow
required: false
multivalued: false
description: "Current limit number 2 for inverse time pickup.\r\n"
currentLimit3:
slot_uri: cim:CurrentRelay.currentLimit3
range: CurrentFlow
required: false
multivalued: false
description: "Current limit number 3 for inverse time pickup.\r\n"
inverseTimeFlag:
slot_uri: cim:CurrentRelay.inverseTimeFlag
range: boolean
required: false
multivalued: false
description: Set true if the current relay has inverse time characteristic.
timeDelay1:
slot_uri: cim:CurrentRelay.timeDelay1
range: Seconds
required: false
multivalued: false
description: "Inverse time delay number 1 for current limit number 1.\r\n"
timeDelay2:
slot_uri: cim:CurrentRelay.timeDelay2
range: Seconds
required: false
multivalued: false
description: "Inverse time delay number 2 for current limit number 2.\r\n"
timeDelay3:
slot_uri: cim:CurrentRelay.timeDelay3
range: Seconds
required: false
multivalued: false
description: "Inverse time delay number 3 for current limit number 3.\r\n"
SynchrocheckRelay:
class_uri: cim:SynchrocheckRelay
is_a: ProtectionEquipment
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Protection
description: A device that operates when two AC circuits are within the desired
limits of frequency, phase angle, and voltage, to permit or to cause the paralleling
of these two circuits. Used to prevent the paralleling of non-synchronous topological
islands.
attributes:
maxAngleDiff:
slot_uri: cim:SynchrocheckRelay.maxAngleDiff
range: AngleRadians
required: false
multivalued: false
description: "The maximum allowable voltage vector phase angle difference\
\ across the open device.\r\n"
maxFreqDiff:
slot_uri: cim:SynchrocheckRelay.maxFreqDiff
range: Frequency
required: false
multivalued: false
description: "The maximum allowable frequency difference across the open device.\r\
\n"
maxVoltDiff:
slot_uri: cim:SynchrocheckRelay.maxVoltDiff
range: Voltage
required: false
multivalued: false
description: "The maximum allowable difference voltage across the open device.\r\
\n"
EquivalentShunt:
class_uri: cim:EquivalentShunt
is_a: EquivalentEquipment
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Equivalents
description: The class represents equivalent shunts.
attributes:
b:
slot_uri: cim:EquivalentShunt.b
range: Susceptance
required: false
multivalued: false
description: Positive sequence shunt susceptance.
g:
slot_uri: cim:EquivalentShunt.g
range: Conductance
required: false
multivalued: false
description: Positive sequence shunt conductance.
EquivalentBranch:
class_uri: cim:EquivalentBranch
is_a: EquivalentEquipment
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Equivalents
description: 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.
attributes:
negativeR12:
slot_uri: cim:EquivalentBranch.negativeR12
range: Resistance
required: false
multivalued: false
description: "Negative sequence series resistance from terminal sequence \
\ 1 to terminal sequence 2. Used for short circuit data exchange according\
\ to IEC 60909.\r\nEquivalentBranch is a result of network reduction prior\
\ to the data exchange."
negativeR21:
slot_uri: cim:EquivalentBranch.negativeR21
range: Resistance
required: false
multivalued: false
description: "Negative sequence series resistance from terminal sequence 2\
\ to terminal sequence 1. Used for short circuit data exchange according\
\ to IEC 60909.\r\nEquivalentBranch is a result of network reduction prior\
\ to the data exchange."
negativeX12:
slot_uri: cim:EquivalentBranch.negativeX12
range: Reactance
required: false
multivalued: false
description: "Negative sequence series reactance from terminal sequence 1\
\ to terminal sequence 2. Used for short circuit data exchange according\
\ to IEC 60909.\r\nUsage : EquivalentBranch is a result of network reduction\
\ prior to the data exchange."
negativeX21:
slot_uri: cim:EquivalentBranch.negativeX21
range: Reactance
required: false
multivalued: false
description: "Negative sequence series reactance from terminal sequence 2\
\ to terminal sequence 1. Used for short circuit data exchange according\
\ to IEC 60909.\r\nUsage: EquivalentBranch is a result of network reduction\
\ prior to the data exchange."
positiveR12:
slot_uri: cim:EquivalentBranch.positiveR12
range: Resistance
required: false
multivalued: false
description: "Positive sequence series resistance from terminal sequence \
\ 1 to terminal sequence 2 . Used for short circuit data exchange according\
\ to IEC 60909. \r\nEquivalentBranch is a result of network reduction prior\
\ to the data exchange. "
positiveR21:
slot_uri: cim:EquivalentBranch.positiveR21
range: Resistance
required: false
multivalued: false
description: "Positive sequence series resistance from terminal sequence 2\
\ to terminal sequence 1. Used for short circuit data exchange according\
\ to IEC 60909.\r\nEquivalentBranch is a result of network reduction prior\
\ to the data exchange."
positiveX12:
slot_uri: cim:EquivalentBranch.positiveX12
range: Reactance
required: false
multivalued: false
description: "Positive sequence series reactance from terminal sequence 1\
\ to terminal sequence 2. Used for short circuit data exchange according\
\ to IEC 60909.\r\nUsage : EquivalentBranch is a result of network reduction\
\ prior to the data exchange."
positiveX21:
slot_uri: cim:EquivalentBranch.positiveX21
range: Reactance
required: false
multivalued: false
description: "Positive sequence series reactance from terminal sequence 2\
\ to terminal sequence 1. Used for short circuit data exchange according\
\ to IEC 60909.\r\nUsage : EquivalentBranch is a result of network reduction\
\ prior to the data exchange."
r:
slot_uri: cim:EquivalentBranch.r
range: Resistance
required: false
multivalued: false
description: Positive sequence series resistance of the reduced branch.
r21:
slot_uri: cim:EquivalentBranch.r21
range: Resistance
required: false
multivalued: false
description: "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.\r\
\nUsage rule : EquivalentBranch is a result of network reduction prior to\
\ the data exchange."
x:
slot_uri: cim:EquivalentBranch.x
range: Reactance
required: false
multivalued: false
description: Positive sequence series reactance of the reduced branch.
x21:
slot_uri: cim:EquivalentBranch.x21
range: Reactance
required: false
multivalued: false
description: "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.\r\
\nUsage rule: EquivalentBranch is a result of network reduction prior to\
\ the data exchange."
zeroR12:
slot_uri: cim:EquivalentBranch.zeroR12
range: Resistance
required: false
multivalued: false
description: "Zero sequence series resistance from terminal sequence 1 to\
\ terminal sequence 2. Used for short circuit data exchange according to\
\ IEC 60909.\r\nEquivalentBranch is a result of network reduction prior\
\ to the data exchange."
zeroR21:
slot_uri: cim:EquivalentBranch.zeroR21
range: Resistance
required: false
multivalued: false
description: "Zero sequence series resistance from terminal sequence 2 to\
\ terminal sequence 1. Used for short circuit data exchange according to\
\ IEC 60909.\r\nUsage : EquivalentBranch is a result of network reduction\
\ prior to the data exchange."
zeroX12:
slot_uri: cim:EquivalentBranch.zeroX12
range: Reactance
required: false
multivalued: false
description: "Zero sequence series reactance from terminal sequence 1 to\
\ terminal sequence 2. Used for short circuit data exchange according to\
\ IEC 60909.\r\nUsage : EquivalentBranch is a result of network reduction\
\ prior to the data exchange."
zeroX21:
slot_uri: cim:EquivalentBranch.zeroX21
range: Reactance
required: false
multivalued: false
description: "Zero sequence series reactance from terminal sequence 2 to terminal\
\ sequence 1. Used for short circuit data exchange according to IEC 60909.\r\
\nUsage : EquivalentBranch is a result of network reduction prior to the\
\ data exchange."
AccumulatorLimitSet:
class_uri: cim:AccumulatorLimitSet
is_a: LimitSet
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Meas
description: "An AccumulatorLimitSet specifies a set of Limits that are associated\
\ with an Accumulator measurement.\r\n"
attributes:
Limits:
slot_uri: cim:AccumulatorLimitSet.Limits
range: AccumulatorLimit
required: true
multivalued: true
description: The limit values used for supervision of Measurements.
Measurements:
slot_uri: cim:AccumulatorLimitSet.Measurements
range: Accumulator
required: false
multivalued: true
description: The Measurements using the LimitSet.
Accumulator:
class_uri: cim:Accumulator
is_a: Measurement
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Meas
description: Accumulator represents an accumulated (counted) Measurement, e.g.
an energy value.
attributes:
maxValue:
slot_uri: cim:Accumulator.maxValue
range: integer
required: false
multivalued: false
description: Normal value range maximum for any of the MeasurementValue.values.
Used for scaling, e.g. in bar graphs or of telemetered raw values.
AccumulatorValues:
slot_uri: cim:Accumulator.AccumulatorValues
range: AccumulatorValue
required: false
multivalued: true
description: The values connected to this measurement.
LimitSets:
slot_uri: cim:Accumulator.LimitSets
range: AccumulatorLimitSet
required: false
multivalued: true
description: A measurement may have zero or more limit ranges defined for
it.
AccumulatorValue:
class_uri: cim:AccumulatorValue
is_a: MeasurementValue
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Meas
description: "AccumulatorValue represents an accumulated (counted) MeasurementValue.\r\
\n"
attributes:
value:
slot_uri: cim:AccumulatorValue.value
range: integer
required: false
multivalued: false
description: The value to supervise. The value is positive.
Accumulator:
slot_uri: cim:AccumulatorValue.Accumulator
range: Accumulator
required: true
multivalued: false
description: Measurement to which this value is connected.
AccumulatorReset:
slot_uri: cim:AccumulatorValue.AccumulatorReset
range: AccumulatorReset
required: false
multivalued: false
description: The command that resets the accumulator value.
AccumulatorReset:
class_uri: cim:AccumulatorReset
is_a: Control
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Meas
description: This command resets the counter value to zero.
attributes:
AccumulatorValue:
slot_uri: cim:AccumulatorReset.AccumulatorValue
range: AccumulatorValue
required: true
multivalued: false
description: The accumulator value that is reset by the command.
AccumulatorLimit:
class_uri: cim:AccumulatorLimit
is_a: Limit
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Meas
description: "Limit values for Accumulator measurements.\r\n"
attributes:
value:
slot_uri: cim:AccumulatorLimit.value
range: integer
required: false
multivalued: false
description: The value to supervise against. The value is positive.
LimitSet:
slot_uri: cim:AccumulatorLimit.LimitSet
range: AccumulatorLimitSet
required: true
multivalued: false
description: The set of limits.
SetPoint:
class_uri: cim:SetPoint
is_a: AnalogControl
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Meas
description: An analog control that issues a set point value.
attributes:
normalValue:
slot_uri: cim:SetPoint.normalValue
range: float
required: false
multivalued: false
description: "Normal value for Control.value e.g. used for percentage scaling.\r\
\n"
value:
slot_uri: cim:SetPoint.value
range: float
required: false
multivalued: false
description: "The value representing the actuator output.\r\n"
DCLineSegment:
class_uri: cim:DCLineSegment
is_a: DCConductingEquipment
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.DC
description: A wire or combination of wires not insulated from one another, with
consistent electrical characteristics, used to carry direct current between
points in the DC region of the power system.
attributes:
capacitance:
slot_uri: cim:DCLineSegment.capacitance
range: Capacitance
required: false
multivalued: false
description: Capacitance of the DC line segment. Significant for cables only.
inductance:
slot_uri: cim:DCLineSegment.inductance
range: Inductance
required: false
multivalued: false
description: Inductance of the DC line segment. Negligible compared with DCSeriesDevice
used for smoothing.
length:
slot_uri: cim:DCLineSegment.length
range: Length
required: false
multivalued: false
description: Segment length for calculating line section capabilities.
resistance:
slot_uri: cim:DCLineSegment.resistance
range: Resistance
required: false
multivalued: false
description: Resistance of the DC line segment.
PerLengthParameter:
slot_uri: cim:DCLineSegment.PerLengthParameter
range: PerLengthDCLineParameter
required: false
multivalued: false
description: Set of per-length parameters for this line segment.
PerLengthDCLineParameter:
class_uri: cim:PerLengthDCLineParameter
is_a: PerLengthLineParameter
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.DC
description: Common type for per-length electrical catalogues describing DC line
parameters.
attributes:
capacitance:
slot_uri: cim:PerLengthDCLineParameter.capacitance
range: CapacitancePerLength
required: false
multivalued: false
description: Capacitance per unit of length of the DC line segment; significant
for cables only.
inductance:
slot_uri: cim:PerLengthDCLineParameter.inductance
range: InductancePerLength
required: false
multivalued: false
description: Inductance per unit of length of the DC line segment.
resistance:
slot_uri: cim:PerLengthDCLineParameter.resistance
range: ResistancePerLength
required: false
multivalued: false
description: Resistance per length of the DC line segment.
DCLineSegments:
slot_uri: cim:PerLengthDCLineParameter.DCLineSegments
range: DCLineSegment
required: false
multivalued: true
description: All line segments described by this set of per-length parameters.
DCBreaker:
class_uri: cim:DCBreaker
is_a: DCSwitch
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.DC
description: 'A breaker within a DC system. '
DCSwitch:
class_uri: cim:DCSwitch
is_a: DCConductingEquipment
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.DC
description: A switch within the DC system.
DCBusbar:
class_uri: cim:DCBusbar
is_a: DCConductingEquipment
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.DC
description: A busbar within a DC system.
DCDisconnector:
class_uri: cim:DCDisconnector
is_a: DCSwitch
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.DC
description: A disconnector within a DC system.
DCGround:
class_uri: cim:DCGround
is_a: DCConductingEquipment
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.DC
description: A ground within a DC system.
attributes:
inductance:
slot_uri: cim:DCGround.inductance
range: Inductance
required: false
multivalued: false
description: Inductance to ground.
r:
slot_uri: cim:DCGround.r
range: Resistance
required: false
multivalued: false
description: Resistance to ground.
DCShunt:
class_uri: cim:DCShunt
is_a: DCConductingEquipment
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.DC
description: A shunt device within the DC system, typically used for filtering. Needed
for transient and short circuit studies.
attributes:
capacitance:
slot_uri: cim:DCShunt.capacitance
range: Capacitance
required: false
multivalued: false
description: Capacitance of the DC shunt.
resistance:
slot_uri: cim:DCShunt.resistance
range: Resistance
required: false
multivalued: false
description: Resistance of the DC device.
VsCapabilityCurve:
class_uri: cim:VsCapabilityCurve
is_a: Curve
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.DC
description: The P-Q capability curve for a voltage source converter, with P on
X-axis and Qmin and Qmax on Y1-axis and Y2-axis.
attributes:
VsConverterDCSides:
slot_uri: cim:VsCapabilityCurve.VsConverterDCSides
range: VsConverter
required: false
multivalued: true
description: All converters with this capability curve.
VsConverter:
class_uri: cim:VsConverter
is_a: ACDCConverter
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.DC
description: DC side of the voltage source converter (VSC).
attributes:
delta:
slot_uri: cim:VsConverter.delta
range: AngleDegrees
required: false
multivalued: false
description: "Angle between VsConverter.uv and ACDCConverter.uc. It is converter\u2019\
s state variable used in power flow. The attribute shall be a positive value\
\ or zero."
droop:
slot_uri: cim:VsConverter.droop
range: PU
required: false
multivalued: false
description: Droop constant. The pu value is obtained as D [kV/MW] x Sb /
Ubdc. The attribute shall be a positive value.
droopCompensation:
slot_uri: cim:VsConverter.droopCompensation
range: Resistance
required: false
multivalued: false
description: Compensation constant. Used to compensate for voltage drop when
controlling voltage at a distant bus. The attribute shall be a positive
value.
maxModulationIndex:
slot_uri: cim:VsConverter.maxModulationIndex
range: float
required: false
multivalued: false
description: "The maximum quotient between the AC converter voltage (Uc) and\
\ DC voltage (Ud). A factor typically less than 1. It is converter\u2019\
s configuration data used in power flow."
maxValveCurrent:
slot_uri: cim:VsConverter.maxValveCurrent
range: CurrentFlow
required: false
multivalued: false
description: "The maximum current through a valve. It is converter\u2019s\
\ configuration data."
pPccControl:
slot_uri: cim:VsConverter.pPccControl
range: VsPpccControlKind
required: false
multivalued: false
description: Kind of control of real power and/or DC voltage.
qPccControl:
slot_uri: cim:VsConverter.qPccControl
range: VsQpccControlKind
required: false
multivalued: false
description: Kind of reactive power control.
qShare:
slot_uri: cim:VsConverter.qShare
range: PerCent
required: false
multivalued: false
description: Reactive power sharing factor among parallel converters on Uac
control. The attribute shall be a positive value or zero.
targetPhasePcc:
slot_uri: cim:VsConverter.targetPhasePcc
range: AngleDegrees
required: false
multivalued: false
description: Phase target at AC side, at point of common coupling. The attribute
shall be a positive value.
targetPowerFactorPcc:
slot_uri: cim:VsConverter.targetPowerFactorPcc
range: float
required: false
multivalued: false
description: Power factor target at the AC side, at point of common coupling.
The attribute shall be a positive value.
targetPWMfactor:
slot_uri: cim:VsConverter.targetPWMfactor
range: float
required: false
multivalued: false
description: Magnitude of pulse-modulation factor. The attribute shall be
a positive value.
targetQpcc:
slot_uri: cim:VsConverter.targetQpcc
range: ReactivePower
required: false
multivalued: false
description: Reactive power injection target in AC grid, at point of common
coupling. Load sign convention is used, i.e. positive sign means flow out
from a node.
targetUpcc:
slot_uri: cim:VsConverter.targetUpcc
range: Voltage
required: false
multivalued: false
description: Voltage target in AC grid, at point of common coupling. The attribute
shall be a positive value.
uv:
slot_uri: cim:VsConverter.uv
range: Voltage
required: false
multivalued: false
description: "Line-to-line voltage on the valve side of the converter transformer.\
\ It is converter\u2019s state variable, result from power flow. The attribute\
\ shall be a positive value."
CapabilityCurve:
slot_uri: cim:VsConverter.CapabilityCurve
range: VsCapabilityCurve
required: false
multivalued: false
description: Capability curve of this converter.
VSCDynamics:
slot_uri: cim:VsConverter.VSCDynamics
range: VSCDynamics
required: false
multivalued: false
description: Voltage source converter dynamics model used to describe dynamic
behaviour of this converter.
VSCDynamics:
class_uri: cim:VSCDynamics
is_a: HVDCDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.HVDCDynamics
description: VSC function block whose behaviour is described by reference to a
standard model or by definition of a user-defined model.
attributes:
VsConverter:
slot_uri: cim:VSCDynamics.VsConverter
range: VsConverter
required: true
multivalued: false
description: Voltage source converter to which voltage source converter dynamics
model applies.
HVDCDynamics:
class_uri: cim:HVDCDynamics
is_a: DynamicsFunctionBlock
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.HVDCDynamics
description: HVDC whose behaviour is described by reference to a standard model
or by definition of a user-defined model.
CsConverter:
class_uri: cim:CsConverter
is_a: ACDCConverter
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.DC
description: "DC side of the current source converter (CSC).\r\nThe firing angle\
\ controls the dc voltage at the converter, both for rectifier and inverter.\
\ The difference between the dc voltages of the rectifier and inverter determines\
\ the dc current. The extinction angle is used to limit the dc voltage at the\
\ inverter, if needed, and is not used in active power control. The firing angle,\
\ transformer tap position and number of connected filters are the primary means\
\ to control a current source dc line. Higher level controls are built on top,\
\ e.g. dc voltage, dc current and active power. From a steady state perspective\
\ it is sufficient to specify the wanted active power transfer (ACDCConverter.targetPpcc)\
\ and the control functions will set the dc voltage, dc current, firing angle,\
\ transformer tap position and number of connected filters to meet this. Therefore\
\ attributes targetAlpha and targetGamma are not applicable in this case.\r\n\
The reactive power consumed by the converter is a function of the firing angle,\
\ transformer tap position and number of connected filter, which can be approximated\
\ with half of the active power. The losses is a function of the dc voltage\
\ and dc current.\r\nThe attributes minAlpha and maxAlpha define the range of\
\ firing angles for rectifier operation between which no discrete tap changer\
\ action takes place. The range is typically 10-18 degrees.\r\nThe attributes\
\ minGamma and maxGamma define the range of extinction angles for inverter operation\
\ between which no discrete tap changer action takes place. The range is typically\
\ 17-20 degrees."
attributes:
alpha:
slot_uri: cim:CsConverter.alpha
range: AngleDegrees
required: false
multivalued: false
description: "Firing angle that determines the dc voltage at the converter\
\ dc terminal. Typical value between 10 degrees and 18 degrees for a rectifier.\
\ It is converter\u2019s state variable, result from power flow. The attribute\
\ shall be a positive value."
gamma:
slot_uri: cim:CsConverter.gamma
range: AngleDegrees
required: false
multivalued: false
description: "Extinction angle. It is used to limit the dc voltage at the\
\ inverter if needed. Typical value between 17 degrees and 20 degrees for\
\ an inverter. It is converter\u2019s state variable, result from power\
\ flow. The attribute shall be a positive value."
maxAlpha:
slot_uri: cim:CsConverter.maxAlpha
range: AngleDegrees
required: false
multivalued: false
description: "Maximum firing angle. It is converter\u2019s configuration data\
\ used in power flow. The attribute shall be a positive value."
maxGamma:
slot_uri: cim:CsConverter.maxGamma
range: AngleDegrees
required: false
multivalued: false
description: "Maximum extinction angle. It is converter\u2019s configuration\
\ data used in power flow. The attribute shall be a positive value."
maxIdc:
slot_uri: cim:CsConverter.maxIdc
range: CurrentFlow
required: false
multivalued: false
description: "The maximum direct current (Id) on the DC side at which the\
\ converter should operate. It is converter\u2019s configuration data use\
\ in power flow. The attribute shall be a positive value."
minAlpha:
slot_uri: cim:CsConverter.minAlpha
range: AngleDegrees
required: false
multivalued: false
description: "Minimum firing angle. It is converter\u2019s configuration data\
\ used in power flow. The attribute shall be a positive value."
minGamma:
slot_uri: cim:CsConverter.minGamma
range: AngleDegrees
required: false
multivalued: false
description: "Minimum extinction angle. It is converter\u2019s configuration\
\ data used in power flow. The attribute shall be a positive value."
minIdc:
slot_uri: cim:CsConverter.minIdc
range: CurrentFlow
required: false
multivalued: false
description: "The minimum direct current (Id) on the DC side at which the\
\ converter should operate. It is converter\u2019s configuration data used\
\ in power flow. The attribute shall be a positive value."
operatingMode:
slot_uri: cim:CsConverter.operatingMode
range: CsOperatingModeKind
required: false
multivalued: false
description: "Indicates whether the DC pole is operating as an inverter or\
\ as a rectifier. It is converter\u2019s control variable used in power\
\ flow."
pPccControl:
slot_uri: cim:CsConverter.pPccControl
range: CsPpccControlKind
required: false
multivalued: false
description: Kind of active power control.
ratedIdc:
slot_uri: cim:CsConverter.ratedIdc
range: CurrentFlow
required: false
multivalued: false
description: "Rated converter DC current, also called IdN. The attribute shall\
\ be a positive value. It is converter\u2019s configuration data used in\
\ power flow."
targetAlpha:
slot_uri: cim:CsConverter.targetAlpha
range: AngleDegrees
required: false
multivalued: false
description: "Target firing angle. It is converter\u2019s control variable\
\ used in power flow. It is only applicable for rectifier if continuous\
\ tap changer control is used. Allowed values are within the range minAlpha<=targetAlpha<=maxAlpha.\
\ The attribute shall be a positive value."
targetGamma:
slot_uri: cim:CsConverter.targetGamma
range: AngleDegrees
required: false
multivalued: false
description: "Target extinction angle. It is converter\u2019s control variable\
\ used in power flow. It is only applicable for inverter if continuous tap\
\ changer control is used. Allowed values are within the range minGamma<=targetGamma<=maxGamma.\
\ The attribute shall be a positive value."
targetIdc:
slot_uri: cim:CsConverter.targetIdc
range: CurrentFlow
required: false
multivalued: false
description: "DC current target value. It is converter\u2019s control variable\
\ used in power flow. The attribute shall be a positive value."
CSCDynamics:
slot_uri: cim:CsConverter.CSCDynamics
range: CSCDynamics
required: false
multivalued: false
description: Current source converter dynamics model used to describe dynamic
behaviour of this converter.
CSCDynamics:
class_uri: cim:CSCDynamics
is_a: HVDCDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.HVDCDynamics
description: CSC function block whose behaviour is described by reference to a
standard model or by definition of a user-defined model.
attributes:
CSConverter:
slot_uri: cim:CSCDynamics.CSConverter
range: CsConverter
required: true
multivalued: false
description: Current source converter to which current source converter dynamics
model applies.
DCChopper:
class_uri: cim:DCChopper
is_a: DCConductingEquipment
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.DC
description: Low resistance equipment used in the internal DC circuit to balance
voltages. It has typically positive and negative pole terminals and a ground.
DCSeriesDevice:
class_uri: cim:DCSeriesDevice
is_a: DCConductingEquipment
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.DC
description: A series device within the DC system, typically a reactor used for
filtering or smoothing. Needed for transient and short circuit studies.
attributes:
inductance:
slot_uri: cim:DCSeriesDevice.inductance
range: Inductance
required: false
multivalued: false
description: Inductance of the device.
resistance:
slot_uri: cim:DCSeriesDevice.resistance
range: Resistance
required: false
multivalued: false
description: Resistance of the DC device.
EnvironmentalDependentLimit:
class_uri: cim:EnvironmentalDependentLimit
is_a: LimitDependency
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfOperationalLimits
description: This is a environmental based limit dependency model for calculating
operational limits.
ScheduledActivePowerLimitValue:
class_uri: cim:ScheduledActivePowerLimitValue
is_a: ScheduledLimitValue
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfOperationalLimits
attributes:
value:
slot_uri: cim:ScheduledActivePowerLimitValue.value
range: ActivePower
required: false
multivalued: false
ScheduledApparentPowerLimitValue:
class_uri: cim:ScheduledApparentPowerLimitValue
is_a: ScheduledLimitValue
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfOperationalLimits
description: A time scheduled value for apparent power limit.
attributes:
value:
slot_uri: cim:ScheduledApparentPowerLimitValue.value
range: ApparentPower
required: false
multivalued: false
description: The apparent power limit value for the scheduled time.
ScheduledCurrentLimitValue:
class_uri: cim:ScheduledCurrentLimitValue
is_a: ScheduledLimitValue
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfOperationalLimits
description: A current limit that is scheduled.
attributes:
value:
slot_uri: cim:ScheduledCurrentLimitValue.value
range: CurrentFlow
required: false
multivalued: false
description: The current flow limit value applicable at the scheduled time.
ScheduledVoltageLimitValue:
class_uri: cim:ScheduledVoltageLimitValue
is_a: ScheduledLimitValue
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfOperationalLimits
description: A voltage limit value for a scheduled time.
attributes:
value:
slot_uri: cim:ScheduledVoltageLimitValue.value
range: Voltage
required: false
multivalued: false
description: The voltage limit value for the scheduled time.
TemperatureDependentLimitPoint:
class_uri: cim:TemperatureDependentLimitPoint
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfOperationalLimits
description: A point on a table of limit verses temperature.
attributes:
limitPercent:
slot_uri: cim:TemperatureDependentLimitPoint.limitPercent
range: PerCent
required: false
multivalued: false
description: "The scaling of the operational limit in percent.\r\n"
temperature:
slot_uri: cim:TemperatureDependentLimitPoint.temperature
range: Temperature
required: false
multivalued: false
description: "The temperature of the table point.\r\n"
TemperatureDependentLimitTable:
slot_uri: cim:TemperatureDependentLimitPoint.TemperatureDependentLimitTable
range: TemperatureDependentLimitTable
required: true
multivalued: false
TemperatureDependentLimitTable:
class_uri: cim:TemperatureDependentLimitTable
is_a: EnvironmentalDependentLimit
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfOperationalLimits
description: This is a table lookup that provides limit values corresponding to
a temperature input.
attributes:
TemperatureLimitTablePoint:
slot_uri: cim:TemperatureDependentLimitTable.TemperatureLimitTablePoint
range: TemperatureDependentLimitPoint
required: false
multivalued: true
TemperaturePolynomialLimit:
class_uri: cim:TemperaturePolynomialLimit
is_a: EnvironmentalDependentLimit
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfOperationalLimits
description: This describes the coefficients of a polynomial function that has
temperature as input and calculates limit values as output.
attributes:
coefficient0:
slot_uri: cim:TemperaturePolynomialLimit.coefficient0
range: float
required: false
multivalued: false
description: "The polinomial coefficent of power 0.\r\n"
coefficient1:
slot_uri: cim:TemperaturePolynomialLimit.coefficient1
range: float
required: false
multivalued: false
description: "The polinomial coefficent of power 1.\r\n"
coefficient2:
slot_uri: cim:TemperaturePolynomialLimit.coefficient2
range: float
required: false
multivalued: false
description: "The polinomial coefficent of power 2.\r\n"
coefficient3:
slot_uri: cim:TemperaturePolynomialLimit.coefficient3
range: float
required: false
multivalued: false
description: "The polinomial coefficent of power 3.\r\n"
coefficient4:
slot_uri: cim:TemperaturePolynomialLimit.coefficient4
range: float
required: false
multivalued: false
description: "The polinomial coefficent of power 4.\r\n"
NetworkBoundary:
class_uri: cim:NetworkBoundary
is_a: FrameworkPart
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfPart303.NetworkModelFrames
description: A framework part that is a boundary between 2 frames.
attributes:
NetworkFrame:
slot_uri: cim:NetworkBoundary.NetworkFrame
range: NetworkFrame
required: false
multivalued: false
FrameworkPart:
class_uri: cim:FrameworkPart
is_a: ModelAuthoritySet
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfPart303.NetworkModelFrames
description: The type of alternate model frame. For example, it could be generator
group used to represent generators in state estimator, planning, planning dynamics,
short circuit, or real-time dynamics etc., but does not specifically represent
any one alternative model. This need to know what objects to be removed in the
realization of any one alternate model.
attributes:
ModelFrameType:
slot_uri: cim:FrameworkPart.ModelFrameType
range: ModelFrameType
required: true
multivalued: false
description: Model frame type of the model frame.
Frame:
slot_uri: cim:FrameworkPart.Frame
range: NetworkFrame
required: false
multivalued: false
NetworkFrame:
class_uri: cim:NetworkFrame
is_a: FrameworkPart
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfPart303.NetworkModelFrames
description: A region isolated by boundaries.
attributes:
FrameworkPart:
slot_uri: cim:NetworkFrame.FrameworkPart
range: FrameworkPart
required: false
multivalued: true
NetworkBoundary:
slot_uri: cim:NetworkFrame.NetworkBoundary
range: NetworkBoundary
required: false
multivalued: true
ModelFrameType:
class_uri: cim:ModelFrameType
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfPart303.NetworkModelFrames.unused
description: Examples would be "Boundary" or "Region" type of frame.
attributes:
ModelFrame:
slot_uri: cim:ModelFrameType.ModelFrame
range: FrameworkPart
required: false
multivalued: true
description: Model frames of the model frame type.
NetworkModelCaseDefinition:
class_uri: cim:NetworkModelCaseDefinition
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfPart303.NetworkModelFrames
description: 'Instructions to build a network model case, including when appropriate
the results. '
attributes:
Operation:
slot_uri: cim:NetworkModelCaseDefinition.Operation
range: Operation
required: false
multivalued: true
Operation:
class_uri: cim:Operation
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfPart303.NetworkModelFrames
attributes:
NetworkModelCaseDefinition:
slot_uri: cim:Operation.NetworkModelCaseDefinition
range: NetworkModelCaseDefinition
required: true
multivalued: false
LoadModelPartVersion:
class_uri: cim:LoadModelPartVersion
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfPart303.NetworkModelFrames
description: Load a model part version.
PowerSystemProjectLifecycleToBeDeleted:
class_uri: cim:PowerSystemProjectLifecycleToBeDeleted
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfPart303.NetworkModelProjects
description: Represent the base lifecycle of a functional model change that could
be a construction of new elements.
attributes:
cancelled:
slot_uri: cim:PowerSystemProjectLifecycleToBeDeleted.cancelled
range: date
required: false
multivalued: false
description: The date the Power System Project is in cancelled stage.
committed:
slot_uri: cim:PowerSystemProjectLifecycleToBeDeleted.committed
range: date
required: false
multivalued: false
description: The date Power System Project is in committed stage.
inBuild:
slot_uri: cim:PowerSystemProjectLifecycleToBeDeleted.inBuild
range: date
required: false
multivalued: false
description: The date Power System Project is in build stage.
inPlan:
slot_uri: cim:PowerSystemProjectLifecycleToBeDeleted.inPlan
range: date
required: false
multivalued: false
description: The date Power System Project is in planning stage.
NetworkModelProjectCollection:
class_uri: cim:NetworkModelProjectCollection
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfPart303.NetworkModelProjects
DifferentialModel:
class_uri: cim:DifferentialModel
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfPart303.NetworkModelProjects
description: 'A set of statements describing the changes in the network model.
The statement is defined in the incremental model. '
ProjectAlternative:
class_uri: cim:ProjectAlternative
is_a: NetworkModelProjectRelationship
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfPart303.NetworkModelProjects
description: "Project B is an alternative to project A. Project A is the primary\
\ alternative.\r\nMultiple project alternatives should not be selected into\
\ a single network study case."
ProjectDependency:
class_uri: cim:ProjectDependency
is_a: NetworkModelProjectRelationship
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfPart303.NetworkModelProjects
description: 'Project A change sets should be applied before Project B during
case creation. '
IPAccessPoint:
class_uri: cim:IPAccessPoint
is_a: CommunicationLink
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.ICCPConfiguration
description: "Internet Protocol Access Point \u2013 used to represent an addressing\
\ structure is based upon an Internet Protocol (IP) address."
attributes:
address:
slot_uri: cim:IPAccessPoint.address
range: string
required: false
multivalued: false
description: Is the dotted decimal IP Address resolve the IP address. The
format is controlled by the value of the addressType.
addressType:
slot_uri: cim:IPAccessPoint.addressType
range: IPAddressKind
required: false
multivalued: false
description: IP address type.
gateway:
slot_uri: cim:IPAccessPoint.gateway
range: string
required: false
multivalued: false
description: Is the dotted decimal IPAddress of the first hop router. Format
is controlled by the addressType.
subnet:
slot_uri: cim:IPAccessPoint.subnet
range: string
required: false
multivalued: false
description: This is the IP subnet mask which controls the local vs non-local
routing.
ICCPVCC:
class_uri: cim:ICCPVCC
is_a: BilateralExchangeActor
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.ICCPConfiguration
description: Indicates that the ICCP information is global in nature and normally
is available to all authorized peers.
PublicX509Certificate:
class_uri: cim:PublicX509Certificate
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.ICCPConfiguration
description: Used to convey information that will allow matching in order to determine
which certificate to use. Actual certificates are exchanged externally to the
CIM exchange.
attributes:
issuerName:
slot_uri: cim:PublicX509Certificate.issuerName
range: string
required: false
multivalued: false
description: Represents the CA that issued the certificate. Defined to be
per X.509.
serialNumber:
slot_uri: cim:PublicX509Certificate.serialNumber
range: string
required: false
multivalued: false
description: "Is the serial number of the certificate per X.509 definition.\r\
\n"
TCPAccessPoint:
slot_uri: cim:PublicX509Certificate.TCPAccessPoint
range: TCPAccessPoint
required: false
multivalued: false
description: The association allows a certificate to be bound for use by TLS.
ISOUpperLayer:
slot_uri: cim:PublicX509Certificate.ISOUpperLayer
range: ISOUpperLayer
required: false
multivalued: false
description: Application layer used with the certificate for mutual authentication.
TCPAccessPoint:
class_uri: cim:TCPAccessPoint
is_a: IPAccessPoint
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.ICCPConfiguration
description: Allows addressing and behavioural information regarding the use of
TCP by ICCP links.
attributes:
keepAliveTime:
slot_uri: cim:TCPAccessPoint.keepAliveTime
range: integer
required: false
multivalued: false
description: Indicates the default interval at which TCP will check if the
TCP connection is still valid.
port:
slot_uri: cim:TCPAccessPoint.port
range: integer
required: false
multivalued: false
description: "This value is only needed to be specified for called nodes (e.g.\
\ those that respond to a TCP.Open request).\r\n\r\nThis value specifies\
\ the TCP port to be used. Well known and \"registered\" ports are preferred\
\ and can be found at:\r\n http://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml\r\
\n\r\nFor IEC 60870-6 TASE.2 (e.g. ICCP) and IEC 61850, the value used shall\
\ be 102 for non-TLS protected exchanges. The value shall be 3782 for TLS\
\ transported ICCP and 61850 exchanges.\r\n\r\n\r\n"
PublicX509Certificate:
slot_uri: cim:TCPAccessPoint.PublicX509Certificate
range: PublicX509Certificate
required: false
multivalued: true
description: Is the Public Certificate used for mutual authentication between
peers.
ISOUpperLayer:
class_uri: cim:ISOUpperLayer
is_a: TCPAccessPoint
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.ICCPConfiguration
description: Is a set of configure addressing information that is required since
ICCP utilizes addressing other than a TCP port.
attributes:
aeInvoke:
slot_uri: cim:ISOUpperLayer.aeInvoke
range: integer
required: false
multivalued: false
description: Is part of the Application Entity addressing as specified by
ISO Addressing.
aeQual:
slot_uri: cim:ISOUpperLayer.aeQual
range: integer
required: false
multivalued: false
description: Is the AE qualifier and represents further application level
addressing information.
apInvoke:
slot_uri: cim:ISOUpperLayer.apInvoke
range: integer
required: false
multivalued: false
description: Is a further application level OSI addressing parameter.
apTitle:
slot_uri: cim:ISOUpperLayer.apTitle
range: string
required: false
multivalued: false
description: Is a sequence of integer strings separated by ".". The value,
in conjunction with other application addressing attributes (e.g. other
APs) are used to select a specific application (e.g. the ICCP application
entity) per the OSI reference model. The sequence, and its values, represent
a namespace whose values are governed by ISO/IEC 7498-3.
osiPsel:
slot_uri: cim:ISOUpperLayer.osiPsel
range: string
required: false
multivalued: false
description: Is the addressing selector for OSI presentation addressing.
osiSsel:
slot_uri: cim:ISOUpperLayer.osiSsel
range: string
required: false
multivalued: false
description: Is the OSI session layer addressing information.
osiTsel:
slot_uri: cim:ISOUpperLayer.osiTsel
range: string
required: false
multivalued: false
description: Is the OSI Transport Layer addressing information.
UpperLayerPublicX509Certificate:
slot_uri: cim:ISOUpperLayer.UpperLayerPublicX509Certificate
range: PublicX509Certificate
required: false
multivalued: true
description: Certificate to be bound for use for Application layer mutual
authentication.
ICCPVirtualControlCentre:
class_uri: cim:ICCPVirtualControlCentre
is_a: BilateralExchangeActor
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.ICCPConfiguration
description: This contains the information that a particular actor exposes for
a particular agreed upon ICCP Bilateral Table.
attributes:
applicationSecurityRequirement:
slot_uri: cim:ICCPVirtualControlCentre.applicationSecurityRequirement
range: ApplicationSecurityKind
required: false
multivalued: false
description: Specifies the expected security mechanism, per IEC 62351-4, to
be utilized.
calling:
slot_uri: cim:ICCPVirtualControlCentre.calling
range: boolean
required: false
multivalued: false
description: "Used to indicate if the Provider is responsible for initiating\
\ the TASE.2 connection. If the value is TRUE, the provider is responsible\
\ for establishing the association. If the value is FALSE, the peer provider\
\ of the Bilateral Table will need to establish the association.\r\n"
clientAndServer:
slot_uri: cim:ICCPVirtualControlCentre.clientAndServer
range: boolean
required: false
multivalued: false
description: "If True the value indicates that the entity represented by the\
\ bilateral table is capable of issuing requests and responding to request\
\ (e.g. bidirectional support of ICCP requests).\r\n\r\nIf False, this indicates\
\ that a calling entity (e.g. calling = True) will not be able to respond\
\ to ICCP requests. If False, and calling=False, this indicates that the\
\ entity will only respond to ICCP requests and not issue ICCP requests."
minimumUpdateInterval:
slot_uri: cim:ICCPVirtualControlCentre.minimumUpdateInterval
range: integer
required: false
multivalued: false
description: Specifies the fastest update interval that can be provided for
integrity information and Transfer Set creation. The value is in seconds.
nameOfLocalICC:
slot_uri: cim:ICCPVirtualControlCentre.nameOfLocalICC
range: string
required: false
multivalued: false
description: "Specifies the ICC scope name that the remote can use to access\
\ the information in the Bilateral Table if the information is not VCC scoped.\
\ This value may not be null.\r\n\r\n"
supportForBlock1:
slot_uri: cim:ICCPVirtualControlCentre.supportForBlock1
range: boolean
required: false
multivalued: false
description: 'Per IEC 60870-6-702: If true indicates support for basic services. Must
always be true.'
supportForBlock2:
slot_uri: cim:ICCPVirtualControlCentre.supportForBlock2
range: boolean
required: false
multivalued: false
description: 'Per IEC 60870-6-702: If true indicates support for extended
conditions.'
supportForBlock3:
slot_uri: cim:ICCPVirtualControlCentre.supportForBlock3
range: boolean
required: false
multivalued: false
description: 'Per IEC 60870-6-702: If true indicates support for blocked
transfers. '
supportForBlock4:
slot_uri: cim:ICCPVirtualControlCentre.supportForBlock4
range: boolean
required: false
multivalued: false
description: 'Per IEC 60870-6-702: If true indicates support for information
messages. '
supportForBlock5:
slot_uri: cim:ICCPVirtualControlCentre.supportForBlock5
range: boolean
required: false
multivalued: false
description: 'Per IEC 60870-6-702: If true indicates support for device control. '
supportForDepriciatedBlock8:
slot_uri: cim:ICCPVirtualControlCentre.supportForDepriciatedBlock8
range: boolean
required: false
multivalued: false
description: 'Per IEC 60870-6-702: If true indicates support for accounts. The
use of this block was deprecated in Edition 3.'
transportSecurityRequirement:
slot_uri: cim:ICCPVirtualControlCentre.transportSecurityRequirement
range: boolean
required: false
multivalued: false
description: If true, then transport level security as specified by IEC 62351-6
is required.
ICCPProvidedPoint:
class_uri: cim:ICCPProvidedPoint
is_a: ProvidedBilateralPoint
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.ICCPConfiguration
description: The IdentifiedObject.name attribute must have a value. The name
attribute shall be used as the DataValue name used for the exchange.
attributes:
accessPriviledge:
slot_uri: cim:ICCPProvidedPoint.accessPriviledge
range: ICCPAccessPrivilegeKind
required: false
multivalued: false
description: Provides information regarding the access privileges allowed
to the ICCP Point.
pointQuality:
slot_uri: cim:ICCPProvidedPoint.pointQuality
range: ICCPQualityKind
required: false
multivalued: false
description: Specifies the type of ICCP quality that will be conveyed as part
of the ICCP Point.
pointType:
slot_uri: cim:ICCPProvidedPoint.pointType
range: ICCPPointKind
required: false
multivalued: false
description: "Indicates the ICCP Point type that is to be conveyed.\r\n\r\n\
A CIM AccumlatorValue shall be mapped to an ICCP real.\r\nA CIM AnalogValue\
\ shall be mapped to an ICCP real.\r\nA CIM DiscreteValue shall be mapped\
\ to either an ICCP real, state, stateSupplemental, or either protection\
\ event type.\r\nA CIM StringMeasurementValue does not have a standardized\
\ mapping."
scope:
slot_uri: cim:ICCPProvidedPoint.scope
range: ICCPScopeKind
required: false
multivalued: false
description: Indicates if the Point is global scoped (e.g. VCC) or accessible
only to the Bilateral table peer (e.g. ICC).
ICCPInformationMessage:
class_uri: cim:ICCPInformationMessage
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.ICCPConfiguration
description: This class represents the TASE.2 Information Message Object. The
IdentifiedObject.name attribute must be non-null. The value of the attribute
shall be used as the TASE.2 Information Reference, as specified by 60870-6-503.
attributes:
localReference:
slot_uri: cim:ICCPInformationMessage.localReference
range: string
required: false
multivalued: false
description: The Local Reference attribute specifies a value agreed upon between
sender and receiver of the Information Message. It further identifies the
Information Message.
scope:
slot_uri: cim:ICCPInformationMessage.scope
range: ICCPScopeKind
required: false
multivalued: false
description: Indicates if the Point is global scoped (e.g. VCC) or accessible
only to the Bilateral table peer (e.g. ICC).
TASE2BilateralTable:
slot_uri: cim:ICCPInformationMessage.TASE2BilateralTable
range: TASE2BilateralTable
required: false
multivalued: true
description: Bilateral table agreement that includes the informational message.
TASE2BilateralTable:
class_uri: cim:TASE2BilateralTable
is_a: BilateralExchangeAgreement
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.ICCPConfiguration
description: This class describe the sending (providing) side in a bilateral ICCP
data exchange. Hence the ICCP bilateral (table) descriptions are created by
exchanging ICCP Provider data between the parties.
attributes:
bilateralTableID:
slot_uri: cim:TASE2BilateralTable.bilateralTableID
range: string
required: false
multivalued: false
description: Specifies the version of the Bilateral Table configuration that
is being exchanged.
bilateralTableVersion:
slot_uri: cim:TASE2BilateralTable.bilateralTableVersion
range: string
required: false
multivalued: false
description: "The Version attribute identifies a unique version of the Bilateral\
\ Table. If any changes are made to a Bilateral Table, then a new unique\
\ value for this attribute shall be generated.\r\n"
tase2version:
slot_uri: cim:TASE2BilateralTable.tase2version
range: string
required: false
multivalued: false
description: "Specifies the version of the TASE.2 that is needed to access\
\ the Bilateral Table information via TASE.2.\r\n\r\nIn order for a link\
\ to be established, both sides must have the same value.\r\n"
ICCPInformationMessage:
slot_uri: cim:TASE2BilateralTable.ICCPInformationMessage
range: ICCPInformationMessage
required: false
multivalued: true
description: Informational message to be included in a Bilateral Table agreement.
ProportionalDistributionComponent:
class_uri: cim:ProportionalDistributionComponent
is_a: EnergyComponent
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.EnergyArea
attributes:
distributionFactor:
slot_uri: cim:ProportionalDistributionComponent.distributionFactor
range: ActivePower
required: false
multivalued: false
ObjectReverseModification:
class_uri: cim:ObjectReverseModification
is_a: ChangeSetMember
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.Part303.GenericDataSet
description: Used to specify precondition properties for a preconditioned update.
attributes:
ObjectModification:
slot_uri: cim:ObjectReverseModification.ObjectModification
range: ObjectModification
required: false
multivalued: false
description: The associated data object representing the update. Normally
the associaiton is specifed, but in the case of a proxy object where the
association is removed, we might not reference any data object as it would
only reference a proxy data object with no associations.
ObjectModification:
class_uri: cim:ObjectModification
is_a: ChangeSetMember
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.Part303.GenericDataSet
description: The object already exists and is to be modified.
attributes:
ObjectReverseModification:
slot_uri: cim:ObjectModification.ObjectReverseModification
range: ObjectReverseModification
required: false
multivalued: false
description: The data object holding preconditions of updates.
ObjectCreation:
class_uri: cim:ObjectCreation
is_a: ChangeSetMember
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.Part303.GenericDataSet
description: An object is to be created in the context.
GenericDataSetVersion:
class_uri: cim:GenericDataSetVersion
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.Part303.GenericDataSet
attributes:
majorVersion:
slot_uri: cim:GenericDataSetVersion.majorVersion
range: string
required: false
multivalued: false
description: 'The universal CIM version name describing a consistent set of
packages. '
minorVersion:
slot_uri: cim:GenericDataSetVersion.minorVersion
range: string
required: false
multivalued: false
description: Describe minor updates and error corrections.
published:
slot_uri: cim:GenericDataSetVersion.published
range: date
required: false
multivalued: false
description: "The date when the complete CIM canonical model is published\
\ and made available for use, \r\nAfter the publication the major version\
\ and name space are updated."
ObjectDeletion:
class_uri: cim:ObjectDeletion
is_a: ChangeSetMember
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.Part303.GenericDataSet
description: "An object is to be deleted in the context.\r\n"
SynchronousMachineSimplified:
class_uri: cim:SynchronousMachineSimplified
is_a: SynchronousMachineDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.SynchronousMachineDynamics
description: "The simplified model represents a synchronous generator as a constant\
\ internal voltage behind an impedance (Rs + jXp) as shown in\
\ the Simplified diagram.\r\nSince internal voltage is held constant, there\
\ is no Efd input and any excitation system model will be ignored. There\
\ is also no Ifd output.\r\nThis model should not be used for representing\
\ a real generator except, perhaps, small generators whose response is insignificant.\
\ \r\nThe parameters used for the simplified model include:\r\n- RotatingMachineDynamics.damping\
\ (D);\r\n- RotatingMachineDynamics.inertia (H);\r\n- RotatingMachineDynamics.statorLeakageReactance\
\ (used to exchange jXp for SynchronousMachineSimplified);\r\n- RotatingMachineDynamics.statorResistance\
\ (Rs)."
SynchronousMachineDetailed:
class_uri: cim:SynchronousMachineDetailed
is_a: SynchronousMachineDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.SynchronousMachineDynamics
description: "All synchronous machine detailed types use a subset of the same\
\ data parameters and input/output variables. \r\nThe several variations differ\
\ in the following ways:\r\n- the number of equivalent windings that are included;\r\
\n- the way in which saturation is incorporated into the model;\r\n- whether\
\ or not \u201Csubtransient saliency\u201D (X''q not = X''d) is\
\ represented.\r\nIt is not necessary for each simulation tool to have separate\
\ models for each of the model types. The same model can often be used for\
\ several types by alternative logic within the model. Also, differences in\
\ saturation representation might not result in significant model performance\
\ differences so model substitutions are often acceptable. "
attributes:
efdBaseRatio:
slot_uri: cim:SynchronousMachineDetailed.efdBaseRatio
range: float
required: false
multivalued: false
description: Ratio (exciter voltage/generator voltage) of Efd bases
of exciter and generator models (> 0). Typical value = 1.
ifdBaseType:
slot_uri: cim:SynchronousMachineDetailed.ifdBaseType
range: IfdBaseKind
required: false
multivalued: false
description: 'Excitation base system mode. It should be equal to the value
of WLMDV given by the user. WLMDV is the PU ratio between
the field voltage and the excitation current: Efd = WLMDV
x Ifd. Typical value = ifag.'
saturationFactor120QAxis:
slot_uri: cim:SynchronousMachineDetailed.saturationFactor120QAxis
range: float
required: false
multivalued: false
description: Quadrature-axis saturation factor at 120% of rated terminal voltage
(S12q) (>= SynchonousMachineDetailed.saturationFactorQAxis). Typical
value = 0,12.
saturationFactorQAxis:
slot_uri: cim:SynchronousMachineDetailed.saturationFactorQAxis
range: float
required: false
multivalued: false
description: Quadrature-axis saturation factor at rated terminal voltage (S1q)
(>= 0). Typical value = 0,02.
SynchronousMachineTimeConstantReactance:
class_uri: cim:SynchronousMachineTimeConstantReactance
is_a: SynchronousMachineDetailed
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.SynchronousMachineDynamics
description: "Synchronous machine detailed modelling types are defined by the\
\ combination of the attributes SynchronousMachineTimeConstantReactance.modelType\
\ and SynchronousMachineTimeConstantReactance.rotorType. \r\nParameter details:\r\
\n\r\n\t- The \u201Cp\u201D in the time-related attribute names is a substitution\
\ for a \u201Cprime\u201D in the usual parameter notation, e.g. tpdo refers\
\ to T'do.
\r\n\t- The parameters used for models expressed in\
\ time constant reactance form include:
\r\n
\r\n- RotatingMachine.ratedS\
\ (MVAbase);\r\n- RotatingMachineDynamics.damping (D);\r\n- RotatingMachineDynamics.inertia\
\ (H);\r\n- RotatingMachineDynamics.saturationFactor (S1);\r\n\
- RotatingMachineDynamics.saturationFactor120 (S12);\r\n- RotatingMachineDynamics.statorLeakageReactance\
\ (Xl);\r\n- RotatingMachineDynamics.statorResistance (Rs);\r\n\
- SynchronousMachineTimeConstantReactance.ks (Ks);\r\n- SynchronousMachineDetailed.saturationFactorQAxis\
\ (S1q);\r\n- SynchronousMachineDetailed.saturationFactor120QAxis (S12q);\r\
\n- SynchronousMachineDetailed.efdBaseRatio;\r\n- SynchronousMachineDetailed.ifdBaseType;\r\
\n- .xDirectSync (Xd);\r\n- .xDirectTrans (X'd);\r\n- .xDirectSubtrans\
\ (X''d);\r\n- .xQuadSync (Xq);\r\n- .xQuadTrans (X'q);\r\
\n- .xQuadSubtrans (X''q);\r\n- .tpdo (T'do);\r\n- .tppdo (T''do);\r\
\n- .tpqo (T'qo);\r\n- .tppqo (T''qo);\r\n- .tc."
attributes:
ks:
slot_uri: cim:SynchronousMachineTimeConstantReactance.ks
range: float
required: false
multivalued: false
description: Saturation loading correction factor (Ks) (>= 0). Used
only by type J model. Typical value = 0.
modelType:
slot_uri: cim:SynchronousMachineTimeConstantReactance.modelType
range: SynchronousMachineModelKind
required: false
multivalued: false
description: Type of synchronous machine model used in dynamic simulation
applications.
rotorType:
slot_uri: cim:SynchronousMachineTimeConstantReactance.rotorType
range: RotorKind
required: false
multivalued: false
description: Type of rotor on physical machine.
tc:
slot_uri: cim:SynchronousMachineTimeConstantReactance.tc
range: Seconds
required: false
multivalued: false
description: "Damping time constant for \u201CCanay\u201D reactance (>=\
\ 0). Typical value = 0."
tpdo:
slot_uri: cim:SynchronousMachineTimeConstantReactance.tpdo
range: Seconds
required: false
multivalued: false
description: Direct-axis transient rotor time constant (T'do) (>
SynchronousMachineTimeConstantReactance.tppdo). Typical value = 5.
tppdo:
slot_uri: cim:SynchronousMachineTimeConstantReactance.tppdo
range: Seconds
required: false
multivalued: false
description: Direct-axis subtransient rotor time constant (T''do) (>
0). Typical value = 0,03.
tppqo:
slot_uri: cim:SynchronousMachineTimeConstantReactance.tppqo
range: Seconds
required: false
multivalued: false
description: Quadrature-axis subtransient rotor time constant (T''qo)
(> 0). Typical value = 0,03.
tpqo:
slot_uri: cim:SynchronousMachineTimeConstantReactance.tpqo
range: Seconds
required: false
multivalued: false
description: Quadrature-axis transient rotor time constant (T'qo) (>
SynchronousMachineTimeConstantReactance.tppqo). Typical value = 0,5.
xDirectSubtrans:
slot_uri: cim:SynchronousMachineTimeConstantReactance.xDirectSubtrans
range: PU
required: false
multivalued: false
description: Direct-axis subtransient reactance (unsaturated) (X''d)
(> RotatingMachineDynamics.statorLeakageReactance). Typical value =
0,2.
xDirectSync:
slot_uri: cim:SynchronousMachineTimeConstantReactance.xDirectSync
range: PU
required: false
multivalued: false
description: Direct-axis synchronous reactance (Xd) (>= SynchronousMachineTimeConstantReactance.xDirectTrans).
The quotient of a sustained value of that AC component of armature voltage
that is produced by the total direct-axis flux due to direct-axis armature
current and the value of the AC component of this current, the machine running
at rated speed. Typical value = 1,8.
xDirectTrans:
slot_uri: cim:SynchronousMachineTimeConstantReactance.xDirectTrans
range: PU
required: false
multivalued: false
description: Direct-axis transient reactance (unsaturated) (X'd) (>=
SynchronousMachineTimeConstantReactance.xDirectSubtrans). Typical value
= 0,5.
xQuadSubtrans:
slot_uri: cim:SynchronousMachineTimeConstantReactance.xQuadSubtrans
range: PU
required: false
multivalued: false
description: Quadrature-axis subtransient reactance (X''q) (> RotatingMachineDynamics.statorLeakageReactance). Typical
value = 0,2.
xQuadSync:
slot_uri: cim:SynchronousMachineTimeConstantReactance.xQuadSync
range: PU
required: false
multivalued: false
description: "Quadrature-axis synchronous reactance (Xq) (>= SynchronousMachineTimeConstantReactance.xQuadTrans).\r\
\nThe ratio of the component of reactive armature voltage, due to the quadrature-axis\
\ component of armature current, to this component of current, under steady\
\ state conditions and at rated frequency. Typical value = 1,6."
xQuadTrans:
slot_uri: cim:SynchronousMachineTimeConstantReactance.xQuadTrans
range: PU
required: false
multivalued: false
description: Quadrature-axis transient reactance (X'q) (>= SynchronousMachineTimeConstantReactance.xQuadSubtrans). Typical
value = 0,3.
SynchronousMachineEquivalentCircuit:
class_uri: cim:SynchronousMachineEquivalentCircuit
is_a: SynchronousMachineDetailed
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.SynchronousMachineDynamics
description: "The electrical equations for all variations of the synchronous models\
\ are based on the SynchronousEquivalentCircuit diagram for the direct- and\
\ quadrature- axes.\r\nEquations for conversion between equivalent circuit and\
\ time constant reactance forms:\r\nXd = Xad + Xl\r\nX\u2019\
d = Xl + Xad x Xfd / (Xad + Xfd)\r\n\
X\u201Dd = Xl + Xad x Xfd x X1d / (Xad\
\ x Xfd + Xad x X1d + Xfd x X1d)\r\nXq\
\ = Xaq + Xl\r\nX\u2019q = Xl + Xaq x X1q\
\ / (Xaq + X1q)\r\nX\u201Dq = Xl + Xaq x\
\ X1q x X2q / (Xaq x X1q + Xaq x X2q\
\ + X1q x X2q)\r\nT\u2019do = (Xad + Xfd)\
\ / (omega0 x Rfd)\r\nT\u201Ddo = (Xad\
\ x Xfd + Xad x X1d + Xfd x X1d) / (omega0\
\ x R1d x (Xad + Xfd)\r\nT\u2019qo = (Xaq\
\ + X1q) / (omega0 x R1q)\r\nT\u201D\
qo = (Xaq x X1q + Xaq x X2q + X1q x X2q)\
\ / (omega0 x R2q x (Xaq + X1q)\r\
\nSame equations using CIM attributes from SynchronousMachineTimeConstantReactance\
\ class on left of \"=\" and SynchronousMachineEquivalentCircuit class on right\
\ (except as noted):\r\nxDirectSync = xad + RotatingMachineDynamics.statorLeakageReactance\r\
\nxDirectTrans = RotatingMachineDynamics.statorLeakageReactance + xad x xfd\
\ / (xad + xfd)\r\nxDirectSubtrans = RotatingMachineDynamics.statorLeakageReactance\
\ + xad x xfd x x1d / (xad x xfd + xad x x1d + xfd x x1d)\r\nxQuadSync = xaq\
\ + RotatingMachineDynamics.statorLeakageReactance\r\nxQuadTrans = RotatingMachineDynamics.statorLeakageReactance\
\ + xaq x x1q / (xaq+ x1q)\r\nxQuadSubtrans = RotatingMachineDynamics.statorLeakageReactance\
\ + xaq x x1q x x2q / (xaq x x1q + xaq x x2q + x1q x x2q) \r\ntpdo = (xad +\
\ xfd) / (2 x pi x nominal frequency x rfd)\r\ntppdo = (xad x xfd + xad x x1d\
\ + xfd x x1d) / (2 x pi x nominal frequency x r1d x (xad + xfd)\r\ntpqo = (xaq\
\ + x1q) / (2 x pi x nominal frequency x r1q)\r\ntppqo = (xaq x x1q + xaq x\
\ x2q + x1q x x2q) / (2 x pi x nominal frequency x r2q x (xaq + x1q)\r\nThese\
\ are only valid for a simplified model where \"Canay\" reactance is zero."
attributes:
r1d:
slot_uri: cim:SynchronousMachineEquivalentCircuit.r1d
range: PU
required: false
multivalued: false
description: Direct-axis damper 1 winding resistance.
r1q:
slot_uri: cim:SynchronousMachineEquivalentCircuit.r1q
range: PU
required: false
multivalued: false
description: Quadrature-axis damper 1 winding resistance.
r2q:
slot_uri: cim:SynchronousMachineEquivalentCircuit.r2q
range: PU
required: false
multivalued: false
description: Quadrature-axis damper 2 winding resistance.
rfd:
slot_uri: cim:SynchronousMachineEquivalentCircuit.rfd
range: PU
required: false
multivalued: false
description: Field winding resistance.
x1d:
slot_uri: cim:SynchronousMachineEquivalentCircuit.x1d
range: PU
required: false
multivalued: false
description: Direct-axis damper 1 winding leakage reactance.
x1q:
slot_uri: cim:SynchronousMachineEquivalentCircuit.x1q
range: PU
required: false
multivalued: false
description: Quadrature-axis damper 1 winding leakage reactance.
x2q:
slot_uri: cim:SynchronousMachineEquivalentCircuit.x2q
range: PU
required: false
multivalued: false
description: Quadrature-axis damper 2 winding leakage reactance.
xad:
slot_uri: cim:SynchronousMachineEquivalentCircuit.xad
range: PU
required: false
multivalued: false
description: Direct-axis mutual reactance.
xaq:
slot_uri: cim:SynchronousMachineEquivalentCircuit.xaq
range: PU
required: false
multivalued: false
description: Quadrature-axis mutual reactance.
xf1d:
slot_uri: cim:SynchronousMachineEquivalentCircuit.xf1d
range: PU
required: false
multivalued: false
description: "Differential mutual (\u201CCanay\u201D) reactance."
xfd:
slot_uri: cim:SynchronousMachineEquivalentCircuit.xfd
range: PU
required: false
multivalued: false
description: Field winding leakage reactance.
AsynchronousMachineTimeConstantReactance:
class_uri: cim:AsynchronousMachineTimeConstantReactance
is_a: AsynchronousMachineDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.AsynchronousMachineDynamics
description: "Parameter details:\r\n\r\n\t- If X'' = X', a\
\ single cage (one equivalent rotor winding per axis) is modelled.
\r\n\t\
- The \u201Cp\u201D in the attribute names is a substitution for a\
\ \u201Cprime\u201D in the usual parameter notation, e.g. tpo refers\
\ to T'o.
\r\n
\r\nThe parameters used for models expressed in\
\ time constant reactance form include:\r\n- RotatingMachine.ratedS (MVAbase);\r\
\n- RotatingMachineDynamics.damping (D);\r\n- RotatingMachineDynamics.inertia\
\ (H);\r\n- RotatingMachineDynamics.saturationFactor (S1);\r\n\
- RotatingMachineDynamics.saturationFactor120 (S12);\r\n- RotatingMachineDynamics.statorLeakageReactance\
\ (Xl);\r\n- RotatingMachineDynamics.statorResistance (Rs);\r\n\
- .xs (Xs);\r\n- .xp (X');\r\n- .xpp (X'');\r\n- .tpo (T'o);\r\
\n- .tppo (T''o)."
attributes:
tpo:
slot_uri: cim:AsynchronousMachineTimeConstantReactance.tpo
range: Seconds
required: false
multivalued: false
description: Transient rotor time constant (T'o) (> AsynchronousMachineTimeConstantReactance.tppo). Typical
value = 5.
tppo:
slot_uri: cim:AsynchronousMachineTimeConstantReactance.tppo
range: Seconds
required: false
multivalued: false
description: Subtransient rotor time constant (T''o) (> 0). Typical
value = 0,03.
xp:
slot_uri: cim:AsynchronousMachineTimeConstantReactance.xp
range: PU
required: false
multivalued: false
description: Transient reactance (unsaturated) (X') (>= AsynchronousMachineTimeConstantReactance.xpp). Typical
value = 0,5.
xpp:
slot_uri: cim:AsynchronousMachineTimeConstantReactance.xpp
range: PU
required: false
multivalued: false
description: Subtransient reactance (unsaturated) (X'') (> RotatingMachineDynamics.statorLeakageReactance). Typical
value = 0,2.
xs:
slot_uri: cim:AsynchronousMachineTimeConstantReactance.xs
range: PU
required: false
multivalued: false
description: Synchronous reactance (Xs) (>= AsynchronousMachineTimeConstantReactance.xp). Typical
value = 1,8.
AsynchronousMachineEquivalentCircuit:
class_uri: cim:AsynchronousMachineEquivalentCircuit
is_a: AsynchronousMachineDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.AsynchronousMachineDynamics
description: "The electrical equations of all variations of the asynchronous model\
\ are based on the AsynchronousEquivalentCircuit diagram for the direct- and\
\ quadrature- axes, with two equivalent rotor windings in each axis. \r\nEquations\
\ for conversion between equivalent circuit and time constant reactance forms:\r\
\nXs = Xm + Xl\r\nX' = Xl + Xm x Xlr1\
\ / (Xm + Xlr1)\r\nX'' = Xl + Xm x Xlr1\
\ x Xlr2 / (Xm x Xlr1 + Xm x Xlr2 + Xlr1\
\ x Xlr2)\r\nT'o = (Xm + Xlr1) / (omega0\
\ x Rr1)\r\nT''o = (Xm x Xlr1 + Xm x Xlr2\
\ + Xlr1 x Xlr2) / (omega0 x Rr2\
\ x (Xm + Xlr1)\r\nSame equations using CIM attributes from AsynchronousMachineTimeConstantReactance\
\ class on left of \"=\" and AsynchronousMachineEquivalentCircuit class on right\
\ (except as noted):\r\nxs = xm + RotatingMachineDynamics.statorLeakageReactance\r\
\nxp = RotatingMachineDynamics.statorLeakageReactance + xm x xlr1 / (xm + xlr1)\r\
\nxpp = RotatingMachineDynamics.statorLeakageReactance + xm x xlr1 x xlr2 /\
\ (xm x xlr1 + xm x xlr2 + xlr1 x xlr2)\r\ntpo = (xm + xlr1) / (2 x pi x nominal\
\ frequency x rr1)\r\ntppo = (xm x xlr1 + xm x xlr2 + xlr1 x xlr2) / (2 x pi\
\ x nominal frequency x rr2 x (xm + xlr1)."
attributes:
rr1:
slot_uri: cim:AsynchronousMachineEquivalentCircuit.rr1
range: PU
required: false
multivalued: false
description: Damper 1 winding resistance.
rr2:
slot_uri: cim:AsynchronousMachineEquivalentCircuit.rr2
range: PU
required: false
multivalued: false
description: Damper 2 winding resistance.
xlr1:
slot_uri: cim:AsynchronousMachineEquivalentCircuit.xlr1
range: PU
required: false
multivalued: false
description: Damper 1 winding leakage reactance.
xlr2:
slot_uri: cim:AsynchronousMachineEquivalentCircuit.xlr2
range: PU
required: false
multivalued: false
description: Damper 2 winding leakage reactance.
xm:
slot_uri: cim:AsynchronousMachineEquivalentCircuit.xm
range: PU
required: false
multivalued: false
description: Magnetizing reactance.
GovHydroIEEE0:
class_uri: cim:GovHydroIEEE0
is_a: TurbineGovernorDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.TurbineGovernorDynamics
description: "IEEE simplified hydro governor-turbine model. Used for mechanical-hydraulic\
\ and electro-hydraulic turbine governors, with or without steam feedback. Typical\
\ values given are for mechanical-hydraulic turbine-governor.\r\nReference: IEEE Transactions on Power Apparatus and Systems, November/December\
\ 1973, Volume PAS-92, Number 6, Dynamic Models for Steam and Hydro Turbines\
\ in Power System Studies, page 1904."
attributes:
k:
slot_uri: cim:GovHydroIEEE0.k
range: PU
required: false
multivalued: false
description: Governor gain (K).
mwbase:
slot_uri: cim:GovHydroIEEE0.mwbase
range: ActivePower
required: false
multivalued: false
description: Base for power values (MWbase) (> 0). Unit = MW.
pmax:
slot_uri: cim:GovHydroIEEE0.pmax
range: PU
required: false
multivalued: false
description: 'Gate maximum (Pmax) (> GovHydroIEEE0.pmin). '
pmin:
slot_uri: cim:GovHydroIEEE0.pmin
range: PU
required: false
multivalued: false
description: 'Gate minimum (Pmin) (< GovHydroIEEE.pmax). '
t1:
slot_uri: cim:GovHydroIEEE0.t1
range: Seconds
required: false
multivalued: false
description: Governor lag time constant (T1) (>= 0). Typical value
= 0,25.
t2:
slot_uri: cim:GovHydroIEEE0.t2
range: Seconds
required: false
multivalued: false
description: Governor lead time constant (T2) (>= 0). Typical value
= 0.
t3:
slot_uri: cim:GovHydroIEEE0.t3
range: Seconds
required: false
multivalued: false
description: Gate actuator time constant (T3) (>= 0). Typical value
= 0,1.
t4:
slot_uri: cim:GovHydroIEEE0.t4
range: Seconds
required: false
multivalued: false
description: 'Water starting time (T4) (>= 0). '
GovHydroIEEE2:
class_uri: cim:GovHydroIEEE2
is_a: TurbineGovernorDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.TurbineGovernorDynamics
description: "IEEE hydro turbine governor model represents plants with straightforward\
\ penstock configurations and hydraulic-dashpot governors.\r\nReference: IEEE Transactions on Power Apparatus and Systems, November/December\
\ 1973, Volume PAS-92, Number 6, Dynamic Models for Steam and Hydro Turbines\
\ in Power System Studies, page 1904."
attributes:
aturb:
slot_uri: cim:GovHydroIEEE2.aturb
range: PU
required: false
multivalued: false
description: Turbine numerator multiplier (Aturb). Typical value =
-1.
bturb:
slot_uri: cim:GovHydroIEEE2.bturb
range: PU
required: false
multivalued: false
description: Turbine denominator multiplier (Bturb) (> 0). Typical
value = 0,5.
gv1:
slot_uri: cim:GovHydroIEEE2.gv1
range: PU
required: false
multivalued: false
description: Nonlinear gain point 1, PU gv (Gv1). Typical value =
0.
gv2:
slot_uri: cim:GovHydroIEEE2.gv2
range: PU
required: false
multivalued: false
description: Nonlinear gain point 2, PU gv (Gv2). Typical value =
0.
gv3:
slot_uri: cim:GovHydroIEEE2.gv3
range: PU
required: false
multivalued: false
description: Nonlinear gain point 3, PU gv (Gv3). Typical value =
0.
gv4:
slot_uri: cim:GovHydroIEEE2.gv4
range: PU
required: false
multivalued: false
description: Nonlinear gain point 4, PU gv (Gv4). Typical value =
0.
gv5:
slot_uri: cim:GovHydroIEEE2.gv5
range: PU
required: false
multivalued: false
description: Nonlinear gain point 5, PU gv (Gv5). Typical value =
0.
gv6:
slot_uri: cim:GovHydroIEEE2.gv6
range: PU
required: false
multivalued: false
description: Nonlinear gain point 6, PU gv (Gv6). Typical value =
0.
kturb:
slot_uri: cim:GovHydroIEEE2.kturb
range: PU
required: false
multivalued: false
description: Turbine gain (Kturb). Typical value = 1.
mwbase:
slot_uri: cim:GovHydroIEEE2.mwbase
range: ActivePower
required: false
multivalued: false
description: Base for power values (MWbase) (> 0). Unit = MW.
pgv1:
slot_uri: cim:GovHydroIEEE2.pgv1
range: PU
required: false
multivalued: false
description: Nonlinear gain point 1, PU power (Pgv1). Typical value
= 0.
pgv2:
slot_uri: cim:GovHydroIEEE2.pgv2
range: PU
required: false
multivalued: false
description: Nonlinear gain point 2, PU power (Pgv2). Typical value
= 0.
pgv3:
slot_uri: cim:GovHydroIEEE2.pgv3
range: PU
required: false
multivalued: false
description: Nonlinear gain point 3, PU power (Pgv3). Typical value
= 0.
pgv4:
slot_uri: cim:GovHydroIEEE2.pgv4
range: PU
required: false
multivalued: false
description: Nonlinear gain point 4, PU power (Pgv4). Typical value
= 0.
pgv5:
slot_uri: cim:GovHydroIEEE2.pgv5
range: PU
required: false
multivalued: false
description: Nonlinear gain point 5, PU power (Pgv5). Typical value
= 0.
pgv6:
slot_uri: cim:GovHydroIEEE2.pgv6
range: PU
required: false
multivalued: false
description: Nonlinear gain point 6, PU power (Pgv6). Typical value
= 0.
pmax:
slot_uri: cim:GovHydroIEEE2.pmax
range: PU
required: false
multivalued: false
description: Maximum gate opening (Pmax) (> GovHydroIEEE2.pmin). Typical
value = 1.
pmin:
slot_uri: cim:GovHydroIEEE2.pmin
range: PU
required: false
multivalued: false
description: Minimum gate opening (Pmin) (<GovHydroIEEE2.pmax). Typical
value = 0.
rperm:
slot_uri: cim:GovHydroIEEE2.rperm
range: PU
required: false
multivalued: false
description: Permanent droop (Rperm). Typical value = 0,05.
rtemp:
slot_uri: cim:GovHydroIEEE2.rtemp
range: PU
required: false
multivalued: false
description: Temporary droop (Rtemp). Typical value = 0,5.
tg:
slot_uri: cim:GovHydroIEEE2.tg
range: Seconds
required: false
multivalued: false
description: Gate servo time constant (Tg) (>= 0). Typical value
= 0,5.
tp:
slot_uri: cim:GovHydroIEEE2.tp
range: Seconds
required: false
multivalued: false
description: Pilot servo valve time constant (Tp) (>= 0). Typical
value = 0,03.
tr:
slot_uri: cim:GovHydroIEEE2.tr
range: Seconds
required: false
multivalued: false
description: Dashpot time constant (Tr) (>= 0). Typical value =
12.
tw:
slot_uri: cim:GovHydroIEEE2.tw
range: Seconds
required: false
multivalued: false
description: Water inertia time constant (Tw) (>= 0). Typical value
= 2.
uc:
slot_uri: cim:GovHydroIEEE2.uc
range: float
required: false
multivalued: false
description: Maximum gate closing velocity (Uc) (<0). Typical value
= -0,1.
uo:
slot_uri: cim:GovHydroIEEE2.uo
range: float
required: false
multivalued: false
description: Maximum gate opening velocity (Uo). Unit = PU / s. Typical
value = 0,1.
GovSteamIEEE1:
class_uri: cim:GovSteamIEEE1
is_a: TurbineGovernorDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.TurbineGovernorDynamics
description: "IEEE steam turbine governor model.\r\nReference: IEEE Transactions on Power Apparatus and Systems, November/December\
\ 1973, Volume PAS-92, Number 6, Dynamic Models for Steam and Hydro Turbines\
\ in Power System Studies, page 1904."
attributes:
k:
slot_uri: cim:GovSteamIEEE1.k
range: PU
required: false
multivalued: false
description: Governor gain (reciprocal of droop) (K) (> 0). Typical
value = 25.
k1:
slot_uri: cim:GovSteamIEEE1.k1
range: float
required: false
multivalued: false
description: Fraction of HP shaft power after first boiler pass (K1). Typical
value = 0,2.
k2:
slot_uri: cim:GovSteamIEEE1.k2
range: float
required: false
multivalued: false
description: Fraction of LP shaft power after first boiler pass (K2). Typical
value = 0.
k3:
slot_uri: cim:GovSteamIEEE1.k3
range: float
required: false
multivalued: false
description: Fraction of HP shaft power after second boiler pass (K3). Typical
value = 0,3.
k4:
slot_uri: cim:GovSteamIEEE1.k4
range: float
required: false
multivalued: false
description: Fraction of LP shaft power after second boiler pass (K4). Typical
value = 0.
k5:
slot_uri: cim:GovSteamIEEE1.k5
range: float
required: false
multivalued: false
description: Fraction of HP shaft power after third boiler pass (K5). Typical
value = 0,5.
k6:
slot_uri: cim:GovSteamIEEE1.k6
range: float
required: false
multivalued: false
description: Fraction of LP shaft power after third boiler pass (K6). Typical
value = 0.
k7:
slot_uri: cim:GovSteamIEEE1.k7
range: float
required: false
multivalued: false
description: Fraction of HP shaft power after fourth boiler pass (K7). Typical
value = 0.
k8:
slot_uri: cim:GovSteamIEEE1.k8
range: float
required: false
multivalued: false
description: Fraction of LP shaft power after fourth boiler pass (K8). Typical
value = 0.
mwbase:
slot_uri: cim:GovSteamIEEE1.mwbase
range: ActivePower
required: false
multivalued: false
description: Base for power values (MWbase) (> 0). Unit =
MW.
pmax:
slot_uri: cim:GovSteamIEEE1.pmax
range: PU
required: false
multivalued: false
description: Maximum valve opening (Pmax) (> GovSteamIEEE1.pmin). Typical
value = 1.
pmin:
slot_uri: cim:GovSteamIEEE1.pmin
range: PU
required: false
multivalued: false
description: Minimum valve opening (Pmin) (>= 0 and < GovSteamIEEE1.pmax). Typical
value = 0.
t1:
slot_uri: cim:GovSteamIEEE1.t1
range: Seconds
required: false
multivalued: false
description: Governor lag time constant (T1) (>= 0). Typical value
= 0.
t2:
slot_uri: cim:GovSteamIEEE1.t2
range: Seconds
required: false
multivalued: false
description: Governor lead time constant (T2) (>= 0). Typical value
= 0.
t3:
slot_uri: cim:GovSteamIEEE1.t3
range: Seconds
required: false
multivalued: false
description: Valve positioner time constant (T3) (> 0). Typical
value = 0,1.
t4:
slot_uri: cim:GovSteamIEEE1.t4
range: Seconds
required: false
multivalued: false
description: Inlet piping/steam bowl time constant (T4) (>= 0). Typical
value = 0,3.
t5:
slot_uri: cim:GovSteamIEEE1.t5
range: Seconds
required: false
multivalued: false
description: Time constant of second boiler pass (T5) (>= 0). Typical
value = 5.
t6:
slot_uri: cim:GovSteamIEEE1.t6
range: Seconds
required: false
multivalued: false
description: Time constant of third boiler pass (T6) (>= 0). Typical
value = 0,5.
t7:
slot_uri: cim:GovSteamIEEE1.t7
range: Seconds
required: false
multivalued: false
description: Time constant of fourth boiler pass (T7) (>= 0). Typical
value = 0.
uc:
slot_uri: cim:GovSteamIEEE1.uc
range: float
required: false
multivalued: false
description: Maximum valve closing velocity (Uc) (< 0). Unit =
PU / s. Typical value = -10.
uo:
slot_uri: cim:GovSteamIEEE1.uo
range: float
required: false
multivalued: false
description: Maximum valve opening velocity (Uo) (> 0). Unit =
PU / s. Typical value = 1.
GovCT1:
class_uri: cim:GovCT1
is_a: TurbineGovernorDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.TurbineGovernorDynamics
description: "General model for any prime mover with a PID governor, used primarily\
\ for combustion turbine and combined cycle units.\r\nThis model can be used\
\ to represent a variety of prime movers controlled by PID governors. It is\
\ suitable, for example, for the representation of: \r\n\r\n\t- gas turbine\
\ and single shaft combined cycle turbines
\r\n
\r\n\r\n\t- diesel\
\ engines with modern electronic or digital governors
\r\n
\r\n\r\
\n\t- steam turbines where steam is supplied from a large boiler drum or a\
\ large header whose pressure is substantially constant over the period under\
\ study
\r\n\t- simple hydro turbines in dam configurations where the\
\ water column length is short and water inertia effects are minimal.
\r\
\n
\r\nAdditional information on this model is available in the 2012 IEEE\
\ report, Dynamic Models for Turbine-Governors in Power System Studies,\
\ 3.1.2.3 pages 3-4 (GGOV1)."
attributes:
aset:
slot_uri: cim:GovCT1.aset
range: float
required: false
multivalued: false
description: Acceleration limiter setpoint (Aset). Unit = PU / s. Typical
value = 0,01.
db:
slot_uri: cim:GovCT1.db
range: PU
required: false
multivalued: false
description: Speed governor deadband in PU speed (db). In the majority
of applications, it is recommended that this value be set to zero. Typical
value = 0.
dm:
slot_uri: cim:GovCT1.dm
range: PU
required: false
multivalued: false
description: Speed sensitivity coefficient (Dm). Dm can represent
either the variation of the engine power with the shaft speed or the variation
of maximum power capability with shaft speed. If it is positive it describes
the falling slope of the engine speed verses power characteristic as speed
increases. A slightly falling characteristic is typical for reciprocating
engines and some aero-derivative turbines. If it is negative the engine
power is assumed to be unaffected by the shaft speed, but the maximum permissible
fuel flow is taken to fall with falling shaft speed. This is characteristic
of single-shaft industrial turbines due to exhaust temperature limits. Typical
value = 0.
ka:
slot_uri: cim:GovCT1.ka
range: PU
required: false
multivalued: false
description: Acceleration limiter gain (Ka). Typical value = 10.
kdgov:
slot_uri: cim:GovCT1.kdgov
range: PU
required: false
multivalued: false
description: Governor derivative gain (Kdgov). Typical value = 0.
kigov:
slot_uri: cim:GovCT1.kigov
range: PU
required: false
multivalued: false
description: Governor integral gain (Kigov). Typical value = 2.
kiload:
slot_uri: cim:GovCT1.kiload
range: PU
required: false
multivalued: false
description: Load limiter integral gain for PI controller (Kiload). Typical
value = 0,67.
kimw:
slot_uri: cim:GovCT1.kimw
range: PU
required: false
multivalued: false
description: Power controller (reset) gain (Kimw). The default value
of 0,01 corresponds to a reset time of 100 s. A value of 0,001 corresponds
to a relatively slow-acting load controller. Typical value = 0,01.
kpgov:
slot_uri: cim:GovCT1.kpgov
range: PU
required: false
multivalued: false
description: Governor proportional gain (Kpgov). Typical value = 10.
kpload:
slot_uri: cim:GovCT1.kpload
range: PU
required: false
multivalued: false
description: Load limiter proportional gain for PI controller (Kpload). Typical
value = 2.
kturb:
slot_uri: cim:GovCT1.kturb
range: PU
required: false
multivalued: false
description: Turbine gain (Kturb) (> 0). Typical value = 1,5.
ldref:
slot_uri: cim:GovCT1.ldref
range: PU
required: false
multivalued: false
description: Load limiter reference value (Ldref). Typical value =
1.
maxerr:
slot_uri: cim:GovCT1.maxerr
range: PU
required: false
multivalued: false
description: Maximum value for speed error signal (maxerr) (> GovCT1.minerr). Typical
value = 0,05.
minerr:
slot_uri: cim:GovCT1.minerr
range: PU
required: false
multivalued: false
description: Minimum value for speed error signal (minerr) (< GovCT1.maxerr). Typical
value = -0,05.
mwbase:
slot_uri: cim:GovCT1.mwbase
range: ActivePower
required: false
multivalued: false
description: Base for power values (MWbase) (> 0). Unit = MW.
r:
slot_uri: cim:GovCT1.r
range: PU
required: false
multivalued: false
description: Permanent droop (R). Typical value = 0,04.
rclose:
slot_uri: cim:GovCT1.rclose
range: float
required: false
multivalued: false
description: Minimum valve closing rate (Rclose). Unit = PU / s. Typical
value = -0,1.
rdown:
slot_uri: cim:GovCT1.rdown
range: PU
required: false
multivalued: false
description: Maximum rate of load limit decrease (Rdown). Typical
value = -99.
ropen:
slot_uri: cim:GovCT1.ropen
range: float
required: false
multivalued: false
description: Maximum valve opening rate (Ropen). Unit = PU / s. Typical
value = 0.10.
rselect:
slot_uri: cim:GovCT1.rselect
range: DroopSignalFeedbackKind
required: false
multivalued: false
description: Feedback signal for droop (Rselect). Typical value =
electricalPower.
rup:
slot_uri: cim:GovCT1.rup
range: PU
required: false
multivalued: false
description: Maximum rate of load limit increase (Rup). Typical value
= 99.
ta:
slot_uri: cim:GovCT1.ta
range: Seconds
required: false
multivalued: false
description: Acceleration limiter time constant (Ta) (> 0). Typical
value = 0,1.
tact:
slot_uri: cim:GovCT1.tact
range: Seconds
required: false
multivalued: false
description: Actuator time constant (Tact) (>= 0). Typical value
= 0,5.
tb:
slot_uri: cim:GovCT1.tb
range: Seconds
required: false
multivalued: false
description: Turbine lag time constant (Tb) (> 0). Typical value
= 0,5.
tc:
slot_uri: cim:GovCT1.tc
range: Seconds
required: false
multivalued: false
description: Turbine lead time constant (Tc) (>= 0). Typical value
= 0.
tdgov:
slot_uri: cim:GovCT1.tdgov
range: Seconds
required: false
multivalued: false
description: Governor derivative controller time constant (Tdgov) (>=
0). Typical value = 1.
teng:
slot_uri: cim:GovCT1.teng
range: Seconds
required: false
multivalued: false
description: Transport time delay for diesel engine used in representing diesel
engines where there is a small but measurable transport delay between a
change in fuel flow setting and the development of torque (Teng)
(>= 0). Teng should be zero in all but special cases where this
transport delay is of particular concern. Typical value = 0.
tfload:
slot_uri: cim:GovCT1.tfload
range: Seconds
required: false
multivalued: false
description: Load-limiter time constant (Tfload) (> 0). Typical
value = 3.
tpelec:
slot_uri: cim:GovCT1.tpelec
range: Seconds
required: false
multivalued: false
description: Electrical power transducer time constant (Tpelec) (>
0). Typical value = 1.
tsa:
slot_uri: cim:GovCT1.tsa
range: Seconds
required: false
multivalued: false
description: Temperature detection lead time constant (Tsa) (>=
0). Typical value = 4.
tsb:
slot_uri: cim:GovCT1.tsb
range: Seconds
required: false
multivalued: false
description: Temperature detection lag time constant (Tsb) (>= 0). Typical
value = 5.
vmax:
slot_uri: cim:GovCT1.vmax
range: PU
required: false
multivalued: false
description: Maximum valve position limit (Vmax) (> GovCT1.vmin). Typical
value = 1.
vmin:
slot_uri: cim:GovCT1.vmin
range: PU
required: false
multivalued: false
description: Minimum valve position limit (Vmin) (< GovCT1.vmax). Typical
value = 0,15.
wfnl:
slot_uri: cim:GovCT1.wfnl
range: PU
required: false
multivalued: false
description: No load fuel flow (Wfnl). Typical value = 0,2.
wfspd:
slot_uri: cim:GovCT1.wfspd
range: boolean
required: false
multivalued: false
description: "Switch for fuel source characteristic to recognize that fuel\
\ flow, for a given fuel valve stroke, can be proportional to engine speed\
\ (Wfspd).\r\ntrue = fuel flow proportional to speed (for some gas\
\ turbines and diesel engines with positive displacement fuel injectors)\r\
\nfalse = fuel control system keeps fuel flow independent of engine speed.\r\
\nTypical value = true."
GovCT2:
class_uri: cim:GovCT2
is_a: TurbineGovernorDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.TurbineGovernorDynamics
description: General governor with frequency-dependent fuel flow limit. This
model is a modification of the GovCT1 model in order to represent the
frequency-dependent fuel flow limit of a specific gas turbine manufacturer.
attributes:
aset:
slot_uri: cim:GovCT2.aset
range: float
required: false
multivalued: false
description: Acceleration limiter setpoint (Aset). Unit = PU / s. Typical
value = 10.
db:
slot_uri: cim:GovCT2.db
range: PU
required: false
multivalued: false
description: Speed governor deadband in PU speed (db). In the majority
of applications, it is recommended that this value be set to zero. Typical
value = 0.
dm:
slot_uri: cim:GovCT2.dm
range: PU
required: false
multivalued: false
description: Speed sensitivity coefficient (Dm). Dm can represent
either the variation of the engine power with the shaft speed or the variation
of maximum power capability with shaft speed. If it is positive it describes
the falling slope of the engine speed verses power characteristic as speed
increases. A slightly falling characteristic is typical for reciprocating
engines and some aero-derivative turbines. If it is negative the engine
power is assumed to be unaffected by the shaft speed, but the maximum permissible
fuel flow is taken to fall with falling shaft speed. This is characteristic
of single-shaft industrial turbines due to exhaust temperature limits. Typical
value = 0.
flim1:
slot_uri: cim:GovCT2.flim1
range: Frequency
required: false
multivalued: false
description: Frequency threshold 1 (Flim1). Unit = Hz. Typical value
= 59.
flim10:
slot_uri: cim:GovCT2.flim10
range: Frequency
required: false
multivalued: false
description: Frequency threshold 10 (Flim10). Unit = Hz. Typical
value = 0.
flim2:
slot_uri: cim:GovCT2.flim2
range: Frequency
required: false
multivalued: false
description: Frequency threshold 2 (Flim2). Unit = Hz. Typical value
= 0.
flim3:
slot_uri: cim:GovCT2.flim3
range: Frequency
required: false
multivalued: false
description: Frequency threshold 3 (Flim3). Unit = Hz. Typical value
= 0.
flim4:
slot_uri: cim:GovCT2.flim4
range: Frequency
required: false
multivalued: false
description: Frequency threshold 4 (Flim4). Unit = Hz. Typical value
= 0.
flim5:
slot_uri: cim:GovCT2.flim5
range: Frequency
required: false
multivalued: false
description: Frequency threshold 5 (Flim5). Unit = Hz. Typical value
= 0.
flim6:
slot_uri: cim:GovCT2.flim6
range: Frequency
required: false
multivalued: false
description: Frequency threshold 6 (Flim6). Unit = Hz. Typical value
= 0.
flim7:
slot_uri: cim:GovCT2.flim7
range: Frequency
required: false
multivalued: false
description: Frequency threshold 7 (Flim7). Unit = Hz. Typical value
= 0.
flim8:
slot_uri: cim:GovCT2.flim8
range: Frequency
required: false
multivalued: false
description: Frequency threshold 8 (Flim8). Unit = Hz. Typical value
= 0.
flim9:
slot_uri: cim:GovCT2.flim9
range: Frequency
required: false
multivalued: false
description: Frequency threshold 9 (Flim9). Unit = Hz. Typical value
= 0.
ka:
slot_uri: cim:GovCT2.ka
range: PU
required: false
multivalued: false
description: Acceleration limiter gain (Ka). Typical value = 10.
kdgov:
slot_uri: cim:GovCT2.kdgov
range: PU
required: false
multivalued: false
description: Governor derivative gain (Kdgov). Typical value = 0.
kigov:
slot_uri: cim:GovCT2.kigov
range: PU
required: false
multivalued: false
description: Governor integral gain (Kigov). Typical value = 0,45.
kiload:
slot_uri: cim:GovCT2.kiload
range: PU
required: false
multivalued: false
description: Load limiter integral gain for PI controller (Kiload). Typical
value = 1.
kimw:
slot_uri: cim:GovCT2.kimw
range: PU
required: false
multivalued: false
description: Power controller (reset) gain (Kimw). The default value
of 0,01 corresponds to a reset time of 100 seconds. A value of 0,001 corresponds
to a relatively slow-acting load controller. Typical value = 0.
kpgov:
slot_uri: cim:GovCT2.kpgov
range: PU
required: false
multivalued: false
description: Governor proportional gain (Kpgov). Typical value = 4.
kpload:
slot_uri: cim:GovCT2.kpload
range: PU
required: false
multivalued: false
description: Load limiter proportional gain for PI controller (Kpload). Typical
value = 1.
kturb:
slot_uri: cim:GovCT2.kturb
range: PU
required: false
multivalued: false
description: Turbine gain (Kturb). Typical value = 1,9168.
ldref:
slot_uri: cim:GovCT2.ldref
range: PU
required: false
multivalued: false
description: Load limiter reference value (Ldref). Typical value =
1.
maxerr:
slot_uri: cim:GovCT2.maxerr
range: PU
required: false
multivalued: false
description: Maximum value for speed error signal (Maxerr) (> GovCT2.minerr). Typical
value = 1.
minerr:
slot_uri: cim:GovCT2.minerr
range: PU
required: false
multivalued: false
description: Minimum value for speed error signal (Minerr) (< GovCT2.maxerr). Typical
value = -1.
mwbase:
slot_uri: cim:GovCT2.mwbase
range: ActivePower
required: false
multivalued: false
description: Base for power values (MWbase) (> 0). Unit = MW.
plim1:
slot_uri: cim:GovCT2.plim1
range: PU
required: false
multivalued: false
description: Power limit 1 (Plim1). Typical value = 0,8325.
plim10:
slot_uri: cim:GovCT2.plim10
range: PU
required: false
multivalued: false
description: Power limit 10 (Plim10). Typical value = 0.
plim2:
slot_uri: cim:GovCT2.plim2
range: PU
required: false
multivalued: false
description: Power limit 2 (Plim2). Typical value = 0.
plim3:
slot_uri: cim:GovCT2.plim3
range: PU
required: false
multivalued: false
description: Power limit 3 (Plim3). Typical value = 0.
plim4:
slot_uri: cim:GovCT2.plim4
range: PU
required: false
multivalued: false
description: Power limit 4 (Plim4). Typical value = 0.
plim5:
slot_uri: cim:GovCT2.plim5
range: PU
required: false
multivalued: false
description: Power limit 5 (Plim5). Typical value = 0.
plim6:
slot_uri: cim:GovCT2.plim6
range: PU
required: false
multivalued: false
description: Power limit 6 (Plim6). Typical value = 0.
plim7:
slot_uri: cim:GovCT2.plim7
range: PU
required: false
multivalued: false
description: Power limit 7 (Plim7). Typical value = 0.
plim8:
slot_uri: cim:GovCT2.plim8
range: PU
required: false
multivalued: false
description: Power limit 8 (Plim8). Typical value = 0.
plim9:
slot_uri: cim:GovCT2.plim9
range: PU
required: false
multivalued: false
description: Power Limit 9 (Plim9). Typical value = 0.
prate:
slot_uri: cim:GovCT2.prate
range: PU
required: false
multivalued: false
description: Ramp rate for frequency-dependent power limit (Prate). Typical
value = 0,017.
r:
slot_uri: cim:GovCT2.r
range: PU
required: false
multivalued: false
description: Permanent droop (R). Typical value = 0,05.
rclose:
slot_uri: cim:GovCT2.rclose
range: float
required: false
multivalued: false
description: Minimum valve closing rate (Rclose). Unit = PU / s. Typical
value = -99.
rdown:
slot_uri: cim:GovCT2.rdown
range: PU
required: false
multivalued: false
description: Maximum rate of load limit decrease (Rdown). Typical
value = -99.
ropen:
slot_uri: cim:GovCT2.ropen
range: float
required: false
multivalued: false
description: Maximum valve opening rate (Ropen). Unit = PU / s. Typical
value = 99.
rselect:
slot_uri: cim:GovCT2.rselect
range: DroopSignalFeedbackKind
required: false
multivalued: false
description: Feedback signal for droop (Rselect). Typical value =
electricalPower.
rup:
slot_uri: cim:GovCT2.rup
range: PU
required: false
multivalued: false
description: Maximum rate of load limit increase (Rup). Typical value
= 99.
ta:
slot_uri: cim:GovCT2.ta
range: Seconds
required: false
multivalued: false
description: Acceleration limiter time constant (Ta) (>= 0). Typical
value = 1.
tact:
slot_uri: cim:GovCT2.tact
range: Seconds
required: false
multivalued: false
description: Actuator time constant (Tact) (>= 0). Typical value
= 0,4.
tb:
slot_uri: cim:GovCT2.tb
range: Seconds
required: false
multivalued: false
description: Turbine lag time constant (Tb) (>= 0). Typical value
= 0,1.
tc:
slot_uri: cim:GovCT2.tc
range: Seconds
required: false
multivalued: false
description: Turbine lead time constant (Tc) (>= 0). Typical value
= 0.
tdgov:
slot_uri: cim:GovCT2.tdgov
range: Seconds
required: false
multivalued: false
description: Governor derivative controller time constant (Tdgov) (>=
0). Typical value = 1.
teng:
slot_uri: cim:GovCT2.teng
range: Seconds
required: false
multivalued: false
description: Transport time delay for diesel engine used in representing diesel
engines where there is a small but measurable transport delay between a
change in fuel flow setting and the development of torque (Teng)
(>= 0). Teng should be zero in all but special cases where this
transport delay is of particular concern. Typical value = 0.
tfload:
slot_uri: cim:GovCT2.tfload
range: Seconds
required: false
multivalued: false
description: Load limiter time constant (Tfload) (>= 0). Typical
value = 3.
tpelec:
slot_uri: cim:GovCT2.tpelec
range: Seconds
required: false
multivalued: false
description: Electrical power transducer time constant (Tpelec) (>=
0). Typical value = 2,5.
tsa:
slot_uri: cim:GovCT2.tsa
range: Seconds
required: false
multivalued: false
description: Temperature detection lead time constant (Tsa) (>=
0). Typical value = 0.
tsb:
slot_uri: cim:GovCT2.tsb
range: Seconds
required: false
multivalued: false
description: Temperature detection lag time constant (Tsb) (>= 0). Typical
value = 50.
vmax:
slot_uri: cim:GovCT2.vmax
range: PU
required: false
multivalued: false
description: Maximum valve position limit (Vmax) (> GovCT2.vmin). Typical
value = 1.
vmin:
slot_uri: cim:GovCT2.vmin
range: PU
required: false
multivalued: false
description: Minimum valve position limit (Vmin) (< GovCT2.vmax). Typical
value = 0,175.
wfnl:
slot_uri: cim:GovCT2.wfnl
range: PU
required: false
multivalued: false
description: No load fuel flow (Wfnl). Typical value = 0,187.
wfspd:
slot_uri: cim:GovCT2.wfspd
range: boolean
required: false
multivalued: false
description: "Switch for fuel source characteristic to recognize that fuel\
\ flow, for a given fuel valve stroke, can be proportional to engine speed\
\ (Wfspd).\r\ntrue = fuel flow proportional to speed (for some gas\
\ turbines and diesel engines with positive displacement fuel injectors)\r\
\nfalse = fuel control system keeps fuel flow independent of engine speed.\r\
\nTypical value = false."
GovGAST:
class_uri: cim:GovGAST
is_a: TurbineGovernorDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.TurbineGovernorDynamics
description: Single shaft gas turbine.
attributes:
at:
slot_uri: cim:GovGAST.at
range: PU
required: false
multivalued: false
description: Ambient temperature load limit (Load Limit). Typical
value = 1.
dturb:
slot_uri: cim:GovGAST.dturb
range: PU
required: false
multivalued: false
description: Turbine damping factor (Dturb). Typical value = 0,18.
kt:
slot_uri: cim:GovGAST.kt
range: PU
required: false
multivalued: false
description: Temperature limiter gain (Kt). Typical value = 3.
mwbase:
slot_uri: cim:GovGAST.mwbase
range: ActivePower
required: false
multivalued: false
description: Base for power values (MWbase) (> 0). Unit = MW.
r:
slot_uri: cim:GovGAST.r
range: PU
required: false
multivalued: false
description: Permanent droop (R) (>0). Typical value = 0,04.
t1:
slot_uri: cim:GovGAST.t1
range: Seconds
required: false
multivalued: false
description: Governor mechanism time constant (T1) (>= 0). T1
represents the natural valve positioning time constant of the governor for
small disturbances, as seen when rate limiting is not in effect. Typical
value = 0,5.
t2:
slot_uri: cim:GovGAST.t2
range: Seconds
required: false
multivalued: false
description: Turbine power time constant (T2) (>= 0). T2
represents delay due to internal energy storage of the gas turbine engine.
T2 can be used to give a rough approximation to the delay associated
with acceleration of the compressor spool of a multi-shaft engine, or with
the compressibility of gas in the plenum of a free power turbine of an aero-derivative
unit, for example. Typical value = 0,5.
t3:
slot_uri: cim:GovGAST.t3
range: Seconds
required: false
multivalued: false
description: Turbine exhaust temperature time constant (T3) (>=
0). Typical value = 3.
vmax:
slot_uri: cim:GovGAST.vmax
range: PU
required: false
multivalued: false
description: Maximum turbine power, PU of MWbase (Vmax) (> GovGAST.vmin). Typical
value = 1.
vmin:
slot_uri: cim:GovGAST.vmin
range: PU
required: false
multivalued: false
description: Minimum turbine power, PU of MWbase (Vmin) (< GovGAST.vmax). Typical
value = 0.
GovGAST1:
class_uri: cim:GovGAST1
is_a: TurbineGovernorDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.TurbineGovernorDynamics
description: Modified single shaft gas turbine.
attributes:
a:
slot_uri: cim:GovGAST1.a
range: float
required: false
multivalued: false
description: Turbine power time constant numerator scale factor (a). Typical
value = 0,8.
b:
slot_uri: cim:GovGAST1.b
range: float
required: false
multivalued: false
description: Turbine power time constant denominator scale factor (b)
(>0). Typical value = 1.
db1:
slot_uri: cim:GovGAST1.db1
range: Frequency
required: false
multivalued: false
description: Intentional dead-band width (db1). Unit = Hz. Typical
value = 0.
db2:
slot_uri: cim:GovGAST1.db2
range: ActivePower
required: false
multivalued: false
description: Unintentional dead-band (db2). Unit = MW. Typical value
= 0.
eps:
slot_uri: cim:GovGAST1.eps
range: Frequency
required: false
multivalued: false
description: Intentional db hysteresis (eps). Unit = Hz. Typical
value = 0.
fidle:
slot_uri: cim:GovGAST1.fidle
range: PU
required: false
multivalued: false
description: Fuel flow at zero power output (Fidle). Typical value
= 0,18.
gv1:
slot_uri: cim:GovGAST1.gv1
range: PU
required: false
multivalued: false
description: Nonlinear gain point 1, PU gv (Gv1). Typical value =
0.
gv2:
slot_uri: cim:GovGAST1.gv2
range: PU
required: false
multivalued: false
description: Nonlinear gain point 2,PU gv (Gv2). Typical value = 0.
gv3:
slot_uri: cim:GovGAST1.gv3
range: PU
required: false
multivalued: false
description: Nonlinear gain point 3, PU gv (Gv3). Typical value =
0.
gv4:
slot_uri: cim:GovGAST1.gv4
range: PU
required: false
multivalued: false
description: Nonlinear gain point 4, PU gv (Gv4). Typical value =
0.
gv5:
slot_uri: cim:GovGAST1.gv5
range: PU
required: false
multivalued: false
description: Nonlinear gain point 5, PU gv (Gv5). Typical value =
0.
gv6:
slot_uri: cim:GovGAST1.gv6
range: PU
required: false
multivalued: false
description: Nonlinear gain point 6, PU gv (Gv6). Typical value =
0.
ka:
slot_uri: cim:GovGAST1.ka
range: PU
required: false
multivalued: false
description: Governor gain (Ka). Typical value = 0.
kt:
slot_uri: cim:GovGAST1.kt
range: PU
required: false
multivalued: false
description: Temperature limiter gain (Kt). Typical value = 3.
lmax:
slot_uri: cim:GovGAST1.lmax
range: PU
required: false
multivalued: false
description: Ambient temperature load limit (Lmax). Lmax is
the turbine power output corresponding to the limiting exhaust gas temperature. Typical
value = 1.
loadinc:
slot_uri: cim:GovGAST1.loadinc
range: PU
required: false
multivalued: false
description: Valve position change allowed at fast rate (Loadinc). Typical
value = 0,05.
ltrate:
slot_uri: cim:GovGAST1.ltrate
range: float
required: false
multivalued: false
description: Maximum long term fuel valve opening rate (Ltrate). Typical
value = 0,02.
mwbase:
slot_uri: cim:GovGAST1.mwbase
range: ActivePower
required: false
multivalued: false
description: Base for power values (MWbase) (> 0). Unit = MW.
pgv1:
slot_uri: cim:GovGAST1.pgv1
range: PU
required: false
multivalued: false
description: Nonlinear gain point 1, PU power (Pgv1). Typical value
= 0.
pgv2:
slot_uri: cim:GovGAST1.pgv2
range: PU
required: false
multivalued: false
description: Nonlinear gain point 2, PU power (Pgv2). Typical value
= 0.
pgv3:
slot_uri: cim:GovGAST1.pgv3
range: PU
required: false
multivalued: false
description: Nonlinear gain point 3, PU power (Pgv3). Typical value
= 0.
pgv4:
slot_uri: cim:GovGAST1.pgv4
range: PU
required: false
multivalued: false
description: Nonlinear gain point 4, PU power (Pgv4). Typical value
= 0.
pgv5:
slot_uri: cim:GovGAST1.pgv5
range: PU
required: false
multivalued: false
description: Nonlinear gain point 5, PU power (Pgv5). Typical value
= 0.
pgv6:
slot_uri: cim:GovGAST1.pgv6
range: PU
required: false
multivalued: false
description: Nonlinear gain point 6, PU power (Pgv6). Typical value
= 0.
r:
slot_uri: cim:GovGAST1.r
range: PU
required: false
multivalued: false
description: Permanent droop (R) (>0). Typical value = 0,04.
rmax:
slot_uri: cim:GovGAST1.rmax
range: float
required: false
multivalued: false
description: Maximum fuel valve opening rate (Rmax). Unit = PU / s. Typical
value = 1.
t1:
slot_uri: cim:GovGAST1.t1
range: Seconds
required: false
multivalued: false
description: Governor mechanism time constant (T1) (>= 0). T1
represents the natural valve positioning time constant of the governor for
small disturbances, as seen when rate limiting is not in effect. Typical
value = 0,5.
t2:
slot_uri: cim:GovGAST1.t2
range: Seconds
required: false
multivalued: false
description: Turbine power time constant (T2) (>= 0). T2
represents delay due to internal energy storage of the gas turbine engine.
T2 can be used to give a rough approximation to the delay associated
with acceleration of the compressor spool of a multi-shaft engine, or with
the compressibility of gas in the plenum of the free power turbine of an
aero-derivative unit, for example. Typical value = 0,5.
t3:
slot_uri: cim:GovGAST1.t3
range: Seconds
required: false
multivalued: false
description: Turbine exhaust temperature time constant (T3) (>=
0). T3 represents delay in the exhaust temperature and load limiting
system. Typical value = 3.
t4:
slot_uri: cim:GovGAST1.t4
range: Seconds
required: false
multivalued: false
description: Governor lead time constant (T4) (>= 0). Typical value
= 0.
t5:
slot_uri: cim:GovGAST1.t5
range: Seconds
required: false
multivalued: false
description: Governor lag time constant (T5) (>= 0). If = 0, entire
gain and lead-lag block is bypassed. Typical value = 0.
tltr:
slot_uri: cim:GovGAST1.tltr
range: Seconds
required: false
multivalued: false
description: Valve position averaging time constant (Tltr) (>= 0). Typical
value = 10.
vmax:
slot_uri: cim:GovGAST1.vmax
range: PU
required: false
multivalued: false
description: Maximum turbine power, PU of MWbase (Vmax) (> GovGAST1.vmin). Typical
value = 1.
vmin:
slot_uri: cim:GovGAST1.vmin
range: PU
required: false
multivalued: false
description: Minimum turbine power, PU of MWbase (Vmin) (< GovGAST1.vmax). Typical
value = 0.
GovGAST2:
class_uri: cim:GovGAST2
is_a: TurbineGovernorDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.TurbineGovernorDynamics
description: Gas turbine.
attributes:
a:
slot_uri: cim:GovGAST2.a
range: float
required: false
multivalued: false
description: Valve positioner (A).
af1:
slot_uri: cim:GovGAST2.af1
range: PU
required: false
multivalued: false
description: Exhaust temperature parameter (Af1). Unit = PU temperature. Based
on temperature in degrees C.
af2:
slot_uri: cim:GovGAST2.af2
range: PU
required: false
multivalued: false
description: Coefficient equal to 0,5(1-speed) (Af2).
b:
slot_uri: cim:GovGAST2.b
range: float
required: false
multivalued: false
description: 'Valve positioner (B). '
bf1:
slot_uri: cim:GovGAST2.bf1
range: PU
required: false
multivalued: false
description: (Bf1). Bf1 = E(1 - W) where E
(speed sensitivity coefficient) is 0,55 to 0,65 x Tr. Unit = PU
temperature. Based on temperature in degrees C.
bf2:
slot_uri: cim:GovGAST2.bf2
range: PU
required: false
multivalued: false
description: Turbine torque coefficient Khhv (depends on heating
value of fuel stream in combustion chamber) (Bf2).
c:
slot_uri: cim:GovGAST2.c
range: float
required: false
multivalued: false
description: 'Valve positioner (C). '
cf2:
slot_uri: cim:GovGAST2.cf2
range: PU
required: false
multivalued: false
description: Coefficient defining fuel flow where power output is 0% (Cf2). Synchronous
but no output. Typically 0,23 x Khhv (23% fuel flow).
ecr:
slot_uri: cim:GovGAST2.ecr
range: Seconds
required: false
multivalued: false
description: Combustion reaction time delay (Ecr) (>= 0).
etd:
slot_uri: cim:GovGAST2.etd
range: Seconds
required: false
multivalued: false
description: Turbine and exhaust delay (Etd) (>= 0).
k3:
slot_uri: cim:GovGAST2.k3
range: PU
required: false
multivalued: false
description: Ratio of fuel adjustment (K3).
k4:
slot_uri: cim:GovGAST2.k4
range: PU
required: false
multivalued: false
description: Gain of radiation shield (K4).
k5:
slot_uri: cim:GovGAST2.k5
range: PU
required: false
multivalued: false
description: Gain of radiation shield (K5).
k6:
slot_uri: cim:GovGAST2.k6
range: PU
required: false
multivalued: false
description: 'Minimum fuel flow (K6). '
kf:
slot_uri: cim:GovGAST2.kf
range: PU
required: false
multivalued: false
description: Fuel system feedback (Kf).
mwbase:
slot_uri: cim:GovGAST2.mwbase
range: ActivePower
required: false
multivalued: false
description: Base for power values (MWbase) (> 0). Unit = MW.
t:
slot_uri: cim:GovGAST2.t
range: Seconds
required: false
multivalued: false
description: Fuel control time constant (T) (>= 0).
t3:
slot_uri: cim:GovGAST2.t3
range: Seconds
required: false
multivalued: false
description: Radiation shield time constant (T3) (>= 0).
t4:
slot_uri: cim:GovGAST2.t4
range: Seconds
required: false
multivalued: false
description: Thermocouple time constant (T4) (>= 0).
t5:
slot_uri: cim:GovGAST2.t5
range: Seconds
required: false
multivalued: false
description: Temperature control time constant (T5) (>= 0).
tc:
slot_uri: cim:GovGAST2.tc
range: Temperature
required: false
multivalued: false
description: "Temperature control (Tc). Unit = \xB0F or \xB0C depending\
\ on parameters Af1 and Bf1. "
tcd:
slot_uri: cim:GovGAST2.tcd
range: Seconds
required: false
multivalued: false
description: Compressor discharge time constant (Tcd) (>= 0).
tf:
slot_uri: cim:GovGAST2.tf
range: Seconds
required: false
multivalued: false
description: Fuel system time constant (Tf) (>= 0).
tmax:
slot_uri: cim:GovGAST2.tmax
range: PU
required: false
multivalued: false
description: Maximum turbine limit (Tmax) (> GovGAST2.tmin).
tmin:
slot_uri: cim:GovGAST2.tmin
range: PU
required: false
multivalued: false
description: Minimum turbine limit (Tmin) (< GovGAST2.tmax).
tr:
slot_uri: cim:GovGAST2.tr
range: Temperature
required: false
multivalued: false
description: "Rated temperature (Tr). Unit = \xB0C depending on parameters\
\ Af1 and Bf1."
trate:
slot_uri: cim:GovGAST2.trate
range: ActivePower
required: false
multivalued: false
description: Turbine rating (Trate). Unit = MW.
tt:
slot_uri: cim:GovGAST2.tt
range: Seconds
required: false
multivalued: false
description: Temperature controller integration rate (Tt) (>= 0).
w:
slot_uri: cim:GovGAST2.w
range: PU
required: false
multivalued: false
description: Governor gain (1/droop) on turbine rating (W).
x:
slot_uri: cim:GovGAST2.x
range: Seconds
required: false
multivalued: false
description: Governor lead time constant (X) (>= 0).
y:
slot_uri: cim:GovGAST2.y
range: Seconds
required: false
multivalued: false
description: Governor lag time constant (Y) (> 0).
z:
slot_uri: cim:GovGAST2.z
range: integer
required: false
multivalued: false
description: "Governor mode (Z).\r\n1 = droop\r\n0 = isochronous."
GovGAST3:
class_uri: cim:GovGAST3
is_a: TurbineGovernorDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.TurbineGovernorDynamics
description: Generic turbogas with acceleration and temperature controller.
attributes:
bca:
slot_uri: cim:GovGAST3.bca
range: float
required: false
multivalued: false
description: Acceleration limit set-point (Bca). Unit = 1/s. Typical
value = 0,01.
bp:
slot_uri: cim:GovGAST3.bp
range: PU
required: false
multivalued: false
description: Droop (bp). Typical value = 0,05.
dtc:
slot_uri: cim:GovGAST3.dtc
range: Temperature
required: false
multivalued: false
description: Exhaust temperature variation due to fuel flow increasing from
0 to 1 PU (deltaTc). Typical value = 390.
ka:
slot_uri: cim:GovGAST3.ka
range: PU
required: false
multivalued: false
description: Minimum fuel flow (Ka). Typical value = 0,23.
kac:
slot_uri: cim:GovGAST3.kac
range: float
required: false
multivalued: false
description: Fuel system feedback (KAC). Typical
value = 0.
kca:
slot_uri: cim:GovGAST3.kca
range: float
required: false
multivalued: false
description: Acceleration control integral gain (Kca). Unit = 1/s. Typical
value = 100.
ksi:
slot_uri: cim:GovGAST3.ksi
range: float
required: false
multivalued: false
description: Gain of radiation shield (Ksi). Typical value = 0,8.
ky:
slot_uri: cim:GovGAST3.ky
range: float
required: false
multivalued: false
description: Coefficient of transfer function of fuel valve positioner (Ky). Typical
value = 1.
mnef:
slot_uri: cim:GovGAST3.mnef
range: PU
required: false
multivalued: false
description: Fuel flow maximum negative error value (MNef). Typical
value = -0,05.
mxef:
slot_uri: cim:GovGAST3.mxef
range: PU
required: false
multivalued: false
description: Fuel flow maximum positive error value (MXef). Typical
value = 0,05.
rcmn:
slot_uri: cim:GovGAST3.rcmn
range: PU
required: false
multivalued: false
description: Minimum fuel flow (RCMN). Typical value = -0,1.
rcmx:
slot_uri: cim:GovGAST3.rcmx
range: PU
required: false
multivalued: false
description: Maximum fuel flow (RCMX). Typical value = 1.
tac:
slot_uri: cim:GovGAST3.tac
range: Seconds
required: false
multivalued: false
description: Fuel control time constant (Tac) (>= 0). Typical value
= 0,1.
tc:
slot_uri: cim:GovGAST3.tc
range: Seconds
required: false
multivalued: false
description: Compressor discharge volume time constant (Tc) (>=
0). Typical value = 0,2.
td:
slot_uri: cim:GovGAST3.td
range: Seconds
required: false
multivalued: false
description: Temperature controller derivative gain (Td) (>= 0). Typical
value = 3,3.
tfen:
slot_uri: cim:GovGAST3.tfen
range: Temperature
required: false
multivalued: false
description: Turbine rated exhaust temperature correspondent to Pm=1 PU (Tfen). Typical
value = 540.
tg:
slot_uri: cim:GovGAST3.tg
range: Seconds
required: false
multivalued: false
description: Time constant of speed governor (Tg) (>= 0). Typical
value = 0,05.
tsi:
slot_uri: cim:GovGAST3.tsi
range: Seconds
required: false
multivalued: false
description: Time constant of radiation shield (Tsi) (>= 0). Typical
value = 15.
tt:
slot_uri: cim:GovGAST3.tt
range: Temperature
required: false
multivalued: false
description: Temperature controller integration rate (Tt). Typical
value = 250.
ttc:
slot_uri: cim:GovGAST3.ttc
range: Seconds
required: false
multivalued: false
description: Time constant of thermocouple (Ttc) (>= 0). Typical
value = 2,5.
ty:
slot_uri: cim:GovGAST3.ty
range: Seconds
required: false
multivalued: false
description: Time constant of fuel valve positioner (Ty) (>= 0). Typical
value = 0,2.
GovGAST4:
class_uri: cim:GovGAST4
is_a: TurbineGovernorDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.TurbineGovernorDynamics
description: Generic turbogas.
attributes:
bp:
slot_uri: cim:GovGAST4.bp
range: PU
required: false
multivalued: false
description: Droop (bp). Typical value = 0,05.
ktm:
slot_uri: cim:GovGAST4.ktm
range: PU
required: false
multivalued: false
description: Compressor gain (Ktm). Typical value = 0.
mnef:
slot_uri: cim:GovGAST4.mnef
range: PU
required: false
multivalued: false
description: Fuel flow maximum negative error value (MNef). Typical
value = -0,05.
mxef:
slot_uri: cim:GovGAST4.mxef
range: PU
required: false
multivalued: false
description: Fuel flow maximum positive error value (MXef). Typical
value = 0,05.
rymn:
slot_uri: cim:GovGAST4.rymn
range: PU
required: false
multivalued: false
description: Minimum valve opening (RYMN). Typical value = 0.
rymx:
slot_uri: cim:GovGAST4.rymx
range: PU
required: false
multivalued: false
description: Maximum valve opening (RYMX). Typical value = 1,1.
ta:
slot_uri: cim:GovGAST4.ta
range: Seconds
required: false
multivalued: false
description: Maximum gate opening velocity (TA) (>= 0). Typical
value = 3.
tc:
slot_uri: cim:GovGAST4.tc
range: Seconds
required: false
multivalued: false
description: Maximum gate closing velocity (TC) (>= 0). Typical
value = 0,5.
tcm:
slot_uri: cim:GovGAST4.tcm
range: Seconds
required: false
multivalued: false
description: Fuel control time constant (Tcm) (>= 0). Typical value
= 0,1.
tm:
slot_uri: cim:GovGAST4.tm
range: Seconds
required: false
multivalued: false
description: Compressor discharge volume time constant (Tm) (>=
0). Typical value = 0,2.
ty:
slot_uri: cim:GovGAST4.ty
range: Seconds
required: false
multivalued: false
description: Time constant of fuel valve positioner (Ty) (>= 0). Typical
value = 0,1.
GovGASTWD:
class_uri: cim:GovGASTWD
is_a: TurbineGovernorDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.TurbineGovernorDynamics
description: "Woodward\u2122 gas turbine governor. \r\n[Footnote: Woodward gas\
\ turbines are an example of suitable products available commercially. This\
\ information is given for the convenience of users of this document and does\
\ not constitute an endorsement by IEC of these products.] \r\n\r\n"
attributes:
a:
slot_uri: cim:GovGASTWD.a
range: float
required: false
multivalued: false
description: Valve positioner (A).
af1:
slot_uri: cim:GovGASTWD.af1
range: PU
required: false
multivalued: false
description: Exhaust temperature parameter (Af1).
af2:
slot_uri: cim:GovGASTWD.af2
range: PU
required: false
multivalued: false
description: Coefficient equal to 0,5(1-speed) (Af2).
b:
slot_uri: cim:GovGASTWD.b
range: float
required: false
multivalued: false
description: 'Valve positioner (B). '
bf1:
slot_uri: cim:GovGASTWD.bf1
range: PU
required: false
multivalued: false
description: (Bf1). Bf1 = E(1-w) where E
(speed sensitivity coefficient) is 0,55 to 0,65 x Tr.
bf2:
slot_uri: cim:GovGASTWD.bf2
range: PU
required: false
multivalued: false
description: Turbine torque coefficient Khhv (depends on heating
value of fuel stream in combustion chamber) (Bf2).
c:
slot_uri: cim:GovGASTWD.c
range: float
required: false
multivalued: false
description: 'Valve positioner (C). '
cf2:
slot_uri: cim:GovGASTWD.cf2
range: PU
required: false
multivalued: false
description: Coefficient defining fuel flow where power output is 0 % (Cf2). Synchronous
but no output. Typically 0,23 x Khhv (23 % fuel flow).
ecr:
slot_uri: cim:GovGASTWD.ecr
range: Seconds
required: false
multivalued: false
description: Combustion reaction time delay (Ecr) (>= 0).
etd:
slot_uri: cim:GovGASTWD.etd
range: Seconds
required: false
multivalued: false
description: Turbine and exhaust delay (Etd) (>= 0).
k3:
slot_uri: cim:GovGASTWD.k3
range: PU
required: false
multivalued: false
description: Ratio of fuel adjustment (K3).
k4:
slot_uri: cim:GovGASTWD.k4
range: PU
required: false
multivalued: false
description: Gain of radiation shield (K4).
k5:
slot_uri: cim:GovGASTWD.k5
range: PU
required: false
multivalued: false
description: Gain of radiation shield (K5).
k6:
slot_uri: cim:GovGASTWD.k6
range: PU
required: false
multivalued: false
description: 'Minimum fuel flow (K6). '
kd:
slot_uri: cim:GovGASTWD.kd
range: PU
required: false
multivalued: false
description: Drop governor gain (Kd).
kdroop:
slot_uri: cim:GovGASTWD.kdroop
range: PU
required: false
multivalued: false
description: (Kdroop) (>= 0).
kf:
slot_uri: cim:GovGASTWD.kf
range: PU
required: false
multivalued: false
description: Fuel system feedback (Kf).
ki:
slot_uri: cim:GovGASTWD.ki
range: PU
required: false
multivalued: false
description: Isochronous Governor Gain (Ki).
kp:
slot_uri: cim:GovGASTWD.kp
range: PU
required: false
multivalued: false
description: PID proportional gain (Kp).
mwbase:
slot_uri: cim:GovGASTWD.mwbase
range: ActivePower
required: false
multivalued: false
description: Base for power values (MWbase) (> 0). Unit = MW.
t:
slot_uri: cim:GovGASTWD.t
range: Seconds
required: false
multivalued: false
description: Fuel control time constant (T) (>= 0).
t3:
slot_uri: cim:GovGASTWD.t3
range: Seconds
required: false
multivalued: false
description: Radiation shield time constant (T3) (>= 0).
t4:
slot_uri: cim:GovGASTWD.t4
range: Seconds
required: false
multivalued: false
description: Thermocouple time constant (T4) (>= 0).
t5:
slot_uri: cim:GovGASTWD.t5
range: Seconds
required: false
multivalued: false
description: Temperature control time constant (T5) (>= 0).
tc:
slot_uri: cim:GovGASTWD.tc
range: Temperature
required: false
multivalued: false
description: Temperature control (Tc).
tcd:
slot_uri: cim:GovGASTWD.tcd
range: Seconds
required: false
multivalued: false
description: Compressor discharge time constant (Tcd) (>= 0).
td:
slot_uri: cim:GovGASTWD.td
range: Seconds
required: false
multivalued: false
description: Power transducer time constant (Td) (>= 0).
tf:
slot_uri: cim:GovGASTWD.tf
range: Seconds
required: false
multivalued: false
description: Fuel system time constant (Tf) (>= 0).
tmax:
slot_uri: cim:GovGASTWD.tmax
range: PU
required: false
multivalued: false
description: Maximum Turbine limit (Tmax) (> GovGASTWD.tmin).
tmin:
slot_uri: cim:GovGASTWD.tmin
range: PU
required: false
multivalued: false
description: Minimum turbine limit (Tmin) (< GovGASTWD.tmax).
tr:
slot_uri: cim:GovGASTWD.tr
range: Temperature
required: false
multivalued: false
description: Rated temperature (Tr).
trate:
slot_uri: cim:GovGASTWD.trate
range: ActivePower
required: false
multivalued: false
description: Turbine rating (Trate). Unit = MW.
tt:
slot_uri: cim:GovGASTWD.tt
range: Seconds
required: false
multivalued: false
description: Temperature controller integration rate (Tt) (>= 0).
GovHydro1:
class_uri: cim:GovHydro1
is_a: TurbineGovernorDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.TurbineGovernorDynamics
description: Basic hydro turbine governor.
attributes:
at:
slot_uri: cim:GovHydro1.at
range: PU
required: false
multivalued: false
description: Turbine gain (At) (> 0). Typical value = 1,2.
dturb:
slot_uri: cim:GovHydro1.dturb
range: PU
required: false
multivalued: false
description: Turbine damping factor (Dturb) (>= 0). Typical value
= 0,5.
gmax:
slot_uri: cim:GovHydro1.gmax
range: PU
required: false
multivalued: false
description: Maximum gate opening (Gmax) (> 0 and > GovHydro.gmin). Typical
value = 1.
gmin:
slot_uri: cim:GovHydro1.gmin
range: PU
required: false
multivalued: false
description: Minimum gate opening (Gmin) (>= 0 and < GovHydro1.gmax). Typical
value = 0.
hdam:
slot_uri: cim:GovHydro1.hdam
range: PU
required: false
multivalued: false
description: Turbine nominal head (hdam). Typical value = 1.
mwbase:
slot_uri: cim:GovHydro1.mwbase
range: ActivePower
required: false
multivalued: false
description: Base for power values (MWbase) (> 0). Unit = MW.
qnl:
slot_uri: cim:GovHydro1.qnl
range: PU
required: false
multivalued: false
description: No-load flow at nominal head (qnl) (>= 0). Typical
value = 0,08.
rperm:
slot_uri: cim:GovHydro1.rperm
range: PU
required: false
multivalued: false
description: Permanent droop (R) (> 0). Typical value = 0,04.
rtemp:
slot_uri: cim:GovHydro1.rtemp
range: PU
required: false
multivalued: false
description: Temporary droop (r) (> GovHydro1.rperm). Typical value
= 0,3.
tf:
slot_uri: cim:GovHydro1.tf
range: Seconds
required: false
multivalued: false
description: Filter time constant (Tf) (> 0). Typical value = 0,05.
tg:
slot_uri: cim:GovHydro1.tg
range: Seconds
required: false
multivalued: false
description: Gate servo time constant (Tg) (> 0). Typical value
= 0,5.
tr:
slot_uri: cim:GovHydro1.tr
range: Seconds
required: false
multivalued: false
description: Washout time constant (Tr) (> 0). Typical value =
5.
tw:
slot_uri: cim:GovHydro1.tw
range: Seconds
required: false
multivalued: false
description: Water inertia time constant (Tw) (> 0). Typical value
= 1.
velm:
slot_uri: cim:GovHydro1.velm
range: float
required: false
multivalued: false
description: Maximum gate velocity (Vlem) (> 0). Typical value
= 0,2.
GovHydro2:
class_uri: cim:GovHydro2
is_a: TurbineGovernorDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.TurbineGovernorDynamics
description: IEEE hydro turbine governor with straightforward penstock configuration
and hydraulic-dashpot governor.
attributes:
aturb:
slot_uri: cim:GovHydro2.aturb
range: PU
required: false
multivalued: false
description: Turbine numerator multiplier (Aturb). Typical value =
-1.
bturb:
slot_uri: cim:GovHydro2.bturb
range: PU
required: false
multivalued: false
description: Turbine denominator multiplier (Bturb) (> 0). Typical
value = 0,5.
db1:
slot_uri: cim:GovHydro2.db1
range: Frequency
required: false
multivalued: false
description: Intentional deadband width (db1). Unit = Hz. Typical
value = 0.
db2:
slot_uri: cim:GovHydro2.db2
range: ActivePower
required: false
multivalued: false
description: Unintentional deadband (db2). Unit = MW. Typical value
= 0.
eps:
slot_uri: cim:GovHydro2.eps
range: Frequency
required: false
multivalued: false
description: Intentional db hysteresis (eps). Unit = Hz. Typical
value = 0.
gv1:
slot_uri: cim:GovHydro2.gv1
range: PU
required: false
multivalued: false
description: Nonlinear gain point 1, PU gv (Gv1). Typical value =
0.
gv2:
slot_uri: cim:GovHydro2.gv2
range: PU
required: false
multivalued: false
description: Nonlinear gain point 2, PU gv (Gv2). Typical value =
0.
gv3:
slot_uri: cim:GovHydro2.gv3
range: PU
required: false
multivalued: false
description: Nonlinear gain point 3, PU gv (Gv3). Typical value =
0.
gv4:
slot_uri: cim:GovHydro2.gv4
range: PU
required: false
multivalued: false
description: Nonlinear gain point 4, PU gv (Gv4). Typical value =
0.
gv5:
slot_uri: cim:GovHydro2.gv5
range: PU
required: false
multivalued: false
description: Nonlinear gain point 5, PU gv (Gv5). Typical value =
0.
gv6:
slot_uri: cim:GovHydro2.gv6
range: PU
required: false
multivalued: false
description: Nonlinear gain point 6, PU gv (Gv6). Typical value =
0.
kturb:
slot_uri: cim:GovHydro2.kturb
range: PU
required: false
multivalued: false
description: Turbine gain (Kturb). Typical value = 1.
mwbase:
slot_uri: cim:GovHydro2.mwbase
range: ActivePower
required: false
multivalued: false
description: Base for power values (MWbase) (> 0). Unit = MW.
pgv1:
slot_uri: cim:GovHydro2.pgv1
range: PU
required: false
multivalued: false
description: Nonlinear gain point 1, PU power (Pgv1). Typical value
= 0.
pgv2:
slot_uri: cim:GovHydro2.pgv2
range: PU
required: false
multivalued: false
description: Nonlinear gain point 2, PU power (Pgv2). Typical value
= 0.
pgv3:
slot_uri: cim:GovHydro2.pgv3
range: PU
required: false
multivalued: false
description: Nonlinear gain point 3, PU power (Pgv3). Typical value
= 0.
pgv4:
slot_uri: cim:GovHydro2.pgv4
range: PU
required: false
multivalued: false
description: Nonlinear gain point 4, PU power (Pgv4). Typical value
= 0.
pgv5:
slot_uri: cim:GovHydro2.pgv5
range: PU
required: false
multivalued: false
description: Nonlinear gain point 5, PU power (Pgv5). Typical value
= 0.
pgv6:
slot_uri: cim:GovHydro2.pgv6
range: PU
required: false
multivalued: false
description: Nonlinear gain point 6, PU power (Pgv6). Typical value
= 0.
pmax:
slot_uri: cim:GovHydro2.pmax
range: PU
required: false
multivalued: false
description: Maximum gate opening (Pmax) (> GovHydro2.pmin). Typical
value = 1.
pmin:
slot_uri: cim:GovHydro2.pmin
range: PU
required: false
multivalued: false
description: Minimum gate opening (Pmin) (< GovHydro2.pmax). Typical
value = 0.
rperm:
slot_uri: cim:GovHydro2.rperm
range: PU
required: false
multivalued: false
description: Permanent droop (Rperm). Typical value = 0,05.
rtemp:
slot_uri: cim:GovHydro2.rtemp
range: PU
required: false
multivalued: false
description: Temporary droop (Rtemp). Typical value = 0,5.
tg:
slot_uri: cim:GovHydro2.tg
range: Seconds
required: false
multivalued: false
description: Gate servo time constant (Tg) (> 0). Typical value
= 0,5.
tp:
slot_uri: cim:GovHydro2.tp
range: Seconds
required: false
multivalued: false
description: Pilot servo valve time constant (Tp) (>= 0). Typical
value = 0,03.
tr:
slot_uri: cim:GovHydro2.tr
range: Seconds
required: false
multivalued: false
description: Dashpot time constant (Tr) (>= 0). Typical value =
12.
tw:
slot_uri: cim:GovHydro2.tw
range: Seconds
required: false
multivalued: false
description: Water inertia time constant (Tw) (>= 0). Typical value
= 2.
uc:
slot_uri: cim:GovHydro2.uc
range: float
required: false
multivalued: false
description: Maximum gate closing velocity (Uc) (< 0). Unit = PU
/ s. Typical value = -0,1.
uo:
slot_uri: cim:GovHydro2.uo
range: float
required: false
multivalued: false
description: Maximum gate opening velocity (Uo). Unit = PU / s. Typical
value = 0,1.
GovHydro3:
class_uri: cim:GovHydro3
is_a: TurbineGovernorDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.TurbineGovernorDynamics
description: Modified IEEE hydro governor-turbine. This model differs from that
defined in the IEEE modelling guideline paper in that the limits on gate position
and velocity do not permit "wind up" of the upstream signals.
attributes:
at:
slot_uri: cim:GovHydro3.at
range: PU
required: false
multivalued: false
description: Turbine gain (At) (>0). Typical value = 1,2.
db1:
slot_uri: cim:GovHydro3.db1
range: Frequency
required: false
multivalued: false
description: Intentional dead-band width (db1). Unit = Hz. Typical
value = 0.
db2:
slot_uri: cim:GovHydro3.db2
range: ActivePower
required: false
multivalued: false
description: Unintentional dead-band (db2). Unit = MW. Typical value
= 0.
dturb:
slot_uri: cim:GovHydro3.dturb
range: PU
required: false
multivalued: false
description: Turbine damping factor (Dturb). Typical value = 0,2.
eps:
slot_uri: cim:GovHydro3.eps
range: Frequency
required: false
multivalued: false
description: Intentional db hysteresis (eps). Unit = Hz. Typical
value = 0.
governorControl:
slot_uri: cim:GovHydro3.governorControl
range: boolean
required: false
multivalued: false
description: "Governor control flag (Cflag).\r\ntrue = PID control\
\ is active\r\nfalse = double derivative control is active.\r\nTypical value\
\ = true."
gv1:
slot_uri: cim:GovHydro3.gv1
range: PU
required: false
multivalued: false
description: Nonlinear gain point 1, PU gv (Gv1). Typical value =
0.
gv2:
slot_uri: cim:GovHydro3.gv2
range: PU
required: false
multivalued: false
description: Nonlinear gain point 2, PU gv (Gv2). Typical value =
0.
gv3:
slot_uri: cim:GovHydro3.gv3
range: PU
required: false
multivalued: false
description: Nonlinear gain point 3, PU gv (Gv3). Typical value =
0.
gv4:
slot_uri: cim:GovHydro3.gv4
range: PU
required: false
multivalued: false
description: Nonlinear gain point 4, PU gv (Gv4). Typical value =
0.
gv5:
slot_uri: cim:GovHydro3.gv5
range: PU
required: false
multivalued: false
description: Nonlinear gain point 5, PU gv (Gv5). Typical value =
0.
gv6:
slot_uri: cim:GovHydro3.gv6
range: PU
required: false
multivalued: false
description: Nonlinear gain point 6, PU gv (Gv6). Typical value =
0.
h0:
slot_uri: cim:GovHydro3.h0
range: PU
required: false
multivalued: false
description: Turbine nominal head (H0). Typical value = 1.
k1:
slot_uri: cim:GovHydro3.k1
range: PU
required: false
multivalued: false
description: Derivative gain (K1). Typical value = 0,01.
k2:
slot_uri: cim:GovHydro3.k2
range: PU
required: false
multivalued: false
description: Double derivative gain, if Cflag = -1 (K2). Typical
value = 2,5.
kg:
slot_uri: cim:GovHydro3.kg
range: PU
required: false
multivalued: false
description: Gate servo gain (Kg). Typical value = 2.
ki:
slot_uri: cim:GovHydro3.ki
range: PU
required: false
multivalued: false
description: Integral gain (Ki). Typical value = 0,5.
mwbase:
slot_uri: cim:GovHydro3.mwbase
range: ActivePower
required: false
multivalued: false
description: Base for power values (MWbase) (> 0). Unit = MW.
pgv1:
slot_uri: cim:GovHydro3.pgv1
range: PU
required: false
multivalued: false
description: Nonlinear gain point 1, PU power (Pgv1). Typical value
= 0.
pgv2:
slot_uri: cim:GovHydro3.pgv2
range: PU
required: false
multivalued: false
description: Nonlinear gain point 2, PU power (Pgv2). Typical value
= 0.
pgv3:
slot_uri: cim:GovHydro3.pgv3
range: PU
required: false
multivalued: false
description: Nonlinear gain point 3, PU power (Pgv3). Typical value
= 0.
pgv4:
slot_uri: cim:GovHydro3.pgv4
range: PU
required: false
multivalued: false
description: Nonlinear gain point 4, PU power (Pgv4). Typical value
= 0.
pgv5:
slot_uri: cim:GovHydro3.pgv5
range: PU
required: false
multivalued: false
description: Nonlinear gain point 5, PU power (Pgv5). Typical value
= 0.
pgv6:
slot_uri: cim:GovHydro3.pgv6
range: PU
required: false
multivalued: false
description: Nonlinear gain point 6, PU power (Pgv6). Typical value
= 0.
pmax:
slot_uri: cim:GovHydro3.pmax
range: PU
required: false
multivalued: false
description: Maximum gate opening, PU of MWbase (Pmax) (> GovHydro3.pmin). Typical
value = 1.
pmin:
slot_uri: cim:GovHydro3.pmin
range: PU
required: false
multivalued: false
description: Minimum gate opening, PU of MWbase (Pmin) (<
GovHydro3.pmax). Typical value = 0.
qnl:
slot_uri: cim:GovHydro3.qnl
range: PU
required: false
multivalued: false
description: No-load turbine flow at nominal head (Qnl). Typical value
= 0,08.
relec:
slot_uri: cim:GovHydro3.relec
range: PU
required: false
multivalued: false
description: Steady-state droop, PU, for electrical power feedback (Relec). Typical
value = 0,05.
rgate:
slot_uri: cim:GovHydro3.rgate
range: PU
required: false
multivalued: false
description: Steady-state droop, PU, for governor output feedback (Rgate). Typical
value = 0.
td:
slot_uri: cim:GovHydro3.td
range: Seconds
required: false
multivalued: false
description: Input filter time constant (Td) (>= 0). Typical value
= 0,05.
tf:
slot_uri: cim:GovHydro3.tf
range: Seconds
required: false
multivalued: false
description: Washout time constant (Tf) (>= 0). Typical value =
0,1.
tp:
slot_uri: cim:GovHydro3.tp
range: Seconds
required: false
multivalued: false
description: Gate servo time constant (Tp) (>= 0). Typical value
= 0,05.
tt:
slot_uri: cim:GovHydro3.tt
range: Seconds
required: false
multivalued: false
description: Power feedback time constant (Tt) (>= 0). Typical
value = 0,2.
tw:
slot_uri: cim:GovHydro3.tw
range: Seconds
required: false
multivalued: false
description: Water inertia time constant (Tw) (>= 0). If = 0, block
is bypassed. Typical value = 1.
velcl:
slot_uri: cim:GovHydro3.velcl
range: float
required: false
multivalued: false
description: Maximum gate closing velocity (Velcl). Unit = PU / s. Typical
value = -0,2.
velop:
slot_uri: cim:GovHydro3.velop
range: float
required: false
multivalued: false
description: Maximum gate opening velocity (Velop). Unit = PU / s.
Typical value = 0,2.
GovHydro4:
class_uri: cim:GovHydro4
is_a: TurbineGovernorDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.TurbineGovernorDynamics
description: Hydro turbine and governor. Represents plants with straight-forward
penstock configurations and hydraulic governors of the traditional 'dashpot'
type. This model can be used to represent simple, Francis/Pelton or Kaplan
turbines.
attributes:
at:
slot_uri: cim:GovHydro4.at
range: PU
required: false
multivalued: false
description: Turbine gain (At). Typical value = 1,2.
bgv0:
slot_uri: cim:GovHydro4.bgv0
range: PU
required: false
multivalued: false
description: Kaplan blade servo point 0 (Bgv0) (= 0 for simple, = 0
for Francis/Pelton). Typical value for Kaplan = 0.
bgv1:
slot_uri: cim:GovHydro4.bgv1
range: PU
required: false
multivalued: false
description: Kaplan blade servo point 1 (Bgv1) (= 0 for simple, = 0
for Francis/Pelton). Typical value for Kaplan = 0.
bgv2:
slot_uri: cim:GovHydro4.bgv2
range: PU
required: false
multivalued: false
description: Kaplan blade servo point 2 (Bgv2) (= 0 for simple, = 0
for Francis/Pelton). Typical value for Kaplan = 0,1.
bgv3:
slot_uri: cim:GovHydro4.bgv3
range: PU
required: false
multivalued: false
description: Kaplan blade servo point 3 (Bgv3) (= 0 for simple, = 0
for Francis/Pelton). Typical value for Kaplan = 0,667.
bgv4:
slot_uri: cim:GovHydro4.bgv4
range: PU
required: false
multivalued: false
description: Kaplan blade servo point 4 (Bgv4) (= 0 for simple, = 0
for Francis/Pelton). Typical value for Kaplan = 0,9.
bgv5:
slot_uri: cim:GovHydro4.bgv5
range: PU
required: false
multivalued: false
description: Kaplan blade servo point 5 (Bgv5) (= 0 for simple, = 0
for Francis/Pelton). Typical value for Kaplan = 1.
bmax:
slot_uri: cim:GovHydro4.bmax
range: float
required: false
multivalued: false
description: Maximum blade adjustment factor (Bmax) (= 0 for simple,
= 0 for Francis/Pelton). Typical value for Kaplan = 1,1276.
db1:
slot_uri: cim:GovHydro4.db1
range: Frequency
required: false
multivalued: false
description: Intentional deadband width (db1). Unit = Hz. Typical
value = 0.
db2:
slot_uri: cim:GovHydro4.db2
range: ActivePower
required: false
multivalued: false
description: Unintentional dead-band (db2). Unit = MW. Typical value
= 0.
dturb:
slot_uri: cim:GovHydro4.dturb
range: PU
required: false
multivalued: false
description: Turbine damping factor (Dturb). Unit = delta P (PU of
MWbase) / delta speed (PU). Typical value for simple = 0,5, Francis/Pelton
= 1,1, Kaplan = 1,1.
eps:
slot_uri: cim:GovHydro4.eps
range: Frequency
required: false
multivalued: false
description: Intentional db hysteresis (eps). Unit = Hz. Typical
value = 0.
gmax:
slot_uri: cim:GovHydro4.gmax
range: PU
required: false
multivalued: false
description: Maximum gate opening, PU of MWbase (Gmax) (>
GovHydro4.gmin). Typical value = 1.
gmin:
slot_uri: cim:GovHydro4.gmin
range: PU
required: false
multivalued: false
description: Minimum gate opening, PU of MWbase (Gmin) (<
GovHydro4.gmax). Typical value = 0.
gv0:
slot_uri: cim:GovHydro4.gv0
range: PU
required: false
multivalued: false
description: Nonlinear gain point 0, PU gv (Gv0) (= 0 for simple). Typical
for Francis/Pelton = 0,1, Kaplan = 0,1.
gv1:
slot_uri: cim:GovHydro4.gv1
range: PU
required: false
multivalued: false
description: Nonlinear gain point 1, PU gv (Gv1) (= 0 for simple, >
GovHydro4.gv0 for Francis/Pelton and Kaplan). Typical value for Francis/Pelton
= 0,4, Kaplan = 0,4.
gv2:
slot_uri: cim:GovHydro4.gv2
range: PU
required: false
multivalued: false
description: Nonlinear gain point 2, PU gv (Gv2) (= 0 for simple, >
GovHydro4.gv1 for Francis/Pelton and Kaplan). Typical value for Francis/Pelton
= 0,5, Kaplan = 0,5.
gv3:
slot_uri: cim:GovHydro4.gv3
range: PU
required: false
multivalued: false
description: Nonlinear gain point 3, PU gv (Gv3) (= 0 for simple,
> GovHydro4.gv2 for Francis/Pelton and Kaplan). Typical value for Francis/Pelton
= 0,7, Kaplan = 0,7.
gv4:
slot_uri: cim:GovHydro4.gv4
range: PU
required: false
multivalued: false
description: Nonlinear gain point 4, PU gv (Gv4) (= 0 for simple,
> GovHydro4.gv3 for Francis/Pelton and Kaplan). Typical value for Francis/Pelton
= 0,8, Kaplan = 0,8.
gv5:
slot_uri: cim:GovHydro4.gv5
range: PU
required: false
multivalued: false
description: Nonlinear gain point 5, PU gv (Gv5) (= 0 for simple,
< 1 and > GovHydro4.gv4 for Francis/Pelton and Kaplan). Typical value
for Francis/Pelton = 0,9, Kaplan = 0,9.
hdam:
slot_uri: cim:GovHydro4.hdam
range: PU
required: false
multivalued: false
description: Head available at dam (hdam). Typical value = 1.
model:
slot_uri: cim:GovHydro4.model
range: GovHydro4ModelKind
required: false
multivalued: false
description: The kind of model being represented (simple, Francis/Pelton or
Kaplan).
mwbase:
slot_uri: cim:GovHydro4.mwbase
range: ActivePower
required: false
multivalued: false
description: Base for power values (MWbase) (> 0). Unit = MW.
pgv0:
slot_uri: cim:GovHydro4.pgv0
range: PU
required: false
multivalued: false
description: Nonlinear gain point 0, PU power (Pgv0) (= 0 for simple). Typical
value = 0.
pgv1:
slot_uri: cim:GovHydro4.pgv1
range: PU
required: false
multivalued: false
description: "Nonlinear gain point 1, PU power (Pgv1) (= 0 for simple).\r\
\nTypical value for Francis/Pelton = 0,42, Kaplan = 0,35."
pgv2:
slot_uri: cim:GovHydro4.pgv2
range: PU
required: false
multivalued: false
description: "Nonlinear gain point 2, PU power (Pgv2) (= 0 for simple).\r\
\nTypical value for Francis/Pelton = 0,56, Kaplan = 0,468."
pgv3:
slot_uri: cim:GovHydro4.pgv3
range: PU
required: false
multivalued: false
description: "Nonlinear gain point 3, PU power (Pgv3) (= 0 for simple).\r\
\nTypical value for Francis/Pelton = 0,8, Kaplan = 0,796."
pgv4:
slot_uri: cim:GovHydro4.pgv4
range: PU
required: false
multivalued: false
description: "Nonlinear gain point 4, PU power (Pgv4) (= 0 for simple).\r\
\nTypical value for Francis/Pelton = 0,9, Kaplan = 0,917."
pgv5:
slot_uri: cim:GovHydro4.pgv5
range: PU
required: false
multivalued: false
description: "Nonlinear gain point 5, PU power (Pgv5) (= 0 for simple).\
\ \r\nTypical value for Francis/Pelton = 0,97, Kaplan = 0,99."
qnl:
slot_uri: cim:GovHydro4.qnl
range: PU
required: false
multivalued: false
description: "No-load flow at nominal head (Qnl).\r\nTypical value\
\ for simple = 0,08, Francis/Pelton = 0, Kaplan = 0."
rperm:
slot_uri: cim:GovHydro4.rperm
range: Seconds
required: false
multivalued: false
description: Permanent droop (Rperm) (>= 0). Typical value = 0,05.
rtemp:
slot_uri: cim:GovHydro4.rtemp
range: Seconds
required: false
multivalued: false
description: Temporary droop (Rtemp) (>= 0). Typical value = 0,3.
tblade:
slot_uri: cim:GovHydro4.tblade
range: Seconds
required: false
multivalued: false
description: Blade servo time constant (Tblade) (>= 0). Typical
value = 100.
tg:
slot_uri: cim:GovHydro4.tg
range: Seconds
required: false
multivalued: false
description: Gate servo time constant (Tg) (> 0). Typical value
= 0,5.
tp:
slot_uri: cim:GovHydro4.tp
range: Seconds
required: false
multivalued: false
description: Pilot servo time constant (Tp) (>= 0). Typical value
= 0,1.
tr:
slot_uri: cim:GovHydro4.tr
range: Seconds
required: false
multivalued: false
description: Dashpot time constant (Tr) (>= 0). Typical value =
5.
tw:
slot_uri: cim:GovHydro4.tw
range: Seconds
required: false
multivalued: false
description: Water inertia time constant (Tw) (> 0). Typical value
= 1.
uc:
slot_uri: cim:GovHydro4.uc
range: float
required: false
multivalued: false
description: Max gate closing velocity (Uc). Typical value = 0,2.
uo:
slot_uri: cim:GovHydro4.uo
range: float
required: false
multivalued: false
description: Max gate opening velocity (Uo). Typical value = 0,2.
GovHydroDD:
class_uri: cim:GovHydroDD
is_a: TurbineGovernorDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.TurbineGovernorDynamics
description: Double derivative hydro governor and turbine.
attributes:
aturb:
slot_uri: cim:GovHydroDD.aturb
range: PU
required: false
multivalued: false
description: Turbine numerator multiplier (Aturb) (see parameter detail
3). Typical value = -1.
bturb:
slot_uri: cim:GovHydroDD.bturb
range: PU
required: false
multivalued: false
description: Turbine denominator multiplier (Bturb) (see parameter
detail 3). Typical value = 0,5.
db1:
slot_uri: cim:GovHydroDD.db1
range: Frequency
required: false
multivalued: false
description: Intentional dead-band width (db1). Unit = Hz. Typical
value = 0.
db2:
slot_uri: cim:GovHydroDD.db2
range: ActivePower
required: false
multivalued: false
description: Unintentional dead-band (db2). Unit = MW. Typical value
= 0.
eps:
slot_uri: cim:GovHydroDD.eps
range: Frequency
required: false
multivalued: false
description: Intentional db hysteresis (eps). Unit = Hz. Typical
value = 0.
gmax:
slot_uri: cim:GovHydroDD.gmax
range: PU
required: false
multivalued: false
description: Maximum gate opening (Gmax) (> GovHydroDD.gmin). Typical
value = 0.
gmin:
slot_uri: cim:GovHydroDD.gmin
range: PU
required: false
multivalued: false
description: Minimum gate opening (Gmin) (< GovHydroDD.gmax). Typical
value = 0.
gv1:
slot_uri: cim:GovHydroDD.gv1
range: PU
required: false
multivalued: false
description: Nonlinear gain point 1, PU gv (Gv1). Typical value =
0.
gv2:
slot_uri: cim:GovHydroDD.gv2
range: PU
required: false
multivalued: false
description: Nonlinear gain point 2, PU gv (Gv2). Typical value =
0.
gv3:
slot_uri: cim:GovHydroDD.gv3
range: PU
required: false
multivalued: false
description: Nonlinear gain point 3, PU gv (Gv3). Typical value =
0.
gv4:
slot_uri: cim:GovHydroDD.gv4
range: PU
required: false
multivalued: false
description: Nonlinear gain point 4, PU gv (Gv4). Typical value =
0.
gv5:
slot_uri: cim:GovHydroDD.gv5
range: PU
required: false
multivalued: false
description: Nonlinear gain point 5, PU gv (Gv5). Typical value =
0.
gv6:
slot_uri: cim:GovHydroDD.gv6
range: PU
required: false
multivalued: false
description: Nonlinear gain point 6, PU gv (Gv6). Typical value =
0.
inputSignal:
slot_uri: cim:GovHydroDD.inputSignal
range: boolean
required: false
multivalued: false
description: "Input signal switch (Flag). \r\ntrue = Pe input\
\ is used\r\nfalse = feedback is received from CV.\r\nFlag\
\ is normally dependent on Tt. If Tt is zero, Flag\
\ is set to false. If Tt is not zero, Flag is set to true.\
\ \r\nTypical value = true."
k1:
slot_uri: cim:GovHydroDD.k1
range: PU
required: false
multivalued: false
description: Single derivative gain (K1). Typical value = 3,6.
k2:
slot_uri: cim:GovHydroDD.k2
range: PU
required: false
multivalued: false
description: Double derivative gain (K2). Typical value = 0,2.
kg:
slot_uri: cim:GovHydroDD.kg
range: PU
required: false
multivalued: false
description: Gate servo gain (Kg). Typical value = 3.
ki:
slot_uri: cim:GovHydroDD.ki
range: PU
required: false
multivalued: false
description: Integral gain (Ki). Typical value = 1.
mwbase:
slot_uri: cim:GovHydroDD.mwbase
range: ActivePower
required: false
multivalued: false
description: Base for power values (MWbase) (>0). Unit = MW.
pgv1:
slot_uri: cim:GovHydroDD.pgv1
range: PU
required: false
multivalued: false
description: Nonlinear gain point 1, PU power (Pgv1). Typical value
= 0.
pgv2:
slot_uri: cim:GovHydroDD.pgv2
range: PU
required: false
multivalued: false
description: Nonlinear gain point 2, PU power (Pgv2). Typical value
= 0.
pgv3:
slot_uri: cim:GovHydroDD.pgv3
range: PU
required: false
multivalued: false
description: Nonlinear gain point 3, PU power (Pgv3). Typical value
= 0.
pgv4:
slot_uri: cim:GovHydroDD.pgv4
range: PU
required: false
multivalued: false
description: Nonlinear gain point 4, PU power (Pgv4). Typical value
= 0.
pgv5:
slot_uri: cim:GovHydroDD.pgv5
range: PU
required: false
multivalued: false
description: Nonlinear gain point 5, PU power (Pgv5). Typical value
= 0.
pgv6:
slot_uri: cim:GovHydroDD.pgv6
range: PU
required: false
multivalued: false
description: Nonlinear gain point 6, PU power (Pgv6). Typical value
= 0.
pmax:
slot_uri: cim:GovHydroDD.pmax
range: PU
required: false
multivalued: false
description: Maximum gate opening, PU of MWbase (Pmax) (>
GovHydroDD.pmin). Typical value = 1.
pmin:
slot_uri: cim:GovHydroDD.pmin
range: PU
required: false
multivalued: false
description: Minimum gate opening, PU of MWbase (Pmin) (>
GovHydroDD.pmax). Typical value = 0.
r:
slot_uri: cim:GovHydroDD.r
range: PU
required: false
multivalued: false
description: Steady state droop (R). Typical value = 0,05.
td:
slot_uri: cim:GovHydroDD.td
range: Seconds
required: false
multivalued: false
description: Input filter time constant (Td) (>= 0). If = 0, block
is bypassed. Typical value = 0.
tf:
slot_uri: cim:GovHydroDD.tf
range: Seconds
required: false
multivalued: false
description: Washout time constant (Tf) (>= 0). Typical value =
0,1.
tp:
slot_uri: cim:GovHydroDD.tp
range: Seconds
required: false
multivalued: false
description: Gate servo time constant (Tp) (>= 0). If = 0, block
is bypassed. Typical value = 0,35.
tt:
slot_uri: cim:GovHydroDD.tt
range: Seconds
required: false
multivalued: false
description: Power feedback time constant (Tt) (>= 0). If = 0,
block is bypassed. Typical value = 0,02.
tturb:
slot_uri: cim:GovHydroDD.tturb
range: Seconds
required: false
multivalued: false
description: Turbine time constant (Tturb) (>= 0). See parameter
detail 3. Typical value = 0,8.
velcl:
slot_uri: cim:GovHydroDD.velcl
range: float
required: false
multivalued: false
description: Maximum gate closing velocity (Velcl). Unit = PU / s. Typical
value = -0,14.
velop:
slot_uri: cim:GovHydroDD.velop
range: float
required: false
multivalued: false
description: Maximum gate opening velocity (Velop). Unit = PU / s. Typical
value = 0,09.
GovHydroFrancis:
class_uri: cim:GovHydroFrancis
is_a: TurbineGovernorDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.TurbineGovernorDynamics
description: "Detailed hydro unit - Francis model. This model can be used to\
\ represent three types of governors.\r\nA schematic of the hydraulic system\
\ of detailed hydro unit models, such as Francis and Pelton, is provided in\
\ the DetailedHydroModelHydraulicSystem diagram."
attributes:
am:
slot_uri: cim:GovHydroFrancis.am
range: PU
required: false
multivalued: false
description: Opening section SEFF at the maximum
efficiency (Am). Typical value = 0,7.
av0:
slot_uri: cim:GovHydroFrancis.av0
range: Area
required: false
multivalued: false
description: Area of the surge tank (AV0). Unit =
m2. Typical value = 30.
av1:
slot_uri: cim:GovHydroFrancis.av1
range: Area
required: false
multivalued: false
description: Area of the compensation tank (AV1).
Unit = m2. Typical value = 700.
bp:
slot_uri: cim:GovHydroFrancis.bp
range: PU
required: false
multivalued: false
description: Droop (Bp). Typical value = 0,05.
db1:
slot_uri: cim:GovHydroFrancis.db1
range: Frequency
required: false
multivalued: false
description: Intentional dead-band width (DB1). Unit = Hz. Typical
value = 0.
etamax:
slot_uri: cim:GovHydroFrancis.etamax
range: PU
required: false
multivalued: false
description: Maximum efficiency (EtaMax). Typical value = 1,05.
governorControl:
slot_uri: cim:GovHydroFrancis.governorControl
range: FrancisGovernorControlKind
required: false
multivalued: false
description: Governor control flag (Cflag). Typical value = mechanicHydrolicTachoAccelerator.
h1:
slot_uri: cim:GovHydroFrancis.h1
range: Length
required: false
multivalued: false
description: Head of compensation chamber water level with respect to the
level of penstock (H1). Unit = km. Typical value
= 0,004.
h2:
slot_uri: cim:GovHydroFrancis.h2
range: Length
required: false
multivalued: false
description: Head of surge tank water level with respect to the level of penstock
(H2). Unit = km. Typical value = 0,040.
hn:
slot_uri: cim:GovHydroFrancis.hn
range: Length
required: false
multivalued: false
description: Rated hydraulic head (Hn). Unit = km. Typical
value = 0,250.
kc:
slot_uri: cim:GovHydroFrancis.kc
range: PU
required: false
multivalued: false
description: Penstock loss coefficient (due to friction) (Kc). Typical
value = 0,025.
kg:
slot_uri: cim:GovHydroFrancis.kg
range: PU
required: false
multivalued: false
description: Water tunnel and surge chamber loss coefficient (due to friction)
(Kg). Typical value = 0,025.
kt:
slot_uri: cim:GovHydroFrancis.kt
range: PU
required: false
multivalued: false
description: Washout gain (Kt). Typical value = 0,25.
qc0:
slot_uri: cim:GovHydroFrancis.qc0
range: PU
required: false
multivalued: false
description: No-load turbine flow at nominal head (Qc0). Typical value
= 0,1.
qn:
slot_uri: cim:GovHydroFrancis.qn
range: VolumeFlowRate
required: false
multivalued: false
description: Rated flow (Qn). Unit = m3/s.
Typical value = 250.
ta:
slot_uri: cim:GovHydroFrancis.ta
range: Seconds
required: false
multivalued: false
description: Derivative gain (Ta) (>= 0). Typical value = 3.
td:
slot_uri: cim:GovHydroFrancis.td
range: Seconds
required: false
multivalued: false
description: Washout time constant (Td) (>= 0). Typical value =
6.
ts:
slot_uri: cim:GovHydroFrancis.ts
range: Seconds
required: false
multivalued: false
description: Gate servo time constant (Ts) (>= 0). Typical value
= 0,5.
twnc:
slot_uri: cim:GovHydroFrancis.twnc
range: Seconds
required: false
multivalued: false
description: Water inertia time constant (Twnc) (>= 0). Typical
value = 1.
twng:
slot_uri: cim:GovHydroFrancis.twng
range: Seconds
required: false
multivalued: false
description: Water tunnel and surge chamber inertia time constant (Twng)
(>= 0). Typical value = 3.
tx:
slot_uri: cim:GovHydroFrancis.tx
range: Seconds
required: false
multivalued: false
description: Derivative feedback gain (Tx) (>= 0). Typical value
= 1.
va:
slot_uri: cim:GovHydroFrancis.va
range: float
required: false
multivalued: false
description: Maximum gate opening velocity (Va). Unit = PU / s. Typical
value = 0,06.
valvmax:
slot_uri: cim:GovHydroFrancis.valvmax
range: PU
required: false
multivalued: false
description: Maximum gate opening (ValvMax) (> GovHydroFrancis.valvmin). Typical
value = 1,1.
valvmin:
slot_uri: cim:GovHydroFrancis.valvmin
range: PU
required: false
multivalued: false
description: Minimum gate opening (ValvMin) (< GovHydroFrancis.valvmax). Typical
value = 0.
vc:
slot_uri: cim:GovHydroFrancis.vc
range: float
required: false
multivalued: false
description: Maximum gate closing velocity (Vc). Unit = PU / s. Typical
value = -0,06.
waterTunnelSurgeChamberSimulation:
slot_uri: cim:GovHydroFrancis.waterTunnelSurgeChamberSimulation
range: boolean
required: false
multivalued: false
description: "Water tunnel and surge chamber simulation (Tflag).\r\n\
true = enable of water tunnel and surge chamber simulation\r\nfalse = inhibit\
\ of water tunnel and surge chamber simulation.\r\nTypical value = false."
zsfc:
slot_uri: cim:GovHydroFrancis.zsfc
range: Length
required: false
multivalued: false
description: Head of upper water level with respect to the level of penstock
(Zsfc). Unit = km. Typical value = 0,025.
GovHydroPelton:
class_uri: cim:GovHydroPelton
is_a: TurbineGovernorDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.TurbineGovernorDynamics
description: "Detailed hydro unit - Pelton model. This model can be used to represent\
\ the dynamic related to water tunnel and surge chamber.\r\nThe DetailedHydroModelHydraulicSystem\
\ diagram, located under the GovHydroFrancis class, provides a schematic of\
\ the hydraulic system of detailed hydro unit models, such as Francis and Pelton."
attributes:
av0:
slot_uri: cim:GovHydroPelton.av0
range: Area
required: false
multivalued: false
description: Area of the surge tank (AV0). Unit =
m2. Typical value = 30.
av1:
slot_uri: cim:GovHydroPelton.av1
range: Area
required: false
multivalued: false
description: Area of the compensation tank (AV1).
Unit = m2. Typical value = 700.
bp:
slot_uri: cim:GovHydroPelton.bp
range: PU
required: false
multivalued: false
description: Droop (bp). Typical value = 0,05.
db1:
slot_uri: cim:GovHydroPelton.db1
range: Frequency
required: false
multivalued: false
description: Intentional dead-band width (DB1). Unit = Hz. Typical
value = 0.
db2:
slot_uri: cim:GovHydroPelton.db2
range: Frequency
required: false
multivalued: false
description: Intentional dead-band width of valve opening error (DB2).
Unit = Hz. Typical value = 0,01.
h1:
slot_uri: cim:GovHydroPelton.h1
range: Length
required: false
multivalued: false
description: Head of compensation chamber water level with respect to the
level of penstock (H1). Unit = km. Typical value
= 0,004.
h2:
slot_uri: cim:GovHydroPelton.h2
range: Length
required: false
multivalued: false
description: Head of surge tank water level with respect to the level of penstock
(H2). Unit = km. Typical value = 0,040.
hn:
slot_uri: cim:GovHydroPelton.hn
range: Length
required: false
multivalued: false
description: Rated hydraulic head (Hn). Unit = km. Typical
value = 0,250.
kc:
slot_uri: cim:GovHydroPelton.kc
range: PU
required: false
multivalued: false
description: Penstock loss coefficient (due to friction) (Kc). Typical
value = 0,025.
kg:
slot_uri: cim:GovHydroPelton.kg
range: PU
required: false
multivalued: false
description: Water tunnel and surge chamber loss coefficient (due to friction)
(Kg). Typical value = 0,025.
qc0:
slot_uri: cim:GovHydroPelton.qc0
range: PU
required: false
multivalued: false
description: No-load turbine flow at nominal head (Qc0). Typical value
= 0,05.
qn:
slot_uri: cim:GovHydroPelton.qn
range: VolumeFlowRate
required: false
multivalued: false
description: Rated flow (Qn). Unit = m3/s.
Typical value = 250.
simplifiedPelton:
slot_uri: cim:GovHydroPelton.simplifiedPelton
range: boolean
required: false
multivalued: false
description: "Simplified Pelton model simulation (Sflag).\r\ntrue =\
\ enable of simplified Pelton model simulation\r\nfalse = enable of complete\
\ Pelton model simulation (non-linear gain).\r\nTypical value = true."
staticCompensating:
slot_uri: cim:GovHydroPelton.staticCompensating
range: boolean
required: false
multivalued: false
description: "Static compensating characteristic (Cflag). It should\
\ be true if simplifiedPelton = false.\r\ntrue = enable of static compensating\
\ characteristic \r\nfalse = inhibit of static compensating characteristic.\r\
\nTypical value = false."
ta:
slot_uri: cim:GovHydroPelton.ta
range: Seconds
required: false
multivalued: false
description: Derivative gain (accelerometer time constant) (Ta) (>=
0). Typical value = 3.
ts:
slot_uri: cim:GovHydroPelton.ts
range: Seconds
required: false
multivalued: false
description: Gate servo time constant (Ts) (>= 0). Typical value
= 0,15.
tv:
slot_uri: cim:GovHydroPelton.tv
range: Seconds
required: false
multivalued: false
description: Servomotor integrator time constant (Tv) (>= 0). Typical
value = 0,3.
twnc:
slot_uri: cim:GovHydroPelton.twnc
range: Seconds
required: false
multivalued: false
description: Water inertia time constant (Twnc) (>= 0). Typical
value = 1.
twng:
slot_uri: cim:GovHydroPelton.twng
range: Seconds
required: false
multivalued: false
description: Water tunnel and surge chamber inertia time constant (Twng)
(>= 0). Typical value = 3.
tx:
slot_uri: cim:GovHydroPelton.tx
range: Seconds
required: false
multivalued: false
description: Electronic integrator time constant (Tx) (>= 0). Typical
value = 0,5.
va:
slot_uri: cim:GovHydroPelton.va
range: float
required: false
multivalued: false
description: Maximum gate opening velocity (Va). Unit = PU / s. Typical
value = 0,06.
valvmax:
slot_uri: cim:GovHydroPelton.valvmax
range: PU
required: false
multivalued: false
description: Maximum gate opening (ValvMax) (> GovHydroPelton.valvmin). Typical
value = 1,1.
valvmin:
slot_uri: cim:GovHydroPelton.valvmin
range: PU
required: false
multivalued: false
description: Minimum gate opening (ValvMin) (< GovHydroPelton.valvmax). Typical
value = 0.
vav:
slot_uri: cim:GovHydroPelton.vav
range: PU
required: false
multivalued: false
description: Maximum servomotor valve opening velocity (Vav). Typical
value = 0,1.
vc:
slot_uri: cim:GovHydroPelton.vc
range: float
required: false
multivalued: false
description: Maximum gate closing velocity (Vc). Unit = PU / s. Typical
value = -0,06.
vcv:
slot_uri: cim:GovHydroPelton.vcv
range: PU
required: false
multivalued: false
description: Maximum servomotor valve closing velocity (Vcv). Typical
value = -0,1.
waterTunnelSurgeChamberSimulation:
slot_uri: cim:GovHydroPelton.waterTunnelSurgeChamberSimulation
range: boolean
required: false
multivalued: false
description: "Water tunnel and surge chamber simulation (Tflag).\r\n\
true = enable of water tunnel and surge chamber simulation\r\nfalse = inhibit\
\ of water tunnel and surge chamber simulation.\r\nTypical value = false."
zsfc:
slot_uri: cim:GovHydroPelton.zsfc
range: Length
required: false
multivalued: false
description: Head of upper water level with respect to the level of penstock
(Zsfc). Unit = km. Typical value = 0,025.
GovHydroPID:
class_uri: cim:GovHydroPID
is_a: TurbineGovernorDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.TurbineGovernorDynamics
description: PID governor and turbine.
attributes:
aturb:
slot_uri: cim:GovHydroPID.aturb
range: PU
required: false
multivalued: false
description: Turbine numerator multiplier (Aturb) (see parameter detail
3). Typical value -1.
bturb:
slot_uri: cim:GovHydroPID.bturb
range: PU
required: false
multivalued: false
description: Turbine denominator multiplier (Bturb) (see parameter
detail 3). Typical value = 0,5.
db1:
slot_uri: cim:GovHydroPID.db1
range: Frequency
required: false
multivalued: false
description: Intentional dead-band width (db1). Unit = Hz. Typical
value = 0.
db2:
slot_uri: cim:GovHydroPID.db2
range: ActivePower
required: false
multivalued: false
description: Unintentional dead-band (db2). Unit = MW. Typical value
= 0.
eps:
slot_uri: cim:GovHydroPID.eps
range: Frequency
required: false
multivalued: false
description: Intentional db hysteresis (eps). Unit = Hz. Typical
value = 0.
gv1:
slot_uri: cim:GovHydroPID.gv1
range: PU
required: false
multivalued: false
description: Nonlinear gain point 1, PU gv (Gv1). Typical value =
0.
gv2:
slot_uri: cim:GovHydroPID.gv2
range: PU
required: false
multivalued: false
description: Nonlinear gain point 2, PU gv (Gv2). Typical value =
0.
gv3:
slot_uri: cim:GovHydroPID.gv3
range: PU
required: false
multivalued: false
description: Nonlinear gain point 3, PU gv (Gv3). Typical value =
0.
gv4:
slot_uri: cim:GovHydroPID.gv4
range: PU
required: false
multivalued: false
description: Nonlinear gain point 4, PU gv (Gv4). Typical value =
0.
gv5:
slot_uri: cim:GovHydroPID.gv5
range: PU
required: false
multivalued: false
description: Nonlinear gain point 5, PU gv (Gv5). Typical value =
0.
gv6:
slot_uri: cim:GovHydroPID.gv6
range: PU
required: false
multivalued: false
description: Nonlinear gain point 6, PU gv (Gv6). Typical value =
0.
inputSignal:
slot_uri: cim:GovHydroPID.inputSignal
range: boolean
required: false
multivalued: false
description: "Input signal switch (Flag). \r\ntrue = Pe input\
\ is used\r\nfalse = feedback is received from CV.\r\nFlag\
\ is normally dependent on Tt. If Tt is zero, Flag\
\ is set to false. If Tt is not zero, Flag is set to true.\
\ \r\nTypical value = true."
kd:
slot_uri: cim:GovHydroPID.kd
range: PU
required: false
multivalued: false
description: Derivative gain (Kd). Typical value = 1,11.
kg:
slot_uri: cim:GovHydroPID.kg
range: PU
required: false
multivalued: false
description: Gate servo gain (Kg). Typical value = 2,5.
ki:
slot_uri: cim:GovHydroPID.ki
range: PU
required: false
multivalued: false
description: Integral gain (Ki). Typical value = 0,36.
kp:
slot_uri: cim:GovHydroPID.kp
range: PU
required: false
multivalued: false
description: Proportional gain (Kp). Typical value = 0,1.
mwbase:
slot_uri: cim:GovHydroPID.mwbase
range: ActivePower
required: false
multivalued: false
description: Base for power values (MWbase) (> 0). Unit = MW.
pgv1:
slot_uri: cim:GovHydroPID.pgv1
range: PU
required: false
multivalued: false
description: Nonlinear gain point 1, PU power (Pgv1). Typical value
= 0.
pgv2:
slot_uri: cim:GovHydroPID.pgv2
range: PU
required: false
multivalued: false
description: Nonlinear gain point 2, PU power (Pgv2). Typical value
= 0.
pgv3:
slot_uri: cim:GovHydroPID.pgv3
range: PU
required: false
multivalued: false
description: Nonlinear gain point 3, PU power (Pgv3). Typical value
= 0.
pgv4:
slot_uri: cim:GovHydroPID.pgv4
range: PU
required: false
multivalued: false
description: Nonlinear gain point 4, PU power (Pgv4). Typical value
= 0.
pgv5:
slot_uri: cim:GovHydroPID.pgv5
range: PU
required: false
multivalued: false
description: Nonlinear gain point 5, PU power (Pgv5). Typical value
= 0.
pgv6:
slot_uri: cim:GovHydroPID.pgv6
range: PU
required: false
multivalued: false
description: Nonlinear gain point 6, PU power (Pgv6). Typical value
= 0.
pmax:
slot_uri: cim:GovHydroPID.pmax
range: PU
required: false
multivalued: false
description: Maximum gate opening, PU of MWbase (Pmax) (> GovHydroPID.pmin). Typical
value = 1.
pmin:
slot_uri: cim:GovHydroPID.pmin
range: PU
required: false
multivalued: false
description: Minimum gate opening, PU of MWbase (Pmin) (< GovHydroPID.pmax). Typical
value = 0.
r:
slot_uri: cim:GovHydroPID.r
range: PU
required: false
multivalued: false
description: Steady state droop (R). Typical value = 0,05.
td:
slot_uri: cim:GovHydroPID.td
range: Seconds
required: false
multivalued: false
description: Input filter time constant (Td) (>= 0). If = 0, block
is bypassed. Typical value = 0.
tf:
slot_uri: cim:GovHydroPID.tf
range: Seconds
required: false
multivalued: false
description: Washout time constant (Tf) (>= 0). Typical value =
0,1.
tp:
slot_uri: cim:GovHydroPID.tp
range: Seconds
required: false
multivalued: false
description: Gate servo time constant (Tp) (>= 0). If = 0, block
is bypassed. Typical value = 0,35.
tt:
slot_uri: cim:GovHydroPID.tt
range: Seconds
required: false
multivalued: false
description: Power feedback time constant (Tt) (>= 0). If = 0,
block is bypassed. Typical value = 0,02.
tturb:
slot_uri: cim:GovHydroPID.tturb
range: Seconds
required: false
multivalued: false
description: Turbine time constant (Tturb) (>= 0). See Parameter
detail 3. Typical value = 0,8.
velcl:
slot_uri: cim:GovHydroPID.velcl
range: float
required: false
multivalued: false
description: Maximum gate closing velocity (Velcl). Unit = PU / s. Typical
value = -0,14.
velop:
slot_uri: cim:GovHydroPID.velop
range: float
required: false
multivalued: false
description: Maximum gate opening velocity (Velop). Unit = PU / s. Typical
value = 0,09.
GovHydroPID2:
class_uri: cim:GovHydroPID2
is_a: TurbineGovernorDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.TurbineGovernorDynamics
description: "Hydro turbine and governor. Represents plants with straightforward\
\ penstock configurations and \"three term\" electro-hydraulic governors (i.e.\
\ WoodwardTM electronic).\r\n[Footnote: Woodward electronic governors\
\ are an example of suitable products available commercially. This information\
\ is given for the convenience of users of this document and does not constitute\
\ an endorsement by IEC of these products.] \r\n"
attributes:
atw:
slot_uri: cim:GovHydroPID2.atw
range: PU
required: false
multivalued: false
description: Factor multiplying Tw (Atw). Typical value = 0.
d:
slot_uri: cim:GovHydroPID2.d
range: PU
required: false
multivalued: false
description: Turbine damping factor (D). Unit = delta P / delta speed. Typical
value = 0.
feedbackSignal:
slot_uri: cim:GovHydroPID2.feedbackSignal
range: boolean
required: false
multivalued: false
description: "Feedback signal type flag (Flag).\r\ntrue = use gate\
\ position feedback signal\r\nfalse = use Pe."
g0:
slot_uri: cim:GovHydroPID2.g0
range: PU
required: false
multivalued: false
description: Gate opening at speed no load (G0). Typical value = 0.
g1:
slot_uri: cim:GovHydroPID2.g1
range: PU
required: false
multivalued: false
description: Intermediate gate opening (G1). Typical value = 0.
g2:
slot_uri: cim:GovHydroPID2.g2
range: PU
required: false
multivalued: false
description: Intermediate gate opening (G2). Typical value = 0.
gmax:
slot_uri: cim:GovHydroPID2.gmax
range: PU
required: false
multivalued: false
description: Maximum gate opening (Gmax) (> GovHydroPID2.gmin). Typical
value = 0.
gmin:
slot_uri: cim:GovHydroPID2.gmin
range: PU
required: false
multivalued: false
description: Minimum gate opening (Gmin) (> GovHydroPID2.gmax). Typical
value = 0.
kd:
slot_uri: cim:GovHydroPID2.kd
range: PU
required: false
multivalued: false
description: Derivative gain (Kd). Typical value = 0.
ki:
slot_uri: cim:GovHydroPID2.ki
range: float
required: false
multivalued: false
description: Reset gain (Ki). Unit = PU/s. Typical value = 0.
kp:
slot_uri: cim:GovHydroPID2.kp
range: PU
required: false
multivalued: false
description: Proportional gain (Kp). Typical value = 0.
mwbase:
slot_uri: cim:GovHydroPID2.mwbase
range: ActivePower
required: false
multivalued: false
description: Base for power values (MWbase) (>0). Unit = MW.
p1:
slot_uri: cim:GovHydroPID2.p1
range: PU
required: false
multivalued: false
description: Power at gate opening G1 (P1). Typical value =
0.
p2:
slot_uri: cim:GovHydroPID2.p2
range: PU
required: false
multivalued: false
description: Power at gate opening G2 (P2). Typical value = 0.
p3:
slot_uri: cim:GovHydroPID2.p3
range: PU
required: false
multivalued: false
description: Power at full opened gate (P3). Typical value = 0.
rperm:
slot_uri: cim:GovHydroPID2.rperm
range: PU
required: false
multivalued: false
description: Permanent drop (Rperm). Typical value = 0.
ta:
slot_uri: cim:GovHydroPID2.ta
range: Seconds
required: false
multivalued: false
description: Controller time constant (Ta) (>= 0). Typical value
= 0.
tb:
slot_uri: cim:GovHydroPID2.tb
range: Seconds
required: false
multivalued: false
description: 'Gate servo time constant (Tb) (> 0). '
treg:
slot_uri: cim:GovHydroPID2.treg
range: Seconds
required: false
multivalued: false
description: Speed detector time constant (Treg) (>= 0). Typical
value = 0.
tw:
slot_uri: cim:GovHydroPID2.tw
range: Seconds
required: false
multivalued: false
description: Water inertia time constant (Tw) (>= 0). Typical value
= 0.
velmax:
slot_uri: cim:GovHydroPID2.velmax
range: float
required: false
multivalued: false
description: Maximum gate opening velocity (Velmax) (< GovHydroPID2.velmin). Unit
= PU / s. Typical value = 0.
velmin:
slot_uri: cim:GovHydroPID2.velmin
range: float
required: false
multivalued: false
description: Maximum gate closing velocity (Velmin) (> GovHydroPID2.velmax). Unit
= PU / s. Typical value = 0.
GovHydroR:
class_uri: cim:GovHydroR
is_a: TurbineGovernorDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.TurbineGovernorDynamics
description: 'Fourth order lead-lag governor and hydro turbine. '
attributes:
at:
slot_uri: cim:GovHydroR.at
range: PU
required: false
multivalued: false
description: Turbine gain (At). Typical value = 1,2.
db1:
slot_uri: cim:GovHydroR.db1
range: Frequency
required: false
multivalued: false
description: Intentional dead-band width (db1). Unit = Hz. Typical
value = 0.
db2:
slot_uri: cim:GovHydroR.db2
range: ActivePower
required: false
multivalued: false
description: Unintentional dead-band (db2). Unit = MW. Typical value
= 0.
dturb:
slot_uri: cim:GovHydroR.dturb
range: PU
required: false
multivalued: false
description: Turbine damping factor (Dturb). Typical value = 0,2.
eps:
slot_uri: cim:GovHydroR.eps
range: Frequency
required: false
multivalued: false
description: Intentional db hysteresis (eps). Unit = Hz. Typical
value = 0.
gmax:
slot_uri: cim:GovHydroR.gmax
range: PU
required: false
multivalued: false
description: Maximum governor output (Gmax) (> GovHydroR.gmin). Typical
value = 1,05.
gmin:
slot_uri: cim:GovHydroR.gmin
range: PU
required: false
multivalued: false
description: Minimum governor output (Gmin) (< GovHydroR.gmax). Typical
value = -0,05.
gv1:
slot_uri: cim:GovHydroR.gv1
range: PU
required: false
multivalued: false
description: Nonlinear gain point 1, PU gv (Gv1). Typical value =
0.
gv2:
slot_uri: cim:GovHydroR.gv2
range: PU
required: false
multivalued: false
description: Nonlinear gain point 2, PU gv (Gv2). Typical value =
0.
gv3:
slot_uri: cim:GovHydroR.gv3
range: PU
required: false
multivalued: false
description: Nonlinear gain point 3, PU gv (Gv3). Typical value =
0.
gv4:
slot_uri: cim:GovHydroR.gv4
range: PU
required: false
multivalued: false
description: Nonlinear gain point 4, PU gv (Gv4). Typical value =
0.
gv5:
slot_uri: cim:GovHydroR.gv5
range: PU
required: false
multivalued: false
description: Nonlinear gain point 5, PU gv (Gv5). Typical value =
0.
gv6:
slot_uri: cim:GovHydroR.gv6
range: PU
required: false
multivalued: false
description: Nonlinear gain point 6, PU gv (Gv6). Typical value =
0.
h0:
slot_uri: cim:GovHydroR.h0
range: PU
required: false
multivalued: false
description: Turbine nominal head (H0). Typical value = 1.
inputSignal:
slot_uri: cim:GovHydroR.inputSignal
range: boolean
required: false
multivalued: false
description: "Input signal switch (Flag).\r\ntrue = Pe input\
\ is used\r\nfalse = feedback is received from CV.\r\nFlag\
\ is normally dependent on Tt. If Tt is zero, Flag\
\ is set to false. If Tt is not zero, Flag is set to true.\
\ \r\nTypical value = true."
kg:
slot_uri: cim:GovHydroR.kg
range: PU
required: false
multivalued: false
description: Gate servo gain (Kg). Typical value = 2.
ki:
slot_uri: cim:GovHydroR.ki
range: PU
required: false
multivalued: false
description: Integral gain (Ki). Typical value = 0,5.
mwbase:
slot_uri: cim:GovHydroR.mwbase
range: ActivePower
required: false
multivalued: false
description: Base for power values (MWbase) (> 0). Unit = MW.
pgv1:
slot_uri: cim:GovHydroR.pgv1
range: PU
required: false
multivalued: false
description: Nonlinear gain point 1, PU power (Pgv1). Typical value
= 0.
pgv2:
slot_uri: cim:GovHydroR.pgv2
range: PU
required: false
multivalued: false
description: Nonlinear gain point 2, PU power (Pgv2). Typical value
= 0.
pgv3:
slot_uri: cim:GovHydroR.pgv3
range: PU
required: false
multivalued: false
description: Nonlinear gain point 3, PU power (Pgv3). Typical value
= 0.
pgv4:
slot_uri: cim:GovHydroR.pgv4
range: PU
required: false
multivalued: false
description: Nonlinear gain point 4, PU power (Pgv4). Typical value
= 0.
pgv5:
slot_uri: cim:GovHydroR.pgv5
range: PU
required: false
multivalued: false
description: Nonlinear gain point 5, PU power (Pgv5). Typical value
= 0.
pgv6:
slot_uri: cim:GovHydroR.pgv6
range: PU
required: false
multivalued: false
description: Nonlinear gain point 6, PU power (Pgv6). Typical value
= 0.
pmax:
slot_uri: cim:GovHydroR.pmax
range: PU
required: false
multivalued: false
description: Maximum gate opening, PU of MWbase (Pmax) (>
GovHydroR.pmin). Typical value = 1.
pmin:
slot_uri: cim:GovHydroR.pmin
range: PU
required: false
multivalued: false
description: Minimum gate opening, PU of MWbase (Pmin) (<
GovHydroR.pmax). Typical value = 0.
qnl:
slot_uri: cim:GovHydroR.qnl
range: PU
required: false
multivalued: false
description: No-load turbine flow at nominal head (Qnl). Typical value
= 0,08.
r:
slot_uri: cim:GovHydroR.r
range: PU
required: false
multivalued: false
description: Steady-state droop (R). Typical value = 0,05.
t1:
slot_uri: cim:GovHydroR.t1
range: Seconds
required: false
multivalued: false
description: Lead time constant 1 (T1) (>= 0). Typical value =
1,5.
t2:
slot_uri: cim:GovHydroR.t2
range: Seconds
required: false
multivalued: false
description: Lag time constant 1 (T2) (>= 0). Typical value = 0,1.
t3:
slot_uri: cim:GovHydroR.t3
range: Seconds
required: false
multivalued: false
description: Lead time constant 2 (T3) (>= 0). Typical value =
1,5.
t4:
slot_uri: cim:GovHydroR.t4
range: Seconds
required: false
multivalued: false
description: Lag time constant 2 (T4) (>= 0). Typical value = 0,1.
t5:
slot_uri: cim:GovHydroR.t5
range: Seconds
required: false
multivalued: false
description: Lead time constant 3 (T5) (>= 0). Typical value =
0.
t6:
slot_uri: cim:GovHydroR.t6
range: Seconds
required: false
multivalued: false
description: Lag time constant 3 (T6) (>= 0). Typical value = 0,05.
t7:
slot_uri: cim:GovHydroR.t7
range: Seconds
required: false
multivalued: false
description: Lead time constant 4 (T7) (>= 0). Typical value =
0.
t8:
slot_uri: cim:GovHydroR.t8
range: Seconds
required: false
multivalued: false
description: Lag time constant 4 (T8) (>= 0). Typical value = 0,05.
td:
slot_uri: cim:GovHydroR.td
range: Seconds
required: false
multivalued: false
description: Input filter time constant (Td) (>= 0). Typical value
= 0,05.
tp:
slot_uri: cim:GovHydroR.tp
range: Seconds
required: false
multivalued: false
description: Gate servo time constant (Tp) (>= 0). Typical value
= 0,05.
tt:
slot_uri: cim:GovHydroR.tt
range: Seconds
required: false
multivalued: false
description: Power feedback time constant (Tt) (>= 0). Typical
value = 0.
tw:
slot_uri: cim:GovHydroR.tw
range: Seconds
required: false
multivalued: false
description: Water inertia time constant (Tw) (> 0). Typical value
= 1.
velcl:
slot_uri: cim:GovHydroR.velcl
range: float
required: false
multivalued: false
description: Maximum gate closing velocity (Velcl). Unit = PU / s. Typical
value = -0,2.
velop:
slot_uri: cim:GovHydroR.velop
range: float
required: false
multivalued: false
description: Maximum gate opening velocity (Velop). Unit = PU / s. Typical
value = 0,2.
GovHydroWEH:
class_uri: cim:GovHydroWEH
is_a: TurbineGovernorDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.TurbineGovernorDynamics
description: "WoodwardTM electric hydro governor. \r\n[Footnote: Woodward\
\ electric hydro governors are an example of suitable products available commercially.\
\ This information is given for the convenience of users of this document and\
\ does not constitute an endorsement by IEC of these products.]"
attributes:
db:
slot_uri: cim:GovHydroWEH.db
range: PU
required: false
multivalued: false
description: Speed deadband (db).
dicn:
slot_uri: cim:GovHydroWEH.dicn
range: PU
required: false
multivalued: false
description: Value to allow the integral controller to advance beyond the
gate limits (Dicn).
dpv:
slot_uri: cim:GovHydroWEH.dpv
range: PU
required: false
multivalued: false
description: Value to allow the pilot valve controller to advance beyond the
gate limits (Dpv).
dturb:
slot_uri: cim:GovHydroWEH.dturb
range: PU
required: false
multivalued: false
description: Turbine damping factor (Dturb). Unit = delta P (PU of
MWbase) / delta speed (PU).
feedbackSignal:
slot_uri: cim:GovHydroWEH.feedbackSignal
range: boolean
required: false
multivalued: false
description: "Feedback signal selection (Sw).\r\ntrue = PID output\
\ (if R-Perm-Gate = droop and R-Perm-Pe = 0)\r\nfalse = electrical\
\ power (if R-Perm-Gate = 0 and R-Perm-Pe = droop) or\r\n\
false = gate position (if R-Perm-Gate = droop and R-Perm-Pe =\
\ 0).\r\nTypical value = false."
fl1:
slot_uri: cim:GovHydroWEH.fl1
range: PU
required: false
multivalued: false
description: Flowgate 1 (Fl1). Flow value for gate position point
1 for lookup table representing water flow through the turbine as a function
of gate position to produce steady state flow.
fl2:
slot_uri: cim:GovHydroWEH.fl2
range: PU
required: false
multivalued: false
description: Flowgate 2 (Fl2). Flow value for gate position point
2 for lookup table representing water flow through the turbine as a function
of gate position to produce steady state flow.
fl3:
slot_uri: cim:GovHydroWEH.fl3
range: PU
required: false
multivalued: false
description: Flowgate 3 (Fl3). Flow value for gate position point
3 for lookup table representing water flow through the turbine as a function
of gate position to produce steady state flow.
fl4:
slot_uri: cim:GovHydroWEH.fl4
range: PU
required: false
multivalued: false
description: Flowgate 4 (Fl4). Flow value for gate position point
4 for lookup table representing water flow through the turbine as a function
of gate position to produce steady state flow.
fl5:
slot_uri: cim:GovHydroWEH.fl5
range: PU
required: false
multivalued: false
description: Flowgate 5 (Fl5). Flow value for gate position point
5 for lookup table representing water flow through the turbine as a function
of gate position to produce steady state flow.
fp1:
slot_uri: cim:GovHydroWEH.fp1
range: PU
required: false
multivalued: false
description: Flow P1 (Fp1). Turbine flow value for point 1 for lookup
table representing PU mechanical power on machine MVA rating as a function
of turbine flow.
fp10:
slot_uri: cim:GovHydroWEH.fp10
range: PU
required: false
multivalued: false
description: Flow P10 (Fp10). Turbine flow value for point 10 for
lookup table representing PU mechanical power on machine MVA rating as a
function of turbine flow.
fp2:
slot_uri: cim:GovHydroWEH.fp2
range: PU
required: false
multivalued: false
description: Flow P2 (Fp2). Turbine flow value for point 2 for lookup
table representing PU mechanical power on machine MVA rating as a function
of turbine flow.
fp3:
slot_uri: cim:GovHydroWEH.fp3
range: PU
required: false
multivalued: false
description: Flow P3 (Fp3). Turbine flow value for point 3 for lookup
table representing PU mechanical power on machine MVA rating as a function
of turbine flow.
fp4:
slot_uri: cim:GovHydroWEH.fp4
range: PU
required: false
multivalued: false
description: Flow P4 (Fp4). Turbine flow value for point 4 for lookup
table representing PU mechanical power on machine MVA rating as a function
of turbine flow.
fp5:
slot_uri: cim:GovHydroWEH.fp5
range: PU
required: false
multivalued: false
description: Flow P5 (Fp5). Turbine flow value for point 5 for lookup
table representing PU mechanical power on machine MVA rating as a function
of turbine flow.
fp6:
slot_uri: cim:GovHydroWEH.fp6
range: PU
required: false
multivalued: false
description: Flow P6 (Fp6). Turbine flow value for point 6 for lookup
table representing PU mechanical power on machine MVA rating as a function
of turbine flow.
fp7:
slot_uri: cim:GovHydroWEH.fp7
range: PU
required: false
multivalued: false
description: Flow P7 (Fp7). Turbine flow value for point 7 for lookup
table representing PU mechanical power on machine MVA rating as a function
of turbine flow.
fp8:
slot_uri: cim:GovHydroWEH.fp8
range: PU
required: false
multivalued: false
description: Flow P8 (Fp8). Turbine flow value for point 8 for lookup
table representing PU mechanical power on machine MVA rating as a function
of turbine flow.
fp9:
slot_uri: cim:GovHydroWEH.fp9
range: PU
required: false
multivalued: false
description: Flow P9 (Fp9). Turbine flow value for point 9 for lookup
table representing PU mechanical power on machine MVA rating as a function
of turbine flow.
gmax:
slot_uri: cim:GovHydroWEH.gmax
range: PU
required: false
multivalued: false
description: Maximum gate position (Gmax) (> GovHydroWEH.gmin).
gmin:
slot_uri: cim:GovHydroWEH.gmin
range: PU
required: false
multivalued: false
description: Minimum gate position (Gmin) (< GovHydroWEH.gmax).
gtmxcl:
slot_uri: cim:GovHydroWEH.gtmxcl
range: PU
required: false
multivalued: false
description: Maximum gate closing rate (Gtmxcl).
gtmxop:
slot_uri: cim:GovHydroWEH.gtmxop
range: PU
required: false
multivalued: false
description: Maximum gate opening rate (Gtmxop).
gv1:
slot_uri: cim:GovHydroWEH.gv1
range: PU
required: false
multivalued: false
description: Gate 1 (Gv1). Gate Position value for point 1 for lookup
table representing water flow through the turbine as a function of gate
position to produce steady state flow.
gv2:
slot_uri: cim:GovHydroWEH.gv2
range: PU
required: false
multivalued: false
description: Gate 2 (Gv2). Gate Position value for point 2 for lookup
table representing water flow through the turbine as a function of gate
position to produce steady state flow.
gv3:
slot_uri: cim:GovHydroWEH.gv3
range: PU
required: false
multivalued: false
description: Gate 3 (Gv3). Gate Position value for point 3 for lookup
table representing water flow through the turbine as a function of gate
position to produce steady state flow.
gv4:
slot_uri: cim:GovHydroWEH.gv4
range: PU
required: false
multivalued: false
description: Gate 4 (Gv4). Gate Position value for point 4 for lookup
table representing water flow through the turbine as a function of gate
position to produce steady state flow.
gv5:
slot_uri: cim:GovHydroWEH.gv5
range: PU
required: false
multivalued: false
description: Gate 5 (Gv5). Gate Position value for point 5 for lookup
table representing water flow through the turbine as a function of gate
position to produce steady state flow.
kd:
slot_uri: cim:GovHydroWEH.kd
range: PU
required: false
multivalued: false
description: Derivative controller derivative gain (Kd).
ki:
slot_uri: cim:GovHydroWEH.ki
range: PU
required: false
multivalued: false
description: Derivative controller Integral gain (Ki).
kp:
slot_uri: cim:GovHydroWEH.kp
range: PU
required: false
multivalued: false
description: Derivative control gain (Kp).
mwbase:
slot_uri: cim:GovHydroWEH.mwbase
range: ActivePower
required: false
multivalued: false
description: Base for power values (MWbase) (> 0). Unit = MW.
pmss1:
slot_uri: cim:GovHydroWEH.pmss1
range: PU
required: false
multivalued: false
description: Pmss flow P1 (Pmss1). Mechanical power output for turbine
flow point 1 for lookup table representing PU mechanical power on machine
MVA rating as a function of turbine flow.
pmss10:
slot_uri: cim:GovHydroWEH.pmss10
range: PU
required: false
multivalued: false
description: "Pmss flow P10 (Pmss10). Mechanical power output for\
\ turbine flow point 10 for lookup table representing PU mechanical power\
\ on machine MVA rating as a function of turbine flow.\r\n"
pmss2:
slot_uri: cim:GovHydroWEH.pmss2
range: PU
required: false
multivalued: false
description: "Pmss flow P2 (Pmss2). Mechanical power output for turbine\
\ flow point 2 for lookup table representing PU mechanical power on machine\
\ MVA rating as a function of turbine flow.\r\n"
pmss3:
slot_uri: cim:GovHydroWEH.pmss3
range: PU
required: false
multivalued: false
description: "Pmss flow P3 (Pmss3). Mechanical power output for turbine\
\ flow point 3 for lookup table representing PU mechanical power on machine\
\ MVA rating as a function of turbine flow.\r\n"
pmss4:
slot_uri: cim:GovHydroWEH.pmss4
range: PU
required: false
multivalued: false
description: "Pmss flow P4 (Pmss4). Mechanical power output for turbine\
\ flow point 4 for lookup table representing PU mechanical power on machine\
\ MVA rating as a function of turbine flow.\r\n"
pmss5:
slot_uri: cim:GovHydroWEH.pmss5
range: PU
required: false
multivalued: false
description: Pmss flow P5 (Pmss5). Mechanical power output for turbine
flow point 5 for lookup table representing PU mechanical power on machine
MVA rating as a function of turbine flow.
pmss6:
slot_uri: cim:GovHydroWEH.pmss6
range: PU
required: false
multivalued: false
description: Pmss flow P6 (Pmss6). Mechanical power output for turbine
flow point 6 for lookup table representing PU mechanical power on machine
MVA rating as a function of turbine flow.
pmss7:
slot_uri: cim:GovHydroWEH.pmss7
range: PU
required: false
multivalued: false
description: Pmss flow P7 (Pmss7). Mechanical power output for turbine
flow point 7 for lookup table representing PU mechanical power on machine
MVA rating as a function of turbine flow.
pmss8:
slot_uri: cim:GovHydroWEH.pmss8
range: PU
required: false
multivalued: false
description: Pmss flow P8 (Pmss8). Mechanical power output for turbine
flow point 8 for lookup table representing PU mechanical power on machine
MVA rating as a function of turbine flow.
pmss9:
slot_uri: cim:GovHydroWEH.pmss9
range: PU
required: false
multivalued: false
description: Pmss flow P9 (Pmss9). Mechanical power output for turbine
flow point 9 for lookup table representing PU mechanical power on machine
MVA rating as a function of turbine flow.
rpg:
slot_uri: cim:GovHydroWEH.rpg
range: float
required: false
multivalued: false
description: Permanent droop for governor output feedback (R-Perm-Gate).
rpp:
slot_uri: cim:GovHydroWEH.rpp
range: float
required: false
multivalued: false
description: Permanent droop for electrical power feedback (R-Perm-Pe).
td:
slot_uri: cim:GovHydroWEH.td
range: Seconds
required: false
multivalued: false
description: Derivative controller time constant (Td) (>= 0). Limits
the derivative characteristic beyond a breakdown frequency to avoid amplification
of high-frequency noise.
tdv:
slot_uri: cim:GovHydroWEH.tdv
range: Seconds
required: false
multivalued: false
description: Distributive valve time lag time constant (Tdv) (>=
0).
tg:
slot_uri: cim:GovHydroWEH.tg
range: Seconds
required: false
multivalued: false
description: Value to allow the distribution valve controller to advance beyond
the gate movement rate limit (Tg) (>= 0).
tp:
slot_uri: cim:GovHydroWEH.tp
range: Seconds
required: false
multivalued: false
description: Pilot valve time lag time constant (Tp) (>= 0).
tpe:
slot_uri: cim:GovHydroWEH.tpe
range: Seconds
required: false
multivalued: false
description: Electrical power droop time constant (Tpe) (>= 0).
tw:
slot_uri: cim:GovHydroWEH.tw
range: Seconds
required: false
multivalued: false
description: Water inertia time constant (Tw) (> 0).
GovHydroWPID:
class_uri: cim:GovHydroWPID
is_a: TurbineGovernorDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.TurbineGovernorDynamics
description: "WoodwardTM PID hydro governor.\r\n[Footnote: Woodward\
\ PID hydro governors are an example of suitable products available commercially.\
\ This information is given for the convenience of users of this document and\
\ does not constitute an endorsement by IEC of these products.]"
attributes:
d:
slot_uri: cim:GovHydroWPID.d
range: PU
required: false
multivalued: false
description: Turbine damping factor (D). Unit = delta P / delta speed.
gatmax:
slot_uri: cim:GovHydroWPID.gatmax
range: PU
required: false
multivalued: false
description: Gate opening limit maximum (Gatmax) (> GovHydroWPID.gatmin).
gatmin:
slot_uri: cim:GovHydroWPID.gatmin
range: PU
required: false
multivalued: false
description: Gate opening limit minimum (Gatmin) (< GovHydroWPID.gatmax).
gv1:
slot_uri: cim:GovHydroWPID.gv1
range: PU
required: false
multivalued: false
description: Gate position 1 (Gv1).
gv2:
slot_uri: cim:GovHydroWPID.gv2
range: PU
required: false
multivalued: false
description: 'Gate position 2 (Gv2). '
gv3:
slot_uri: cim:GovHydroWPID.gv3
range: PU
required: false
multivalued: false
description: Gate position 3 (Gv3) (= 1,0).
kd:
slot_uri: cim:GovHydroWPID.kd
range: PU
required: false
multivalued: false
description: Derivative gain (Kd). Typical value = 1,11.
ki:
slot_uri: cim:GovHydroWPID.ki
range: PU
required: false
multivalued: false
description: Reset gain (Ki). Typical value = 0,36.
kp:
slot_uri: cim:GovHydroWPID.kp
range: PU
required: false
multivalued: false
description: Proportional gain (Kp). Typical value = 0,1.
mwbase:
slot_uri: cim:GovHydroWPID.mwbase
range: ActivePower
required: false
multivalued: false
description: Base for power values (MWbase) (> 0). Unit = MW.
pgv1:
slot_uri: cim:GovHydroWPID.pgv1
range: PU
required: false
multivalued: false
description: Output at Gv1 PU of MWbase (Pgv1).
pgv2:
slot_uri: cim:GovHydroWPID.pgv2
range: PU
required: false
multivalued: false
description: Output at Gv2 PU of MWbase (Pgv2).
pgv3:
slot_uri: cim:GovHydroWPID.pgv3
range: PU
required: false
multivalued: false
description: 'Output at Gv3 PU of MWbase (Pgv3). '
pmax:
slot_uri: cim:GovHydroWPID.pmax
range: PU
required: false
multivalued: false
description: Maximum power output (Pmax) (> GovHydroWPID.pmin).
pmin:
slot_uri: cim:GovHydroWPID.pmin
range: PU
required: false
multivalued: false
description: Minimum power output (Pmin) (< GovHydroWPID.pmax).
reg:
slot_uri: cim:GovHydroWPID.reg
range: PU
required: false
multivalued: false
description: Permanent drop (Reg).
ta:
slot_uri: cim:GovHydroWPID.ta
range: Seconds
required: false
multivalued: false
description: Controller time constant (Ta) (>= 0). Typical value
= 0.
tb:
slot_uri: cim:GovHydroWPID.tb
range: Seconds
required: false
multivalued: false
description: Gate servo time constant (Tb) (>= 0). Typical value
= 0.
treg:
slot_uri: cim:GovHydroWPID.treg
range: Seconds
required: false
multivalued: false
description: Speed detector time constant (Treg) (>= 0).
tw:
slot_uri: cim:GovHydroWPID.tw
range: Seconds
required: false
multivalued: false
description: Water inertia time constant (Tw) (>= 0). Typical value
= 0.
velmax:
slot_uri: cim:GovHydroWPID.velmax
range: PU
required: false
multivalued: false
description: Maximum gate opening velocity (Velmax) (> GovHydroWPID.velmin). Unit
= PU / s. Typical value = 0.
velmin:
slot_uri: cim:GovHydroWPID.velmin
range: PU
required: false
multivalued: false
description: Maximum gate closing velocity (Velmin) (< GovHydroWPID.velmax). Unit
= PU / s. Typical value = 0.
GovSteam0:
class_uri: cim:GovSteam0
is_a: TurbineGovernorDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.TurbineGovernorDynamics
description: A simplified steam turbine governor.
attributes:
dt:
slot_uri: cim:GovSteam0.dt
range: PU
required: false
multivalued: false
description: Turbine damping coefficient (Dt). Unit = delta P / delta
speed. Typical value = 0.
mwbase:
slot_uri: cim:GovSteam0.mwbase
range: ActivePower
required: false
multivalued: false
description: Base for power values (MWbase) (> 0). Unit = MW.
r:
slot_uri: cim:GovSteam0.r
range: PU
required: false
multivalued: false
description: Permanent droop (R). Typical value = 0,05.
t1:
slot_uri: cim:GovSteam0.t1
range: Seconds
required: false
multivalued: false
description: Steam bowl time constant (T1) (> 0). Typical value
= 0,5.
t2:
slot_uri: cim:GovSteam0.t2
range: Seconds
required: false
multivalued: false
description: Numerator time constant of T2/T3 block (T2)
(>= 0). Typical value = 3.
t3:
slot_uri: cim:GovSteam0.t3
range: Seconds
required: false
multivalued: false
description: Reheater time constant (T3) (> 0). Typical value =
10.
vmax:
slot_uri: cim:GovSteam0.vmax
range: PU
required: false
multivalued: false
description: Maximum valve position, PU of mwcap (Vmax) (>
GovSteam0.vmin). Typical value = 1.
vmin:
slot_uri: cim:GovSteam0.vmin
range: PU
required: false
multivalued: false
description: Minimum valve position, PU of mwcap (Vmin) (<
GovSteam0.vmax). Typical value = 0.
GovSteam1:
class_uri: cim:GovSteam1
is_a: TurbineGovernorDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.TurbineGovernorDynamics
description: 'Steam turbine governor, based on the GovSteamIEEE1 (with optional
deadband and nonlinear valve gain added). '
attributes:
db1:
slot_uri: cim:GovSteam1.db1
range: Frequency
required: false
multivalued: false
description: Intentional deadband width (db1). Unit = Hz. Typical
value = 0.
db2:
slot_uri: cim:GovSteam1.db2
range: ActivePower
required: false
multivalued: false
description: Unintentional deadband (db2). Unit = MW. Typical value
= 0.
eps:
slot_uri: cim:GovSteam1.eps
range: Frequency
required: false
multivalued: false
description: Intentional db hysteresis (eps). Unit = Hz. Typical
value = 0.
gv1:
slot_uri: cim:GovSteam1.gv1
range: PU
required: false
multivalued: false
description: Nonlinear gain valve position point 1 (GV1). Typical
value = 0.
gv2:
slot_uri: cim:GovSteam1.gv2
range: PU
required: false
multivalued: false
description: Nonlinear gain valve position point 2 (GV2). Typical
value = 0,4.
gv3:
slot_uri: cim:GovSteam1.gv3
range: PU
required: false
multivalued: false
description: Nonlinear gain valve position point 3 (GV3). Typical
value = 0,5.
gv4:
slot_uri: cim:GovSteam1.gv4
range: PU
required: false
multivalued: false
description: Nonlinear gain valve position point 4 (GV4). Typical
value = 0,6.
gv5:
slot_uri: cim:GovSteam1.gv5
range: PU
required: false
multivalued: false
description: Nonlinear gain valve position point 5 (GV5). Typical
value = 1.
gv6:
slot_uri: cim:GovSteam1.gv6
range: PU
required: false
multivalued: false
description: Nonlinear gain valve position point 6 (GV6). Typical
value = 0.
k:
slot_uri: cim:GovSteam1.k
range: PU
required: false
multivalued: false
description: Governor gain (reciprocal of droop) (K) (> 0). Typical
value = 25.
k1:
slot_uri: cim:GovSteam1.k1
range: float
required: false
multivalued: false
description: Fraction of HP shaft power after first boiler pass (K1). Typical
value = 0,2.
k2:
slot_uri: cim:GovSteam1.k2
range: float
required: false
multivalued: false
description: Fraction of LP shaft power after first boiler pass (K2). Typical
value = 0.
k3:
slot_uri: cim:GovSteam1.k3
range: float
required: false
multivalued: false
description: Fraction of HP shaft power after second boiler pass (K3). Typical
value = 0,3.
k4:
slot_uri: cim:GovSteam1.k4
range: float
required: false
multivalued: false
description: Fraction of LP shaft power after second boiler pass (K4). Typical
value = 0.
k5:
slot_uri: cim:GovSteam1.k5
range: float
required: false
multivalued: false
description: Fraction of HP shaft power after third boiler pass (K5). Typical
value = 0,5.
k6:
slot_uri: cim:GovSteam1.k6
range: float
required: false
multivalued: false
description: Fraction of LP shaft power after third boiler pass (K6). Typical
value = 0.
k7:
slot_uri: cim:GovSteam1.k7
range: float
required: false
multivalued: false
description: Fraction of HP shaft power after fourth boiler pass (K7). Typical
value = 0.
k8:
slot_uri: cim:GovSteam1.k8
range: float
required: false
multivalued: false
description: Fraction of LP shaft power after fourth boiler pass (K8). Typical
value = 0.
mwbase:
slot_uri: cim:GovSteam1.mwbase
range: ActivePower
required: false
multivalued: false
description: Base for power values (MWbase) (> 0). Unit = MW.
pgv1:
slot_uri: cim:GovSteam1.pgv1
range: PU
required: false
multivalued: false
description: Nonlinear gain power value point 1 (Pgv1). Typical value
= 0.
pgv2:
slot_uri: cim:GovSteam1.pgv2
range: PU
required: false
multivalued: false
description: Nonlinear gain power value point 2 (Pgv2). Typical value
= 0,75.
pgv3:
slot_uri: cim:GovSteam1.pgv3
range: PU
required: false
multivalued: false
description: Nonlinear gain power value point 3 (Pgv3). Typical value
= 0,91.
pgv4:
slot_uri: cim:GovSteam1.pgv4
range: PU
required: false
multivalued: false
description: Nonlinear gain power value point 4 (Pgv4). Typical value
= 0,98.
pgv5:
slot_uri: cim:GovSteam1.pgv5
range: PU
required: false
multivalued: false
description: Nonlinear gain power value point 5 (Pgv5). Typical value
= 1.
pgv6:
slot_uri: cim:GovSteam1.pgv6
range: PU
required: false
multivalued: false
description: Nonlinear gain power value point 6 (Pgv6). Typical value
= 0.
pmax:
slot_uri: cim:GovSteam1.pmax
range: PU
required: false
multivalued: false
description: Maximum valve opening (Pmax) (> GovSteam1.pmin). Typical
value = 1.
pmin:
slot_uri: cim:GovSteam1.pmin
range: PU
required: false
multivalued: false
description: Minimum valve opening (Pmin) (>= 0 and < GovSteam1.pmax). Typical
value = 0.
sdb1:
slot_uri: cim:GovSteam1.sdb1
range: boolean
required: false
multivalued: false
description: "Intentional deadband indicator.\r\ntrue = intentional deadband\
\ is applied\r\nfalse = intentional deadband is not applied.\r\nTypical\
\ value = true."
sdb2:
slot_uri: cim:GovSteam1.sdb2
range: boolean
required: false
multivalued: false
description: "Unintentional deadband location.\r\ntrue = intentional deadband\
\ is applied before point \"A\"\r\nfalse = intentional deadband is applied\
\ after point \"A\".\r\nTypical value = true."
t1:
slot_uri: cim:GovSteam1.t1
range: Seconds
required: false
multivalued: false
description: Governor lag time constant (T1) (>= 0). Typical value
= 0.
t2:
slot_uri: cim:GovSteam1.t2
range: Seconds
required: false
multivalued: false
description: Governor lead time constant (T2) (>= 0). Typical value
= 0.
t3:
slot_uri: cim:GovSteam1.t3
range: Seconds
required: false
multivalued: false
description: Valve positioner time constant (T3) (> 0). Typical
value = 0,1.
t4:
slot_uri: cim:GovSteam1.t4
range: Seconds
required: false
multivalued: false
description: Inlet piping/steam bowl time constant (T4) (>= 0). Typical
value = 0,3.
t5:
slot_uri: cim:GovSteam1.t5
range: Seconds
required: false
multivalued: false
description: Time constant of second boiler pass (T5) (>= 0). Typical
value = 5.
t6:
slot_uri: cim:GovSteam1.t6
range: Seconds
required: false
multivalued: false
description: Time constant of third boiler pass (T6) (>= 0). Typical
value = 0,5.
t7:
slot_uri: cim:GovSteam1.t7
range: Seconds
required: false
multivalued: false
description: Time constant of fourth boiler pass (T7) (>= 0). Typical
value = 0.
uc:
slot_uri: cim:GovSteam1.uc
range: float
required: false
multivalued: false
description: Maximum valve closing velocity (Uc) (< 0). Unit =
PU / s. Typical value = -10.
uo:
slot_uri: cim:GovSteam1.uo
range: float
required: false
multivalued: false
description: Maximum valve opening velocity (Uo) (> 0). Unit =
PU / s. Typical value = 1.
valve:
slot_uri: cim:GovSteam1.valve
range: boolean
required: false
multivalued: false
description: "Nonlinear valve characteristic.\r\ntrue = nonlinear valve characteristic\
\ is used\r\nfalse = nonlinear valve characteristic is not used.\r\nTypical\
\ value = true."
GovSteam2:
class_uri: cim:GovSteam2
is_a: TurbineGovernorDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.TurbineGovernorDynamics
description: Simplified governor.
attributes:
dbf:
slot_uri: cim:GovSteam2.dbf
range: PU
required: false
multivalued: false
description: Frequency deadband (DBF). Typical value = 0.
k:
slot_uri: cim:GovSteam2.k
range: float
required: false
multivalued: false
description: Governor gain (reciprocal of droop) (K). Typical value
= 20.
mnef:
slot_uri: cim:GovSteam2.mnef
range: PU
required: false
multivalued: false
description: Fuel flow maximum negative error value (MNEF). Typical
value = -1.
mxef:
slot_uri: cim:GovSteam2.mxef
range: PU
required: false
multivalued: false
description: Fuel flow maximum positive error value (MXEF). Typical
value = 1.
pmax:
slot_uri: cim:GovSteam2.pmax
range: PU
required: false
multivalued: false
description: Maximum fuel flow (PMAX) (> GovSteam2.pmin). Typical
value = 1.
pmin:
slot_uri: cim:GovSteam2.pmin
range: PU
required: false
multivalued: false
description: Minimum fuel flow (PMIN) (< GovSteam2.pmax). Typical
value = 0.
t1:
slot_uri: cim:GovSteam2.t1
range: Seconds
required: false
multivalued: false
description: Governor lag time constant (T1) (>
0). Typical value = 0,45.
t2:
slot_uri: cim:GovSteam2.t2
range: Seconds
required: false
multivalued: false
description: Governor lead time constant (T2) (>=
0). Typical value = 0.
GovSteamBB:
class_uri: cim:GovSteamBB
is_a: TurbineGovernorDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.TurbineGovernorDynamics
description: European governor model.
attributes:
fcut:
slot_uri: cim:GovSteamBB.fcut
range: PU
required: false
multivalued: false
description: Frequency deadband (fcut) (>= 0). Typical
value = 0,002.
k2:
slot_uri: cim:GovSteamBB.k2
range: PU
required: false
multivalued: false
description: Gain (K2). Typical value = 0,75.
k3:
slot_uri: cim:GovSteamBB.k3
range: PU
required: false
multivalued: false
description: Gain (K3). Typical value = 0,5.
kd:
slot_uri: cim:GovSteamBB.kd
range: PU
required: false
multivalued: false
description: Gain (Kd). Typical value = 1,0.
kg:
slot_uri: cim:GovSteamBB.kg
range: PU
required: false
multivalued: false
description: Gain (Kg). Typical value = 1,0.
kls:
slot_uri: cim:GovSteamBB.kls
range: PU
required: false
multivalued: false
description: Gain (Kls) (> 0). Typical value = 0,1.
kp:
slot_uri: cim:GovSteamBB.kp
range: PU
required: false
multivalued: false
description: Gain (Kp). Typical value = 1,0.
ks:
slot_uri: cim:GovSteamBB.ks
range: PU
required: false
multivalued: false
description: Gain (Ks). Typical value = 21,0.
peflag:
slot_uri: cim:GovSteamBB.peflag
range: boolean
required: false
multivalued: false
description: "Electric power input selection (Peflag). \r\ntrue = electric\
\ power input\r\nfalse = feedback signal.\r\nTypical value = false."
pmax:
slot_uri: cim:GovSteamBB.pmax
range: PU
required: false
multivalued: false
description: High power limit (Pmax) (> GovSteamBB.pmin). Typical
value = 1,0.
pmin:
slot_uri: cim:GovSteamBB.pmin
range: PU
required: false
multivalued: false
description: Low power limit (Pmin) (< GovSteamBB.pmax). Typical
value = 0.
t1:
slot_uri: cim:GovSteamBB.t1
range: Seconds
required: false
multivalued: false
description: Time constant (T1). Typical value = 0,05.
t4:
slot_uri: cim:GovSteamBB.t4
range: Seconds
required: false
multivalued: false
description: Time constant (T4). Typical value = 0,15.
t5:
slot_uri: cim:GovSteamBB.t5
range: Seconds
required: false
multivalued: false
description: Time constant (T5). Typical value = 12,0.
t6:
slot_uri: cim:GovSteamBB.t6
range: Seconds
required: false
multivalued: false
description: Time constant (T6). Typical value = 0,75.
td:
slot_uri: cim:GovSteamBB.td
range: Seconds
required: false
multivalued: false
description: Time constant (Td) (> 0). Typical value = 1,0.
tn:
slot_uri: cim:GovSteamBB.tn
range: Seconds
required: false
multivalued: false
description: Time constant (Tn) (> 0). Typical value = 1,0.
GovSteamCC:
class_uri: cim:GovSteamCC
is_a: CrossCompoundTurbineGovernorDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.TurbineGovernorDynamics
description: Cross compound turbine governor. Unlike tandem compound units, cross
compound units are not on the same shaft.
attributes:
dhp:
slot_uri: cim:GovSteamCC.dhp
range: PU
required: false
multivalued: false
description: HP damping factor (Dhp). Typical value = 0.
dlp:
slot_uri: cim:GovSteamCC.dlp
range: PU
required: false
multivalued: false
description: LP damping factor (Dlp). Typical value = 0.
fhp:
slot_uri: cim:GovSteamCC.fhp
range: PU
required: false
multivalued: false
description: Fraction of HP power ahead of reheater (Fhp). Typical
value = 0,3.
flp:
slot_uri: cim:GovSteamCC.flp
range: PU
required: false
multivalued: false
description: Fraction of LP power ahead of reheater (Flp). Typical
value = 0,7.
mwbase:
slot_uri: cim:GovSteamCC.mwbase
range: ActivePower
required: false
multivalued: false
description: Base for power values (MWbase) (> 0). Unit = MW.
pmaxhp:
slot_uri: cim:GovSteamCC.pmaxhp
range: PU
required: false
multivalued: false
description: Maximum HP value position (Pmaxhp). Typical value = 1.
pmaxlp:
slot_uri: cim:GovSteamCC.pmaxlp
range: PU
required: false
multivalued: false
description: Maximum LP value position (Pmaxlp). Typical value = 1.
rhp:
slot_uri: cim:GovSteamCC.rhp
range: PU
required: false
multivalued: false
description: HP governor droop (Rhp) (> 0). Typical value = 0,05.
rlp:
slot_uri: cim:GovSteamCC.rlp
range: PU
required: false
multivalued: false
description: LP governor droop (Rlp) (> 0). Typical value = 0,05.
t1hp:
slot_uri: cim:GovSteamCC.t1hp
range: Seconds
required: false
multivalued: false
description: HP governor time constant (T1hp) (>= 0). Typical value
= 0,1.
t1lp:
slot_uri: cim:GovSteamCC.t1lp
range: Seconds
required: false
multivalued: false
description: LP governor time constant (T1lp) (>= 0). Typical value
= 0,1.
t3hp:
slot_uri: cim:GovSteamCC.t3hp
range: Seconds
required: false
multivalued: false
description: HP turbine time constant (T3hp) (>= 0). Typical value
= 0,1.
t3lp:
slot_uri: cim:GovSteamCC.t3lp
range: Seconds
required: false
multivalued: false
description: LP turbine time constant (T3lp) (>= 0). Typical value
= 0,1.
t4hp:
slot_uri: cim:GovSteamCC.t4hp
range: Seconds
required: false
multivalued: false
description: HP turbine time constant (T4hp) (>= 0). Typical value
= 0,1.
t4lp:
slot_uri: cim:GovSteamCC.t4lp
range: Seconds
required: false
multivalued: false
description: LP turbine time constant (T4lp) (>= 0). Typical value
= 0,1.
t5hp:
slot_uri: cim:GovSteamCC.t5hp
range: Seconds
required: false
multivalued: false
description: HP reheater time constant (T5hp) (>= 0). Typical value
= 10.
t5lp:
slot_uri: cim:GovSteamCC.t5lp
range: Seconds
required: false
multivalued: false
description: LP reheater time constant (T5lp) (>= 0). Typical value
= 10.
GovSteamEU:
class_uri: cim:GovSteamEU
is_a: TurbineGovernorDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.TurbineGovernorDynamics
description: Simplified boiler and steam turbine with PID governor.
attributes:
chc:
slot_uri: cim:GovSteamEU.chc
range: float
required: false
multivalued: false
description: Control valves rate closing limit (Chc). Unit = PU /
s. Typical value = -3,3.
cho:
slot_uri: cim:GovSteamEU.cho
range: float
required: false
multivalued: false
description: Control valves rate opening limit (Cho). Unit = PU /
s. Typical value = 0,17.
cic:
slot_uri: cim:GovSteamEU.cic
range: PU
required: false
multivalued: false
description: Intercept valves rate closing limit (Cic). Typical value
= -2,2.
cio:
slot_uri: cim:GovSteamEU.cio
range: PU
required: false
multivalued: false
description: Intercept valves rate opening limit (Cio). Typical value
= 0,123.
db1:
slot_uri: cim:GovSteamEU.db1
range: PU
required: false
multivalued: false
description: Deadband of the frequency corrector (db1). Typical value
= 0.
db2:
slot_uri: cim:GovSteamEU.db2
range: PU
required: false
multivalued: false
description: Deadband of the speed governor (db2). Typical value =
0,0004.
hhpmax:
slot_uri: cim:GovSteamEU.hhpmax
range: PU
required: false
multivalued: false
description: Maximum control valve position (Hhpmax). Typical value
= 1.
ke:
slot_uri: cim:GovSteamEU.ke
range: PU
required: false
multivalued: false
description: Gain of the power controller (Ke). Typical value = 0,65.
kfcor:
slot_uri: cim:GovSteamEU.kfcor
range: PU
required: false
multivalued: false
description: Gain of the frequency corrector (Kfcor). Typical value
= 20.
khp:
slot_uri: cim:GovSteamEU.khp
range: PU
required: false
multivalued: false
description: Fraction of total turbine output generated by HP part (Khp). Typical
value = 0,277.
klp:
slot_uri: cim:GovSteamEU.klp
range: PU
required: false
multivalued: false
description: Fraction of total turbine output generated by HP part (Klp). Typical
value = 0,723.
komegacor:
slot_uri: cim:GovSteamEU.komegacor
range: PU
required: false
multivalued: false
description: Gain of the speed governor (Kwcor). Typical value = 20.
mwbase:
slot_uri: cim:GovSteamEU.mwbase
range: ActivePower
required: false
multivalued: false
description: Base for power values (MWbase) (> 0). Unit = MW.
pmax:
slot_uri: cim:GovSteamEU.pmax
range: PU
required: false
multivalued: false
description: Maximal active power of the turbine (Pmax). Typical value
= 1.
prhmax:
slot_uri: cim:GovSteamEU.prhmax
range: PU
required: false
multivalued: false
description: Maximum low pressure limit (Prhmax). Typical value =
1,4.
simx:
slot_uri: cim:GovSteamEU.simx
range: PU
required: false
multivalued: false
description: Intercept valves transfer limit (Simx). Typical value
= 0,425.
tb:
slot_uri: cim:GovSteamEU.tb
range: Seconds
required: false
multivalued: false
description: Boiler time constant (Tb) (>= 0). Typical value =
100.
tdp:
slot_uri: cim:GovSteamEU.tdp
range: Seconds
required: false
multivalued: false
description: Derivative time constant of the power controller (Tdp)
(>= 0). Typical value = 0.
ten:
slot_uri: cim:GovSteamEU.ten
range: Seconds
required: false
multivalued: false
description: Electro hydraulic transducer (Ten) (>= 0). Typical
value = 0,1.
tf:
slot_uri: cim:GovSteamEU.tf
range: Seconds
required: false
multivalued: false
description: Frequency transducer time constant (Tf) (>= 0). Typical
value = 0.
tfp:
slot_uri: cim:GovSteamEU.tfp
range: Seconds
required: false
multivalued: false
description: Time constant of the power controller (Tfp) (>= 0). Typical
value = 0.
thp:
slot_uri: cim:GovSteamEU.thp
range: Seconds
required: false
multivalued: false
description: High pressure (HP) time constant of the turbine (Thp)
(>= 0). Typical value = 0,31.
tip:
slot_uri: cim:GovSteamEU.tip
range: Seconds
required: false
multivalued: false
description: Integral time constant of the power controller (Tip) (>=
0). Typical value = 2.
tlp:
slot_uri: cim:GovSteamEU.tlp
range: Seconds
required: false
multivalued: false
description: Low pressure (LP) time constant of the turbine (Tlp) (>=
0). Typical value = 0,45.
tp:
slot_uri: cim:GovSteamEU.tp
range: Seconds
required: false
multivalued: false
description: Power transducer time constant (Tp) (>= 0). Typical
value = 0,07.
trh:
slot_uri: cim:GovSteamEU.trh
range: Seconds
required: false
multivalued: false
description: Reheater time constant of the turbine (Trh) (>= 0). Typical
value = 8.
tvhp:
slot_uri: cim:GovSteamEU.tvhp
range: Seconds
required: false
multivalued: false
description: Control valves servo time constant (Tvhp) (>= 0). Typical
value = 0,1.
tvip:
slot_uri: cim:GovSteamEU.tvip
range: Seconds
required: false
multivalued: false
description: Intercept valves servo time constant (Tvip) (>= 0). Typical
value = 0,15.
tw:
slot_uri: cim:GovSteamEU.tw
range: Seconds
required: false
multivalued: false
description: Speed transducer time constant (Tw) (>= 0). Typical
value = 0,02.
wfmax:
slot_uri: cim:GovSteamEU.wfmax
range: PU
required: false
multivalued: false
description: Upper limit for frequency correction (Wfmax) (> GovSteamEU.wfmin). Typical
value = 0,05.
wfmin:
slot_uri: cim:GovSteamEU.wfmin
range: PU
required: false
multivalued: false
description: Lower limit for frequency correction (Wfmin) (< GovSteamEU.wfmax). Typical
value = -0,05.
wmax1:
slot_uri: cim:GovSteamEU.wmax1
range: PU
required: false
multivalued: false
description: Emergency speed control lower limit (wmax1). Typical
value = 1,025.
wmax2:
slot_uri: cim:GovSteamEU.wmax2
range: PU
required: false
multivalued: false
description: Emergency speed control upper limit (wmax2). Typical
value = 1,05.
wwmax:
slot_uri: cim:GovSteamEU.wwmax
range: PU
required: false
multivalued: false
description: Upper limit for the speed governor (Wwmax) (> GovSteamEU.wwmin). Typical
value = 0,1.
wwmin:
slot_uri: cim:GovSteamEU.wwmin
range: PU
required: false
multivalued: false
description: Lower limit for the speed governor frequency correction (Wwmin)
(< GovSteamEU.wwmax). Typical value = -1.
GovSteamFV2:
class_uri: cim:GovSteamFV2
is_a: TurbineGovernorDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.TurbineGovernorDynamics
description: Steam turbine governor with reheat time constants and modelling of
the effects of fast valve closing to reduce mechanical power.
attributes:
dt:
slot_uri: cim:GovSteamFV2.dt
range: PU
required: false
multivalued: false
description: (Dt).
k:
slot_uri: cim:GovSteamFV2.k
range: PU
required: false
multivalued: false
description: Fraction of the turbine power developed by turbine sections not
involved in fast valving (K).
mwbase:
slot_uri: cim:GovSteamFV2.mwbase
range: ActivePower
required: false
multivalued: false
description: Alternate base used instead of machine base in equipment model
if necessary (MWbase) (> 0). Unit = MW.
r:
slot_uri: cim:GovSteamFV2.r
range: PU
required: false
multivalued: false
description: (R).
t1:
slot_uri: cim:GovSteamFV2.t1
range: Seconds
required: false
multivalued: false
description: Governor time constant (T1) (>= 0).
t3:
slot_uri: cim:GovSteamFV2.t3
range: Seconds
required: false
multivalued: false
description: Reheater time constant (T3) (>= 0).
ta:
slot_uri: cim:GovSteamFV2.ta
range: Seconds
required: false
multivalued: false
description: Time after initial time for valve to close (Ta) (>=
0).
tb:
slot_uri: cim:GovSteamFV2.tb
range: Seconds
required: false
multivalued: false
description: Time after initial time for valve to begin opening (Tb)
(>= 0).
tc:
slot_uri: cim:GovSteamFV2.tc
range: Seconds
required: false
multivalued: false
description: Time after initial time for valve to become fully open (Tc)
(>= 0).
tt:
slot_uri: cim:GovSteamFV2.tt
range: Seconds
required: false
multivalued: false
description: Time constant with which power falls off after intercept valve
closure (Tt) (>= 0).
vmax:
slot_uri: cim:GovSteamFV2.vmax
range: PU
required: false
multivalued: false
description: (Vmax) (> GovSteamFV2.vmin).
vmin:
slot_uri: cim:GovSteamFV2.vmin
range: PU
required: false
multivalued: false
description: (Vmin) (< GovSteamFV2.vmax).
GovSteamFV3:
class_uri: cim:GovSteamFV3
is_a: TurbineGovernorDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.TurbineGovernorDynamics
description: Simplified GovSteamIEEE1 steam turbine governor with Prmax limit
and fast valving.
attributes:
gv1:
slot_uri: cim:GovSteamFV3.gv1
range: PU
required: false
multivalued: false
description: Nonlinear gain valve position point 1 (GV1). Typical
value = 0.
gv2:
slot_uri: cim:GovSteamFV3.gv2
range: PU
required: false
multivalued: false
description: Nonlinear gain valve position point 2 (GV2). Typical
value = 0,4.
gv3:
slot_uri: cim:GovSteamFV3.gv3
range: PU
required: false
multivalued: false
description: Nonlinear gain valve position point 3 (GV3). Typical
value = 0,5.
gv4:
slot_uri: cim:GovSteamFV3.gv4
range: PU
required: false
multivalued: false
description: Nonlinear gain valve position point 4 (GV4). Typical
value = 0,6.
gv5:
slot_uri: cim:GovSteamFV3.gv5
range: PU
required: false
multivalued: false
description: Nonlinear gain valve position point 5 (GV5). Typical
value = 1.
gv6:
slot_uri: cim:GovSteamFV3.gv6
range: PU
required: false
multivalued: false
description: Nonlinear gain valve position point 6 (GV6). Typical
value = 0.
k:
slot_uri: cim:GovSteamFV3.k
range: PU
required: false
multivalued: false
description: Governor gain, (reciprocal of droop) (K). Typical value
= 20.
k1:
slot_uri: cim:GovSteamFV3.k1
range: PU
required: false
multivalued: false
description: Fraction of turbine power developed after first boiler pass (K1). Typical
value = 0,2.
k2:
slot_uri: cim:GovSteamFV3.k2
range: PU
required: false
multivalued: false
description: Fraction of turbine power developed after second boiler pass
(K2). Typical value = 0,2.
k3:
slot_uri: cim:GovSteamFV3.k3
range: PU
required: false
multivalued: false
description: Fraction of hp turbine power developed after crossover or third
boiler pass (K3). Typical value = 0,6.
mwbase:
slot_uri: cim:GovSteamFV3.mwbase
range: ActivePower
required: false
multivalued: false
description: Base for power values (MWbase) (> 0). Unit = MW.
pgv1:
slot_uri: cim:GovSteamFV3.pgv1
range: PU
required: false
multivalued: false
description: Nonlinear gain power value point 1 (Pgv1). Typical value
= 0.
pgv2:
slot_uri: cim:GovSteamFV3.pgv2
range: PU
required: false
multivalued: false
description: Nonlinear gain power value point 2 (Pgv2). Typical value
= 0,75.
pgv3:
slot_uri: cim:GovSteamFV3.pgv3
range: PU
required: false
multivalued: false
description: Nonlinear gain power value point 3 (Pgv3). Typical value
= 0,91.
pgv4:
slot_uri: cim:GovSteamFV3.pgv4
range: PU
required: false
multivalued: false
description: Nonlinear gain power value point 4 (Pgv4). Typical value
= 0,98.
pgv5:
slot_uri: cim:GovSteamFV3.pgv5
range: PU
required: false
multivalued: false
description: Nonlinear gain power value point 5 (Pgv5). Typical value
= 1.
pgv6:
slot_uri: cim:GovSteamFV3.pgv6
range: PU
required: false
multivalued: false
description: Nonlinear gain power value point 6 (Pgv6). Typical value
= 0.
pmax:
slot_uri: cim:GovSteamFV3.pmax
range: PU
required: false
multivalued: false
description: Maximum valve opening, PU of MWbase (Pmax) (>
GovSteamFV3.pmin). Typical value = 1.
pmin:
slot_uri: cim:GovSteamFV3.pmin
range: PU
required: false
multivalued: false
description: Minimum valve opening, PU of MWbase (Pmin) (<
GovSteamFV3.pmax). Typical value = 0.
prmax:
slot_uri: cim:GovSteamFV3.prmax
range: PU
required: false
multivalued: false
description: Max. pressure in reheater (Prmax). Typical value = 1.
t1:
slot_uri: cim:GovSteamFV3.t1
range: Seconds
required: false
multivalued: false
description: Governor lead time constant (T1) (>= 0). Typical value
= 0.
t2:
slot_uri: cim:GovSteamFV3.t2
range: Seconds
required: false
multivalued: false
description: Governor lag time constant (T2) (>= 0). Typical value
= 0.
t3:
slot_uri: cim:GovSteamFV3.t3
range: Seconds
required: false
multivalued: false
description: Valve positioner time constant (T3) (> 0). Typical
value = 0.
t4:
slot_uri: cim:GovSteamFV3.t4
range: Seconds
required: false
multivalued: false
description: Inlet piping/steam bowl time constant (T4) (>= 0). Typical
value = 0,2.
t5:
slot_uri: cim:GovSteamFV3.t5
range: Seconds
required: false
multivalued: false
description: Time constant of second boiler pass (i.e. reheater) (T5)
(> 0 if fast valving is used, otherwise >= 0). Typical value = 0,5.
t6:
slot_uri: cim:GovSteamFV3.t6
range: Seconds
required: false
multivalued: false
description: Time constant of crossover or third boiler pass (T6) (>=
0). Typical value = 10.
ta:
slot_uri: cim:GovSteamFV3.ta
range: Seconds
required: false
multivalued: false
description: Time to close intercept valve (IV) (Ta) (>= 0). Typical
value = 0,97.
tb:
slot_uri: cim:GovSteamFV3.tb
range: Seconds
required: false
multivalued: false
description: Time until IV starts to reopen (Tb) (>= 0). Typical
value = 0,98.
tc:
slot_uri: cim:GovSteamFV3.tc
range: Seconds
required: false
multivalued: false
description: Time until IV is fully open (Tc) (>= 0). Typical value
= 0,99.
uc:
slot_uri: cim:GovSteamFV3.uc
range: float
required: false
multivalued: false
description: Maximum valve closing velocity (Uc). Unit = PU / s. Typical
value = -1.
uo:
slot_uri: cim:GovSteamFV3.uo
range: float
required: false
multivalued: false
description: Maximum valve opening velocity (Uo). Unit = PU / s. Typical
value = 0,1.
GovSteamFV4:
class_uri: cim:GovSteamFV4
is_a: TurbineGovernorDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.TurbineGovernorDynamics
description: Detailed electro-hydraulic governor for steam unit.
attributes:
cpsmn:
slot_uri: cim:GovSteamFV4.cpsmn
range: PU
required: false
multivalued: false
description: Minimum value of pressure regulator output (Cpsmn). Typical
value = -1.
cpsmx:
slot_uri: cim:GovSteamFV4.cpsmx
range: PU
required: false
multivalued: false
description: Maximum value of pressure regulator output (Cpsmx). Typical
value = 1.
crmn:
slot_uri: cim:GovSteamFV4.crmn
range: PU
required: false
multivalued: false
description: Minimum value of regulator set-point (Crmn). Typical
value = 0.
crmx:
slot_uri: cim:GovSteamFV4.crmx
range: PU
required: false
multivalued: false
description: Maximum value of regulator set-point (Crmx). Typical
value = 1,2.
kdc:
slot_uri: cim:GovSteamFV4.kdc
range: PU
required: false
multivalued: false
description: Derivative gain of pressure regulator (Kdc). Typical
value = 1.
kf1:
slot_uri: cim:GovSteamFV4.kf1
range: PU
required: false
multivalued: false
description: Frequency bias (reciprocal of droop) (Kf1). Typical value
= 20.
kf3:
slot_uri: cim:GovSteamFV4.kf3
range: PU
required: false
multivalued: false
description: Frequency control (reciprocal of droop) (Kf3). Typical
value = 20.
khp:
slot_uri: cim:GovSteamFV4.khp
range: PU
required: false
multivalued: false
description: Fraction of total turbine output generated by HP part (Khp). Typical
value = 0,35.
kic:
slot_uri: cim:GovSteamFV4.kic
range: PU
required: false
multivalued: false
description: Integral gain of pressure regulator (Kic). Typical value
= 0,0033.
kip:
slot_uri: cim:GovSteamFV4.kip
range: PU
required: false
multivalued: false
description: Integral gain of pressure feedback regulator (Kip). Typical
value = 0,5.
kit:
slot_uri: cim:GovSteamFV4.kit
range: PU
required: false
multivalued: false
description: Integral gain of electro-hydraulic regulator (Kit). Typical
value = 0,04.
kmp1:
slot_uri: cim:GovSteamFV4.kmp1
range: PU
required: false
multivalued: false
description: First gain coefficient of intercept valves characteristic (Kmp1). Typical
value = 0,5.
kmp2:
slot_uri: cim:GovSteamFV4.kmp2
range: PU
required: false
multivalued: false
description: Second gain coefficient of intercept valves characteristic (Kmp2). Typical
value = 3,5.
kpc:
slot_uri: cim:GovSteamFV4.kpc
range: PU
required: false
multivalued: false
description: Proportional gain of pressure regulator (Kpc). Typical
value = 0,5.
kpp:
slot_uri: cim:GovSteamFV4.kpp
range: PU
required: false
multivalued: false
description: Proportional gain of pressure feedback regulator (Kpp). Typical
value = 1.
kpt:
slot_uri: cim:GovSteamFV4.kpt
range: PU
required: false
multivalued: false
description: Proportional gain of electro-hydraulic regulator (Kpt). Typical
value = 0,3.
krc:
slot_uri: cim:GovSteamFV4.krc
range: PU
required: false
multivalued: false
description: Maximum variation of fuel flow (Krc). Typical value =
0,05.
ksh:
slot_uri: cim:GovSteamFV4.ksh
range: PU
required: false
multivalued: false
description: Pressure loss due to flow friction in the boiler tubes (Ksh). Typical
value = 0,08.
lpi:
slot_uri: cim:GovSteamFV4.lpi
range: PU
required: false
multivalued: false
description: Maximum negative power error (Lpi). Typical value = -0,15.
lps:
slot_uri: cim:GovSteamFV4.lps
range: PU
required: false
multivalued: false
description: Maximum positive power error (Lps). Typical value = 0,03.
mnef:
slot_uri: cim:GovSteamFV4.mnef
range: PU
required: false
multivalued: false
description: Lower limit for frequency correction (MNEF). Typical
value = -0,05.
mxef:
slot_uri: cim:GovSteamFV4.mxef
range: PU
required: false
multivalued: false
description: Upper limit for frequency correction (MXEF). Typical
value = 0,05.
pr1:
slot_uri: cim:GovSteamFV4.pr1
range: PU
required: false
multivalued: false
description: First value of pressure set point static characteristic (Pr1). Typical
value = 0,2.
pr2:
slot_uri: cim:GovSteamFV4.pr2
range: PU
required: false
multivalued: false
description: Second value of pressure set point static characteristic, corresponding
to Ps0 = 1,0 PU (Pr2). Typical value = 0,75.
psmn:
slot_uri: cim:GovSteamFV4.psmn
range: PU
required: false
multivalued: false
description: Minimum value of pressure set point static characteristic (Psmn). Typical
value = 1.
rsmimn:
slot_uri: cim:GovSteamFV4.rsmimn
range: PU
required: false
multivalued: false
description: Minimum value of integral regulator (Rsmimn). Typical
value = 0.
rsmimx:
slot_uri: cim:GovSteamFV4.rsmimx
range: PU
required: false
multivalued: false
description: Maximum value of integral regulator (Rsmimx). Typical
value = 1,1.
rvgmn:
slot_uri: cim:GovSteamFV4.rvgmn
range: PU
required: false
multivalued: false
description: Minimum value of integral regulator (Rvgmn). Typical
value = 0.
rvgmx:
slot_uri: cim:GovSteamFV4.rvgmx
range: PU
required: false
multivalued: false
description: Maximum value of integral regulator (Rvgmx). Typical
value = 1,2.
srmn:
slot_uri: cim:GovSteamFV4.srmn
range: PU
required: false
multivalued: false
description: Minimum valve opening (Srmn). Typical value = 0.
srmx:
slot_uri: cim:GovSteamFV4.srmx
range: PU
required: false
multivalued: false
description: Maximum valve opening (Srmx). Typical value = 1,1.
srsmp:
slot_uri: cim:GovSteamFV4.srsmp
range: PU
required: false
multivalued: false
description: Intercept valves characteristic discontinuity point (Srsmp). Typical
value = 0,43.
svmn:
slot_uri: cim:GovSteamFV4.svmn
range: float
required: false
multivalued: false
description: Maximum regulator gate closing velocity (Svmn). Typical
value = -0,0333.
svmx:
slot_uri: cim:GovSteamFV4.svmx
range: float
required: false
multivalued: false
description: Maximum regulator gate opening velocity (Svmx). Typical
value = 0,0333.
ta:
slot_uri: cim:GovSteamFV4.ta
range: Seconds
required: false
multivalued: false
description: Control valves rate opening time (Ta) (>= 0). Typical
value = 0,8.
tam:
slot_uri: cim:GovSteamFV4.tam
range: Seconds
required: false
multivalued: false
description: Intercept valves rate opening time (Tam) (>= 0). Typical
value = 0,8.
tc:
slot_uri: cim:GovSteamFV4.tc
range: Seconds
required: false
multivalued: false
description: Control valves rate closing time (Tc) (>= 0). Typical
value = 0,5.
tcm:
slot_uri: cim:GovSteamFV4.tcm
range: Seconds
required: false
multivalued: false
description: Intercept valves rate closing time (Tcm) (>= 0). Typical
value = 0,5.
tdc:
slot_uri: cim:GovSteamFV4.tdc
range: Seconds
required: false
multivalued: false
description: Derivative time constant of pressure regulator (Tdc) (>=
0). Typical value = 90.
tf1:
slot_uri: cim:GovSteamFV4.tf1
range: Seconds
required: false
multivalued: false
description: Time constant of fuel regulation (Tf1) (>= 0). Typical
value = 10.
tf2:
slot_uri: cim:GovSteamFV4.tf2
range: Seconds
required: false
multivalued: false
description: Time constant of steam chest (Tf2) (>= 0). Typical
value = 10.
thp:
slot_uri: cim:GovSteamFV4.thp
range: Seconds
required: false
multivalued: false
description: High pressure (HP) time constant of the turbine (Thp)
(>= 0). Typical value = 0,15.
tmp:
slot_uri: cim:GovSteamFV4.tmp
range: Seconds
required: false
multivalued: false
description: Low pressure (LP) time constant of the turbine (Tmp) (>=
0). Typical value = 0,4.
trh:
slot_uri: cim:GovSteamFV4.trh
range: Seconds
required: false
multivalued: false
description: Reheater time constant of the turbine (Trh) (>= 0). Typical
value = 10.
tv:
slot_uri: cim:GovSteamFV4.tv
range: Seconds
required: false
multivalued: false
description: Boiler time constant (Tv) (>= 0). Typical value =
60.
ty:
slot_uri: cim:GovSteamFV4.ty
range: Seconds
required: false
multivalued: false
description: Control valves servo time constant (Ty) (>= 0). Typical
value = 0,1.
y:
slot_uri: cim:GovSteamFV4.y
range: PU
required: false
multivalued: false
description: Coefficient of linearized equations of turbine (Stodola formulation)
(Y). Typical value = 0,13.
yhpmn:
slot_uri: cim:GovSteamFV4.yhpmn
range: PU
required: false
multivalued: false
description: Minimum control valve position (Yhpmn). Typical value
= 0.
yhpmx:
slot_uri: cim:GovSteamFV4.yhpmx
range: PU
required: false
multivalued: false
description: Maximum control valve position (Yhpmx). Typical value
= 1,1.
ympmn:
slot_uri: cim:GovSteamFV4.ympmn
range: PU
required: false
multivalued: false
description: Minimum intercept valve position (Ympmn). Typical value
= 0.
ympmx:
slot_uri: cim:GovSteamFV4.ympmx
range: PU
required: false
multivalued: false
description: Maximum intercept valve position (Ympmx). Typical value
= 1,1.
GovSteamSGO:
class_uri: cim:GovSteamSGO
is_a: TurbineGovernorDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.TurbineGovernorDynamics
description: Simplified steam turbine governor.
attributes:
k1:
slot_uri: cim:GovSteamSGO.k1
range: PU
required: false
multivalued: false
description: 'One / PU regulation (K1). '
k2:
slot_uri: cim:GovSteamSGO.k2
range: PU
required: false
multivalued: false
description: 'Fraction (K2). '
k3:
slot_uri: cim:GovSteamSGO.k3
range: PU
required: false
multivalued: false
description: Fraction (K3).
mwbase:
slot_uri: cim:GovSteamSGO.mwbase
range: ActivePower
required: false
multivalued: false
description: Base for power values (MWbase) (> 0). Unit = MW.
pmax:
slot_uri: cim:GovSteamSGO.pmax
range: PU
required: false
multivalued: false
description: 'Upper power limit (Pmax) (> GovSteamSGO.pmin). '
pmin:
slot_uri: cim:GovSteamSGO.pmin
range: Seconds
required: false
multivalued: false
description: Lower power limit (Pmin) (>= 0 and < GovSteamSGO.pmax).
t1:
slot_uri: cim:GovSteamSGO.t1
range: Seconds
required: false
multivalued: false
description: Controller lag (T1) (>= 0).
t2:
slot_uri: cim:GovSteamSGO.t2
range: Seconds
required: false
multivalued: false
description: Controller lead compensation (T2) (>= 0).
t3:
slot_uri: cim:GovSteamSGO.t3
range: Seconds
required: false
multivalued: false
description: 'Governor lag (T3) (> 0). '
t4:
slot_uri: cim:GovSteamSGO.t4
range: Seconds
required: false
multivalued: false
description: 'Delay due to steam inlet volumes associated with steam chest
and inlet piping (T4) (>= 0). '
t5:
slot_uri: cim:GovSteamSGO.t5
range: Seconds
required: false
multivalued: false
description: 'Reheater delay including hot and cold leads (T5) (>=
0). '
t6:
slot_uri: cim:GovSteamSGO.t6
range: Seconds
required: false
multivalued: false
description: 'Delay due to IP-LP turbine, crossover pipes and LP end hoods
(T6) (>= 0). '
TurbLCFB1:
class_uri: cim:TurbLCFB1
is_a: TurbineLoadControllerDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.TurbineLoadControllerDynamics
description: Turbine load controller model developed by WECC. This model represents
a supervisory turbine load controller that acts to maintain turbine power at
a set value by continuous adjustment of the turbine governor speed-load reference.
This model is intended to represent slow reset 'outer loop' controllers managing
the action of the turbine governor.
attributes:
db:
slot_uri: cim:TurbLCFB1.db
range: PU
required: false
multivalued: false
description: Controller deadband (db). Typical value = 0.
emax:
slot_uri: cim:TurbLCFB1.emax
range: PU
required: false
multivalued: false
description: Maximum control error (Emax) (see parameter detail 4). Typical
value = 0,02.
fb:
slot_uri: cim:TurbLCFB1.fb
range: PU
required: false
multivalued: false
description: Frequency bias gain (Fb). Typical value = 0.
fbf:
slot_uri: cim:TurbLCFB1.fbf
range: boolean
required: false
multivalued: false
description: "Frequency bias flag (Fbf).\r\ntrue = enable frequency\
\ bias\r\nfalse = disable frequency bias.\r\nTypical value = false."
irmax:
slot_uri: cim:TurbLCFB1.irmax
range: PU
required: false
multivalued: false
description: Maximum turbine speed/load reference bias (Irmax) (see
parameter detail 3). Typical value = 0.
ki:
slot_uri: cim:TurbLCFB1.ki
range: PU
required: false
multivalued: false
description: Integral gain (Ki). Typical value = 0.
kp:
slot_uri: cim:TurbLCFB1.kp
range: PU
required: false
multivalued: false
description: Proportional gain (Kp). Typical value = 0.
mwbase:
slot_uri: cim:TurbLCFB1.mwbase
range: ActivePower
required: false
multivalued: false
description: Base for power values (MWbase) (> 0). Unit = MW.
pbf:
slot_uri: cim:TurbLCFB1.pbf
range: boolean
required: false
multivalued: false
description: "Power controller flag (Pbf).\r\ntrue = enable load controller\r\
\nfalse = disable load controller.\r\nTypical value = false."
pmwset:
slot_uri: cim:TurbLCFB1.pmwset
range: ActivePower
required: false
multivalued: false
description: Power controller setpoint (Pmwset) (see parameter detail
1). Unit = MW. Typical value = 0.
speedReferenceGovernor:
slot_uri: cim:TurbLCFB1.speedReferenceGovernor
range: boolean
required: false
multivalued: false
description: "Type of turbine governor reference (Type).\r\ntrue =\
\ speed reference governor\r\nfalse = load reference governor.\r\nTypical\
\ value = true."
tpelec:
slot_uri: cim:TurbLCFB1.tpelec
range: Seconds
required: false
multivalued: false
description: Power transducer time constant (Tpelec) (>= 0). Typical
value = 0.
MechLoad1:
class_uri: cim:MechLoad1
is_a: MechanicalLoadDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.MechanicalLoadDynamics
description: Mechanical load model type 1.
attributes:
a:
slot_uri: cim:MechLoad1.a
range: float
required: false
multivalued: false
description: Speed squared coefficient (a).
b:
slot_uri: cim:MechLoad1.b
range: float
required: false
multivalued: false
description: Speed coefficient (b).
d:
slot_uri: cim:MechLoad1.d
range: float
required: false
multivalued: false
description: Speed to the exponent coefficient (d).
e:
slot_uri: cim:MechLoad1.e
range: float
required: false
multivalued: false
description: Exponent (e).
ExcIEEEAC1A:
class_uri: cim:ExcIEEEAC1A
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: "IEEE 421.5-2005 type AC1A model. The model represents the field-controlled\
\ alternator-rectifier excitation systems designated type AC1A. These excitation\
\ systems consist of an alternator main exciter with non-controlled rectifiers.\r\
\nReference: IEEE 421.5-2005, 6.1."
attributes:
ka:
slot_uri: cim:ExcIEEEAC1A.ka
range: PU
required: false
multivalued: false
description: Voltage regulator gain (KA) (> 0). Typical
value = 400.
kc:
slot_uri: cim:ExcIEEEAC1A.kc
range: PU
required: false
multivalued: false
description: Rectifier loading factor proportional to commutating reactance
(KC) (>= 0). Typical value = 0,2.
kd:
slot_uri: cim:ExcIEEEAC1A.kd
range: PU
required: false
multivalued: false
description: Demagnetizing factor, a function of exciter alternator reactances
(KD) (>= 0). Typical value = 0,38.
ke:
slot_uri: cim:ExcIEEEAC1A.ke
range: PU
required: false
multivalued: false
description: Exciter constant related to self-excited field (KE). Typical
value = 1.
kf:
slot_uri: cim:ExcIEEEAC1A.kf
range: PU
required: false
multivalued: false
description: Excitation control system stabilizer gains (KF)
(>= 0). Typical value = 0,03.
seve1:
slot_uri: cim:ExcIEEEAC1A.seve1
range: float
required: false
multivalued: false
description: Exciter saturation function value at the corresponding exciter
voltage, VE1, back of commutating reactance (SE[VE1])
(>= 0). Typical value = 0,1.
seve2:
slot_uri: cim:ExcIEEEAC1A.seve2
range: float
required: false
multivalued: false
description: Exciter saturation function value at the corresponding exciter
voltage, VE2, back of commutating reactance (SE[VE2])
(>= 0). Typical value = 0,03.
ta:
slot_uri: cim:ExcIEEEAC1A.ta
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (TA)
(> 0). Typical value = 0,02.
tb:
slot_uri: cim:ExcIEEEAC1A.tb
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (TB)
(>= 0). Typical value = 0.
tc:
slot_uri: cim:ExcIEEEAC1A.tc
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (TC)
(>= 0). Typical value = 0.
te:
slot_uri: cim:ExcIEEEAC1A.te
range: Seconds
required: false
multivalued: false
description: Exciter time constant, integration rate associated with exciter
control (TE) (> 0). Typical value = 0,8.
tf:
slot_uri: cim:ExcIEEEAC1A.tf
range: Seconds
required: false
multivalued: false
description: Excitation control system stabilizer time constant (TF)
(> 0). Typical value = 1.
vamax:
slot_uri: cim:ExcIEEEAC1A.vamax
range: PU
required: false
multivalued: false
description: Maximum voltage regulator output (VAMAX)
(> 0). Typical value = 14,5.
vamin:
slot_uri: cim:ExcIEEEAC1A.vamin
range: PU
required: false
multivalued: false
description: Minimum voltage regulator output (VAMIN)
(< 0). Typical value = -14,5.
ve1:
slot_uri: cim:ExcIEEEAC1A.ve1
range: PU
required: false
multivalued: false
description: Exciter alternator output voltages back of commutating reactance
at which saturation is defined (VE1) (> 0). Typical
value = 4,18.
ve2:
slot_uri: cim:ExcIEEEAC1A.ve2
range: PU
required: false
multivalued: false
description: Exciter alternator output voltages back of commutating reactance
at which saturation is defined (VE2) (> 0). Typical
value = 3,14.
vrmax:
slot_uri: cim:ExcIEEEAC1A.vrmax
range: PU
required: false
multivalued: false
description: Maximum voltage regulator outputs (VRMAX)
(> 0). Typical value = 6,03.
vrmin:
slot_uri: cim:ExcIEEEAC1A.vrmin
range: PU
required: false
multivalued: false
description: Minimum voltage regulator outputs (VRMIN)
(< 0). Typical value = -5,43.
ExcIEEEAC2A:
class_uri: cim:ExcIEEEAC2A
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: "IEEE 421.5-2005 type AC2A model. The model represents a high initial\
\ response field-controlled alternator-rectifier excitation system. The alternator\
\ main exciter is used with non-controlled rectifiers. The type AC2A model is\
\ similar to that of type AC1A except for the inclusion of exciter time constant\
\ compensation and exciter field current limiting elements.\r\nReference: IEEE\
\ 421.5-2005, 6.2."
attributes:
ka:
slot_uri: cim:ExcIEEEAC2A.ka
range: PU
required: false
multivalued: false
description: Voltage regulator gain (KA) (> 0). Typical
value = 400.
kb:
slot_uri: cim:ExcIEEEAC2A.kb
range: PU
required: false
multivalued: false
description: Second stage regulator gain (KB) (>
0). Typical value = 25.
kc:
slot_uri: cim:ExcIEEEAC2A.kc
range: PU
required: false
multivalued: false
description: Rectifier loading factor proportional to commutating reactance
(KC) (>= 0). Typical value = 0,28.
kd:
slot_uri: cim:ExcIEEEAC2A.kd
range: PU
required: false
multivalued: false
description: Demagnetizing factor, a function of exciter alternator reactances
(KD) (>= 0). Typical value = 0,35.
ke:
slot_uri: cim:ExcIEEEAC2A.ke
range: PU
required: false
multivalued: false
description: Exciter constant related to self-excited field (KE)
(>= 0). Typical value = 1.
kf:
slot_uri: cim:ExcIEEEAC2A.kf
range: PU
required: false
multivalued: false
description: Excitation control system stabilizer gains (KF)
(>= 0). Typical value = 0,03.
kh:
slot_uri: cim:ExcIEEEAC2A.kh
range: PU
required: false
multivalued: false
description: Exciter field current feedback gain (KH)
(>= 0). Typical value = 1.
seve1:
slot_uri: cim:ExcIEEEAC2A.seve1
range: float
required: false
multivalued: false
description: Exciter saturation function value at the corresponding exciter
voltage, VE1, back of commutating reactance (SE[VE1])
(>= 0). Typical value = 0,037.
seve2:
slot_uri: cim:ExcIEEEAC2A.seve2
range: float
required: false
multivalued: false
description: Exciter saturation function value at the corresponding exciter
voltage, VE2, back of commutating reactance (SE[VE2])
(>= 0). Typical value = 0,012.
ta:
slot_uri: cim:ExcIEEEAC2A.ta
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (TA)
(> 0). Typical value = 0,02.
tb:
slot_uri: cim:ExcIEEEAC2A.tb
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (TB)
(>= 0). Typical value = 0.
tc:
slot_uri: cim:ExcIEEEAC2A.tc
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (TC)
(>= 0). Typical value = 0.
te:
slot_uri: cim:ExcIEEEAC2A.te
range: Seconds
required: false
multivalued: false
description: Exciter time constant, integration rate associated with exciter
control (TE) (> 0). Typical value = 0,6.
tf:
slot_uri: cim:ExcIEEEAC2A.tf
range: Seconds
required: false
multivalued: false
description: Excitation control system stabilizer time constant (TF)
(> 0). Typical value = 1.
vamax:
slot_uri: cim:ExcIEEEAC2A.vamax
range: PU
required: false
multivalued: false
description: Maximum voltage regulator output (VAMAX)
(> 0). Typical value = 8.
vamin:
slot_uri: cim:ExcIEEEAC2A.vamin
range: PU
required: false
multivalued: false
description: Minimum voltage regulator output (VAMIN)
(< 0). Typical value = -8.
ve1:
slot_uri: cim:ExcIEEEAC2A.ve1
range: PU
required: false
multivalued: false
description: Exciter alternator output voltages back of commutating reactance
at which saturation is defined (VE1) (> 0). Typical
value = 4,4.
ve2:
slot_uri: cim:ExcIEEEAC2A.ve2
range: PU
required: false
multivalued: false
description: Exciter alternator output voltages back of commutating reactance
at which saturation is defined (VE2) (> 0). Typical
value = 3,3.
vfemax:
slot_uri: cim:ExcIEEEAC2A.vfemax
range: PU
required: false
multivalued: false
description: Exciter field current limit reference (VFEMAX)
(> 0). Typical value = 4,4.
vrmax:
slot_uri: cim:ExcIEEEAC2A.vrmax
range: PU
required: false
multivalued: false
description: Maximum voltage regulator outputs (VRMAX)
(> 0). Typical value = 105.
vrmin:
slot_uri: cim:ExcIEEEAC2A.vrmin
range: PU
required: false
multivalued: false
description: Minimum voltage regulator outputs (VRMIN)
(< 0). Typical value = -95.
ExcIEEEAC3A:
class_uri: cim:ExcIEEEAC3A
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: "IEEE 421.5-2005 type AC3A model. The model represents the field-controlled\
\ alternator-rectifier excitation systems designated type AC3A. These excitation\
\ systems include an alternator main exciter with non-controlled rectifiers.\
\ The exciter employs self-excitation, and the voltage regulator power is derived\
\ from the exciter output voltage. Therefore, this system has an additional\
\ nonlinearity, simulated by the use of a multiplier whose inputs are the voltage\
\ regulator command signal, Va, and the exciter output voltage, Efd,\
\ times KR. This model is applicable to excitation\
\ systems employing static voltage regulators.\r\nReference: IEEE 421.5-2005,\
\ 6.3."
attributes:
efdn:
slot_uri: cim:ExcIEEEAC3A.efdn
range: PU
required: false
multivalued: false
description: Value of Efd at which feedback gain changes (EFDN)
(> 0). Typical value = 2,36.
ka:
slot_uri: cim:ExcIEEEAC3A.ka
range: PU
required: false
multivalued: false
description: Voltage regulator gain (KA) (> 0). Typical
value = 45,62.
kc:
slot_uri: cim:ExcIEEEAC3A.kc
range: PU
required: false
multivalued: false
description: Rectifier loading factor proportional to commutating reactance
(KC) (>= 0). Typical value = 0,104.
kd:
slot_uri: cim:ExcIEEEAC3A.kd
range: PU
required: false
multivalued: false
description: Demagnetizing factor, a function of exciter alternator reactances
(KD) (>= 0). Typical value = 0,499.
ke:
slot_uri: cim:ExcIEEEAC3A.ke
range: PU
required: false
multivalued: false
description: Exciter constant related to self-excited field (KE). Typical
value = 1.
kf:
slot_uri: cim:ExcIEEEAC3A.kf
range: PU
required: false
multivalued: false
description: Excitation control system stabilizer gains (KF)
(>= 0). Typical value = 0,143.
kn:
slot_uri: cim:ExcIEEEAC3A.kn
range: PU
required: false
multivalued: false
description: Excitation control system stabilizer gain (KN)
(>= 0). Typical value = 0,05.
kr:
slot_uri: cim:ExcIEEEAC3A.kr
range: PU
required: false
multivalued: false
description: Constant associated with regulator and alternator field power
supply (KR) (> 0). Typical value = 3,77.
seve1:
slot_uri: cim:ExcIEEEAC3A.seve1
range: float
required: false
multivalued: false
description: Exciter saturation function value at the corresponding exciter
voltage, VE1, back of commutating reactance (SE[VE1])
(>= 0). Typical value = 1,143.
seve2:
slot_uri: cim:ExcIEEEAC3A.seve2
range: float
required: false
multivalued: false
description: Exciter saturation function value at the corresponding exciter
voltage, VE2, back of commutating reactance (SE[VE2])
(>= 0). Typical value = 0,1.
ta:
slot_uri: cim:ExcIEEEAC3A.ta
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (TA)
(> 0). Typical value = 0,013.
tb:
slot_uri: cim:ExcIEEEAC3A.tb
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (TB)
(>= 0). Typical value = 0.
tc:
slot_uri: cim:ExcIEEEAC3A.tc
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (TC)
(>= 0). Typical value = 0.
te:
slot_uri: cim:ExcIEEEAC3A.te
range: Seconds
required: false
multivalued: false
description: Exciter time constant, integration rate associated with exciter
control (TE) (> 0). Typical value = 1,17.
tf:
slot_uri: cim:ExcIEEEAC3A.tf
range: Seconds
required: false
multivalued: false
description: Excitation control system stabilizer time constant (TF)
(> 0). Typical value = 1.
vamax:
slot_uri: cim:ExcIEEEAC3A.vamax
range: PU
required: false
multivalued: false
description: Maximum voltage regulator output (VAMAX)
(> 0). Typical value = 1.
vamin:
slot_uri: cim:ExcIEEEAC3A.vamin
range: PU
required: false
multivalued: false
description: Minimum voltage regulator output (VAMIN)
(< 0). Typical value = -0,95.
ve1:
slot_uri: cim:ExcIEEEAC3A.ve1
range: PU
required: false
multivalued: false
description: Exciter alternator output voltages back of commutating reactance
at which saturation is defined (VE1) (> 0). Typical
value = 6,24.
ve2:
slot_uri: cim:ExcIEEEAC3A.ve2
range: PU
required: false
multivalued: false
description: Exciter alternator output voltages back of commutating reactance
at which saturation is defined (VE2) (> 0). Typical
value = 4,68.
vemin:
slot_uri: cim:ExcIEEEAC3A.vemin
range: PU
required: false
multivalued: false
description: Minimum exciter voltage output (VEMIN)
(<= 0). Typical value = 0.
vfemax:
slot_uri: cim:ExcIEEEAC3A.vfemax
range: PU
required: false
multivalued: false
description: Exciter field current limit reference (VFEMAX)
(>= 0). Typical value = 16.
ExcIEEEAC4A:
class_uri: cim:ExcIEEEAC4A
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: "IEEE 421.5-2005 type AC4A model. The model represents type AC4A\
\ alternator-supplied controlled-rectifier excitation system which is quite\
\ different from the other types of AC systems. This high initial response excitation\
\ system utilizes a full thyristor bridge in the exciter output circuit. The\
\ voltage regulator controls the firing of the thyristor bridges. The exciter\
\ alternator uses an independent voltage regulator to control its output voltage\
\ to a constant value. These effects are not modelled; however, transient loading\
\ effects on the exciter alternator are included.\r\nReference: IEEE 421.5-2005,\
\ 6.4."
attributes:
ka:
slot_uri: cim:ExcIEEEAC4A.ka
range: PU
required: false
multivalued: false
description: Voltage regulator gain (KA) (> 0). Typical
value = 200.
kc:
slot_uri: cim:ExcIEEEAC4A.kc
range: PU
required: false
multivalued: false
description: Rectifier loading factor proportional to commutating reactance
(KC) (>= 0). Typical value = 0.
ta:
slot_uri: cim:ExcIEEEAC4A.ta
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (TA)
(> 0). Typical value = 0,015.
tb:
slot_uri: cim:ExcIEEEAC4A.tb
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (TB)
(>= 0). Typical value = 10.
tc:
slot_uri: cim:ExcIEEEAC4A.tc
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (TC)
(>= 0). Typical value = 1.
vimax:
slot_uri: cim:ExcIEEEAC4A.vimax
range: PU
required: false
multivalued: false
description: Maximum voltage regulator input limit (VIMAX)
(> 0). Typical value = 10.
vimin:
slot_uri: cim:ExcIEEEAC4A.vimin
range: PU
required: false
multivalued: false
description: Minimum voltage regulator input limit (VIMIN)
(< 0). Typical value = -10.
vrmax:
slot_uri: cim:ExcIEEEAC4A.vrmax
range: PU
required: false
multivalued: false
description: Maximum voltage regulator output (VRMAX)
(> 0). Typical value = 5,64.
vrmin:
slot_uri: cim:ExcIEEEAC4A.vrmin
range: PU
required: false
multivalued: false
description: Minimum voltage regulator output (VRMIN)
(< 0). Typical value = -4,53.
ExcIEEEAC5A:
class_uri: cim:ExcIEEEAC5A
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: "IEEE 421.5-2005 type AC5A model. The model represents a simplified\
\ model for brushless excitation systems. The regulator is supplied from a source,\
\ such as a permanent magnet generator, which is not affected by system disturbances.\
\ Unlike other AC models, this model uses loaded rather than open circuit exciter\
\ saturation data in the same way as it is used for the DC models. Because\
\ the model has been widely implemented by the industry, it is sometimes used\
\ to represent other types of systems when either detailed data for them are\
\ not available or simplified models are required.\r\nReference: IEEE 421.5-2005,\
\ 6.5."
attributes:
efd1:
slot_uri: cim:ExcIEEEAC5A.efd1
range: PU
required: false
multivalued: false
description: Exciter voltage at which exciter saturation is defined (EFD1)
(> 0). Typical value = 5,6.
efd2:
slot_uri: cim:ExcIEEEAC5A.efd2
range: PU
required: false
multivalued: false
description: Exciter voltage at which exciter saturation is defined (EFD2)
(> 0). Typical value = 4,2.
ka:
slot_uri: cim:ExcIEEEAC5A.ka
range: PU
required: false
multivalued: false
description: Voltage regulator gain (KA) (> 0). Typical
value = 400.
ke:
slot_uri: cim:ExcIEEEAC5A.ke
range: PU
required: false
multivalued: false
description: Exciter constant related to self-excited field (KE). Typical
value = 1.
kf:
slot_uri: cim:ExcIEEEAC5A.kf
range: PU
required: false
multivalued: false
description: Excitation control system stabilizer gains (KF)
(>= 0). Typical value = 0,03.
seefd1:
slot_uri: cim:ExcIEEEAC5A.seefd1
range: float
required: false
multivalued: false
description: Exciter saturation function value at the corresponding exciter
voltage, EFD1 (SE[EFD1])
(>= 0). Typical value = 0,86.
seefd2:
slot_uri: cim:ExcIEEEAC5A.seefd2
range: float
required: false
multivalued: false
description: Exciter saturation function value at the corresponding exciter
voltage, EFD2 (SE[EFD2])
(>= 0). Typical value = 0,5.
ta:
slot_uri: cim:ExcIEEEAC5A.ta
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (TA)
(> 0). Typical value = 0,02.
te:
slot_uri: cim:ExcIEEEAC5A.te
range: Seconds
required: false
multivalued: false
description: Exciter time constant, integration rate associated with exciter
control (TE) (> 0). Typical value = 0,8.
tf1:
slot_uri: cim:ExcIEEEAC5A.tf1
range: Seconds
required: false
multivalued: false
description: Excitation control system stabilizer time constant (TF1)
(> 0). Typical value = 1.
tf2:
slot_uri: cim:ExcIEEEAC5A.tf2
range: Seconds
required: false
multivalued: false
description: Excitation control system stabilizer time constant (TF2)
(>= 0). Typical value = 1.
tf3:
slot_uri: cim:ExcIEEEAC5A.tf3
range: Seconds
required: false
multivalued: false
description: Excitation control system stabilizer time constant (TF3)
(>= 0). Typical value = 1.
vrmax:
slot_uri: cim:ExcIEEEAC5A.vrmax
range: PU
required: false
multivalued: false
description: Maximum voltage regulator output (VRMAX)
(> 0). Typical value = 7,3.
vrmin:
slot_uri: cim:ExcIEEEAC5A.vrmin
range: PU
required: false
multivalued: false
description: Minimum voltage regulator output (VRMIN)
(< 0). Typical value = -7,3.
ExcIEEEAC6A:
class_uri: cim:ExcIEEEAC6A
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: "IEEE 421.5-2005 type AC6A model. The model represents field-controlled\
\ alternator-rectifier excitation systems with system-supplied electronic voltage\
\ regulators. The maximum output of the regulator, VR,\
\ is a function of terminal voltage, VT. The field\
\ current limiter included in the original model AC6A remains in the 2005 update.\r\
\nReference: IEEE 421.5-2005, 6.6. \r\n\r\n"
attributes:
ka:
slot_uri: cim:ExcIEEEAC6A.ka
range: PU
required: false
multivalued: false
description: Voltage regulator gain (KA) (> 0). Typical
value = 536.
kc:
slot_uri: cim:ExcIEEEAC6A.kc
range: PU
required: false
multivalued: false
description: Rectifier loading factor proportional to commutating reactance
(KC) (>= 0). Typical value = 0,173.
kd:
slot_uri: cim:ExcIEEEAC6A.kd
range: PU
required: false
multivalued: false
description: Demagnetizing factor, a function of exciter alternator reactances
(KD) (>= 0). Typical value = 1,91.
ke:
slot_uri: cim:ExcIEEEAC6A.ke
range: PU
required: false
multivalued: false
description: Exciter constant related to self-excited field (KE). Typical
value = 1,6.
kh:
slot_uri: cim:ExcIEEEAC6A.kh
range: PU
required: false
multivalued: false
description: Exciter field current limiter gain (KH)
(>= 0). Typical value = 92.
seve1:
slot_uri: cim:ExcIEEEAC6A.seve1
range: float
required: false
multivalued: false
description: Exciter saturation function value at the corresponding exciter
voltage, VE1, back of commutating reactance (SE[VE1])
(>= 0). Typical value = 0,214.
seve2:
slot_uri: cim:ExcIEEEAC6A.seve2
range: float
required: false
multivalued: false
description: Exciter saturation function value at the corresponding exciter
voltage, VE2, back of commutating reactance (SE[VE2])
(>= 0). Typical value = 0,044.
ta:
slot_uri: cim:ExcIEEEAC6A.ta
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (TA)
(>= 0). Typical value = 0,086.
tb:
slot_uri: cim:ExcIEEEAC6A.tb
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (TB)
(>= 0). Typical value = 9.
tc:
slot_uri: cim:ExcIEEEAC6A.tc
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (TC)
(>= 0). Typical value = 3.
te:
slot_uri: cim:ExcIEEEAC6A.te
range: Seconds
required: false
multivalued: false
description: Exciter time constant, integration rate associated with exciter
control (TE) (> 0). Typical value = 1.
th:
slot_uri: cim:ExcIEEEAC6A.th
range: Seconds
required: false
multivalued: false
description: Exciter field current limiter time constant (TH)
(> 0). Typical value = 0,08.
tj:
slot_uri: cim:ExcIEEEAC6A.tj
range: Seconds
required: false
multivalued: false
description: Exciter field current limiter time constant (TJ)
(>= 0). Typical value = 0,02.
tk:
slot_uri: cim:ExcIEEEAC6A.tk
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (TK)
(>= 0). Typical value = 0,18.
vamax:
slot_uri: cim:ExcIEEEAC6A.vamax
range: PU
required: false
multivalued: false
description: Maximum voltage regulator output (VAMAX)
(> 0). Typical value = 75.
vamin:
slot_uri: cim:ExcIEEEAC6A.vamin
range: PU
required: false
multivalued: false
description: Minimum voltage regulator output (VAMIN) (< 0). Typical
value = -75.
ve1:
slot_uri: cim:ExcIEEEAC6A.ve1
range: PU
required: false
multivalued: false
description: Exciter alternator output voltages back of commutating reactance
at which saturation is defined (VE1) (> 0). Typical
value = 7,4.
ve2:
slot_uri: cim:ExcIEEEAC6A.ve2
range: PU
required: false
multivalued: false
description: Exciter alternator output voltages back of commutating reactance
at which saturation is defined (VE2) (> 0). Typical
value = 5,55.
vfelim:
slot_uri: cim:ExcIEEEAC6A.vfelim
range: PU
required: false
multivalued: false
description: Exciter field current limit reference (VFELIM)
(> 0). Typical value = 19.
vhmax:
slot_uri: cim:ExcIEEEAC6A.vhmax
range: PU
required: false
multivalued: false
description: Maximum field current limiter signal reference (VHMAX)
(> 0). Typical value = 75.
vrmax:
slot_uri: cim:ExcIEEEAC6A.vrmax
range: PU
required: false
multivalued: false
description: Maximum voltage regulator output (VRMAX)
(> 0). Typical value = 44.
vrmin:
slot_uri: cim:ExcIEEEAC6A.vrmin
range: PU
required: false
multivalued: false
description: Minimum voltage regulator output (VRMIN)
(< 0). Typical value = -36.
ExcIEEEAC7B:
class_uri: cim:ExcIEEEAC7B
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: "IEEE 421.5-2005 type AC7B model. The model represents excitation\
\ systems which consist of an AC alternator with either stationary or rotating\
\ rectifiers to produce the DC field requirements. It is an upgrade to earlier\
\ AC excitation systems, which replace only the controls but retain the AC alternator\
\ and diode rectifier bridge.\r\nReference: IEEE 421.5-2005, 6.7. Note, however,\
\ that in IEEE 421.5-2005, the [1 / sTE] block is shown\
\ as [1 / (1 + sTE)], which is incorrect."
attributes:
kc:
slot_uri: cim:ExcIEEEAC7B.kc
range: PU
required: false
multivalued: false
description: Rectifier loading factor proportional to commutating reactance
(KC) (>= 0). Typical value = 0,18.
kd:
slot_uri: cim:ExcIEEEAC7B.kd
range: PU
required: false
multivalued: false
description: Demagnetizing factor, a function of exciter alternator reactances
(KD) (>= 0). Typical value = 0,02.
kdr:
slot_uri: cim:ExcIEEEAC7B.kdr
range: PU
required: false
multivalued: false
description: Voltage regulator derivative gain (KDR)
(>= 0). Typical value = 0.
ke:
slot_uri: cim:ExcIEEEAC7B.ke
range: PU
required: false
multivalued: false
description: Exciter constant related to self-excited field (KE). Typical
value = 1.
kf1:
slot_uri: cim:ExcIEEEAC7B.kf1
range: PU
required: false
multivalued: false
description: Excitation control system stabilizer gain (KF1)
(>= 0). Typical value = 0,212.
kf2:
slot_uri: cim:ExcIEEEAC7B.kf2
range: PU
required: false
multivalued: false
description: Excitation control system stabilizer gain (KF2)
(>= 0). Typical value = 0.
kf3:
slot_uri: cim:ExcIEEEAC7B.kf3
range: PU
required: false
multivalued: false
description: Excitation control system stabilizer gain (KF3)
(>= 0). Typical value = 0.
kia:
slot_uri: cim:ExcIEEEAC7B.kia
range: PU
required: false
multivalued: false
description: Voltage regulator integral gain (KIA)
(>= 0). Typical value = 59,69.
kir:
slot_uri: cim:ExcIEEEAC7B.kir
range: PU
required: false
multivalued: false
description: Voltage regulator integral gain (KIR)
(>= 0). Typical value = 4,24.
kl:
slot_uri: cim:ExcIEEEAC7B.kl
range: PU
required: false
multivalued: false
description: Exciter field voltage lower limit parameter (KL). Typical
value = 10.
kp:
slot_uri: cim:ExcIEEEAC7B.kp
range: PU
required: false
multivalued: false
description: Potential circuit gain coefficient (KP)
(> 0). Typical value = 4,96.
kpa:
slot_uri: cim:ExcIEEEAC7B.kpa
range: PU
required: false
multivalued: false
description: Voltage regulator proportional gain (KPA)
(> 0 if ExcIEEEAC7B.kia = 0). Typical value = 65,36.
kpr:
slot_uri: cim:ExcIEEEAC7B.kpr
range: PU
required: false
multivalued: false
description: Voltage regulator proportional gain (KPR)
(> 0 if ExcIEEEAC7B.kir = 0). Typical value = 4,24.
seve1:
slot_uri: cim:ExcIEEEAC7B.seve1
range: float
required: false
multivalued: false
description: Exciter saturation function value at the corresponding exciter
voltage, VE1, back of commutating reactance (SE[VE1])
(>= 0). Typical value = 0,44.
seve2:
slot_uri: cim:ExcIEEEAC7B.seve2
range: float
required: false
multivalued: false
description: Exciter saturation function value at the corresponding exciter
voltage, VE2, back of commutating reactance (SE[VE2])
(>= 0). Typical value = 0,075.
tdr:
slot_uri: cim:ExcIEEEAC7B.tdr
range: Seconds
required: false
multivalued: false
description: Lag time constant (TDR) (>= 0). Typical
value = 0.
te:
slot_uri: cim:ExcIEEEAC7B.te
range: Seconds
required: false
multivalued: false
description: Exciter time constant, integration rate associated with exciter
control (TE) (> 0). Typical value = 1,1.
tf:
slot_uri: cim:ExcIEEEAC7B.tf
range: Seconds
required: false
multivalued: false
description: Excitation control system stabilizer time constant (TF)
(> 0). Typical value = 1.
vamax:
slot_uri: cim:ExcIEEEAC7B.vamax
range: PU
required: false
multivalued: false
description: Maximum voltage regulator output (VAMAX)
(> 0). Typical value = 1.
vamin:
slot_uri: cim:ExcIEEEAC7B.vamin
range: PU
required: false
multivalued: false
description: Minimum voltage regulator output (VAMIN)
(< 0). Typical value = -0,95.
ve1:
slot_uri: cim:ExcIEEEAC7B.ve1
range: PU
required: false
multivalued: false
description: Exciter alternator output voltages back of commutating reactance
at which saturation is defined (VE1) (> 0). Typical
value = 6,3.
ve2:
slot_uri: cim:ExcIEEEAC7B.ve2
range: PU
required: false
multivalued: false
description: Exciter alternator output voltages back of commutating reactance
at which saturation is defined (VE2) (> 0). Typical
value = 3,02.
vemin:
slot_uri: cim:ExcIEEEAC7B.vemin
range: PU
required: false
multivalued: false
description: Minimum exciter voltage output (VEMIN)
(<= 0). Typical value = 0.
vfemax:
slot_uri: cim:ExcIEEEAC7B.vfemax
range: PU
required: false
multivalued: false
description: Exciter field current limit reference (VFEMAX). Typical
value = 6,9.
vrmax:
slot_uri: cim:ExcIEEEAC7B.vrmax
range: PU
required: false
multivalued: false
description: Maximum voltage regulator output (VRMAX)
(> 0). Typical value = 5,79.
vrmin:
slot_uri: cim:ExcIEEEAC7B.vrmin
range: PU
required: false
multivalued: false
description: Minimum voltage regulator output (VRMIN)
(< 0). Typical value = -5,79.
ExcIEEEAC8B:
class_uri: cim:ExcIEEEAC8B
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: "IEEE 421.5-2005 type AC8B model. This model represents a PID voltage\
\ regulator with either a brushless exciter or DC exciter. The AVR in this model\
\ consists of PID control, with separate constants for the proportional (KPR),\
\ integral (KIR), and derivative (KDR)\
\ gains. The representation of the brushless exciter (TE,\
\ KE, SE, KC,\
\ KD) is similar to the model type AC2A. The type AC8B\
\ model can be used to represent static voltage regulators applied to brushless\
\ excitation systems. Digitally based voltage regulators feeding DC rotating\
\ main exciters can be represented with the AC type AC8B model with the parameters\
\ KC and KD set to 0. For\
\ thyristor power stages fed from the generator terminals, the limits VRMAX\
\ and VRMIN should be a function of terminal\
\ voltage: VT x VRMAX and\
\ VT x VRMIN.\r\nReference:\
\ IEEE 421.5-2005, 6.8. "
attributes:
ka:
slot_uri: cim:ExcIEEEAC8B.ka
range: PU
required: false
multivalued: false
description: Voltage regulator gain (KA) (> 0). Typical
value = 1.
kc:
slot_uri: cim:ExcIEEEAC8B.kc
range: PU
required: false
multivalued: false
description: Rectifier loading factor proportional to commutating reactance
(KC) (>= 0). Typical value = 0,55.
kd:
slot_uri: cim:ExcIEEEAC8B.kd
range: PU
required: false
multivalued: false
description: Demagnetizing factor, a function of exciter alternator reactances
(KD) (>= 0). Typical value = 1,1.
kdr:
slot_uri: cim:ExcIEEEAC8B.kdr
range: PU
required: false
multivalued: false
description: Voltage regulator derivative gain (KDR)
(>= 0). Typical value = 10.
ke:
slot_uri: cim:ExcIEEEAC8B.ke
range: PU
required: false
multivalued: false
description: Exciter constant related to self-excited field (KE). Typical
value = 1.
kir:
slot_uri: cim:ExcIEEEAC8B.kir
range: PU
required: false
multivalued: false
description: Voltage regulator integral gain (KIR)
(>= 0). Typical value = 5.
kpr:
slot_uri: cim:ExcIEEEAC8B.kpr
range: PU
required: false
multivalued: false
description: Voltage regulator proportional gain (KPR)
(> 0 if ExcIEEEAC8B.kir = 0). Typical value = 80.
seve1:
slot_uri: cim:ExcIEEEAC8B.seve1
range: float
required: false
multivalued: false
description: Exciter saturation function value at the corresponding exciter
voltage, VE1, back of commutating reactance (SE[VE1])
(>= 0). Typical value = 0,3.
seve2:
slot_uri: cim:ExcIEEEAC8B.seve2
range: float
required: false
multivalued: false
description: Exciter saturation function value at the corresponding exciter
voltage, VE2, back of commutating reactance (SE[VE2])
(>= 0). Typical value = 3.
ta:
slot_uri: cim:ExcIEEEAC8B.ta
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (TA)
(>= 0). Typical value = 0.
tdr:
slot_uri: cim:ExcIEEEAC8B.tdr
range: Seconds
required: false
multivalued: false
description: Lag time constant (TDR) (> 0). Typical
value = 0,1.
te:
slot_uri: cim:ExcIEEEAC8B.te
range: Seconds
required: false
multivalued: false
description: Exciter time constant, integration rate associated with exciter
control (TE) (> 0). Typical value = 1,2.
ve1:
slot_uri: cim:ExcIEEEAC8B.ve1
range: PU
required: false
multivalued: false
description: Exciter alternator output voltages back of commutating reactance
at which saturation is defined (VE1) (> 0). Typical
value = 6,5.
ve2:
slot_uri: cim:ExcIEEEAC8B.ve2
range: PU
required: false
multivalued: false
description: Exciter alternator output voltages back of commutating reactance
at which saturation is defined (VE2) (> 0). Typical
value = 9.
vemin:
slot_uri: cim:ExcIEEEAC8B.vemin
range: PU
required: false
multivalued: false
description: Minimum exciter voltage output (VEMIN)
(<= 0). Typical value = 0.
vfemax:
slot_uri: cim:ExcIEEEAC8B.vfemax
range: PU
required: false
multivalued: false
description: Exciter field current limit reference (VFEMAX). Typical
value = 6.
vrmax:
slot_uri: cim:ExcIEEEAC8B.vrmax
range: PU
required: false
multivalued: false
description: Maximum voltage regulator output (VRMAX)
(> 0). Typical value = 35.
vrmin:
slot_uri: cim:ExcIEEEAC8B.vrmin
range: PU
required: false
multivalued: false
description: Minimum voltage regulator output (VRMIN)
(<= 0). Typical value = 0.
ExcIEEEDC1A:
class_uri: cim:ExcIEEEDC1A
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: "IEEE 421.5-2005 type DC1A model. This model represents field-controlled\
\ DC commutator exciters with continuously acting voltage regulators (especially\
\ the direct-acting rheostatic, rotating amplifier, and magnetic amplifier types).\
\ Because this model has been widely implemented by the industry, it is sometimes\
\ used to represent other types of systems when detailed data for them are not\
\ available or when a simplified model is required.\r\nReference: IEEE 421.5-2005,\
\ 5.1. "
attributes:
efd1:
slot_uri: cim:ExcIEEEDC1A.efd1
range: PU
required: false
multivalued: false
description: Exciter voltage at which exciter saturation is defined (EFD1)
(> 0). Typical value = 3,1.
efd2:
slot_uri: cim:ExcIEEEDC1A.efd2
range: PU
required: false
multivalued: false
description: Exciter voltage at which exciter saturation is defined (EFD2)
(> 0). Typical value = 2,3.
exclim:
slot_uri: cim:ExcIEEEDC1A.exclim
range: boolean
required: false
multivalued: false
description: "(exclim). IEEE standard is ambiguous about lower limit\
\ on exciter output.\r\ntrue = a lower limit of zero is applied to integrator\
\ output\r\nfalse = a lower limit of zero is not applied to integrator output.\r\
\nTypical value = true."
ka:
slot_uri: cim:ExcIEEEDC1A.ka
range: PU
required: false
multivalued: false
description: Voltage regulator gain (KA) (> 0). Typical
value = 46.
ke:
slot_uri: cim:ExcIEEEDC1A.ke
range: PU
required: false
multivalued: false
description: Exciter constant related to self-excited field (KE). Typical
value = 0.
kf:
slot_uri: cim:ExcIEEEDC1A.kf
range: PU
required: false
multivalued: false
description: Excitation control system stabilizer gain (KF)
(>= 0). Typical value = 0.1.
seefd1:
slot_uri: cim:ExcIEEEDC1A.seefd1
range: float
required: false
multivalued: false
description: Exciter saturation function value at the corresponding exciter
voltage, EFD1 (SE[EFD1])
(>= 0). Typical value = 0.33.
seefd2:
slot_uri: cim:ExcIEEEDC1A.seefd2
range: float
required: false
multivalued: false
description: Exciter saturation function value at the corresponding exciter
voltage, EFD2 (SE[EFD2])
(>= 0). Typical value = 0,1.
ta:
slot_uri: cim:ExcIEEEDC1A.ta
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (TA)
(> 0). Typical value = 0,06.
tb:
slot_uri: cim:ExcIEEEDC1A.tb
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (TB)
(>= 0). Typical value = 0.
tc:
slot_uri: cim:ExcIEEEDC1A.tc
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (TC)
(>= 0). Typical value = 0.
te:
slot_uri: cim:ExcIEEEDC1A.te
range: Seconds
required: false
multivalued: false
description: Exciter time constant, integration rate associated with exciter
control (TE) (> 0). Typical value = 0,46.
tf:
slot_uri: cim:ExcIEEEDC1A.tf
range: Seconds
required: false
multivalued: false
description: Excitation control system stabilizer time constant (TF)
(> 0). Typical value = 1.
uelin:
slot_uri: cim:ExcIEEEDC1A.uelin
range: boolean
required: false
multivalued: false
description: "UEL input (uelin).\r\ntrue = input is connected to the\
\ HV gate\r\nfalse = input connects to the error signal.\r\nTypical value\
\ = true."
vrmax:
slot_uri: cim:ExcIEEEDC1A.vrmax
range: PU
required: false
multivalued: false
description: Maximum voltage regulator output (VRMAX)
(> ExcIEEEDC1A.vrmin). Typical value = 1.
vrmin:
slot_uri: cim:ExcIEEEDC1A.vrmin
range: PU
required: false
multivalued: false
description: Minimum voltage regulator output (VRMIN)
(< 0 and < ExcIEEEDC1A.vrmax). Typical value = -0,9.
ExcIEEEDC2A:
class_uri: cim:ExcIEEEDC2A
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: "IEEE 421.5-2005 type DC2A model. This model represents field-controlled\
\ DC commutator exciters with continuously acting voltage regulators having\
\ supplies obtained from the generator or auxiliary bus. It differs from the\
\ type DC1A model only in the voltage regulator output limits, which are now\
\ proportional to terminal voltage VT.\r\nIt is representative\
\ of solid-state replacements for various forms of older mechanical and rotating\
\ amplifier regulating equipment connected to DC commutator exciters.\r\nReference:\
\ IEEE 421.5-2005, 5.2. "
attributes:
efd1:
slot_uri: cim:ExcIEEEDC2A.efd1
range: PU
required: false
multivalued: false
description: Exciter voltage at which exciter saturation is defined (EFD1)
(> 0). Typical value = 3,05.
efd2:
slot_uri: cim:ExcIEEEDC2A.efd2
range: PU
required: false
multivalued: false
description: Exciter voltage at which exciter saturation is defined (EFD2)
(> 0). Typical value = 2,29.
exclim:
slot_uri: cim:ExcIEEEDC2A.exclim
range: PU
required: false
multivalued: false
description: (exclim). IEEE standard is ambiguous about lower limit
on exciter output. Typical value = - 999 which means that there is no limit
applied.
ka:
slot_uri: cim:ExcIEEEDC2A.ka
range: PU
required: false
multivalued: false
description: Voltage regulator gain (KA) (> 0). Typical
value = 300.
ke:
slot_uri: cim:ExcIEEEDC2A.ke
range: PU
required: false
multivalued: false
description: Exciter constant related to self-excited field (KE). Typical
value = 1.
kf:
slot_uri: cim:ExcIEEEDC2A.kf
range: PU
required: false
multivalued: false
description: Excitation control system stabilizer gain (KF)
(>= 0). Typical value = 0,1.
seefd1:
slot_uri: cim:ExcIEEEDC2A.seefd1
range: float
required: false
multivalued: false
description: Exciter saturation function value at the corresponding exciter
voltage, EFD1 (SE[EFD1])
(>= 0). Typical value = 0,279.
seefd2:
slot_uri: cim:ExcIEEEDC2A.seefd2
range: float
required: false
multivalued: false
description: Exciter saturation function value at the corresponding exciter
voltage, EFD2 (SE[EFD2])
(>= 0). Typical value = 0,117.
ta:
slot_uri: cim:ExcIEEEDC2A.ta
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (TA)
(> 0). Typical value = 0,01.
tb:
slot_uri: cim:ExcIEEEDC2A.tb
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (TB)
(>= 0). Typical value = 0.
tc:
slot_uri: cim:ExcIEEEDC2A.tc
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (TC)
(>= 0). Typical value = 0.
te:
slot_uri: cim:ExcIEEEDC2A.te
range: Seconds
required: false
multivalued: false
description: Exciter time constant, integration rate associated with exciter
control (TE) (> 0). Typical value = 1,33.
tf:
slot_uri: cim:ExcIEEEDC2A.tf
range: Seconds
required: false
multivalued: false
description: Excitation control system stabilizer time constant (TF)
(> 0). Typical value = 0,675.
uelin:
slot_uri: cim:ExcIEEEDC2A.uelin
range: boolean
required: false
multivalued: false
description: "UEL input (uelin).\r\ntrue = input is connected to the\
\ HV gate\r\nfalse = input connects to the error signal.\r\nTypical value\
\ = true."
vrmax:
slot_uri: cim:ExcIEEEDC2A.vrmax
range: PU
required: false
multivalued: false
description: Maximum voltage regulator output (VRMAX)(>
ExcIEEEDC2A.vrmin). Typical value = 4,95.
vrmin:
slot_uri: cim:ExcIEEEDC2A.vrmin
range: PU
required: false
multivalued: false
description: Minimum voltage regulator output (VRMIN)
(< 0 and < ExcIEEEDC2A.vrmax). Typical value = -4,9.
ExcIEEEDC3A:
class_uri: cim:ExcIEEEDC3A
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: "IEEE 421.5-2005 type DC3A model. This model represents older systems,\
\ in particular those DC commutator exciters with non-continuously acting regulators\
\ that were commonly used before the development of the continuously acting\
\ varieties. These systems respond at basically two different rates, depending\
\ upon the magnitude of voltage error. For small errors, adjustment is made\
\ periodically with a signal to a motor-operated rheostat. Larger errors cause\
\ resistors to be quickly shorted or inserted and a strong forcing signal applied\
\ to the exciter. Continuous motion of the motor-operated rheostat occurs for\
\ these larger error signals, even though it is bypassed by contactor action.\r\
\nReference: IEEE 421.5-2005, 5.3. "
attributes:
efd1:
slot_uri: cim:ExcIEEEDC3A.efd1
range: PU
required: false
multivalued: false
description: Exciter voltage at which exciter saturation is defined (EFD1)
(> 0). Typical value = 3,375.
efd2:
slot_uri: cim:ExcIEEEDC3A.efd2
range: PU
required: false
multivalued: false
description: Exciter voltage at which exciter saturation is defined (EFD2)
(> 0). Typical value = 3,15.
exclim:
slot_uri: cim:ExcIEEEDC3A.exclim
range: boolean
required: false
multivalued: false
description: "(exclim). IEEE standard is ambiguous about lower limit\
\ on exciter output.\r\ntrue = a lower limit of zero is applied to integrator\
\ output\r\nfalse = a lower limit of zero is not applied to integrator output.\r\
\nTypical value = true."
ke:
slot_uri: cim:ExcIEEEDC3A.ke
range: PU
required: false
multivalued: false
description: Exciter constant related to self-excited field (KE). Typical
value = 0,05.
kv:
slot_uri: cim:ExcIEEEDC3A.kv
range: PU
required: false
multivalued: false
description: Fast raise/lower contact setting (KV)
(> 0). Typical value = 0,05.
seefd1:
slot_uri: cim:ExcIEEEDC3A.seefd1
range: float
required: false
multivalued: false
description: Exciter saturation function value at the corresponding exciter
voltage, EFD1 (SE[EFD1])
(>= 0). Typical value = 0,267.
seefd2:
slot_uri: cim:ExcIEEEDC3A.seefd2
range: float
required: false
multivalued: false
description: Exciter saturation function value at the corresponding exciter
voltage, EFD2 (SE[EFD2])
(>= 0). Typical value = 0,068.
te:
slot_uri: cim:ExcIEEEDC3A.te
range: Seconds
required: false
multivalued: false
description: Exciter time constant, integration rate associated with exciter
control (TE) (> 0). Typical value = 0,5.
trh:
slot_uri: cim:ExcIEEEDC3A.trh
range: Seconds
required: false
multivalued: false
description: Rheostat travel time (TRH) (> 0). Typical
value = 20.
vrmax:
slot_uri: cim:ExcIEEEDC3A.vrmax
range: PU
required: false
multivalued: false
description: Maximum voltage regulator output (VRMAX)
(> 0). Typical value = 1.
vrmin:
slot_uri: cim:ExcIEEEDC3A.vrmin
range: PU
required: false
multivalued: false
description: Minimum voltage regulator output (VRMIN)
(<= 0). Typical value = 0.
ExcIEEEDC4B:
class_uri: cim:ExcIEEEDC4B
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: "IEEE 421.5-2005 type DC4B model. These excitation systems utilize\
\ a field-controlled DC commutator exciter with a continuously acting voltage\
\ regulator having supplies obtained from the generator or auxiliary bus.\r\n\
Reference: IEEE 421.5-2005, 5.4. "
attributes:
efd1:
slot_uri: cim:ExcIEEEDC4B.efd1
range: PU
required: false
multivalued: false
description: Exciter voltage at which exciter saturation is defined (EFD1)
(> 0). Typical value = 1,75.
efd2:
slot_uri: cim:ExcIEEEDC4B.efd2
range: PU
required: false
multivalued: false
description: Exciter voltage at which exciter saturation is defined (EFD2)
(> 0). Typical value = 2,33.
ka:
slot_uri: cim:ExcIEEEDC4B.ka
range: PU
required: false
multivalued: false
description: Voltage regulator gain (KA) (> 0). Typical
value = 1.
kd:
slot_uri: cim:ExcIEEEDC4B.kd
range: PU
required: false
multivalued: false
description: Regulator derivative gain (KD) (>=
0). Typical value = 20.
ke:
slot_uri: cim:ExcIEEEDC4B.ke
range: PU
required: false
multivalued: false
description: Exciter constant related to self-excited field (KE). Typical
value = 1.
kf:
slot_uri: cim:ExcIEEEDC4B.kf
range: PU
required: false
multivalued: false
description: Excitation control system stabilizer gain (KF)
(>= 0). Typical value = 0.
ki:
slot_uri: cim:ExcIEEEDC4B.ki
range: PU
required: false
multivalued: false
description: Regulator integral gain (KI) (>=
0). Typical value = 20.
kp:
slot_uri: cim:ExcIEEEDC4B.kp
range: PU
required: false
multivalued: false
description: Regulator proportional gain (KP) (>=
0). Typical value = 20.
oelin:
slot_uri: cim:ExcIEEEDC4B.oelin
range: boolean
required: false
multivalued: false
description: "OEL input (OELin).\r\ntrue = LV gate\r\nfalse = subtract\
\ from error signal.\r\nTypical value = true."
seefd1:
slot_uri: cim:ExcIEEEDC4B.seefd1
range: float
required: false
multivalued: false
description: Exciter saturation function value at the corresponding exciter
voltage, EFD1 (SE[EFD1])
(>= 0). Typical value = 0,08.
seefd2:
slot_uri: cim:ExcIEEEDC4B.seefd2
range: float
required: false
multivalued: false
description: Exciter saturation function value at the corresponding exciter
voltage, EFD2 (SE[EFD2])
(>= 0). Typical value = 0,27.
ta:
slot_uri: cim:ExcIEEEDC4B.ta
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (TA)
(> 0). Typical value = 0,2.
td:
slot_uri: cim:ExcIEEEDC4B.td
range: Seconds
required: false
multivalued: false
description: Regulator derivative filter time constant (TD)
(> 0 if ExcIEEEDC4B.kd > 0). Typical value = 0,01.
te:
slot_uri: cim:ExcIEEEDC4B.te
range: Seconds
required: false
multivalued: false
description: Exciter time constant, integration rate associated with exciter
control (TE) (> 0). Typical value = 0,8.
tf:
slot_uri: cim:ExcIEEEDC4B.tf
range: Seconds
required: false
multivalued: false
description: Excitation control system stabilizer time constant (TF)
(>= 0). Typical value = 1.
uelin:
slot_uri: cim:ExcIEEEDC4B.uelin
range: boolean
required: false
multivalued: false
description: "UEL input (UELin).\r\ntrue = HV gate\r\nfalse = add to\
\ error signal.\r\nTypical value = true."
vemin:
slot_uri: cim:ExcIEEEDC4B.vemin
range: PU
required: false
multivalued: false
description: Minimum exciter voltage output (VEMIN)
(<= 0). Typical value = 0.
vrmax:
slot_uri: cim:ExcIEEEDC4B.vrmax
range: PU
required: false
multivalued: false
description: Maximum voltage regulator output (VRMAX)
(> ExcIEEEDC4B.vrmin). Typical value = 2,7.
vrmin:
slot_uri: cim:ExcIEEEDC4B.vrmin
range: PU
required: false
multivalued: false
description: Minimum voltage regulator output (VRMIN)
(<= 0 and < ExcIEEEDC4B.vrmax). Typical value = -0,9.
ExcIEEEST1A:
class_uri: cim:ExcIEEEST1A
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: "IEEE 421.5-2005 type ST1A model. This model represents systems in\
\ which excitation power is supplied through a transformer from the generator\
\ terminals (or the unit\u2019s auxiliary bus) and is regulated by a controlled\
\ rectifier. The maximum exciter voltage available from such systems is directly\
\ related to the generator terminal voltage.\r\nReference: IEEE 421.5-2005,\
\ 7.1. "
attributes:
ilr:
slot_uri: cim:ExcIEEEST1A.ilr
range: PU
required: false
multivalued: false
description: Exciter output current limit reference (ILR). Typical
value = 0.
ka:
slot_uri: cim:ExcIEEEST1A.ka
range: PU
required: false
multivalued: false
description: Voltage regulator gain (KA) (> 0). Typical
value = 190.
kc:
slot_uri: cim:ExcIEEEST1A.kc
range: PU
required: false
multivalued: false
description: Rectifier loading factor proportional to commutating reactance
(KC) (>= 0). Typical value = 0,08.
kf:
slot_uri: cim:ExcIEEEST1A.kf
range: PU
required: false
multivalued: false
description: Excitation control system stabilizer gains (KF)
(>= 0). Typical value = 0.
klr:
slot_uri: cim:ExcIEEEST1A.klr
range: PU
required: false
multivalued: false
description: Exciter output current limiter gain (KLR). Typical
value = 0.
pssin:
slot_uri: cim:ExcIEEEST1A.pssin
range: boolean
required: false
multivalued: false
description: "Selector of the Power System Stabilizer (PSS) input (PSSin).\r\
\ntrue = PSS input (Vs) added to error signal\r\nfalse = PSS input\
\ (Vs) added to voltage regulator output.\r\nTypical value = true."
ta:
slot_uri: cim:ExcIEEEST1A.ta
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (TA)
(>= 0). Typical value = 0.
tb:
slot_uri: cim:ExcIEEEST1A.tb
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (TB)
(>= 0). Typical value = 10.
tb1:
slot_uri: cim:ExcIEEEST1A.tb1
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (TB1)
(>= 0). Typical value = 0.
tc:
slot_uri: cim:ExcIEEEST1A.tc
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (TC)
(>= 0). Typical value = 1.
tc1:
slot_uri: cim:ExcIEEEST1A.tc1
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (TC1)
(>= 0). Typical value = 0.
tf:
slot_uri: cim:ExcIEEEST1A.tf
range: Seconds
required: false
multivalued: false
description: Excitation control system stabilizer time constant (TF)
(>= 0). Typical value = 1.
uelin:
slot_uri: cim:ExcIEEEST1A.uelin
range: ExcIEEEST1AUELselectorKind
required: false
multivalued: false
description: Selector of the connection of the UEL input (UELin). Typical
value = ignoreUELsignal.
vamax:
slot_uri: cim:ExcIEEEST1A.vamax
range: PU
required: false
multivalued: false
description: Maximum voltage regulator output (VAMAX)
(> 0). Typical value = 14,5.
vamin:
slot_uri: cim:ExcIEEEST1A.vamin
range: PU
required: false
multivalued: false
description: Minimum voltage regulator output (VAMIN)
(< 0). Typical value = -14,5.
vimax:
slot_uri: cim:ExcIEEEST1A.vimax
range: PU
required: false
multivalued: false
description: Maximum voltage regulator input limit (VIMAX)
(> 0). Typical value = 999.
vimin:
slot_uri: cim:ExcIEEEST1A.vimin
range: PU
required: false
multivalued: false
description: Minimum voltage regulator input limit (VIMIN)
(< 0). Typical value = -999.
vrmax:
slot_uri: cim:ExcIEEEST1A.vrmax
range: PU
required: false
multivalued: false
description: Maximum voltage regulator outputs (VRMAX)
(> 0). Typical value = 7,8.
vrmin:
slot_uri: cim:ExcIEEEST1A.vrmin
range: PU
required: false
multivalued: false
description: Minimum voltage regulator outputs (VRMIN)
(< 0). Typical value = -6,7.
ExcIEEEST2A:
class_uri: cim:ExcIEEEST2A
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: "IEEE 421.5-2005 type ST2A model. Some static systems use both current\
\ and voltage sources (generator terminal quantities) to comprise the power\
\ source. The regulator controls the exciter output through controlled saturation\
\ of the power transformer components. These compound-source rectifier excitation\
\ systems are designated type ST2A and are represented by ExcIEEEST2A.\r\nReference:\
\ IEEE 421.5-2005, 7.2. "
attributes:
efdmax:
slot_uri: cim:ExcIEEEST2A.efdmax
range: PU
required: false
multivalued: false
description: Maximum field voltage (EFDMax) (>=
0). Typical value = 99.
ka:
slot_uri: cim:ExcIEEEST2A.ka
range: PU
required: false
multivalued: false
description: Voltage regulator gain (KA) (> 0). Typical
value = 120.
kc:
slot_uri: cim:ExcIEEEST2A.kc
range: PU
required: false
multivalued: false
description: Rectifier loading factor proportional to commutating reactance
(KC) (>= 0). Typical value = 1,82.
ke:
slot_uri: cim:ExcIEEEST2A.ke
range: PU
required: false
multivalued: false
description: Exciter constant related to self-excited field (KE). Typical
value = 1.
kf:
slot_uri: cim:ExcIEEEST2A.kf
range: PU
required: false
multivalued: false
description: Excitation control system stabilizer gains (KF)
(>= 0). Typical value = 0,05.
ki:
slot_uri: cim:ExcIEEEST2A.ki
range: PU
required: false
multivalued: false
description: Potential circuit gain coefficient (KI)
(>= 0). Typical value = 8.
kp:
slot_uri: cim:ExcIEEEST2A.kp
range: PU
required: false
multivalued: false
description: Potential circuit gain coefficient (KP)
(>= 0). Typical value = 4,88.
ta:
slot_uri: cim:ExcIEEEST2A.ta
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (TA)
(> 0). Typical value = 0,15.
te:
slot_uri: cim:ExcIEEEST2A.te
range: Seconds
required: false
multivalued: false
description: Exciter time constant, integration rate associated with exciter
control (TE) (> 0). Typical value = 0,5.
tf:
slot_uri: cim:ExcIEEEST2A.tf
range: Seconds
required: false
multivalued: false
description: Excitation control system stabilizer time constant (TF)
(>= 0). Typical value = 1.
uelin:
slot_uri: cim:ExcIEEEST2A.uelin
range: boolean
required: false
multivalued: false
description: "UEL input (UELin).\r\ntrue = HV gate\r\nfalse = add to\
\ error signal.\r\nTypical value = true."
vrmax:
slot_uri: cim:ExcIEEEST2A.vrmax
range: PU
required: false
multivalued: false
description: Maximum voltage regulator outputs (VRMAX)
(> 0). Typical value = 1.
vrmin:
slot_uri: cim:ExcIEEEST2A.vrmin
range: PU
required: false
multivalued: false
description: Minimum voltage regulator outputs (VRMIN)
(<= 0). Typical value = 0.
ExcIEEEST3A:
class_uri: cim:ExcIEEEST3A
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: "IEEE 421.5-2005 type ST3A model. Some static systems utilize a\
\ field voltage control loop to linearize the exciter control characteristic.\
\ This also makes the output independent of supply source variations until supply\
\ limitations are reached. These systems utilize a variety of controlled-rectifier\
\ designs: full thyristor complements or hybrid bridges in either series or\
\ shunt configurations. The power source can consist of only a potential source,\
\ either fed from the machine terminals or from internal windings. Some designs\
\ can have compound power sources utilizing both machine potential and current.\
\ These power sources are represented as phasor combinations of machine terminal\
\ current and voltage and are accommodated by suitable parameters in model type\
\ ST3A which is represented by ExcIEEEST3A.\r\nReference: IEEE 421.5-2005, 7.3. "
attributes:
ka:
slot_uri: cim:ExcIEEEST3A.ka
range: PU
required: false
multivalued: false
description: Voltage regulator gain (KA) (> 0).
This is parameter K in the IEEE standard. Typical value = 200.
kc:
slot_uri: cim:ExcIEEEST3A.kc
range: PU
required: false
multivalued: false
description: Rectifier loading factor proportional to commutating reactance
(KC) (>= 0). Typical value = 0,2.
kg:
slot_uri: cim:ExcIEEEST3A.kg
range: PU
required: false
multivalued: false
description: Feedback gain constant of the inner loop field regulator (KG)
(>= 0). Typical value = 1.
ki:
slot_uri: cim:ExcIEEEST3A.ki
range: PU
required: false
multivalued: false
description: Potential circuit gain coefficient (KI)
(>= 0). Typical value = 0.
km:
slot_uri: cim:ExcIEEEST3A.km
range: PU
required: false
multivalued: false
description: Forward gain constant of the inner loop field regulator (KM)
(> 0). Typical value = 7,93.
kp:
slot_uri: cim:ExcIEEEST3A.kp
range: PU
required: false
multivalued: false
description: Potential circuit gain coefficient (KP)
(> 0). Typical value = 6,15.
ta:
slot_uri: cim:ExcIEEEST3A.ta
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (TA)
(>= 0). Typical value = 0.
tb:
slot_uri: cim:ExcIEEEST3A.tb
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (TB)
(>= 0). Typical value = 10.
tc:
slot_uri: cim:ExcIEEEST3A.tc
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (TC)
(>= 0). Typical value = 1.
thetap:
slot_uri: cim:ExcIEEEST3A.thetap
range: AngleDegrees
required: false
multivalued: false
description: Potential circuit phase angle (thetap). Typical value
= 0.
tm:
slot_uri: cim:ExcIEEEST3A.tm
range: Seconds
required: false
multivalued: false
description: Forward time constant of inner loop field regulator (TM)
(> 0). Typical value = 0,4.
vbmax:
slot_uri: cim:ExcIEEEST3A.vbmax
range: PU
required: false
multivalued: false
description: Maximum excitation voltage (VBMax) (>
0). Typical value = 6,9.
vgmax:
slot_uri: cim:ExcIEEEST3A.vgmax
range: PU
required: false
multivalued: false
description: Maximum inner loop feedback voltage (VGMax)
(>= 0). Typical value = 5,8.
vimax:
slot_uri: cim:ExcIEEEST3A.vimax
range: PU
required: false
multivalued: false
description: Maximum voltage regulator input limit (VIMAX)
(> 0). Typical value = 0,2.
vimin:
slot_uri: cim:ExcIEEEST3A.vimin
range: PU
required: false
multivalued: false
description: Minimum voltage regulator input limit (VIMIN)
(< 0). Typical value = -0,2.
vmmax:
slot_uri: cim:ExcIEEEST3A.vmmax
range: PU
required: false
multivalued: false
description: Maximum inner loop output (VMMax) (>
0). Typical value = 1.
vmmin:
slot_uri: cim:ExcIEEEST3A.vmmin
range: PU
required: false
multivalued: false
description: Minimum inner loop output (VMMin) (<=
0). Typical value = 0.
vrmax:
slot_uri: cim:ExcIEEEST3A.vrmax
range: PU
required: false
multivalued: false
description: Maximum voltage regulator output (VRMAX)
(> 0). Typical value = 10.
vrmin:
slot_uri: cim:ExcIEEEST3A.vrmin
range: PU
required: false
multivalued: false
description: Minimum voltage regulator output (VRMIN)
(< 0). Typical value = -10.
xl:
slot_uri: cim:ExcIEEEST3A.xl
range: PU
required: false
multivalued: false
description: Reactance associated with potential source (XL)
(>= 0). Typical value = 0,081.
ExcIEEEST4B:
class_uri: cim:ExcIEEEST4B
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: "IEEE 421.5-2005 type ST4B model. This model is a variation of the\
\ type ST3A model, with a proportional plus integral (PI) regulator block replacing\
\ the lag-lead regulator characteristic that is in the ST3A model. Both potential\
\ and compound source rectifier excitation systems are modelled. The PI regulator\
\ blocks have non-windup limits that are represented. The voltage regulator\
\ of this model is typically implemented digitally.\r\nReference: IEEE 421.5-2005,\
\ 7.4. "
attributes:
kc:
slot_uri: cim:ExcIEEEST4B.kc
range: PU
required: false
multivalued: false
description: Rectifier loading factor proportional to commutating reactance
(KC) (>= 0). Typical value = 0,113.
kg:
slot_uri: cim:ExcIEEEST4B.kg
range: PU
required: false
multivalued: false
description: Feedback gain constant of the inner loop field regulator (KG)
(>= 0). Typical value = 0.
ki:
slot_uri: cim:ExcIEEEST4B.ki
range: PU
required: false
multivalued: false
description: Potential circuit gain coefficient (KI)
(>= 0). Typical value = 0.
kim:
slot_uri: cim:ExcIEEEST4B.kim
range: PU
required: false
multivalued: false
description: Voltage regulator integral gain output (KIM). Typical
value = 0.
kir:
slot_uri: cim:ExcIEEEST4B.kir
range: PU
required: false
multivalued: false
description: Voltage regulator integral gain (KIR). Typical
value = 10,75.
kp:
slot_uri: cim:ExcIEEEST4B.kp
range: PU
required: false
multivalued: false
description: Potential circuit gain coefficient (KP)
(> 0). Typical value = 9,3.
kpm:
slot_uri: cim:ExcIEEEST4B.kpm
range: PU
required: false
multivalued: false
description: Voltage regulator proportional gain output (KPM). Typical
value = 1.
kpr:
slot_uri: cim:ExcIEEEST4B.kpr
range: PU
required: false
multivalued: false
description: Voltage regulator proportional gain (KPR). Typical
value = 10,75.
ta:
slot_uri: cim:ExcIEEEST4B.ta
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (TA)
(>= 0). Typical value = 0,02.
thetap:
slot_uri: cim:ExcIEEEST4B.thetap
range: AngleDegrees
required: false
multivalued: false
description: Potential circuit phase angle (thetap). Typical value
= 0.
vbmax:
slot_uri: cim:ExcIEEEST4B.vbmax
range: PU
required: false
multivalued: false
description: Maximum excitation voltage (VBMax) (>
0). Typical value = 11,63.
vmmax:
slot_uri: cim:ExcIEEEST4B.vmmax
range: PU
required: false
multivalued: false
description: Maximum inner loop output (VMMax) (>
ExcIEEEST4B.vmmin). Typical value = 99.
vmmin:
slot_uri: cim:ExcIEEEST4B.vmmin
range: PU
required: false
multivalued: false
description: Minimum inner loop output (VMMin) (<
ExcIEEEST4B.vmmax). Typical value = -99.
vrmax:
slot_uri: cim:ExcIEEEST4B.vrmax
range: PU
required: false
multivalued: false
description: Maximum voltage regulator output (VRMAX)
(> 0). Typical value = 1.
vrmin:
slot_uri: cim:ExcIEEEST4B.vrmin
range: PU
required: false
multivalued: false
description: Minimum voltage regulator output (VRMIN)
(< 0). Typical value = -0,87.
xl:
slot_uri: cim:ExcIEEEST4B.xl
range: PU
required: false
multivalued: false
description: Reactance associated with potential source (XL)
(>= 0). Typical value = 0,124.
ExcIEEEST5B:
class_uri: cim:ExcIEEEST5B
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: "IEEE 421.5-2005 type ST5B model. The type ST5B excitation system\
\ is a variation of the type ST1A model, with alternative overexcitation and\
\ underexcitation inputs and additional limits.\r\nThe block diagram in the\
\ IEEE 421.5 standard has input signal Vc and does not indicate the summation\
\ point with Vref. The implementation of the ExcIEEEST5B shall consider\
\ summation point with Vref.\r\nReference: IEEE 421.5-2005, 7.5. "
attributes:
kc:
slot_uri: cim:ExcIEEEST5B.kc
range: PU
required: false
multivalued: false
description: Rectifier regulation factor (KC) (>=
0). Typical value = 0,004.
kr:
slot_uri: cim:ExcIEEEST5B.kr
range: PU
required: false
multivalued: false
description: Regulator gain (KR) (> 0). Typical
value = 200.
t1:
slot_uri: cim:ExcIEEEST5B.t1
range: Seconds
required: false
multivalued: false
description: Firing circuit time constant (T1) (>= 0). Typical
value = 0,004.
tb1:
slot_uri: cim:ExcIEEEST5B.tb1
range: Seconds
required: false
multivalued: false
description: Regulator lag time constant (TB1) (>=
0). Typical value = 6.
tb2:
slot_uri: cim:ExcIEEEST5B.tb2
range: Seconds
required: false
multivalued: false
description: Regulator lag time constant (TB2) (>=
0). Typical value = 0,01.
tc1:
slot_uri: cim:ExcIEEEST5B.tc1
range: Seconds
required: false
multivalued: false
description: Regulator lead time constant (TC1) (>=
0). Typical value = 0,8.
tc2:
slot_uri: cim:ExcIEEEST5B.tc2
range: Seconds
required: false
multivalued: false
description: Regulator lead time constant (TC2) (>=
0). Typical value = 0,08.
tob1:
slot_uri: cim:ExcIEEEST5B.tob1
range: Seconds
required: false
multivalued: false
description: OEL lag time constant (TOB1) (>=
0). Typical value = 2.
tob2:
slot_uri: cim:ExcIEEEST5B.tob2
range: Seconds
required: false
multivalued: false
description: OEL lag time constant (TOB2) (>=
0). Typical value = 0,08.
toc1:
slot_uri: cim:ExcIEEEST5B.toc1
range: Seconds
required: false
multivalued: false
description: OEL lead time constant (TOC1) (>=
0). Typical value = 0,1.
toc2:
slot_uri: cim:ExcIEEEST5B.toc2
range: Seconds
required: false
multivalued: false
description: OEL lead time constant (TOC2) (>=
0). Typical value = 0,08.
tub1:
slot_uri: cim:ExcIEEEST5B.tub1
range: Seconds
required: false
multivalued: false
description: UEL lag time constant (TUB1) (>=
0). Typical value = 10.
tub2:
slot_uri: cim:ExcIEEEST5B.tub2
range: Seconds
required: false
multivalued: false
description: UEL lag time constant (TUB2) (>=
0). Typical value = 0,05.
tuc1:
slot_uri: cim:ExcIEEEST5B.tuc1
range: Seconds
required: false
multivalued: false
description: UEL lead time constant (TUC1) (>=
0). Typical value = 2.
tuc2:
slot_uri: cim:ExcIEEEST5B.tuc2
range: Seconds
required: false
multivalued: false
description: UEL lead time constant (TUC2) (>=
0). Typical value = 0,1.
vrmax:
slot_uri: cim:ExcIEEEST5B.vrmax
range: PU
required: false
multivalued: false
description: Maximum voltage regulator output (VRMAX)
(> 0). Typical value = 5.
vrmin:
slot_uri: cim:ExcIEEEST5B.vrmin
range: PU
required: false
multivalued: false
description: Minimum voltage regulator output (VRMIN)
(< 0). Typical value = -4.
ExcIEEEST6B:
class_uri: cim:ExcIEEEST6B
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: "IEEE 421.5-2005 type ST6B model. This model consists of a PI voltage\
\ regulator with an inner loop field voltage regulator and pre-control. The\
\ field voltage regulator implements a proportional control. The pre-control\
\ and the delay in the feedback circuit increase the dynamic response.\r\nReference:\
\ IEEE 421.5-2005, 7.6. "
attributes:
ilr:
slot_uri: cim:ExcIEEEST6B.ilr
range: PU
required: false
multivalued: false
description: Exciter output current limit reference (ILR)
(> 0). Typical value = 4,164.
kci:
slot_uri: cim:ExcIEEEST6B.kci
range: PU
required: false
multivalued: false
description: Exciter output current limit adjustment (KCI)
(> 0). Typical value = 1,0577.
kff:
slot_uri: cim:ExcIEEEST6B.kff
range: PU
required: false
multivalued: false
description: Pre-control gain constant of the inner loop field regulator (KFF).
Typical value = 1.
kg:
slot_uri: cim:ExcIEEEST6B.kg
range: PU
required: false
multivalued: false
description: Feedback gain constant of the inner loop field regulator (KG)
(>= 0). Typical value = 1.
kia:
slot_uri: cim:ExcIEEEST6B.kia
range: PU
required: false
multivalued: false
description: Voltage regulator integral gain (KIA)
(> 0). Typical value = 45,094.
klr:
slot_uri: cim:ExcIEEEST6B.klr
range: PU
required: false
multivalued: false
description: Exciter output current limiter gain (KLR)
(> 0). Typical value = 17,33.
km:
slot_uri: cim:ExcIEEEST6B.km
range: PU
required: false
multivalued: false
description: Forward gain constant of the inner loop field regulator (KM). Typical
value = 1.
kpa:
slot_uri: cim:ExcIEEEST6B.kpa
range: PU
required: false
multivalued: false
description: Voltage regulator proportional gain (KPA)
(> 0). Typical value = 18,038.
oelin:
slot_uri: cim:ExcIEEEST6B.oelin
range: ExcST6BOELselectorKind
required: false
multivalued: false
description: OEL input selector (OELin). Typical value = noOELinput.
tg:
slot_uri: cim:ExcIEEEST6B.tg
range: Seconds
required: false
multivalued: false
description: Feedback time constant of inner loop field voltage regulator
(TG) (>= 0). Typical value = 0,02.
vamax:
slot_uri: cim:ExcIEEEST6B.vamax
range: PU
required: false
multivalued: false
description: Maximum voltage regulator output (VAMAX) (>
0). Typical value = 4,81.
vamin:
slot_uri: cim:ExcIEEEST6B.vamin
range: PU
required: false
multivalued: false
description: Minimum voltage regulator output (VAMIN)
(< 0). Typical value = -3,85.
vrmax:
slot_uri: cim:ExcIEEEST6B.vrmax
range: PU
required: false
multivalued: false
description: Maximum voltage regulator output (VRMAX)
(> 0). Typical value = 4,81.
vrmin:
slot_uri: cim:ExcIEEEST6B.vrmin
range: PU
required: false
multivalued: false
description: Minimum voltage regulator output (VRMIN)
(< 0). Typical value = -3,85.
ExcIEEEST7B:
class_uri: cim:ExcIEEEST7B
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: "IEEE 421.5-2005 type ST7B model. This model is representative of\
\ static potential-source excitation systems. In this system, the AVR consists\
\ of a PI voltage regulator. A phase lead-lag filter in series allows the introduction\
\ of a derivative function, typically used with brushless excitation systems.\
\ In that case, the regulator is of the PID type. In addition, the terminal\
\ voltage channel includes a phase lead-lag filter. The AVR includes the appropriate\
\ inputs on its reference for overexcitation limiter (OEL1), underexcitation\
\ limiter (UEL), stator current limiter (SCL), and current compensator (DROOP).\
\ All these limitations, when they work at voltage reference level, keep the\
\ PSS (VS signal from PSS) in operation. However, the UEL limitation can also\
\ be transferred to the high value (HV) gate acting on the output signal. In\
\ addition, the output signal passes through a low value (LV) gate for a ceiling\
\ overexcitation limiter (OEL2).\r\nReference: IEEE 421.5-2005, 7.7. "
attributes:
kh:
slot_uri: cim:ExcIEEEST7B.kh
range: PU
required: false
multivalued: false
description: High-value gate feedback gain (KH) (>=
0). Typical value = 1.
kia:
slot_uri: cim:ExcIEEEST7B.kia
range: PU
required: false
multivalued: false
description: Voltage regulator integral gain (KIA)
(>= 0). Typical value = 1.
kl:
slot_uri: cim:ExcIEEEST7B.kl
range: PU
required: false
multivalued: false
description: Low-value gate feedback gain (KL) (>=
0). Typical value = 1.
kpa:
slot_uri: cim:ExcIEEEST7B.kpa
range: PU
required: false
multivalued: false
description: Voltage regulator proportional gain (KPA)
(> 0). Typical value = 40.
oelin:
slot_uri: cim:ExcIEEEST7B.oelin
range: ExcST7BOELselectorKind
required: false
multivalued: false
description: OEL input selector (OELin). Typical value = noOELinput.
tb:
slot_uri: cim:ExcIEEEST7B.tb
range: Seconds
required: false
multivalued: false
description: Regulator lag time constant (TB) (>=
0). Typical value = 1.
tc:
slot_uri: cim:ExcIEEEST7B.tc
range: Seconds
required: false
multivalued: false
description: Regulator lead time constant (TC) (>=
0). Typical value = 1.
tf:
slot_uri: cim:ExcIEEEST7B.tf
range: Seconds
required: false
multivalued: false
description: Excitation control system stabilizer time constant (TF)
(>= 0). Typical value = 1.
tg:
slot_uri: cim:ExcIEEEST7B.tg
range: Seconds
required: false
multivalued: false
description: Feedback time constant of inner loop field voltage regulator
(TG) (>= 0). Typical value = 1.
tia:
slot_uri: cim:ExcIEEEST7B.tia
range: Seconds
required: false
multivalued: false
description: Feedback time constant (TIA) (>=
0). Typical value = 3.
uelin:
slot_uri: cim:ExcIEEEST7B.uelin
range: ExcST7BUELselectorKind
required: false
multivalued: false
description: UEL input selector (UELin). Typical value = noUELinput.
vmax:
slot_uri: cim:ExcIEEEST7B.vmax
range: PU
required: false
multivalued: false
description: Maximum voltage reference signal (VMAX)
(> 0 and > ExcIEEEST7B.vmin). Typical value = 1,1.
vmin:
slot_uri: cim:ExcIEEEST7B.vmin
range: PU
required: false
multivalued: false
description: Minimum voltage reference signal (VMIN)
(> 0 and < ExcIEEEST7B.vmax). Typical value = 0,9.
vrmax:
slot_uri: cim:ExcIEEEST7B.vrmax
range: PU
required: false
multivalued: false
description: Maximum voltage regulator output (VRMAX)
(> 0). Typical value = 5.
vrmin:
slot_uri: cim:ExcIEEEST7B.vrmin
range: PU
required: false
multivalued: false
description: Minimum voltage regulator output (VRMIN)
(< 0). Typical value = -4,5.
ExcAC1A:
class_uri: cim:ExcAC1A
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: Modified IEEE AC1A alternator-supplied rectifier excitation system
with different rate feedback source.
attributes:
hvlvgates:
slot_uri: cim:ExcAC1A.hvlvgates
range: boolean
required: false
multivalued: false
description: "Indicates if both HV gate and LV gate are active (HVLVgates).\r\
\ntrue = gates are used\r\nfalse = gates are not used.\r\nTypical value\
\ = true."
ka:
slot_uri: cim:ExcAC1A.ka
range: PU
required: false
multivalued: false
description: Voltage regulator gain (Ka) (> 0). Typical value =
400.
kc:
slot_uri: cim:ExcAC1A.kc
range: PU
required: false
multivalued: false
description: Rectifier loading factor proportional to commutating reactance
(Kc) (>= 0). Typical value = 0,2.
kd:
slot_uri: cim:ExcAC1A.kd
range: PU
required: false
multivalued: false
description: Demagnetizing factor, a function of exciter alternator reactances
(Kd) (>= 0). Typical value = 0,38.
ke:
slot_uri: cim:ExcAC1A.ke
range: PU
required: false
multivalued: false
description: Exciter constant related to self-excited field (Ke). Typical
value = 1.
kf:
slot_uri: cim:ExcAC1A.kf
range: PU
required: false
multivalued: false
description: Excitation control system stabilizer gains (Kf) (>=
0). Typical value = 0,03.
kf1:
slot_uri: cim:ExcAC1A.kf1
range: PU
required: false
multivalued: false
description: Coefficient to allow different usage of the model (Kf1)
(>= 0). Typical value = 0.
kf2:
slot_uri: cim:ExcAC1A.kf2
range: PU
required: false
multivalued: false
description: Coefficient to allow different usage of the model (Kf2)
(>= 0). Typical value = 1.
ks:
slot_uri: cim:ExcAC1A.ks
range: PU
required: false
multivalued: false
description: Coefficient to allow different usage of the model-speed coefficient
(Ks) (>= 0). Typical value = 0.
seve1:
slot_uri: cim:ExcAC1A.seve1
range: float
required: false
multivalued: false
description: Exciter saturation function value at the corresponding exciter
voltage, Ve1, back of commutating reactance (Se[Ve1])
(>= 0). Typical value = 0,1.
seve2:
slot_uri: cim:ExcAC1A.seve2
range: float
required: false
multivalued: false
description: Exciter saturation function value at the corresponding exciter
voltage, Ve2, back of commutating reactance (Se[Ve2])
(>= 0). Typical value = 0,03.
ta:
slot_uri: cim:ExcAC1A.ta
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (Ta) (> 0). Typical
value = 0,02.
tb:
slot_uri: cim:ExcAC1A.tb
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (Tb) (>= 0). Typical
value = 0.
tc:
slot_uri: cim:ExcAC1A.tc
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (Tc)
(>= 0). Typical value = 0.
te:
slot_uri: cim:ExcAC1A.te
range: Seconds
required: false
multivalued: false
description: Exciter time constant, integration rate associated with exciter
control (Te) (> 0). Typical value = 0,8.
tf:
slot_uri: cim:ExcAC1A.tf
range: Seconds
required: false
multivalued: false
description: Excitation control system stabilizer time constant (Tf)
(> 0). Typical value = 1.
vamax:
slot_uri: cim:ExcAC1A.vamax
range: PU
required: false
multivalued: false
description: Maximum voltage regulator output (Vamax)
(> 0). Typical value = 14,5.
vamin:
slot_uri: cim:ExcAC1A.vamin
range: PU
required: false
multivalued: false
description: Minimum voltage regulator output (Vamin)
(< 0). Typical value = -14,5.
ve1:
slot_uri: cim:ExcAC1A.ve1
range: PU
required: false
multivalued: false
description: Exciter alternator output voltages back of commutating reactance
at which saturation is defined (Ve1) (> 0). Typical value = 4,18.
ve2:
slot_uri: cim:ExcAC1A.ve2
range: PU
required: false
multivalued: false
description: Exciter alternator output voltages back of commutating reactance
at which saturation is defined (Ve2) (> 0). Typical value = 3,14.
vrmax:
slot_uri: cim:ExcAC1A.vrmax
range: PU
required: false
multivalued: false
description: Maximum voltage regulator outputs (Vrmax) (> 0). Typical
value = 6,03.
vrmin:
slot_uri: cim:ExcAC1A.vrmin
range: PU
required: false
multivalued: false
description: Minimum voltage regulator outputs (Vrmin) (< 0). Typical
value = -5,43.
ExcAC2A:
class_uri: cim:ExcAC2A
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: Modified IEEE AC2A alternator-supplied rectifier excitation system
with different field current limit.
attributes:
hvgate:
slot_uri: cim:ExcAC2A.hvgate
range: boolean
required: false
multivalued: false
description: "Indicates if HV gate is active (HVgate).\r\ntrue = gate\
\ is used\r\nfalse = gate is not used.\r\nTypical value = true."
ka:
slot_uri: cim:ExcAC2A.ka
range: PU
required: false
multivalued: false
description: Voltage regulator gain (Ka) (> 0). Typical value =
400.
kb:
slot_uri: cim:ExcAC2A.kb
range: PU
required: false
multivalued: false
description: Second stage regulator gain (Kb) (> 0). Exciter field
current controller gain. Typical value = 25.
kb1:
slot_uri: cim:ExcAC2A.kb1
range: PU
required: false
multivalued: false
description: Second stage regulator gain (Kb1). It is exciter field
current controller gain used as alternative to Kb to represent a
variant of the ExcAC2A model. Typical value = 25.
kc:
slot_uri: cim:ExcAC2A.kc
range: PU
required: false
multivalued: false
description: Rectifier loading factor proportional to commutating reactance
(Kc) (>= 0). Typical value = 0,28.
kd:
slot_uri: cim:ExcAC2A.kd
range: PU
required: false
multivalued: false
description: Demagnetizing factor, a function of exciter alternator reactances
(Kd) (>= 0). Typical value = 0,35.
ke:
slot_uri: cim:ExcAC2A.ke
range: PU
required: false
multivalued: false
description: Exciter constant related to self-excited field (Ke). Typical
value = 1.
kf:
slot_uri: cim:ExcAC2A.kf
range: PU
required: false
multivalued: false
description: Excitation control system stabilizer gains (Kf) (>=
0). Typical value = 0,03.
kh:
slot_uri: cim:ExcAC2A.kh
range: PU
required: false
multivalued: false
description: Exciter field current feedback gain (Kh) (>= 0). Typical
value = 1.
kl:
slot_uri: cim:ExcAC2A.kl
range: PU
required: false
multivalued: false
description: Exciter field current limiter gain (Kl). Typical value
= 10.
kl1:
slot_uri: cim:ExcAC2A.kl1
range: PU
required: false
multivalued: false
description: Coefficient to allow different usage of the model (Kl1). Typical
value = 1.
ks:
slot_uri: cim:ExcAC2A.ks
range: PU
required: false
multivalued: false
description: Coefficient to allow different usage of the model-speed coefficient
(Ks) (>= 0). Typical value = 0.
lvgate:
slot_uri: cim:ExcAC2A.lvgate
range: boolean
required: false
multivalued: false
description: "Indicates if LV gate is active (LVgate).\r\ntrue = gate\
\ is used\r\nfalse = gate is not used.\r\nTypical value = true."
seve1:
slot_uri: cim:ExcAC2A.seve1
range: float
required: false
multivalued: false
description: Exciter saturation function value at the corresponding exciter
voltage, Ve1, back of commutating reactance (Se[Ve1])
(>= 0). Typical value = 0,037.
seve2:
slot_uri: cim:ExcAC2A.seve2
range: float
required: false
multivalued: false
description: Exciter saturation function value at the corresponding exciter
voltage, Ve2, back of commutating reactance (Se[Ve2])
(>= 0). Typical value = 0,012.
ta:
slot_uri: cim:ExcAC2A.ta
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (Ta) (> 0). Typical
value = 0,02.
tb:
slot_uri: cim:ExcAC2A.tb
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (Tb) (>= 0). Typical
value = 0.
tc:
slot_uri: cim:ExcAC2A.tc
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (Tc) (>= 0). Typical
value = 0.
te:
slot_uri: cim:ExcAC2A.te
range: Seconds
required: false
multivalued: false
description: Exciter time constant, integration rate associated with exciter
control (Te) (> 0). Typical value = 0,6.
tf:
slot_uri: cim:ExcAC2A.tf
range: Seconds
required: false
multivalued: false
description: Excitation control system stabilizer time constant (Tf)
(> 0). Typical value = 1.
vamax:
slot_uri: cim:ExcAC2A.vamax
range: PU
required: false
multivalued: false
description: Maximum voltage regulator output (Vamax) (> 0). Typical
value = 8.
vamin:
slot_uri: cim:ExcAC2A.vamin
range: PU
required: false
multivalued: false
description: Minimum voltage regulator output (Vamin) (< 0). Typical
value = -8.
ve1:
slot_uri: cim:ExcAC2A.ve1
range: PU
required: false
multivalued: false
description: Exciter alternator output voltages back of commutating reactance
at which saturation is defined (Ve1) (> 0). Typical
value = 4,4.
ve2:
slot_uri: cim:ExcAC2A.ve2
range: PU
required: false
multivalued: false
description: Exciter alternator output voltages back of commutating reactance
at which saturation is defined (Ve2) (> 0). Typical
value = 3,3.
vfemax:
slot_uri: cim:ExcAC2A.vfemax
range: PU
required: false
multivalued: false
description: Exciter field current limit reference (Vfemax) (>=
0). Typical value = 4,4.
vlr:
slot_uri: cim:ExcAC2A.vlr
range: PU
required: false
multivalued: false
description: Maximum exciter field current (Vlr) (> 0). Typical
value = 4,4.
vrmax:
slot_uri: cim:ExcAC2A.vrmax
range: PU
required: false
multivalued: false
description: Maximum voltage regulator outputs (Vrmax) (> 0). Typical
value = 105.
vrmin:
slot_uri: cim:ExcAC2A.vrmin
range: PU
required: false
multivalued: false
description: Minimum voltage regulator outputs (Vrmin) (< 0). Typical
value = -95.
ExcAC3A:
class_uri: cim:ExcAC3A
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: Modified IEEE AC3A alternator-supplied rectifier excitation system
with different field current limit.
attributes:
efdn:
slot_uri: cim:ExcAC3A.efdn
range: PU
required: false
multivalued: false
description: Value of Efd at which feedback gain changes (Efdn)
(> 0). Typical value = 2,36.
ka:
slot_uri: cim:ExcAC3A.ka
range: Seconds
required: false
multivalued: false
description: Voltage regulator gain (Ka) (> 0). Typical value =
45,62.
kc:
slot_uri: cim:ExcAC3A.kc
range: PU
required: false
multivalued: false
description: Rectifier loading factor proportional to commutating reactance
(Kc) (>= 0). Typical value = 0,104.
kd:
slot_uri: cim:ExcAC3A.kd
range: PU
required: false
multivalued: false
description: Demagnetizing factor, a function of exciter alternator reactances
(Kd) (>= 0). Typical value = 0,499.
ke:
slot_uri: cim:ExcAC3A.ke
range: PU
required: false
multivalued: false
description: Exciter constant related to self-excited field (Ke). Typical
value = 1.
kf:
slot_uri: cim:ExcAC3A.kf
range: PU
required: false
multivalued: false
description: Excitation control system stabilizer gains (Kf) (>=
0). Typical value = 0,143.
kf1:
slot_uri: cim:ExcAC3A.kf1
range: PU
required: false
multivalued: false
description: Coefficient to allow different usage of the model (Kf1). Typical
value = 1.
kf2:
slot_uri: cim:ExcAC3A.kf2
range: PU
required: false
multivalued: false
description: Coefficient to allow different usage of the model (Kf2). Typical
value = 0.
klv:
slot_uri: cim:ExcAC3A.klv
range: PU
required: false
multivalued: false
description: Gain used in the minimum field voltage limiter loop (Klv). Typical
value = 0,194.
kn:
slot_uri: cim:ExcAC3A.kn
range: PU
required: false
multivalued: false
description: Excitation control system stabilizer gain (Kn) (>=
0). Typical value =0,05.
kr:
slot_uri: cim:ExcAC3A.kr
range: PU
required: false
multivalued: false
description: Constant associated with regulator and alternator field power
supply (Kr) (> 0). Typical value =3,77.
ks:
slot_uri: cim:ExcAC3A.ks
range: PU
required: false
multivalued: false
description: Coefficient to allow different usage of the model-speed coefficient
(Ks). Typical value = 0.
seve1:
slot_uri: cim:ExcAC3A.seve1
range: float
required: false
multivalued: false
description: Exciter saturation function value at the corresponding exciter
voltage, Ve1, back of commutating reactance (Se[Ve1])
(>= 0). Typical value = 1,143.
seve2:
slot_uri: cim:ExcAC3A.seve2
range: float
required: false
multivalued: false
description: Exciter saturation function value at the corresponding exciter
voltage, Ve2, back of commutating reactance (Se[Ve2])
(>= 0). Typical value = 0,1.
ta:
slot_uri: cim:ExcAC3A.ta
range: PU
required: false
multivalued: false
description: Voltage regulator time constant (Ta) (> 0). Typical
value = 0,013.
tb:
slot_uri: cim:ExcAC3A.tb
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (Tb) (>= 0). Typical
value = 0.
tc:
slot_uri: cim:ExcAC3A.tc
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (Tc) (>= 0). Typical
value = 0.
te:
slot_uri: cim:ExcAC3A.te
range: Seconds
required: false
multivalued: false
description: Exciter time constant, integration rate associated with exciter
control (Te) (> 0). Typical value = 1,17.
tf:
slot_uri: cim:ExcAC3A.tf
range: Seconds
required: false
multivalued: false
description: Excitation control system stabilizer time constant (Tf)
(> 0). Typical value = 1.
vamax:
slot_uri: cim:ExcAC3A.vamax
range: PU
required: false
multivalued: false
description: Maximum voltage regulator output (Vamax) (> 0). Typical
value = 1.
vamin:
slot_uri: cim:ExcAC3A.vamin
range: PU
required: false
multivalued: false
description: Minimum voltage regulator output (Vamin) (< 0). Typical
value = -0,95.
ve1:
slot_uri: cim:ExcAC3A.ve1
range: PU
required: false
multivalued: false
description: Exciter alternator output voltages back of commutating reactance
at which saturation is defined (Ve1) (> 0). Typical
value = 6.24.
ve2:
slot_uri: cim:ExcAC3A.ve2
range: PU
required: false
multivalued: false
description: Exciter alternator output voltages back of commutating reactance
at which saturation is defined (Ve2) (> 0). Typical
value = 4,68.
vemin:
slot_uri: cim:ExcAC3A.vemin
range: PU
required: false
multivalued: false
description: Minimum exciter voltage output (Vemin) (<= 0). Typical
value = 0.
vfemax:
slot_uri: cim:ExcAC3A.vfemax
range: PU
required: false
multivalued: false
description: Exciter field current limit reference (Vfemax) (>=
0). Typical value = 16.
vlv:
slot_uri: cim:ExcAC3A.vlv
range: PU
required: false
multivalued: false
description: Field voltage used in the minimum field voltage limiter loop
(Vlv). Typical value = 0,79.
ExcAC4A:
class_uri: cim:ExcAC4A
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: Modified IEEE AC4A alternator-supplied rectifier excitation system
with different minimum controller output.
attributes:
ka:
slot_uri: cim:ExcAC4A.ka
range: PU
required: false
multivalued: false
description: Voltage regulator gain (Ka) (> 0). Typical value =
200.
kc:
slot_uri: cim:ExcAC4A.kc
range: PU
required: false
multivalued: false
description: Rectifier loading factor proportional to commutating reactance
(Kc) (>= 0). Typical value = 0.
ta:
slot_uri: cim:ExcAC4A.ta
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (Ta) (> 0). Typical
value = 0,015.
tb:
slot_uri: cim:ExcAC4A.tb
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (Tb) (>= 0). Typical
value = 10.
tc:
slot_uri: cim:ExcAC4A.tc
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (Tc) (>= 0). Typical
value = 1.
vimax:
slot_uri: cim:ExcAC4A.vimax
range: PU
required: false
multivalued: false
description: Maximum voltage regulator input limit (Vimax) (> 0). Typical
value = 10.
vimin:
slot_uri: cim:ExcAC4A.vimin
range: PU
required: false
multivalued: false
description: Minimum voltage regulator input limit (Vimin) (< 0). Typical
value = -10.
vrmax:
slot_uri: cim:ExcAC4A.vrmax
range: PU
required: false
multivalued: false
description: Maximum voltage regulator output (Vrmax) (> 0). Typical
value = 5,64.
vrmin:
slot_uri: cim:ExcAC4A.vrmin
range: PU
required: false
multivalued: false
description: Minimum voltage regulator output (Vrmin) (< 0). Typical
value = -4,53.
ExcAC5A:
class_uri: cim:ExcAC5A
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: Modified IEEE AC5A alternator-supplied rectifier excitation system
with different minimum controller output.
attributes:
a:
slot_uri: cim:ExcAC5A.a
range: float
required: false
multivalued: false
description: Coefficient to allow different usage of the model (a). Typical
value = 1.
efd1:
slot_uri: cim:ExcAC5A.efd1
range: PU
required: false
multivalued: false
description: Exciter voltage at which exciter saturation is defined (Efd1)
(> 0). Typical value = 5,6.
efd2:
slot_uri: cim:ExcAC5A.efd2
range: PU
required: false
multivalued: false
description: Exciter voltage at which exciter saturation is defined (Efd2)
(> 0). Typical value = 4,2.
ka:
slot_uri: cim:ExcAC5A.ka
range: PU
required: false
multivalued: false
description: Voltage regulator gain (Ka) (> 0). Typical value =
400.
ke:
slot_uri: cim:ExcAC5A.ke
range: PU
required: false
multivalued: false
description: Exciter constant related to self-excited field (Ke). Typical
value = 1.
kf:
slot_uri: cim:ExcAC5A.kf
range: PU
required: false
multivalued: false
description: Excitation control system stabilizer gains (Kf) (>=
0). Typical value = 0,03.
ks:
slot_uri: cim:ExcAC5A.ks
range: PU
required: false
multivalued: false
description: Coefficient to allow different usage of the model-speed coefficient
(Ks). Typical value = 0.
seefd1:
slot_uri: cim:ExcAC5A.seefd1
range: float
required: false
multivalued: false
description: Exciter saturation function value at the corresponding exciter
voltage, Efd1 (Se[Efd1])
(>= 0). Typical value = 0,86.
seefd2:
slot_uri: cim:ExcAC5A.seefd2
range: float
required: false
multivalued: false
description: Exciter saturation function value at the corresponding exciter
voltage, Efd2 (Se[Efd2])
(>= 0). Typical value = 0,5.
ta:
slot_uri: cim:ExcAC5A.ta
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (Ta) (> 0). Typical
value = 0,02.
tb:
slot_uri: cim:ExcAC5A.tb
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (Tb) (>= 0). Typical
value = 0.
tc:
slot_uri: cim:ExcAC5A.tc
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (Tc) (>= 0). Typical
value = 0.
te:
slot_uri: cim:ExcAC5A.te
range: Seconds
required: false
multivalued: false
description: Exciter time constant, integration rate associated with exciter
control (Te) (> 0). Typical value = 0,8.
tf1:
slot_uri: cim:ExcAC5A.tf1
range: Seconds
required: false
multivalued: false
description: Excitation control system stabilizer time constant (Tf1)
(> 0). Typical value = 1.
tf2:
slot_uri: cim:ExcAC5A.tf2
range: Seconds
required: false
multivalued: false
description: Excitation control system stabilizer time constant (Tf2)
(>= 0). Typical value = 0,8.
tf3:
slot_uri: cim:ExcAC5A.tf3
range: Seconds
required: false
multivalued: false
description: Excitation control system stabilizer time constant (Tf3)
(>= 0). Typical value = 0.
vrmax:
slot_uri: cim:ExcAC5A.vrmax
range: PU
required: false
multivalued: false
description: Maximum voltage regulator output (Vrmax) (> 0). Typical
value = 7,3.
vrmin:
slot_uri: cim:ExcAC5A.vrmin
range: PU
required: false
multivalued: false
description: Minimum voltage regulator output (Vrmin) (< 0). Typical
value =-7,3.
ExcAC6A:
class_uri: cim:ExcAC6A
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: Modified IEEE AC6A alternator-supplied rectifier excitation system
with speed input.
attributes:
ka:
slot_uri: cim:ExcAC6A.ka
range: PU
required: false
multivalued: false
description: Voltage regulator gain (Ka) (> 0). Typical value =
536.
kc:
slot_uri: cim:ExcAC6A.kc
range: PU
required: false
multivalued: false
description: Rectifier loading factor proportional to commutating reactance
(Kc) (>= 0). Typical value = 0,173.
kd:
slot_uri: cim:ExcAC6A.kd
range: PU
required: false
multivalued: false
description: Demagnetizing factor, a function of exciter alternator reactances
(Kd) (>= 0). Typical value = 1,91.
ke:
slot_uri: cim:ExcAC6A.ke
range: PU
required: false
multivalued: false
description: Exciter constant related to self-excited field (Ke). Typical
value = 1,6.
kh:
slot_uri: cim:ExcAC6A.kh
range: PU
required: false
multivalued: false
description: Exciter field current limiter gain (Kh) (>= 0). Typical
value = 92.
ks:
slot_uri: cim:ExcAC6A.ks
range: PU
required: false
multivalued: false
description: Coefficient to allow different usage of the model-speed coefficient
(Ks). Typical value = 0.
seve1:
slot_uri: cim:ExcAC6A.seve1
range: float
required: false
multivalued: false
description: Exciter saturation function value at the corresponding exciter
voltage, Ve1, back of commutating reactance (Se[Ve1])
(>= 0). Typical value = 0,214.
seve2:
slot_uri: cim:ExcAC6A.seve2
range: float
required: false
multivalued: false
description: Exciter saturation function value at the corresponding exciter
voltage, Ve2, back of commutating reactance (Se[Ve2])
(>= 0). Typical value = 0,044.
ta:
slot_uri: cim:ExcAC6A.ta
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (Ta) (>= 0). Typical
value = 0,086.
tb:
slot_uri: cim:ExcAC6A.tb
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (Tb) (>= 0). Typical
value = 9.
tc:
slot_uri: cim:ExcAC6A.tc
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (Tc) (>= 0). Typical
value = 3.
te:
slot_uri: cim:ExcAC6A.te
range: Seconds
required: false
multivalued: false
description: Exciter time constant, integration rate associated with exciter
control (Te) (> 0). Typical value = 1.
th:
slot_uri: cim:ExcAC6A.th
range: Seconds
required: false
multivalued: false
description: Exciter field current limiter time constant (Th) (>
0). Typical value = 0,08.
tj:
slot_uri: cim:ExcAC6A.tj
range: Seconds
required: false
multivalued: false
description: Exciter field current limiter time constant (Tj) (>=
0). Typical value = 0,02.
tk:
slot_uri: cim:ExcAC6A.tk
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (Tk) (>= 0). Typical
value = 0,18.
vamax:
slot_uri: cim:ExcAC6A.vamax
range: PU
required: false
multivalued: false
description: Maximum voltage regulator output (Vamax) (> 0). Typical
value = 75.
vamin:
slot_uri: cim:ExcAC6A.vamin
range: PU
required: false
multivalued: false
description: Minimum voltage regulator output (Vamin) (< 0). Typical
value = -75.
ve1:
slot_uri: cim:ExcAC6A.ve1
range: PU
required: false
multivalued: false
description: Exciter alternator output voltages back of commutating reactance
at which saturation is defined (Ve1) (> 0). Typical
value = 7,4.
ve2:
slot_uri: cim:ExcAC6A.ve2
range: PU
required: false
multivalued: false
description: Exciter alternator output voltages back of commutating reactance
at which saturation is defined (Ve2) (> 0). Typical
value = 5,55.
vfelim:
slot_uri: cim:ExcAC6A.vfelim
range: PU
required: false
multivalued: false
description: Exciter field current limit reference (Vfelim) (> 0). Typical
value = 19.
vhmax:
slot_uri: cim:ExcAC6A.vhmax
range: PU
required: false
multivalued: false
description: Maximum field current limiter signal reference (Vhmax)
(> 0). Typical value = 75.
vrmax:
slot_uri: cim:ExcAC6A.vrmax
range: PU
required: false
multivalued: false
description: Maximum voltage regulator output (Vrmax) (> 0). Typical
value = 44.
vrmin:
slot_uri: cim:ExcAC6A.vrmin
range: PU
required: false
multivalued: false
description: Minimum voltage regulator output (Vrmin) (< 0). Typical
value = -36.
ExcAC8B:
class_uri: cim:ExcAC8B
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: Modified IEEE AC8B alternator-supplied rectifier excitation system
with speed input and input limiter.
attributes:
inlim:
slot_uri: cim:ExcAC8B.inlim
range: boolean
required: false
multivalued: false
description: "Input limiter indicator.\r\ntrue = input limiter Vimax\
\ and Vimin is considered\r\nfalse = input limiter Vimax and\
\ Vimin is not considered.\r\nTypical value = true."
ka:
slot_uri: cim:ExcAC8B.ka
range: PU
required: false
multivalued: false
description: Voltage regulator gain (Ka) (> 0). Typical value =
1.
kc:
slot_uri: cim:ExcAC8B.kc
range: PU
required: false
multivalued: false
description: Rectifier loading factor proportional to commutating reactance
(Kc) (>= 0). Typical value = 0,55.
kd:
slot_uri: cim:ExcAC8B.kd
range: PU
required: false
multivalued: false
description: Demagnetizing factor, a function of exciter alternator reactances
(Kd) (>= 0). Typical value = 1,1.
kdr:
slot_uri: cim:ExcAC8B.kdr
range: PU
required: false
multivalued: false
description: Voltage regulator derivative gain (Kdr) (>= 0). Typical
value = 10.
ke:
slot_uri: cim:ExcAC8B.ke
range: PU
required: false
multivalued: false
description: Exciter constant related to self-excited field (Ke). Typical
value = 1.
kir:
slot_uri: cim:ExcAC8B.kir
range: PU
required: false
multivalued: false
description: Voltage regulator integral gain (Kir) (>= 0). Typical
value = 5.
kpr:
slot_uri: cim:ExcAC8B.kpr
range: PU
required: false
multivalued: false
description: Voltage regulator proportional gain (Kpr) (> 0 if ExcAC8B.kir
= 0). Typical value = 80.
ks:
slot_uri: cim:ExcAC8B.ks
range: PU
required: false
multivalued: false
description: Coefficient to allow different usage of the model-speed coefficient
(Ks). Typical value = 0.
pidlim:
slot_uri: cim:ExcAC8B.pidlim
range: boolean
required: false
multivalued: false
description: "PID limiter indicator.\r\ntrue = input limiter Vpidmax\
\ and Vpidmin is considered\r\nfalse = input limiter Vpidmax\
\ and Vpidmin is not considered.\r\nTypical value = true."
seve1:
slot_uri: cim:ExcAC8B.seve1
range: float
required: false
multivalued: false
description: Exciter saturation function value at the corresponding exciter
voltage, Ve1, back of commutating reactance (Se[Ve1])
(>= 0). Typical value = 0,3.
seve2:
slot_uri: cim:ExcAC8B.seve2
range: float
required: false
multivalued: false
description: Exciter saturation function value at the corresponding exciter
voltage, Ve2, back of commutating reactance (Se[Ve2])
(>= 0). Typical value = 3.
ta:
slot_uri: cim:ExcAC8B.ta
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (Ta) (>= 0). Typical
value = 0.
tdr:
slot_uri: cim:ExcAC8B.tdr
range: Seconds
required: false
multivalued: false
description: Lag time constant (Tdr) (> 0 if ExcAC8B.kdr > 0). Typical
value = 0,1.
te:
slot_uri: cim:ExcAC8B.te
range: Seconds
required: false
multivalued: false
description: Exciter time constant, integration rate associated with exciter
control (Te) (> 0). Typical value = 1,2.
telim:
slot_uri: cim:ExcAC8B.telim
range: boolean
required: false
multivalued: false
description: "Selector for the limiter on the block (1/sTe). \r\nSee\
\ diagram for meaning of true and false.\r\nTypical value = false."
ve1:
slot_uri: cim:ExcAC8B.ve1
range: PU
required: false
multivalued: false
description: Exciter alternator output voltages back of commutating reactance
at which saturation is defined (Ve1) (> 0). Typical
value = 6,5.
ve2:
slot_uri: cim:ExcAC8B.ve2
range: PU
required: false
multivalued: false
description: Exciter alternator output voltages back of commutating reactance
at which saturation is defined (Ve2) (> 0). Typical
value = 9.
vemin:
slot_uri: cim:ExcAC8B.vemin
range: PU
required: false
multivalued: false
description: Minimum exciter voltage output (Vemin) (<= 0). Typical
value = 0.
vfemax:
slot_uri: cim:ExcAC8B.vfemax
range: PU
required: false
multivalued: false
description: Exciter field current limit reference (Vfemax). Typical
value = 6.
vimax:
slot_uri: cim:ExcAC8B.vimax
range: PU
required: false
multivalued: false
description: Input signal maximum (Vimax) (> ExcAC8B.vimin). Typical
value = 35.
vimin:
slot_uri: cim:ExcAC8B.vimin
range: PU
required: false
multivalued: false
description: Input signal minimum (Vimin) (< ExcAC8B.vimax). Typical
value = -10.
vpidmax:
slot_uri: cim:ExcAC8B.vpidmax
range: PU
required: false
multivalued: false
description: PID maximum controller output (Vpidmax) (> ExcAC8B.vpidmin). Typical
value = 35.
vpidmin:
slot_uri: cim:ExcAC8B.vpidmin
range: PU
required: false
multivalued: false
description: PID minimum controller output (Vpidmin) (< ExcAC8B.vpidmax). Typical
value = -10.
vrmax:
slot_uri: cim:ExcAC8B.vrmax
range: PU
required: false
multivalued: false
description: Maximum voltage regulator output (Vrmax) (> 0). Typical
value = 35.
vrmin:
slot_uri: cim:ExcAC8B.vrmin
range: PU
required: false
multivalued: false
description: Minimum voltage regulator output (Vrmin) (< 0). Typical
value = 0.
vtmult:
slot_uri: cim:ExcAC8B.vtmult
range: boolean
required: false
multivalued: false
description: "Multiply by generator's terminal voltage indicator.\r\ntrue\
\ =the limits Vrmax and Vrmin are multiplied by the generator\u2019\
s terminal voltage to represent a thyristor power stage fed from the generator\
\ terminals\r\nfalse = limits are not multiplied by generator's terminal\
\ voltage. \r\nTypical value = false."
ExcANS:
class_uri: cim:ExcANS
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: Italian excitation system. It represents static field voltage or
excitation current feedback excitation system.
attributes:
blint:
slot_uri: cim:ExcANS.blint
range: integer
required: false
multivalued: false
description: "Governor control flag (BLINT). \r\n0 = lead-lag regulator\r\
\n1 = proportional integral regulator.\r\nTypical value = 0."
ifmn:
slot_uri: cim:ExcANS.ifmn
range: PU
required: false
multivalued: false
description: Minimum exciter current (IFMN). Typical
value = -5,2.
ifmx:
slot_uri: cim:ExcANS.ifmx
range: PU
required: false
multivalued: false
description: Maximum exciter current (IFMX). Typical
value = 6,5.
k2:
slot_uri: cim:ExcANS.k2
range: float
required: false
multivalued: false
description: Exciter gain (K2). Typical value =
20.
k3:
slot_uri: cim:ExcANS.k3
range: float
required: false
multivalued: false
description: AVR gain (K3). Typical value = 1000.
kce:
slot_uri: cim:ExcANS.kce
range: float
required: false
multivalued: false
description: Ceiling factor (KCE). Typical value
= 1.
krvecc:
slot_uri: cim:ExcANS.krvecc
range: integer
required: false
multivalued: false
description: "Feedback enabling (KRVECC). \r\n0 =\
\ open loop control\r\n1 = closed loop control.\r\nTypical value = 1."
kvfif:
slot_uri: cim:ExcANS.kvfif
range: integer
required: false
multivalued: false
description: "Rate feedback signal flag (KVFIF).\
\ \r\n0 = output voltage of the exciter\r\n1 = exciter field current.\r\n\
Typical value = 0."
t1:
slot_uri: cim:ExcANS.t1
range: Seconds
required: false
multivalued: false
description: Time constant (T1) (>= 0). Typical
value = 20.
t2:
slot_uri: cim:ExcANS.t2
range: Seconds
required: false
multivalued: false
description: Time constant (T2) (>= 0). Typical
value = 0,05.
t3:
slot_uri: cim:ExcANS.t3
range: Seconds
required: false
multivalued: false
description: Time constant (T3) (>= 0). Typical
value = 1,6.
tb:
slot_uri: cim:ExcANS.tb
range: Seconds
required: false
multivalued: false
description: Exciter time constant (TB) (>= 0). Typical
value = 0,04.
vrmn:
slot_uri: cim:ExcANS.vrmn
range: PU
required: false
multivalued: false
description: Minimum AVR output (VRMN). Typical
value = -5,2.
vrmx:
slot_uri: cim:ExcANS.vrmx
range: PU
required: false
multivalued: false
description: Maximum AVR output (VRMX). Typical
value = 6,5.
ExcAVR1:
class_uri: cim:ExcAVR1
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: Italian excitation system corresponding to IEEE (1968) type 1 model.
It represents an exciter dynamo and electromechanical regulator.
attributes:
e1:
slot_uri: cim:ExcAVR1.e1
range: PU
required: false
multivalued: false
description: Field voltage value 1 (E1). Typical
value = 4.18.
e2:
slot_uri: cim:ExcAVR1.e2
range: PU
required: false
multivalued: false
description: Field voltage value 2 (E2). Typical
value = 3,14.
ka:
slot_uri: cim:ExcAVR1.ka
range: float
required: false
multivalued: false
description: AVR gain (KA). Typical value = 500.
kf:
slot_uri: cim:ExcAVR1.kf
range: float
required: false
multivalued: false
description: Rate feedback gain (KF). Typical value
= 0,12.
se1:
slot_uri: cim:ExcAVR1.se1
range: float
required: false
multivalued: false
description: Saturation factor at E1 (S[E1]). Typical
value = 0,1.
se2:
slot_uri: cim:ExcAVR1.se2
range: float
required: false
multivalued: false
description: Saturation factor at E2 (S[E2]). Typical
value = 0,03.
ta:
slot_uri: cim:ExcAVR1.ta
range: Seconds
required: false
multivalued: false
description: AVR time constant (TA) (>= 0). Typical
value = 0,2.
tb:
slot_uri: cim:ExcAVR1.tb
range: Seconds
required: false
multivalued: false
description: AVR time constant (TB) (>= 0). Typical
value = 0.
te:
slot_uri: cim:ExcAVR1.te
range: Seconds
required: false
multivalued: false
description: Exciter time constant (TE) (>= 0). Typical
value = 1.
tf:
slot_uri: cim:ExcAVR1.tf
range: Seconds
required: false
multivalued: false
description: Rate feedback time constant (TF) (>=
0). Typical value = 1.
vrmn:
slot_uri: cim:ExcAVR1.vrmn
range: PU
required: false
multivalued: false
description: Minimum AVR output (VRMN). Typical
value = -6.
vrmx:
slot_uri: cim:ExcAVR1.vrmx
range: PU
required: false
multivalued: false
description: Maximum AVR output (VRMX). Typical
value = 7.
ExcAVR2:
class_uri: cim:ExcAVR2
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: Italian excitation system corresponding to IEEE (1968) type 2 model.
It represents an alternator and rotating diodes and electromechanic voltage
regulators.
attributes:
e1:
slot_uri: cim:ExcAVR2.e1
range: PU
required: false
multivalued: false
description: Field voltage value 1 (E1). Typical
value = 4,18.
e2:
slot_uri: cim:ExcAVR2.e2
range: PU
required: false
multivalued: false
description: Field voltage value 2 (E2). Typical
value = 3,14.
ka:
slot_uri: cim:ExcAVR2.ka
range: float
required: false
multivalued: false
description: AVR gain (KA). Typical value = 500.
kf:
slot_uri: cim:ExcAVR2.kf
range: float
required: false
multivalued: false
description: Rate feedback gain (KF). Typical value
= 0,12.
se1:
slot_uri: cim:ExcAVR2.se1
range: float
required: false
multivalued: false
description: Saturation factor at E1 (S[E1]). Typical
value = 0.1.
se2:
slot_uri: cim:ExcAVR2.se2
range: float
required: false
multivalued: false
description: Saturation factor at E2 (S[E2]). Typical
value = 0,03.
ta:
slot_uri: cim:ExcAVR2.ta
range: Seconds
required: false
multivalued: false
description: AVR time constant (TA) (>= 0). Typical
value = 0,02.
tb:
slot_uri: cim:ExcAVR2.tb
range: Seconds
required: false
multivalued: false
description: AVR time constant (TB) (>= 0). Typical
value = 0.
te:
slot_uri: cim:ExcAVR2.te
range: Seconds
required: false
multivalued: false
description: Exciter time constant (TE) (>= 0). Typical
value = 1.
tf1:
slot_uri: cim:ExcAVR2.tf1
range: Seconds
required: false
multivalued: false
description: Rate feedback time constant (TF1) (>=
0). Typical value = 1.
tf2:
slot_uri: cim:ExcAVR2.tf2
range: Seconds
required: false
multivalued: false
description: Rate feedback time constant (TF2) (>=
0). Typical value = 1.
vrmn:
slot_uri: cim:ExcAVR2.vrmn
range: PU
required: false
multivalued: false
description: Minimum AVR output (VRMN). Typical
value = -6.
vrmx:
slot_uri: cim:ExcAVR2.vrmx
range: PU
required: false
multivalued: false
description: Maximum AVR output (VRMX). Typical
value = 7.
ExcAVR3:
class_uri: cim:ExcAVR3
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: 'Italian excitation system. It represents an exciter dynamo and electric
regulator. '
attributes:
e1:
slot_uri: cim:ExcAVR3.e1
range: PU
required: false
multivalued: false
description: Field voltage value 1 (E1). Typical
value = 4,18.
e2:
slot_uri: cim:ExcAVR3.e2
range: PU
required: false
multivalued: false
description: Field voltage value 2 (E2). Typical
value = 3,14.
ka:
slot_uri: cim:ExcAVR3.ka
range: float
required: false
multivalued: false
description: AVR gain (KA). Typical value = 100.
se1:
slot_uri: cim:ExcAVR3.se1
range: float
required: false
multivalued: false
description: Saturation factor at E1 (S[E1]). Typical
value = 0,1.
se2:
slot_uri: cim:ExcAVR3.se2
range: float
required: false
multivalued: false
description: Saturation factor at E2 (S[E2]). Typical
value = 0,03.
t1:
slot_uri: cim:ExcAVR3.t1
range: Seconds
required: false
multivalued: false
description: AVR time constant (T1) (>= 0). Typical
value = 20.
t2:
slot_uri: cim:ExcAVR3.t2
range: Seconds
required: false
multivalued: false
description: AVR time constant (T2) (>= 0). Typical
value = 1,6.
t3:
slot_uri: cim:ExcAVR3.t3
range: Seconds
required: false
multivalued: false
description: AVR time constant (T3) (>= 0). Typical
value = 0,66.
t4:
slot_uri: cim:ExcAVR3.t4
range: Seconds
required: false
multivalued: false
description: AVR time constant (T4) (>= 0). Typical
value = 0,07.
te:
slot_uri: cim:ExcAVR3.te
range: Seconds
required: false
multivalued: false
description: Exciter time constant (TE) (>= 0). Typical
value = 1.
vrmn:
slot_uri: cim:ExcAVR3.vrmn
range: PU
required: false
multivalued: false
description: Minimum AVR output (VRMN). Typical
value = -7,5.
vrmx:
slot_uri: cim:ExcAVR3.vrmx
range: PU
required: false
multivalued: false
description: Maximum AVR output (VRMX). Typical
value = 7,5.
ExcAVR4:
class_uri: cim:ExcAVR4
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: Italian excitation system. It represents a static exciter and electric
voltage regulator.
attributes:
imul:
slot_uri: cim:ExcAVR4.imul
range: boolean
required: false
multivalued: false
description: "AVR output voltage dependency selector (IMUL).\r\
\ntrue = selector is connected\r\nfalse = selector is not connected.\r\n\
Typical value = true."
ka:
slot_uri: cim:ExcAVR4.ka
range: float
required: false
multivalued: false
description: AVR gain (KA). Typical value = 300.
ke:
slot_uri: cim:ExcAVR4.ke
range: float
required: false
multivalued: false
description: Exciter gain (KE). Typical value
= 1.
kif:
slot_uri: cim:ExcAVR4.kif
range: float
required: false
multivalued: false
description: Exciter internal reactance (KIF). Typical
value = 0.
t1:
slot_uri: cim:ExcAVR4.t1
range: Seconds
required: false
multivalued: false
description: AVR time constant (T1) (>= 0). Typical
value = 4,8.
t1if:
slot_uri: cim:ExcAVR4.t1if
range: Seconds
required: false
multivalued: false
description: Exciter current feedback time constant (T1IF)
(>= 0). Typical value = 60.
t2:
slot_uri: cim:ExcAVR4.t2
range: Seconds
required: false
multivalued: false
description: AVR time constant (T2) (>= 0). Typical
value = 1,5.
t3:
slot_uri: cim:ExcAVR4.t3
range: Seconds
required: false
multivalued: false
description: AVR time constant (T3) (>= 0). Typical
value = 0.
t4:
slot_uri: cim:ExcAVR4.t4
range: Seconds
required: false
multivalued: false
description: AVR time constant (T4) (>= 0). Typical
value = 0.
tif:
slot_uri: cim:ExcAVR4.tif
range: Seconds
required: false
multivalued: false
description: Exciter current feedback time constant (TIF)
(>= 0). Typical value = 0.
vfmn:
slot_uri: cim:ExcAVR4.vfmn
range: PU
required: false
multivalued: false
description: Minimum exciter output (VFMN). Typical
value = 0.
vfmx:
slot_uri: cim:ExcAVR4.vfmx
range: PU
required: false
multivalued: false
description: Maximum exciter output (VFMX). Typical
value = 5.
vrmn:
slot_uri: cim:ExcAVR4.vrmn
range: PU
required: false
multivalued: false
description: Minimum AVR output (VRMN). Typical
value = 0.
vrmx:
slot_uri: cim:ExcAVR4.vrmx
range: PU
required: false
multivalued: false
description: Maximum AVR output (VRMX). Typical
value = 5.
ExcAVR5:
class_uri: cim:ExcAVR5
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: Manual excitation control with field circuit resistance. This model
can be used as a very simple representation of manual voltage control.
attributes:
ka:
slot_uri: cim:ExcAVR5.ka
range: PU
required: false
multivalued: false
description: Gain (Ka).
rex:
slot_uri: cim:ExcAVR5.rex
range: PU
required: false
multivalued: false
description: Effective output resistance (Rex). Rex represents
the effective output resistance seen by the excitation system.
ta:
slot_uri: cim:ExcAVR5.ta
range: Seconds
required: false
multivalued: false
description: Time constant (Ta) (>= 0).
ExcAVR7:
class_uri: cim:ExcAVR7
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: IVO excitation system.
attributes:
a1:
slot_uri: cim:ExcAVR7.a1
range: PU
required: false
multivalued: false
description: Lead coefficient (A1). Typical value
= 0,5.
a2:
slot_uri: cim:ExcAVR7.a2
range: PU
required: false
multivalued: false
description: Lag coefficient (A2). Typical value
= 0,5.
a3:
slot_uri: cim:ExcAVR7.a3
range: PU
required: false
multivalued: false
description: Lead coefficient (A3). Typical value
= 0,5.
a4:
slot_uri: cim:ExcAVR7.a4
range: PU
required: false
multivalued: false
description: Lag coefficient (A4). Typical value
= 0,5.
a5:
slot_uri: cim:ExcAVR7.a5
range: PU
required: false
multivalued: false
description: Lead coefficient (A5). Typical value
= 0,5.
a6:
slot_uri: cim:ExcAVR7.a6
range: PU
required: false
multivalued: false
description: Lag coefficient (A6). Typical value
= 0,5.
k1:
slot_uri: cim:ExcAVR7.k1
range: PU
required: false
multivalued: false
description: Gain (K1). Typical value = 1.
k3:
slot_uri: cim:ExcAVR7.k3
range: PU
required: false
multivalued: false
description: Gain (K3). Typical value = 3.
k5:
slot_uri: cim:ExcAVR7.k5
range: PU
required: false
multivalued: false
description: Gain (K5). Typical value = 1.
t1:
slot_uri: cim:ExcAVR7.t1
range: Seconds
required: false
multivalued: false
description: Lead time constant (T1) (>= 0). Typical
value = 0,05.
t2:
slot_uri: cim:ExcAVR7.t2
range: Seconds
required: false
multivalued: false
description: Lag time constant (T2) (>= 0). Typical
value = 0,1.
t3:
slot_uri: cim:ExcAVR7.t3
range: Seconds
required: false
multivalued: false
description: Lead time constant (T3) (>= 0). Typical
value = 0,1.
t4:
slot_uri: cim:ExcAVR7.t4
range: Seconds
required: false
multivalued: false
description: Lag time constant (T4) (>= 0). Typical
value = 0,1.
t5:
slot_uri: cim:ExcAVR7.t5
range: Seconds
required: false
multivalued: false
description: Lead time constant (T5) (>= 0). Typical
value = 0,1.
t6:
slot_uri: cim:ExcAVR7.t6
range: Seconds
required: false
multivalued: false
description: Lag time constant (T6) (>= 0). Typical
value = 0,1.
vmax1:
slot_uri: cim:ExcAVR7.vmax1
range: PU
required: false
multivalued: false
description: Lead-lag maximum limit (Vmax1) (> ExcAVR7.vmin1). Typical
value = 5.
vmax3:
slot_uri: cim:ExcAVR7.vmax3
range: PU
required: false
multivalued: false
description: Lead-lag maximum limit (Vmax3) (> ExcAVR7.vmin3). Typical
value = 5.
vmax5:
slot_uri: cim:ExcAVR7.vmax5
range: PU
required: false
multivalued: false
description: Lead-lag maximum limit (Vmax5) (> ExcAVR7.vmin5). Typical
value = 5.
vmin1:
slot_uri: cim:ExcAVR7.vmin1
range: PU
required: false
multivalued: false
description: Lead-lag minimum limit (Vmin1) (< ExcAVR7.vmax1). Typical
value = -5.
vmin3:
slot_uri: cim:ExcAVR7.vmin3
range: PU
required: false
multivalued: false
description: Lead-lag minimum limit (Vmin3) (< ExcAVR7.vmax3). Typical
value = -5.
vmin5:
slot_uri: cim:ExcAVR7.vmin5
range: PU
required: false
multivalued: false
description: Lead-lag minimum limit (Vmin5) (< ExcAVR7.vmax5). Typical
value = -2.
ExcBBC:
class_uri: cim:ExcBBC
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: Transformer fed static excitation system (static with ABB regulator).
This model represents a static excitation system in which a gated thyristor
bridge fed by a transformer at the main generator terminals feeds the main generator
directly.
attributes:
efdmax:
slot_uri: cim:ExcBBC.efdmax
range: PU
required: false
multivalued: false
description: Maximum open circuit exciter voltage (Efdmax) (> ExcBBC.efdmin). Typical
value = 5.
efdmin:
slot_uri: cim:ExcBBC.efdmin
range: PU
required: false
multivalued: false
description: Minimum open circuit exciter voltage (Efdmin) (< ExcBBC.efdmax). Typical
value = -5.
k:
slot_uri: cim:ExcBBC.k
range: PU
required: false
multivalued: false
description: Steady state gain (K) (not = 0). Typical value = 300.
switch:
slot_uri: cim:ExcBBC.switch
range: boolean
required: false
multivalued: false
description: "Supplementary signal routing selector (switch).\r\ntrue\
\ = Vs connected to 3rd summing point\r\nfalse = Vs connected\
\ to 1st summing point (see diagram).\r\nTypical value = false."
t1:
slot_uri: cim:ExcBBC.t1
range: Seconds
required: false
multivalued: false
description: Controller time constant (T1) (>= 0). Typical value
= 6.
t2:
slot_uri: cim:ExcBBC.t2
range: Seconds
required: false
multivalued: false
description: Controller time constant (T2) (>= 0). Typical value
= 1.
t3:
slot_uri: cim:ExcBBC.t3
range: Seconds
required: false
multivalued: false
description: Lead/lag time constant (T3) (>= 0). If = 0, block
is bypassed. Typical value = 0,05.
t4:
slot_uri: cim:ExcBBC.t4
range: Seconds
required: false
multivalued: false
description: Lead/lag time constant (T4) (>= 0). If = 0, block
is bypassed. Typical value = 0,01.
vrmax:
slot_uri: cim:ExcBBC.vrmax
range: PU
required: false
multivalued: false
description: Maximum control element output (Vrmax) (> ExcBBC.vrmin). Typical
value = 5.
vrmin:
slot_uri: cim:ExcBBC.vrmin
range: PU
required: false
multivalued: false
description: Minimum control element output (Vrmin) (< ExcBBC.vrmax). Typical
value = -5.
xe:
slot_uri: cim:ExcBBC.xe
range: PU
required: false
multivalued: false
description: Effective excitation transformer reactance (Xe) (>=
0). Xe models the regulation of the transformer/rectifier unit. Typical
value = 0,05.
ExcCZ:
class_uri: cim:ExcCZ
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: Czech proportion/integral exciter.
attributes:
efdmax:
slot_uri: cim:ExcCZ.efdmax
range: PU
required: false
multivalued: false
description: Exciter output maximum limit (Efdmax) (> ExcCZ.efdmin).
efdmin:
slot_uri: cim:ExcCZ.efdmin
range: PU
required: false
multivalued: false
description: 'Exciter output minimum limit (Efdmin) (< ExcCZ.efdmax). '
ka:
slot_uri: cim:ExcCZ.ka
range: PU
required: false
multivalued: false
description: Regulator gain (Ka).
ke:
slot_uri: cim:ExcCZ.ke
range: PU
required: false
multivalued: false
description: Exciter constant related to self-excited field (Ke).
kp:
slot_uri: cim:ExcCZ.kp
range: PU
required: false
multivalued: false
description: Regulator proportional gain (Kp).
ta:
slot_uri: cim:ExcCZ.ta
range: Seconds
required: false
multivalued: false
description: Regulator time constant (Ta) (>= 0).
tc:
slot_uri: cim:ExcCZ.tc
range: Seconds
required: false
multivalued: false
description: 'Regulator integral time constant (Tc) (>= 0). '
te:
slot_uri: cim:ExcCZ.te
range: Seconds
required: false
multivalued: false
description: Exciter time constant, integration rate associated with exciter
control (Te) (>= 0).
vrmax:
slot_uri: cim:ExcCZ.vrmax
range: PU
required: false
multivalued: false
description: 'Voltage regulator maximum limit (Vrmax) (> ExcCZ.vrmin). '
vrmin:
slot_uri: cim:ExcCZ.vrmin
range: PU
required: false
multivalued: false
description: 'Voltage regulator minimum limit (Vrmin) (< ExcCZ.vrmax). '
ExcDC1A:
class_uri: cim:ExcDC1A
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: Modified IEEE DC1A direct current commutator exciter with speed input
and without underexcitation limiters (UEL) inputs.
attributes:
efd1:
slot_uri: cim:ExcDC1A.efd1
range: PU
required: false
multivalued: false
description: Exciter voltage at which exciter saturation is defined (Efd1)
(> 0). Typical value = 3,1.
efd2:
slot_uri: cim:ExcDC1A.efd2
range: PU
required: false
multivalued: false
description: Exciter voltage at which exciter saturation is defined (Efd2)
(> 0). Typical value = 2,3.
efdmax:
slot_uri: cim:ExcDC1A.efdmax
range: PU
required: false
multivalued: false
description: Maximum voltage exciter output limiter (Efdmax) (>
ExcDC1A.efdmin). Typical value = 99.
efdmin:
slot_uri: cim:ExcDC1A.efdmin
range: PU
required: false
multivalued: false
description: Minimum voltage exciter output limiter (Efdmin) (<
ExcDC1A.edfmax). Typical value = -99.
exclim:
slot_uri: cim:ExcDC1A.exclim
range: boolean
required: false
multivalued: false
description: "(exclim). IEEE standard is ambiguous about lower limit\
\ on exciter output. \r\ntrue = a lower limit of zero is applied to integrator\
\ output\r\nfalse = a lower limit of zero is not applied to integrator output.\r\
\nTypical value = true."
ka:
slot_uri: cim:ExcDC1A.ka
range: PU
required: false
multivalued: false
description: Voltage regulator gain (Ka) (> 0). Typical value =
46.
ke:
slot_uri: cim:ExcDC1A.ke
range: PU
required: false
multivalued: false
description: Exciter constant related to self-excited field (Ke). Typical
value = 0.
kf:
slot_uri: cim:ExcDC1A.kf
range: PU
required: false
multivalued: false
description: Excitation control system stabilizer gain (Kf) (>=
0). Typical value = 0,1.
ks:
slot_uri: cim:ExcDC1A.ks
range: PU
required: false
multivalued: false
description: Coefficient to allow different usage of the model-speed coefficient
(Ks). Typical value = 0.
seefd1:
slot_uri: cim:ExcDC1A.seefd1
range: float
required: false
multivalued: false
description: Exciter saturation function value at the corresponding exciter
voltage, Efd1 (Se[Eefd1])
(>= 0). Typical value = 0,33.
seefd2:
slot_uri: cim:ExcDC1A.seefd2
range: float
required: false
multivalued: false
description: Exciter saturation function value at the corresponding exciter
voltage, Efd2 (Se[Eefd2])
(>= 0). Typical value = 0,1.
ta:
slot_uri: cim:ExcDC1A.ta
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (Ta) (> 0). Typical
value = 0,06.
tb:
slot_uri: cim:ExcDC1A.tb
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (Tb) (>= 0). Typical
value = 0.
tc:
slot_uri: cim:ExcDC1A.tc
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (Tc) (>= 0). Typical
value = 0.
te:
slot_uri: cim:ExcDC1A.te
range: Seconds
required: false
multivalued: false
description: Exciter time constant, integration rate associated with exciter
control (Te) (> 0). Typical value = 0,46.
tf:
slot_uri: cim:ExcDC1A.tf
range: Seconds
required: false
multivalued: false
description: Excitation control system stabilizer time constant (Tf)
(> 0). Typical value = 1.
vrmax:
slot_uri: cim:ExcDC1A.vrmax
range: PU
required: false
multivalued: false
description: Maximum voltage regulator output (Vrmax) (> ExcDC1A.vrmin). Typical
value = 1.
vrmin:
slot_uri: cim:ExcDC1A.vrmin
range: PU
required: false
multivalued: false
description: Minimum voltage regulator output (Vrmin) (< 0 and <
ExcDC1A.vrmax). Typical value = -0,9.
ExcDC2A:
class_uri: cim:ExcDC2A
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: Modified IEEE DC2A direct current commutator exciter with speed input,
one more leg block in feedback loop and without underexcitation limiters (UEL)
inputs. DC type 2 excitation system model with added speed multiplier, added
lead-lag, and voltage-dependent limits.
attributes:
efd1:
slot_uri: cim:ExcDC2A.efd1
range: PU
required: false
multivalued: false
description: Exciter voltage at which exciter saturation is defined (Efd1)
(> 0). Typical value = 3,05.
efd2:
slot_uri: cim:ExcDC2A.efd2
range: PU
required: false
multivalued: false
description: Exciter voltage at which exciter saturation is defined (Efd2)
(> 0). Typical value = 2,29.
exclim:
slot_uri: cim:ExcDC2A.exclim
range: boolean
required: false
multivalued: false
description: "(exclim). IEEE standard is ambiguous about lower limit\
\ on exciter output.\r\ntrue = a lower limit of zero is applied to integrator\
\ output\r\nfalse = a lower limit of zero is not applied to integrator output.\r\
\nTypical value = true."
ka:
slot_uri: cim:ExcDC2A.ka
range: PU
required: false
multivalued: false
description: Voltage regulator gain (Ka) (> 0). Typical value =
300.
ke:
slot_uri: cim:ExcDC2A.ke
range: PU
required: false
multivalued: false
description: Exciter constant related to self-excited field (Ke). If
Ke is entered as zero, the model calculates an effective value of
Ke such that the initial condition value of Vr is zero. The
zero value of Ke is not changed. If Ke is entered as non-zero,
its value is used directly, without change. Typical value = 1.
kf:
slot_uri: cim:ExcDC2A.kf
range: PU
required: false
multivalued: false
description: Excitation control system stabilizer gain (Kf) (>=
0). Typical value = 0,1.
ks:
slot_uri: cim:ExcDC2A.ks
range: PU
required: false
multivalued: false
description: Coefficient to allow different usage of the model-speed coefficient
(Ks). Typical value = 0.
seefd1:
slot_uri: cim:ExcDC2A.seefd1
range: float
required: false
multivalued: false
description: Exciter saturation function value at the corresponding exciter
voltage, Efd1 (Se[Efd1])
(>= 0). Typical value = 0,279.
seefd2:
slot_uri: cim:ExcDC2A.seefd2
range: float
required: false
multivalued: false
description: Exciter saturation function value at the corresponding exciter
voltage, Efd2 (Se[Efd2])
(>= 0). Typical value = 0,117.
ta:
slot_uri: cim:ExcDC2A.ta
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (Ta) (> 0). Typical
value = 0,01.
tb:
slot_uri: cim:ExcDC2A.tb
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (Tb) (>= 0). Typical
value = 0.
tc:
slot_uri: cim:ExcDC2A.tc
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (Tc) (>= 0). Typical
value = 0.
te:
slot_uri: cim:ExcDC2A.te
range: Seconds
required: false
multivalued: false
description: Exciter time constant, integration rate associated with exciter
control (Te) (> 0). Typical value = 1,33.
tf:
slot_uri: cim:ExcDC2A.tf
range: Seconds
required: false
multivalued: false
description: Excitation control system stabilizer time constant (Tf)
(> 0). Typical value = 0,675.
tf1:
slot_uri: cim:ExcDC2A.tf1
range: Seconds
required: false
multivalued: false
description: Excitation control system stabilizer time constant (Tf1)
(>= 0). Typical value = 0.
vrmax:
slot_uri: cim:ExcDC2A.vrmax
range: PU
required: false
multivalued: false
description: Maximum voltage regulator output (Vrmax) (> ExcDC2A.vrmin). Typical
value = 4,95.
vrmin:
slot_uri: cim:ExcDC2A.vrmin
range: PU
required: false
multivalued: false
description: Minimum voltage regulator output (Vrmin) (< 0 and <
ExcDC2A.vrmax). Typical value = -4,9.
vtlim:
slot_uri: cim:ExcDC2A.vtlim
range: boolean
required: false
multivalued: false
description: "(Vtlim).\r\ntrue = limiter at the block (Ka / [1 +\
\ sTa]) is dependent on Vt \r\nfalse = limiter at the block is\
\ not dependent on Vt.\r\nTypical value = true."
ExcDC3A:
class_uri: cim:ExcDC3A
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: Modified IEEE DC3A direct current commutator exciter with speed input,
and deadband. DC old type 4.
attributes:
efd1:
slot_uri: cim:ExcDC3A.efd1
range: PU
required: false
multivalued: false
description: Exciter voltage at which exciter saturation is defined (Efd1)
(> 0). Typical value = 2,6.
efd2:
slot_uri: cim:ExcDC3A.efd2
range: PU
required: false
multivalued: false
description: Exciter voltage at which exciter saturation is defined (Efd2)
(> 0). Typical value = 3,45.
efdlim:
slot_uri: cim:ExcDC3A.efdlim
range: boolean
required: false
multivalued: false
description: "(Efdlim).\r\ntrue = exciter output limiter is active\r\
\nfalse = exciter output limiter not active.\r\nTypical value = true."
efdmax:
slot_uri: cim:ExcDC3A.efdmax
range: PU
required: false
multivalued: false
description: Maximum voltage exciter output limiter (Efdmax) (>
ExcDC3A.efdmin). Typical value = 99.
efdmin:
slot_uri: cim:ExcDC3A.efdmin
range: PU
required: false
multivalued: false
description: Minimum voltage exciter output limiter (Efdmin) (<
ExcDC3A.efdmax). Typical value = -99.
exclim:
slot_uri: cim:ExcDC3A.exclim
range: boolean
required: false
multivalued: false
description: "(exclim). IEEE standard is ambiguous about lower limit\
\ on exciter output.\r\ntrue = a lower limit of zero is applied to integrator\
\ output\r\nfalse = a lower limit of zero not applied to integrator output.\r\
\nTypical value = true."
ke:
slot_uri: cim:ExcDC3A.ke
range: PU
required: false
multivalued: false
description: Exciter constant related to self-excited field (Ke). Typical
value = 1.
kr:
slot_uri: cim:ExcDC3A.kr
range: PU
required: false
multivalued: false
description: Deadband (Kr). Typical value = 0.
ks:
slot_uri: cim:ExcDC3A.ks
range: PU
required: false
multivalued: false
description: Coefficient to allow different usage of the model-speed coefficient
(Ks). Typical value = 0.
kv:
slot_uri: cim:ExcDC3A.kv
range: PU
required: false
multivalued: false
description: Fast raise/lower contact setting (Kv) (> 0). Typical
value = 0,05.
seefd1:
slot_uri: cim:ExcDC3A.seefd1
range: float
required: false
multivalued: false
description: Exciter saturation function value at the corresponding exciter
voltage, Efd1 (Se[Efd1])
(>= 0). Typical value = 0,1.
seefd2:
slot_uri: cim:ExcDC3A.seefd2
range: float
required: false
multivalued: false
description: Exciter saturation function value at the corresponding exciter
voltage, Efd2 (Se[Efd2])
(>= 0). Typical value = 0,35.
te:
slot_uri: cim:ExcDC3A.te
range: Seconds
required: false
multivalued: false
description: Exciter time constant, integration rate associated with exciter
control (Te) (> 0). Typical value = 1,83.
trh:
slot_uri: cim:ExcDC3A.trh
range: Seconds
required: false
multivalued: false
description: Rheostat travel time (Trh) (> 0). Typical value =
20.
vrmax:
slot_uri: cim:ExcDC3A.vrmax
range: PU
required: false
multivalued: false
description: Maximum voltage regulator output (Vrmax) (> 0). Typical
value = 5.
vrmin:
slot_uri: cim:ExcDC3A.vrmin
range: PU
required: false
multivalued: false
description: Minimum voltage regulator output (Vrmin) (<= 0). Typical
value = 0.
ExcDC3A1:
class_uri: cim:ExcDC3A1
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: Modified old IEEE type 3 excitation system.
attributes:
exclim:
slot_uri: cim:ExcDC3A1.exclim
range: boolean
required: false
multivalued: false
description: "(exclim).\r\ntrue = lower limit of zero is applied to\
\ integrator output\r\nfalse = lower limit of zero not applied to integrator\
\ output.\r\nTypical value = true."
ka:
slot_uri: cim:ExcDC3A1.ka
range: PU
required: false
multivalued: false
description: Voltage regulator gain (Ka) (> 0). Typical value =
300.
ke:
slot_uri: cim:ExcDC3A1.ke
range: PU
required: false
multivalued: false
description: Exciter constant related to self-excited field (Ke). Typical
value = 1.
kf:
slot_uri: cim:ExcDC3A1.kf
range: PU
required: false
multivalued: false
description: Excitation control system stabilizer gain (Kf) (>=
0). Typical value = 0,1.
ki:
slot_uri: cim:ExcDC3A1.ki
range: PU
required: false
multivalued: false
description: Potential circuit gain coefficient (Ki) (>= 0). Typical
value = 4,83.
kp:
slot_uri: cim:ExcDC3A1.kp
range: PU
required: false
multivalued: false
description: Potential circuit gain coefficient (Kp) (>= 0). Typical
value = 4,37.
ta:
slot_uri: cim:ExcDC3A1.ta
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (Ta) (> 0). Typical
value = 0,01.
te:
slot_uri: cim:ExcDC3A1.te
range: Seconds
required: false
multivalued: false
description: Exciter time constant, integration rate associated with exciter
control (Te) (> 0). Typical value = 1,83.
tf:
slot_uri: cim:ExcDC3A1.tf
range: Seconds
required: false
multivalued: false
description: Excitation control system stabilizer time constant (Tf)
(>= 0). Typical value = 0,675.
vb1max:
slot_uri: cim:ExcDC3A1.vb1max
range: PU
required: false
multivalued: false
description: Available exciter voltage limiter (Vb1max) (> 0). Typical
value = 11,63.
vblim:
slot_uri: cim:ExcDC3A1.vblim
range: boolean
required: false
multivalued: false
description: "Vb limiter indicator.\r\ntrue = exciter Vbmax limiter\
\ is active\r\nfalse = Vb1max is active. \r\nTypical value = true."
vbmax:
slot_uri: cim:ExcDC3A1.vbmax
range: PU
required: false
multivalued: false
description: Available exciter voltage limiter (Vbmax) (> 0). Typical
value = 11,63.
vrmax:
slot_uri: cim:ExcDC3A1.vrmax
range: PU
required: false
multivalued: false
description: Maximum voltage regulator output (Vrmax) (> ExcDC3A1.vrmin). Typical
value = 5.
vrmin:
slot_uri: cim:ExcDC3A1.vrmin
range: PU
required: false
multivalued: false
description: Minimum voltage regulator output (Vrmin) (< 0 and <
ExcDC3A1.vrmax). Typical value = 0.
ExcELIN1:
class_uri: cim:ExcELIN1
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: Static PI transformer fed excitation system ELIN (VATECH) - simplified
model. This model represents an all-static excitation system. A PI voltage
controller establishes a desired field current set point for a proportional
current controller. The integrator of the PI controller has a follow-up input
to match its signal to the present field current. A power system stabilizer
with power input is included in the model.
attributes:
dpnf:
slot_uri: cim:ExcELIN1.dpnf
range: PU
required: false
multivalued: false
description: Controller follow up deadband (Dpnf). Typical value =
0.
efmax:
slot_uri: cim:ExcELIN1.efmax
range: PU
required: false
multivalued: false
description: Maximum open circuit excitation voltage (Efmax) (>
ExcELIN1.efmin). Typical value = 5.
efmin:
slot_uri: cim:ExcELIN1.efmin
range: PU
required: false
multivalued: false
description: Minimum open circuit excitation voltage (Efmin) (<
ExcELIN1.efmax). Typical value = -5.
ks1:
slot_uri: cim:ExcELIN1.ks1
range: PU
required: false
multivalued: false
description: Stabilizer gain 1 (Ks1). Typical value = 0.
ks2:
slot_uri: cim:ExcELIN1.ks2
range: PU
required: false
multivalued: false
description: Stabilizer gain 2 (Ks2). Typical value = 0.
smax:
slot_uri: cim:ExcELIN1.smax
range: PU
required: false
multivalued: false
description: Stabilizer limit output (smax). Typical value = 0,1.
tfi:
slot_uri: cim:ExcELIN1.tfi
range: Seconds
required: false
multivalued: false
description: Current transducer time constant (Tfi) (>= 0). Typical
value = 0.
tnu:
slot_uri: cim:ExcELIN1.tnu
range: Seconds
required: false
multivalued: false
description: Controller reset time constant (Tnu) (>= 0). Typical
value = 2.
ts1:
slot_uri: cim:ExcELIN1.ts1
range: Seconds
required: false
multivalued: false
description: Stabilizer phase lag time constant (Ts1) (>= 0). Typical
value = 1.
ts2:
slot_uri: cim:ExcELIN1.ts2
range: Seconds
required: false
multivalued: false
description: Stabilizer filter time constant (Ts2) (>= 0). Typical
value = 1.
tsw:
slot_uri: cim:ExcELIN1.tsw
range: Seconds
required: false
multivalued: false
description: Stabilizer parameters (Tsw) (>= 0). Typical value
= 3.
vpi:
slot_uri: cim:ExcELIN1.vpi
range: PU
required: false
multivalued: false
description: Current controller gain (Vpi). Typical value = 12,45.
vpnf:
slot_uri: cim:ExcELIN1.vpnf
range: PU
required: false
multivalued: false
description: Controller follow up gain (Vpnf). Typical value = 2.
vpu:
slot_uri: cim:ExcELIN1.vpu
range: PU
required: false
multivalued: false
description: Voltage controller proportional gain (Vpu). Typical value
= 34,5.
xe:
slot_uri: cim:ExcELIN1.xe
range: PU
required: false
multivalued: false
description: Excitation transformer effective reactance (Xe) (>=
0). Xe represents the regulation of the transformer/rectifier unit. Typical
value = 0,06.
ExcELIN2:
class_uri: cim:ExcELIN2
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: 'Detailed excitation system ELIN (VATECH). This model represents
an all-static excitation system. A PI voltage controller establishes a desired
field current set point for a proportional current controller. The integrator
of the PI controller has a follow-up input to match its signal to the present
field current. Power system stabilizer models used in conjunction with this
excitation system model: PssELIN2, PssIEEE2B, Pss2B.'
attributes:
efdbas:
slot_uri: cim:ExcELIN2.efdbas
range: PU
required: false
multivalued: false
description: Gain (Efdbas). Typical value = 0,1.
iefmax:
slot_uri: cim:ExcELIN2.iefmax
range: PU
required: false
multivalued: false
description: Limiter (Iefmax) (> ExcELIN2.iefmin). Typical
value = 1.
iefmax2:
slot_uri: cim:ExcELIN2.iefmax2
range: PU
required: false
multivalued: false
description: Minimum open circuit excitation voltage (Iefmax2). Typical
value = -5.
iefmin:
slot_uri: cim:ExcELIN2.iefmin
range: PU
required: false
multivalued: false
description: Limiter (Iefmin) (< ExcELIN2.iefmax). Typical
value = 1.
k1:
slot_uri: cim:ExcELIN2.k1
range: PU
required: false
multivalued: false
description: Voltage regulator input gain (K1). Typical value = 0.
k1ec:
slot_uri: cim:ExcELIN2.k1ec
range: PU
required: false
multivalued: false
description: Voltage regulator input limit (K1ec). Typical value =
2.
k2:
slot_uri: cim:ExcELIN2.k2
range: PU
required: false
multivalued: false
description: Gain (K2). Typical value = 5.
k3:
slot_uri: cim:ExcELIN2.k3
range: PU
required: false
multivalued: false
description: Gain (K3). Typical value = 0,1.
k4:
slot_uri: cim:ExcELIN2.k4
range: PU
required: false
multivalued: false
description: Gain (K4). Typical value = 0.
kd1:
slot_uri: cim:ExcELIN2.kd1
range: PU
required: false
multivalued: false
description: Voltage controller derivative gain (Kd1). Typical value
= 34,5.
ke2:
slot_uri: cim:ExcELIN2.ke2
range: PU
required: false
multivalued: false
description: Gain (Ke2). Typical value = 0,1.
ketb:
slot_uri: cim:ExcELIN2.ketb
range: PU
required: false
multivalued: false
description: Gain (Ketb). Typical value = 0,06.
pid1max:
slot_uri: cim:ExcELIN2.pid1max
range: PU
required: false
multivalued: false
description: Controller follow up gain (PID1max). Typical value =
2.
seve1:
slot_uri: cim:ExcELIN2.seve1
range: PU
required: false
multivalued: false
description: Exciter saturation function value at the corresponding exciter
voltage, Ve1, back of commutating reactance (Se[Ve1])
(>= 0). Typical value = 0.
seve2:
slot_uri: cim:ExcELIN2.seve2
range: PU
required: false
multivalued: false
description: Exciter saturation function value at the corresponding exciter
voltage, Ve2, back of commutating reactance (Se[Ve2])
(>= 0). Typical value = 1.
tb1:
slot_uri: cim:ExcELIN2.tb1
range: Seconds
required: false
multivalued: false
description: Voltage controller derivative washout time constant (Tb1)
(>= 0). Typical value = 12,45.
te:
slot_uri: cim:ExcELIN2.te
range: Seconds
required: false
multivalued: false
description: Time constant (Te) (>= 0). Typical value = 0.
te2:
slot_uri: cim:ExcELIN2.te2
range: Seconds
required: false
multivalued: false
description: Time Constant (Te2) (>= 0). Typical
value = 1.
ti1:
slot_uri: cim:ExcELIN2.ti1
range: PU
required: false
multivalued: false
description: Controller follow up deadband (Ti1). Typical value =
0.
ti3:
slot_uri: cim:ExcELIN2.ti3
range: Seconds
required: false
multivalued: false
description: Time constant (Ti3) (>= 0). Typical
value = 3.
ti4:
slot_uri: cim:ExcELIN2.ti4
range: Seconds
required: false
multivalued: false
description: Time constant (Ti4) (>= 0). Typical
value = 0.
tr4:
slot_uri: cim:ExcELIN2.tr4
range: Seconds
required: false
multivalued: false
description: Time constant (Tr4) (>= 0). Typical
value = 1.
upmax:
slot_uri: cim:ExcELIN2.upmax
range: PU
required: false
multivalued: false
description: Limiter (Upmax) (> ExcELIN2.upmin). Typical value
= 3.
upmin:
slot_uri: cim:ExcELIN2.upmin
range: PU
required: false
multivalued: false
description: Limiter (Upmin) (< ExcELIN2.upmax). Typical value
= 0.
ve1:
slot_uri: cim:ExcELIN2.ve1
range: PU
required: false
multivalued: false
description: Exciter alternator output voltages back of commutating reactance
at which saturation is defined (Ve1) (> 0). Typical
value = 3.
ve2:
slot_uri: cim:ExcELIN2.ve2
range: PU
required: false
multivalued: false
description: Exciter alternator output voltages back of commutating reactance
at which saturation is defined (Ve2) (> 0). Typical
value = 0.
xp:
slot_uri: cim:ExcELIN2.xp
range: PU
required: false
multivalued: false
description: Excitation transformer effective reactance (Xp). Typical
value = 1.
ExcHU:
class_uri: cim:ExcHU
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: Hungarian excitation system, with built-in voltage transducer.
attributes:
ae:
slot_uri: cim:ExcHU.ae
range: PU
required: false
multivalued: false
description: Major loop PI tag gain factor (Ae). Typical value = 3.
ai:
slot_uri: cim:ExcHU.ai
range: PU
required: false
multivalued: false
description: Minor loop PI tag gain factor (Ai). Typical value = 22.
atr:
slot_uri: cim:ExcHU.atr
range: PU
required: false
multivalued: false
description: AVR constant (Atr). Typical value = 2,19.
emax:
slot_uri: cim:ExcHU.emax
range: PU
required: false
multivalued: false
description: Field voltage control signal upper limit on AVR base (Emax)
(> ExcHU.emin). Typical value = 0,996.
emin:
slot_uri: cim:ExcHU.emin
range: PU
required: false
multivalued: false
description: Field voltage control signal lower limit on AVR base (Emin)
(< ExcHU.emax). Typical value = -0,866.
imax:
slot_uri: cim:ExcHU.imax
range: PU
required: false
multivalued: false
description: Major loop PI tag output signal upper limit (Imax) (>
ExcHU.imin). Typical value = 2,19.
imin:
slot_uri: cim:ExcHU.imin
range: PU
required: false
multivalued: false
description: Major loop PI tag output signal lower limit (Imin) (<
ExcHU.imax). Typical value = 0,1.
ke:
slot_uri: cim:ExcHU.ke
range: float
required: false
multivalued: false
description: Voltage base conversion constant (Ke). Typical value
= 4,666.
ki:
slot_uri: cim:ExcHU.ki
range: float
required: false
multivalued: false
description: Current base conversion constant (Ki). Typical value
= 0,21428.
te:
slot_uri: cim:ExcHU.te
range: Seconds
required: false
multivalued: false
description: Major loop PI tag integration time constant (Te) (>=
0). Typical value = 0,154.
ti:
slot_uri: cim:ExcHU.ti
range: Seconds
required: false
multivalued: false
description: Minor loop PI control tag integration time constant (Ti)
(>= 0). Typical value = 0,01333.
tr:
slot_uri: cim:ExcHU.tr
range: Seconds
required: false
multivalued: false
description: Filter time constant (Tr) (>= 0). If a voltage compensator
is used in conjunction with this excitation system model, Tr should
be set to 0. Typical value = 0,01.
ExcNI:
class_uri: cim:ExcNI
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: Bus or solid fed SCR (silicon-controlled rectifier) bridge excitation
system model type NI (NVE).
attributes:
busFedSelector:
slot_uri: cim:ExcNI.busFedSelector
range: boolean
required: false
multivalued: false
description: "Fed by selector (BusFedSelector). \r\ntrue = bus fed\
\ (switch is closed)\r\nfalse = solid fed (switch is open).\r\nTypical value\
\ = true."
ka:
slot_uri: cim:ExcNI.ka
range: PU
required: false
multivalued: false
description: Voltage regulator gain (Ka) (> 0). Typical value =
210.
kf:
slot_uri: cim:ExcNI.kf
range: PU
required: false
multivalued: false
description: Excitation control system stabilizer gain (Kf) (> 0). Typical
value 0,01.
r:
slot_uri: cim:ExcNI.r
range: PU
required: false
multivalued: false
description: "rc / rfd (R) (>= 0). \r\n0 means exciter\
\ has negative current capability\r\n> 0 means exciter does not have\
\ negative current capability. \r\nTypical value = 5."
ta:
slot_uri: cim:ExcNI.ta
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (Ta) (> 0). Typical
value = 0,02.
tf1:
slot_uri: cim:ExcNI.tf1
range: Seconds
required: false
multivalued: false
description: Excitation control system stabilizer time constant (Tf1)
(> 0). Typical value = 1,0.
tf2:
slot_uri: cim:ExcNI.tf2
range: Seconds
required: false
multivalued: false
description: Excitation control system stabilizer time constant (Tf2)
(> 0). Typical value = 0,1.
tr:
slot_uri: cim:ExcNI.tr
range: Seconds
required: false
multivalued: false
description: Time constant (Tr) (>= 0). Typical value = 0,02.
vrmax:
slot_uri: cim:ExcNI.vrmax
range: PU
required: false
multivalued: false
description: Maximum voltage regulator ouput (Vrmax) (> ExcNI.vrmin).
Typical value = 5,0.
vrmin:
slot_uri: cim:ExcNI.vrmin
range: PU
required: false
multivalued: false
description: Minimum voltage regulator ouput (Vrmin) (< ExcNI.vrmax).
Typical value = -2,0.
ExcOEX3T:
class_uri: cim:ExcOEX3T
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: Modified IEEE type ST1 excitation system with semi-continuous and
acting terminal voltage limiter.
attributes:
e1:
slot_uri: cim:ExcOEX3T.e1
range: PU
required: false
multivalued: false
description: Saturation parameter (E1).
e2:
slot_uri: cim:ExcOEX3T.e2
range: PU
required: false
multivalued: false
description: Saturation parameter (E2).
ka:
slot_uri: cim:ExcOEX3T.ka
range: PU
required: false
multivalued: false
description: Gain (KA).
kc:
slot_uri: cim:ExcOEX3T.kc
range: PU
required: false
multivalued: false
description: Gain (KC).
kd:
slot_uri: cim:ExcOEX3T.kd
range: PU
required: false
multivalued: false
description: Gain (KD).
ke:
slot_uri: cim:ExcOEX3T.ke
range: PU
required: false
multivalued: false
description: Gain (KE).
kf:
slot_uri: cim:ExcOEX3T.kf
range: PU
required: false
multivalued: false
description: Gain (KF).
see1:
slot_uri: cim:ExcOEX3T.see1
range: PU
required: false
multivalued: false
description: Saturation parameter (SE[E1]).
see2:
slot_uri: cim:ExcOEX3T.see2
range: PU
required: false
multivalued: false
description: Saturation parameter (SE[E2]).
t1:
slot_uri: cim:ExcOEX3T.t1
range: Seconds
required: false
multivalued: false
description: Time constant (T1) (>= 0).
t2:
slot_uri: cim:ExcOEX3T.t2
range: Seconds
required: false
multivalued: false
description: Time constant (T2) (>= 0).
t3:
slot_uri: cim:ExcOEX3T.t3
range: Seconds
required: false
multivalued: false
description: Time constant (T3) (>= 0).
t4:
slot_uri: cim:ExcOEX3T.t4
range: Seconds
required: false
multivalued: false
description: Time constant (T4) (>= 0).
t5:
slot_uri: cim:ExcOEX3T.t5
range: Seconds
required: false
multivalued: false
description: Time constant (T5) (>= 0).
t6:
slot_uri: cim:ExcOEX3T.t6
range: Seconds
required: false
multivalued: false
description: Time constant (T6) (>= 0).
te:
slot_uri: cim:ExcOEX3T.te
range: Seconds
required: false
multivalued: false
description: Time constant (TE) (>= 0).
tf:
slot_uri: cim:ExcOEX3T.tf
range: Seconds
required: false
multivalued: false
description: Time constant (TF) (>= 0).
vrmax:
slot_uri: cim:ExcOEX3T.vrmax
range: PU
required: false
multivalued: false
description: Limiter (VRMAX) (> ExcOEX3T.vrmin).
vrmin:
slot_uri: cim:ExcOEX3T.vrmin
range: PU
required: false
multivalued: false
description: 'Limiter (VRMIN) (< ExcOEX3T.vrmax). '
ExcPIC:
class_uri: cim:ExcPIC
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: 'Proportional/integral regulator excitation system. This model can
be used to represent excitation systems with a proportional-integral (PI) voltage
regulator controller. '
attributes:
e1:
slot_uri: cim:ExcPIC.e1
range: PU
required: false
multivalued: false
description: Field voltage value 1 (E1). Typical
value = 0.
e2:
slot_uri: cim:ExcPIC.e2
range: PU
required: false
multivalued: false
description: Field voltage value 2 (E2). Typical
value = 0.
efdmax:
slot_uri: cim:ExcPIC.efdmax
range: PU
required: false
multivalued: false
description: Exciter maximum limit (Efdmax) (>
ExcPIC.efdmin). Typical value = 8.
efdmin:
slot_uri: cim:ExcPIC.efdmin
range: PU
required: false
multivalued: false
description: Exciter minimum limit (Efdmin) (<
ExcPIC.efdmax). Typical value = -0,87.
ka:
slot_uri: cim:ExcPIC.ka
range: PU
required: false
multivalued: false
description: PI controller gain (Ka). Typical value
= 3,15.
kc:
slot_uri: cim:ExcPIC.kc
range: PU
required: false
multivalued: false
description: Exciter regulation factor (Kc). Typical
value = 0,08.
ke:
slot_uri: cim:ExcPIC.ke
range: PU
required: false
multivalued: false
description: Exciter constant (Ke). Typical value
= 0.
kf:
slot_uri: cim:ExcPIC.kf
range: PU
required: false
multivalued: false
description: Rate feedback gain (Kf). Typical value
= 0.
ki:
slot_uri: cim:ExcPIC.ki
range: PU
required: false
multivalued: false
description: Current source gain (Ki). Typical value
= 0.
kp:
slot_uri: cim:ExcPIC.kp
range: PU
required: false
multivalued: false
description: Potential source gain (Kp). Typical
value = 6,5.
se1:
slot_uri: cim:ExcPIC.se1
range: PU
required: false
multivalued: false
description: Saturation factor at E1 (Se1). Typical
value = 0.
se2:
slot_uri: cim:ExcPIC.se2
range: PU
required: false
multivalued: false
description: Saturation factor at E2 (Se2). Typical
value = 0.
ta1:
slot_uri: cim:ExcPIC.ta1
range: Seconds
required: false
multivalued: false
description: PI controller time constant (Ta1) (>=
0). Typical value = 1.
ta2:
slot_uri: cim:ExcPIC.ta2
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (Ta2)
(>= 0). Typical value = 0,01.
ta3:
slot_uri: cim:ExcPIC.ta3
range: Seconds
required: false
multivalued: false
description: Lead time constant (Ta3) (>= 0). Typical
value = 0.
ta4:
slot_uri: cim:ExcPIC.ta4
range: Seconds
required: false
multivalued: false
description: Lag time constant (Ta4) (>= 0). Typical
value = 0.
te:
slot_uri: cim:ExcPIC.te
range: Seconds
required: false
multivalued: false
description: Exciter time constant (Te) (>= 0). Typical
value = 0.
tf1:
slot_uri: cim:ExcPIC.tf1
range: Seconds
required: false
multivalued: false
description: Rate feedback time constant (Tf1) (>=
0). Typical value = 0.
tf2:
slot_uri: cim:ExcPIC.tf2
range: Seconds
required: false
multivalued: false
description: Rate feedback lag time constant (Tf2)
(>= 0). Typical value = 0.
vr1:
slot_uri: cim:ExcPIC.vr1
range: PU
required: false
multivalued: false
description: PI maximum limit (Vr1). Typical value
= 1.
vr2:
slot_uri: cim:ExcPIC.vr2
range: PU
required: false
multivalued: false
description: PI minimum limit (Vr2). Typical value
= -0,87.
vrmax:
slot_uri: cim:ExcPIC.vrmax
range: PU
required: false
multivalued: false
description: Voltage regulator maximum limit (Vrmax)
(> ExcPIC.vrmin). Typical value = 1.
vrmin:
slot_uri: cim:ExcPIC.vrmin
range: PU
required: false
multivalued: false
description: Voltage regulator minimum limit (Vrmin)
(< ExcPIC.vrmax). Typical value = -0,87.
ExcREXS:
class_uri: cim:ExcREXS
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: 'General purpose rotating excitation system. This model can be used
to represent a wide range of excitation systems whose DC power source is an
AC or DC generator. It encompasses IEEE type AC1, AC2, DC1, and DC2 excitation
system models. '
attributes:
e1:
slot_uri: cim:ExcREXS.e1
range: PU
required: false
multivalued: false
description: Field voltage value 1 (E1). Typical
value = 3.
e2:
slot_uri: cim:ExcREXS.e2
range: PU
required: false
multivalued: false
description: Field voltage value 2 (E2). Typical
value = 4.
fbf:
slot_uri: cim:ExcREXS.fbf
range: ExcREXSFeedbackSignalKind
required: false
multivalued: false
description: Rate feedback signal flag (fbf). Typical value = fieldCurrent.
flimf:
slot_uri: cim:ExcREXS.flimf
range: PU
required: false
multivalued: false
description: Limit type flag (Flimf). Typical value = 0.
kc:
slot_uri: cim:ExcREXS.kc
range: PU
required: false
multivalued: false
description: Rectifier regulation factor (Kc). Typical value = 0,05.
kd:
slot_uri: cim:ExcREXS.kd
range: PU
required: false
multivalued: false
description: Exciter regulation factor (Kd). Typical value = 2.
ke:
slot_uri: cim:ExcREXS.ke
range: PU
required: false
multivalued: false
description: Exciter field proportional constant (Ke). Typical value
= 1.
kefd:
slot_uri: cim:ExcREXS.kefd
range: PU
required: false
multivalued: false
description: Field voltage feedback gain (Kefd). Typical value = 0.
kf:
slot_uri: cim:ExcREXS.kf
range: Seconds
required: false
multivalued: false
description: Rate feedback gain (Kf) (>= 0). Typical value = 0,05.
kh:
slot_uri: cim:ExcREXS.kh
range: PU
required: false
multivalued: false
description: Field voltage controller feedback gain (Kh). Typical
value = 0.
kii:
slot_uri: cim:ExcREXS.kii
range: PU
required: false
multivalued: false
description: Field current regulator integral gain (Kii). Typical
value = 0.
kip:
slot_uri: cim:ExcREXS.kip
range: PU
required: false
multivalued: false
description: Field current regulator proportional gain (Kip). Typical
value = 1.
ks:
slot_uri: cim:ExcREXS.ks
range: PU
required: false
multivalued: false
description: Coefficient to allow different usage of the model-speed coefficient
(Ks). Typical value = 0.
kvi:
slot_uri: cim:ExcREXS.kvi
range: PU
required: false
multivalued: false
description: Voltage regulator integral gain (Kvi). Typical value
= 0.
kvp:
slot_uri: cim:ExcREXS.kvp
range: PU
required: false
multivalued: false
description: Voltage regulator proportional gain (Kvp). Typical value
= 2800.
kvphz:
slot_uri: cim:ExcREXS.kvphz
range: PU
required: false
multivalued: false
description: V/Hz limiter gain (Kvphz). Typical value = 0.
nvphz:
slot_uri: cim:ExcREXS.nvphz
range: PU
required: false
multivalued: false
description: Pickup speed of V/Hz limiter (Nvphz). Typical value =
0.
se1:
slot_uri: cim:ExcREXS.se1
range: PU
required: false
multivalued: false
description: Saturation factor at E1 (Se1). Typical
value = 0,0001.
se2:
slot_uri: cim:ExcREXS.se2
range: PU
required: false
multivalued: false
description: Saturation factor at E2 (Se2). Typical
value = 0,001.
ta:
slot_uri: cim:ExcREXS.ta
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (Ta) (>= 0). If =
0, block is bypassed. Typical value = 0,01.
tb1:
slot_uri: cim:ExcREXS.tb1
range: Seconds
required: false
multivalued: false
description: Lag time constant (Tb1) (>= 0). If = 0, block is bypassed. Typical
value = 0.
tb2:
slot_uri: cim:ExcREXS.tb2
range: Seconds
required: false
multivalued: false
description: Lag time constant (Tb2) (>= 0). If = 0, block is bypassed. Typical
value = 0.
tc1:
slot_uri: cim:ExcREXS.tc1
range: Seconds
required: false
multivalued: false
description: Lead time constant (Tc1) (>= 0). Typical value = 0.
tc2:
slot_uri: cim:ExcREXS.tc2
range: Seconds
required: false
multivalued: false
description: Lead time constant (Tc2) (>= 0). Typical value = 0.
te:
slot_uri: cim:ExcREXS.te
range: Seconds
required: false
multivalued: false
description: Exciter field time constant (Te) (> 0). Typical value
= 1,2.
tf:
slot_uri: cim:ExcREXS.tf
range: Seconds
required: false
multivalued: false
description: Rate feedback time constant (Tf) (>= 0). If = 0, the
feedback path is not used. Typical value = 1.
tf1:
slot_uri: cim:ExcREXS.tf1
range: Seconds
required: false
multivalued: false
description: Feedback lead time constant (Tf1) (>= 0). Typical
value = 0.
tf2:
slot_uri: cim:ExcREXS.tf2
range: Seconds
required: false
multivalued: false
description: Feedback lag time constant (Tf2) (>= 0). If = 0, block
is bypassed. Typical value = 0.
tp:
slot_uri: cim:ExcREXS.tp
range: Seconds
required: false
multivalued: false
description: Field current bridge time constant (Tp) (>= 0). Typical
value = 0.
vcmax:
slot_uri: cim:ExcREXS.vcmax
range: PU
required: false
multivalued: false
description: Maximum compounding voltage (Vcmax). Typical value =
0.
vfmax:
slot_uri: cim:ExcREXS.vfmax
range: PU
required: false
multivalued: false
description: Maximum exciter field current (Vfmax) (> ExcREXS.vfmin). Typical
value = 47.
vfmin:
slot_uri: cim:ExcREXS.vfmin
range: PU
required: false
multivalued: false
description: Minimum exciter field current (Vfmin) (< ExcREXS.vfmax). Typical
value = -20.
vimax:
slot_uri: cim:ExcREXS.vimax
range: PU
required: false
multivalued: false
description: Voltage regulator input limit (Vimax). Typical value
= 0,1.
vrmax:
slot_uri: cim:ExcREXS.vrmax
range: PU
required: false
multivalued: false
description: Maximum controller output (Vrmax) (> ExcREXS.vrmin). Typical
value = 47.
vrmin:
slot_uri: cim:ExcREXS.vrmin
range: PU
required: false
multivalued: false
description: Minimum controller output (Vrmin) (< ExcREXS.vrmax). Typical
value = -20.
xc:
slot_uri: cim:ExcREXS.xc
range: PU
required: false
multivalued: false
description: Exciter compounding reactance (Xc). Typical value = 0.
ExcRQB:
class_uri: cim:ExcRQB
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: 'Excitation system type RQB (four-loop regulator, r?gulateur quatre
boucles, developed in France) primarily used in nuclear or thermal generating
units. This excitation system shall be always used together with power system
stabilizer type PssRQB. '
attributes:
ki0:
slot_uri: cim:ExcRQB.ki0
range: float
required: false
multivalued: false
description: Voltage reference input gain (Ki0). Typical value = 12,7.
ki1:
slot_uri: cim:ExcRQB.ki1
range: float
required: false
multivalued: false
description: Voltage input gain (Ki1). Typical value = -16,8.
klir:
slot_uri: cim:ExcRQB.klir
range: float
required: false
multivalued: false
description: OEL input gain (KLIR). Typical value = 12,13.
klus:
slot_uri: cim:ExcRQB.klus
range: float
required: false
multivalued: false
description: Limiter gain (KLUS). Typical value = 50.
lsat:
slot_uri: cim:ExcRQB.lsat
range: PU
required: false
multivalued: false
description: Integrator limiter (LSAT). Typical value = 5,73.
lus:
slot_uri: cim:ExcRQB.lus
range: PU
required: false
multivalued: false
description: Setpoint (LUS). Typical value = 0,12.
mesu:
slot_uri: cim:ExcRQB.mesu
range: Seconds
required: false
multivalued: false
description: Voltage input time constant (MESU) (>= 0). Typical
value = 0,02.
t4m:
slot_uri: cim:ExcRQB.t4m
range: Seconds
required: false
multivalued: false
description: Input time constant (T4M) (>= 0). Typical value =
5.
tc:
slot_uri: cim:ExcRQB.tc
range: Seconds
required: false
multivalued: false
description: Lead lag time constant (TC) (>= 0). Typical value
= 0,02.
te:
slot_uri: cim:ExcRQB.te
range: Seconds
required: false
multivalued: false
description: Lead lag time constant (TE) (>= 0). Typical value
= 0,22.
tf:
slot_uri: cim:ExcRQB.tf
range: Seconds
required: false
multivalued: false
description: Exciter time constant (TF) (>= 0). Typical value =
0,01.
ucmax:
slot_uri: cim:ExcRQB.ucmax
range: PU
required: false
multivalued: false
description: Maximum voltage reference limit (UCMAX) (> ExcRQB.ucmin). Typical
value = 1,1.
ucmin:
slot_uri: cim:ExcRQB.ucmin
range: PU
required: false
multivalued: false
description: Minimum voltage reference limit (UCMIN) (< ExcRQB.ucmax). Typical
value = 0,9.
ExcSCRX:
class_uri: cim:ExcSCRX
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: Simple excitation system with generic characteristics typical of
many excitation systems; intended for use where negative field current could
be a problem.
attributes:
cswitch:
slot_uri: cim:ExcSCRX.cswitch
range: boolean
required: false
multivalued: false
description: "Power source switch (Cswitch).\r\ntrue = fixed voltage\
\ of 1.0 PU\r\nfalse = generator terminal voltage."
emax:
slot_uri: cim:ExcSCRX.emax
range: PU
required: false
multivalued: false
description: Maximum field voltage output (Emax) (> ExcSCRX.emin). Typical
value = 5.
emin:
slot_uri: cim:ExcSCRX.emin
range: PU
required: false
multivalued: false
description: Minimum field voltage output (Emin) (< ExcSCRX.emax). Typical
value = 0.
k:
slot_uri: cim:ExcSCRX.k
range: PU
required: false
multivalued: false
description: Gain (K) (> 0). Typical value = 200.
rcrfd:
slot_uri: cim:ExcSCRX.rcrfd
range: float
required: false
multivalued: false
description: Ratio of field discharge resistance to field winding resistance
([rc / rfd]). Typical value = 0.
tatb:
slot_uri: cim:ExcSCRX.tatb
range: float
required: false
multivalued: false
description: Gain reduction ratio of lag-lead element ([Ta / Tb]).
The parameter Ta is not defined explicitly. Typical value = 0.1.
tb:
slot_uri: cim:ExcSCRX.tb
range: Seconds
required: false
multivalued: false
description: Denominator time constant of lag-lead block (Tb) (>=
0). Typical value = 10.
te:
slot_uri: cim:ExcSCRX.te
range: Seconds
required: false
multivalued: false
description: Time constant of gain block (Te) (> 0). Typical value
= 0,02.
ExcSEXS:
class_uri: cim:ExcSEXS
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: Simplified excitation system.
attributes:
efdmax:
slot_uri: cim:ExcSEXS.efdmax
range: PU
required: false
multivalued: false
description: Field voltage clipping maximum limit (Efdmax) (> ExcSEXS.efdmin). Typical
value = 5.
efdmin:
slot_uri: cim:ExcSEXS.efdmin
range: PU
required: false
multivalued: false
description: Field voltage clipping minimum limit (Efdmin) (< ExcSEXS.efdmax). Typical
value = -5.
emax:
slot_uri: cim:ExcSEXS.emax
range: PU
required: false
multivalued: false
description: Maximum field voltage output (Emax) (> ExcSEXS.emin). Typical
value = 5.
emin:
slot_uri: cim:ExcSEXS.emin
range: PU
required: false
multivalued: false
description: Minimum field voltage output (Emin) (< ExcSEXS.emax). Typical
value = -5.
k:
slot_uri: cim:ExcSEXS.k
range: PU
required: false
multivalued: false
description: Gain (K) (> 0). Typical value = 100.
kc:
slot_uri: cim:ExcSEXS.kc
range: PU
required: false
multivalued: false
description: PI controller gain (Kc) (> 0 if ExcSEXS.tc > 0). Typical
value = 0,08.
tatb:
slot_uri: cim:ExcSEXS.tatb
range: float
required: false
multivalued: false
description: Gain reduction ratio of lag-lead element ([Ta / Tb]). Typical
value = 0,1.
tb:
slot_uri: cim:ExcSEXS.tb
range: Seconds
required: false
multivalued: false
description: Denominator time constant of lag-lead block (Tb) (>=
0). Typical value = 10.
tc:
slot_uri: cim:ExcSEXS.tc
range: Seconds
required: false
multivalued: false
description: PI controller phase lead time constant (Tc) (>= 0). Typical
value = 0.
te:
slot_uri: cim:ExcSEXS.te
range: Seconds
required: false
multivalued: false
description: Time constant of gain block (Te) (> 0). Typical value
= 0,05.
ExcSK:
class_uri: cim:ExcSK
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: Slovakian excitation system. UEL and secondary voltage control are
included in this model. When this model is used, there cannot be a separate
underexcitation limiter or VAr controller model.
attributes:
efdmax:
slot_uri: cim:ExcSK.efdmax
range: PU
required: false
multivalued: false
description: Field voltage clipping upper level limit (Efdmax) (>
ExcSK.efdmin).
efdmin:
slot_uri: cim:ExcSK.efdmin
range: PU
required: false
multivalued: false
description: Field voltage clipping lower level limit (Efdmin) (<
ExcSK.efdmax).
emax:
slot_uri: cim:ExcSK.emax
range: PU
required: false
multivalued: false
description: Maximum field voltage output (Emax) (> ExcSK.emin). Typical
value = 20.
emin:
slot_uri: cim:ExcSK.emin
range: PU
required: false
multivalued: false
description: Minimum field voltage output (Emin) (< ExcSK.emax). Typical
value = -20.
k:
slot_uri: cim:ExcSK.k
range: PU
required: false
multivalued: false
description: Gain (K). Typical value = 1.
k1:
slot_uri: cim:ExcSK.k1
range: PU
required: false
multivalued: false
description: Parameter of underexcitation limit (K1). Typical value
= 0,1364.
k2:
slot_uri: cim:ExcSK.k2
range: PU
required: false
multivalued: false
description: Parameter of underexcitation limit (K2). Typical value
= -0,3861.
kc:
slot_uri: cim:ExcSK.kc
range: PU
required: false
multivalued: false
description: PI controller gain (Kc). Typical value = 70.
kce:
slot_uri: cim:ExcSK.kce
range: PU
required: false
multivalued: false
description: Rectifier regulation factor (Kce). Typical value = 0.
kd:
slot_uri: cim:ExcSK.kd
range: PU
required: false
multivalued: false
description: Exciter internal reactance (Kd). Typical value = 0.
kgob:
slot_uri: cim:ExcSK.kgob
range: PU
required: false
multivalued: false
description: P controller gain (Kgob). Typical value = 10.
kp:
slot_uri: cim:ExcSK.kp
range: PU
required: false
multivalued: false
description: PI controller gain (Kp). Typical value = 1.
kqi:
slot_uri: cim:ExcSK.kqi
range: PU
required: false
multivalued: false
description: PI controller gain of integral component (Kqi). Typical
value = 0.
kqob:
slot_uri: cim:ExcSK.kqob
range: PU
required: false
multivalued: false
description: 'Rate of rise of the reactive power (Kqob). '
kqp:
slot_uri: cim:ExcSK.kqp
range: PU
required: false
multivalued: false
description: PI controller gain (Kqp). Typical value = 0.
nq:
slot_uri: cim:ExcSK.nq
range: PU
required: false
multivalued: false
description: Deadband of reactive power (nq). Determines the range
of sensitivity. Typical value = 0,001.
qconoff:
slot_uri: cim:ExcSK.qconoff
range: boolean
required: false
multivalued: false
description: "Secondary voltage control state (Qc_on_off).\r\ntrue\
\ = secondary voltage control is on\r\nfalse = secondary voltage control\
\ is off.\r\nTypical value = false."
qz:
slot_uri: cim:ExcSK.qz
range: PU
required: false
multivalued: false
description: 'Desired value (setpoint) of reactive power, manual setting (Qz). '
remote:
slot_uri: cim:ExcSK.remote
range: boolean
required: false
multivalued: false
description: "Selector to apply automatic calculation in secondary controller\
\ model (remote).\r\ntrue = automatic calculation is activated\r\n\
false = manual set is active; the use of desired value of reactive power\
\ (Qz) is required.\r\nTypical value = true."
sbase:
slot_uri: cim:ExcSK.sbase
range: ApparentPower
required: false
multivalued: false
description: Apparent power of the unit (Sbase) (> 0). Unit = MVA. Typical
value = 259.
tc:
slot_uri: cim:ExcSK.tc
range: Seconds
required: false
multivalued: false
description: PI controller phase lead time constant (Tc) (>= 0). Typical
value = 8.
te:
slot_uri: cim:ExcSK.te
range: Seconds
required: false
multivalued: false
description: Time constant of gain block (Te) (>= 0). Typical value
= 0,1.
ti:
slot_uri: cim:ExcSK.ti
range: Seconds
required: false
multivalued: false
description: PI controller phase lead time constant (Ti) (>= 0). Typical
value = 2.
tp:
slot_uri: cim:ExcSK.tp
range: Seconds
required: false
multivalued: false
description: Time constant (Tp) (>= 0). Typical value = 0,1.
tr:
slot_uri: cim:ExcSK.tr
range: Seconds
required: false
multivalued: false
description: Voltage transducer time constant (Tr) (>= 0). Typical
value = 0,01.
uimax:
slot_uri: cim:ExcSK.uimax
range: PU
required: false
multivalued: false
description: Maximum error (UImax) (> ExcSK.uimin). Typical value
= 10.
uimin:
slot_uri: cim:ExcSK.uimin
range: PU
required: false
multivalued: false
description: Minimum error (UImin) (< ExcSK.uimax). Typical value
= -10.
urmax:
slot_uri: cim:ExcSK.urmax
range: PU
required: false
multivalued: false
description: Maximum controller output (URmax) (> ExcSK.urmin). Typical
value = 10.
urmin:
slot_uri: cim:ExcSK.urmin
range: PU
required: false
multivalued: false
description: Minimum controller output (URmin) (< ExcSK.urmax). Typical
value = -10.
vtmax:
slot_uri: cim:ExcSK.vtmax
range: PU
required: false
multivalued: false
description: Maximum terminal voltage input (Vtmax) (> ExcSK.vtmin). Determines
the range of voltage deadband. Typical value = 1,05.
vtmin:
slot_uri: cim:ExcSK.vtmin
range: PU
required: false
multivalued: false
description: Minimum terminal voltage input (Vtmin) (< ExcSK.vtmax). Determines
the range of voltage deadband. Typical value = 0,95.
yp:
slot_uri: cim:ExcSK.yp
range: PU
required: false
multivalued: false
description: Maximum output (Yp). Typical value = 1.
ExcST1A:
class_uri: cim:ExcST1A
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: Modification of an old IEEE ST1A static excitation system without
overexcitation limiter (OEL) and underexcitation limiter (UEL).
attributes:
ilr:
slot_uri: cim:ExcST1A.ilr
range: PU
required: false
multivalued: false
description: Exciter output current limit reference (Ilr). Typical
value = 0.
ka:
slot_uri: cim:ExcST1A.ka
range: PU
required: false
multivalued: false
description: Voltage regulator gain (Ka) (> 0). Typical value =
190.
kc:
slot_uri: cim:ExcST1A.kc
range: PU
required: false
multivalued: false
description: Rectifier loading factor proportional to commutating reactance
(Kc) (>= 0). Typical value = 0,05.
kf:
slot_uri: cim:ExcST1A.kf
range: PU
required: false
multivalued: false
description: Excitation control system stabilizer gains (Kf) (>=
0). Typical value = 0.
klr:
slot_uri: cim:ExcST1A.klr
range: PU
required: false
multivalued: false
description: Exciter output current limiter gain (Klr). Typical value
= 0.
ta:
slot_uri: cim:ExcST1A.ta
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (Ta) (>= 0). Typical
value = 0,02.
tb:
slot_uri: cim:ExcST1A.tb
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (Tb) (>= 0). Typical
value = 10.
tb1:
slot_uri: cim:ExcST1A.tb1
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (Tb1) (>= 0). Typical
value = 0.
tc:
slot_uri: cim:ExcST1A.tc
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (Tc) (>= 0). Typical
value = 1.
tc1:
slot_uri: cim:ExcST1A.tc1
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (Tc1) (>= 0). Typical
value = 0.
tf:
slot_uri: cim:ExcST1A.tf
range: Seconds
required: false
multivalued: false
description: Excitation control system stabilizer time constant (Tf)
(>= 0). Typical value = 1.
vamax:
slot_uri: cim:ExcST1A.vamax
range: PU
required: false
multivalued: false
description: Maximum voltage regulator output (Vamax) (> 0). Typical
value = 999.
vamin:
slot_uri: cim:ExcST1A.vamin
range: PU
required: false
multivalued: false
description: Minimum voltage regulator output (Vamin) (< 0). Typical
value = -999.
vimax:
slot_uri: cim:ExcST1A.vimax
range: PU
required: false
multivalued: false
description: Maximum voltage regulator input limit (Vimax) (> 0). Typical
value = 999.
vimin:
slot_uri: cim:ExcST1A.vimin
range: PU
required: false
multivalued: false
description: Minimum voltage regulator input limit (Vimin) (< 0). Typical
value = -999.
vrmax:
slot_uri: cim:ExcST1A.vrmax
range: PU
required: false
multivalued: false
description: Maximum voltage regulator outputs (Vrmax) (> 0) . Typical
value = 7,8.
vrmin:
slot_uri: cim:ExcST1A.vrmin
range: PU
required: false
multivalued: false
description: Minimum voltage regulator outputs (Vrmin) (< 0). Typical
value = -6,7.
xe:
slot_uri: cim:ExcST1A.xe
range: PU
required: false
multivalued: false
description: Excitation xfmr effective reactance (Xe). Typical value
= 0,04.
ExcST2A:
class_uri: cim:ExcST2A
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: Modified IEEE ST2A static excitation system with another lead-lag
block added to match the model defined by WECC.
attributes:
efdmax:
slot_uri: cim:ExcST2A.efdmax
range: PU
required: false
multivalued: false
description: Maximum field voltage (Efdmax) (>= 0). Typical value
= 99.
ka:
slot_uri: cim:ExcST2A.ka
range: PU
required: false
multivalued: false
description: Voltage regulator gain (Ka) (> 0). Typical value =
120.
kc:
slot_uri: cim:ExcST2A.kc
range: PU
required: false
multivalued: false
description: Rectifier loading factor proportional to commutating reactance
(Kc) (>= 0). Typical value = 1,82.
ke:
slot_uri: cim:ExcST2A.ke
range: PU
required: false
multivalued: false
description: Exciter constant related to self-excited field (Ke). Typical
value = 1.
kf:
slot_uri: cim:ExcST2A.kf
range: PU
required: false
multivalued: false
description: Excitation control system stabilizer gains (kf) (>=
0). Typical value = 0,05.
ki:
slot_uri: cim:ExcST2A.ki
range: PU
required: false
multivalued: false
description: Potential circuit gain coefficient (Ki)
(>= 0). Typical value = 8.
kp:
slot_uri: cim:ExcST2A.kp
range: PU
required: false
multivalued: false
description: Potential circuit gain coefficient (Kp)
(>= 0). Typical value = 4,88.
ta:
slot_uri: cim:ExcST2A.ta
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (Ta) (> 0). Typical
value = 0,15.
tb:
slot_uri: cim:ExcST2A.tb
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (Tb) (>= 0). Typical
value = 0.
tc:
slot_uri: cim:ExcST2A.tc
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (Tc) (>= 0). Typical
value = 0.
te:
slot_uri: cim:ExcST2A.te
range: Seconds
required: false
multivalued: false
description: Exciter time constant, integration rate associated with exciter
control (Te) (> 0). Typical value = 0,5.
tf:
slot_uri: cim:ExcST2A.tf
range: Seconds
required: false
multivalued: false
description: Excitation control system stabilizer time constant (Tf)
(>= 0). Typical value = 0,7.
uelin:
slot_uri: cim:ExcST2A.uelin
range: boolean
required: false
multivalued: false
description: "UEL input (UELin).\r\ntrue = HV gate\r\nfalse = add to\
\ error signal.\r\nTypical value = false."
vrmax:
slot_uri: cim:ExcST2A.vrmax
range: PU
required: false
multivalued: false
description: Maximum voltage regulator outputs (Vrmax) (> 0). Typical
value = 1.
vrmin:
slot_uri: cim:ExcST2A.vrmin
range: PU
required: false
multivalued: false
description: Minimum voltage regulator outputs (Vrmin) (< 0). Typical
value = -1.
ExcST3A:
class_uri: cim:ExcST3A
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: Modified IEEE ST3A static excitation system with added speed multiplier.
attributes:
efdmax:
slot_uri: cim:ExcST3A.efdmax
range: PU
required: false
multivalued: false
description: Maximum AVR output (Efdmax) (>= 0). Typical value
= 6,9.
kc:
slot_uri: cim:ExcST3A.kc
range: PU
required: false
multivalued: false
description: Rectifier loading factor proportional to commutating reactance
(Kc) (>= 0). Typical value = 1,1.
kg:
slot_uri: cim:ExcST3A.kg
range: PU
required: false
multivalued: false
description: Feedback gain constant of the inner loop field regulator (Kg)
(>= 0). Typical value = 1.
ki:
slot_uri: cim:ExcST3A.ki
range: PU
required: false
multivalued: false
description: Potential circuit gain coefficient (Ki)
(>= 0). Typical value = 4,83.
kj:
slot_uri: cim:ExcST3A.kj
range: PU
required: false
multivalued: false
description: AVR gain (Kj) (> 0). Typical value = 200.
km:
slot_uri: cim:ExcST3A.km
range: PU
required: false
multivalued: false
description: Forward gain constant of the inner loop field regulator (Km)
(> 0). Typical value = 7,04.
kp:
slot_uri: cim:ExcST3A.kp
range: PU
required: false
multivalued: false
description: Potential source gain (Kp) (> 0). Typical
value = 4,37.
ks:
slot_uri: cim:ExcST3A.ks
range: PU
required: false
multivalued: false
description: Coefficient to allow different usage of the model-speed coefficient
(Ks). Typical value = 0.
ks1:
slot_uri: cim:ExcST3A.ks1
range: PU
required: false
multivalued: false
description: Coefficient to allow different usage of the model-speed coefficient
(Ks1). Typical value = 0.
tb:
slot_uri: cim:ExcST3A.tb
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (Tb) (>= 0). Typical
value = 6,67.
tc:
slot_uri: cim:ExcST3A.tc
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (Tc) (>= 0). Typical
value = 1.
thetap:
slot_uri: cim:ExcST3A.thetap
range: AngleDegrees
required: false
multivalued: false
description: Potential circuit phase angle (thetap). Typical
value = 20.
tm:
slot_uri: cim:ExcST3A.tm
range: Seconds
required: false
multivalued: false
description: Forward time constant of inner loop field regulator (Tm)
(> 0). Typical value = 1.
vbmax:
slot_uri: cim:ExcST3A.vbmax
range: PU
required: false
multivalued: false
description: Maximum excitation voltage (Vbmax) (> 0). Typical
value = 8,63.
vgmax:
slot_uri: cim:ExcST3A.vgmax
range: PU
required: false
multivalued: false
description: Maximum inner loop feedback voltage (Vgmax) (>= 0). Typical
value = 6,53.
vimax:
slot_uri: cim:ExcST3A.vimax
range: PU
required: false
multivalued: false
description: Maximum voltage regulator input limit (Vimax) (> 0). Typical
value = 0,2.
vimin:
slot_uri: cim:ExcST3A.vimin
range: PU
required: false
multivalued: false
description: Minimum voltage regulator input limit (Vimin) (< 0). Typical
value = -0,2.
vrmax:
slot_uri: cim:ExcST3A.vrmax
range: PU
required: false
multivalued: false
description: Maximum voltage regulator output (Vrmax) (> 0). Typical
value = 1.
vrmin:
slot_uri: cim:ExcST3A.vrmin
range: PU
required: false
multivalued: false
description: Minimum voltage regulator output (Vrmin) (< 0). Typical
value = -1.
xl:
slot_uri: cim:ExcST3A.xl
range: PU
required: false
multivalued: false
description: Reactance associated with potential source (Xl) (>=
0). Typical value = 0,09.
ExcST4B:
class_uri: cim:ExcST4B
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: Modified IEEE ST4B static excitation system with maximum inner loop
feedback gain Vgmax.
attributes:
kc:
slot_uri: cim:ExcST4B.kc
range: PU
required: false
multivalued: false
description: Rectifier loading factor proportional to commutating reactance
(Kc) (>= 0). Typical value = 0,113.
kg:
slot_uri: cim:ExcST4B.kg
range: PU
required: false
multivalued: false
description: Feedback gain constant of the inner loop field regulator (Kg)
(>= 0). Typical value = 0.
ki:
slot_uri: cim:ExcST4B.ki
range: PU
required: false
multivalued: false
description: Potential circuit gain coefficient (Ki) (>= 0). Typical
value = 0.
kim:
slot_uri: cim:ExcST4B.kim
range: PU
required: false
multivalued: false
description: Voltage regulator integral gain output (Kim). Typical
value = 0.
kir:
slot_uri: cim:ExcST4B.kir
range: PU
required: false
multivalued: false
description: Voltage regulator integral gain (Kir). Typical value
= 10,75.
kp:
slot_uri: cim:ExcST4B.kp
range: PU
required: false
multivalued: false
description: Potential circuit gain coefficient (Kp) (> 0). Typical
value = 9,3.
kpm:
slot_uri: cim:ExcST4B.kpm
range: PU
required: false
multivalued: false
description: Voltage regulator proportional gain output (Kpm). Typical
value = 1.
kpr:
slot_uri: cim:ExcST4B.kpr
range: PU
required: false
multivalued: false
description: Voltage regulator proportional gain (Kpr). Typical value
= 10,75.
lvgate:
slot_uri: cim:ExcST4B.lvgate
range: boolean
required: false
multivalued: false
description: "Selector (LVGate).\r\ntrue = LVGate is part of\
\ the block diagram\r\nfalse = LVGate is not part of the block diagram.\
\ \r\nTypical value = false."
ta:
slot_uri: cim:ExcST4B.ta
range: Seconds
required: false
multivalued: false
description: Voltage regulator time constant (Ta) (>= 0). Typical
value = 0,02.
thetap:
slot_uri: cim:ExcST4B.thetap
range: AngleDegrees
required: false
multivalued: false
description: Potential circuit phase angle (thetap). Typical
value = 0.
uel:
slot_uri: cim:ExcST4B.uel
range: boolean
required: false
multivalued: false
description: "Selector (UEL).\r\ntrue = UEL is part of block\
\ diagram\r\nfalse = UEL is not part of block diagram. \r\nTypical\
\ value = false."
vbmax:
slot_uri: cim:ExcST4B.vbmax
range: PU
required: false
multivalued: false
description: Maximum excitation voltage (Vbmax) (> 0). Typical
value = 11,63.
vgmax:
slot_uri: cim:ExcST4B.vgmax
range: PU
required: false
multivalued: false
description: Maximum inner loop feedback voltage (Vgmax) (>= 0). Typical
value = 5,8.
vmmax:
slot_uri: cim:ExcST4B.vmmax
range: PU
required: false
multivalued: false
description: Maximum inner loop output (Vmmax) (> ExcST4B.vmmin). Typical
value = 99.
vmmin:
slot_uri: cim:ExcST4B.vmmin
range: PU
required: false
multivalued: false
description: Minimum inner loop output (Vmmin) (< ExcST4B.vmmax). Typical
value = -99.
vrmax:
slot_uri: cim:ExcST4B.vrmax
range: PU
required: false
multivalued: false
description: Maximum voltage regulator output (Vrmax) (> 0). Typical
value = 1.
vrmin:
slot_uri: cim:ExcST4B.vrmin
range: PU
required: false
multivalued: false
description: Minimum voltage regulator output (Vrmin) (< 0). Typical
value = -0,87.
xl:
slot_uri: cim:ExcST4B.xl
range: PU
required: false
multivalued: false
description: Reactance associated with potential source (Xl) (>=
0). Typical value = 0,124.
ExcST6B:
class_uri: cim:ExcST6B
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: Modified IEEE ST6B static excitation system with PID controller and
optional inner feedback loop.
attributes:
ilr:
slot_uri: cim:ExcST6B.ilr
range: PU
required: false
multivalued: false
description: Exciter output current limit reference (Ilr) (> 0). Typical
value = 4,164.
k1:
slot_uri: cim:ExcST6B.k1
range: boolean
required: false
multivalued: false
description: "Selector (K1).\r\ntrue = feedback is from Ifd\r\
\nfalse = feedback is not from Ifd.\r\nTypical value = true."
kcl:
slot_uri: cim:ExcST6B.kcl
range: PU
required: false
multivalued: false
description: Exciter output current limit adjustment (Kcl) (> 0). Typical
value = 1,0577.
kff:
slot_uri: cim:ExcST6B.kff
range: PU
required: false
multivalued: false
description: Pre-control gain constant of the inner loop field regulator (Kff). Typical
value = 1.
kg:
slot_uri: cim:ExcST6B.kg
range: PU
required: false
multivalued: false
description: Feedback gain constant of the inner loop field regulator (Kg)
(>= 0). Typical value = 1.
kia:
slot_uri: cim:ExcST6B.kia
range: PU
required: false
multivalued: false
description: Voltage regulator integral gain (Kia) (> 0). Typical
value = 45,094.
klr:
slot_uri: cim:ExcST6B.klr
range: PU
required: false
multivalued: false
description: Exciter output current limit adjustment (Kcl) (> 0). Typical
value = 17,33.
km:
slot_uri: cim:ExcST6B.km
range: PU
required: false
multivalued: false
description: Forward gain constant of the inner loop field regulator (Km). Typical
value = 1.
kpa:
slot_uri: cim:ExcST6B.kpa
range: PU
required: false
multivalued: false
description: Voltage regulator proportional gain (Kpa) (> 0). Typical
value = 18,038.
kvd:
slot_uri: cim:ExcST6B.kvd
range: PU
required: false
multivalued: false
description: Voltage regulator derivative gain (Kvd). Typical value
= 0.
oelin:
slot_uri: cim:ExcST6B.oelin
range: ExcST6BOELselectorKind
required: false
multivalued: false
description: OEL input selector (OELin). Typical value = noOELinput
(corresponds to OELin = 0 on diagram).
tg:
slot_uri: cim:ExcST6B.tg
range: Seconds
required: false
multivalued: false
description: Feedback time constant of inner loop field voltage regulator
(Tg) (>= 0). Typical value = 0,02.
ts:
slot_uri: cim:ExcST6B.ts
range: Seconds
required: false
multivalued: false
description: Rectifier firing time constant (Ts) (>= 0). Typical
value = 0.
tvd:
slot_uri: cim:ExcST6B.tvd
range: Seconds
required: false
multivalued: false
description: Voltage regulator derivative gain (Tvd) (>= 0). Typical
value = 0.
vamax:
slot_uri: cim:ExcST6B.vamax
range: PU
required: false
multivalued: false
description: Maximum voltage regulator output (Vamax) (> 0). Typical
value = 4,81.
vamin:
slot_uri: cim:ExcST6B.vamin
range: PU
required: false
multivalued: false
description: Minimum voltage regulator output (Vamin) (< 0). Typical
value = -3,85.
vilim:
slot_uri: cim:ExcST6B.vilim
range: boolean
required: false
multivalued: false
description: "Selector (Vilim).\r\ntrue = Vimin-Vimax\
\ limiter is active\r\nfalse = Vimin-Vimax limiter is not\
\ active.\r\nTypical value = true."
vimax:
slot_uri: cim:ExcST6B.vimax
range: PU
required: false
multivalued: false
description: Maximum voltage regulator input limit (Vimax) (> ExcST6B.vimin). Typical
value = 10.
vimin:
slot_uri: cim:ExcST6B.vimin
range: PU
required: false
multivalued: false
description: Minimum voltage regulator input limit (Vimin) (< ExcST6B.vimax). Typical
value = -10.
vmult:
slot_uri: cim:ExcST6B.vmult
range: boolean
required: false
multivalued: false
description: "Selector (vmult).\r\ntrue = multiply regulator output\
\ by terminal voltage\r\nfalse = do not multiply regulator output by terminal\
\ voltage. \r\nTypical value = true."
vrmax:
slot_uri: cim:ExcST6B.vrmax
range: PU
required: false
multivalued: false
description: Maximum voltage regulator output (Vrmax) (> 0). Typical
value = 4,81.
vrmin:
slot_uri: cim:ExcST6B.vrmin
range: PU
required: false
multivalued: false
description: Minimum voltage regulator output (Vrmin) (< 0). Typical
value = -3,85.
xc:
slot_uri: cim:ExcST6B.xc
range: PU
required: false
multivalued: false
description: Excitation source reactance (Xc). Typical value = 0,05.
ExcST7B:
class_uri: cim:ExcST7B
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
description: Modified IEEE ST7B static excitation system without stator current
limiter (SCL) and current compensator (DROOP) inputs.
attributes:
kh:
slot_uri: cim:ExcST7B.kh
range: PU
required: false
multivalued: false
description: High-value gate feedback gain (Kh) (>= 0). Typical
value = 1.
kia:
slot_uri: cim:ExcST7B.kia
range: PU
required: false
multivalued: false
description: Voltage regulator integral gain (Kia) (>= 0). Typical
value = 1.
kl:
slot_uri: cim:ExcST7B.kl
range: PU
required: false
multivalued: false
description: Low-value gate feedback gain (Kl) (>= 0). Typical
value = 1.
kpa:
slot_uri: cim:ExcST7B.kpa
range: PU
required: false
multivalued: false
description: Voltage regulator proportional gain (Kpa) (> 0). Typical
value = 40.
oelin:
slot_uri: cim:ExcST7B.oelin
range: ExcST7BOELselectorKind
required: false
multivalued: false
description: OEL input selector (OELin). Typical value = noOELinput.
tb:
slot_uri: cim:ExcST7B.tb
range: Seconds
required: false
multivalued: false
description: Regulator lag time constant (Tb) (>= 0). Typical value
= 1.
tc:
slot_uri: cim:ExcST7B.tc
range: Seconds
required: false
multivalued: false
description: Regulator lead time constant (Tc) (>= 0). Typical
value = 1.
tf:
slot_uri: cim:ExcST7B.tf
range: Seconds
required: false
multivalued: false
description: Excitation control system stabilizer time constant (Tf)
(>= 0). Typical value = 1.
tg:
slot_uri: cim:ExcST7B.tg
range: Seconds
required: false
multivalued: false
description: Feedback time constant of inner loop field voltage regulator
(Tg) (>= 0). Typical value = 1.
tia:
slot_uri: cim:ExcST7B.tia
range: Seconds
required: false
multivalued: false
description: Feedback time constant (Tia) (>= 0). Typical value
= 3.
ts:
slot_uri: cim:ExcST7B.ts
range: Seconds
required: false
multivalued: false
description: Rectifier firing time constant (Ts) (>= 0). Typical
value = 0.
uelin:
slot_uri: cim:ExcST7B.uelin
range: ExcST7BUELselectorKind
required: false
multivalued: false
description: UEL input selector (UELin). Typical value = noUELinput.
vmax:
slot_uri: cim:ExcST7B.vmax
range: PU
required: false
multivalued: false
description: Maximum voltage reference signal (Vmax) (> 0 and >
ExcST7B.vmin)). Typical value = 1,1.
vmin:
slot_uri: cim:ExcST7B.vmin
range: PU
required: false
multivalued: false
description: Minimum voltage reference signal (Vmin) (> 0 and <
ExcST7B.vmax). Typical value = 0,9.
vrmax:
slot_uri: cim:ExcST7B.vrmax
range: PU
required: false
multivalued: false
description: Maximum voltage regulator output (Vrmax) (> 0). Typical
value = 5.
vrmin:
slot_uri: cim:ExcST7B.vrmin
range: PU
required: false
multivalued: false
description: Minimum voltage regulator output (Vrmin) (< 0). Typical
value = -4,5.
OverexcLimIEEE:
class_uri: cim:OverexcLimIEEE
is_a: OverexcitationLimiterDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.OverexcitationLimiterDynamics
description: "The over excitation limiter model is intended to represent the significant\
\ features of OELs necessary for some large-scale system studies. It is the\
\ result of a pragmatic approach to obtain a model that can be widely applied\
\ with attainable data from generator owners. An attempt to include all variations\
\ in the functionality of OELs and duplicate how they interact with the rest\
\ of the excitation systems would likely result in a level of application insufficient\
\ for the studies for which they are intended.\r\nReference: IEEE OEL 421.5-2005,\
\ 9. "
attributes:
hyst:
slot_uri: cim:OverexcLimIEEE.hyst
range: PU
required: false
multivalued: false
description: OEL pickup/drop-out hysteresis (HYST). Typical value
= 0,03.
ifdlim:
slot_uri: cim:OverexcLimIEEE.ifdlim
range: PU
required: false
multivalued: false
description: OEL timed field current limit (IFDLIM). Typical
value = 1,05.
ifdmax:
slot_uri: cim:OverexcLimIEEE.ifdmax
range: PU
required: false
multivalued: false
description: OEL instantaneous field current limit (IFDMAX). Typical
value = 1,5.
itfpu:
slot_uri: cim:OverexcLimIEEE.itfpu
range: PU
required: false
multivalued: false
description: OEL timed field current limiter pickup level (ITFPU). Typical
value = 1,05.
kcd:
slot_uri: cim:OverexcLimIEEE.kcd
range: PU
required: false
multivalued: false
description: OEL cooldown gain (KCD). Typical value
= 1.
kramp:
slot_uri: cim:OverexcLimIEEE.kramp
range: float
required: false
multivalued: false
description: OEL ramped limit rate (KRAMP). Unit
= PU / s. Typical value = 10.
OverexcLim2:
class_uri: cim:OverexcLim2
is_a: OverexcitationLimiterDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.OverexcitationLimiterDynamics
description: "Different from LimIEEEOEL, LimOEL2 has a fixed pickup threshold\
\ and reduces the excitation set-point by means of a non-windup integral regulator.\r\
\nIrated is the rated machine excitation current (calculated from nameplate\
\ conditions: Vnom, Pnom,\
\ CosPhinom)."
attributes:
ifdlim:
slot_uri: cim:OverexcLim2.ifdlim
range: PU
required: false
multivalued: false
description: Limit value of rated field current (IFDLIM). Typical
value = 1,05.
koi:
slot_uri: cim:OverexcLim2.koi
range: PU
required: false
multivalued: false
description: Gain Over excitation limiter (KOI). Typical
value = 0,1.
voimax:
slot_uri: cim:OverexcLim2.voimax
range: PU
required: false
multivalued: false
description: Maximum error signal (VOIMAX) (>
OverexcLim2.voimin). Typical value = 0.
voimin:
slot_uri: cim:OverexcLim2.voimin
range: PU
required: false
multivalued: false
description: Minimum error signal (VOIMIN) (<
OverexcLim2.voimax). Typical value = -9999.
OverexcLimX1:
class_uri: cim:OverexcLimX1
is_a: OverexcitationLimiterDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.OverexcitationLimiterDynamics
description: Field voltage over excitation limiter.
attributes:
efd1:
slot_uri: cim:OverexcLimX1.efd1
range: PU
required: false
multivalued: false
description: Low voltage point on the inverse time characteristic (EFD1). Typical
value = 1,1.
efd2:
slot_uri: cim:OverexcLimX1.efd2
range: PU
required: false
multivalued: false
description: Mid voltage point on the inverse time characteristic (EFD2). Typical
value = 1,2.
efd3:
slot_uri: cim:OverexcLimX1.efd3
range: PU
required: false
multivalued: false
description: High voltage point on the inverse time characteristic (EFD3). Typical
value = 1,5.
efddes:
slot_uri: cim:OverexcLimX1.efddes
range: PU
required: false
multivalued: false
description: Desired field voltage (EFDDES). Typical
value = 0,9.
efdrated:
slot_uri: cim:OverexcLimX1.efdrated
range: PU
required: false
multivalued: false
description: Rated field voltage (EFDRATED). Typical
value = 1,05.
kmx:
slot_uri: cim:OverexcLimX1.kmx
range: PU
required: false
multivalued: false
description: Gain (KMX). Typical value = 0,01.
t1:
slot_uri: cim:OverexcLimX1.t1
range: Seconds
required: false
multivalued: false
description: Time to trip the exciter at the low voltage point on the inverse
time characteristic (TIME1) (>= 0). Typical
value = 120.
t2:
slot_uri: cim:OverexcLimX1.t2
range: Seconds
required: false
multivalued: false
description: Time to trip the exciter at the mid voltage point on the inverse
time characteristic (TIME2) (>= 0). Typical
value = 40.
t3:
slot_uri: cim:OverexcLimX1.t3
range: Seconds
required: false
multivalued: false
description: Time to trip the exciter at the high voltage point on the inverse
time characteristic (TIME3) (>= 0). Typical
value = 15.
vlow:
slot_uri: cim:OverexcLimX1.vlow
range: PU
required: false
multivalued: false
description: Low voltage limit (VLOW) (> 0).
OverexcLimX2:
class_uri: cim:OverexcLimX2
is_a: OverexcitationLimiterDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.OverexcitationLimiterDynamics
description: Field voltage or current overexcitation limiter designed to protect
the generator field of an AC machine with automatic excitation control from
overheating due to prolonged overexcitation.
attributes:
efd1:
slot_uri: cim:OverexcLimX2.efd1
range: PU
required: false
multivalued: false
description: Low voltage or current point on the inverse time characteristic
(EFD1). Typical value = 1,1.
efd2:
slot_uri: cim:OverexcLimX2.efd2
range: PU
required: false
multivalued: false
description: Mid voltage or current point on the inverse time characteristic
(EFD2). Typical value = 1,2.
efd3:
slot_uri: cim:OverexcLimX2.efd3
range: PU
required: false
multivalued: false
description: High voltage or current point on the inverse time characteristic
(EFD3). Typical value = 1,5.
efddes:
slot_uri: cim:OverexcLimX2.efddes
range: PU
required: false
multivalued: false
description: Desired field voltage if m = false or desired field current
if m = true (EFDDES). Typical value = 1.
efdrated:
slot_uri: cim:OverexcLimX2.efdrated
range: PU
required: false
multivalued: false
description: Rated field voltage if m = false or rated field current if m
= true (EFDRATED). Typical value = 1,05.
kmx:
slot_uri: cim:OverexcLimX2.kmx
range: PU
required: false
multivalued: false
description: Gain (KMX). Typical value = 0,002.
m:
slot_uri: cim:OverexcLimX2.m
range: boolean
required: false
multivalued: false
description: "(m).\r\ntrue = IFD limiting\r\nfalse = EFD limiting."
t1:
slot_uri: cim:OverexcLimX2.t1
range: Seconds
required: false
multivalued: false
description: Time to trip the exciter at the low voltage or current point
on the inverse time characteristic (TIME1) (>=
0). Typical value = 120.
t2:
slot_uri: cim:OverexcLimX2.t2
range: Seconds
required: false
multivalued: false
description: Time to trip the exciter at the mid voltage or current point
on the inverse time characteristic (TIME2) (>=
0). Typical value = 40.
t3:
slot_uri: cim:OverexcLimX2.t3
range: Seconds
required: false
multivalued: false
description: Time to trip the exciter at the high voltage or current point
on the inverse time characteristic (TIME3) (>=
0). Typical value = 15.
vlow:
slot_uri: cim:OverexcLimX2.vlow
range: PU
required: false
multivalued: false
description: Low voltage limit (VLOW) (> 0).
UnderexcLimIEEE1:
class_uri: cim:UnderexcLimIEEE1
is_a: UnderexcitationLimiterDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.UnderexcitationLimiterDynamics
description: "Type UEL1 model which has a circular limit boundary when plotted\
\ in terms of machine reactive power vs. real power output.\r\nReference: IEEE\
\ UEL1 421.5-2005, 10.1. "
attributes:
kuc:
slot_uri: cim:UnderexcLimIEEE1.kuc
range: PU
required: false
multivalued: false
description: UEL centre setting (KUC). Typical value
= 1,38.
kuf:
slot_uri: cim:UnderexcLimIEEE1.kuf
range: PU
required: false
multivalued: false
description: UEL excitation system stabilizer gain (KUF). Typical
value = 3,3.
kui:
slot_uri: cim:UnderexcLimIEEE1.kui
range: PU
required: false
multivalued: false
description: UEL integral gain (KUI). Typical value
= 0.
kul:
slot_uri: cim:UnderexcLimIEEE1.kul
range: PU
required: false
multivalued: false
description: UEL proportional gain (KUL). Typical
value = 100.
kur:
slot_uri: cim:UnderexcLimIEEE1.kur
range: PU
required: false
multivalued: false
description: UEL radius setting (KUR). Typical value
= 1,95.
tu1:
slot_uri: cim:UnderexcLimIEEE1.tu1
range: Seconds
required: false
multivalued: false
description: UEL lead time constant (TU1) (>=
0). Typical value = 0.
tu2:
slot_uri: cim:UnderexcLimIEEE1.tu2
range: Seconds
required: false
multivalued: false
description: UEL lag time constant (TU2) (>= 0). Typical
value = 0,05.
tu3:
slot_uri: cim:UnderexcLimIEEE1.tu3
range: Seconds
required: false
multivalued: false
description: UEL lead time constant (TU3) (>=
0). Typical value = 0.
tu4:
slot_uri: cim:UnderexcLimIEEE1.tu4
range: Seconds
required: false
multivalued: false
description: UEL lag time constant (TU4) (>= 0). Typical
value = 0.
vucmax:
slot_uri: cim:UnderexcLimIEEE1.vucmax
range: PU
required: false
multivalued: false
description: UEL maximum limit for operating point phasor magnitude (VUCMAX). Typical
value = 5,8.
vuimax:
slot_uri: cim:UnderexcLimIEEE1.vuimax
range: PU
required: false
multivalued: false
description: UEL integrator output maximum limit (VUIMAX)
(> UnderexcLimIEEE1.vuimin).
vuimin:
slot_uri: cim:UnderexcLimIEEE1.vuimin
range: PU
required: false
multivalued: false
description: UEL integrator output minimum limit (VUIMIN)
(< UnderexcLimIEEE1.vuimax).
vulmax:
slot_uri: cim:UnderexcLimIEEE1.vulmax
range: PU
required: false
multivalued: false
description: UEL output maximum limit (VULMAX) (>
UnderexcLimIEEE1.vulmin). Typical value = 18.
vulmin:
slot_uri: cim:UnderexcLimIEEE1.vulmin
range: PU
required: false
multivalued: false
description: UEL output minimum limit (VULMIN) (<
UnderexcLimIEEE1.vulmax). Typical value = -18.
vurmax:
slot_uri: cim:UnderexcLimIEEE1.vurmax
range: PU
required: false
multivalued: false
description: UEL maximum limit for radius phasor magnitude (VURMAX). Typical
value = 5,8.
UnderexcLimIEEE2:
class_uri: cim:UnderexcLimIEEE2
is_a: UnderexcitationLimiterDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.UnderexcitationLimiterDynamics
description: "Type UEL2 underexcitation limiter which has either a straight-line\
\ or multi-segment characteristic when plotted in terms of machine reactive\
\ power output vs. real power output.\r\nReference: IEEE UEL2 421.5-2005, 10.2\
\ (limit characteristic lookup table shown in Figure 10.4 (p 32))."
attributes:
k1:
slot_uri: cim:UnderexcLimIEEE2.k1
range: float
required: false
multivalued: false
description: UEL terminal voltage exponent applied to real power input to
UEL limit look-up table (k1). Typical value = 2.
k2:
slot_uri: cim:UnderexcLimIEEE2.k2
range: float
required: false
multivalued: false
description: UEL terminal voltage exponent applied to reactive power output
from UEL limit look-up table (k2). Typical value = 2.
kfb:
slot_uri: cim:UnderexcLimIEEE2.kfb
range: PU
required: false
multivalued: false
description: Gain associated with optional integrator feedback input signal
to UEL (KFB). Typical value = 0.
kuf:
slot_uri: cim:UnderexcLimIEEE2.kuf
range: PU
required: false
multivalued: false
description: UEL excitation system stabilizer gain (KUF). Typical
value = 0.
kui:
slot_uri: cim:UnderexcLimIEEE2.kui
range: PU
required: false
multivalued: false
description: UEL integral gain (KUI). Typical value
= 0,5.
kul:
slot_uri: cim:UnderexcLimIEEE2.kul
range: PU
required: false
multivalued: false
description: UEL proportional gain (KUL). Typical
value = 0,8.
p0:
slot_uri: cim:UnderexcLimIEEE2.p0
range: PU
required: false
multivalued: false
description: Real power values for endpoints (P0). Typical
value = 0.
p1:
slot_uri: cim:UnderexcLimIEEE2.p1
range: PU
required: false
multivalued: false
description: Real power values for endpoints (P1). Typical
value = 0,3.
p10:
slot_uri: cim:UnderexcLimIEEE2.p10
range: PU
required: false
multivalued: false
description: 'Real power values for endpoints (P10). '
p2:
slot_uri: cim:UnderexcLimIEEE2.p2
range: PU
required: false
multivalued: false
description: Real power values for endpoints (P2). Typical
value = 0,6.
p3:
slot_uri: cim:UnderexcLimIEEE2.p3
range: PU
required: false
multivalued: false
description: Real power values for endpoints (P3). Typical
value = 0,9.
p4:
slot_uri: cim:UnderexcLimIEEE2.p4
range: PU
required: false
multivalued: false
description: Real power values for endpoints (P4). Typical
value = 1,02.
p5:
slot_uri: cim:UnderexcLimIEEE2.p5
range: PU
required: false
multivalued: false
description: 'Real power values for endpoints (P5). '
p6:
slot_uri: cim:UnderexcLimIEEE2.p6
range: PU
required: false
multivalued: false
description: Real power values for endpoints (P6).
p7:
slot_uri: cim:UnderexcLimIEEE2.p7
range: PU
required: false
multivalued: false
description: 'Real power values for endpoints (P7). '
p8:
slot_uri: cim:UnderexcLimIEEE2.p8
range: PU
required: false
multivalued: false
description: 'Real power values for endpoints (P8). '
p9:
slot_uri: cim:UnderexcLimIEEE2.p9
range: PU
required: false
multivalued: false
description: 'Real power values for endpoints (P9). '
q0:
slot_uri: cim:UnderexcLimIEEE2.q0
range: PU
required: false
multivalued: false
description: Reactive power values for endpoints (Q0). Typical
value = -0,31.
q1:
slot_uri: cim:UnderexcLimIEEE2.q1
range: PU
required: false
multivalued: false
description: Reactive power values for endpoints (Q1). Typical
value = -0,31.
q10:
slot_uri: cim:UnderexcLimIEEE2.q10
range: PU
required: false
multivalued: false
description: 'Reactive power values for endpoints (Q10). '
q2:
slot_uri: cim:UnderexcLimIEEE2.q2
range: PU
required: false
multivalued: false
description: Reactive power values for endpoints (Q2). Typical
value = -0,28.
q3:
slot_uri: cim:UnderexcLimIEEE2.q3
range: PU
required: false
multivalued: false
description: Reactive power values for endpoints (Q3). Typical
value = -0,21.
q4:
slot_uri: cim:UnderexcLimIEEE2.q4
range: PU
required: false
multivalued: false
description: Reactive power values for endpoints (Q4). Typical
value = 0.
q5:
slot_uri: cim:UnderexcLimIEEE2.q5
range: PU
required: false
multivalued: false
description: 'Reactive power values for endpoints (Q5). '
q6:
slot_uri: cim:UnderexcLimIEEE2.q6
range: PU
required: false
multivalued: false
description: 'Reactive power values for endpoints (Q6). '
q7:
slot_uri: cim:UnderexcLimIEEE2.q7
range: PU
required: false
multivalued: false
description: 'Reactive power values for endpoints (Q7). '
q8:
slot_uri: cim:UnderexcLimIEEE2.q8
range: PU
required: false
multivalued: false
description: 'Reactive power values for endpoints (Q8). '
q9:
slot_uri: cim:UnderexcLimIEEE2.q9
range: PU
required: false
multivalued: false
description: 'Reactive power values for endpoints (Q9). '
tu1:
slot_uri: cim:UnderexcLimIEEE2.tu1
range: Seconds
required: false
multivalued: false
description: UEL lead time constant (TU1) (>=
0). Typical value = 0.
tu2:
slot_uri: cim:UnderexcLimIEEE2.tu2
range: Seconds
required: false
multivalued: false
description: UEL lag time constant (TU2) (>= 0). Typical
value = 0.
tu3:
slot_uri: cim:UnderexcLimIEEE2.tu3
range: Seconds
required: false
multivalued: false
description: UEL lead time constant (TU3) (>=
0). Typical value = 0.
tu4:
slot_uri: cim:UnderexcLimIEEE2.tu4
range: Seconds
required: false
multivalued: false
description: UEL lag time constant (TU4) (>= 0). Typical
value = 0.
tul:
slot_uri: cim:UnderexcLimIEEE2.tul
range: Seconds
required: false
multivalued: false
description: Time constant associated with optional integrator feedback input
signal to UEL (TUL) (>= 0). Typical value =
0.
tup:
slot_uri: cim:UnderexcLimIEEE2.tup
range: Seconds
required: false
multivalued: false
description: Real power filter time constant (TUP)
(>= 0). Typical value = 5.
tuq:
slot_uri: cim:UnderexcLimIEEE2.tuq
range: Seconds
required: false
multivalued: false
description: Reactive power filter time constant (TUQ)
(>= 0). Typical value = 0.
tuv:
slot_uri: cim:UnderexcLimIEEE2.tuv
range: Seconds
required: false
multivalued: false
description: Voltage filter time constant (TUV) (>=
0). Typical value = 5.
vuimax:
slot_uri: cim:UnderexcLimIEEE2.vuimax
range: PU
required: false
multivalued: false
description: UEL integrator output maximum limit (VUIMAX)
(> UnderexcLimIEEE2.vuimin). Typical value = 0,25.
vuimin:
slot_uri: cim:UnderexcLimIEEE2.vuimin
range: PU
required: false
multivalued: false
description: UEL integrator output minimum limit (VUIMIN)
(< UnderexcLimIEEE2.vuimax). Typical value = 0.
vulmax:
slot_uri: cim:UnderexcLimIEEE2.vulmax
range: PU
required: false
multivalued: false
description: UEL output maximum limit (VULMAX) (>
UnderexcLimIEEE2.vulmin). Typical value = 0,25.
vulmin:
slot_uri: cim:UnderexcLimIEEE2.vulmin
range: PU
required: false
multivalued: false
description: UEL output minimum limit (VULMIN) (<
UnderexcLimIEEE2.vulmax). Typical value = 0.
UnderexcLim2Simplified:
class_uri: cim:UnderexcLim2Simplified
is_a: UnderexcitationLimiterDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.UnderexcitationLimiterDynamics
description: "Simplified type UEL2 underexcitation limiter. This model can be\
\ derived from UnderexcLimIEEE2. The limit characteristic (look \u2013up table)\
\ is a single straight-line, the same as UnderexcLimIEEE2 (see Figure 10.4 (p\
\ 32), IEEE 421.5-2005 Section 10.2)."
attributes:
kui:
slot_uri: cim:UnderexcLim2Simplified.kui
range: PU
required: false
multivalued: false
description: Gain Under excitation limiter (KUI). Typical
value = 0,1.
p0:
slot_uri: cim:UnderexcLim2Simplified.p0
range: PU
required: false
multivalued: false
description: Segment P initial point (P0). Typical
value = 0.
p1:
slot_uri: cim:UnderexcLim2Simplified.p1
range: PU
required: false
multivalued: false
description: Segment P end point (P1). Typical value
= 1.
q0:
slot_uri: cim:UnderexcLim2Simplified.q0
range: PU
required: false
multivalued: false
description: Segment Q initial point (Q0). Typical
value = -0,31.
q1:
slot_uri: cim:UnderexcLim2Simplified.q1
range: PU
required: false
multivalued: false
description: Segment Q end point (Q1). Typical value
= -0,1.
vuimax:
slot_uri: cim:UnderexcLim2Simplified.vuimax
range: PU
required: false
multivalued: false
description: Maximum error signal (VUIMAX) (>
UnderexcLim2Simplified.vuimin). Typical value = 1.
vuimin:
slot_uri: cim:UnderexcLim2Simplified.vuimin
range: PU
required: false
multivalued: false
description: Minimum error signal (VUIMIN) (<
UnderexcLim2Simplified.vuimax). Typical value = 0.
UnderexcLimX1:
class_uri: cim:UnderexcLimX1
is_a: UnderexcitationLimiterDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.UnderexcitationLimiterDynamics
description: Allis-Chalmers minimum excitation limiter.
attributes:
k:
slot_uri: cim:UnderexcLimX1.k
range: PU
required: false
multivalued: false
description: Minimum excitation limit slope (K) (> 0).
kf2:
slot_uri: cim:UnderexcLimX1.kf2
range: PU
required: false
multivalued: false
description: Differential gain (KF2).
km:
slot_uri: cim:UnderexcLimX1.km
range: PU
required: false
multivalued: false
description: Minimum excitation limit gain (KM).
melmax:
slot_uri: cim:UnderexcLimX1.melmax
range: PU
required: false
multivalued: false
description: Minimum excitation limit value (MELMAX).
tf2:
slot_uri: cim:UnderexcLimX1.tf2
range: Seconds
required: false
multivalued: false
description: Differential time constant (TF2) (>=
0).
tm:
slot_uri: cim:UnderexcLimX1.tm
range: Seconds
required: false
multivalued: false
description: Minimum excitation limit time constant (TM)
(>= 0).
UnderexcLimX2:
class_uri: cim:UnderexcLimX2
is_a: UnderexcitationLimiterDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.UnderexcitationLimiterDynamics
description: Westinghouse minimum excitation limiter.
attributes:
kf2:
slot_uri: cim:UnderexcLimX2.kf2
range: PU
required: false
multivalued: false
description: Differential gain (KF2).
km:
slot_uri: cim:UnderexcLimX2.km
range: PU
required: false
multivalued: false
description: Minimum excitation limit gain (KM).
melmax:
slot_uri: cim:UnderexcLimX2.melmax
range: PU
required: false
multivalued: false
description: Minimum excitation limit value (MELMAX).
qo:
slot_uri: cim:UnderexcLimX2.qo
range: PU
required: false
multivalued: false
description: Excitation centre setting (QO).
r:
slot_uri: cim:UnderexcLimX2.r
range: PU
required: false
multivalued: false
description: Excitation radius (R).
tf2:
slot_uri: cim:UnderexcLimX2.tf2
range: Seconds
required: false
multivalued: false
description: Differential time constant (TF2) (>=
0).
tm:
slot_uri: cim:UnderexcLimX2.tm
range: Seconds
required: false
multivalued: false
description: Minimum excitation limit time constant (TM)
(>= 0).
PssIEEE1A:
class_uri: cim:PssIEEE1A
is_a: PowerSystemStabilizerDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.PowerSystemStabilizerDynamics
description: "IEEE 421.5-2005 type PSS1A power system stabilizer model. PSS1A\
\ is the generalized form of a PSS with a single input signal. \r\nReference:\
\ IEEE 1A 421.5-2005, 8.1. "
attributes:
a1:
slot_uri: cim:PssIEEE1A.a1
range: PU
required: false
multivalued: false
description: PSS signal conditioning frequency filter constant (A1). Typical
value = 0,061.
a2:
slot_uri: cim:PssIEEE1A.a2
range: PU
required: false
multivalued: false
description: PSS signal conditioning frequency filter constant (A2). Typical
value = 0,0017.
inputSignalType:
slot_uri: cim:PssIEEE1A.inputSignalType
range: InputSignalKind
required: false
multivalued: false
description: Type of input signal (rotorAngularFrequencyDeviation, generatorElectricalPower,
or busFrequencyDeviation). Typical value = rotorAngularFrequencyDeviation.
ks:
slot_uri: cim:PssIEEE1A.ks
range: PU
required: false
multivalued: false
description: Stabilizer gain (Ks). Typical value = 5.
t1:
slot_uri: cim:PssIEEE1A.t1
range: Seconds
required: false
multivalued: false
description: Lead/lag time constant (T1) (>= 0). Typical value
= 0,3.
t2:
slot_uri: cim:PssIEEE1A.t2
range: Seconds
required: false
multivalued: false
description: Lead/lag time constant (T2) (>= 0). Typical value
= 0,03.
t3:
slot_uri: cim:PssIEEE1A.t3
range: Seconds
required: false
multivalued: false
description: Lead/lag time constant (T3) (>= 0). Typical value
= 0,3.
t4:
slot_uri: cim:PssIEEE1A.t4
range: Seconds
required: false
multivalued: false
description: Lead/lag time constant (T4) (>= 0). Typical value
= 0,03.
t5:
slot_uri: cim:PssIEEE1A.t5
range: Seconds
required: false
multivalued: false
description: Washout time constant (T5) (>= 0). Typical value =
10.
t6:
slot_uri: cim:PssIEEE1A.t6
range: Seconds
required: false
multivalued: false
description: Transducer time constant (T6) (>= 0). Typical value
= 0,01.
vrmax:
slot_uri: cim:PssIEEE1A.vrmax
range: PU
required: false
multivalued: false
description: Maximum stabilizer output (Vrmax) (> PssIEEE1A.vrmin). Typical
value = 0,05.
vrmin:
slot_uri: cim:PssIEEE1A.vrmin
range: PU
required: false
multivalued: false
description: Minimum stabilizer output (Vrmin) (< PssIEEE1A.vrmax). Typical
value = -0,05.
PssIEEE2B:
class_uri: cim:PssIEEE2B
is_a: PowerSystemStabilizerDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.PowerSystemStabilizerDynamics
description: "IEEE 421.5-2005 type PSS2B power system stabilizer model. This stabilizer\
\ model is designed to represent a variety of dual-input stabilizers, which\
\ normally use combinations of power and speed or frequency to derive the stabilizing\
\ signal.\r\nReference: IEEE 2B 421.5-2005, 8.2."
attributes:
inputSignal1Type:
slot_uri: cim:PssIEEE2B.inputSignal1Type
range: InputSignalKind
required: false
multivalued: false
description: 'Type of input signal #1 (rotorAngularFrequencyDeviation, busFrequencyDeviation). Typical
value = rotorAngularFrequencyDeviation.'
inputSignal2Type:
slot_uri: cim:PssIEEE2B.inputSignal2Type
range: InputSignalKind
required: false
multivalued: false
description: 'Type of input signal #2 (generatorElectricalPower). Typical
value = generatorElectricalPower.'
ks1:
slot_uri: cim:PssIEEE2B.ks1
range: PU
required: false
multivalued: false
description: Stabilizer gain (Ks1). Typical value = 12.
ks2:
slot_uri: cim:PssIEEE2B.ks2
range: PU
required: false
multivalued: false
description: 'Gain on signal #2 (Ks2). Typical value = 0,2.'
ks3:
slot_uri: cim:PssIEEE2B.ks3
range: PU
required: false
multivalued: false
description: 'Gain on signal #2 input before ramp-tracking filter (Ks3). Typical
value = 1.'
m:
slot_uri: cim:PssIEEE2B.m
range: integer
required: false
multivalued: false
description: Denominator order of ramp tracking filter (M). Typical
value = 5.
n:
slot_uri: cim:PssIEEE2B.n
range: integer
required: false
multivalued: false
description: Order of ramp tracking filter (N). Typical value = 1.
t1:
slot_uri: cim:PssIEEE2B.t1
range: Seconds
required: false
multivalued: false
description: Lead/lag time constant (T1) (>= 0). Typical value
= 0,12.
t10:
slot_uri: cim:PssIEEE2B.t10
range: Seconds
required: false
multivalued: false
description: Lead/lag time constant (T10) (>= 0). Typical value
= 0.
t11:
slot_uri: cim:PssIEEE2B.t11
range: Seconds
required: false
multivalued: false
description: Lead/lag time constant (T11) (>= 0). Typical value
= 0.
t2:
slot_uri: cim:PssIEEE2B.t2
range: Seconds
required: false
multivalued: false
description: Lead/lag time constant (T2) (>= 0). Typical value
= 0,02.
t3:
slot_uri: cim:PssIEEE2B.t3
range: Seconds
required: false
multivalued: false
description: Lead/lag time constant (T3) (>= 0). Typical value
= 0,3.
t4:
slot_uri: cim:PssIEEE2B.t4
range: Seconds
required: false
multivalued: false
description: Lead/lag time constant (T4) (>= 0). Typical value
= 0,02.
t6:
slot_uri: cim:PssIEEE2B.t6
range: Seconds
required: false
multivalued: false
description: 'Time constant on signal #1 (T6) (>= 0). Typical value
= 0.'
t7:
slot_uri: cim:PssIEEE2B.t7
range: Seconds
required: false
multivalued: false
description: 'Time constant on signal #2 (T7) (>= 0). Typical value
= 2.'
t8:
slot_uri: cim:PssIEEE2B.t8
range: Seconds
required: false
multivalued: false
description: Lead of ramp tracking filter (T8) (>= 0). Typical
value = 0,2.
t9:
slot_uri: cim:PssIEEE2B.t9
range: Seconds
required: false
multivalued: false
description: Lag of ramp tracking filter (T9) (>= 0). Typical value
= 0,1.
tw1:
slot_uri: cim:PssIEEE2B.tw1
range: Seconds
required: false
multivalued: false
description: 'First washout on signal #1 (Tw1) (>= 0). Typical
value = 2.'
tw2:
slot_uri: cim:PssIEEE2B.tw2
range: Seconds
required: false
multivalued: false
description: 'Second washout on signal #1 (Tw2) (>= 0). Typical
value = 2.'
tw3:
slot_uri: cim:PssIEEE2B.tw3
range: Seconds
required: false
multivalued: false
description: 'First washout on signal #2 (Tw3) (>= 0). Typical
value = 2.'
tw4:
slot_uri: cim:PssIEEE2B.tw4
range: Seconds
required: false
multivalued: false
description: 'Second washout on signal #2 (Tw4) (>= 0). Typical
value = 0.'
vsi1max:
slot_uri: cim:PssIEEE2B.vsi1max
range: PU
required: false
multivalued: false
description: 'Input signal #1 maximum limit (Vsi1max) (> PssIEEE2B.vsi1min). Typical
value = 2.'
vsi1min:
slot_uri: cim:PssIEEE2B.vsi1min
range: PU
required: false
multivalued: false
description: 'Input signal #1 minimum limit (Vsi1min) (< PssIEEE2B.vsi1max). Typical
value = -2.'
vsi2max:
slot_uri: cim:PssIEEE2B.vsi2max
range: PU
required: false
multivalued: false
description: 'Input signal #2 maximum limit (Vsi2max) (> PssIEEE2B.vsi2min). Typical
value = 2.'
vsi2min:
slot_uri: cim:PssIEEE2B.vsi2min
range: PU
required: false
multivalued: false
description: 'Input signal #2 minimum limit (Vsi2min) (< PssIEEE2B.vsi2max). Typical
value = -2.'
vstmax:
slot_uri: cim:PssIEEE2B.vstmax
range: PU
required: false
multivalued: false
description: Stabilizer output maximum limit (Vstmax) (> PssIEEE2B.vstmin). Typical
value = 0,1.
vstmin:
slot_uri: cim:PssIEEE2B.vstmin
range: PU
required: false
multivalued: false
description: Stabilizer output minimum limit (Vstmin) (< PssIEEE2B.vstmax). Typical
value = -0,1.
PssIEEE3B:
class_uri: cim:PssIEEE3B
is_a: PowerSystemStabilizerDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.PowerSystemStabilizerDynamics
description: "IEEE 421.5-2005 type PSS3B power system stabilizer model. The PSS\
\ model PSS3B has dual inputs of electrical power and rotor angular frequency\
\ deviation. The signals are used to derive an equivalent mechanical power signal.\r\
\nThis model has 2 input signals. They have the following fixed types (expressed\
\ in terms of InputSignalKind values): the first one is of rotorAngleFrequencyDeviation\
\ type and the second one is of generatorElectricalPower type.\r\nReference:\
\ IEEE 3B 421.5-2005, 8.3. \r\n\r\n"
attributes:
a1:
slot_uri: cim:PssIEEE3B.a1
range: PU
required: false
multivalued: false
description: Notch filter parameter (A1). Typical value = 0,359.
a2:
slot_uri: cim:PssIEEE3B.a2
range: PU
required: false
multivalued: false
description: Notch filter parameter (A2). Typical value = 0,586.
a3:
slot_uri: cim:PssIEEE3B.a3
range: PU
required: false
multivalued: false
description: Notch filter parameter (A3). Typical value = 0,429.
a4:
slot_uri: cim:PssIEEE3B.a4
range: PU
required: false
multivalued: false
description: Notch filter parameter (A4). Typical value = 0,564.
a5:
slot_uri: cim:PssIEEE3B.a5
range: PU
required: false
multivalued: false
description: Notch filter parameter (A5). Typical value = 0,001.
a6:
slot_uri: cim:PssIEEE3B.a6
range: PU
required: false
multivalued: false
description: Notch filter parameter (A6). Typical value = 0.
a7:
slot_uri: cim:PssIEEE3B.a7
range: PU
required: false
multivalued: false
description: Notch filter parameter (A7). Typical value = 0,031.
a8:
slot_uri: cim:PssIEEE3B.a8
range: PU
required: false
multivalued: false
description: Notch filter parameter (A8). Typical value = 0.
ks1:
slot_uri: cim:PssIEEE3B.ks1
range: PU
required: false
multivalued: false
description: 'Gain on signal # 1 (Ks1). Typical value = -0,602.'
ks2:
slot_uri: cim:PssIEEE3B.ks2
range: PU
required: false
multivalued: false
description: 'Gain on signal # 2 (Ks2). Typical value = 30,12.'
t1:
slot_uri: cim:PssIEEE3B.t1
range: Seconds
required: false
multivalued: false
description: Transducer time constant (T1) (>= 0). Typical value
= 0,012.
t2:
slot_uri: cim:PssIEEE3B.t2
range: Seconds
required: false
multivalued: false
description: Transducer time constant (T2) (>= 0). Typical value
= 0,012.
tw1:
slot_uri: cim:PssIEEE3B.tw1
range: Seconds
required: false
multivalued: false
description: Washout time constant (Tw1) (>= 0). Typical value
= 0,3.
tw2:
slot_uri: cim:PssIEEE3B.tw2
range: Seconds
required: false
multivalued: false
description: Washout time constant (Tw2) (>= 0). Typical value
= 0,3.
tw3:
slot_uri: cim:PssIEEE3B.tw3
range: Seconds
required: false
multivalued: false
description: Washout time constant (Tw3) (>= 0). Typical value
= 0,6.
vstmax:
slot_uri: cim:PssIEEE3B.vstmax
range: PU
required: false
multivalued: false
description: Stabilizer output maximum limit (Vstmax) (> PssIEEE3B.vstmin). Typical
value = 0,1.
vstmin:
slot_uri: cim:PssIEEE3B.vstmin
range: PU
required: false
multivalued: false
description: Stabilizer output minimum limit (Vstmin) (< PssIEEE3B.vstmax). Typical
value = -0,1.
PssIEEE4B:
class_uri: cim:PssIEEE4B
is_a: PowerSystemStabilizerDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.PowerSystemStabilizerDynamics
description: "IEEE 421.5-2005 type PSS4B power system stabilizer. The PSS4B model\
\ represents a structure based on multiple working frequency bands. Three separate\
\ bands, respectively dedicated to the low-, intermediate- and high-frequency\
\ modes of oscillations, are used in this delta omega (speed input) PSS.\r\n\
There is an error in the in IEEE 421.5-2005 PSS4B model: the Pe input\
\ should read \u2013Pe. This implies that the input Pe needs to\
\ be multiplied by -1.\r\nReference: IEEE 4B 421.5-2005, 8.4. \r\nParameter\
\ details:\r\nThis model has 2 input signals. They have the following fixed\
\ types (expressed in terms of InputSignalKind values): the first one is of\
\ rotorAngleFrequencyDeviation type and the second one is of generatorElectricalPower\
\ type.\r\n"
attributes:
bwh1:
slot_uri: cim:PssIEEE4B.bwh1
range: float
required: false
multivalued: false
description: 'Notch filter 1 (high-frequency band): three dB bandwidth (Bwi). '
bwh2:
slot_uri: cim:PssIEEE4B.bwh2
range: float
required: false
multivalued: false
description: 'Notch filter 2 (high-frequency band): three dB bandwidth (Bwi). '
bwl1:
slot_uri: cim:PssIEEE4B.bwl1
range: float
required: false
multivalued: false
description: 'Notch filter 1 (low-frequency band): three dB bandwidth (Bwi). '
bwl2:
slot_uri: cim:PssIEEE4B.bwl2
range: float
required: false
multivalued: false
description: 'Notch filter 2 (low-frequency band): three dB bandwidth (Bwi). '
kh:
slot_uri: cim:PssIEEE4B.kh
range: PU
required: false
multivalued: false
description: High band gain (KH). Typical value
= 120.
kh1:
slot_uri: cim:PssIEEE4B.kh1
range: PU
required: false
multivalued: false
description: High band differential filter gain (KH1). Typical
value = 66.
kh11:
slot_uri: cim:PssIEEE4B.kh11
range: PU
required: false
multivalued: false
description: High band first lead-lag blocks coefficient (KH11). Typical
value = 1.
kh17:
slot_uri: cim:PssIEEE4B.kh17
range: PU
required: false
multivalued: false
description: High band first lead-lag blocks coefficient (KH17). Typical
value = 1.
kh2:
slot_uri: cim:PssIEEE4B.kh2
range: PU
required: false
multivalued: false
description: High band differential filter gain (KH2). Typical
value = 66.
ki:
slot_uri: cim:PssIEEE4B.ki
range: PU
required: false
multivalued: false
description: Intermediate band gain (KI). Typical
value = 30.
ki1:
slot_uri: cim:PssIEEE4B.ki1
range: PU
required: false
multivalued: false
description: Intermediate band differential filter gain (KI1). Typical
value = 66.
ki11:
slot_uri: cim:PssIEEE4B.ki11
range: PU
required: false
multivalued: false
description: Intermediate band first lead-lag blocks coefficient (KI11). Typical
value = 1.
ki17:
slot_uri: cim:PssIEEE4B.ki17
range: PU
required: false
multivalued: false
description: Intermediate band first lead-lag blocks coefficient (KI17). Typical
value = 1.
ki2:
slot_uri: cim:PssIEEE4B.ki2
range: PU
required: false
multivalued: false
description: Intermediate band differential filter gain (KI2). Typical
value = 66.
kl:
slot_uri: cim:PssIEEE4B.kl
range: PU
required: false
multivalued: false
description: Low band gain (KL). Typical value =
7.5.
kl1:
slot_uri: cim:PssIEEE4B.kl1
range: PU
required: false
multivalued: false
description: Low band differential filter gain (KL1). Typical
value = 66.
kl11:
slot_uri: cim:PssIEEE4B.kl11
range: PU
required: false
multivalued: false
description: Low band first lead-lag blocks coefficient (KL11). Typical
value = 1.
kl17:
slot_uri: cim:PssIEEE4B.kl17
range: PU
required: false
multivalued: false
description: Low band first lead-lag blocks coefficient (KL17). Typical
value = 1.
kl2:
slot_uri: cim:PssIEEE4B.kl2
range: PU
required: false
multivalued: false
description: Low band differential filter gain (KL2). Typical
value = 66.
omeganh1:
slot_uri: cim:PssIEEE4B.omeganh1
range: float
required: false
multivalued: false
description: 'Notch filter 1 (high-frequency band): filter frequency (omegani).'
omeganh2:
slot_uri: cim:PssIEEE4B.omeganh2
range: float
required: false
multivalued: false
description: 'Notch filter 2 (high-frequency band): filter frequency (omegani).'
omeganl1:
slot_uri: cim:PssIEEE4B.omeganl1
range: float
required: false
multivalued: false
description: 'Notch filter 1 (low-frequency band): filter frequency (omegani).'
omeganl2:
slot_uri: cim:PssIEEE4B.omeganl2
range: float
required: false
multivalued: false
description: 'Notch filter 2 (low-frequency band): filter frequency (omegani).'
th1:
slot_uri: cim:PssIEEE4B.th1
range: Seconds
required: false
multivalued: false
description: High band time constant (TH1) (>=
0). Typical value = 0,01513.
th10:
slot_uri: cim:PssIEEE4B.th10
range: Seconds
required: false
multivalued: false
description: High band time constant (TH10) (>=
0). Typical value = 0.
th11:
slot_uri: cim:PssIEEE4B.th11
range: Seconds
required: false
multivalued: false
description: High band time constant (TH11) (>=
0). Typical value = 0.
th12:
slot_uri: cim:PssIEEE4B.th12
range: Seconds
required: false
multivalued: false
description: High band time constant (TH12) (>=
0). Typical value = 0.
th2:
slot_uri: cim:PssIEEE4B.th2
range: Seconds
required: false
multivalued: false
description: High band time constant (TH2) (>=
0). Typical value = 0,01816.
th3:
slot_uri: cim:PssIEEE4B.th3
range: Seconds
required: false
multivalued: false
description: High band time constant (TH3) (>=
0). Typical value = 0.
th4:
slot_uri: cim:PssIEEE4B.th4
range: Seconds
required: false
multivalued: false
description: High band time constant (TH4) (>=
0). Typical value = 0.
th5:
slot_uri: cim:PssIEEE4B.th5
range: Seconds
required: false
multivalued: false
description: High band time constant (TH5) (>=
0). Typical value = 0.
th6:
slot_uri: cim:PssIEEE4B.th6
range: Seconds
required: false
multivalued: false
description: High band time constant (TH6) (>=
0). Typical value = 0.
th7:
slot_uri: cim:PssIEEE4B.th7
range: Seconds
required: false
multivalued: false
description: High band time constant (TH7) (>=
0). Typical value = 0,01816.
th8:
slot_uri: cim:PssIEEE4B.th8
range: Seconds
required: false
multivalued: false
description: High band time constant (TH8) (>=
0). Typical value = 0,02179.
th9:
slot_uri: cim:PssIEEE4B.th9
range: Seconds
required: false
multivalued: false
description: High band time constant (TH9) (>=
0). Typical value = 0.
ti1:
slot_uri: cim:PssIEEE4B.ti1
range: Seconds
required: false
multivalued: false
description: Intermediate band time constant (TI1)
(>= 0). Typical value = 0,173.
ti10:
slot_uri: cim:PssIEEE4B.ti10
range: Seconds
required: false
multivalued: false
description: Intermediate band time constant (TI10)
(>= 0). Typical value = 0.
ti11:
slot_uri: cim:PssIEEE4B.ti11
range: Seconds
required: false
multivalued: false
description: Intermediate band time constant (TI11)
(>= 0). Typical value = 0.
ti12:
slot_uri: cim:PssIEEE4B.ti12
range: Seconds
required: false
multivalued: false
description: Intermediate band time constant (TI12)
(>= 0). Typical value = 0.
ti2:
slot_uri: cim:PssIEEE4B.ti2
range: Seconds
required: false
multivalued: false
description: Intermediate band time constant (TI2)
(>= 0). Typical value = 0,2075.
ti3:
slot_uri: cim:PssIEEE4B.ti3
range: Seconds
required: false
multivalued: false
description: Intermediate band time constant (TI3)
(>= 0). Typical value = 0.
ti4:
slot_uri: cim:PssIEEE4B.ti4
range: Seconds
required: false
multivalued: false
description: Intermediate band time constant (TI4)
(>= 0). Typical value = 0.
ti5:
slot_uri: cim:PssIEEE4B.ti5
range: Seconds
required: false
multivalued: false
description: Intermediate band time constant (TI5)
(>= 0). Typical value = 0.
ti6:
slot_uri: cim:PssIEEE4B.ti6
range: Seconds
required: false
multivalued: false
description: Intermediate band time constant (TI6)
(>= 0). Typical value = 0.
ti7:
slot_uri: cim:PssIEEE4B.ti7
range: Seconds
required: false
multivalued: false
description: Intermediate band time constant (TI7)
(>= 0). Typical value = 0,2075.
ti8:
slot_uri: cim:PssIEEE4B.ti8
range: Seconds
required: false
multivalued: false
description: Intermediate band time constant (TI8)
(>= 0). Typical value = 0,2491.
ti9:
slot_uri: cim:PssIEEE4B.ti9
range: Seconds
required: false
multivalued: false
description: Intermediate band time constant (TI9)
(>= 0). Typical value = 0.
tl1:
slot_uri: cim:PssIEEE4B.tl1
range: Seconds
required: false
multivalued: false
description: Low band time constant (TL1) (>=
0). Typical value = 1,73.
tl10:
slot_uri: cim:PssIEEE4B.tl10
range: Seconds
required: false
multivalued: false
description: Low band time constant (TL10) (>=
0). Typical value = 0.
tl11:
slot_uri: cim:PssIEEE4B.tl11
range: Seconds
required: false
multivalued: false
description: Low band time constant (TL11) (>=
0). Typical value = 0.
tl12:
slot_uri: cim:PssIEEE4B.tl12
range: Seconds
required: false
multivalued: false
description: Low band time constant (TL12) (>=
0). Typical value = 0.
tl2:
slot_uri: cim:PssIEEE4B.tl2
range: Seconds
required: false
multivalued: false
description: Low band time constant (TL2) (>=
0). Typical value = 2,075.
tl3:
slot_uri: cim:PssIEEE4B.tl3
range: Seconds
required: false
multivalued: false
description: Low band time constant (TL3) (>=
0). Typical value = 0.
tl4:
slot_uri: cim:PssIEEE4B.tl4
range: Seconds
required: false
multivalued: false
description: Low band time constant (TL4) (>=
0). Typical value = 0.
tl5:
slot_uri: cim:PssIEEE4B.tl5
range: Seconds
required: false
multivalued: false
description: Low band time constant (TL5) (>=
0). Typical value = 0.
tl6:
slot_uri: cim:PssIEEE4B.tl6
range: Seconds
required: false
multivalued: false
description: Low band time constant (TL6) (>=
0). Typical value = 0.
tl7:
slot_uri: cim:PssIEEE4B.tl7
range: Seconds
required: false
multivalued: false
description: Low band time constant (TL7) (>=
0). Typical value = 2,075.
tl8:
slot_uri: cim:PssIEEE4B.tl8
range: Seconds
required: false
multivalued: false
description: Low band time constant (TL8) (>=
0). Typical value = 2,491.
tl9:
slot_uri: cim:PssIEEE4B.tl9
range: Seconds
required: false
multivalued: false
description: Low band time constant (TL9) (>=
0). Typical value = 0.
vhmax:
slot_uri: cim:PssIEEE4B.vhmax
range: PU
required: false
multivalued: false
description: High band output maximum limit (VHmax)
(> PssIEEE4B.vhmin). Typical value = 0,6.
vhmin:
slot_uri: cim:PssIEEE4B.vhmin
range: PU
required: false
multivalued: false
description: High band output minimum limit (VHmin)
(< PssIEEE4V.vhmax). Typical value = -0,6.
vimax:
slot_uri: cim:PssIEEE4B.vimax
range: PU
required: false
multivalued: false
description: Intermediate band output maximum limit (VImax)
(> PssIEEE4B.vimin). Typical value = 0,6.
vimin:
slot_uri: cim:PssIEEE4B.vimin
range: PU
required: false
multivalued: false
description: Intermediate band output minimum limit (VImin)
(< PssIEEE4B.vimax). Typical value = -0,6.
vlmax:
slot_uri: cim:PssIEEE4B.vlmax
range: PU
required: false
multivalued: false
description: Low band output maximum limit (VLmax)
(> PssIEEE4B.vlmin). Typical value = 0,075.
vlmin:
slot_uri: cim:PssIEEE4B.vlmin
range: PU
required: false
multivalued: false
description: Low band output minimum limit (VLmin)
(< PssIEEE4B.vlmax). Typical value = -0,075.
vstmax:
slot_uri: cim:PssIEEE4B.vstmax
range: PU
required: false
multivalued: false
description: PSS output maximum limit (VSTmax) (>
PssIEEE4B.vstmin). Typical value = 0,15.
vstmin:
slot_uri: cim:PssIEEE4B.vstmin
range: PU
required: false
multivalued: false
description: PSS output minimum limit (VSTmin) (<
PssIEEE4B.vstmax). Typical value = -0,15.
Pss1:
class_uri: cim:Pss1
is_a: PowerSystemStabilizerDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.PowerSystemStabilizerDynamics
description: Italian PSS with three inputs (speed, frequency, power).
attributes:
kf:
slot_uri: cim:Pss1.kf
range: float
required: false
multivalued: false
description: Frequency power input gain (KF). Typical
value = 5.
komega:
slot_uri: cim:Pss1.komega
range: float
required: false
multivalued: false
description: Shaft speed power input gain (Komega). Typical
value = 0.
kpe:
slot_uri: cim:Pss1.kpe
range: float
required: false
multivalued: false
description: Electric power input gain (KPE). Typical
value = 0,3.
ks:
slot_uri: cim:Pss1.ks
range: float
required: false
multivalued: false
description: PSS gain (Ks). Typical value = 1.
pmin:
slot_uri: cim:Pss1.pmin
range: PU
required: false
multivalued: false
description: Minimum power PSS enabling (Pmin). Typical value = 0,25.
t10:
slot_uri: cim:Pss1.t10
range: Seconds
required: false
multivalued: false
description: Lead/lag time constant (T10) (>=
0). Typical value = 0.
t5:
slot_uri: cim:Pss1.t5
range: Seconds
required: false
multivalued: false
description: Washout (T5) (>= 0). Typical value
= 3,5.
t6:
slot_uri: cim:Pss1.t6
range: Seconds
required: false
multivalued: false
description: Filter time constant (T6) (>= 0). Typical
value = 0.
t7:
slot_uri: cim:Pss1.t7
range: Seconds
required: false
multivalued: false
description: "Lead/lag time constant (T7) (>=\
\ 0). If = 0, both blocks are bypassed. Typical value = 0.\r\n"
t8:
slot_uri: cim:Pss1.t8
range: Seconds
required: false
multivalued: false
description: Lead/lag time constant (T8) (>= 0). Typical
value = 0.
t9:
slot_uri: cim:Pss1.t9
range: Seconds
required: false
multivalued: false
description: Lead/lag time constant (T9) (>= 0). If
= 0, both blocks are bypassed. Typical value = 0.
tpe:
slot_uri: cim:Pss1.tpe
range: Seconds
required: false
multivalued: false
description: Electric power filter time constant (TPE)
(>= 0). Typical value = 0,05.
vadat:
slot_uri: cim:Pss1.vadat
range: boolean
required: false
multivalued: false
description: "Signal selector (VADAT).\r\
\ntrue = closed (generator power is greater than\
\ Pmin)\r\nfalse = open (Pe\
\ is smaller than Pmin).\r\nTypical\
\ value = true."
vsmn:
slot_uri: cim:Pss1.vsmn
range: PU
required: false
multivalued: false
description: Stabilizer output maximum limit (VSMN). Typical
value = -0,06.
vsmx:
slot_uri: cim:Pss1.vsmx
range: PU
required: false
multivalued: false
description: Stabilizer output minimum limit (VSMX). Typical
value = 0,06.
Pss1A:
class_uri: cim:Pss1A
is_a: PowerSystemStabilizerDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.PowerSystemStabilizerDynamics
description: Single input power system stabilizer. It is a modified version in
order to allow representation of various vendors' implementations on PSS type
1A.
attributes:
a1:
slot_uri: cim:Pss1A.a1
range: PU
required: false
multivalued: false
description: Notch filter parameter (A1).
a2:
slot_uri: cim:Pss1A.a2
range: PU
required: false
multivalued: false
description: 'Notch filter parameter (A2). '
a3:
slot_uri: cim:Pss1A.a3
range: PU
required: false
multivalued: false
description: 'Notch filter parameter (A3). '
a4:
slot_uri: cim:Pss1A.a4
range: PU
required: false
multivalued: false
description: 'Notch filter parameter (A4). '
a5:
slot_uri: cim:Pss1A.a5
range: PU
required: false
multivalued: false
description: 'Notch filter parameter (A5). '
a6:
slot_uri: cim:Pss1A.a6
range: PU
required: false
multivalued: false
description: 'Notch filter parameter (A6). '
a7:
slot_uri: cim:Pss1A.a7
range: PU
required: false
multivalued: false
description: 'Notch filter parameter (A7). '
a8:
slot_uri: cim:Pss1A.a8
range: PU
required: false
multivalued: false
description: 'Notch filter parameter (A8). '
inputSignalType:
slot_uri: cim:Pss1A.inputSignalType
range: InputSignalKind
required: false
multivalued: false
description: Type of input signal (rotorAngularFrequencyDeviation, busFrequencyDeviation,
generatorElectricalPower, generatorAcceleratingPower, busVoltage, or busVoltageDerivative).
kd:
slot_uri: cim:Pss1A.kd
range: boolean
required: false
multivalued: false
description: "Selector (Kd). \r\ntrue = e-sTdelay used\r\
\nfalse = e-sTdelay not used."
ks:
slot_uri: cim:Pss1A.ks
range: PU
required: false
multivalued: false
description: 'Stabilizer gain (Ks). '
t1:
slot_uri: cim:Pss1A.t1
range: Seconds
required: false
multivalued: false
description: 'Lead/lag time constant (T1) (>=
0). '
t2:
slot_uri: cim:Pss1A.t2
range: Seconds
required: false
multivalued: false
description: 'Lead/lag time constant (T2) (>=
0). '
t3:
slot_uri: cim:Pss1A.t3
range: Seconds
required: false
multivalued: false
description: 'Lead/lag time constant (T3) (>=
0). '
t4:
slot_uri: cim:Pss1A.t4
range: Seconds
required: false
multivalued: false
description: 'Lead/lag time constant (T4) (>=
0). '
t5:
slot_uri: cim:Pss1A.t5
range: Seconds
required: false
multivalued: false
description: 'Washout time constant (T5) (>= 0). '
t6:
slot_uri: cim:Pss1A.t6
range: Seconds
required: false
multivalued: false
description: 'Transducer time constant (T6) (>=
0). '
tdelay:
slot_uri: cim:Pss1A.tdelay
range: Seconds
required: false
multivalued: false
description: 'Time constant (Tdelay) (>= 0). '
vcl:
slot_uri: cim:Pss1A.vcl
range: PU
required: false
multivalued: false
description: 'Stabilizer input cutoff threshold (Vcl). '
vcu:
slot_uri: cim:Pss1A.vcu
range: PU
required: false
multivalued: false
description: 'Stabilizer input cutoff threshold (Vcu). '
vrmax:
slot_uri: cim:Pss1A.vrmax
range: PU
required: false
multivalued: false
description: 'Maximum stabilizer output (Vrmax) (> Pss1A.vrmin). '
vrmin:
slot_uri: cim:Pss1A.vrmin
range: PU
required: false
multivalued: false
description: 'Minimum stabilizer output (Vrmin) (< Pss1A.vrmax). '
Pss2B:
class_uri: cim:Pss2B
is_a: PowerSystemStabilizerDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.PowerSystemStabilizerDynamics
description: Modified IEEE PSS2B. Extra lead/lag (or rate) block added at end
(up to 4 lead/lags total).
attributes:
a:
slot_uri: cim:Pss2B.a
range: float
required: false
multivalued: false
description: Numerator constant (a). Typical value = 1.
ks1:
slot_uri: cim:Pss2B.ks1
range: PU
required: false
multivalued: false
description: Stabilizer gain (Ks1). Typical value = 12.
ks2:
slot_uri: cim:Pss2B.ks2
range: PU
required: false
multivalued: false
description: 'Gain on signal #2 (Ks2). Typical value = 0,2.'
ks3:
slot_uri: cim:Pss2B.ks3
range: PU
required: false
multivalued: false
description: 'Gain on signal #2 input before ramp-tracking filter (Ks3). Typical
value = 1.'
ks4:
slot_uri: cim:Pss2B.ks4
range: PU
required: false
multivalued: false
description: 'Gain on signal #2 input after ramp-tracking filter (Ks4). Typical
value = 1.'
m:
slot_uri: cim:Pss2B.m
range: integer
required: false
multivalued: false
description: Denominator order of ramp tracking filter (m). Typical
value = 5.
n:
slot_uri: cim:Pss2B.n
range: integer
required: false
multivalued: false
description: Order of ramp tracking filter (n). Typical value = 1.
t1:
slot_uri: cim:Pss2B.t1
range: Seconds
required: false
multivalued: false
description: Lead/lag time constant (T1) (>= 0). Typical
value = 0,12.
t10:
slot_uri: cim:Pss2B.t10
range: Seconds
required: false
multivalued: false
description: Lead/lag time constant (T10) (>=
0). Typical value = 0.
t11:
slot_uri: cim:Pss2B.t11
range: Seconds
required: false
multivalued: false
description: Lead/lag time constant (T11) (>=
0). Typical value = 0.
t2:
slot_uri: cim:Pss2B.t2
range: Seconds
required: false
multivalued: false
description: Lead/lag time constant (T2) (>= 0). Typical
value = 0,02.
t3:
slot_uri: cim:Pss2B.t3
range: Seconds
required: false
multivalued: false
description: Lead/lag time constant (T3) (>= 0). Typical
value = 0,3.
t4:
slot_uri: cim:Pss2B.t4
range: Seconds
required: false
multivalued: false
description: Lead/lag time constant (T4) (>= 0). Typical
value = 0,02.
t6:
slot_uri: cim:Pss2B.t6
range: Seconds
required: false
multivalued: false
description: 'Time constant on signal #1 (T6) (>=
0). Typical value = 0.'
t7:
slot_uri: cim:Pss2B.t7
range: Seconds
required: false
multivalued: false
description: 'Time constant on signal #2 (T7) (>=
0). Typical value = 2.'
t8:
slot_uri: cim:Pss2B.t8
range: Seconds
required: false
multivalued: false
description: Lead of ramp tracking filter (T8) (>=
0). Typical value = 0,2.
t9:
slot_uri: cim:Pss2B.t9
range: Seconds
required: false
multivalued: false
description: Lag of ramp tracking filter (T9) (>=
0). Typical value = 0,1.
ta:
slot_uri: cim:Pss2B.ta
range: Seconds
required: false
multivalued: false
description: Lead constant (Ta) (>= 0). Typical
value = 0.
tb:
slot_uri: cim:Pss2B.tb
range: Seconds
required: false
multivalued: false
description: Lag time constant (Tb) (>= 0). Typical
value = 0.
tw1:
slot_uri: cim:Pss2B.tw1
range: Seconds
required: false
multivalued: false
description: 'First washout on signal #1 (Tw1) (>=
0). Typical value = 2.'
tw2:
slot_uri: cim:Pss2B.tw2
range: Seconds
required: false
multivalued: false
description: 'Second washout on signal #1 (Tw2) (>=
0). Typical value = 2.'
tw3:
slot_uri: cim:Pss2B.tw3
range: Seconds
required: false
multivalued: false
description: 'First washout on signal #2 (Tw3) (>=
0). Typical value = 2.'
tw4:
slot_uri: cim:Pss2B.tw4
range: Seconds
required: false
multivalued: false
description: 'Second washout on signal #2 (Tw4) (>=
0). Typical value = 0.'
vsi1max:
slot_uri: cim:Pss2B.vsi1max
range: PU
required: false
multivalued: false
description: 'Input signal #1 maximum limit (Vsi1max) (> Pss2B.vsi1min). Typical
value = 2.'
vsi1min:
slot_uri: cim:Pss2B.vsi1min
range: PU
required: false
multivalued: false
description: 'Input signal #1 minimum limit (Vsi1min) (< Pss2B.vsi1max). Typical
value = -2.'
vsi2max:
slot_uri: cim:Pss2B.vsi2max
range: PU
required: false
multivalued: false
description: 'Input signal #2 maximum limit (Vsi2max) (> Pss2B.vsi2min). Typical
value = 2.'
vsi2min:
slot_uri: cim:Pss2B.vsi2min
range: PU
required: false
multivalued: false
description: 'Input signal #2 minimum limit (Vsi2min) (< Pss2B.vsi2max). Typical
value = -2.'
vstmax:
slot_uri: cim:Pss2B.vstmax
range: PU
required: false
multivalued: false
description: Stabilizer output maximum limit (Vstmax) (> Pss2B.vstmin). Typical
value = 0,1.
vstmin:
slot_uri: cim:Pss2B.vstmin
range: PU
required: false
multivalued: false
description: Stabilizer output minimum limit (Vstmin) (< Pss2B.vstmax). Typical
value = -0,1.
Pss2ST:
class_uri: cim:Pss2ST
is_a: PowerSystemStabilizerDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.PowerSystemStabilizerDynamics
description: PTI microprocessor-based stabilizer type 1.
attributes:
inputSignal1Type:
slot_uri: cim:Pss2ST.inputSignal1Type
range: InputSignalKind
required: false
multivalued: false
description: 'Type of input signal #1 (rotorAngularFrequencyDeviation, busFrequencyDeviation,
generatorElectricalPower, generatorAcceleratingPower, busVoltage, or busVoltageDerivative
- shall be different than Pss2ST.inputSignal2Type). Typical value = rotorAngularFrequencyDeviation.'
inputSignal2Type:
slot_uri: cim:Pss2ST.inputSignal2Type
range: InputSignalKind
required: false
multivalued: false
description: 'Type of input signal #2 (rotorAngularFrequencyDeviation, busFrequencyDeviation,
generatorElectricalPower, generatorAcceleratingPower, busVoltage, or busVoltageDerivative
- shall be different than Pss2ST.inputSignal1Type). Typical value = busVoltageDerivative.'
k1:
slot_uri: cim:Pss2ST.k1
range: PU
required: false
multivalued: false
description: 'Gain (K1). '
k2:
slot_uri: cim:Pss2ST.k2
range: PU
required: false
multivalued: false
description: 'Gain (K2). '
lsmax:
slot_uri: cim:Pss2ST.lsmax
range: PU
required: false
multivalued: false
description: 'Limiter (LSMAX) (> Pss2ST.lsmin). '
lsmin:
slot_uri: cim:Pss2ST.lsmin
range: PU
required: false
multivalued: false
description: 'Limiter (LSMIN) (< Pss2ST.lsmax). '
t1:
slot_uri: cim:Pss2ST.t1
range: Seconds
required: false
multivalued: false
description: 'Time constant (T1) (>= 0). '
t10:
slot_uri: cim:Pss2ST.t10
range: Seconds
required: false
multivalued: false
description: 'Time constant (T10) (>= 0). '
t2:
slot_uri: cim:Pss2ST.t2
range: Seconds
required: false
multivalued: false
description: Time constant (T2) (>= 0).
t3:
slot_uri: cim:Pss2ST.t3
range: Seconds
required: false
multivalued: false
description: 'Time constant (T3) (>= 0). '
t4:
slot_uri: cim:Pss2ST.t4
range: Seconds
required: false
multivalued: false
description: Time constant (T4) (>= 0).
t5:
slot_uri: cim:Pss2ST.t5
range: Seconds
required: false
multivalued: false
description: 'Time constant (T5) (>= 0). '
t6:
slot_uri: cim:Pss2ST.t6
range: Seconds
required: false
multivalued: false
description: 'Time constant (T6) (>= 0). '
t7:
slot_uri: cim:Pss2ST.t7
range: Seconds
required: false
multivalued: false
description: 'Time constant (T7) (>= 0). '
t8:
slot_uri: cim:Pss2ST.t8
range: Seconds
required: false
multivalued: false
description: 'Time constant (T8) (>= 0). '
t9:
slot_uri: cim:Pss2ST.t9
range: Seconds
required: false
multivalued: false
description: 'Time constant (T9) (>= 0). '
vcl:
slot_uri: cim:Pss2ST.vcl
range: PU
required: false
multivalued: false
description: 'Cutoff limiter (VCL). '
vcu:
slot_uri: cim:Pss2ST.vcu
range: PU
required: false
multivalued: false
description: 'Cutoff limiter (VCU). '
Pss5:
class_uri: cim:Pss5
is_a: PowerSystemStabilizerDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.PowerSystemStabilizerDynamics
description: Detailed Italian PSS.
attributes:
ctw2:
slot_uri: cim:Pss5.ctw2
range: boolean
required: false
multivalued: false
description: "Selector for second washout enabling (CTW2).\r\
\ntrue = second washout filter is bypassed\r\nfalse = second washout filter\
\ in use.\r\nTypical value = true."
deadband:
slot_uri: cim:Pss5.deadband
range: PU
required: false
multivalued: false
description: Stabilizer output deadband (DEADBAND). Typical value
= 0.
isfreq:
slot_uri: cim:Pss5.isfreq
range: boolean
required: false
multivalued: false
description: "Selector for frequency/shaft speed input (isFreq).\r\n\
true = speed (same meaning as InputSignaKind.rotorSpeed)\r\nfalse = frequency\
\ (same meaning as InputSignalKind.busFrequency).\r\nTypical value = true\
\ (same meaning as InputSignalKind.rotorSpeed)."
kf:
slot_uri: cim:Pss5.kf
range: float
required: false
multivalued: false
description: Frequency/shaft speed input gain (KF). Typical
value = 5.
kpe:
slot_uri: cim:Pss5.kpe
range: float
required: false
multivalued: false
description: Electric power input gain (KPE). Typical
value = 0,3.
kpss:
slot_uri: cim:Pss5.kpss
range: float
required: false
multivalued: false
description: PSS gain (KPSS). Typical value = 1.
pmin:
slot_uri: cim:Pss5.pmin
range: PU
required: false
multivalued: false
description: Minimum power PSS enabling (Pmin). Typical value = 0,25.
tl1:
slot_uri: cim:Pss5.tl1
range: Seconds
required: false
multivalued: false
description: Lead/lag time constant (TL1) (>=
0). Typical value = 0.
tl2:
slot_uri: cim:Pss5.tl2
range: Seconds
required: false
multivalued: false
description: "Lead/lag time constant (TL2) (>=\
\ 0). If = 0, both blocks are bypassed. Typical value = 0.\r\n"
tl3:
slot_uri: cim:Pss5.tl3
range: Seconds
required: false
multivalued: false
description: Lead/lag time constant (TL3) (>=
0). Typical value = 0.
tl4:
slot_uri: cim:Pss5.tl4
range: Seconds
required: false
multivalued: false
description: Lead/lag time constant (TL4) (>= 0). If = 0, both
blocks are bypassed. Typical value = 0.
tpe:
slot_uri: cim:Pss5.tpe
range: Seconds
required: false
multivalued: false
description: Electric power filter time constant (TPE)
(>= 0). Typical value = 0,05.
tw1:
slot_uri: cim:Pss5.tw1
range: Seconds
required: false
multivalued: false
description: First washout (TW1) (>= 0). Typical
value = 3,5.
tw2:
slot_uri: cim:Pss5.tw2
range: Seconds
required: false
multivalued: false
description: Second washout (TW2) (>= 0). Typical
value = 0.
vadat:
slot_uri: cim:Pss5.vadat
range: boolean
required: false
multivalued: false
description: "Signal selector (VadAtt).\r\
\ntrue = closed (generator power is greater than\
\ Pmin)\r\nfalse = open (Pe\
\ is smaller than Pmin).\r\nTypical\
\ value = true."
vsmn:
slot_uri: cim:Pss5.vsmn
range: PU
required: false
multivalued: false
description: Stabilizer output maximum limit (VSMN). Typical
value = -0,1.
vsmx:
slot_uri: cim:Pss5.vsmx
range: PU
required: false
multivalued: false
description: Stabilizer output minimum limit (VSMX). Typical
value = 0,1.
PssELIN2:
class_uri: cim:PssELIN2
is_a: PowerSystemStabilizerDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.PowerSystemStabilizerDynamics
description: Power system stabilizer typically associated with ExcELIN2 (though
PssIEEE2B or Pss2B can also be used).
attributes:
apss:
slot_uri: cim:PssELIN2.apss
range: PU
required: false
multivalued: false
description: Coefficient (a_PSS). Typical value = 0,1.
ks1:
slot_uri: cim:PssELIN2.ks1
range: PU
required: false
multivalued: false
description: Gain (Ks1). Typical value = 1.
ks2:
slot_uri: cim:PssELIN2.ks2
range: PU
required: false
multivalued: false
description: Gain (Ks2). Typical value = 0,1.
ppss:
slot_uri: cim:PssELIN2.ppss
range: PU
required: false
multivalued: false
description: Coefficient (p_PSS) (>= 0 and <= 4). Typical value
= 0,1.
psslim:
slot_uri: cim:PssELIN2.psslim
range: PU
required: false
multivalued: false
description: PSS limiter (psslim). Typical value = 0,1.
ts1:
slot_uri: cim:PssELIN2.ts1
range: Seconds
required: false
multivalued: false
description: Time constant (Ts1) (>= 0). Typical value = 0.
ts2:
slot_uri: cim:PssELIN2.ts2
range: Seconds
required: false
multivalued: false
description: Time constant (Ts2) (>= 0). Typical value = 1.
ts3:
slot_uri: cim:PssELIN2.ts3
range: Seconds
required: false
multivalued: false
description: Time constant (Ts3) (>= 0). Typical value = 1.
ts4:
slot_uri: cim:PssELIN2.ts4
range: Seconds
required: false
multivalued: false
description: Time constant (Ts4) (>= 0). Typical value = 0,1.
ts5:
slot_uri: cim:PssELIN2.ts5
range: Seconds
required: false
multivalued: false
description: Time constant (Ts5) (>= 0). Typical value = 0.
ts6:
slot_uri: cim:PssELIN2.ts6
range: Seconds
required: false
multivalued: false
description: Time constant (Ts6) (>= 0). Typical value = 1.
PssPTIST1:
class_uri: cim:PssPTIST1
is_a: PowerSystemStabilizerDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.PowerSystemStabilizerDynamics
description: PTI microprocessor-based stabilizer type 1.
attributes:
dtc:
slot_uri: cim:PssPTIST1.dtc
range: Seconds
required: false
multivalued: false
description: Time step related to activation of controls (deltatc)
(>= 0). Typical value = 0,025.
dtf:
slot_uri: cim:PssPTIST1.dtf
range: Seconds
required: false
multivalued: false
description: Time step frequency calculation (deltatf) (>= 0). Typical
value = 0,025.
dtp:
slot_uri: cim:PssPTIST1.dtp
range: Seconds
required: false
multivalued: false
description: Time step active power calculation (deltatp) (>= 0). Typical
value = 0,0125.
k:
slot_uri: cim:PssPTIST1.k
range: PU
required: false
multivalued: false
description: Gain (K). Typical value = 9.
m:
slot_uri: cim:PssPTIST1.m
range: PU
required: false
multivalued: false
description: (M). M = 2 x H. Typical value = 5.
t1:
slot_uri: cim:PssPTIST1.t1
range: Seconds
required: false
multivalued: false
description: Time constant (T1) (>= 0). Typical value = 0,3.
t2:
slot_uri: cim:PssPTIST1.t2
range: Seconds
required: false
multivalued: false
description: Time constant (T2) (>= 0). Typical value = 1.
t3:
slot_uri: cim:PssPTIST1.t3
range: Seconds
required: false
multivalued: false
description: Time constant (T3) (>= 0). Typical value = 0,2.
t4:
slot_uri: cim:PssPTIST1.t4
range: Seconds
required: false
multivalued: false
description: Time constant (T4) (>= 0). Typical value = 0,05.
tf:
slot_uri: cim:PssPTIST1.tf
range: Seconds
required: false
multivalued: false
description: Time constant (Tf) (>= 0). Typical value = 0,2.
tp:
slot_uri: cim:PssPTIST1.tp
range: Seconds
required: false
multivalued: false
description: Time constant (Tp) (>= 0). Typical value = 0,2.
PssPTIST3:
class_uri: cim:PssPTIST3
is_a: PowerSystemStabilizerDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.PowerSystemStabilizerDynamics
description: PTI microprocessor-based stabilizer type 3.
attributes:
a0:
slot_uri: cim:PssPTIST3.a0
range: PU
required: false
multivalued: false
description: 'Filter coefficient (A0). '
a1:
slot_uri: cim:PssPTIST3.a1
range: PU
required: false
multivalued: false
description: 'Limiter (Al). '
a2:
slot_uri: cim:PssPTIST3.a2
range: PU
required: false
multivalued: false
description: 'Filter coefficient (A2). '
a3:
slot_uri: cim:PssPTIST3.a3
range: PU
required: false
multivalued: false
description: 'Filter coefficient (A3). '
a4:
slot_uri: cim:PssPTIST3.a4
range: PU
required: false
multivalued: false
description: 'Filter coefficient (A4). '
a5:
slot_uri: cim:PssPTIST3.a5
range: PU
required: false
multivalued: false
description: 'Filter coefficient (A5). '
al:
slot_uri: cim:PssPTIST3.al
range: PU
required: false
multivalued: false
description: Limiter (Al).
athres:
slot_uri: cim:PssPTIST3.athres
range: PU
required: false
multivalued: false
description: Threshold value above which output averaging will be bypassed
(Athres). Typical value = 0,005.
b0:
slot_uri: cim:PssPTIST3.b0
range: PU
required: false
multivalued: false
description: 'Filter coefficient (B0). '
b1:
slot_uri: cim:PssPTIST3.b1
range: PU
required: false
multivalued: false
description: 'Filter coefficient (B1). '
b2:
slot_uri: cim:PssPTIST3.b2
range: PU
required: false
multivalued: false
description: 'Filter coefficient (B2). '
b3:
slot_uri: cim:PssPTIST3.b3
range: PU
required: false
multivalued: false
description: 'Filter coefficient (B3). '
b4:
slot_uri: cim:PssPTIST3.b4
range: PU
required: false
multivalued: false
description: 'Filter coefficient (B4). '
b5:
slot_uri: cim:PssPTIST3.b5
range: PU
required: false
multivalued: false
description: 'Filter coefficient (B5). '
dl:
slot_uri: cim:PssPTIST3.dl
range: PU
required: false
multivalued: false
description: 'Limiter (Dl). '
dtc:
slot_uri: cim:PssPTIST3.dtc
range: Seconds
required: false
multivalued: false
description: Time step related to activation of controls (deltatc)
(>= 0). Typical value = 0,025 (0,03 for 50 Hz).
dtf:
slot_uri: cim:PssPTIST3.dtf
range: Seconds
required: false
multivalued: false
description: Time step frequency calculation (deltatf) (>= 0). Typical
value = 0,025 (0,03 for 50 Hz).
dtp:
slot_uri: cim:PssPTIST3.dtp
range: Seconds
required: false
multivalued: false
description: Time step active power calculation (deltatp) (>= 0). Typical
value = 0,0125 (0,015 for 50 Hz).
isw:
slot_uri: cim:PssPTIST3.isw
range: boolean
required: false
multivalued: false
description: "Digital/analogue output switch (Isw).\r\ntrue = produce\
\ analogue output\r\nfalse = convert to digital output, using tap selection\
\ table. "
k:
slot_uri: cim:PssPTIST3.k
range: PU
required: false
multivalued: false
description: Gain (K). Typical value = 9.
lthres:
slot_uri: cim:PssPTIST3.lthres
range: PU
required: false
multivalued: false
description: Threshold value (Lthres).
m:
slot_uri: cim:PssPTIST3.m
range: PU
required: false
multivalued: false
description: (M). M = 2 x H. Typical value = 5.
nav:
slot_uri: cim:PssPTIST3.nav
range: float
required: false
multivalued: false
description: Number of control outputs to average (NAV) (1 <= NAV
<= 16). Typical value = 4.
ncl:
slot_uri: cim:PssPTIST3.ncl
range: float
required: false
multivalued: false
description: 'Number of counts at limit to active limit function (NCL)
(> 0). '
ncr:
slot_uri: cim:PssPTIST3.ncr
range: float
required: false
multivalued: false
description: 'Number of counts until reset after limit function is triggered
(NCR). '
pmin:
slot_uri: cim:PssPTIST3.pmin
range: PU
required: false
multivalued: false
description: (Pmin).
t1:
slot_uri: cim:PssPTIST3.t1
range: Seconds
required: false
multivalued: false
description: Time constant (T1) (>= 0). Typical value = 0,3.
t2:
slot_uri: cim:PssPTIST3.t2
range: Seconds
required: false
multivalued: false
description: Time constant (T2) (>= 0). Typical value = 1.
t3:
slot_uri: cim:PssPTIST3.t3
range: Seconds
required: false
multivalued: false
description: Time constant (T3) (>= 0). Typical value = 0,2.
t4:
slot_uri: cim:PssPTIST3.t4
range: Seconds
required: false
multivalued: false
description: Time constant (T4) (>= 0). Typical value = 0,05.
t5:
slot_uri: cim:PssPTIST3.t5
range: Seconds
required: false
multivalued: false
description: 'Time constant (T5) (>= 0). '
t6:
slot_uri: cim:PssPTIST3.t6
range: Seconds
required: false
multivalued: false
description: 'Time constant (T6) (>= 0). '
tf:
slot_uri: cim:PssPTIST3.tf
range: Seconds
required: false
multivalued: false
description: Time constant (Tf) (>= 0). Typical value = 0,2.
tp:
slot_uri: cim:PssPTIST3.tp
range: Seconds
required: false
multivalued: false
description: Time constant (Tp) (>= 0). Typical value = 0,2.
PssRQB:
class_uri: cim:PssRQB
is_a: PowerSystemStabilizerDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.PowerSystemStabilizerDynamics
description: Power system stabilizer type RQB. This power system stabilizer is
intended to be used together with excitation system type ExcRQB, which is primarily
used in nuclear or thermal generating units.
attributes:
kdpm:
slot_uri: cim:PssRQB.kdpm
range: float
required: false
multivalued: false
description: Lead lag gain (KDPM). Typical value = 0,185.
ki2:
slot_uri: cim:PssRQB.ki2
range: float
required: false
multivalued: false
description: Speed input gain (Ki2). Typical value = 3,43.
ki3:
slot_uri: cim:PssRQB.ki3
range: float
required: false
multivalued: false
description: Electrical power input gain (Ki3). Typical value = -11,45.
ki4:
slot_uri: cim:PssRQB.ki4
range: float
required: false
multivalued: false
description: Mechanical power input gain (Ki4). Typical value = 11,86.
sibv:
slot_uri: cim:PssRQB.sibv
range: PU
required: false
multivalued: false
description: Speed deadband (SIBV). Typical value = 0,006.
t4f:
slot_uri: cim:PssRQB.t4f
range: Seconds
required: false
multivalued: false
description: Lead lag time constant (T4F) (>= 0). Typical value
= 0,045.
t4m:
slot_uri: cim:PssRQB.t4m
range: Seconds
required: false
multivalued: false
description: Input time constant (T4M) (>= 0). Typical value = 5.
t4mom:
slot_uri: cim:PssRQB.t4mom
range: Seconds
required: false
multivalued: false
description: Speed time constant (T4MOM) (>= 0). Typical value =
1,27.
tomd:
slot_uri: cim:PssRQB.tomd
range: Seconds
required: false
multivalued: false
description: Speed delay (TOMD) (>= 0). Typical value = 0,02.
tomsl:
slot_uri: cim:PssRQB.tomsl
range: Seconds
required: false
multivalued: false
description: Speed time constant (TOMSL) (>= 0). Typical value =
0,04.
PssSB4:
class_uri: cim:PssSB4
is_a: PowerSystemStabilizerDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.PowerSystemStabilizerDynamics
description: Power sensitive stabilizer model.
attributes:
kx:
slot_uri: cim:PssSB4.kx
range: PU
required: false
multivalued: false
description: Gain (Kx). Typical value = 2,7.
ta:
slot_uri: cim:PssSB4.ta
range: Seconds
required: false
multivalued: false
description: Time constant (Ta) (>= 0). Typical value = 0,37.
tb:
slot_uri: cim:PssSB4.tb
range: Seconds
required: false
multivalued: false
description: Time constant (Tb) (>= 0). Typical value = 0,37.
tc:
slot_uri: cim:PssSB4.tc
range: Seconds
required: false
multivalued: false
description: Time constant (Tc) (>= 0). Typical value = 0,035.
td:
slot_uri: cim:PssSB4.td
range: Seconds
required: false
multivalued: false
description: Time constant (Td) (>= 0). Typical value = 0,0.
te:
slot_uri: cim:PssSB4.te
range: Seconds
required: false
multivalued: false
description: Time constant (Te) (>= 0). Typical value = 0,0169.
tt:
slot_uri: cim:PssSB4.tt
range: Seconds
required: false
multivalued: false
description: Time constant (Tt) (>= 0). Typical value = 0,18.
tx1:
slot_uri: cim:PssSB4.tx1
range: Seconds
required: false
multivalued: false
description: Reset time constant (Tx1) (>= 0). Typical value =
0,035.
tx2:
slot_uri: cim:PssSB4.tx2
range: Seconds
required: false
multivalued: false
description: Time constant (Tx2) (>= 0). Typical value = 5,0.
vsmax:
slot_uri: cim:PssSB4.vsmax
range: PU
required: false
multivalued: false
description: Limiter (Vsmax) (> PssSB4.vsmin). Typical value =
0,062.
vsmin:
slot_uri: cim:PssSB4.vsmin
range: PU
required: false
multivalued: false
description: Limiter (Vsmin) (< PssSB4.vsmax). Typical value =
-0,062.
PssSH:
class_uri: cim:PssSH
is_a: PowerSystemStabilizerDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.PowerSystemStabilizerDynamics
description: "SiemensTM \u201CH infinity\u201D power system stabilizer\
\ with generator electrical power input.\r\n[Footnote: Siemens \"H infinity\"\
\ power system stabilizers are an example of suitable products available commercially.\
\ This information is given for the convenience of users of this document and\
\ does not constitute an endorsement by IEC of these products.] \r\n"
attributes:
k:
slot_uri: cim:PssSH.k
range: PU
required: false
multivalued: false
description: Main gain (K). Typical value = 1.
k0:
slot_uri: cim:PssSH.k0
range: PU
required: false
multivalued: false
description: Gain 0 (K0). Typical value = 0,012.
k1:
slot_uri: cim:PssSH.k1
range: PU
required: false
multivalued: false
description: Gain 1 (K1). Typical value = 0,488.
k2:
slot_uri: cim:PssSH.k2
range: PU
required: false
multivalued: false
description: Gain 2 (K2). Typical value = 0,064.
k3:
slot_uri: cim:PssSH.k3
range: PU
required: false
multivalued: false
description: Gain 3 (K3). Typical value = 0,224.
k4:
slot_uri: cim:PssSH.k4
range: PU
required: false
multivalued: false
description: Gain 4 (K4). Typical value = 0,1.
t1:
slot_uri: cim:PssSH.t1
range: Seconds
required: false
multivalued: false
description: Time constant 1 (T1) (> 0). Typical value = 0,076.
t2:
slot_uri: cim:PssSH.t2
range: Seconds
required: false
multivalued: false
description: Time constant 2 (T2) (> 0). Typical value = 0,086.
t3:
slot_uri: cim:PssSH.t3
range: Seconds
required: false
multivalued: false
description: Time constant 3 (T3) (> 0). Typical value = 1,068.
t4:
slot_uri: cim:PssSH.t4
range: Seconds
required: false
multivalued: false
description: Time constant 4 (T4) (> 0). Typical value = 1,913.
td:
slot_uri: cim:PssSH.td
range: Seconds
required: false
multivalued: false
description: Input time constant (Td) (>= 0). Typical
value = 10.
vsmax:
slot_uri: cim:PssSH.vsmax
range: PU
required: false
multivalued: false
description: Output maximum limit (Vsmax) (> PssSH.vsmin). Typical
value = 0,1.
vsmin:
slot_uri: cim:PssSH.vsmin
range: PU
required: false
multivalued: false
description: Output minimum limit (Vsmin) (< PssSH.vsmax). Typical
value = -0,1.
PssSK:
class_uri: cim:PssSK
is_a: PowerSystemStabilizerDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.PowerSystemStabilizerDynamics
description: Slovakian PSS with three inputs.
attributes:
k1:
slot_uri: cim:PssSK.k1
range: PU
required: false
multivalued: false
description: Gain P (K1). Typical value =
-0,3.
k2:
slot_uri: cim:PssSK.k2
range: PU
required: false
multivalued: false
description: Gain fE (K2). Typical
value = -0,15.
k3:
slot_uri: cim:PssSK.k3
range: PU
required: false
multivalued: false
description: Gain If (K3). Typical
value = 10.
t1:
slot_uri: cim:PssSK.t1
range: Seconds
required: false
multivalued: false
description: Denominator time constant (T1) (>
0,005). Typical value = 0,3.
t2:
slot_uri: cim:PssSK.t2
range: Seconds
required: false
multivalued: false
description: Filter time constant (T2) (> 0,005). Typical
value = 0,35.
t3:
slot_uri: cim:PssSK.t3
range: Seconds
required: false
multivalued: false
description: Denominator time constant (T3) (>
0,005). Typical value = 0,22.
t4:
slot_uri: cim:PssSK.t4
range: Seconds
required: false
multivalued: false
description: Filter time constant (T4) (> 0,005). Typical
value = 0,02.
t5:
slot_uri: cim:PssSK.t5
range: Seconds
required: false
multivalued: false
description: Denominator time constant (T5) (>
0,005). Typical value = 0,02.
t6:
slot_uri: cim:PssSK.t6
range: Seconds
required: false
multivalued: false
description: Filter time constant (T6) (> 0,005). Typical
value = 0,02.
vsmax:
slot_uri: cim:PssSK.vsmax
range: PU
required: false
multivalued: false
description: Stabilizer output maximum limit (VSMAX)
(> PssSK.vsmin). Typical value = 0,4.
vsmin:
slot_uri: cim:PssSK.vsmin
range: PU
required: false
multivalued: false
description: Stabilizer output minimum limit (VSMIN)
(< PssSK.vsmax). Typical value = -0.4.
PssSTAB2A:
class_uri: cim:PssSTAB2A
is_a: PowerSystemStabilizerDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.PowerSystemStabilizerDynamics
description: "Power system stabilizer part of an ABB excitation system.\r\n[Footnote:\
\ ABB excitation systems are an example of suitable products available commercially.\
\ This information is given for the convenience of users of this document and\
\ does not constitute an endorsement by IEC of these products.]\r\n"
attributes:
hlim:
slot_uri: cim:PssSTAB2A.hlim
range: PU
required: false
multivalued: false
description: Stabilizer output limiter (HLIM). Typical
value = 0,5.
k2:
slot_uri: cim:PssSTAB2A.k2
range: PU
required: false
multivalued: false
description: Gain (K2). Typical value = 1,0.
k3:
slot_uri: cim:PssSTAB2A.k3
range: PU
required: false
multivalued: false
description: Gain (K3). Typical value = 0,25.
k4:
slot_uri: cim:PssSTAB2A.k4
range: PU
required: false
multivalued: false
description: Gain (K4). Typical value = 0,075.
k5:
slot_uri: cim:PssSTAB2A.k5
range: PU
required: false
multivalued: false
description: Gain (K5). Typical value = 2,5.
t2:
slot_uri: cim:PssSTAB2A.t2
range: Seconds
required: false
multivalued: false
description: Time constant (T2). Typical value = 4,0.
t3:
slot_uri: cim:PssSTAB2A.t3
range: Seconds
required: false
multivalued: false
description: Time constant (T3). Typical value = 2,0.
t5:
slot_uri: cim:PssSTAB2A.t5
range: Seconds
required: false
multivalued: false
description: Time constant (T5). Typical value = 4,5.
PssWECC:
class_uri: cim:PssWECC
is_a: PowerSystemStabilizerDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.PowerSystemStabilizerDynamics
description: Dual input power system stabilizer, based on IEEE type 2, with modified
output limiter defined by WECC (Western Electricity Coordinating Council, USA).
attributes:
inputSignal1Type:
slot_uri: cim:PssWECC.inputSignal1Type
range: InputSignalKind
required: false
multivalued: false
description: 'Type of input signal #1 (rotorAngularFrequencyDeviation, busFrequencyDeviation,
generatorElectricalPower, generatorAcceleratingPower, busVoltage, or busVoltageDerivative
- shall be different than PssWECC.inputSignal2Type). Typical value = rotorAngularFrequencyDeviation.'
inputSignal2Type:
slot_uri: cim:PssWECC.inputSignal2Type
range: InputSignalKind
required: false
multivalued: false
description: 'Type of input signal #2 (rotorAngularFrequencyDeviation, busFrequencyDeviation,
generatorElectricalPower, generatorAcceleratingPower, busVoltage, busVoltageDerivative
- shall be different than PssWECC.inputSignal1Type). Typical value = busVoltageDerivative.'
k1:
slot_uri: cim:PssWECC.k1
range: PU
required: false
multivalued: false
description: 'Input signal 1 gain (K1). Typical
value = 1,13. '
k2:
slot_uri: cim:PssWECC.k2
range: PU
required: false
multivalued: false
description: Input signal 2 gain (K2). Typical value
= 0,0.
t1:
slot_uri: cim:PssWECC.t1
range: Seconds
required: false
multivalued: false
description: Input signal 1 transducer time constant (T1)
(>= 0). Typical value = 0,037.
t10:
slot_uri: cim:PssWECC.t10
range: Seconds
required: false
multivalued: false
description: Lag time constant (T10) (>= 0). Typical
value = 0.
t2:
slot_uri: cim:PssWECC.t2
range: Seconds
required: false
multivalued: false
description: Input signal 2 transducer time constant (T2)
(>= 0). Typical value = 0,0.
t3:
slot_uri: cim:PssWECC.t3
range: Seconds
required: false
multivalued: false
description: Stabilizer washout time constant (T3)
(>= 0). Typical value = 9,5.
t4:
slot_uri: cim:PssWECC.t4
range: Seconds
required: false
multivalued: false
description: Stabilizer washout time lag constant (T4)
(>= 0). Typical value = 9,5.
t5:
slot_uri: cim:PssWECC.t5
range: Seconds
required: false
multivalued: false
description: Lead time constant (T5) (>= 0). Typical
value = 1,7.
t6:
slot_uri: cim:PssWECC.t6
range: Seconds
required: false
multivalued: false
description: Lag time constant (T6) (>= 0). Typical
value = 1,5.
t7:
slot_uri: cim:PssWECC.t7
range: Seconds
required: false
multivalued: false
description: Lead time constant (T7) (>= 0). Typical
value = 1,7.
t8:
slot_uri: cim:PssWECC.t8
range: Seconds
required: false
multivalued: false
description: Lag time constant (T8) (>= 0). Typical
value = 1,5.
t9:
slot_uri: cim:PssWECC.t9
range: Seconds
required: false
multivalued: false
description: Lead time constant (T9) (>= 0). Typical
value = 0.
vcl:
slot_uri: cim:PssWECC.vcl
range: PU
required: false
multivalued: false
description: Minimum value for voltage compensator output (VCL).
Typical value = 0.
vcu:
slot_uri: cim:PssWECC.vcu
range: PU
required: false
multivalued: false
description: Maximum value for voltage compensator output (VCU).
Typical value = 0.
vsmax:
slot_uri: cim:PssWECC.vsmax
range: PU
required: false
multivalued: false
description: "Maximum output signal (Vsmax) (> PssWECC.vsmin). Typical\
\ value = 0,05.\r\n"
vsmin:
slot_uri: cim:PssWECC.vsmin
range: PU
required: false
multivalued: false
description: Minimum output signal (Vsmin) (< PssWECC.vsmax). Typical
value = -0,05.
DiscExcContIEEEDEC1A:
class_uri: cim:DiscExcContIEEEDEC1A
is_a: DiscontinuousExcitationControlDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.DiscontinuousExcitationControlDynamics
description: "IEEE type DEC1A discontinuous excitation control model that boosts\
\ generator excitation to a level higher than that demanded by the voltage regulator\
\ and stabilizer immediately following a system fault.\r\nReference: IEEE 421.5-2005,\
\ 12.2. "
attributes:
esc:
slot_uri: cim:DiscExcContIEEEDEC1A.esc
range: PU
required: false
multivalued: false
description: Speed change reference (ESC). Typical
value = 0,0015.
kan:
slot_uri: cim:DiscExcContIEEEDEC1A.kan
range: PU
required: false
multivalued: false
description: Discontinuous controller gain (KAN). Typical
value = 400.
ketl:
slot_uri: cim:DiscExcContIEEEDEC1A.ketl
range: PU
required: false
multivalued: false
description: Terminal voltage limiter gain (KETL). Typical
value = 47.
tan:
slot_uri: cim:DiscExcContIEEEDEC1A.tan
range: Seconds
required: false
multivalued: false
description: Discontinuous controller time constant (TAN)
(>= 0). Typical value = 0,08.
td:
slot_uri: cim:DiscExcContIEEEDEC1A.td
range: Seconds
required: false
multivalued: false
description: Time constant (TD) (>= 0). Typical
value = 0,03.
tl1:
slot_uri: cim:DiscExcContIEEEDEC1A.tl1
range: Seconds
required: false
multivalued: false
description: Time constant (TL1) (>=
0). Typical value = 0,025.
tl2:
slot_uri: cim:DiscExcContIEEEDEC1A.tl2
range: Seconds
required: false
multivalued: false
description: Time constant (TL2) (>=
0). Typical value = 1,25.
tw5:
slot_uri: cim:DiscExcContIEEEDEC1A.tw5
range: Seconds
required: false
multivalued: false
description: DEC washout time constant (TW5)
(>= 0). Typical value = 5.
val:
slot_uri: cim:DiscExcContIEEEDEC1A.val
range: PU
required: false
multivalued: false
description: Regulator voltage reference (VAL). Typical
value = 5,5.
vanmax:
slot_uri: cim:DiscExcContIEEEDEC1A.vanmax
range: PU
required: false
multivalued: false
description: Limiter for Van (VANMAX).
vomax:
slot_uri: cim:DiscExcContIEEEDEC1A.vomax
range: PU
required: false
multivalued: false
description: Limiter (VOMAX) (> DiscExcContIEEEDEC1A.vomin). Typical
value = 0,3.
vomin:
slot_uri: cim:DiscExcContIEEEDEC1A.vomin
range: PU
required: false
multivalued: false
description: Limiter (VOMIN) (< DiscExcContIEEEDEC1A.vomax). Typical
value = 0,1.
vsmax:
slot_uri: cim:DiscExcContIEEEDEC1A.vsmax
range: PU
required: false
multivalued: false
description: Limiter (VSMAX)(> DiscExcContIEEEDEC1A.vsmin). Typical
value = 0,2.
vsmin:
slot_uri: cim:DiscExcContIEEEDEC1A.vsmin
range: PU
required: false
multivalued: false
description: Limiter (VSMIN) (< DiscExcContIEEEDEC1A.vsmax). Typical
value = -0,066.
vtc:
slot_uri: cim:DiscExcContIEEEDEC1A.vtc
range: PU
required: false
multivalued: false
description: Terminal voltage level reference (VTC). Typical
value = 0,95.
vtlmt:
slot_uri: cim:DiscExcContIEEEDEC1A.vtlmt
range: PU
required: false
multivalued: false
description: Voltage reference (VTLMT). Typical
value = 1,1.
vtm:
slot_uri: cim:DiscExcContIEEEDEC1A.vtm
range: PU
required: false
multivalued: false
description: Voltage limits (VTM). Typical value
= 1,13.
vtn:
slot_uri: cim:DiscExcContIEEEDEC1A.vtn
range: PU
required: false
multivalued: false
description: Voltage limits (VTN). Typical value
= 1,12.
DiscExcContIEEEDEC2A:
class_uri: cim:DiscExcContIEEEDEC2A
is_a: DiscontinuousExcitationControlDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.DiscontinuousExcitationControlDynamics
description: "IEEE type DEC2A model for discontinuous excitation control. This\
\ system provides transient excitation boosting via an open-loop control as\
\ initiated by a trigger signal generated remotely.\r\nReference: IEEE 421.5-2005\
\ 12.3. "
attributes:
td1:
slot_uri: cim:DiscExcContIEEEDEC2A.td1
range: Seconds
required: false
multivalued: false
description: 'Discontinuous controller time constant (TD1)
(>= 0). '
td2:
slot_uri: cim:DiscExcContIEEEDEC2A.td2
range: Seconds
required: false
multivalued: false
description: 'Discontinuous controller washout time constant (TD2)
(>= 0). '
vdmax:
slot_uri: cim:DiscExcContIEEEDEC2A.vdmax
range: PU
required: false
multivalued: false
description: 'Limiter (VDMAX) (> DiscExcContIEEEDEC2A.vdmin). '
vdmin:
slot_uri: cim:DiscExcContIEEEDEC2A.vdmin
range: PU
required: false
multivalued: false
description: 'Limiter (VDMIN) (< DiscExcContIEEEDEC2A.vdmax). '
vk:
slot_uri: cim:DiscExcContIEEEDEC2A.vk
range: PU
required: false
multivalued: false
description: 'Discontinuous controller input reference (VK). '
DiscExcContIEEEDEC3A:
class_uri: cim:DiscExcContIEEEDEC3A
is_a: DiscontinuousExcitationControlDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.DiscontinuousExcitationControlDynamics
description: "IEEE type DEC3A model. In some systems, the stabilizer output is\
\ disconnected from the regulator immediately following a severe fault to prevent\
\ the stabilizer from competing with action of voltage regulator during the\
\ first swing.\r\nReference: IEEE 421.5-2005 12.4. "
attributes:
tdr:
slot_uri: cim:DiscExcContIEEEDEC3A.tdr
range: Seconds
required: false
multivalued: false
description: 'Reset time delay (TDR) (>= 0). '
vtmin:
slot_uri: cim:DiscExcContIEEEDEC3A.vtmin
range: PU
required: false
multivalued: false
description: 'Terminal undervoltage comparison level (VTMIN). '
PFVArType1IEEEPFController:
class_uri: cim:PFVArType1IEEEPFController
is_a: PFVArControllerType1Dynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.PFVArControllerType1Dynamics
description: "IEEE PF controller type 1 which operates by moving the voltage reference\
\ directly.\r\nReference: IEEE 421.5-2005, 11.2. "
attributes:
ovex:
slot_uri: cim:PFVArType1IEEEPFController.ovex
range: boolean
required: false
multivalued: false
description: "Overexcitation Flag (OVEX)\r\ntrue = overexcited\r\n\
false = underexcited."
tpfc:
slot_uri: cim:PFVArType1IEEEPFController.tpfc
range: Seconds
required: false
multivalued: false
description: PF controller time delay (TPFC) (>=
0). Typical value = 5.
vitmin:
slot_uri: cim:PFVArType1IEEEPFController.vitmin
range: PU
required: false
multivalued: false
description: Minimum machine terminal current needed to enable pf/var controller
(VITMIN).
vpf:
slot_uri: cim:PFVArType1IEEEPFController.vpf
range: PU
required: false
multivalued: false
description: Synchronous machine power factor (VPF).
vpfcbw:
slot_uri: cim:PFVArType1IEEEPFController.vpfcbw
range: float
required: false
multivalued: false
description: PF controller deadband (VPFC_BW). Typical
value = 0,05.
vpfref:
slot_uri: cim:PFVArType1IEEEPFController.vpfref
range: PU
required: false
multivalued: false
description: PF controller reference (VPFREF).
vvtmax:
slot_uri: cim:PFVArType1IEEEPFController.vvtmax
range: PU
required: false
multivalued: false
description: Maximum machine terminal voltage needed for pf/var controller
to be enabled (VVTMAX) (> PFVArType1IEEEPFController.vvtmin).
vvtmin:
slot_uri: cim:PFVArType1IEEEPFController.vvtmin
range: PU
required: false
multivalued: false
description: Minimum machine terminal voltage needed to enable pf/var controller
(VVTMIN) (< PFVArType1IEEEPFController.vvtmax).
PFVArType1IEEEVArController:
class_uri: cim:PFVArType1IEEEVArController
is_a: PFVArControllerType1Dynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.PFVArControllerType1Dynamics
description: "IEEE VAR controller type 1 which operates by moving the voltage\
\ reference directly.\r\nReference: IEEE 421.5-2005, 11.3."
attributes:
tvarc:
slot_uri: cim:PFVArType1IEEEVArController.tvarc
range: Seconds
required: false
multivalued: false
description: Var controller time delay (TVARC) (>=
0). Typical value = 5.
vvar:
slot_uri: cim:PFVArType1IEEEVArController.vvar
range: PU
required: false
multivalued: false
description: Synchronous machine power factor (VVAR).
vvarcbw:
slot_uri: cim:PFVArType1IEEEVArController.vvarcbw
range: float
required: false
multivalued: false
description: Var controller deadband (VVARC_BW). Typical
value = 0,02.
vvarref:
slot_uri: cim:PFVArType1IEEEVArController.vvarref
range: PU
required: false
multivalued: false
description: Var controller reference (VVARREF).
vvtmax:
slot_uri: cim:PFVArType1IEEEVArController.vvtmax
range: PU
required: false
multivalued: false
description: Maximum machine terminal voltage needed for pf/VAr controller
to be enabled (VVTMAX) (> PVFArType1IEEEVArController.vvtmin).
vvtmin:
slot_uri: cim:PFVArType1IEEEVArController.vvtmin
range: PU
required: false
multivalued: false
description: Minimum machine terminal voltage needed to enable pf/var controller
(VVTMIN) (< PVFArType1IEEEVArController.vvtmax).
VAdjIEEE:
class_uri: cim:VAdjIEEE
is_a: VoltageAdjusterDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.VoltageAdjusterDynamics
description: "IEEE voltage adjuster which is used to represent the voltage adjuster\
\ in either a power factor or VAr control system.\r\nReference: IEEE 421.5-2005,\
\ 11.1."
attributes:
adjslew:
slot_uri: cim:VAdjIEEE.adjslew
range: float
required: false
multivalued: false
description: Rate at which output of adjuster changes (ADJ_SLEW). Unit
= s / PU. Typical value = 300.
taoff:
slot_uri: cim:VAdjIEEE.taoff
range: Seconds
required: false
multivalued: false
description: Time that adjuster pulses are off (TAOFF)
(>= 0). Typical value = 0,5.
taon:
slot_uri: cim:VAdjIEEE.taon
range: Seconds
required: false
multivalued: false
description: Time that adjuster pulses are on (TAON)
(>= 0). Typical value = 0,1.
vadjf:
slot_uri: cim:VAdjIEEE.vadjf
range: float
required: false
multivalued: false
description: Set high to provide a continuous raise or lower (VADJF).
vadjmax:
slot_uri: cim:VAdjIEEE.vadjmax
range: PU
required: false
multivalued: false
description: Maximum output of the adjuster (VADJMAX)
(> VAdjIEEE.vadjmin). Typical value = 1,1.
vadjmin:
slot_uri: cim:VAdjIEEE.vadjmin
range: PU
required: false
multivalued: false
description: Minimum output of the adjuster (VADJMIN)
(< VAdjIEEE.vadjmax). Typical value = 0,9.
PFVArType2IEEEPFController:
class_uri: cim:PFVArType2IEEEPFController
is_a: PFVArControllerType2Dynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.PFVArControllerType2Dynamics
description: "IEEE PF controller type 2 which is a summing point type controller\
\ making up the outside loop of a two-loop system. This controller is implemented\
\ as a slow PI type controller. The voltage regulator forms the inner loop and\
\ is implemented as a fast controller.\r\nReference: IEEE 421.5-2005, 11.4. "
attributes:
exlon:
slot_uri: cim:PFVArType2IEEEPFController.exlon
range: boolean
required: false
multivalued: false
description: "Overexcitation or under excitation flag (EXLON)\r\ntrue\
\ = 1 (not in the overexcitation or underexcitation state, integral action\
\ is active)\r\nfalse = 0 (in the overexcitation or underexcitation state,\
\ so integral action is disabled to allow the limiter to play its role)."
ki:
slot_uri: cim:PFVArType2IEEEPFController.ki
range: PU
required: false
multivalued: false
description: Integral gain of the pf controller (KI). Typical
value = 1.
kp:
slot_uri: cim:PFVArType2IEEEPFController.kp
range: PU
required: false
multivalued: false
description: Proportional gain of the pf controller (KP). Typical
value = 1.
pfref:
slot_uri: cim:PFVArType2IEEEPFController.pfref
range: PU
required: false
multivalued: false
description: Power factor reference (PFREF).
vclmt:
slot_uri: cim:PFVArType2IEEEPFController.vclmt
range: PU
required: false
multivalued: false
description: Maximum output of the pf controller (VCLMT). Typical
value = 0,1.
vref:
slot_uri: cim:PFVArType2IEEEPFController.vref
range: PU
required: false
multivalued: false
description: Voltage regulator reference (VREF).
vs:
slot_uri: cim:PFVArType2IEEEPFController.vs
range: float
required: false
multivalued: false
description: Generator sensing voltage (VS).
PFVArType2IEEEVArController:
class_uri: cim:PFVArType2IEEEVArController
is_a: PFVArControllerType2Dynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.PFVArControllerType2Dynamics
description: "IEEE VAR controller type 2 which is a summing point type controller.\
\ It makes up the outside loop of a two-loop system. This controller is implemented\
\ as a slow PI type controller, and the voltage regulator forms the inner loop\
\ and is implemented as a fast controller.\r\nReference: IEEE 421.5-2005, 11.5."
attributes:
exlon:
slot_uri: cim:PFVArType2IEEEVArController.exlon
range: boolean
required: false
multivalued: false
description: "Overexcitation or under excitation flag (EXLON)\r\ntrue\
\ = 1 (not in the overexcitation or underexcitation state, integral action\
\ is active)\r\nfalse = 0 (in the overexcitation or underexcitation state,\
\ so integral action is disabled to allow the limiter to play its role)."
ki:
slot_uri: cim:PFVArType2IEEEVArController.ki
range: PU
required: false
multivalued: false
description: Integral gain of the pf controller (KI).
kp:
slot_uri: cim:PFVArType2IEEEVArController.kp
range: PU
required: false
multivalued: false
description: Proportional gain of the pf controller (KP).
qref:
slot_uri: cim:PFVArType2IEEEVArController.qref
range: PU
required: false
multivalued: false
description: 'Reactive power reference (QREF). '
vclmt:
slot_uri: cim:PFVArType2IEEEVArController.vclmt
range: PU
required: false
multivalued: false
description: Maximum output of the pf controller (VCLMT).
vref:
slot_uri: cim:PFVArType2IEEEVArController.vref
range: PU
required: false
multivalued: false
description: Voltage regulator reference (VREF).
vs:
slot_uri: cim:PFVArType2IEEEVArController.vs
range: float
required: false
multivalued: false
description: Generator sensing voltage (VS).
PFVArType2Common1:
class_uri: cim:PFVArType2Common1
is_a: PFVArControllerType2Dynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.PFVArControllerType2Dynamics
description: "Power factor / reactive power regulator. This model represents the\
\ power factor or reactive power controller such as the Basler SCP-250. The\
\ controller measures power factor or reactive power (PU on generator rated\
\ power) and compares it with the operator's set point.\r\n[Footnote: Basler\
\ SCP-250 is an example of a suitable product available commercially. This information\
\ is given for the convenience of users of this document and does not constitute\
\ an endorsement by IEC of this product.]"
attributes:
j:
slot_uri: cim:PFVArType2Common1.j
range: boolean
required: false
multivalued: false
description: "Selector (J).\r\ntrue = control mode for reactive power\r\
\nfalse = control mode for power factor."
ki:
slot_uri: cim:PFVArType2Common1.ki
range: PU
required: false
multivalued: false
description: Reset gain (Ki).
kp:
slot_uri: cim:PFVArType2Common1.kp
range: PU
required: false
multivalued: false
description: Proportional gain (Kp).
max:
slot_uri: cim:PFVArType2Common1.max
range: PU
required: false
multivalued: false
description: Output limit (max).
ref:
slot_uri: cim:PFVArType2Common1.ref
range: PU
required: false
multivalued: false
description: "Reference value of reactive power or power factor (Ref).\r\
\nThe reference value is initialised by this model. This initialisation\
\ can override the value exchanged by this attribute to represent a plant\
\ operator's change of the reference setting."
VCompIEEEType1:
class_uri: cim:VCompIEEEType1
is_a: VoltageCompensatorDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.VoltageCompensatorDynamics
description: "Terminal voltage transducer and load compensator\
\ as defined in IEEE 421.5-2005, 4. This model is common to all excitation system\
\ models described in the IEEE Standard. \r\nParameter details:\r\n\r\n\t- If Rc\
\ and Xc are set to zero, the load compensation is not employed\
\ and the behaviour is as a simple sensing circuit.
\r\n
\r\n\r\n\
\t- If all parameters (Rc, Xc and Tr) are set to zero,\
\ the standard model VCompIEEEType1 is bypassed.
\r\n
\r\nReference:\
\ IEEE 421.5-2005 4. "
attributes:
rc:
slot_uri: cim:VCompIEEEType1.rc
range: PU
required: false
multivalued: false
description: Resistive component of compensation of
a generator (Rc) (>= 0).
tr:
slot_uri: cim:VCompIEEEType1.tr
range: Seconds
required: false
multivalued: false
description: Time constant which is used for the combined
voltage sensing and compensation signal (Tr) (>= 0).
xc:
slot_uri: cim:VCompIEEEType1.xc
range: PU
required: false
multivalued: false
description: Reactive component of compensation of a
generator (Xc) (>= 0).
WindPlantIEC:
class_uri: cim:WindPlantIEC
is_a: WindPlantDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.WindDynamics
description: "Simplified IEC type plant level model. \r\nReference: IEC 61400-27-1:2015,\
\ Annex D."
attributes:
WindPlantReactiveControlIEC:
slot_uri: cim:WindPlantIEC.WindPlantReactiveControlIEC
range: WindPlantReactiveControlIEC
required: true
multivalued: false
description: Wind plant model with which this wind reactive control is associated.
WindPlantFreqPcontrolIEC:
slot_uri: cim:WindPlantIEC.WindPlantFreqPcontrolIEC
range: WindPlantFreqPcontrolIEC
required: true
multivalued: false
description: Wind plant frequency and active power control model associated
with this wind plant.
WindPlantFreqPcontrolIEC:
class_uri: cim:WindPlantFreqPcontrolIEC
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.WindDynamics
description: "Frequency and active power controller model.\r\nReference: IEC 61400-27-1:2015,\
\ Annex D."
attributes:
dprefmax:
slot_uri: cim:WindPlantFreqPcontrolIEC.dprefmax
range: PU
required: false
multivalued: false
description: Maximum ramp rate of pWTref request
from the plant controller to the wind turbines (dprefmax)
(> WindPlantFreqPcontrolIEC.dprefmin). It is a case-dependent parameter.
dprefmin:
slot_uri: cim:WindPlantFreqPcontrolIEC.dprefmin
range: PU
required: false
multivalued: false
description: Minimum (negative) ramp rate of pWTref
request from the plant controller to the wind turbines (dprefmin)
(< WindPlantFreqPcontrolIEC.dprefmax). It is a project-dependent parameter.
dpwprefmax:
slot_uri: cim:WindPlantFreqPcontrolIEC.dpwprefmax
range: PU
required: false
multivalued: false
description: Maximum positive ramp rate for wind plant power reference (dpWPrefmax)
(> WindPlantFreqPcontrolIEC.dpwprefmin). It is a project-dependent parameter.
dpwprefmin:
slot_uri: cim:WindPlantFreqPcontrolIEC.dpwprefmin
range: PU
required: false
multivalued: false
description: Maximum negative ramp rate for wind plant power reference (dpWPrefmin)
(< WindPlantFreqPcontrolIEC.dpwprefmax). It is a project-dependent parameter.
kiwpp:
slot_uri: cim:WindPlantFreqPcontrolIEC.kiwpp
range: float
required: false
multivalued: false
description: Plant P controller integral gain (KIWPp).
It is a project-dependent parameter.
kiwppmax:
slot_uri: cim:WindPlantFreqPcontrolIEC.kiwppmax
range: PU
required: false
multivalued: false
description: Maximum PI integrator term (KIWPpmax)
(> WindPlantFreqPcontrolIEC.kiwppmin). It is a project-dependent parameter.
kiwppmin:
slot_uri: cim:WindPlantFreqPcontrolIEC.kiwppmin
range: PU
required: false
multivalued: false
description: Minimum PI integrator term (KIWPpmin)
(< WindPlantFreqPcontrolIEC.kiwppmax). It is a project-dependent parameter.
kpwpp:
slot_uri: cim:WindPlantFreqPcontrolIEC.kpwpp
range: float
required: false
multivalued: false
description: Plant P controller proportional gain (KPWPp).
It is a project-dependent parameter.
kwppref:
slot_uri: cim:WindPlantFreqPcontrolIEC.kwppref
range: PU
required: false
multivalued: false
description: Power reference gain (KWPpref). It is
a project-dependent parameter.
prefmax:
slot_uri: cim:WindPlantFreqPcontrolIEC.prefmax
range: PU
required: false
multivalued: false
description: Maximum pWTref request from the plant
controller to the wind turbines (prefmax) (>
WindPlantFreqPcontrolIEC.prefmin). It is a project-dependent parameter.
prefmin:
slot_uri: cim:WindPlantFreqPcontrolIEC.prefmin
range: PU
required: false
multivalued: false
description: Minimum pWTref request from the plant
controller to the wind turbines (prefmin) (<
WindPlantFreqPcontrolIEC.prefmax). It is a project-dependent parameter.
tpft:
slot_uri: cim:WindPlantFreqPcontrolIEC.tpft
range: Seconds
required: false
multivalued: false
description: Lead time constant in reference value transfer function (Tpft)
(>= 0). It is a project-dependent parameter.
tpfv:
slot_uri: cim:WindPlantFreqPcontrolIEC.tpfv
range: Seconds
required: false
multivalued: false
description: Lag time constant in reference value transfer function (Tpfv)
(>= 0). It is a project-dependent parameter.
twpffiltp:
slot_uri: cim:WindPlantFreqPcontrolIEC.twpffiltp
range: Seconds
required: false
multivalued: false
description: Filter time constant for frequency measurement (TWPffiltp)
(>= 0). It is a project-dependent parameter.
twppfiltp:
slot_uri: cim:WindPlantFreqPcontrolIEC.twppfiltp
range: Seconds
required: false
multivalued: false
description: Filter time constant for active power measurement (TWPpfiltp)
(>= 0). It is a project-dependent parameter.
WindPlantIEC:
slot_uri: cim:WindPlantFreqPcontrolIEC.WindPlantIEC
range: WindPlantIEC
required: true
multivalued: false
description: Wind plant model with which this wind plant frequency and active
power control is associated.
WindDynamicsLookupTable:
slot_uri: cim:WindPlantFreqPcontrolIEC.WindDynamicsLookupTable
range: WindDynamicsLookupTable
required: true
multivalued: true
description: The wind dynamics lookup table associated with this frequency
and active power wind plant model.
WindDynamicsLookupTable:
class_uri: cim:WindDynamicsLookupTable
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.WindDynamics
description: Look up table for the purpose of wind standard models.
attributes:
input:
slot_uri: cim:WindDynamicsLookupTable.input
range: float
required: false
multivalued: false
description: Input value (x) for the lookup table function.
lookupTableFunctionType:
slot_uri: cim:WindDynamicsLookupTable.lookupTableFunctionType
range: WindLookupTableFunctionKind
required: false
multivalued: false
description: Type of the lookup table function.
output:
slot_uri: cim:WindDynamicsLookupTable.output
range: float
required: false
multivalued: false
description: Output value (y) for the lookup table function.
sequence:
slot_uri: cim:WindDynamicsLookupTable.sequence
range: integer
required: false
multivalued: false
description: Sequence numbers of the pairs of the input (x) and the
output (y) of the lookup table function.
WindPlantFreqPcontrolIEC:
slot_uri: cim:WindDynamicsLookupTable.WindPlantFreqPcontrolIEC
range: WindPlantFreqPcontrolIEC
required: false
multivalued: false
description: The frequency and active power wind plant control model with
which this wind dynamics lookup table is associated.
WindPlantReactiveControlIEC:
slot_uri: cim:WindDynamicsLookupTable.WindPlantReactiveControlIEC
range: WindPlantReactiveControlIEC
required: false
multivalued: false
description: The voltage and reactive power wind plant control model with
which this wind dynamics lookup table is associated.
WindProtectionIEC:
slot_uri: cim:WindDynamicsLookupTable.WindProtectionIEC
range: WindProtectionIEC
required: false
multivalued: false
description: The grid protection model with which this wind dynamics lookup
table is associated.
WindContQPQULimIEC:
slot_uri: cim:WindDynamicsLookupTable.WindContQPQULimIEC
range: WindContQPQULimIEC
required: false
multivalued: false
description: The QP and QU limitation model with which this wind dynamics
lookup table is associated.
WindContCurrLimIEC:
slot_uri: cim:WindDynamicsLookupTable.WindContCurrLimIEC
range: WindContCurrLimIEC
required: false
multivalued: false
description: The current control limitation model with which this wind dynamics
lookup table is associated.
WindContPType3IEC:
slot_uri: cim:WindDynamicsLookupTable.WindContPType3IEC
range: WindContPType3IEC
required: false
multivalued: false
description: The P control type 3 model with which this wind dynamics lookup
table is associated.
WindContRotorRIEC:
slot_uri: cim:WindDynamicsLookupTable.WindContRotorRIEC
range: WindContRotorRIEC
required: false
multivalued: false
description: The rotor resistance control model with which this wind dynamics
lookup table is associated.
WindPitchContPowerIEC:
slot_uri: cim:WindDynamicsLookupTable.WindPitchContPowerIEC
range: WindPitchContPowerIEC
required: false
multivalued: false
description: The pitch control power model with which this wind dynamics lookup
table is associated.
WindGenType3bIEC:
slot_uri: cim:WindDynamicsLookupTable.WindGenType3bIEC
range: WindGenType3bIEC
required: false
multivalued: false
description: The generator type 3B model with which this wind dynamics lookup
table is associated.
WindPlantReactiveControlIEC:
class_uri: cim:WindPlantReactiveControlIEC
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.WindDynamics
description: "Simplified plant voltage and reactive power control model for use\
\ with type 3 and type 4 wind turbine models.\r\nReference: IEC 61400-27-1:2015,\
\ Annex D."
attributes:
dxrefmax:
slot_uri: cim:WindPlantReactiveControlIEC.dxrefmax
range: PU
required: false
multivalued: false
description: Maximum positive ramp rate for wind turbine reactive power/voltage
reference (dxrefmax) (> WindPlantReactiveControlIEC.dxrefmin).
It is a project-dependent parameter.
dxrefmin:
slot_uri: cim:WindPlantReactiveControlIEC.dxrefmin
range: PU
required: false
multivalued: false
description: Maximum negative ramp rate for wind turbine reactive power/voltage
reference (dxrefmin) (< WindPlantReactiveControlIEC.dxrefmax).
It is a project-dependent parameter.
kiwpx:
slot_uri: cim:WindPlantReactiveControlIEC.kiwpx
range: float
required: false
multivalued: false
description: Plant Q controller integral gain (KIWPx).
It is a project-dependent parameter.
kiwpxmax:
slot_uri: cim:WindPlantReactiveControlIEC.kiwpxmax
range: PU
required: false
multivalued: false
description: Maximum reactive power/voltage reference from integration (KIWPxmax)
(> WindPlantReactiveControlIEC.kiwpxmin). It is a project-dependent parameter.
kiwpxmin:
slot_uri: cim:WindPlantReactiveControlIEC.kiwpxmin
range: PU
required: false
multivalued: false
description: Minimum reactive power/voltage reference from integration (KIWPxmin)
(< WindPlantReactiveControlIEC.kiwpxmax). It is a project-dependent parameter.
kpwpx:
slot_uri: cim:WindPlantReactiveControlIEC.kpwpx
range: float
required: false
multivalued: false
description: Plant Q controller proportional gain (KPWPx).
It is a project-dependent parameter.
kwpqref:
slot_uri: cim:WindPlantReactiveControlIEC.kwpqref
range: PU
required: false
multivalued: false
description: Reactive power reference gain (KWPqref).
It is a project-dependent parameter.
kwpqu:
slot_uri: cim:WindPlantReactiveControlIEC.kwpqu
range: PU
required: false
multivalued: false
description: Plant voltage control droop (KWPqu).
It is a project-dependent parameter.
tuqfilt:
slot_uri: cim:WindPlantReactiveControlIEC.tuqfilt
range: Seconds
required: false
multivalued: false
description: Filter time constant for voltage-dependent reactive power (Tuqfilt)
(>= 0). It is a project-dependent parameter.
twppfiltq:
slot_uri: cim:WindPlantReactiveControlIEC.twppfiltq
range: Seconds
required: false
multivalued: false
description: Filter time constant for active power measurement (TWPpfiltq)
(>= 0). It is a project-dependent parameter.
twpqfiltq:
slot_uri: cim:WindPlantReactiveControlIEC.twpqfiltq
range: Seconds
required: false
multivalued: false
description: Filter time constant for reactive power measurement (TWPqfiltq)
(>= 0). It is a project-dependent parameter.
twpufiltq:
slot_uri: cim:WindPlantReactiveControlIEC.twpufiltq
range: Seconds
required: false
multivalued: false
description: Filter time constant for voltage measurement (TWPufiltq)
(>= 0). It is a project-dependent parameter.
txft:
slot_uri: cim:WindPlantReactiveControlIEC.txft
range: Seconds
required: false
multivalued: false
description: Lead time constant in reference value transfer function (Txft)
(>= 0). It is a project-dependent parameter.
txfv:
slot_uri: cim:WindPlantReactiveControlIEC.txfv
range: Seconds
required: false
multivalued: false
description: Lag time constant in reference value transfer function (Txfv)
(>= 0). It is a project-dependent parameter.
uwpqdip:
slot_uri: cim:WindPlantReactiveControlIEC.uwpqdip
range: PU
required: false
multivalued: false
description: Voltage threshold for UVRT detection in Q control (uWPqdip).
It is a project-dependent parameter.
windPlantQcontrolModesType:
slot_uri: cim:WindPlantReactiveControlIEC.windPlantQcontrolModesType
range: WindPlantQcontrolModeKind
required: false
multivalued: false
description: Reactive power/voltage controller mode (MWPqmode).
It is a case-dependent parameter.
xrefmax:
slot_uri: cim:WindPlantReactiveControlIEC.xrefmax
range: PU
required: false
multivalued: false
description: Maximum xWTref (qWTref
or delta uWTref) request from the plant controller
(xrefmax) (> WindPlantReactiveControlIEC.xrefmin).
It is a case-dependent parameter.
xrefmin:
slot_uri: cim:WindPlantReactiveControlIEC.xrefmin
range: PU
required: false
multivalued: false
description: Minimum xWTref (qWTref
or delta uWTref) request from the plant controller
(xrefmin) (< WindPlantReactiveControlIEC.xrefmax).
It is a project-dependent parameter.
WindDynamicsLookupTable:
slot_uri: cim:WindPlantReactiveControlIEC.WindDynamicsLookupTable
range: WindDynamicsLookupTable
required: true
multivalued: true
description: The wind dynamics lookup table associated with this voltage and
reactive power wind plant model.
WindPlantIEC:
slot_uri: cim:WindPlantReactiveControlIEC.WindPlantIEC
range: WindPlantIEC
required: true
multivalued: false
description: Wind plant reactive control model associated with this wind plant.
WindProtectionIEC:
class_uri: cim:WindProtectionIEC
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.WindDynamics
description: "The grid protection model includes protection against over- and\
\ under-voltage, and against over- and under-frequency.\r\nReference: IEC 61400-27-1:2015,\
\ 5.6.6."
attributes:
dfimax:
slot_uri: cim:WindProtectionIEC.dfimax
range: PU
required: false
multivalued: false
description: Maximum rate of change of frequency (dFmax).
It is a type-dependent parameter.
fover:
slot_uri: cim:WindProtectionIEC.fover
range: PU
required: false
multivalued: false
description: 'Wind turbine over frequency protection activation threshold
(fover). It is a project-dependent parameter. '
funder:
slot_uri: cim:WindProtectionIEC.funder
range: PU
required: false
multivalued: false
description: Wind turbine under frequency protection activation threshold
(funder). It is a project-dependent parameter.
mzc:
slot_uri: cim:WindProtectionIEC.mzc
range: boolean
required: false
multivalued: false
description: "Zero crossing measurement mode (Mzc). It is a type-dependent\
\ parameter. \r\ntrue = WT protection system uses zero crossings to detect\
\ frequency (1 in the IEC model)\r\nfalse = WT protection system does not\
\ use zero crossings to detect frequency (0 in the IEC model)."
tfma:
slot_uri: cim:WindProtectionIEC.tfma
range: Seconds
required: false
multivalued: false
description: Time interval of moving average window (TfMA) (>= 0). It
is a type-dependent parameter.
uover:
slot_uri: cim:WindProtectionIEC.uover
range: PU
required: false
multivalued: false
description: Wind turbine over voltage protection activation threshold (uover).
It is a project-dependent parameter.
uunder:
slot_uri: cim:WindProtectionIEC.uunder
range: PU
required: false
multivalued: false
description: Wind turbine under voltage protection activation threshold (uunder).
It is a project-dependent parameter.
WindTurbineType3or4IEC:
slot_uri: cim:WindProtectionIEC.WindTurbineType3or4IEC
range: WindTurbineType3or4IEC
required: false
multivalued: false
description: Wind generator type 3 or type 4 model with which this wind turbine
protection model is associated.
WindTurbineType1or2IEC:
slot_uri: cim:WindProtectionIEC.WindTurbineType1or2IEC
range: WindTurbineType1or2IEC
required: false
multivalued: false
description: Wind generator type 1 or type 2 model with which this wind turbine
protection model is associated.
WindDynamicsLookupTable:
slot_uri: cim:WindProtectionIEC.WindDynamicsLookupTable
range: WindDynamicsLookupTable
required: true
multivalued: true
description: The wind dynamics lookup table associated with this grid protection
model.
WindTurbineType3or4IEC:
class_uri: cim:WindTurbineType3or4IEC
is_a: WindTurbineType3or4Dynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.WindDynamics
description: Parent class supporting relationships to IEC wind turbines type 3
and type 4 including their control models.
attributes:
WindContQPQULimIEC:
slot_uri: cim:WindTurbineType3or4IEC.WindContQPQULimIEC
range: WindContQPQULimIEC
required: false
multivalued: false
description: QP and QU limitation model associated with this wind generator
type 3 or type 4 model.
WindContCurrLimIEC:
slot_uri: cim:WindTurbineType3or4IEC.WindContCurrLimIEC
range: WindContCurrLimIEC
required: true
multivalued: false
description: Wind control current limitation model associated with this wind
turbine type 3 or type 4 model.
WindProtectionIEC:
slot_uri: cim:WindTurbineType3or4IEC.WindProtectionIEC
range: WindProtectionIEC
required: true
multivalued: false
description: Wind turbune protection model associated with this wind generator
type 3 or type 4 model.
WIndContQIEC:
slot_uri: cim:WindTurbineType3or4IEC.WIndContQIEC
range: WindContQIEC
required: true
multivalued: false
description: Wind control Q model associated with this wind turbine type 3
or type 4 model.
WindRefFrameRotIEC:
slot_uri: cim:WindTurbineType3or4IEC.WindRefFrameRotIEC
range: WindRefFrameRotIEC
required: true
multivalued: false
description: Reference frame rotation model associated with this wind turbine
type 3 or type 4 model.
WindContQLimIEC:
slot_uri: cim:WindTurbineType3or4IEC.WindContQLimIEC
range: WindContQLimIEC
required: false
multivalued: false
description: Constant Q limitation model associated with this wind generator
type 3 or type 4 model.
WindContQPQULimIEC:
class_uri: cim:WindContQPQULimIEC
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.WindDynamics
description: "QP and QU limitation model.\r\nReference: IEC 61400-27-1:2015, 5.6.5.10."
attributes:
tpfiltql:
slot_uri: cim:WindContQPQULimIEC.tpfiltql
range: Seconds
required: false
multivalued: false
description: Power measurement filter time constant for Q capacity (Tpfiltql)
(>= 0). It is a type-dependent parameter.
tufiltql:
slot_uri: cim:WindContQPQULimIEC.tufiltql
range: Seconds
required: false
multivalued: false
description: Voltage measurement filter time constant for Q capacity (Tufiltql)
(>= 0). It is a type-dependent parameter.
WindTurbineType3or4IEC:
slot_uri: cim:WindContQPQULimIEC.WindTurbineType3or4IEC
range: WindTurbineType3or4IEC
required: false
multivalued: false
description: Wind generator type 3 or type 4 model with which this QP and
QU limitation model is associated.
WindDynamicsLookupTable:
slot_uri: cim:WindContQPQULimIEC.WindDynamicsLookupTable
range: WindDynamicsLookupTable
required: true
multivalued: true
description: The wind dynamics lookup table associated with this QP and QU
limitation model.
WindContCurrLimIEC:
class_uri: cim:WindContCurrLimIEC
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.WindDynamics
description: "Current limitation model. The current limitation model combines\
\ the physical limits and the control limits.\r\nReference: IEC 61400-27-1:2015,\
\ 5.6.5.8."
attributes:
imax:
slot_uri: cim:WindContCurrLimIEC.imax
range: PU
required: false
multivalued: false
description: Maximum continuous current at the wind turbine terminals (imax).
It is a type-dependent parameter.
imaxdip:
slot_uri: cim:WindContCurrLimIEC.imaxdip
range: PU
required: false
multivalued: false
description: Maximum current during voltage dip at the wind turbine terminals
(imaxdip). It is a project-dependent parameter.
kpqu:
slot_uri: cim:WindContCurrLimIEC.kpqu
range: PU
required: false
multivalued: false
description: Partial derivative of reactive current limit (Kpqu)
versus voltage. It is a type-dependent parameter.
mdfslim:
slot_uri: cim:WindContCurrLimIEC.mdfslim
range: boolean
required: false
multivalued: false
description: "Limitation of type 3 stator current (MDFSLim).\
\ MDFSLim = 1 for wind turbines type\
\ 4. It is a type-dependent parameter.\r\nfalse= total current limitation\
\ (0 in the IEC model)\r\ntrue=stator current limitation (1 in the IEC model).\r\
\n"
mqpri:
slot_uri: cim:WindContCurrLimIEC.mqpri
range: boolean
required: false
multivalued: false
description: "Prioritisation of Q control during UVRT (Mqpri).\
\ It is a project-dependent parameter.\r\ntrue = reactive power priority\
\ (1 in the IEC model)\r\nfalse = active power priority (0 in the IEC model)."
tufiltcl:
slot_uri: cim:WindContCurrLimIEC.tufiltcl
range: Seconds
required: false
multivalued: false
description: Voltage measurement filter time constant (Tufiltcl)
(>= 0). It is a type-dependent parameter.
upqumax:
slot_uri: cim:WindContCurrLimIEC.upqumax
range: PU
required: false
multivalued: false
description: Wind turbine voltage in the operation point where zero reactive
current can be delivered (upqumax). It is a type-dependent
parameter.
WindTurbineType3or4IEC:
slot_uri: cim:WindContCurrLimIEC.WindTurbineType3or4IEC
range: WindTurbineType3or4IEC
required: true
multivalued: false
description: Wind turbine type 3 or type 4 model with which this wind control
current limitation model is associated.
WindDynamicsLookupTable:
slot_uri: cim:WindContCurrLimIEC.WindDynamicsLookupTable
range: WindDynamicsLookupTable
required: true
multivalued: true
description: The wind dynamics lookup table associated with this current control
limitation model.
WindContQIEC:
class_uri: cim:WindContQIEC
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.WindDynamics
description: "Q control model.\r\nReference: IEC 61400-27-1:2015, 5.6.5.7."
attributes:
iqh1:
slot_uri: cim:WindContQIEC.iqh1
range: PU
required: false
multivalued: false
description: Maximum reactive current injection during dip (iqh1).
It is a type-dependent parameter.
iqmax:
slot_uri: cim:WindContQIEC.iqmax
range: PU
required: false
multivalued: false
description: Maximum reactive current injection (iqmax)
(> WindContQIEC.iqmin). It is a type-dependent parameter.
iqmin:
slot_uri: cim:WindContQIEC.iqmin
range: PU
required: false
multivalued: false
description: Minimum reactive current injection (iqmin)
(< WindContQIEC.iqmax). It is a type-dependent parameter.
iqpost:
slot_uri: cim:WindContQIEC.iqpost
range: PU
required: false
multivalued: false
description: Post fault reactive current injection (iqpost).
It is a project-dependent parameter.
kiq:
slot_uri: cim:WindContQIEC.kiq
range: PU
required: false
multivalued: false
description: Reactive power PI controller integration gain (KI,q).
It is a type-dependent parameter.
kiu:
slot_uri: cim:WindContQIEC.kiu
range: PU
required: false
multivalued: false
description: Voltage PI controller integration gain (KI,u).
It is a type-dependent parameter.
kpq:
slot_uri: cim:WindContQIEC.kpq
range: PU
required: false
multivalued: false
description: Reactive power PI controller proportional gain (KP,q).
It is a type-dependent parameter.
kpu:
slot_uri: cim:WindContQIEC.kpu
range: PU
required: false
multivalued: false
description: Voltage PI controller proportional gain (KP,u).
It is a type-dependent parameter.
kqv:
slot_uri: cim:WindContQIEC.kqv
range: PU
required: false
multivalued: false
description: Voltage scaling factor for UVRT current (Kqv).
It is a project-dependent parameter.
rdroop:
slot_uri: cim:WindContQIEC.rdroop
range: PU
required: false
multivalued: false
description: Resistive component of voltage drop impedance (rdroop)
(>= 0). It is a project-dependent parameter.
tpfiltq:
slot_uri: cim:WindContQIEC.tpfiltq
range: Seconds
required: false
multivalued: false
description: Power measurement filter time constant (Tpfiltq)
(>= 0). It is a type-dependent parameter.
tpost:
slot_uri: cim:WindContQIEC.tpost
range: Seconds
required: false
multivalued: false
description: Length of time period where post fault reactive power is injected
(Tpost) (>= 0). It is a project-dependent parameter.
tqord:
slot_uri: cim:WindContQIEC.tqord
range: Seconds
required: false
multivalued: false
description: Time constant in reactive power order lag (Tqord)
(>= 0). It is a type-dependent parameter.
tufiltq:
slot_uri: cim:WindContQIEC.tufiltq
range: Seconds
required: false
multivalued: false
description: Voltage measurement filter time constant (Tufiltq)
(>= 0). It is a type-dependent parameter.
udb1:
slot_uri: cim:WindContQIEC.udb1
range: PU
required: false
multivalued: false
description: Voltage deadband lower limit (udb1).
It is a type-dependent parameter.
udb2:
slot_uri: cim:WindContQIEC.udb2
range: PU
required: false
multivalued: false
description: Voltage deadband upper limit (udb2).
It is a type-dependent parameter.
umax:
slot_uri: cim:WindContQIEC.umax
range: PU
required: false
multivalued: false
description: Maximum voltage in voltage PI controller integral term (umax)
(> WindContQIEC.umin). It is a type-dependent parameter.
umin:
slot_uri: cim:WindContQIEC.umin
range: PU
required: false
multivalued: false
description: Minimum voltage in voltage PI controller integral term (umin)
(< WindContQIEC.umax). It is a type-dependent parameter.
uqdip:
slot_uri: cim:WindContQIEC.uqdip
range: PU
required: false
multivalued: false
description: Voltage threshold for UVRT detection in Q control (uqdip).
It is a type-dependent parameter.
uref0:
slot_uri: cim:WindContQIEC.uref0
range: PU
required: false
multivalued: false
description: User-defined bias in voltage reference (uref0).
It is a case-dependent parameter.
windQcontrolModesType:
slot_uri: cim:WindContQIEC.windQcontrolModesType
range: WindQcontrolModeKind
required: false
multivalued: false
description: Types of general wind turbine Q control modes (MqG). It
is a project-dependent parameter.
windUVRTQcontrolModesType:
slot_uri: cim:WindContQIEC.windUVRTQcontrolModesType
range: WindUVRTQcontrolModeKind
required: false
multivalued: false
description: Types of UVRT Q control modes (MqUVRT).
It is a project-dependent parameter.
xdroop:
slot_uri: cim:WindContQIEC.xdroop
range: PU
required: false
multivalued: false
description: Inductive component of voltage drop impedance (xdroop)
(>= 0). It is a project-dependent parameter.
WindTurbineType3or4IEC:
slot_uri: cim:WindContQIEC.WindTurbineType3or4IEC
range: WindTurbineType3or4IEC
required: true
multivalued: false
description: Wind turbine type 3 or type 4 model with which this reactive
control model is associated.
WindRefFrameRotIEC:
class_uri: cim:WindRefFrameRotIEC
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.WindDynamics
description: "Reference frame rotation model.\r\nReference: IEC 61400-27-1:2015,\
\ 5.6.3.5."
attributes:
tpll:
slot_uri: cim:WindRefFrameRotIEC.tpll
range: Seconds
required: false
multivalued: false
description: Time constant for PLL first order filter model (TPLL)
(>= 0). It is a type-dependent parameter.
upll1:
slot_uri: cim:WindRefFrameRotIEC.upll1
range: PU
required: false
multivalued: false
description: Voltage below which the angle of the voltage is filtered and
possibly also frozen (uPLL1). It is a type-dependent
parameter.
upll2:
slot_uri: cim:WindRefFrameRotIEC.upll2
range: PU
required: false
multivalued: false
description: Voltage (uPLL2) below which the angle
of the voltage is frozen if uPLL2 is
smaller or equal to uPLL1 . It is a type-dependent
parameter.
WindTurbineType3or4IEC:
slot_uri: cim:WindRefFrameRotIEC.WindTurbineType3or4IEC
range: WindTurbineType3or4IEC
required: true
multivalued: false
description: Wind turbine type 3 or type 4 model with which this reference
frame rotation model is associated.
WindContQLimIEC:
class_uri: cim:WindContQLimIEC
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.WindDynamics
description: "Constant Q limitation model.\r\nReference: IEC 61400-27-1:2015,\
\ 5.6.5.9."
attributes:
qmax:
slot_uri: cim:WindContQLimIEC.qmax
range: PU
required: false
multivalued: false
description: Maximum reactive power (qmax) (>
WindContQLimIEC.qmin). It is a type-dependent parameter.
qmin:
slot_uri: cim:WindContQLimIEC.qmin
range: PU
required: false
multivalued: false
description: Minimum reactive power (qmin) (<
WindContQLimIEC.qmax). It is a type-dependent parameter.
WindTurbineType3or4IEC:
slot_uri: cim:WindContQLimIEC.WindTurbineType3or4IEC
range: WindTurbineType3or4IEC
required: false
multivalued: false
description: Wind generator type 3 or type 4 model with which this constant
Q limitation model is associated.
WindTurbineType1or2IEC:
class_uri: cim:WindTurbineType1or2IEC
is_a: WindTurbineType1or2Dynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.WindDynamics
description: "Parent class supporting relationships to IEC wind turbines type\
\ 1 and type 2 including their control models.\r\nGenerator model for wind turbine\
\ of IEC type 1 or type 2 is a standard asynchronous generator model.\r\nReference:\
\ IEC 61400-27-1:2015, 5.5.2 and 5.5.3."
attributes:
WindProtectionIEC:
slot_uri: cim:WindTurbineType1or2IEC.WindProtectionIEC
range: WindProtectionIEC
required: true
multivalued: false
description: Wind turbune protection model associated with this wind generator
type 1 or type 2 model.
WindMechIEC:
slot_uri: cim:WindTurbineType1or2IEC.WindMechIEC
range: WindMechIEC
required: true
multivalued: false
description: Wind mechanical model associated with this wind generator type
1 or type 2 model.
WindMechIEC:
class_uri: cim:WindMechIEC
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.WindDynamics
description: "Two mass model.\r\nReference: IEC 61400-27-1:2015, 5.6.2.1."
attributes:
cdrt:
slot_uri: cim:WindMechIEC.cdrt
range: PU
required: false
multivalued: false
description: Drive train damping (cdrt). It
is a type-dependent parameter.
hgen:
slot_uri: cim:WindMechIEC.hgen
range: Seconds
required: false
multivalued: false
description: Inertia constant of generator (Hgen)
(>= 0). It is a type-dependent parameter.
hwtr:
slot_uri: cim:WindMechIEC.hwtr
range: Seconds
required: false
multivalued: false
description: Inertia constant of wind turbine rotor (HWTR)
(>= 0). It is a type-dependent parameter.
kdrt:
slot_uri: cim:WindMechIEC.kdrt
range: PU
required: false
multivalued: false
description: Drive train stiffness (kdrt). It is
a type-dependent parameter.
WindTurbineType4bIEC:
slot_uri: cim:WindMechIEC.WindTurbineType4bIEC
range: WindTurbineType4bIEC
required: false
multivalued: false
description: Wind turbine type 4B model with which this wind mechanical model
is associated.
WindTurbineType3IEC:
slot_uri: cim:WindMechIEC.WindTurbineType3IEC
range: WindTurbineType3IEC
required: false
multivalued: false
description: Wind turbine type 3 model with which this wind mechanical model
is associated.
WindTurbineType1or2IEC:
slot_uri: cim:WindMechIEC.WindTurbineType1or2IEC
range: WindTurbineType1or2IEC
required: false
multivalued: false
description: Wind generator type 1 or type 2 model with which this wind mechanical
model is associated.
WindTurbineType4bIEC:
class_uri: cim:WindTurbineType4bIEC
is_a: WindTurbineType4IEC
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.WindDynamics
description: "Wind turbine IEC type 4B.\r\nReference: IEC 61400-27-1:2015, 5.5.5.3."
attributes:
WindGenType4IEC:
slot_uri: cim:WindTurbineType4bIEC.WindGenType4IEC
range: WindGenType4IEC
required: false
multivalued: false
description: Wind generator type 4 model associated with this wind turbine
type 4B model.
WindMechIEC:
slot_uri: cim:WindTurbineType4bIEC.WindMechIEC
range: WindMechIEC
required: true
multivalued: false
description: Wind mechanical model associated with this wind turbine type
4B model.
WindContPType4bIEC:
slot_uri: cim:WindTurbineType4bIEC.WindContPType4bIEC
range: WindContPType4bIEC
required: true
multivalued: false
description: Wind control P type 4B model associated with this wind turbine
type 4B model.
WindTurbineType4IEC:
class_uri: cim:WindTurbineType4IEC
is_a: WindTurbineType3or4IEC
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.WindDynamics
description: Parent class supporting relationships to IEC wind turbines type 4
including their control models.
attributes:
WindGenType3aIEC:
slot_uri: cim:WindTurbineType4IEC.WindGenType3aIEC
range: WindGenType3aIEC
required: false
multivalued: false
description: Wind generator type 3A model associated with this wind turbine
type 4 model.
WindGenType3aIEC:
class_uri: cim:WindGenType3aIEC
is_a: WindGenType3IEC
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.WindDynamics
description: "IEC type 3A generator set model.\r\nReference: IEC 61400-27-1:2015,\
\ 5.6.3.2."
attributes:
kpc:
slot_uri: cim:WindGenType3aIEC.kpc
range: float
required: false
multivalued: false
description: Current PI controller proportional gain (KPc).
It is a type-dependent parameter.
tic:
slot_uri: cim:WindGenType3aIEC.tic
range: Seconds
required: false
multivalued: false
description: Current PI controller integration time constant (TIc)
(>= 0). It is a type-dependent parameter.
WindTurbineType4IEC:
slot_uri: cim:WindGenType3aIEC.WindTurbineType4IEC
range: WindTurbineType4IEC
required: false
multivalued: false
description: Wind turbine type 4 model with which this wind generator type
3A model is associated.
WindGenType3IEC:
class_uri: cim:WindGenType3IEC
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.WindDynamics
description: Parent class supporting relationships to IEC wind turbines type 3
generator models of IEC type 3A and 3B.
attributes:
dipmax:
slot_uri: cim:WindGenType3IEC.dipmax
range: PU
required: false
multivalued: false
description: Maximum active current ramp rate (dipmax).
It is a project-dependent parameter.
diqmax:
slot_uri: cim:WindGenType3IEC.diqmax
range: PU
required: false
multivalued: false
description: Maximum reactive current ramp rate (diqmax).
It is a project-dependent parameter.
xs:
slot_uri: cim:WindGenType3IEC.xs
range: PU
required: false
multivalued: false
description: Electromagnetic transient reactance (xS).
It is a type-dependent parameter.
WindTurbineType3IEC:
slot_uri: cim:WindGenType3IEC.WindTurbineType3IEC
range: WindTurbineType3IEC
required: false
multivalued: false
description: 'Wind turbine type 3 model with which this wind generator type
3 is associated. '
WindTurbineType3IEC:
class_uri: cim:WindTurbineType3IEC
is_a: WindTurbineType3or4IEC
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.WindDynamics
description: Parent class supporting relationships to IEC wind turbines type 3
including their control models.
attributes:
WindAeroTwoDimIEC:
slot_uri: cim:WindTurbineType3IEC.WindAeroTwoDimIEC
range: WindAeroTwoDimIEC
required: false
multivalued: false
description: Wind aerodynamic model associated with this wind turbine type
3 model.
WindMechIEC:
slot_uri: cim:WindTurbineType3IEC.WindMechIEC
range: WindMechIEC
required: true
multivalued: false
description: Wind mechanical model associated with this wind turbine type
3 model.
WindContPitchAngleIEC:
slot_uri: cim:WindTurbineType3IEC.WindContPitchAngleIEC
range: WindContPitchAngleIEC
required: true
multivalued: false
description: Wind control pitch angle model associated with this wind turbine
type 3.
WindGenType3IEC:
slot_uri: cim:WindTurbineType3IEC.WindGenType3IEC
range: WindGenType3IEC
required: false
multivalued: false
description: Wind generator type 3 model associated with this wind turbine
type 3 model.
WindContPType3IEC:
slot_uri: cim:WindTurbineType3IEC.WindContPType3IEC
range: WindContPType3IEC
required: true
multivalued: false
description: Wind control P type 3 model associated with this wind turbine
type 3 model.
WindAeroOneDimIEC:
slot_uri: cim:WindTurbineType3IEC.WindAeroOneDimIEC
range: WindAeroOneDimIEC
required: false
multivalued: false
description: Wind aerodynamic model associated with this wind generator type
3 model.
WindAeroTwoDimIEC:
class_uri: cim:WindAeroTwoDimIEC
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.WindDynamics
description: "Two-dimensional aerodynamic model. \r\nReference: IEC 61400-27-1:2015,\
\ 5.6.1.3."
attributes:
dpomega:
slot_uri: cim:WindAeroTwoDimIEC.dpomega
range: PU
required: false
multivalued: false
description: Partial derivative of aerodynamic power with respect to changes
in WTR speed (dpomega). It is a type-dependent
parameter.
dptheta:
slot_uri: cim:WindAeroTwoDimIEC.dptheta
range: PU
required: false
multivalued: false
description: Partial derivative of aerodynamic power with respect to changes
in pitch angle (dptheta). It is a type-dependent
parameter.
dpv1:
slot_uri: cim:WindAeroTwoDimIEC.dpv1
range: PU
required: false
multivalued: false
description: Partial derivative (dpv1). It is a type-dependent
parameter.
omegazero:
slot_uri: cim:WindAeroTwoDimIEC.omegazero
range: PU
required: false
multivalued: false
description: Rotor speed if the wind turbine is not derated (omega0).
It is a type-dependent parameter.
pavail:
slot_uri: cim:WindAeroTwoDimIEC.pavail
range: PU
required: false
multivalued: false
description: Available aerodynamic power (pavail).
It is a case-dependent parameter.
thetav2:
slot_uri: cim:WindAeroTwoDimIEC.thetav2
range: AngleDegrees
required: false
multivalued: false
description: Blade angle at twice rated wind speed (thetav2).
It is a type-dependent parameter.
thetazero:
slot_uri: cim:WindAeroTwoDimIEC.thetazero
range: AngleDegrees
required: false
multivalued: false
description: Pitch angle if the wind turbine is not derated (theta0).
It is a case-dependent parameter.
WindTurbineType3IEC:
slot_uri: cim:WindAeroTwoDimIEC.WindTurbineType3IEC
range: WindTurbineType3IEC
required: true
multivalued: false
description: Wind turbine type 3 model with which this wind aerodynamic model
is associated.
WindContPitchAngleIEC:
class_uri: cim:WindContPitchAngleIEC
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.WindDynamics
description: "Pitch angle control model.\r\nReference: IEC 61400-27-1:2015, 5.6.5.2."
attributes:
dthetamax:
slot_uri: cim:WindContPitchAngleIEC.dthetamax
range: float
required: false
multivalued: false
description: 'Maximum pitch positive ramp rate (dthetamax)
(> WindContPitchAngleIEC.dthetamin). It is a type-dependent parameter.
Unit = degrees / s. '
dthetamin:
slot_uri: cim:WindContPitchAngleIEC.dthetamin
range: float
required: false
multivalued: false
description: 'Maximum pitch negative ramp rate (dthetamin)
(< WindContPitchAngleIEC.dthetamax). It is a type-dependent parameter.
Unit = degrees / s. '
kic:
slot_uri: cim:WindContPitchAngleIEC.kic
range: PU
required: false
multivalued: false
description: Power PI controller integration gain (KIc).
It is a type-dependent parameter.
kiomega:
slot_uri: cim:WindContPitchAngleIEC.kiomega
range: PU
required: false
multivalued: false
description: Speed PI controller integration gain (KIomega).
It is a type-dependent parameter.
kpc:
slot_uri: cim:WindContPitchAngleIEC.kpc
range: PU
required: false
multivalued: false
description: Power PI controller proportional gain (KPc).
It is a type-dependent parameter.
kpomega:
slot_uri: cim:WindContPitchAngleIEC.kpomega
range: PU
required: false
multivalued: false
description: Speed PI controller proportional gain (KPomega).
It is a type-dependent parameter.
kpx:
slot_uri: cim:WindContPitchAngleIEC.kpx
range: PU
required: false
multivalued: false
description: Pitch cross coupling gain (KPX). It
is a type-dependent parameter.
thetamax:
slot_uri: cim:WindContPitchAngleIEC.thetamax
range: AngleDegrees
required: false
multivalued: false
description: Maximum pitch angle (thetamax) (>
WindContPitchAngleIEC.thetamin). It is a type-dependent parameter.
thetamin:
slot_uri: cim:WindContPitchAngleIEC.thetamin
range: AngleDegrees
required: false
multivalued: false
description: Minimum pitch angle (thetamin) (<
WindContPitchAngleIEC.thetamax). It is a type-dependent parameter.
ttheta:
slot_uri: cim:WindContPitchAngleIEC.ttheta
range: Seconds
required: false
multivalued: false
description: Pitch time constant (ttheta) (>= 0). It is a type-dependent
parameter.
WindTurbineType3IEC:
slot_uri: cim:WindContPitchAngleIEC.WindTurbineType3IEC
range: WindTurbineType3IEC
required: true
multivalued: false
description: Wind turbine type 3 model with which this pitch control model
is associated.
WindContPType3IEC:
class_uri: cim:WindContPType3IEC
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.WindDynamics
description: "P control model type 3.\r\nReference: IEC 61400-27-1:2015, 5.6.5.4."
attributes:
dpmax:
slot_uri: cim:WindContPType3IEC.dpmax
range: PU
required: false
multivalued: false
description: Maximum wind turbine power ramp rate (dpmax).
It is a type-dependent parameter.
dprefmax:
slot_uri: cim:WindContPType3IEC.dprefmax
range: PU
required: false
multivalued: false
description: Maximum ramp rate of wind turbine reference power (dprefmax).
It is a project-dependent parameter.
dprefmin:
slot_uri: cim:WindContPType3IEC.dprefmin
range: PU
required: false
multivalued: false
description: Minimum ramp rate of wind turbine reference power (dprefmin).
It is a project-dependent parameter.
dthetamax:
slot_uri: cim:WindContPType3IEC.dthetamax
range: PU
required: false
multivalued: false
description: Ramp limitation of torque, required in some grid codes (dtmax).
It is a project-dependent parameter.
dthetamaxuvrt:
slot_uri: cim:WindContPType3IEC.dthetamaxuvrt
range: PU
required: false
multivalued: false
description: Limitation of torque rise rate during UVRT (dthetamaxUVRT).
It is a project-dependent parameter.
kdtd:
slot_uri: cim:WindContPType3IEC.kdtd
range: PU
required: false
multivalued: false
description: Gain for active drive train damping (KDTD).
It is a type-dependent parameter.
kip:
slot_uri: cim:WindContPType3IEC.kip
range: PU
required: false
multivalued: false
description: PI controller integration parameter (KIp).
It is a type-dependent parameter.
kpp:
slot_uri: cim:WindContPType3IEC.kpp
range: PU
required: false
multivalued: false
description: PI controller proportional gain (KPp). It is
a type-dependent parameter.
mpuvrt:
slot_uri: cim:WindContPType3IEC.mpuvrt
range: boolean
required: false
multivalued: false
description: "Enable UVRT power control mode (MpUVRT).\
\ It is a project-dependent parameter.\r\ntrue = voltage control (1 in\
\ the IEC model)\r\nfalse = reactive power control (0 in the IEC model).\r\
\n"
omegadtd:
slot_uri: cim:WindContPType3IEC.omegadtd
range: PU
required: false
multivalued: false
description: Active drive train damping frequency (omegaDTD).
It can be calculated from two mass model parameters. It is a type-dependent
parameter.
omegaoffset:
slot_uri: cim:WindContPType3IEC.omegaoffset
range: PU
required: false
multivalued: false
description: Offset to reference value that limits controller action during
rotor speed changes (omegaoffset). It is a case-dependent
parameter.
pdtdmax:
slot_uri: cim:WindContPType3IEC.pdtdmax
range: PU
required: false
multivalued: false
description: Maximum active drive train damping power (pDTDmax).
It is a type-dependent parameter.
tdvs:
slot_uri: cim:WindContPType3IEC.tdvs
range: Seconds
required: false
multivalued: false
description: Time delay after deep voltage sags (TDVS)
(>= 0). It is a project-dependent parameter.
thetaemin:
slot_uri: cim:WindContPType3IEC.thetaemin
range: PU
required: false
multivalued: false
description: Minimum electrical generator torque (temin).
It is a type-dependent parameter.
thetauscale:
slot_uri: cim:WindContPType3IEC.thetauscale
range: PU
required: false
multivalued: false
description: Voltage scaling factor of reset-torque (tuscale).
It is a project-dependent parameter.
tomegafiltp3:
slot_uri: cim:WindContPType3IEC.tomegafiltp3
range: Seconds
required: false
multivalued: false
description: Filter time constant for generator speed measurement (Tomegafiltp3)
(>= 0). It is a type-dependent parameter.
tomegaref:
slot_uri: cim:WindContPType3IEC.tomegaref
range: Seconds
required: false
multivalued: false
description: Time constant in speed reference filter (Tomega,ref)
(>= 0). It is a type-dependent parameter.
tpfiltp3:
slot_uri: cim:WindContPType3IEC.tpfiltp3
range: Seconds
required: false
multivalued: false
description: Filter time constant for power measurement (Tpfiltp3)
(>= 0). It is a type-dependent parameter.
tpord:
slot_uri: cim:WindContPType3IEC.tpord
range: PU
required: false
multivalued: false
description: Time constant in power order lag (Tpord). It
is a type-dependent parameter.
tufiltp3:
slot_uri: cim:WindContPType3IEC.tufiltp3
range: Seconds
required: false
multivalued: false
description: Filter time constant for voltage measurement (Tufiltp3)
(>= 0). It is a type-dependent parameter.
udvs:
slot_uri: cim:WindContPType3IEC.udvs
range: PU
required: false
multivalued: false
description: Voltage limit for hold UVRT status after deep voltage sags (uDVS).
It is a project-dependent parameter.
updip:
slot_uri: cim:WindContPType3IEC.updip
range: PU
required: false
multivalued: false
description: Voltage dip threshold for P-control (uPdip). Part
of turbine control, often different (e.g 0.8) from converter thresholds.
It is a project-dependent parameter.
zeta:
slot_uri: cim:WindContPType3IEC.zeta
range: float
required: false
multivalued: false
description: Coefficient for active drive train damping (zeta). It
is a type-dependent parameter.
WindTurbineType3IEC:
slot_uri: cim:WindContPType3IEC.WindTurbineType3IEC
range: WindTurbineType3IEC
required: true
multivalued: false
description: Wind turbine type 3 model with which this wind control P type
3 model is associated.
WindDynamicsLookupTable:
slot_uri: cim:WindContPType3IEC.WindDynamicsLookupTable
range: WindDynamicsLookupTable
required: true
multivalued: true
description: The wind dynamics lookup table associated with this P control
type 3 model.
WindAeroOneDimIEC:
class_uri: cim:WindAeroOneDimIEC
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.WindDynamics
description: "One-dimensional aerodynamic model. \r\nReference: IEC 61400-27-1:2015,\
\ 5.6.1.2."
attributes:
ka:
slot_uri: cim:WindAeroOneDimIEC.ka
range: float
required: false
multivalued: false
description: Aerodynamic gain (ka). It is a type-dependent
parameter.
thetaomega:
slot_uri: cim:WindAeroOneDimIEC.thetaomega
range: AngleDegrees
required: false
multivalued: false
description: Initial pitch angle (thetaomega0). It
is a case-dependent parameter.
WindTurbineType3IEC:
slot_uri: cim:WindAeroOneDimIEC.WindTurbineType3IEC
range: WindTurbineType3IEC
required: true
multivalued: false
description: Wind turbine type 3 model with which this wind aerodynamic model
is associated.
WindGenType4IEC:
class_uri: cim:WindGenType4IEC
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.WindDynamics
description: "IEC type 4 generator set model.\r\nReference: IEC 61400-27-1:2015,\
\ 5.6.3.4."
attributes:
dipmax:
slot_uri: cim:WindGenType4IEC.dipmax
range: PU
required: false
multivalued: false
description: Maximum active current ramp rate (dipmax).
It is a project-dependent parameter.
diqmax:
slot_uri: cim:WindGenType4IEC.diqmax
range: PU
required: false
multivalued: false
description: Maximum reactive current ramp rate (diqmax).
It is a project-dependent parameter.
diqmin:
slot_uri: cim:WindGenType4IEC.diqmin
range: PU
required: false
multivalued: false
description: Minimum reactive current ramp rate (diqmin).
It is a project-dependent parameter.
tg:
slot_uri: cim:WindGenType4IEC.tg
range: Seconds
required: false
multivalued: false
description: Time constant (Tg) (>= 0). It is
a type-dependent parameter.
WindTurbineType4bIEC:
slot_uri: cim:WindGenType4IEC.WindTurbineType4bIEC
range: WindTurbineType4bIEC
required: false
multivalued: false
description: Wind turbine type 4B model with which this wind generator type
4 model is associated.
WindTurbineType4aIEC:
slot_uri: cim:WindGenType4IEC.WindTurbineType4aIEC
range: WindTurbineType4aIEC
required: false
multivalued: false
description: Wind turbine type 4A model with which this wind generator type
4 model is associated.
WindTurbineType4aIEC:
class_uri: cim:WindTurbineType4aIEC
is_a: WindTurbineType4IEC
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.WindDynamics
description: "Wind turbine IEC type 4A.\r\nReference: IEC 61400-27-1:2015, 5.5.5.2."
attributes:
WindContPType4aIEC:
slot_uri: cim:WindTurbineType4aIEC.WindContPType4aIEC
range: WindContPType4aIEC
required: true
multivalued: false
description: Wind control P type 4A model associated with this wind turbine
type 4A model.
WindGenType4IEC:
slot_uri: cim:WindTurbineType4aIEC.WindGenType4IEC
range: WindGenType4IEC
required: false
multivalued: false
description: Wind generator type 4 model associated with this wind turbine
type 4A model.
WindContPType4aIEC:
class_uri: cim:WindContPType4aIEC
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.WindDynamics
description: "P control model type 4A.\r\nReference: IEC 61400-27-1:2015, 5.6.5.5."
attributes:
dpmaxp4a:
slot_uri: cim:WindContPType4aIEC.dpmaxp4a
range: PU
required: false
multivalued: false
description: Maximum wind turbine power ramp rate (dpmaxp4A).
It is a project-dependent parameter.
tpordp4a:
slot_uri: cim:WindContPType4aIEC.tpordp4a
range: Seconds
required: false
multivalued: false
description: Time constant in power order lag (Tpordp4A)
(>= 0). It is a type-dependent parameter.
tufiltp4a:
slot_uri: cim:WindContPType4aIEC.tufiltp4a
range: Seconds
required: false
multivalued: false
description: Voltage measurement filter time constant (Tufiltp4A)
(>= 0). It is a type-dependent parameter.
WindTurbineType4aIEC:
slot_uri: cim:WindContPType4aIEC.WindTurbineType4aIEC
range: WindTurbineType4aIEC
required: true
multivalued: false
description: ' Wind turbine type 4A model with which this wind control P type
4A model is associated.'
WindContPType4bIEC:
class_uri: cim:WindContPType4bIEC
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.WindDynamics
description: "P control model type 4B.\r\nReference: IEC 61400-27-1:2015, 5.6.5.6."
attributes:
dpmaxp4b:
slot_uri: cim:WindContPType4bIEC.dpmaxp4b
range: PU
required: false
multivalued: false
description: Maximum wind turbine power ramp rate (dpmaxp4B).
It is a project-dependent parameter.
tpaero:
slot_uri: cim:WindContPType4bIEC.tpaero
range: Seconds
required: false
multivalued: false
description: Time constant in aerodynamic power response (Tpaero)
(>= 0). It is a type-dependent parameter.
tpordp4b:
slot_uri: cim:WindContPType4bIEC.tpordp4b
range: Seconds
required: false
multivalued: false
description: Time constant in power order lag (Tpordp4B)
(>= 0). It is a type-dependent parameter.
tufiltp4b:
slot_uri: cim:WindContPType4bIEC.tufiltp4b
range: Seconds
required: false
multivalued: false
description: Voltage measurement filter time constant (Tufiltp4B)
(>= 0). It is a type-dependent parameter.
WindTurbineType4bIEC:
slot_uri: cim:WindContPType4bIEC.WindTurbineType4bIEC
range: WindTurbineType4bIEC
required: true
multivalued: false
description: Wind turbine type 4B model with which this wind control P type
4B model is associated.
WindContRotorRIEC:
class_uri: cim:WindContRotorRIEC
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.WindDynamics
description: "Rotor resistance control model.\r\nReference: IEC 61400-27-1:2015,\
\ 5.6.5.3."
attributes:
kirr:
slot_uri: cim:WindContRotorRIEC.kirr
range: PU
required: false
multivalued: false
description: Integral gain in rotor resistance PI controller (KIrr).
It is a type-dependent parameter.
komegafilt:
slot_uri: cim:WindContRotorRIEC.komegafilt
range: float
required: false
multivalued: false
description: Filter gain for generator speed measurement (Komegafilt).
It is a type-dependent parameter.
kpfilt:
slot_uri: cim:WindContRotorRIEC.kpfilt
range: float
required: false
multivalued: false
description: Filter gain for power measurement (Kpfilt).
It is a type-dependent parameter.
kprr:
slot_uri: cim:WindContRotorRIEC.kprr
range: PU
required: false
multivalued: false
description: Proportional gain in rotor resistance PI controller (KPrr).
It is a type-dependent parameter.
rmax:
slot_uri: cim:WindContRotorRIEC.rmax
range: PU
required: false
multivalued: false
description: Maximum rotor resistance (rmax) (>
WindContRotorRIEC.rmin). It is a type-dependent parameter.
rmin:
slot_uri: cim:WindContRotorRIEC.rmin
range: PU
required: false
multivalued: false
description: Minimum rotor resistance (rmin) (<
WindContRotorRIEC.rmax). It is a type-dependent parameter.
tomegafiltrr:
slot_uri: cim:WindContRotorRIEC.tomegafiltrr
range: Seconds
required: false
multivalued: false
description: Filter time constant for generator speed measurement (Tomegafiltrr)
(>= 0). It is a type-dependent parameter.
tpfiltrr:
slot_uri: cim:WindContRotorRIEC.tpfiltrr
range: Seconds
required: false
multivalued: false
description: Filter time constant for power measurement (Tpfiltrr)
(>= 0). It is a type-dependent parameter.
WindGenTurbineType2IEC:
slot_uri: cim:WindContRotorRIEC.WindGenTurbineType2IEC
range: WindGenTurbineType2IEC
required: true
multivalued: false
description: Wind turbine type 2 model with whitch this wind control rotor
resistance model is associated.
WindDynamicsLookupTable:
slot_uri: cim:WindContRotorRIEC.WindDynamicsLookupTable
range: WindDynamicsLookupTable
required: true
multivalued: true
description: The wind dynamics lookup table associated with this rotor resistance
control model.
WindGenTurbineType2IEC:
class_uri: cim:WindGenTurbineType2IEC
is_a: WindTurbineType1or2IEC
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.WindDynamics
description: "Wind turbine IEC type 2.\r\n\r\nReference: IEC 61400-27-1:2015,\
\ 5.5.3."
attributes:
WindContRotorRIEC:
slot_uri: cim:WindGenTurbineType2IEC.WindContRotorRIEC
range: WindContRotorRIEC
required: true
multivalued: false
description: Wind control rotor resistance model associated with wind turbine
type 2 model.
WindPitchContPowerIEC:
slot_uri: cim:WindGenTurbineType2IEC.WindPitchContPowerIEC
range: WindPitchContPowerIEC
required: true
multivalued: false
description: Pitch control power model associated with this wind turbine type
2 model.
WindPitchContPowerIEC:
class_uri: cim:WindPitchContPowerIEC
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.WindDynamics
description: "Pitch control power model.\r\nReference: IEC 61400-27-1:2015, 5.6.5.1."
attributes:
dpmax:
slot_uri: cim:WindPitchContPowerIEC.dpmax
range: PU
required: false
multivalued: false
description: Rate limit for increasing power (dpmax)
(> WindPitchContPowerIEC.dpmin). It is a type-dependent parameter.
dpmin:
slot_uri: cim:WindPitchContPowerIEC.dpmin
range: PU
required: false
multivalued: false
description: Rate limit for decreasing power (dpmin)
(< WindPitchContPowerIEC.dpmax). It is a type-dependent parameter.
pmin:
slot_uri: cim:WindPitchContPowerIEC.pmin
range: PU
required: false
multivalued: false
description: Minimum power setting (pmin). It is
a type-dependent parameter.
pset:
slot_uri: cim:WindPitchContPowerIEC.pset
range: PU
required: false
multivalued: false
description: If pinit < pset
then power will be ramped down to pmin. It
is (pset) in the IEC 61400-27-1:2015. It is a type-dependent
parameter.
t1:
slot_uri: cim:WindPitchContPowerIEC.t1
range: Seconds
required: false
multivalued: false
description: Lag time constant (T1) (>= 0). It
is a type-dependent parameter.
tr:
slot_uri: cim:WindPitchContPowerIEC.tr
range: Seconds
required: false
multivalued: false
description: Voltage measurement time constant (Tr)
(>= 0). It is a type-dependent parameter.
uuvrt:
slot_uri: cim:WindPitchContPowerIEC.uuvrt
range: PU
required: false
multivalued: false
description: Dip detection threshold (uUVRT). It
is a type-dependent parameter.
WindGenTurbineType2IEC:
slot_uri: cim:WindPitchContPowerIEC.WindGenTurbineType2IEC
range: WindGenTurbineType2IEC
required: false
multivalued: false
description: Wind turbine type 2 model with which this pitch control power
model is associated.
WindDynamicsLookupTable:
slot_uri: cim:WindPitchContPowerIEC.WindDynamicsLookupTable
range: WindDynamicsLookupTable
required: true
multivalued: true
description: The wind dynamics lookup table associated with this pitch control
power model.
WindGenTurbineType1bIEC:
slot_uri: cim:WindPitchContPowerIEC.WindGenTurbineType1bIEC
range: WindGenTurbineType1bIEC
required: false
multivalued: false
description: Wind turbine type 1B model with which this pitch control power
model is associated.
WindGenTurbineType1bIEC:
class_uri: cim:WindGenTurbineType1bIEC
is_a: WindTurbineType1or2IEC
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.WindDynamics
description: "Wind turbine IEC type 1B.\r\n\r\nReference: IEC 61400-27-1:2015,\
\ 5.5.2.3."
attributes:
WindPitchContPowerIEC:
slot_uri: cim:WindGenTurbineType1bIEC.WindPitchContPowerIEC
range: WindPitchContPowerIEC
required: true
multivalued: false
description: Pitch control power model associated with this wind turbine type
1B model.
WindGenType3bIEC:
class_uri: cim:WindGenType3bIEC
is_a: WindGenType3IEC
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.WindDynamics
description: "IEC type 3B generator set model.\r\nReference: IEC 61400-27-1:2015,\
\ 5.6.3.3."
attributes:
mwtcwp:
slot_uri: cim:WindGenType3bIEC.mwtcwp
range: boolean
required: false
multivalued: false
description: "Crowbar control mode (MWTcwp). It is\
\ a case-dependent parameter.\r\ntrue = 1 in the IEC model\r\nfalse = 0\
\ in the IEC model."
tg:
slot_uri: cim:WindGenType3bIEC.tg
range: Seconds
required: false
multivalued: false
description: Current generation time constant (Tg)
(>= 0). It is a type-dependent parameter.
two:
slot_uri: cim:WindGenType3bIEC.two
range: Seconds
required: false
multivalued: false
description: Time constant for crowbar washout filter (Two)
(>= 0). It is a case-dependent parameter.
WindDynamicsLookupTable:
slot_uri: cim:WindGenType3bIEC.WindDynamicsLookupTable
range: WindDynamicsLookupTable
required: true
multivalued: true
description: The wind dynamics lookup table associated with this generator
type 3B model.
WindGenTurbineType1aIEC:
class_uri: cim:WindGenTurbineType1aIEC
is_a: WindTurbineType1or2IEC
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.WindDynamics
description: "Wind turbine IEC type 1A.\r\nReference: IEC 61400-27-1:2015, 5.5.2.2."
attributes:
WindAeroConstIEC:
slot_uri: cim:WindGenTurbineType1aIEC.WindAeroConstIEC
range: WindAeroConstIEC
required: true
multivalued: false
description: Wind aerodynamic model associated with this wind turbine type
1A model.
WindAeroConstIEC:
class_uri: cim:WindAeroConstIEC
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.WindDynamics
description: "Constant aerodynamic torque model which assumes that the aerodynamic\
\ torque is constant.\r\nReference: IEC 61400-27-1:2015, 5.6.1.1."
attributes:
WindGenTurbineType1aIEC:
slot_uri: cim:WindAeroConstIEC.WindGenTurbineType1aIEC
range: WindGenTurbineType1aIEC
required: true
multivalued: false
description: Wind turbine type 1A model with which this wind aerodynamic model
is associated.
LoadComposite:
class_uri: cim:LoadComposite
is_a: LoadDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.LoadDynamics
description: "Combined static load and induction motor load effects.\r\nThe dynamics\
\ of the motor are simplified by linearizing the induction machine equations."
attributes:
epfd:
slot_uri: cim:LoadComposite.epfd
range: float
required: false
multivalued: false
description: Active load-frequency dependence index (dynamic) (Epfd). Typical
value = 1,5.
epfs:
slot_uri: cim:LoadComposite.epfs
range: float
required: false
multivalued: false
description: Active load-frequency dependence index (static) (Epfs). Typical
value = 1,5.
epvd:
slot_uri: cim:LoadComposite.epvd
range: float
required: false
multivalued: false
description: Active load-voltage dependence index (dynamic) (Epvd). Typical
value = 0,7.
epvs:
slot_uri: cim:LoadComposite.epvs
range: float
required: false
multivalued: false
description: Active load-voltage dependence index (static) (Epvs). Typical
value = 0,7.
eqfd:
slot_uri: cim:LoadComposite.eqfd
range: float
required: false
multivalued: false
description: Reactive load-frequency dependence index (dynamic) (Eqfd). Typical
value = 0.
eqfs:
slot_uri: cim:LoadComposite.eqfs
range: float
required: false
multivalued: false
description: Reactive load-frequency dependence index (static) (Eqfs). Typical
value = 0.
eqvd:
slot_uri: cim:LoadComposite.eqvd
range: float
required: false
multivalued: false
description: Reactive load-voltage dependence index (dynamic) (Eqvd). Typical
value = 2.
eqvs:
slot_uri: cim:LoadComposite.eqvs
range: float
required: false
multivalued: false
description: Reactive load-voltage dependence index (static) (Eqvs). Typical
value = 2.
h:
slot_uri: cim:LoadComposite.h
range: Seconds
required: false
multivalued: false
description: Inertia constant (H) (>= 0). Typical value = 2,5.
lfac:
slot_uri: cim:LoadComposite.lfac
range: float
required: false
multivalued: false
description: Loading factor (Lfac). The ratio of
initial P to motor MVA base. Typical value = 0,8.
pfrac:
slot_uri: cim:LoadComposite.pfrac
range: float
required: false
multivalued: false
description: Fraction of constant-power load to be represented by this motor
model (PFRAC) (>= 0,0 and <= 1,0). Typical
value = 0,5.
LoadGenericNonLinear:
class_uri: cim:LoadGenericNonLinear
is_a: LoadDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.LoadDynamics
description: Generic non-linear dynamic (GNLD) load. This model can be used in
mid-term and long-term voltage stability simulations (i.e., to study voltage
collapse), as it can replace a more detailed representation of aggregate load,
including induction motors, thermostatically controlled and static loads.
attributes:
bs:
slot_uri: cim:LoadGenericNonLinear.bs
range: float
required: false
multivalued: false
description: Steady state voltage index for reactive power (BS).
bt:
slot_uri: cim:LoadGenericNonLinear.bt
range: float
required: false
multivalued: false
description: Transient voltage index for reactive power (BT).
genericNonLinearLoadModelType:
slot_uri: cim:LoadGenericNonLinear.genericNonLinearLoadModelType
range: GenericNonLinearLoadModelKind
required: false
multivalued: false
description: Type of generic non-linear load model.
ls:
slot_uri: cim:LoadGenericNonLinear.ls
range: float
required: false
multivalued: false
description: Steady state voltage index for active power (LS).
lt:
slot_uri: cim:LoadGenericNonLinear.lt
range: float
required: false
multivalued: false
description: Transient voltage index for active power (LT).
tp:
slot_uri: cim:LoadGenericNonLinear.tp
range: Seconds
required: false
multivalued: false
description: Time constant of lag function of active power (TP)
(> 0).
tq:
slot_uri: cim:LoadGenericNonLinear.tq
range: Seconds
required: false
multivalued: false
description: Time constant of lag function of reactive power (TQ)
(> 0).
LoadAggregate:
class_uri: cim:LoadAggregate
is_a: LoadDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.LoadDynamics
description: "Aggregate loads are used to represent all or part of the real and\
\ reactive load from one or more loads in the static (power flow) data. This\
\ load is usually the aggregation of many individual load devices and the load\
\ model is an approximate representation of the aggregate response of the load\
\ devices to system disturbances.\r\nStandard aggregate load model comprised\
\ of static and/or dynamic components. A static load model represents the sensitivity\
\ of the real and reactive power consumed by the load to the amplitude and frequency\
\ of the bus voltage. A dynamic load model can be used to represent the aggregate\
\ response of the motor components of the load.\r\n\r\n\r\n"
attributes:
LoadStatic:
slot_uri: cim:LoadAggregate.LoadStatic
range: LoadStatic
required: false
multivalued: false
description: Aggregate static load associated with this aggregate load.
LoadMotor:
slot_uri: cim:LoadAggregate.LoadMotor
range: LoadMotor
required: false
multivalued: false
description: Aggregate motor (dynamic) load associated with this aggregate
load.
LoadStatic:
class_uri: cim:LoadStatic
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.LoadDynamics
description: General static load. This model represents the sensitivity of the
real and reactive power consumed by the load to the amplitude and frequency
of the bus voltage.
attributes:
ep1:
slot_uri: cim:LoadStatic.ep1
range: float
required: false
multivalued: false
description: First term voltage exponent for active power (Ep1). Used
only when .staticLoadModelType = exponential.
ep2:
slot_uri: cim:LoadStatic.ep2
range: float
required: false
multivalued: false
description: Second term voltage exponent for active power (Ep2). Used
only when .staticLoadModelType = exponential.
ep3:
slot_uri: cim:LoadStatic.ep3
range: float
required: false
multivalued: false
description: Third term voltage exponent for active power (Ep3). Used
only when .staticLoadModelType = exponential.
eq1:
slot_uri: cim:LoadStatic.eq1
range: float
required: false
multivalued: false
description: First term voltage exponent for reactive power (Eq1). Used
only when .staticLoadModelType = exponential.
eq2:
slot_uri: cim:LoadStatic.eq2
range: float
required: false
multivalued: false
description: Second term voltage exponent for reactive power (Eq2). Used
only when .staticLoadModelType = exponential.
eq3:
slot_uri: cim:LoadStatic.eq3
range: float
required: false
multivalued: false
description: Third term voltage exponent for reactive power (Eq3). Used
only when .staticLoadModelType = exponential.
kp1:
slot_uri: cim:LoadStatic.kp1
range: float
required: false
multivalued: false
description: First term voltage coefficient for active power (Kp1). Not
used when .staticLoadModelType = constantZ.
kp2:
slot_uri: cim:LoadStatic.kp2
range: float
required: false
multivalued: false
description: Second term voltage coefficient for active power (Kp2). Not
used when .staticLoadModelType = constantZ.
kp3:
slot_uri: cim:LoadStatic.kp3
range: float
required: false
multivalued: false
description: Third term voltage coefficient for active power (Kp3). Not
used when .staticLoadModelType = constantZ.
kp4:
slot_uri: cim:LoadStatic.kp4
range: float
required: false
multivalued: false
description: Frequency coefficient for active power (Kp4) (not
= 0 if .staticLoadModelType = zIP2). Used only when .staticLoadModelType
= zIP2.
kpf:
slot_uri: cim:LoadStatic.kpf
range: float
required: false
multivalued: false
description: Frequency deviation coefficient for active power (Kpf). Not
used when .staticLoadModelType = constantZ.
kq1:
slot_uri: cim:LoadStatic.kq1
range: float
required: false
multivalued: false
description: First term voltage coefficient for reactive power (Kq1). Not
used when .staticLoadModelType = constantZ.
kq2:
slot_uri: cim:LoadStatic.kq2
range: float
required: false
multivalued: false
description: Second term voltage coefficient for reactive power (Kq2). Not
used when .staticLoadModelType = constantZ.
kq3:
slot_uri: cim:LoadStatic.kq3
range: float
required: false
multivalued: false
description: Third term voltage coefficient for reactive power (Kq3). Not
used when .staticLoadModelType = constantZ.
kq4:
slot_uri: cim:LoadStatic.kq4
range: float
required: false
multivalued: false
description: Frequency coefficient for reactive power (Kq4) (not
= 0 when .staticLoadModelType = zIP2). Used only when .staticLoadModelType
- zIP2.
kqf:
slot_uri: cim:LoadStatic.kqf
range: float
required: false
multivalued: false
description: Frequency deviation coefficient for reactive power (Kqf). Not
used when .staticLoadModelType = constantZ.
staticLoadModelType:
slot_uri: cim:LoadStatic.staticLoadModelType
range: StaticLoadModelKind
required: false
multivalued: false
description: Type of static load model. Typical value = constantZ.
LoadAggregate:
slot_uri: cim:LoadStatic.LoadAggregate
range: LoadAggregate
required: true
multivalued: false
description: Aggregate load to which this aggregate static load belongs.
LoadMotor:
class_uri: cim:LoadMotor
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.LoadDynamics
description: "Aggregate induction motor load. This model is used to represent\
\ a fraction of an ordinary load as \"induction motor load\". It allows a load\
\ that is treated as an ordinary constant power in power flow analysis to be\
\ represented by an induction motor in dynamic simulation. This model is intended\
\ for representation of aggregations of many motors dispersed through a load\
\ represented at a high voltage bus but where there is no information on the\
\ characteristics of individual motors.\r\nEither a \"one-cage\" or \"two-cage\"\
\ model of the induction machine can be modelled. Magnetic saturation is not\
\ modelled.\r\nThis model treats a fraction of the constant power part of a\
\ load as a motor. During initialisation, the initial power drawn by the motor\
\ is set equal to Pfrac times the constant P part of the static\
\ load. The remainder of the load is left as a static load.\r\nThe reactive\
\ power demand of the motor is calculated during initialisation as a function\
\ of voltage at the load bus. This reactive power demand can be less than or\
\ greater than the constant Q component of the load. If the motor's\
\ reactive demand is greater than the constant Q component of the load,\
\ the model inserts a shunt capacitor at the terminal of the motor to bring\
\ its reactive demand down to equal the constant Q reactive load. \r\
\nIf an induction motor load model and a static load model are both present\
\ for a load, the motor Pfrac is assumed to be subtracted from the power\
\ flow constant P load before the static load model is applied. The\
\ remainder of the load, if any, is then represented by the static load model."
attributes:
d:
slot_uri: cim:LoadMotor.d
range: float
required: false
multivalued: false
description: Damping factor (D). Unit = delta P/delta speed. Typical
value = 2.
h:
slot_uri: cim:LoadMotor.h
range: Seconds
required: false
multivalued: false
description: Inertia constant (H) (>= 0). Typical value = 0,4.
lfac:
slot_uri: cim:LoadMotor.lfac
range: float
required: false
multivalued: false
description: Loading factor (Lfac). The ratio of initial P to
motor MVA base. Typical value = 0,8.
lp:
slot_uri: cim:LoadMotor.lp
range: PU
required: false
multivalued: false
description: Transient reactance (Lp). Typical value = 0,15.
lpp:
slot_uri: cim:LoadMotor.lpp
range: PU
required: false
multivalued: false
description: Subtransient reactance (Lpp). Typical value = 0,15.
ls:
slot_uri: cim:LoadMotor.ls
range: PU
required: false
multivalued: false
description: Synchronous reactance (Ls). Typical value = 3,2.
pfrac:
slot_uri: cim:LoadMotor.pfrac
range: float
required: false
multivalued: false
description: Fraction of constant-power load to be represented by this motor
model (Pfrac) (>= 0,0 and <= 1,0). Typical value = 0,3.
ra:
slot_uri: cim:LoadMotor.ra
range: PU
required: false
multivalued: false
description: Stator resistance (Ra). Typical value = 0.
tbkr:
slot_uri: cim:LoadMotor.tbkr
range: Seconds
required: false
multivalued: false
description: Circuit breaker operating time (Tbkr) (>= 0). Typical
value = 0,08.
tpo:
slot_uri: cim:LoadMotor.tpo
range: Seconds
required: false
multivalued: false
description: Transient rotor time constant (Tpo) (>= 0). Typical
value = 1.
tppo:
slot_uri: cim:LoadMotor.tppo
range: Seconds
required: false
multivalued: false
description: Subtransient rotor time constant (Tppo) (>= 0). Typical
value = 0,02.
tv:
slot_uri: cim:LoadMotor.tv
range: Seconds
required: false
multivalued: false
description: Voltage trip pickup time (Tv) (>= 0). Typical value
= 0,1.
vt:
slot_uri: cim:LoadMotor.vt
range: PU
required: false
multivalued: false
description: Voltage threshold for tripping (Vt). Typical value =
0,7.
LoadAggregate:
slot_uri: cim:LoadMotor.LoadAggregate
range: LoadAggregate
required: true
multivalued: false
description: Aggregate load to which this aggregate motor (dynamic) load belongs.
Delay:
class_uri: cim:Delay
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.InfHVDCDynamics
description: All the measurements are filtered by a first lag element with a time
constant TM.
attributes:
tm:
slot_uri: cim:Delay.tm
range: Seconds
required: false
multivalued: false
description: Time constant.
IdcInverterControl:
slot_uri: cim:Delay.IdcInverterControl
range: IdcInverterControl
required: false
multivalued: false
VDCOL:
slot_uri: cim:Delay.VDCOL
range: VDCOL
required: false
multivalued: false
CCAinverter:
slot_uri: cim:Delay.CCAinverter
range: CCAinverter
required: false
multivalued: false
Pcontrol:
slot_uri: cim:Delay.Pcontrol
range: Pcontrol
required: false
multivalued: false
Qregulator:
slot_uri: cim:Delay.Qregulator
range: Qregulator
required: false
multivalued: false
CCArectifierControl:
slot_uri: cim:Delay.CCArectifierControl
range: CCArectifierControl
required: false
multivalued: false
DCvoltageControl:
slot_uri: cim:Delay.DCvoltageControl
range: DCvoltageControl
required: false
multivalued: false
Umode:
slot_uri: cim:Delay.Umode
range: Umode
required: false
multivalued: false
Qlimiter:
slot_uri: cim:Delay.Qlimiter
range: Qlimiter
required: false
multivalued: false
BlockingFunction:
slot_uri: cim:Delay.BlockingFunction
range: BlockingFunction
required: false
multivalued: false
Qmode:
slot_uri: cim:Delay.Qmode
range: Qmode
required: false
multivalued: false
PFmode:
slot_uri: cim:Delay.PFmode
range: PFmode
required: false
multivalued: false
IdcInverterControl:
class_uri: cim:IdcInverterControl
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.InfHVDCDynamics.CSC
attributes:
CSCtype1:
slot_uri: cim:IdcInverterControl.CSCtype1
range: CSCtype1
required: false
multivalued: false
VDCOL:
slot_uri: cim:IdcInverterControl.VDCOL
range: VDCOL
required: true
multivalued: false
Delay:
slot_uri: cim:IdcInverterControl.Delay
range: Delay
required: true
multivalued: false
VDCOL:
class_uri: cim:VDCOL
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.InfHVDCDynamics.CSC
attributes:
IdcInverterControl:
slot_uri: cim:VDCOL.IdcInverterControl
range: IdcInverterControl
required: false
multivalued: false
HVDCLookUpTable:
slot_uri: cim:VDCOL.HVDCLookUpTable
range: HVDCLookUpTable
required: true
multivalued: true
Delay:
slot_uri: cim:VDCOL.Delay
range: Delay
required: true
multivalued: false
HVDCLookUpTable:
class_uri: cim:HVDCLookUpTable
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.InfHVDCDynamics
attributes:
functionKind:
slot_uri: cim:HVDCLookUpTable.functionKind
range: LookUpTableFunctionKind
required: false
multivalued: false
input:
slot_uri: cim:HVDCLookUpTable.input
range: float
required: false
multivalued: false
output:
slot_uri: cim:HVDCLookUpTable.output
range: float
required: false
multivalued: false
sequence:
slot_uri: cim:HVDCLookUpTable.sequence
range: integer
required: false
multivalued: false
Qregulator:
slot_uri: cim:HVDCLookUpTable.Qregulator
range: Qregulator
required: false
multivalued: false
VDCOL:
slot_uri: cim:HVDCLookUpTable.VDCOL
range: VDCOL
required: false
multivalued: false
Qregulator:
class_uri: cim:Qregulator
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.InfHVDCDynamics.VSC
attributes:
VSCtype1:
slot_uri: cim:Qregulator.VSCtype1
range: VSCtype1
required: false
multivalued: false
HVDClookUpTable:
slot_uri: cim:Qregulator.HVDClookUpTable
range: HVDCLookUpTable
required: true
multivalued: true
Delay:
slot_uri: cim:Qregulator.Delay
range: Delay
required: true
multivalued: false
VSCtype1:
class_uri: cim:VSCtype1
is_a: VSCDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.InfHVDCDynamics.VSC
attributes:
DCvoltageControl:
slot_uri: cim:VSCtype1.DCvoltageControl
range: DCvoltageControl
required: true
multivalued: false
Umode:
slot_uri: cim:VSCtype1.Umode
range: Umode
required: true
multivalued: false
Qregulator:
slot_uri: cim:VSCtype1.Qregulator
range: Qregulator
required: true
multivalued: false
Qmode:
slot_uri: cim:VSCtype1.Qmode
range: Qmode
required: true
multivalued: false
Qlimiter:
slot_uri: cim:VSCtype1.Qlimiter
range: Qlimiter
required: true
multivalued: false
Pcontrol:
slot_uri: cim:VSCtype1.Pcontrol
range: Pcontrol
required: true
multivalued: false
PFmodel:
slot_uri: cim:VSCtype1.PFmodel
range: PFmode
required: true
multivalued: false
BlockingFunction:
slot_uri: cim:VSCtype1.BlockingFunction
range: BlockingFunction
required: true
multivalued: false
Umode:
class_uri: cim:Umode
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.InfHVDCDynamics.VSC
attributes:
VSCtype1:
slot_uri: cim:Umode.VSCtype1
range: VSCtype1
required: false
multivalued: false
Delay:
slot_uri: cim:Umode.Delay
range: Delay
required: true
multivalued: false
Qmode:
class_uri: cim:Qmode
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.InfHVDCDynamics.VSC
attributes:
VSCtype1:
slot_uri: cim:Qmode.VSCtype1
range: VSCtype1
required: false
multivalued: false
Delay:
slot_uri: cim:Qmode.Delay
range: Delay
required: true
multivalued: false
Qlimiter:
class_uri: cim:Qlimiter
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.InfHVDCDynamics.VSC
attributes:
VSCtype1:
slot_uri: cim:Qlimiter.VSCtype1
range: VSCtype1
required: false
multivalued: false
Delay:
slot_uri: cim:Qlimiter.Delay
range: Delay
required: true
multivalued: false
Pcontrol:
class_uri: cim:Pcontrol
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.InfHVDCDynamics.VSC
attributes:
VSCtype1:
slot_uri: cim:Pcontrol.VSCtype1
range: VSCtype1
required: false
multivalued: false
Delay:
slot_uri: cim:Pcontrol.Delay
range: Delay
required: true
multivalued: false
PFmode:
class_uri: cim:PFmode
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.InfHVDCDynamics.VSC
attributes:
VSCtype1:
slot_uri: cim:PFmode.VSCtype1
range: VSCtype1
required: false
multivalued: false
Delay:
slot_uri: cim:PFmode.Delay
range: Delay
required: true
multivalued: false
BlockingFunction:
class_uri: cim:BlockingFunction
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.InfHVDCDynamics.VSC
attributes:
VSCtype1:
slot_uri: cim:BlockingFunction.VSCtype1
range: VSCtype1
required: false
multivalued: false
Delay:
slot_uri: cim:BlockingFunction.Delay
range: Delay
required: true
multivalued: false
DCvoltageControl:
class_uri: cim:DCvoltageControl
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.InfHVDCDynamics.VSC
description: DC voltage control used for voltage regulation.
attributes:
kivdc:
slot_uri: cim:DCvoltageControl.kivdc
range: PU
required: false
multivalued: false
description: Integral gain of the DC voltage regulator (Kivdc).
kpvdc:
slot_uri: cim:DCvoltageControl.kpvdc
range: PU
required: false
multivalued: false
description: Proportional gain of the DC voltage regulator (Kpvdc).
vdcmax:
slot_uri: cim:DCvoltageControl.vdcmax
range: PU
required: false
multivalued: false
description: Maximum DC voltage (Vdcmax).
vdcmin:
slot_uri: cim:DCvoltageControl.vdcmin
range: PU
required: false
multivalued: false
description: Minimum DC voltage (Vdcmin).
VSCtype1:
slot_uri: cim:DCvoltageControl.VSCtype1
range: VSCtype1
required: false
multivalued: false
Delay:
slot_uri: cim:DCvoltageControl.Delay
range: Delay
required: true
multivalued: false
CSCtype1:
class_uri: cim:CSCtype1
is_a: CSCDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.InfHVDCDynamics.CSC
attributes:
IdcInverterControl:
slot_uri: cim:CSCtype1.IdcInverterControl
range: IdcInverterControl
required: true
multivalued: false
IgnAngleContInverter:
slot_uri: cim:CSCtype1.IgnAngleContInverter
range: IgnAngleContInverter
required: true
multivalued: false
CCArectifierControl:
slot_uri: cim:CSCtype1.CCArectifierControl
range: CCArectifierControl
required: true
multivalued: false
CCAinverter:
slot_uri: cim:CSCtype1.CCAinverter
range: CCAinverter
required: true
multivalued: false
IgnAngleContInverter:
class_uri: cim:IgnAngleContInverter
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.InfHVDCDynamics.CSC
attributes:
CSCtype1:
slot_uri: cim:IgnAngleContInverter.CSCtype1
range: CSCtype1
required: false
multivalued: false
CCArectifierControl:
class_uri: cim:CCArectifierControl
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.InfHVDCDynamics.CSC
attributes:
CSCtype1:
slot_uri: cim:CCArectifierControl.CSCtype1
range: CSCtype1
required: false
multivalued: false
Delay:
slot_uri: cim:CCArectifierControl.Delay
range: Delay
required: true
multivalued: false
CCAinverter:
class_uri: cim:CCAinverter
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.InfHVDCDynamics.CSC
attributes:
CSCtype1:
slot_uri: cim:CCAinverter.CSCtype1
range: CSCtype1
required: false
multivalued: false
Delay:
slot_uri: cim:CCAinverter.Delay
range: Delay
required: true
multivalued: false
SynchronousMachineUserDefined:
class_uri: cim:SynchronousMachineUserDefined
is_a: SynchronousMachineDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.UserDefinedModels
description: Synchronous machine whose dynamic behaviour is described by a user-defined
model.
attributes:
proprietary:
slot_uri: cim:SynchronousMachineUserDefined.proprietary
range: boolean
required: false
multivalued: false
description: "Behaviour is based on a proprietary model as opposed to a detailed\
\ model.\r\ntrue = user-defined model is proprietary with behaviour mutually\
\ understood by sending and receiving applications and parameters passed\
\ as general attributes\r\nfalse = user-defined model is explicitly defined\
\ in terms of control blocks and their input and output signals."
ProprietaryParameterDynamics:
slot_uri: cim:SynchronousMachineUserDefined.ProprietaryParameterDynamics
range: ProprietaryParameterDynamics
required: false
multivalued: true
description: Parameter of this proprietary user-defined model.
ProprietaryParameterDynamics:
class_uri: cim:ProprietaryParameterDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.UserDefinedModels
description: "Supports definition of one or more parameters of several different\
\ datatypes for use by proprietary user-defined models. \r\nThis class does\
\ not inherit from IdentifiedObject since it is not intended that a single instance\
\ of it be referenced by more than one proprietary user-defined model instance."
attributes:
booleanParameterValue:
slot_uri: cim:ProprietaryParameterDynamics.booleanParameterValue
range: boolean
required: false
multivalued: false
description: Boolean parameter value. If this attribute is populated, integerParameterValue
and floatParameterValue will not be.
floatParameterValue:
slot_uri: cim:ProprietaryParameterDynamics.floatParameterValue
range: float
required: false
multivalued: false
description: Floating point parameter value. If this attribute is populated,
booleanParameterValue and integerParameterValue will not be.
integerParameterValue:
slot_uri: cim:ProprietaryParameterDynamics.integerParameterValue
range: integer
required: false
multivalued: false
description: Integer parameter value. If this attribute is populated, booleanParameterValue
and floatParameterValue will not be.
parameterNumber:
slot_uri: cim:ProprietaryParameterDynamics.parameterNumber
range: integer
required: false
multivalued: false
description: Sequence number of the parameter among the set of parameters
associated with the related proprietary user-defined model.
LoadUserDefined:
slot_uri: cim:ProprietaryParameterDynamics.LoadUserDefined
range: LoadUserDefined
required: false
multivalued: false
description: Proprietary user-defined model with which this parameter is associated.
VoltageCompensatorUserDefined:
slot_uri: cim:ProprietaryParameterDynamics.VoltageCompensatorUserDefined
range: VoltageCompensatorUserDefined
required: false
multivalued: false
description: Proprietary user-defined model with which this parameter is associated.
PFVArControllerType2UserDefined:
slot_uri: cim:ProprietaryParameterDynamics.PFVArControllerType2UserDefined
range: PFVArControllerType2UserDefined
required: false
multivalued: false
description: Proprietary user-defined model with which this parameter is associated.
VoltageAdjusterUserDefined:
slot_uri: cim:ProprietaryParameterDynamics.VoltageAdjusterUserDefined
range: VoltageAdjusterUserDefined
required: false
multivalued: false
description: Proprietary user-defined model with which this parameter is associated.
PFVArControllerType1UserDefined:
slot_uri: cim:ProprietaryParameterDynamics.PFVArControllerType1UserDefined
range: PFVArControllerType1UserDefined
required: false
multivalued: false
description: Proprietary user-defined model with which this parameter is associated.
DiscontinuousExcitationControlUserDefined:
slot_uri: cim:ProprietaryParameterDynamics.DiscontinuousExcitationControlUserDefined
range: DiscontinuousExcitationControlUserDefined
required: false
multivalued: false
description: Proprietary user-defined model with which this parameter is associated.
PowerSystemStabilizerUserDefined:
slot_uri: cim:ProprietaryParameterDynamics.PowerSystemStabilizerUserDefined
range: PowerSystemStabilizerUserDefined
required: false
multivalued: false
description: Proprietary user-defined model with which this parameter is associated.
UnderexcitationLimiterUserDefined:
slot_uri: cim:ProprietaryParameterDynamics.UnderexcitationLimiterUserDefined
range: UnderexcitationLimiterUserDefined
required: false
multivalued: false
description: Proprietary user-defined model with which this parameter is associated.
OverexcitationLimiterUserDefined:
slot_uri: cim:ProprietaryParameterDynamics.OverexcitationLimiterUserDefined
range: OverexcitationLimiterUserDefined
required: false
multivalued: false
description: Proprietary user-defined model with which this parameter is associated.
ExcitationSystemUserDefined:
slot_uri: cim:ProprietaryParameterDynamics.ExcitationSystemUserDefined
range: ExcitationSystemUserDefined
required: false
multivalued: false
description: Proprietary user-defined model with which this parameter is associated.
MechanicalLoadUserDefined:
slot_uri: cim:ProprietaryParameterDynamics.MechanicalLoadUserDefined
range: MechanicalLoadUserDefined
required: false
multivalued: false
description: Proprietary user-defined model with which this parameter is associated.
TurbineLoadControllerUserDefined:
slot_uri: cim:ProprietaryParameterDynamics.TurbineLoadControllerUserDefined
range: TurbineLoadControllerUserDefined
required: false
multivalued: false
description: Proprietary user-defined model with which this parameter is associated.
TurbineGovernorUserDefined:
slot_uri: cim:ProprietaryParameterDynamics.TurbineGovernorUserDefined
range: TurbineGovernorUserDefined
required: false
multivalued: false
description: Proprietary user-defined model with which this parameter is associated.
AsynchronousMachineUserDefined:
slot_uri: cim:ProprietaryParameterDynamics.AsynchronousMachineUserDefined
range: AsynchronousMachineUserDefined
required: false
multivalued: false
description: Proprietary user-defined model with which this parameter is associated.
SynchronousMachineUserDefined:
slot_uri: cim:ProprietaryParameterDynamics.SynchronousMachineUserDefined
range: SynchronousMachineUserDefined
required: false
multivalued: false
description: Proprietary user-defined model with which this parameter is associated.
SVCUserDefined:
slot_uri: cim:ProprietaryParameterDynamics.SVCUserDefined
range: SVCUserDefined
required: false
multivalued: false
description: Proprietary user-defined model with which this parameter is associated.
VSCUserDefined:
slot_uri: cim:ProprietaryParameterDynamics.VSCUserDefined
range: VSCUserDefined
required: false
multivalued: false
description: Proprietary user-defined model with which this parameter is associated.
CSCUserDefined:
slot_uri: cim:ProprietaryParameterDynamics.CSCUserDefined
range: CSCUserDefined
required: false
multivalued: false
description: Proprietary user-defined model with which this parameter is associated.
WindPlantUserDefined:
slot_uri: cim:ProprietaryParameterDynamics.WindPlantUserDefined
range: WindPlantUserDefined
required: false
multivalued: false
description: Proprietary user-defined model with which this parameter is associated.
WindType3or4UserDefined:
slot_uri: cim:ProprietaryParameterDynamics.WindType3or4UserDefined
range: WindType3or4UserDefined
required: false
multivalued: false
description: Proprietary user-defined model with which this parameter is associated.
WindType1or2UserDefined:
slot_uri: cim:ProprietaryParameterDynamics.WindType1or2UserDefined
range: WindType1or2UserDefined
required: false
multivalued: false
description: Proprietary user-defined model with which this parameter is associated.
SVCUserDefined:
class_uri: cim:SVCUserDefined
is_a: StaticVarCompensatorDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.UserDefinedModels
description: Static var compensator (SVC) function block whose dynamic behaviour
is described by a user-defined model.
attributes:
proprietary:
slot_uri: cim:SVCUserDefined.proprietary
range: boolean
required: false
multivalued: false
description: "Behaviour is based on a proprietary model as opposed to a detailed\
\ model.\r\ntrue = user-defined model is proprietary with behaviour mutually\
\ understood by sending and receiving applications and parameters passed\
\ as general attributes\r\nfalse = user-defined model is explicitly defined\
\ in terms of control blocks and their input and output signals."
ProprietaryParameterDynamics:
slot_uri: cim:SVCUserDefined.ProprietaryParameterDynamics
range: ProprietaryParameterDynamics
required: false
multivalued: true
description: Parameter of this proprietary user-defined model.
VSCUserDefined:
class_uri: cim:VSCUserDefined
is_a: VSCDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.UserDefinedModels
description: Voltage source converter (VSC) function block whose dynamic behaviour
is described by a user-defined model.
attributes:
proprietary:
slot_uri: cim:VSCUserDefined.proprietary
range: boolean
required: false
multivalued: false
description: "Behaviour is based on a proprietary model as opposed to a detailed\
\ model.\r\ntrue = user-defined model is proprietary with behaviour mutually\
\ understood by sending and receiving applications and parameters passed\
\ as general attributes\r\nfalse = user-defined model is explicitly defined\
\ in terms of control blocks and their input and output signals."
ProprietaryParameterDynamics:
slot_uri: cim:VSCUserDefined.ProprietaryParameterDynamics
range: ProprietaryParameterDynamics
required: false
multivalued: true
description: Parameter of this proprietary user-defined model.
CSCUserDefined:
class_uri: cim:CSCUserDefined
is_a: CSCDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.UserDefinedModels
description: Current source converter (CSC) function block whose dynamic behaviour
is described by a user-defined model.
attributes:
proprietary:
slot_uri: cim:CSCUserDefined.proprietary
range: boolean
required: false
multivalued: false
description: "Behaviour is based on a proprietary model as opposed to a detailed\
\ model.\r\ntrue = user-defined model is proprietary with behaviour mutually\
\ understood by sending and receiving applications and parameters passed\
\ as general attributes\r\nfalse = user-defined model is explicitly defined\
\ in terms of control blocks and their input and output signals."
ProprietaryParameterDynamics:
slot_uri: cim:CSCUserDefined.ProprietaryParameterDynamics
range: ProprietaryParameterDynamics
required: false
multivalued: true
description: Parameter of this proprietary user-defined model.
WindPlantUserDefined:
class_uri: cim:WindPlantUserDefined
is_a: WindPlantDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.UserDefinedModels
description: Wind plant function block whose dynamic behaviour is described by
a user-defined model.
attributes:
proprietary:
slot_uri: cim:WindPlantUserDefined.proprietary
range: boolean
required: false
multivalued: false
description: "Behaviour is based on a proprietary model as opposed to a detailed\
\ model.\r\ntrue = user-defined model is proprietary with behaviour mutually\
\ understood by sending and receiving applications and parameters passed\
\ as general attributes\r\nfalse = user-defined model is explicitly defined\
\ in terms of control blocks and their input and output signals."
ProprietaryParameterDynamics:
slot_uri: cim:WindPlantUserDefined.ProprietaryParameterDynamics
range: ProprietaryParameterDynamics
required: false
multivalued: true
description: Parameter of this proprietary user-defined model.
WindType3or4UserDefined:
class_uri: cim:WindType3or4UserDefined
is_a: WindTurbineType3or4Dynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.UserDefinedModels
description: Wind type 3 or type 4 function block whose dynamic behaviour is described
by a user-defined model.
attributes:
proprietary:
slot_uri: cim:WindType3or4UserDefined.proprietary
range: boolean
required: false
multivalued: false
description: "Behaviour is based on a proprietary model as opposed to a detailed\
\ model.\r\ntrue = user-defined model is proprietary with behaviour mutually\
\ understood by sending and receiving applications and parameters passed\
\ as general attributes\r\nfalse = user-defined model is explicitly defined\
\ in terms of control blocks and their input and output signals."
ProprietaryParameterDynamics:
slot_uri: cim:WindType3or4UserDefined.ProprietaryParameterDynamics
range: ProprietaryParameterDynamics
required: false
multivalued: true
description: Parameter of this proprietary user-defined model.
WindType1or2UserDefined:
class_uri: cim:WindType1or2UserDefined
is_a: WindTurbineType1or2Dynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.UserDefinedModels
description: Wind type 1 or type 2 function block whose dynamic behaviour is described
by a user-defined model.
attributes:
proprietary:
slot_uri: cim:WindType1or2UserDefined.proprietary
range: boolean
required: false
multivalued: false
description: "Behaviour is based on a proprietary model as opposed to a detailed\
\ model.\r\ntrue = user-defined model is proprietary with behaviour mutually\
\ understood by sending and receiving applications and parameters passed\
\ as general attributes\r\nfalse = user-defined model is explicitly defined\
\ in terms of control blocks and their input and output signals."
ProprietaryParameterDynamics:
slot_uri: cim:WindType1or2UserDefined.ProprietaryParameterDynamics
range: ProprietaryParameterDynamics
required: false
multivalued: true
description: Parameter of this proprietary user-defined model.
LoadUserDefined:
class_uri: cim:LoadUserDefined
is_a: LoadDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.UserDefinedModels
description: Load whose dynamic behaviour is described by a user-defined model.
attributes:
proprietary:
slot_uri: cim:LoadUserDefined.proprietary
range: boolean
required: false
multivalued: false
description: "Behaviour is based on a proprietary model as opposed to a detailed\
\ model.\r\ntrue = user-defined model is proprietary with behaviour mutually\
\ understood by sending and receiving applications and parameters passed\
\ as general attributes\r\nfalse = user-defined model is explicitly defined\
\ in terms of control blocks and their input and output signals."
ProprietaryParameterDynamics:
slot_uri: cim:LoadUserDefined.ProprietaryParameterDynamics
range: ProprietaryParameterDynamics
required: false
multivalued: true
description: Parameter of this proprietary user-defined model.
VoltageCompensatorUserDefined:
class_uri: cim:VoltageCompensatorUserDefined
is_a: VoltageCompensatorDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.UserDefinedModels
description: Voltage compensator function block whose dynamic behaviour is described
by a user-defined model.
attributes:
proprietary:
slot_uri: cim:VoltageCompensatorUserDefined.proprietary
range: boolean
required: false
multivalued: false
description: "Behaviour is based on a proprietary model as opposed to a detailed\
\ model.\r\ntrue = user-defined model is proprietary with behaviour mutually\
\ understood by sending and receiving applications and parameters passed\
\ as general attributes\r\nfalse = user-defined model is explicitly defined\
\ in terms of control blocks and their input and output signals."
ProprietaryParameterDynamics:
slot_uri: cim:VoltageCompensatorUserDefined.ProprietaryParameterDynamics
range: ProprietaryParameterDynamics
required: false
multivalued: true
description: Parameter of this proprietary user-defined model.
PFVArControllerType2UserDefined:
class_uri: cim:PFVArControllerType2UserDefined
is_a: PFVArControllerType2Dynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.UserDefinedModels
description: Power factor or VAr controller type 2 function block whose dynamic
behaviour is described by a user-defined model.
attributes:
proprietary:
slot_uri: cim:PFVArControllerType2UserDefined.proprietary
range: boolean
required: false
multivalued: false
description: "Behaviour is based on a proprietary model as opposed to a detailed\
\ model.\r\ntrue = user-defined model is proprietary with behaviour mutually\
\ understood by sending and receiving applications and parameters passed\
\ as general attributes\r\nfalse = user-defined model is explicitly defined\
\ in terms of control blocks and their input and output signals."
ProprietaryParameterDynamics:
slot_uri: cim:PFVArControllerType2UserDefined.ProprietaryParameterDynamics
range: ProprietaryParameterDynamics
required: false
multivalued: true
description: Parameter of this proprietary user-defined model.
VoltageAdjusterUserDefined:
class_uri: cim:VoltageAdjusterUserDefined
is_a: VoltageAdjusterDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.UserDefinedModels
description: Voltage adjuster function block whose
dynamic behaviour is described by a user-defined model.
attributes:
proprietary:
slot_uri: cim:VoltageAdjusterUserDefined.proprietary
range: boolean
required: false
multivalued: false
description: "Behaviour is based on a proprietary model as opposed to a detailed\
\ model.\r\ntrue = user-defined model is proprietary with behaviour mutually\
\ understood by sending and receiving applications and parameters passed\
\ as general attributes\r\nfalse = user-defined model is explicitly defined\
\ in terms of control blocks and their input and output signals."
ProprietaryParameterDynamics:
slot_uri: cim:VoltageAdjusterUserDefined.ProprietaryParameterDynamics
range: ProprietaryParameterDynamics
required: false
multivalued: true
description: Parameter of this proprietary user-defined model.
PFVArControllerType1UserDefined:
class_uri: cim:PFVArControllerType1UserDefined
is_a: PFVArControllerType1Dynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.UserDefinedModels
description: Power factor or VAr controller type 1 function block whose dynamic
behaviour is described by a user-defined model.
attributes:
proprietary:
slot_uri: cim:PFVArControllerType1UserDefined.proprietary
range: boolean
required: false
multivalued: false
description: "Behaviour is based on a proprietary model as opposed to a detailed\
\ model.\r\ntrue = user-defined model is proprietary with behaviour mutually\
\ understood by sending and receiving applications and parameters passed\
\ as general attributes\r\nfalse = user-defined model is explicitly defined\
\ in terms of control blocks and their input and output signals."
ProprietaryParameterDynamics:
slot_uri: cim:PFVArControllerType1UserDefined.ProprietaryParameterDynamics
range: ProprietaryParameterDynamics
required: false
multivalued: true
description: Parameter of this proprietary user-defined model.
DiscontinuousExcitationControlUserDefined:
class_uri: cim:DiscontinuousExcitationControlUserDefined
is_a: DiscontinuousExcitationControlDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.UserDefinedModels
description: Discontinuous excitation control function block whose dynamic behaviour
is described by a user-defined model.
attributes:
proprietary:
slot_uri: cim:DiscontinuousExcitationControlUserDefined.proprietary
range: boolean
required: false
multivalued: false
description: "Behaviour is based on a proprietary model as opposed to a detailed\
\ model.\r\ntrue = user-defined model is proprietary with behaviour mutually\
\ understood by sending and receiving applications and parameters passed\
\ as general attributes\r\nfalse = user-defined model is explicitly defined\
\ in terms of control blocks and their input and output signals."
ProprietaryParameterDynamics:
slot_uri: cim:DiscontinuousExcitationControlUserDefined.ProprietaryParameterDynamics
range: ProprietaryParameterDynamics
required: false
multivalued: true
description: Parameter of this proprietary user-defined model.
PowerSystemStabilizerUserDefined:
class_uri: cim:PowerSystemStabilizerUserDefined
is_a: PowerSystemStabilizerDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.UserDefinedModels
description: Power system stabilizer function block
whose dynamic behaviour is described by a user-defined
model.
attributes:
proprietary:
slot_uri: cim:PowerSystemStabilizerUserDefined.proprietary
range: boolean
required: false
multivalued: false
description: "Behaviour is based on a proprietary model as opposed to a detailed\
\ model.\r\ntrue = user-defined model is proprietary with behaviour mutually\
\ understood by sending and receiving applications and parameters passed\
\ as general attributes\r\nfalse = user-defined model is explicitly defined\
\ in terms of control blocks and their input and output signals."
ProprietaryParameterDynamics:
slot_uri: cim:PowerSystemStabilizerUserDefined.ProprietaryParameterDynamics
range: ProprietaryParameterDynamics
required: false
multivalued: true
description: Parameter of this proprietary user-defined model.
UnderexcitationLimiterUserDefined:
class_uri: cim:UnderexcitationLimiterUserDefined
is_a: UnderexcitationLimiterDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.UserDefinedModels
description: Underexcitation limiter function block whose dynamic behaviour is
described by a user-defined model.
attributes:
proprietary:
slot_uri: cim:UnderexcitationLimiterUserDefined.proprietary
range: boolean
required: false
multivalued: false
description: "Behaviour is based on a proprietary model as opposed to a detailed\
\ model.\r\ntrue = user-defined model is proprietary with behaviour mutually\
\ understood by sending and receiving applications and parameters passed\
\ as general attributes\r\nfalse = user-defined model is explicitly defined\
\ in terms of control blocks and their input and output signals."
ProprietaryParameterDynamics:
slot_uri: cim:UnderexcitationLimiterUserDefined.ProprietaryParameterDynamics
range: ProprietaryParameterDynamics
required: false
multivalued: true
description: Parameter of this proprietary user-defined model.
OverexcitationLimiterUserDefined:
class_uri: cim:OverexcitationLimiterUserDefined
is_a: OverexcitationLimiterDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.UserDefinedModels
description: Overexcitation limiter system function block whose dynamic behaviour
is described by a user-defined model.
attributes:
proprietary:
slot_uri: cim:OverexcitationLimiterUserDefined.proprietary
range: boolean
required: false
multivalued: false
description: "Behaviour is based on a proprietary model as opposed to a detailed\
\ model.\r\ntrue = user-defined model is proprietary with behaviour mutually\
\ understood by sending and receiving applications and parameters passed\
\ as general attributes\r\nfalse = user-defined model is explicitly defined\
\ in terms of control blocks and their input and output signals."
ProprietaryParameterDynamics:
slot_uri: cim:OverexcitationLimiterUserDefined.ProprietaryParameterDynamics
range: ProprietaryParameterDynamics
required: false
multivalued: true
description: Parameter of this proprietary user-defined model.
ExcitationSystemUserDefined:
class_uri: cim:ExcitationSystemUserDefined
is_a: ExcitationSystemDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.UserDefinedModels
description: Excitation system function block whose dynamic behaviour is described
by a user-defined model.
attributes:
proprietary:
slot_uri: cim:ExcitationSystemUserDefined.proprietary
range: boolean
required: false
multivalued: false
description: "Behaviour is based on a proprietary model as opposed to a detailed\
\ model.\r\ntrue = user-defined model is proprietary with behaviour mutually\
\ understood by sending and receiving applications and parameters passed\
\ as general attributes\r\nfalse = user-defined model is explicitly defined\
\ in terms of control blocks and their input and output signals."
ProprietaryParameterDynamics:
slot_uri: cim:ExcitationSystemUserDefined.ProprietaryParameterDynamics
range: ProprietaryParameterDynamics
required: false
multivalued: true
description: Parameter of this proprietary user-defined model.
MechanicalLoadUserDefined:
class_uri: cim:MechanicalLoadUserDefined
is_a: MechanicalLoadDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.UserDefinedModels
description: Mechanical load function block whose dynamic behaviour is described
by a user-defined model.
attributes:
proprietary:
slot_uri: cim:MechanicalLoadUserDefined.proprietary
range: boolean
required: false
multivalued: false
description: "Behaviour is based on a proprietary model as opposed to a detailed\
\ model.\r\ntrue = user-defined model is proprietary with behaviour mutually\
\ understood by sending and receiving applications and parameters passed\
\ as general attributes\r\nfalse = user-defined model is explicitly defined\
\ in terms of control blocks and their input and output signals."
ProprietaryParameterDynamics:
slot_uri: cim:MechanicalLoadUserDefined.ProprietaryParameterDynamics
range: ProprietaryParameterDynamics
required: false
multivalued: true
description: Parameter of this proprietary user-defined model.
TurbineLoadControllerUserDefined:
class_uri: cim:TurbineLoadControllerUserDefined
is_a: TurbineLoadControllerDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.UserDefinedModels
description: Turbine load controller function block whose dynamic behaviour is
described by a user-defined model.
attributes:
proprietary:
slot_uri: cim:TurbineLoadControllerUserDefined.proprietary
range: boolean
required: false
multivalued: false
description: "Behaviour is based on a proprietary model as opposed to a detailed\
\ model.\r\ntrue = user-defined model is proprietary with behaviour mutually\
\ understood by sending and receiving applications and parameters passed\
\ as general attributes\r\nfalse = user-defined model is explicitly defined\
\ in terms of control blocks and their input and output signals."
ProprietaryParameterDynamics:
slot_uri: cim:TurbineLoadControllerUserDefined.ProprietaryParameterDynamics
range: ProprietaryParameterDynamics
required: false
multivalued: true
description: Parameter of this proprietary user-defined model.
TurbineGovernorUserDefined:
class_uri: cim:TurbineGovernorUserDefined
is_a: TurbineGovernorDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.UserDefinedModels
description: Turbine-governor function block whose dynamic behaviour is described
by a user-defined model.
attributes:
proprietary:
slot_uri: cim:TurbineGovernorUserDefined.proprietary
range: boolean
required: false
multivalued: false
description: "Behaviour is based on a proprietary model as opposed to a detailed\
\ model.\r\ntrue = user-defined model is proprietary with behaviour mutually\
\ understood by sending and receiving applications and parameters passed\
\ as general attributes\r\nfalse = user-defined model is explicitly defined\
\ in terms of control blocks and their input and output signals."
ProprietaryParameterDynamics:
slot_uri: cim:TurbineGovernorUserDefined.ProprietaryParameterDynamics
range: ProprietaryParameterDynamics
required: false
multivalued: true
description: Parameter of this proprietary user-defined model.
AsynchronousMachineUserDefined:
class_uri: cim:AsynchronousMachineUserDefined
is_a: AsynchronousMachineDynamics
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.UserDefinedModels
description: Asynchronous machine whose dynamic behaviour is described by a user-defined
model.
attributes:
proprietary:
slot_uri: cim:AsynchronousMachineUserDefined.proprietary
range: boolean
required: false
multivalued: false
description: "Behaviour is based on a proprietary model as opposed to a detailed\
\ model.\r\ntrue = user-defined model is proprietary with behaviour mutually\
\ understood by sending and receiving applications and parameters passed\
\ as general attributes\r\nfalse = user-defined model is explicitly defined\
\ in terms of control blocks and their input and output signals."
ProprietaryParameterDynamics:
slot_uri: cim:AsynchronousMachineUserDefined.ProprietaryParameterDynamics
range: ProprietaryParameterDynamics
required: false
multivalued: true
description: Parameter of this proprietary user-defined model.
GeneratorTypeAsset:
class_uri: cim:GeneratorTypeAsset
is_a: CatalogAssetType
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfTypeAsset
description: "Generic generation equipment that may be used for various purposes\
\ such as work planning. It defines both the Real and Reactive power properties\
\ (modelled at the PSR level as a GeneratingUnit + SynchronousMachine).\r\n"
attributes:
maxP:
slot_uri: cim:GeneratorTypeAsset.maxP
range: ActivePower
required: false
multivalued: false
description: Maximum real power limit.
maxQ:
slot_uri: cim:GeneratorTypeAsset.maxQ
range: ReactivePower
required: false
multivalued: false
description: Maximum reactive power limit.
minP:
slot_uri: cim:GeneratorTypeAsset.minP
range: ActivePower
required: false
multivalued: false
description: Minimum real power generated.
minQ:
slot_uri: cim:GeneratorTypeAsset.minQ
range: ReactivePower
required: false
multivalued: false
description: Minimum reactive power generated.
rDirectSubtrans:
slot_uri: cim:GeneratorTypeAsset.rDirectSubtrans
range: Resistance
required: false
multivalued: false
description: "Direct-axis subtransient resistance.\r\n"
rDirectSync:
slot_uri: cim:GeneratorTypeAsset.rDirectSync
range: Resistance
required: false
multivalued: false
description: "Direct-axis synchronous resistance.\r\n"
rDirectTrans:
slot_uri: cim:GeneratorTypeAsset.rDirectTrans
range: Resistance
required: false
multivalued: false
description: "Direct-axis transient resistance.\r\n"
rQuadSubtrans:
slot_uri: cim:GeneratorTypeAsset.rQuadSubtrans
range: Resistance
required: false
multivalued: false
description: "Quadrature-axis subtransient resistance.\r\n"
rQuadSync:
slot_uri: cim:GeneratorTypeAsset.rQuadSync
range: Resistance
required: false
multivalued: false
description: "Quadrature-axis synchronous resistance.\r\n"
rQuadTrans:
slot_uri: cim:GeneratorTypeAsset.rQuadTrans
range: Resistance
required: false
multivalued: false
description: "Quadrature-axis transient resistance.\r\n"
xDirectSubtrans:
slot_uri: cim:GeneratorTypeAsset.xDirectSubtrans
range: Reactance
required: false
multivalued: false
description: "Direct-axis subtransient reactance.\r\n"
xDirectSync:
slot_uri: cim:GeneratorTypeAsset.xDirectSync
range: Reactance
required: false
multivalued: false
description: "Direct-axis synchronous reactance.\r\n"
xDirectTrans:
slot_uri: cim:GeneratorTypeAsset.xDirectTrans
range: Reactance
required: false
multivalued: false
description: "Direct-axis transient reactance.\r\n"
xQuadSubtrans:
slot_uri: cim:GeneratorTypeAsset.xQuadSubtrans
range: Reactance
required: false
multivalued: false
description: "Quadrature-axis subtransient reactance.\r\n"
xQuadSync:
slot_uri: cim:GeneratorTypeAsset.xQuadSync
range: Reactance
required: false
multivalued: false
description: "Quadrature-axis synchronous reactance.\r\n"
xQuadTrans:
slot_uri: cim:GeneratorTypeAsset.xQuadTrans
range: Reactance
required: false
multivalued: false
description: Quadrature-axis transient reactance.
NonStandardItem:
class_uri: cim:NonStandardItem
is_a: WorkDocument
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfWork
description: "This document provides information for non-standard items like customer\
\ contributions (e.g., customer digs trench), vouchers (e.g., credit), and contractor\
\ bids. \r\n"
attributes:
amount:
slot_uri: cim:NonStandardItem.amount
range: Money
required: false
multivalued: false
description: The projected cost for this item.
AccessPermit:
class_uri: cim:AccessPermit
is_a: WorkDocument
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfWork
description: "A permit is sometimes needed to provide legal access to land or\
\ equipment. For example, local authority permission for road works.\r\n"
attributes:
applicationNumber:
slot_uri: cim:AccessPermit.applicationNumber
range: string
required: false
multivalued: false
description: ' Permit application number that is used by municipality, state,
province, etc.'
effectiveDate:
slot_uri: cim:AccessPermit.effectiveDate
range: date
required: false
multivalued: false
description: "Date that permit became official.\r\n"
expirationDate:
slot_uri: cim:AccessPermit.expirationDate
range: date
required: false
multivalued: false
description: "Permit expiration date.\r\n"
payment:
slot_uri: cim:AccessPermit.payment
range: Money
required: false
multivalued: false
description: Total cost of permit.
permitID:
slot_uri: cim:AccessPermit.permitID
range: string
required: false
multivalued: false
description: Permit identifier.
Regulation:
class_uri: cim:Regulation
is_a: WorkDocument
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfWork
description: Special requirements and/or regulations may pertain to certain types
of assets or work. For example, fire protection and scaffolding.
attributes:
referenceNumber:
slot_uri: cim:Regulation.referenceNumber
range: string
required: false
multivalued: false
description: ' External reference to regulation, if applicable.'
InfoQuestion:
class_uri: cim:InfoQuestion
is_a: WorkDocument
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfWork
description: "Questions and answers associated with a type of document for purposes\
\ of clarification. Questions may be predefined or ad hoc.\r\n"
attributes:
answer:
slot_uri: cim:InfoQuestion.answer
range: string
required: false
multivalued: false
description: Answer to question.
answerDateTime:
slot_uri: cim:InfoQuestion.answerDateTime
range: date
required: false
multivalued: false
description: "The date and time the quesiton was answered.\r\n"
answerRemark:
slot_uri: cim:InfoQuestion.answerRemark
range: string
required: false
multivalued: false
description: Remarks to qualify the answer.
questionCode:
slot_uri: cim:InfoQuestion.questionCode
range: string
required: false
multivalued: false
description: The question code. If blank, refer to questionText.
questionRemark:
slot_uri: cim:InfoQuestion.questionRemark
range: string
required: false
multivalued: false
description: Remarks to qualify the question in this situation.
questionText:
slot_uri: cim:InfoQuestion.questionText
range: string
required: false
multivalued: false
description: For non-coded questions, the question is provided here.
questionType:
slot_uri: cim:InfoQuestion.questionType
range: string
required: false
multivalued: false
description: "The type of the question.\r\n"
ErpEngChangeOrder:
class_uri: cim:ErpEngChangeOrder
is_a: ErpDocument
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfERPSupport
description: General Utility Engineering Change Order information.
ErpChartOfAccounts:
class_uri: cim:ErpChartOfAccounts
is_a: ErpDocument
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfERPSupport
description: Accounting structure of a business. Each account represents a financial
aspect of a business, such as its Accounts Payable, or the value of its inventory,
or its office supply expenses.
ErpSalesOrder:
class_uri: cim:ErpSalesOrder
is_a: ErpDocument
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfERPSupport
description: "General purpose Sales Order is used for utility service orders,\
\ etc.\r\nAs used by the OAG, the SalesOrder is a step beyond a PurchaseOrder\
\ in that the receiving entity of the order also communicates SalesInformoration\
\ about the Order along with the Order itself."
ErpBankAccount:
class_uri: cim:ErpBankAccount
is_a: BankAccount
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfERPSupport
description: "Relationship under a particular name, usually evidenced by a deposit\
\ against which withdrawals can be made. Types of bank accounts include: demand,\
\ time, custodial, joint, trustee, corporate, special, and regular accounts.\r\
\nA statement of transactions during a fiscal period and the resulting balance\
\ is maintained on each account.\r\nFor Payment metering, the account is associated\
\ with Bank and Supplier, reflecting details of the bank account used for depositing\
\ revenue collected by TokenVendor. The name of the account holder should be\
\ specified in 'name' attribute."
attributes:
bankABA:
slot_uri: cim:ErpBankAccount.bankABA
range: string
required: false
multivalued: false
description: Bank ABA.
ErpInventoryCount:
class_uri: cim:ErpInventoryCount
is_a: ErpIdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfERPSupport
description: "This is related to Inventory physical counts organized by AssetModel.\
\ Note that a count of a type of asset can be accomplished by the association\
\ inherited by AssetModel (from Document) to Asset.\r\nIt enables ERP applications\
\ to transfer an inventory count between ERP and the actual physical inventory\
\ location. This count may be a cycle count or a physical count."
attributes:
status:
slot_uri: cim:ErpInventoryCount.status
range: Status
required: false
multivalued: false
Zone:
class_uri: cim:Zone
is_a: Location
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfLocations
description: Area divided off from other areas. It may be part of the electrical
network, a land area where special restrictions apply, weather areas, etc. For
weather, it is an area where a set of relatively homogenous weather measurements
apply.
attributes:
kind:
slot_uri: cim:Zone.kind
range: ZoneKind
required: false
multivalued: false
description: Kind of this zone.
RedLine:
class_uri: cim:RedLine
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfLocations
description: This class is used for handling the accompanying annotations, time
stamp, author, etc. of designs, drawings and maps. A red line can be associated
with any Location object.
attributes:
status:
slot_uri: cim:RedLine.status
range: Status
required: false
multivalued: false
BusinessPlan:
class_uri: cim:BusinessPlan
is_a: Document
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfCommon
description: A BusinessPlan is an organized sequence of predetermined actions
required to complete a future organizational objective. It is a type of document
that typically references a schedule, physical and/or logical resources (assets
and/or PowerSystemResources), locations, etc.
DocumentOrganisationRole:
class_uri: cim:DocumentOrganisationRole
is_a: OrganisationRole
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfCommon
description: "Role an organisation plays with respect to documents.\r\n"
OrgOrgRole:
class_uri: cim:OrgOrgRole
is_a: OrganisationRole
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfCommon
description: "Roles played between Organisations and other Organisations. This\
\ includes role ups for ogranisations, cost centers, profit centers, regulatory\
\ reporting, etc.\r\nNote that the parent and child relationship is indicated\
\ by the name on each end of the association."
attributes:
clientID:
slot_uri: cim:OrgOrgRole.clientID
range: string
required: false
multivalued: false
description: Identifiers of the organisation held by another organisation,
such as a government agency (federal, state, province, city, county), financial
institution (Dun and Bradstreet), etc.
BusinessRole:
class_uri: cim:BusinessRole
is_a: OrganisationRole
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfCommon
description: "A business role that this organisation plays. A single organisation\
\ typically performs many functions, each one described as a role.\r\n"
attributes:
status:
slot_uri: cim:BusinessRole.status
range: Status
required: false
multivalued: false
type:
slot_uri: cim:BusinessRole.type
range: string
required: false
multivalued: false
description: "Classification by utility's corporate standards and practices.\r\
\n"
Ratio:
class_uri: cim:Ratio
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfCommon
description: "Fraction specified explicitly with a numerator and denominator,\
\ which can be used to calculate the quotient.\r\n"
attributes:
denominator:
slot_uri: cim:Ratio.denominator
range: float
required: false
multivalued: false
description: The part of a fraction that is below the line and that functions
as the divisor of the numerator.
numerator:
slot_uri: cim:Ratio.numerator
range: float
required: false
multivalued: false
description: The part of a fraction that is above the line and signifies the
number to be divided by the denominator.
OilAnalysisMoistureAnalog:
class_uri: cim:OilAnalysisMoistureAnalog
is_a: AssetAnalog
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetMeas
description: "Asset oil analysis moisture type of analog.\r\n"
attributes:
kind:
slot_uri: cim:OilAnalysisMoistureAnalog.kind
range: OilAnalysisMoistureAnalogKind
required: false
multivalued: false
description: Kind of analog representing oil moisture analysis result.
AssetAnalog:
class_uri: cim:AssetAnalog
is_a: Analog
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetMeas
description: "Definition of type of analog useful in asset domain.\r\n"
attributes:
detectionLimit:
slot_uri: cim:AssetAnalog.detectionLimit
range: float
required: false
multivalued: false
description: Detection limit of related analog value if different from detection
limit of test standard or if there is no test standard. The detection limit
(also known as lower limit of detection or limit of detection (LOD), is
the lowest quantity of a substance that can be distinguished from the absence
of that substance (a blank value) within a stated confidence limit (generally
1%).
precision:
slot_uri: cim:AssetAnalog.precision
range: float
required: false
multivalued: false
description: Precision of related analog value if different from precision
of test standard or if there is no test standard. Precision is a measure
of how closely individual measurements agree with one another. Expressed
as 'plus or minus' the value of this attribute.
reportingTemperature:
slot_uri: cim:AssetAnalog.reportingTemperature
range: Temperature
required: false
multivalued: false
description: "Reporting temperature of related analog value if different from\
\ reporting temperature of test standard or if there is no test standard.\
\ Reporting temperature is what gas volumes are normalized to. Different\
\ reporting temperatures are used by different sources. For example, ASTM\
\ specifies 0\xB0C, whereas IEC specifies 20\xB0C. Online monitors often\
\ have their own unique reporting temperatures. "
TestStandard:
slot_uri: cim:AssetAnalog.TestStandard
range: TestStandard
required: false
multivalued: false
description: The lab test standard to which this asset health analog is related.
TestStandard:
class_uri: cim:TestStandard
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: The precise standard used in executing a lab test, including the
standard, and standard version, test method and variant, if needed.
attributes:
testMethod:
slot_uri: cim:TestStandard.testMethod
range: TestMethod
required: false
multivalued: false
description: Identification of test method used if multiple methods specified
by test standard.
testStandardASTM:
slot_uri: cim:TestStandard.testStandardASTM
range: ASTMStandard
required: false
multivalued: false
description: Which ASTM standard used to determine analog value result. Applies
only if ASTM standard used.
testStandardCIGRE:
slot_uri: cim:TestStandard.testStandardCIGRE
range: CIGREStandard
required: false
multivalued: false
description: Which CIGRE standard used to determine analog value result. Applies
only if CIGRE standard used.
testStandardDIN:
slot_uri: cim:TestStandard.testStandardDIN
range: DINStandard
required: false
multivalued: false
description: Which DIN standard used to determine analog value result. Applies
only if DIN standard used.
testStandardDoble:
slot_uri: cim:TestStandard.testStandardDoble
range: DobleStandard
required: false
multivalued: false
description: Which Doble standard used to determine analog value result. Applies
only if Doble standard used.
testStandardEPA:
slot_uri: cim:TestStandard.testStandardEPA
range: EPAStandard
required: false
multivalued: false
description: Which EPA standard used to determine analog value result. Applies
only if EPA standard used.
testStandardIEC:
slot_uri: cim:TestStandard.testStandardIEC
range: IECStandard
required: false
multivalued: false
description: Which IEC standard used to determine analog value result. Applies
only if IEC standard used.
testStandardIEEE:
slot_uri: cim:TestStandard.testStandardIEEE
range: IEEEStandard
required: false
multivalued: false
description: Which IEEE standard used to determine analog value result. Applies
only if IEEE standard used.
testStandardISO:
slot_uri: cim:TestStandard.testStandardISO
range: ISOStandard
required: false
multivalued: false
description: Which ISO standard used to determine analog value result. Applies
only if ISO standard used.
testStandardLaborelec:
slot_uri: cim:TestStandard.testStandardLaborelec
range: LaborelecStandard
required: false
multivalued: false
description: Which Laborelec standard used to determine analog value result.
Applies only if Laborelec standard used.
testStandardTAPPI:
slot_uri: cim:TestStandard.testStandardTAPPI
range: TAPPIStandard
required: false
multivalued: false
description: Which TAPPI standard used to determine analog value result. Applies
only if TAPPI standard used.
testStandardUKMinistryOfDefence:
slot_uri: cim:TestStandard.testStandardUKMinistryOfDefence
range: UKMinistryOfDefenceStandard
required: false
multivalued: false
description: Which UK Ministry of Defence standard used to determine analog
value result. Applies only if UK Ministry of Defence standard used.
testStandardWEP:
slot_uri: cim:TestStandard.testStandardWEP
range: WEPStandard
required: false
multivalued: false
description: Which WEP standard used to determine analog value result. Applies
only if WEP standard used.
testVariant:
slot_uri: cim:TestStandard.testVariant
range: TestVariantKind
required: false
multivalued: false
description: Identification of variant of test method or standard if one is
specified by the standard.
AssetString:
slot_uri: cim:TestStandard.AssetString
range: AssetStringMeasurement
required: false
multivalued: true
description: An asset health string related to this lab test standard.
AssetAnalog:
slot_uri: cim:TestStandard.AssetAnalog
range: AssetAnalog
required: false
multivalued: true
description: An asset health analog related to this lab test standard.
AssetDiscrete:
slot_uri: cim:TestStandard.AssetDiscrete
range: AssetDiscrete
required: false
multivalued: true
description: An asset health discrete related to this lab test standard.
ASTMStandard:
class_uri: cim:ASTMStandard
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: Standard published by ASTM (ASTM International).
attributes:
standardEdition:
slot_uri: cim:ASTMStandard.standardEdition
range: ASTMStandardEditionKind
required: false
multivalued: false
description: Edition of ASTM standard.
standardNumber:
slot_uri: cim:ASTMStandard.standardNumber
range: ASTMStandardKind
required: false
multivalued: false
description: ASTM standard number.
CIGREStandard:
class_uri: cim:CIGREStandard
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: Standard published by CIGRE (Council on Large Electric Systems).
attributes:
standardEdition:
slot_uri: cim:CIGREStandard.standardEdition
range: CIGREStandardEditionKind
required: false
multivalued: false
description: Edition of CIGRE standard.
standardNumber:
slot_uri: cim:CIGREStandard.standardNumber
range: CIGREStandardKind
required: false
multivalued: false
description: CIGRE standard number.
DINStandard:
class_uri: cim:DINStandard
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: Standard published by DIN (German Institute of Standards).
attributes:
standardEdition:
slot_uri: cim:DINStandard.standardEdition
range: DINStandardEditionKind
required: false
multivalued: false
description: Edition of DIN standard.
standardNumber:
slot_uri: cim:DINStandard.standardNumber
range: DINStandardKind
required: false
multivalued: false
description: DIN standard number.
DobleStandard:
class_uri: cim:DobleStandard
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: Standard published by Doble.
attributes:
standardEdition:
slot_uri: cim:DobleStandard.standardEdition
range: DobleStandardEditionKind
required: false
multivalued: false
description: Edition of Doble standard.
standardNumber:
slot_uri: cim:DobleStandard.standardNumber
range: DobleStandardKind
required: false
multivalued: false
description: Doble standard number.
EPAStandard:
class_uri: cim:EPAStandard
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: Standard published by EPA (United States Environmental Protection
Agency).
attributes:
standardEdition:
slot_uri: cim:EPAStandard.standardEdition
range: EPAStandardEditionKind
required: false
multivalued: false
description: Edition of EPA standard.
standardNumber:
slot_uri: cim:EPAStandard.standardNumber
range: EPAStandardKind
required: false
multivalued: false
description: EPA standard number.
IECStandard:
class_uri: cim:IECStandard
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: Standard published by IEC (International Electrotechnical Commission).
attributes:
standardEdition:
slot_uri: cim:IECStandard.standardEdition
range: IECStandardEditionKind
required: false
multivalued: false
description: Edition of IEC standard.
standardNumber:
slot_uri: cim:IECStandard.standardNumber
range: IECStandardKind
required: false
multivalued: false
description: IEC standard number.
IEEEStandard:
class_uri: cim:IEEEStandard
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: Standard published by IEEE (Institute of Electrical and Electronics
Engineers).
attributes:
standardEdition:
slot_uri: cim:IEEEStandard.standardEdition
range: IEEEStandardEditionKind
required: false
multivalued: false
description: Edition of IEEE standard.
standardNumber:
slot_uri: cim:IEEEStandard.standardNumber
range: IEEEStandardKind
required: false
multivalued: false
description: IEEE standard number.
ISOStandard:
class_uri: cim:ISOStandard
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: Standard published by ISO (International Organization for Standardization).
attributes:
standardEdition:
slot_uri: cim:ISOStandard.standardEdition
range: ISOStandardEditionKind
required: false
multivalued: false
description: Edition of ISO standard.
standardNumber:
slot_uri: cim:ISOStandard.standardNumber
range: ISOStandardKind
required: false
multivalued: false
description: ISO standard number.
LaborelecStandard:
class_uri: cim:LaborelecStandard
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: Standard published by Laborelec.
attributes:
standardEdition:
slot_uri: cim:LaborelecStandard.standardEdition
range: LaborelecStandardEditionKind
required: false
multivalued: false
description: Edition of Laborelec standard.
standardNumber:
slot_uri: cim:LaborelecStandard.standardNumber
range: LaborelecStandardKind
required: false
multivalued: false
description: Laborelec standard number.
TAPPIStandard:
class_uri: cim:TAPPIStandard
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: 'Standard published by TAPPI. '
attributes:
standardEdition:
slot_uri: cim:TAPPIStandard.standardEdition
range: TAPPIStandardEditionKind
required: false
multivalued: false
description: Edition of TAPPI standard.
standardNumber:
slot_uri: cim:TAPPIStandard.standardNumber
range: TAPPIStandardKind
required: false
multivalued: false
description: TAPPI standard number.
UKMinistryOfDefenceStandard:
class_uri: cim:UKMinistryOfDefenceStandard
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: Standard published by United Kingdom Ministry of Defence.
attributes:
standardEdition:
slot_uri: cim:UKMinistryOfDefenceStandard.standardEdition
range: UKMinistryOfDefenceStandardEditionKind
required: false
multivalued: false
description: Edition of UK Ministry of Defence standard.
standardNumber:
slot_uri: cim:UKMinistryOfDefenceStandard.standardNumber
range: UKMinistryofDefenceStandardKind
required: false
multivalued: false
description: UK Ministry of Defence standard number.
WEPStandard:
class_uri: cim:WEPStandard
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: Standard published by Westinghouse - a WEP (Westinghouse Engineering
Procedure).
attributes:
standardEdition:
slot_uri: cim:WEPStandard.standardEdition
range: WEPStandardEditionKind
required: false
multivalued: false
description: Edition of WEP standard.
standardNumber:
slot_uri: cim:WEPStandard.standardNumber
range: WEPStandardKind
required: false
multivalued: false
description: WEP standard number.
AssetStringMeasurement:
class_uri: cim:AssetStringMeasurement
is_a: StringMeasurement
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetMeas
description: "Definition of type of string measurement useful in asset domain.\r\
\n"
attributes:
kind:
slot_uri: cim:AssetStringMeasurement.kind
range: AssetStringKind
required: false
multivalued: false
description: Kind of string useful in asset domain.
TestStandard:
slot_uri: cim:AssetStringMeasurement.TestStandard
range: TestStandard
required: false
multivalued: false
description: Test standard which describes this asset string measurement.
AssetDiscrete:
class_uri: cim:AssetDiscrete
is_a: Discrete
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetMeas
description: "Definition of type of discrete useful in asset domain.\r\n"
attributes:
TestStandard:
slot_uri: cim:AssetDiscrete.TestStandard
range: TestStandard
required: false
multivalued: false
description: The lab test standard to which this asset health discrete is
related.
InspectionAnalog:
class_uri: cim:InspectionAnalog
is_a: AssetAnalog
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetMeas
description: "Asset inspection type of analog.\r\n"
attributes:
kind:
slot_uri: cim:InspectionAnalog.kind
range: InspectionAnalogKind
required: false
multivalued: false
description: Kind of analog representing inspection result.
AssetTemperaturePressureAnalog:
class_uri: cim:AssetTemperaturePressureAnalog
is_a: AssetAnalog
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetMeas
description: "Temperature or pressure type of asset analog.\r\n"
attributes:
kind:
slot_uri: cim:AssetTemperaturePressureAnalog.kind
range: AssetTemperaturePressureAnalogKind
required: false
multivalued: false
description: Kind of analog representing temperature or pressure related to
an asset.
OilAnalysisFluidDiscrete:
class_uri: cim:OilAnalysisFluidDiscrete
is_a: AssetDiscrete
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetMeas
description: "Asset oil analysis fluid type of discrete.\r\n"
attributes:
kind:
slot_uri: cim:OilAnalysisFluidDiscrete.kind
range: OilAnalysisFluidDiscreteKind
required: false
multivalued: false
description: Kind of discrete representing oil fluid test analysis result.
InspectionDiscrete:
class_uri: cim:InspectionDiscrete
is_a: AssetDiscrete
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetMeas
description: "Asset inspection type of discrete.\r\n"
attributes:
kind:
slot_uri: cim:InspectionDiscrete.kind
range: InspectionDiscreteKind
required: false
multivalued: false
description: Kind of discrete representing inspection result.
OilAnalysisPCBDiscrete:
class_uri: cim:OilAnalysisPCBDiscrete
is_a: AssetDiscrete
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetMeas
description: "Asset oil analysis PCB type of discrete.\r\n"
attributes:
kind:
slot_uri: cim:OilAnalysisPCBDiscrete.kind
range: OilAnalysisPCBDiscreteKind
required: false
multivalued: false
description: Kind of discrete representing oil PCB test analysis result.
OilAnalysisFluidAnalog:
class_uri: cim:OilAnalysisFluidAnalog
is_a: AssetAnalog
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetMeas
description: "Asset oil analysis fluid test type of analog.\r\n."
attributes:
kind:
slot_uri: cim:OilAnalysisFluidAnalog.kind
range: OilAnalysisFluidAnalogKind
required: false
multivalued: false
description: Kind of analog representing oil fluid test analysis result.
OilAnalysisGasAnalog:
class_uri: cim:OilAnalysisGasAnalog
is_a: AssetAnalog
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetMeas
description: "Asset oil analysis gas type of analog.\r\n"
attributes:
kind:
slot_uri: cim:OilAnalysisGasAnalog.kind
range: OilAnalysisGasAnalogKind
required: false
multivalued: false
description: Kind of analog representing oil dissolved gases analysis result.
OilAnalysisPCBAnalog:
class_uri: cim:OilAnalysisPCBAnalog
is_a: AssetAnalog
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetMeas
description: "Asset oil analysis PCB type of analog.\r\n"
attributes:
kind:
slot_uri: cim:OilAnalysisPCBAnalog.kind
range: OilAnalysisPCBAnalogKind
required: false
multivalued: false
description: Kind of analog representing oil PCB analysis result.
OilAnalysisParticleDiscrete:
class_uri: cim:OilAnalysisParticleDiscrete
is_a: AssetDiscrete
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetMeas
description: "Asset oil analysis particle type of discrete.\r\n"
attributes:
kind:
slot_uri: cim:OilAnalysisParticleDiscrete.kind
range: OilAnalysisParticleDiscreteKind
required: false
multivalued: false
description: Kind of discrete representing oil particulate analysis result.
OilAnalysisMetalsAnalog:
class_uri: cim:OilAnalysisMetalsAnalog
is_a: AssetAnalog
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetMeas
description: "Asset oil analysis metals type of analog.\r\n"
attributes:
kind:
slot_uri: cim:OilAnalysisMetalsAnalog.kind
range: OilAnalysisMetalsAnalogKind
required: false
multivalued: false
description: Kind of analog representing oil metals elements analysis result.
PeriodicStatisticalCalculation:
class_uri: cim:PeriodicStatisticalCalculation
is_a: StatisticalCalculation
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetMeas
description: "Description of period for which calculation is performed.\r\n"
attributes:
calculationIntervalMagnitude:
slot_uri: cim:PeriodicStatisticalCalculation.calculationIntervalMagnitude
range: integer
required: false
multivalued: false
description: Number of units (of calculationIntervalUnit) in the calculation
interval.
calculationIntervalUnit:
slot_uri: cim:PeriodicStatisticalCalculation.calculationIntervalUnit
range: CalculationIntervalUnitKind
required: false
multivalued: false
description: Unit in which calculation interval is defined.
OilAnalysisParticleAnalog:
class_uri: cim:OilAnalysisParticleAnalog
is_a: AssetAnalog
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetMeas
description: "Asset oil analysis particle type of analog.\r\n"
attributes:
kind:
slot_uri: cim:OilAnalysisParticleAnalog.kind
range: OilAnalysisParticleAnalogKind
required: false
multivalued: false
description: Kind of analog representing oil particulate analysis result.
OilAnalysisPaperAnalog:
class_uri: cim:OilAnalysisPaperAnalog
is_a: AssetAnalog
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetMeas
description: "Asset oil inspection paper type of analog.\r\n"
attributes:
kind:
slot_uri: cim:OilAnalysisPaperAnalog.kind
range: OilAnalysisPaperAnalogKind
required: false
multivalued: false
description: Kind of analog representing oil paper degradation analysis result.
IEC61968CIMVersion:
class_uri: cim:IEC61968CIMVersion
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968
description: "IEC 61968 version number assigned to this UML model.\r\n"
attributes:
date:
slot_uri: cim:IEC61968CIMVersion.date
range: date
required: false
multivalued: false
description: (const=2016-10-31) Form is YYYY-MM-DD for example for January
5, 2009 it is 2009-01-05.
version:
slot_uri: cim:IEC61968CIMVersion.version
range: string
required: false
multivalued: false
description: "(const=IEC61968CIM13v09) Form is IEC61968CIMXXvYY[a-z] where\
\ XX is the major CIM package version and the YY is the minor version. For\
\ example IEC61968CIM10v17a.\r\nThe letter on the version number indicates\
\ the changes are due to National Committee comments."
FaultIndicatorInfo:
class_uri: cim:FaultIndicatorInfo
is_a: AssetInfo
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfAssetInfo
description: Parameters of fault indicator asset.
attributes:
resetKind:
slot_uri: cim:FaultIndicatorInfo.resetKind
range: FaultIndicatorResetKind
required: false
multivalued: false
description: Kind of reset mechanisim of this fault indicator.
OldTransformerTankInfo:
class_uri: cim:OldTransformerTankInfo
is_a: TransformerTankInfo
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfAssetInfo
attributes:
constructionKind:
slot_uri: cim:OldTransformerTankInfo.constructionKind
range: TransformerConstructionKind
required: false
multivalued: false
description: Kind of construction for this transformer.
coreCoilsWeight:
slot_uri: cim:OldTransformerTankInfo.coreCoilsWeight
range: Mass
required: false
multivalued: false
description: Weight of core and coils in transformer.
coreKind:
slot_uri: cim:OldTransformerTankInfo.coreKind
range: TransformerCoreKind
required: false
multivalued: false
description: Core kind of this transformer product.
function:
slot_uri: cim:OldTransformerTankInfo.function
range: TransformerFunctionKind
required: false
multivalued: false
description: Function of this transformer.
neutralBIL:
slot_uri: cim:OldTransformerTankInfo.neutralBIL
range: Voltage
required: false
multivalued: false
description: "Basic insulation level of neutral.\r\n"
oilPreservationKind:
slot_uri: cim:OldTransformerTankInfo.oilPreservationKind
range: OilPreservationKind
required: false
multivalued: false
description: Kind of oil preservation system.
CurrentTransformerInfo:
class_uri: cim:CurrentTransformerInfo
is_a: AssetInfo
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfAssetInfo
description: "Properties of current transformer asset.\r\n"
attributes:
accuracyClass:
slot_uri: cim:CurrentTransformerInfo.accuracyClass
range: string
required: false
multivalued: false
description: CT accuracy classification.
accuracyLimit:
slot_uri: cim:CurrentTransformerInfo.accuracyLimit
range: CurrentFlow
required: false
multivalued: false
description: Accuracy limit.
coreCount:
slot_uri: cim:CurrentTransformerInfo.coreCount
range: integer
required: false
multivalued: false
description: Number of cores.
ctClass:
slot_uri: cim:CurrentTransformerInfo.ctClass
range: string
required: false
multivalued: false
kneePointCurrent:
slot_uri: cim:CurrentTransformerInfo.kneePointCurrent
range: CurrentFlow
required: false
multivalued: false
description: Maximum primary current where the CT still displays linear characteristicts.
kneePointVoltage:
slot_uri: cim:CurrentTransformerInfo.kneePointVoltage
range: Voltage
required: false
multivalued: false
description: Maximum voltage across the secondary terminals where the CT still
displays linear characteristicts.
maxRatio:
slot_uri: cim:CurrentTransformerInfo.maxRatio
range: Ratio
required: false
multivalued: false
description: Maximum ratio between the primary and secondary current.
nominalRatio:
slot_uri: cim:CurrentTransformerInfo.nominalRatio
range: Ratio
required: false
multivalued: false
description: "Nominal ratio between the primary and secondary current; i.e.\
\ 100:5.\r\n"
primaryFlsRating:
slot_uri: cim:CurrentTransformerInfo.primaryFlsRating
range: CurrentFlow
required: false
multivalued: false
description: Full load secondary (FLS) rating for primary winding.
primaryRatio:
slot_uri: cim:CurrentTransformerInfo.primaryRatio
range: Ratio
required: false
multivalued: false
description: Ratio for the primary winding tap changer.
ratedCurrent:
slot_uri: cim:CurrentTransformerInfo.ratedCurrent
range: CurrentFlow
required: false
multivalued: false
description: Rated current on the primary side.
secondaryFlsRating:
slot_uri: cim:CurrentTransformerInfo.secondaryFlsRating
range: CurrentFlow
required: false
multivalued: false
description: Full load secondary (FLS) rating for secondary winding.
secondaryRatio:
slot_uri: cim:CurrentTransformerInfo.secondaryRatio
range: Ratio
required: false
multivalued: false
description: Ratio for the secondary winding tap changer.
tertiaryFlsRating:
slot_uri: cim:CurrentTransformerInfo.tertiaryFlsRating
range: CurrentFlow
required: false
multivalued: false
description: Full load secondary (FLS) rating for tertiary winding.
tertiaryRatio:
slot_uri: cim:CurrentTransformerInfo.tertiaryRatio
range: Ratio
required: false
multivalued: false
description: Ratio for the tertiary winding tap changer.
usage:
slot_uri: cim:CurrentTransformerInfo.usage
range: string
required: false
multivalued: false
description: "Usage: eg. metering, protection, etc.\r\n"
SurgeArresterInfo:
class_uri: cim:SurgeArresterInfo
is_a: AssetInfo
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfAssetInfo
description: Properties of surge arrester.
attributes:
continuousOperatingVoltage:
slot_uri: cim:SurgeArresterInfo.continuousOperatingVoltage
range: Voltage
required: false
multivalued: false
description: Maximum continuous power frequency voltage allowed on the surge
arrester.
isPolymer:
slot_uri: cim:SurgeArresterInfo.isPolymer
range: boolean
required: false
multivalued: false
description: If true, the arrester has a polymer housing, porcelain otherwise.
lightningImpulseDischargeVoltage:
slot_uri: cim:SurgeArresterInfo.lightningImpulseDischargeVoltage
range: Voltage
required: false
multivalued: false
description: Residual voltage during an 8x20 microsecond current impulse at
the nominal discharge current level.
lineDischargeClass:
slot_uri: cim:SurgeArresterInfo.lineDischargeClass
range: integer
required: false
multivalued: false
description: Determines the arrester energy discharge capability. Choices
are limited to 0 (none) through 5 (highest) by IEC 60099. Classes 1..3 require
a 10-kA nominal discharge current. Classes 4..5 require a 20-kA nominal
discharge current. Lower nominal discharge currents must use class 0.
nominalDischargeCurrent:
slot_uri: cim:SurgeArresterInfo.nominalDischargeCurrent
range: CurrentFlow
required: false
multivalued: false
description: The lightning discharge current used to classify the arrester.
Choices are limited to 1.5, 2.5, 5, 10, and 20 kA by IEC 60099.
pressureReliefClass:
slot_uri: cim:SurgeArresterInfo.pressureReliefClass
range: CurrentFlow
required: false
multivalued: false
description: Fault current level at which all parts of the failed arrester
lie within a circle prescribed by IEC 60099.
ratedVoltage:
slot_uri: cim:SurgeArresterInfo.ratedVoltage
range: Voltage
required: false
multivalued: false
description: The temporary overvoltage (TOV) level at power frequency that
the surge arrester withstands for 10 seconds.
steepFrontDischargeVoltage:
slot_uri: cim:SurgeArresterInfo.steepFrontDischargeVoltage
range: Voltage
required: false
multivalued: false
description: Residual voltage during a current impulse with front time of
1 microsecond, and magnitude equal to the nominal discharge current level.
switchingImpulseDischargeVoltage:
slot_uri: cim:SurgeArresterInfo.switchingImpulseDischargeVoltage
range: Voltage
required: false
multivalued: false
description: Residual voltage during a current impulse with front time of
at least 30 microseconds, and magnitude specified in IEC 60099 for the line
discharge class. Does not apply to line discharge class 0.
PotentialTransformerInfo:
class_uri: cim:PotentialTransformerInfo
is_a: AssetInfo
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfAssetInfo
description: "Properties of potential transformer asset.\r\n"
attributes:
accuracyClass:
slot_uri: cim:PotentialTransformerInfo.accuracyClass
range: string
required: false
multivalued: false
nominalRatio:
slot_uri: cim:PotentialTransformerInfo.nominalRatio
range: Ratio
required: false
multivalued: false
primaryRatio:
slot_uri: cim:PotentialTransformerInfo.primaryRatio
range: Ratio
required: false
multivalued: false
description: Ratio for the primary winding tap changer.
ptClass:
slot_uri: cim:PotentialTransformerInfo.ptClass
range: string
required: false
multivalued: false
ratedVoltage:
slot_uri: cim:PotentialTransformerInfo.ratedVoltage
range: Voltage
required: false
multivalued: false
description: Rated voltage on the primary side.
secondaryRatio:
slot_uri: cim:PotentialTransformerInfo.secondaryRatio
range: Ratio
required: false
multivalued: false
description: Ratio for the secondary winding tap changer.
tertiaryRatio:
slot_uri: cim:PotentialTransformerInfo.tertiaryRatio
range: Ratio
required: false
multivalued: false
description: Ratio for the tertiary winding tap changer.
BreakerInfo:
class_uri: cim:BreakerInfo
is_a: OldSwitchInfo
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfAssetInfo
description: "Properties of breaker assets.\r\n"
attributes:
phaseTrip:
slot_uri: cim:BreakerInfo.phaseTrip
range: CurrentFlow
required: false
multivalued: false
description: Phase trip rating.
OldSwitchInfo:
class_uri: cim:OldSwitchInfo
is_a: SwitchInfo
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfAssetInfo
description: "Properties of switch assets.\r\n"
attributes:
dielectricStrength:
slot_uri: cim:OldSwitchInfo.dielectricStrength
range: Voltage
required: false
multivalued: false
description: The maximum rms voltage that may be applied across an open contact
without breaking down the dielectric properties of the switch in the open
position.
loadBreak:
slot_uri: cim:OldSwitchInfo.loadBreak
range: boolean
required: false
multivalued: false
description: True if switch has load breaking capabiity. Unless specified
false, this is always assumed to be true for breakers and reclosers.
makingCapacity:
slot_uri: cim:OldSwitchInfo.makingCapacity
range: CurrentFlow
required: false
multivalued: false
description: The highest value of current the switch can make at the rated
voltage under specified operating conditions without suffering significant
deterioration of its performance.
minimumCurrent:
slot_uri: cim:OldSwitchInfo.minimumCurrent
range: CurrentFlow
required: false
multivalued: false
description: The lowest value of current that the switch can make, carry and
break in uninterrupted duty at the rated voltage under specified operating
conditions without suffering significant deterioration of its performance.
poleCount:
slot_uri: cim:OldSwitchInfo.poleCount
range: integer
required: false
multivalued: false
description: Number of poles (i.e. of current carrying conductors that are
switched).
remote:
slot_uri: cim:OldSwitchInfo.remote
range: boolean
required: false
multivalued: false
description: ' True if device is capable of being operated by remote control.'
withstandCurrent:
slot_uri: cim:OldSwitchInfo.withstandCurrent
range: CurrentFlow
required: false
multivalued: false
description: The highest value of current the switch can carry in the closed
position at the rated voltage under specified operating conditions without
suffering significant deterioration of its performance.
SwitchInfo:
class_uri: cim:SwitchInfo
is_a: AssetInfo
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetInfo
description: "\r\nSwitch datasheet information."
attributes:
breakingCapacity:
slot_uri: cim:SwitchInfo.breakingCapacity
range: CurrentFlow
required: false
multivalued: false
description: "The maximum fault current a breaking device can break safely\
\ under prescribed conditions of use.\r\n"
gasWeightPerTank:
slot_uri: cim:SwitchInfo.gasWeightPerTank
range: Mass
required: false
multivalued: false
description: Weight of gas in each tank of SF6 dead tank breaker.
isSinglePhase:
slot_uri: cim:SwitchInfo.isSinglePhase
range: boolean
required: false
multivalued: false
description: If true, it is a single phase switch.
isUnganged:
slot_uri: cim:SwitchInfo.isUnganged
range: boolean
required: false
multivalued: false
description: If true, the switch is not ganged (i.e., a switch phase may be
operated separately from other phases).
lowPressureAlarm:
slot_uri: cim:SwitchInfo.lowPressureAlarm
range: Pressure
required: false
multivalued: false
description: Gas or air pressure at or below which a low pressure alarm is
generated.
lowPressureLockOut:
slot_uri: cim:SwitchInfo.lowPressureLockOut
range: Pressure
required: false
multivalued: false
description: Gas or air pressure below which the breaker will not open.
oilVolumePerTank:
slot_uri: cim:SwitchInfo.oilVolumePerTank
range: Volume
required: false
multivalued: false
description: Volume of oil in each tank of bulk oil breaker.
ratedCurrent:
slot_uri: cim:SwitchInfo.ratedCurrent
range: CurrentFlow
required: false
multivalued: false
description: Rated current.
ratedFrequency:
slot_uri: cim:SwitchInfo.ratedFrequency
range: Frequency
required: false
multivalued: false
description: Frequency for which switch is rated.
ratedImpulseWithstandVoltage:
slot_uri: cim:SwitchInfo.ratedImpulseWithstandVoltage
range: Voltage
required: false
multivalued: false
description: Rated impulse withstand voltage, also known as BIL (Basic Impulse
Level).
ratedInterruptingTime:
slot_uri: cim:SwitchInfo.ratedInterruptingTime
range: Seconds
required: false
multivalued: false
description: Switch rated interrupting time in seconds.
ratedVoltage:
slot_uri: cim:SwitchInfo.ratedVoltage
range: Voltage
required: false
multivalued: false
description: Rated voltage.
OldTransformerEndInfo:
class_uri: cim:OldTransformerEndInfo
is_a: TransformerEndInfo
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfAssetInfo
attributes:
dayOverLoadRating:
slot_uri: cim:OldTransformerEndInfo.dayOverLoadRating
range: ApparentPower
required: false
multivalued: false
description: "Overload rating for 24 hours.\r\n"
hourOverLoadRating:
slot_uri: cim:OldTransformerEndInfo.hourOverLoadRating
range: ApparentPower
required: false
multivalued: false
description: "Overload rating for 1 hour.\r\n"
solidInsulationWeight:
slot_uri: cim:OldTransformerEndInfo.solidInsulationWeight
range: Mass
required: false
multivalued: false
description: Weight of solid insultation in transformer.
windingInsulationKind:
slot_uri: cim:OldTransformerEndInfo.windingInsulationKind
range: WindingInsulationKind
required: false
multivalued: false
description: "Type of insultation used for transformer windings.\r\n"
ProtectionEquipmentInfo:
class_uri: cim:ProtectionEquipmentInfo
is_a: AssetInfo
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfAssetInfo
description: Properties of protection equipment asset.
attributes:
groundTrip:
slot_uri: cim:ProtectionEquipmentInfo.groundTrip
range: CurrentFlow
required: false
multivalued: false
description: Actual ground trip for this type of relay, if applicable.
phaseTrip:
slot_uri: cim:ProtectionEquipmentInfo.phaseTrip
range: CurrentFlow
required: false
multivalued: false
description: Actual phase trip for this type of relay, if applicable.
CompositeSwitchInfo:
class_uri: cim:CompositeSwitchInfo
is_a: AssetInfo
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfAssetInfo
description: "Properties of a composite switch.\r\n"
attributes:
ganged:
slot_uri: cim:CompositeSwitchInfo.ganged
range: boolean
required: false
multivalued: false
description: "True if multi-phase switch controls all phases concurrently.\r\
\n"
initOpMode:
slot_uri: cim:CompositeSwitchInfo.initOpMode
range: string
required: false
multivalued: false
description: 'Initial operating mode, with the following values: Automatic,
Manual.'
interruptingRating:
slot_uri: cim:CompositeSwitchInfo.interruptingRating
range: CurrentFlow
required: false
multivalued: false
description: Breaking capacity, or short circuit rating, is the maximum rated
current which the device can safely interrupt at the rated voltage.
kind:
slot_uri: cim:CompositeSwitchInfo.kind
range: CompositeSwitchKind
required: false
multivalued: false
description: Kind of composite switch.
phaseCode:
slot_uri: cim:CompositeSwitchInfo.phaseCode
range: PhaseCode
required: false
multivalued: false
description: Phases carried, if applicable.
phaseCount:
slot_uri: cim:CompositeSwitchInfo.phaseCount
range: integer
required: false
multivalued: false
description: Supported number of phases, typically 0, 1 or 3.
ratedVoltage:
slot_uri: cim:CompositeSwitchInfo.ratedVoltage
range: Voltage
required: false
multivalued: false
description: Rated voltage.
remote:
slot_uri: cim:CompositeSwitchInfo.remote
range: boolean
required: false
multivalued: false
description: ' True if device is capable of being operated by remote control.'
switchStateCount:
slot_uri: cim:CompositeSwitchInfo.switchStateCount
range: integer
required: false
multivalued: false
description: Number of switch states represented by the composite switch.
RecloserInfo:
class_uri: cim:RecloserInfo
is_a: OldSwitchInfo
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfAssetInfo
description: "Properties of recloser assets.\r\n"
attributes:
groundTripCapable:
slot_uri: cim:RecloserInfo.groundTripCapable
range: boolean
required: false
multivalued: false
description: True if device has ground trip capability.
groundTripNormalEnabled:
slot_uri: cim:RecloserInfo.groundTripNormalEnabled
range: boolean
required: false
multivalued: false
description: True if normal status of ground trip is enabled.
groundTripRating:
slot_uri: cim:RecloserInfo.groundTripRating
range: CurrentFlow
required: false
multivalued: false
description: Ground trip rating.
phaseTripRating:
slot_uri: cim:RecloserInfo.phaseTripRating
range: CurrentFlow
required: false
multivalued: false
description: Phase trip rating.
recloseLockoutCount:
slot_uri: cim:RecloserInfo.recloseLockoutCount
range: integer
required: false
multivalued: false
description: Total number of phase reclose operations.
Facility:
class_uri: cim:Facility
is_a: AssetContainer
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: A facility may contain buildings, storage facilities, switching facilities,
power generation, manufacturing facilities, maintenance facilities, etc.
attributes:
kind:
slot_uri: cim:Facility.kind
range: string
required: false
multivalued: false
description: Kind of this facility.
TestDataSet:
class_uri: cim:TestDataSet
is_a: ProcedureDataSet
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: Test results, usually obtained by a lab or other independent organisation.
attributes:
conclusion:
slot_uri: cim:TestDataSet.conclusion
range: string
required: false
multivalued: false
description: Conclusion drawn from test results.
specimenID:
slot_uri: cim:TestDataSet.specimenID
range: string
required: false
multivalued: false
description: Identifier of specimen used in inspection or test.
specimenToLabDateTime:
slot_uri: cim:TestDataSet.specimenToLabDateTime
range: date
required: false
multivalued: false
description: Date and time the specimen was received by the lab.
FailureEvent:
class_uri: cim:FailureEvent
is_a: ActivityRecord
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: 'An event where an asset has failed to perform its functions within
specified parameters. This class is intended to reflect the failure itself.
Additional information resulting from forensic analysis could be captured by
a diagnosis data set. '
attributes:
breakerFailureReason:
slot_uri: cim:FailureEvent.breakerFailureReason
range: BreakerFailureReasonKind
required: false
multivalued: false
description: Reason for breaker failure.
corporateCode:
slot_uri: cim:FailureEvent.corporateCode
range: string
required: false
multivalued: false
description: Code for asset failure.
failureClassification:
slot_uri: cim:FailureEvent.failureClassification
range: AssetFailureClassification
required: false
multivalued: false
description: Classification of failure.
failureDateTime:
slot_uri: cim:FailureEvent.failureDateTime
range: date
required: false
multivalued: false
description: Time and date of asset failure.
failureIsolationMethod:
slot_uri: cim:FailureEvent.failureIsolationMethod
range: FailureIsolationMethodKind
required: false
multivalued: false
description: How the asset failure was isolated from the system.
failureMode:
slot_uri: cim:FailureEvent.failureMode
range: AssetFailureMode
required: true
multivalued: false
description: What asset failed to be able to do.
faultLocatingMethod:
slot_uri: cim:FailureEvent.faultLocatingMethod
range: string
required: false
multivalued: false
description: 'The method used for locating the faulted part of the asset.
For example, cable options include: Cap Discharge-Thumping, Bridge Method,
Visual Inspection, Other.'
location:
slot_uri: cim:FailureEvent.location
range: string
required: false
multivalued: false
description: Failure location on an object.
rootCause:
slot_uri: cim:FailureEvent.rootCause
range: string
required: false
multivalued: false
description: Root cause of asset failure.
transformerFailureReason:
slot_uri: cim:FailureEvent.transformerFailureReason
range: TransformerFailureReasonKind
required: false
multivalued: false
description: Reason for transformer failure.
Streetlight:
class_uri: cim:Streetlight
is_a: Asset
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: "Streetlight asset.\r\n"
attributes:
armLength:
slot_uri: cim:Streetlight.armLength
range: Length
required: false
multivalued: false
description: Length of arm. Note that a new light may be placed on an existing
arm.
lampKind:
slot_uri: cim:Streetlight.lampKind
range: StreetlightLampKind
required: false
multivalued: false
description: Lamp kind.
lightRating:
slot_uri: cim:Streetlight.lightRating
range: ActivePower
required: false
multivalued: false
description: Power rating of light.
Pole:
slot_uri: cim:Streetlight.Pole
range: Pole
required: false
multivalued: false
description: Pole to which thiss streetlight is attached.
Pole:
class_uri: cim:Pole
is_a: Structure
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfAssets
description: "Pole asset.\r\n"
attributes:
baseKind:
slot_uri: cim:Pole.baseKind
range: PoleBaseKind
required: false
multivalued: false
description: Kind of base for this pole.
breastBlock:
slot_uri: cim:Pole.breastBlock
range: boolean
required: false
multivalued: false
description: True if a block of material has been attached to base of pole
in ground for stability. This technique is used primarily when anchors can
not be used.
classification:
slot_uri: cim:Pole.classification
range: string
required: false
multivalued: false
description: ' Pole class: 1, 2, 3, 4, 5, 6, 7, H1, H2, Other, Unknown.'
construction:
slot_uri: cim:Pole.construction
range: string
required: false
multivalued: false
description: The framing structure mounted on the pole.
diameter:
slot_uri: cim:Pole.diameter
range: Length
required: false
multivalued: false
description: Diameter of the pole.
jpaReference:
slot_uri: cim:Pole.jpaReference
range: string
required: false
multivalued: false
description: Joint pole agreement reference number.
length:
slot_uri: cim:Pole.length
range: Length
required: false
multivalued: false
description: Length of the pole (inclusive of any section of the pole that
may be underground post-installation).
preservativeKind:
slot_uri: cim:Pole.preservativeKind
range: PolePreservativeKind
required: false
multivalued: false
description: Kind of preservative for this pole.
speciesType:
slot_uri: cim:Pole.speciesType
range: string
required: false
multivalued: false
description: Pole species. Aluminum, Aluminum Davit, Concrete, Fiberglass,
Galvanized Davit, Galvanized, Steel Davit Primed, Steel Davit, Steel Standard
Primed, Steel, Truncated, Wood-Treated, Wood-Hard, Wood-Salt Treated, Wood-Soft,
Wood, Other, Unknown.
treatedDateTime:
slot_uri: cim:Pole.treatedDateTime
range: date
required: false
multivalued: false
description: "Date and time pole was last treated with preservative.\r\n"
treatmentKind:
slot_uri: cim:Pole.treatmentKind
range: PoleTreatmentKind
required: false
multivalued: false
description: Kind of treatment for this pole.
Streetlights:
slot_uri: cim:Pole.Streetlights
range: Streetlight
required: false
multivalued: true
description: All streetlights attached to this pole.
OilSpecimen:
class_uri: cim:OilSpecimen
is_a: Specimen
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
attributes:
oilSampleTakenFrom:
slot_uri: cim:OilSpecimen.oilSampleTakenFrom
range: OilSampleLocation
required: false
multivalued: false
description: Location from which oil sample taken.
oilSampleTemperature:
slot_uri: cim:OilSpecimen.oilSampleTemperature
range: Temperature
required: false
multivalued: false
description: Oil sample temperature.
oilTemperatureSource:
slot_uri: cim:OilSpecimen.oilTemperatureSource
range: OilTemperatureSource
required: false
multivalued: false
description: Source of oil temperature.
sampleContainer:
slot_uri: cim:OilSpecimen.sampleContainer
range: SampleContainerType
required: false
multivalued: false
description: Type of sample container.
Specimen:
class_uri: cim:Specimen
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: Sample or specimen of a material (fluid or solid).
attributes:
ambientTemperatureAtSampling:
slot_uri: cim:Specimen.ambientTemperatureAtSampling
range: Temperature
required: false
multivalued: false
description: "Operating ambient temperature (in \xB0C)."
humidityAtSampling:
slot_uri: cim:Specimen.humidityAtSampling
range: PerCent
required: false
multivalued: false
description: Operating ambient humidity (in percent).
specimenID:
slot_uri: cim:Specimen.specimenID
range: string
required: false
multivalued: false
description: Identifier of specimen used in inspection or test.
specimenSampleDateTime:
slot_uri: cim:Specimen.specimenSampleDateTime
range: date
required: false
multivalued: false
description: Date and time sample specimen taken.
specimenToLabDateTime:
slot_uri: cim:Specimen.specimenToLabDateTime
range: date
required: false
multivalued: false
description: "Date and time the specimen was received by the lab.\r\n"
AssetTestSampleTaker:
slot_uri: cim:Specimen.AssetTestSampleTaker
range: AssetTestSampleTaker
required: false
multivalued: false
description: Test sampler taker who gathered this specimen.
LabTestDataSet:
slot_uri: cim:Specimen.LabTestDataSet
range: LabTestDataSet
required: false
multivalued: true
description: Results from lab testing done on specimen.
LabTestDataSet:
class_uri: cim:LabTestDataSet
is_a: ProcedureDataSet
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: Results of testing done by a lab.
attributes:
conclusion:
slot_uri: cim:LabTestDataSet.conclusion
range: string
required: false
multivalued: false
description: Conclusion drawn from test results.
conclusionConfidence:
slot_uri: cim:LabTestDataSet.conclusionConfidence
range: string
required: false
multivalued: false
description: Description of confidence in conclusion.
reasonForTest:
slot_uri: cim:LabTestDataSet.reasonForTest
range: TestReason
required: false
multivalued: false
description: Reason for performing test.
testEquipmentID:
slot_uri: cim:LabTestDataSet.testEquipmentID
range: string
required: false
multivalued: false
description: Identity of lab equipment used to perform test.
AssetTestLab:
slot_uri: cim:LabTestDataSet.AssetTestLab
range: AssetTestLab
required: false
multivalued: false
description: Test lab which produced this set of lab test results.
Specimen:
slot_uri: cim:LabTestDataSet.Specimen
range: Specimen
required: false
multivalued: false
description: Specimen on which lab testing done in determining results.
AssetTestLab:
class_uri: cim:AssetTestLab
is_a: AssetOrganisationRole
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: Test lab that performs various types of testing related to assets.
attributes:
LabTestDataSet:
slot_uri: cim:AssetTestLab.LabTestDataSet
range: LabTestDataSet
required: false
multivalued: true
description: A set of lab test results produced by this test lab.
AssetTestSampleTaker:
class_uri: cim:AssetTestSampleTaker
is_a: AssetOrganisationRole
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: Identity of person/organization that took sample.
attributes:
Specimen:
slot_uri: cim:AssetTestSampleTaker.Specimen
range: Specimen
required: false
multivalued: true
description: Specimen taken by this sample taker.
RiskScore:
class_uri: cim:RiskScore
is_a: AggregateScore
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: Score that is indicative of the risk associated with one or more
assets.
attributes:
kind:
slot_uri: cim:RiskScore.kind
range: RiskScoreKind
required: false
multivalued: false
description: The risk kind, such as CustomerRisk, FinancialRisk, SafetyRisk,
etc.
AssetHealthScore:
slot_uri: cim:RiskScore.AssetHealthScore
range: HealthScore
required: false
multivalued: true
description: Individual health score associated with this risk score.
HealthScore:
class_uri: cim:HealthScore
is_a: AggregateScore
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: Score that is indicative of the health of one or more assets.
attributes:
AssetRiskScore:
slot_uri: cim:HealthScore.AssetRiskScore
range: RiskScore
required: false
multivalued: false
description: Risk score with which this health score is associated.
FACTSDevice:
class_uri: cim:FACTSDevice
is_a: Asset
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: "FACTS device asset.\r\n"
attributes:
kind:
slot_uri: cim:FACTSDevice.kind
range: FACTSDeviceKind
required: false
multivalued: false
description: Kind of FACTS device.
AssetUser:
class_uri: cim:AssetUser
is_a: AssetOrganisationRole
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: "Organisation that is a user of the asset.\r\n"
Joint:
class_uri: cim:Joint
is_a: Asset
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: "Joint connects two or more cables. It includes the portion of cable\
\ under wipes, welds, or other seals.\r\n"
attributes:
configurationKind:
slot_uri: cim:Joint.configurationKind
range: JointConfigurationKind
required: false
multivalued: false
description: Configuration of joint.
fillKind:
slot_uri: cim:Joint.fillKind
range: JointFillKind
required: false
multivalued: false
description: Material used to fill the joint.
insulation:
slot_uri: cim:Joint.insulation
range: string
required: false
multivalued: false
description: The type of insulation around the joint, classified according
to the utility's asset management standards and practices.
MaintenanceDataSet:
class_uri: cim:MaintenanceDataSet
is_a: ProcedureDataSet
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: The result of a maintenance activity, a type of Procedure, for a
given attribute of an asset.
attributes:
conditionAfter:
slot_uri: cim:MaintenanceDataSet.conditionAfter
range: string
required: false
multivalued: false
description: Condition of asset just following maintenance procedure.
conditionBefore:
slot_uri: cim:MaintenanceDataSet.conditionBefore
range: string
required: false
multivalued: false
description: Description of the condition of the asset just prior to maintenance
being performed.
maintCode:
slot_uri: cim:MaintenanceDataSet.maintCode
range: string
required: false
multivalued: false
description: Code for the type of maintenance performed.
Cabinet:
class_uri: cim:Cabinet
is_a: AssetContainer
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: Enclosure that offers protection to the equipment it contains and/or
safety to people/animals outside it.
ComMedia:
class_uri: cim:ComMedia
is_a: Asset
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: "Communication media such as fibre optic cable, power-line, telephone,\
\ etc.\r\n"
DiagnosisDataSet:
class_uri: cim:DiagnosisDataSet
is_a: ProcedureDataSet
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: 'The result of a problem (typically an asset failure) diagnosis.
Contains complete information like what might be received from a lab doing forensic
analysis of a failed asset. '
attributes:
effect:
slot_uri: cim:DiagnosisDataSet.effect
range: string
required: false
multivalued: false
description: Effect of problem.
failureMode:
slot_uri: cim:DiagnosisDataSet.failureMode
range: string
required: false
multivalued: false
description: 'Failuer mode, for example: Failure to Insulate; Failure to conduct;
Failure to contain oil; Failure to provide ground plane; Other.'
finalCause:
slot_uri: cim:DiagnosisDataSet.finalCause
range: string
required: false
multivalued: false
description: Cause of problem determined during diagnosis.
finalCode:
slot_uri: cim:DiagnosisDataSet.finalCode
range: string
required: false
multivalued: false
description: "Code for diagnosed probem type.\r\n"
finalOrigin:
slot_uri: cim:DiagnosisDataSet.finalOrigin
range: string
required: false
multivalued: false
description: Origin of problem determined during diagnosis.
finalRemark:
slot_uri: cim:DiagnosisDataSet.finalRemark
range: string
required: false
multivalued: false
description: Remarks pertaining to findings during problem diagnosis.
phaseCode:
slot_uri: cim:DiagnosisDataSet.phaseCode
range: PhaseCode
required: false
multivalued: false
description: Phase(s) diagnosed.
preliminaryCode:
slot_uri: cim:DiagnosisDataSet.preliminaryCode
range: string
required: false
multivalued: false
description: "Code for problem type determined during preliminary assessment.\r\
\n"
preliminaryDateTime:
slot_uri: cim:DiagnosisDataSet.preliminaryDateTime
range: date
required: false
multivalued: false
description: "Date and time preliminary assessment of problem was performed.\r\
\n"
preliminaryRemark:
slot_uri: cim:DiagnosisDataSet.preliminaryRemark
range: string
required: false
multivalued: false
description: Remarks pertaining to preliminary assessment of problem.
rootCause:
slot_uri: cim:DiagnosisDataSet.rootCause
range: string
required: false
multivalued: false
description: Root cause of problem determined during diagnosis.
rootOrigin:
slot_uri: cim:DiagnosisDataSet.rootOrigin
range: string
required: false
multivalued: false
description: Root origin of problem determined during diagnosis.
rootRemark:
slot_uri: cim:DiagnosisDataSet.rootRemark
range: string
required: false
multivalued: false
description: Remarks pertaining to root cause findings during problem diagnosis.
Maintainer:
class_uri: cim:Maintainer
is_a: AssetOrganisationRole
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
description: "Organisation that maintains assets.\r\n"
ExternalCustomerAgreement:
class_uri: cim:ExternalCustomerAgreement
is_a: Agreement
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfCustomers
description: A type of customer agreement involving an external agency. For example,
a customer may form a contracts with an Energy Service Supplier if Direct Access
is permitted.
ServiceGuarantee:
class_uri: cim:ServiceGuarantee
is_a: Document
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfCustomers
description: "A service guarantee, often imposed by a regulator, defines conditions\
\ that, if not satisfied, will result in the utility making a monetary payment\
\ to the customer. Note that guarantee's identifier is in the 'name' attribute\
\ and the status of the guarantee is in the 'Status.status' attribute.\r\nExample\
\ service requirements include:\r\n1) If power is not restored within 24 hours,\
\ customers can claim $50 for residential customers or $100 for commercial and\
\ industrial customers. In addition for each extra period of 12 hours the customer's\
\ supply has not been activated, the customer can claim $25.\r\n2) If a customer\
\ has a question about their electricity bill, the utility will investigate\
\ and respond to the inquiry within 15 working days. If utility fails to meet\
\ its guarantee, utility will automatically pay the customer $50."
attributes:
applicationPeriod:
slot_uri: cim:ServiceGuarantee.applicationPeriod
range: DateTimeInterval
required: false
multivalued: false
description: Period in which this service guantee applies.
automaticPay:
slot_uri: cim:ServiceGuarantee.automaticPay
range: boolean
required: false
multivalued: false
description: True if utility must autmatically pay the specified amount whenever
the condition is not satisified, otherwise customer must make a claim to
receive payment.
payAmount:
slot_uri: cim:ServiceGuarantee.payAmount
range: Money
required: false
multivalued: false
description: Amount to be paid by the service provider to the customer for
each violation of the 'serviceRequirement'.
serviceRequirement:
slot_uri: cim:ServiceGuarantee.serviceRequirement
range: string
required: false
multivalued: false
description: Explanation of the requirement and conditions for satisfying
it.
SubscribePowerCurve:
class_uri: cim:SubscribePowerCurve
is_a: Curve
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfCustomers
description: Price curve for specifying the cost of energy (X) at points in time
(y1) according to a prcing structure, which is based on a tariff.
PowerQualityPricing:
class_uri: cim:PowerQualityPricing
is_a: Document
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfCustomers
description: "Pricing can be based on power quality.\r\n"
attributes:
emergencyHighVoltLimit:
slot_uri: cim:PowerQualityPricing.emergencyHighVoltLimit
range: Voltage
required: false
multivalued: false
description: ' Emergency high voltage limit.'
emergencyLowVoltLimit:
slot_uri: cim:PowerQualityPricing.emergencyLowVoltLimit
range: Voltage
required: false
multivalued: false
description: ' Emergency low voltage limit.'
normalHighVoltLimit:
slot_uri: cim:PowerQualityPricing.normalHighVoltLimit
range: Voltage
required: false
multivalued: false
description: ' Normal high voltage limit.'
normalLowVoltLimit:
slot_uri: cim:PowerQualityPricing.normalLowVoltLimit
range: Voltage
required: false
multivalued: false
description: ' Normal low voltage limit.'
powerFactorMin:
slot_uri: cim:PowerQualityPricing.powerFactorMin
range: float
required: false
multivalued: false
description: Threshold minimum power factor for this PricingStructure, specified
in instances where a special charge is levied if the actual power factor
for a Service falls below the value specified here.
valueUninterruptedServiceEnergy:
slot_uri: cim:PowerQualityPricing.valueUninterruptedServiceEnergy
range: CostPerEnergyUnit
required: false
multivalued: false
description: "Value of uninterrupted service (Cost per energy).\r\n"
valueUninterruptedServiceP:
slot_uri: cim:PowerQualityPricing.valueUninterruptedServiceP
range: float
required: false
multivalued: false
description: Value of uninterrupted service (Cost per active power).
voltImbalanceViolCost:
slot_uri: cim:PowerQualityPricing.voltImbalanceViolCost
range: float
required: false
multivalued: false
description: ' Voltage imbalance violation cost (Cost per unit Voltage).'
voltLimitViolCost:
slot_uri: cim:PowerQualityPricing.voltLimitViolCost
range: float
required: false
multivalued: false
description: ' Voltage limit violation cost (Cost per unit Voltage).'
ComplianceEvent:
class_uri: cim:ComplianceEvent
is_a: ActivityRecord
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfCustomers
description: "Compliance events are used for reporting regulatory or contract\
\ compliance issues and/or variances. These might be created as a consequence\
\ of local business processes and associated rules. It is anticipated that this\
\ class will be customised extensively to meet local implementation needs.\r\
\nUse inherited 'type' to indicate that, for example, expected performance will\
\ not be met or reported as mandated.\r\n"
attributes:
deadline:
slot_uri: cim:ComplianceEvent.deadline
range: date
required: false
multivalued: false
description: "The deadline for compliance.\r\n"
WorkOrder:
class_uri: cim:WorkOrder
is_a: Document
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Work
RepairItem:
class_uri: cim:RepairItem
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Work
description: Asset component to be repaired or problem area to be corrected.
attributes:
breakerRepairItem:
slot_uri: cim:RepairItem.breakerRepairItem
range: BreakerRepairItemKind
required: false
multivalued: false
description: Breaker component or problem area which is the focus of this
maintenance work task (for work tasks related to breakers only).
transformerRepairItem:
slot_uri: cim:RepairItem.transformerRepairItem
range: TransformerRepairItemKind
required: false
multivalued: false
description: Transformer component or problem area which is the focus of this
maintenance work task (for work tasks related to transformers only).
RepairWorkTask:
slot_uri: cim:RepairItem.RepairWorkTask
range: RepairWorkTask
required: false
multivalued: true
description: Repair work task under which breaker item of this type is repaired.
RepairWorkTask:
class_uri: cim:RepairWorkTask
is_a: WorkTask
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Work
description: Work task for asset repair. Costs associated with this are considered
corrective maintenance (CM) costs.
attributes:
emergency:
slot_uri: cim:RepairWorkTask.emergency
range: boolean
required: false
multivalued: false
description: Repair work is emergency.
BreakerRepairItem:
slot_uri: cim:RepairWorkTask.BreakerRepairItem
range: RepairItem
required: false
multivalued: true
description: Type of breaker item to be repaird by this repair work task.
Vehicle:
class_uri: cim:Vehicle
is_a: WorkAsset
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Work
description: "Vehicle asset.\r\n"
attributes:
odometerReadDateTime:
slot_uri: cim:Vehicle.odometerReadDateTime
range: date
required: false
multivalued: false
description: "Date and time the last odometer reading was recorded.\r\n"
odometerReading:
slot_uri: cim:Vehicle.odometerReading
range: Length
required: false
multivalued: false
description: Odometer reading of this vehicle as of the 'odometerReadingDateTime'.
Refer to associated ActivityRecords for earlier readings.
usageKind:
slot_uri: cim:Vehicle.usageKind
range: VehicleUsageKind
required: false
multivalued: false
description: Kind of usage of the vehicle.
MaintenanceLocation:
class_uri: cim:MaintenanceLocation
is_a: WorkLocation
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Work
description: Location where to perform maintenance work.
attributes:
block:
slot_uri: cim:MaintenanceLocation.block
range: string
required: false
multivalued: false
description: (if applicable) Name, identifier, or description of the block
in which work is to occur.
lot:
slot_uri: cim:MaintenanceLocation.lot
range: string
required: false
multivalued: false
description: (if applicable) Name, identifier, or description of the lot in
which work is to occur.
nearestIntersection:
slot_uri: cim:MaintenanceLocation.nearestIntersection
range: string
required: false
multivalued: false
description: The names of streets at the nearest intersection to work area.
subdivision:
slot_uri: cim:MaintenanceLocation.subdivision
range: string
required: false
multivalued: false
description: (if applicable) Name, identifier, or description of the subdivision
in which work is to occur.
ServiceOrder:
class_uri: cim:ServiceOrder
is_a: WorkOrder
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Work
InternalLocation:
class_uri: cim:InternalLocation
is_a: WorkLocation
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Work
description: Description of location internal to a building.
attributes:
buildingName:
slot_uri: cim:InternalLocation.buildingName
range: string
required: false
multivalued: false
description: Name of building where location is.
buildingNumber:
slot_uri: cim:InternalLocation.buildingNumber
range: string
required: false
multivalued: false
description: Number of building where location is.
floor:
slot_uri: cim:InternalLocation.floor
range: integer
required: false
multivalued: false
description: Floor of location.
roomNumber:
slot_uri: cim:InternalLocation.roomNumber
range: string
required: false
multivalued: false
description: Room number of location.
Tool:
class_uri: cim:Tool
is_a: WorkAsset
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Work
description: "Tool asset.\r\n"
attributes:
lastCalibrationDate:
slot_uri: cim:Tool.lastCalibrationDate
range: date
required: false
multivalued: false
description: (if applicable) Date the tool was last calibrated.
MaintenanceOrder:
class_uri: cim:MaintenanceOrder
is_a: WorkOrder
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Work
MaintenanceWorkTask:
class_uri: cim:MaintenanceWorkTask
is_a: WorkTask
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Work
description: Maintenance work task. Costs associated with this are considered
preventive maintenance (PM) costs.
attributes:
breakerMaintenanceKind:
slot_uri: cim:MaintenanceWorkTask.breakerMaintenanceKind
range: BreakerMaintenanceKind
required: false
multivalued: false
description: Kind of breaker maintenance performed by this maintenance work
task.
transformerMaintenanceKind:
slot_uri: cim:MaintenanceWorkTask.transformerMaintenanceKind
range: TransformerMaintenanceKind
required: false
multivalued: false
description: Kind of transformer maintenance performed by this maintenance
work task.
ShuntCompensatorControl:
class_uri: cim:ShuntCompensatorControl
is_a: RegulatingControl
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfWiresExt
description: Distribution capacitor bank control settings.
attributes:
branchDirect:
slot_uri: cim:ShuntCompensatorControl.branchDirect
range: integer
required: false
multivalued: false
description: 'For VAR, amp, or power factor locally controlled shunt impedances,
the flow direction: in, out.'
cellSize:
slot_uri: cim:ShuntCompensatorControl.cellSize
range: ReactivePower
required: false
multivalued: false
description: The size of the individual units that make up the bank.
controlKind:
slot_uri: cim:ShuntCompensatorControl.controlKind
range: ShuntImpedanceControlKind
required: false
multivalued: false
description: Kind of control (if any).
highVoltageOverride:
slot_uri: cim:ShuntCompensatorControl.highVoltageOverride
range: PU
required: false
multivalued: false
description: For locally controlled shunt impedances which have a voltage
override feature, the high voltage override value. If the voltage is above
this value, the shunt impedance will be turned off regardless of the other
local controller settings.
localControlKind:
slot_uri: cim:ShuntCompensatorControl.localControlKind
range: ShuntImpedanceLocalControlKind
required: false
multivalued: false
description: Kind of local controller.
localOffLevel:
slot_uri: cim:ShuntCompensatorControl.localOffLevel
range: string
required: false
multivalued: false
description: Upper control setting.
localOnLevel:
slot_uri: cim:ShuntCompensatorControl.localOnLevel
range: string
required: false
multivalued: false
description: Lower control setting.
localOverride:
slot_uri: cim:ShuntCompensatorControl.localOverride
range: boolean
required: false
multivalued: false
description: True if the locally controlled capacitor has voltage override
capability.
lowVoltageOverride:
slot_uri: cim:ShuntCompensatorControl.lowVoltageOverride
range: PU
required: false
multivalued: false
description: For locally controlled shunt impedances which have a voltage
override feature, the low voltage override value. If the voltage is below
this value, the shunt impedance will be turned on regardless of the other
local controller settings.
maxSwitchOperationCount:
slot_uri: cim:ShuntCompensatorControl.maxSwitchOperationCount
range: integer
required: false
multivalued: false
description: "IdmsShuntImpedanceData.maxNumSwitchOps.\r\n"
normalOpen:
slot_uri: cim:ShuntCompensatorControl.normalOpen
range: boolean
required: false
multivalued: false
description: True if open is normal status for a fixed capacitor bank, otherwise
normal status is closed.
regBranch:
slot_uri: cim:ShuntCompensatorControl.regBranch
range: string
required: false
multivalued: false
description: For VAR, amp, or power factor locally controlled shunt impedances,
the index of the regulation branch.
regBranchEnd:
slot_uri: cim:ShuntCompensatorControl.regBranchEnd
range: integer
required: false
multivalued: false
description: 'For VAR, amp, or power factor locally controlled shunt impedances,
the end of the branch that is regulated. The field has the following values:
from side, to side, and tertiary (only if the branch is a transformer).'
regBranchKind:
slot_uri: cim:ShuntCompensatorControl.regBranchKind
range: RegulationBranchKind
required: false
multivalued: false
description: (For VAR, amp, or power factor locally controlled shunt impedances)
Kind of regulation branch.
sensingPhaseCode:
slot_uri: cim:ShuntCompensatorControl.sensingPhaseCode
range: PhaseCode
required: false
multivalued: false
description: Phases that are measured for controlling the device.
switchOperationCycle:
slot_uri: cim:ShuntCompensatorControl.switchOperationCycle
range: Hours
required: false
multivalued: false
description: Time interval between consecutive switching operations.
vRegLineLine:
slot_uri: cim:ShuntCompensatorControl.vRegLineLine
range: boolean
required: false
multivalued: false
description: True if regulated voltages are measured line to line, otherwise
they are measured line to ground.
ShuntCompensatorInfo:
slot_uri: cim:ShuntCompensatorControl.ShuntCompensatorInfo
range: ShuntCompensatorInfo
required: false
multivalued: false
ShuntCompensatorInfo:
class_uri: cim:ShuntCompensatorInfo
is_a: AssetInfo
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetInfo
description: Properties of shunt capacitor, shunt reactor or switchable bank of
shunt capacitor or reactor assets.
attributes:
maxPowerLoss:
slot_uri: cim:ShuntCompensatorInfo.maxPowerLoss
range: ApparentPower
required: false
multivalued: false
description: Maximum allowed apparent power loss.
ratedCurrent:
slot_uri: cim:ShuntCompensatorInfo.ratedCurrent
range: CurrentFlow
required: false
multivalued: false
description: Rated current.
ratedReactivePower:
slot_uri: cim:ShuntCompensatorInfo.ratedReactivePower
range: ReactivePower
required: false
multivalued: false
description: Rated reactive power.
ratedVoltage:
slot_uri: cim:ShuntCompensatorInfo.ratedVoltage
range: Voltage
required: false
multivalued: false
description: Rated voltage.
ShuntCompensatorControl:
slot_uri: cim:ShuntCompensatorInfo.ShuntCompensatorControl
range: ShuntCompensatorControl
required: false
multivalued: false
SVC:
class_uri: cim:SVC
is_a: ShuntCompensator
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfWiresExt
description: "SVC asset allows the capacitive and inductive ratings for each phase\
\ to be specified individually if required.\r\n"
attributes:
capacitiveRating:
slot_uri: cim:SVC.capacitiveRating
range: Reactance
required: false
multivalued: false
description: "Maximum capacitive reactive power.\r\n"
inductiveRating:
slot_uri: cim:SVC.inductiveRating
range: Reactance
required: false
multivalued: false
description: "Maximum inductive reactive power.\r\n"
ControlledAppliance:
class_uri: cim:ControlledAppliance
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
description: "Appliance controlled with a PAN device control.\r\n"
attributes:
isElectricVehicle:
slot_uri: cim:ControlledAppliance.isElectricVehicle
range: boolean
required: false
multivalued: false
description: "True if the appliance is an electric vehicle.\r\n"
isExteriorLighting:
slot_uri: cim:ControlledAppliance.isExteriorLighting
range: boolean
required: false
multivalued: false
description: "True if the appliance is exterior lighting.\r\n"
isGenerationSystem:
slot_uri: cim:ControlledAppliance.isGenerationSystem
range: boolean
required: false
multivalued: false
description: "True if the appliance is a generation system.\r\n"
isHvacCompressorOrFurnace:
slot_uri: cim:ControlledAppliance.isHvacCompressorOrFurnace
range: boolean
required: false
multivalued: false
description: "True if the appliance is HVAC compressor or furnace.\r\n"
isInteriorLighting:
slot_uri: cim:ControlledAppliance.isInteriorLighting
range: boolean
required: false
multivalued: false
description: "True if the appliance is interior lighting.\r\n"
isIrrigationPump:
slot_uri: cim:ControlledAppliance.isIrrigationPump
range: boolean
required: false
multivalued: false
description: "True if the appliance is an irrigation pump.\r\n"
isManagedCommercialIndustrialLoad:
slot_uri: cim:ControlledAppliance.isManagedCommercialIndustrialLoad
range: boolean
required: false
multivalued: false
description: "True if the appliance is managed commercial or industrial load.\r\
\n"
isPoolPumpSpaJacuzzi:
slot_uri: cim:ControlledAppliance.isPoolPumpSpaJacuzzi
range: boolean
required: false
multivalued: false
description: "True if the appliance is a pool, pump, spa or jacuzzi.\r\n"
isSimpleMiscLoad:
slot_uri: cim:ControlledAppliance.isSimpleMiscLoad
range: boolean
required: false
multivalued: false
description: "True if the appliance is a simple miscellaneous load.\r\n"
isSmartAppliance:
slot_uri: cim:ControlledAppliance.isSmartAppliance
range: boolean
required: false
multivalued: false
description: "True if the appliance is a smart appliance.\r\n"
isStripAndBaseboardHeater:
slot_uri: cim:ControlledAppliance.isStripAndBaseboardHeater
range: boolean
required: false
multivalued: false
description: "True if the appliance is a stip or baseboard heater.\r\n"
isWaterHeater:
slot_uri: cim:ControlledAppliance.isWaterHeater
range: boolean
required: false
multivalued: false
description: "True if the appliance is a water heater.\r\n"
PanPricing:
class_uri: cim:PanPricing
is_a: EndDeviceAction
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
description: "PAN action/command used to issue pricing information to a PAN device.\r\
\n"
attributes:
providerID:
slot_uri: cim:PanPricing.providerID
range: integer
required: false
multivalued: false
description: "Unique identifier for the commodity provider.\r\n"
PanPricingDetails:
slot_uri: cim:PanPricing.PanPricingDetails
range: PanPricingDetail
required: false
multivalued: true
description: All pricing details issued by this PAN pricing command/action.
PanPricingDetail:
class_uri: cim:PanPricingDetail
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
description: "Detail for a single price command/action.\r\n"
attributes:
alternateCostDelivered:
slot_uri: cim:PanPricingDetail.alternateCostDelivered
range: float
required: false
multivalued: false
description: Alternative measure of the cost of the energy consumed. An example
might be the emissions of CO2 for each kWh of electricity consumed providing
a measure of the environmental cost.
alternateCostUnit:
slot_uri: cim:PanPricingDetail.alternateCostUnit
range: string
required: false
multivalued: false
description: Cost unit for the alternate cost delivered field. One example
is kg of CO2 per unit of measure.
currentTimeDate:
slot_uri: cim:PanPricingDetail.currentTimeDate
range: date
required: false
multivalued: false
description: "Current time as determined by a PAN device.\r\n"
generationPrice:
slot_uri: cim:PanPricingDetail.generationPrice
range: Money
required: false
multivalued: false
description: "Price of the commodity measured in base unit of currency per\
\ 'unitOfMeasure'.\r\n"
generationPriceRatio:
slot_uri: cim:PanPricingDetail.generationPriceRatio
range: float
required: false
multivalued: false
description: "Ratio of 'generationPrice' to the \"normal\" price chosen by\
\ the commodity provider.\r\n"
price:
slot_uri: cim:PanPricingDetail.price
range: Money
required: false
multivalued: false
description: "Price of the commodity measured in base unit of currency per\
\ 'unitOfMeasure'.\r\n"
priceRatio:
slot_uri: cim:PanPricingDetail.priceRatio
range: float
required: false
multivalued: false
description: "Ratio of 'price' to the \"normal\" price chosen by the commodity\
\ provider.\r\n"
priceTier:
slot_uri: cim:PanPricingDetail.priceTier
range: integer
required: false
multivalued: false
description: "Pricing tier as chosen by the commodity provider.\r\n"
priceTierCount:
slot_uri: cim:PanPricingDetail.priceTierCount
range: integer
required: false
multivalued: false
description: "Maximum number of price tiers available.\r\n"
priceTierLabel:
slot_uri: cim:PanPricingDetail.priceTierLabel
range: string
required: false
multivalued: false
description: "Label for price tier.\r\n"
rateLabel:
slot_uri: cim:PanPricingDetail.rateLabel
range: string
required: false
multivalued: false
description: "Label of the current billing rate specified by commodity provider.\r\
\n"
registerTier:
slot_uri: cim:PanPricingDetail.registerTier
range: string
required: false
multivalued: false
description: "Register tier accumulating usage information.\r\n"
unitOfMeasure:
slot_uri: cim:PanPricingDetail.unitOfMeasure
range: string
required: false
multivalued: false
description: "Defines commodity as well as its base unit of measure.\r\n"
PanPricing:
slot_uri: cim:PanPricingDetail.PanPricing
range: PanPricing
required: false
multivalued: false
description: PAN pricing command/action issuing this price detail.
ComFunction:
class_uri: cim:ComFunction
is_a: EndDeviceFunction
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
description: 'Communication function of communication equipment or a device such
as a meter. '
attributes:
amrAddress:
slot_uri: cim:ComFunction.amrAddress
range: string
required: false
multivalued: false
description: Communication ID number (e.g. serial number, IP address, telephone
number, etc.) of the AMR module which serves this meter.
amrRouter:
slot_uri: cim:ComFunction.amrRouter
range: string
required: false
multivalued: false
description: "Communication ID number (e.g. port number, serial number, data\
\ collector ID, etc.) of the parent device associated to this AMR module.\r\
\n"
direction:
slot_uri: cim:ComFunction.direction
range: ComDirectionKind
required: false
multivalued: false
description: "Kind of communication direction.\r\n"
technology:
slot_uri: cim:ComFunction.technology
range: ComTechnologyKind
required: false
multivalued: false
description: "Kind of communication technology.\r\n"
ComModule:
slot_uri: cim:ComFunction.ComModule
range: ComModule
required: false
multivalued: false
description: Module performing this communication function.
ComModule:
class_uri: cim:ComModule
is_a: Asset
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
description: "An asset having communications capabilities that can be paired with\
\ a meter or other end device to provide the device with communication ability,\
\ through associated communication function. An end device that has communications\
\ capabilities through embedded hardware can use that function directly (without\
\ the communication module), or combine embedded communication function with\
\ additional communication functions provided through an external communication\
\ module (e.g. zigbee).\r\n"
attributes:
amrSystem:
slot_uri: cim:ComModule.amrSystem
range: string
required: false
multivalued: false
description: "Automated meter reading (AMR) system communicating with this\
\ com module.\r\n"
supportsAutonomousDst:
slot_uri: cim:ComModule.supportsAutonomousDst
range: boolean
required: false
multivalued: false
description: If true, autonomous daylight saving time (DST) function is supported.
timeZoneOffset:
slot_uri: cim:ComModule.timeZoneOffset
range: Minutes
required: false
multivalued: false
description: "Time zone offset relative to GMT for the location of this com\
\ module.\r\n"
ComFunctions:
slot_uri: cim:ComModule.ComFunctions
range: ComFunction
required: false
multivalued: true
description: All functions this communication module performs.
PanDemandResponse:
class_uri: cim:PanDemandResponse
is_a: EndDeviceAction
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
description: "PAN control used to issue action/command to PAN devices during a\
\ demand response/load control event.\r\n"
attributes:
appliance:
slot_uri: cim:PanDemandResponse.appliance
range: ControlledAppliance
required: false
multivalued: false
description: "Appliance being controlled.\r\n"
avgLoadAdjustment:
slot_uri: cim:PanDemandResponse.avgLoadAdjustment
range: PerCent
required: false
multivalued: false
description: "Used to define a maximum energy usage limit as a percentage\
\ of the client implementations specific average energy usage. The load\
\ adjustment percentage is added to 100% creating a percentage limit applied\
\ to the client implementations specific average energy usage. A -10% load\
\ adjustment percentage will establish an energy usage limit equal to 90%\
\ of the client implementations specific average energy usage. Each load\
\ adjustment percentage is referenced to the client implementations specific\
\ average energy usage. There are no cumulative effects.\r\nThe range of\
\ this field is -100% to +100% with a resolution of 1. A -100% value equals\
\ a total load shed. A +100% value will limit the energy usage to the client\
\ implementations specific average energy usage."
cancelControlMode:
slot_uri: cim:PanDemandResponse.cancelControlMode
range: string
required: false
multivalued: false
description: "Encoding of cancel control.\r\n"
cancelDateTime:
slot_uri: cim:PanDemandResponse.cancelDateTime
range: date
required: false
multivalued: false
description: "Timestamp when a canceling of the event is scheduled to start.\r\
\n"
cancelNow:
slot_uri: cim:PanDemandResponse.cancelNow
range: boolean
required: false
multivalued: false
description: "If true, a canceling of the event should start immediately.\r\
\n"
coolingOffset:
slot_uri: cim:PanDemandResponse.coolingOffset
range: Temperature
required: false
multivalued: false
description: "Requested offset to apply to the normal cooling setpoint at\
\ the time of the start of the event. It represents a temperature change\
\ that will be applied to the associated cooling set point. The temperature\
\ offsets will be calculated per the local temperature in the thermostat.\
\ The calculated temperature will be interpreted as the number of degrees\
\ to be added to the cooling set point. Sequential demand response events\
\ are not cumulative. The offset shall be applied to the normal setpoint.\r\
\n"
coolingSetpoint:
slot_uri: cim:PanDemandResponse.coolingSetpoint
range: Temperature
required: false
multivalued: false
description: "Requested cooling set point. Temperature set point is typically\
\ defined and calculated based on local temperature.\r\n"
criticalityLevel:
slot_uri: cim:PanDemandResponse.criticalityLevel
range: string
required: false
multivalued: false
description: Level of criticality for the action of this control. The action
taken by load control devices for an event can be solely based on this value,
or in combination with other load control event fields supported by the
device.
dutyCycle:
slot_uri: cim:PanDemandResponse.dutyCycle
range: PerCent
required: false
multivalued: false
description: Maximum "on" state duty cycle as a percentage of time. For example,
if the value is 80, the device would be in an "on" state for 80% of the
time for the duration of the action.
enrollmentGroup:
slot_uri: cim:PanDemandResponse.enrollmentGroup
range: string
required: false
multivalued: false
description: "Provides a mechanism to direct load control actions to groups\
\ of PAN devices. It can be used in conjunction with the PAN device types.\r\
\n"
heatingOffset:
slot_uri: cim:PanDemandResponse.heatingOffset
range: Temperature
required: false
multivalued: false
description: "Requested offset to apply to the normal heating setpoint at\
\ the time of the start of the event. It represents a temperature change\
\ that will be applied to the associated heating set point. The temperature\
\ offsets will be calculated per the local temperature in the thermostat.\
\ The calculated temperature will be interpreted as the number of degrees\
\ to be subtracted from the heating set point. Sequential demand response\
\ events are not cumulative. The offset shall be applied to the normal setpoint.\r\
\n"
heatingSetpoint:
slot_uri: cim:PanDemandResponse.heatingSetpoint
range: Temperature
required: false
multivalued: false
description: "Requested heating set point. Temperature set point is typically\
\ defined and calculated based on local temperature.\r\n"
SimpleEndDeviceFunction:
class_uri: cim:SimpleEndDeviceFunction
is_a: EndDeviceFunction
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
description: "Simple end device function distinguished by 'kind'. Use this class\
\ for instances that cannot be represented by another end device function specialisations.\r\
\n"
attributes:
kind:
slot_uri: cim:SimpleEndDeviceFunction.kind
range: EndDeviceFunctionKind
required: false
multivalued: false
description: "Kind of this function.\r\n"
PanDisplay:
class_uri: cim:PanDisplay
is_a: EndDeviceAction
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
description: "PAN action/command used to issue the displaying of text messages\
\ on PAN devices.\r\n"
attributes:
confirmationRequired:
slot_uri: cim:PanDisplay.confirmationRequired
range: boolean
required: false
multivalued: false
description: "If true, the requesting entity (e.g. retail electric provider)\
\ requires confirmation of the successful display of the text message.\r\
\n"
priority:
slot_uri: cim:PanDisplay.priority
range: string
required: false
multivalued: false
description: "Priority associated with the text message to be displayed.\r\
\n"
textMessage:
slot_uri: cim:PanDisplay.textMessage
range: string
required: false
multivalued: false
description: "Text to be displayed by a PAN device.\r\n"
transmissionMode:
slot_uri: cim:PanDisplay.transmissionMode
range: TransmissionModeKind
required: false
multivalued: false
description: "Transmission mode to be used for this PAN display control.\r\
\n"
TapeShieldCableInfo:
class_uri: cim:TapeShieldCableInfo
is_a: CableInfo
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetInfo
description: Tape shield cable data.
attributes:
tapeLap:
slot_uri: cim:TapeShieldCableInfo.tapeLap
range: PerCent
required: false
multivalued: false
description: Percentage of the tape shield width that overlaps in each wrap,
typically 10% to 25%.
tapeThickness:
slot_uri: cim:TapeShieldCableInfo.tapeThickness
range: Length
required: false
multivalued: false
description: Thickness of the tape shield, before wrapping.
CableInfo:
class_uri: cim:CableInfo
is_a: WireInfo
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetInfo
description: "Cable data.\r\n"
attributes:
constructionKind:
slot_uri: cim:CableInfo.constructionKind
range: CableConstructionKind
required: false
multivalued: false
description: Kind of construction of this cable.
diameterOverCore:
slot_uri: cim:CableInfo.diameterOverCore
range: Length
required: false
multivalued: false
description: Diameter over the core, including any semi-con screen; should
be the insulating layer's inside diameter.
diameterOverInsulation:
slot_uri: cim:CableInfo.diameterOverInsulation
range: Length
required: false
multivalued: false
description: Diameter over the insulating layer, excluding outer screen.
diameterOverJacket:
slot_uri: cim:CableInfo.diameterOverJacket
range: Length
required: false
multivalued: false
description: Diameter over the outermost jacketing layer.
diameterOverScreen:
slot_uri: cim:CableInfo.diameterOverScreen
range: Length
required: false
multivalued: false
description: Diameter over the outer screen; should be the shield's inside
diameter.
isStrandFill:
slot_uri: cim:CableInfo.isStrandFill
range: boolean
required: false
multivalued: false
description: True if wire strands are extruded in a way to fill the voids
in the cable.
nominalTemperature:
slot_uri: cim:CableInfo.nominalTemperature
range: Temperature
required: false
multivalued: false
description: Maximum nominal design operating temperature.
outerJacketKind:
slot_uri: cim:CableInfo.outerJacketKind
range: CableOuterJacketKind
required: false
multivalued: false
description: Kind of outer jacket of this cable.
sheathAsNeutral:
slot_uri: cim:CableInfo.sheathAsNeutral
range: boolean
required: false
multivalued: false
description: True if sheath / shield is used as a neutral (i.e., bonded).
shieldMaterial:
slot_uri: cim:CableInfo.shieldMaterial
range: CableShieldMaterialKind
required: false
multivalued: false
description: Material of the shield.
OperatingMechanismInfo:
class_uri: cim:OperatingMechanismInfo
is_a: AssetInfo
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetInfo
description: Breaker operating mechanism datasheet information.
attributes:
closeAmps:
slot_uri: cim:OperatingMechanismInfo.closeAmps
range: CurrentFlow
required: false
multivalued: false
description: Close current (nominal).
closeVoltage:
slot_uri: cim:OperatingMechanismInfo.closeVoltage
range: Voltage
required: false
multivalued: false
description: Close voltage in volts DC.
mechanismKind:
slot_uri: cim:OperatingMechanismInfo.mechanismKind
range: OperatingMechanismKind
required: false
multivalued: false
description: Kind of breaker operating mechanism.
motorRunCurrent:
slot_uri: cim:OperatingMechanismInfo.motorRunCurrent
range: CurrentFlow
required: false
multivalued: false
description: Rated motor run current in amps.
motorStartCurrent:
slot_uri: cim:OperatingMechanismInfo.motorStartCurrent
range: CurrentFlow
required: false
multivalued: false
description: Rated motor start current in amps.
motorVoltage:
slot_uri: cim:OperatingMechanismInfo.motorVoltage
range: Voltage
required: false
multivalued: false
description: Nominal motor voltage in volts DC.
tripAmps:
slot_uri: cim:OperatingMechanismInfo.tripAmps
range: CurrentFlow
required: false
multivalued: false
description: Trip current (nominal).
tripVoltage:
slot_uri: cim:OperatingMechanismInfo.tripVoltage
range: Voltage
required: false
multivalued: false
description: Trip voltage in volts DC.
BushingInfo:
class_uri: cim:BushingInfo
is_a: AssetInfo
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetInfo
description: Bushing datasheet information.
attributes:
c1Capacitance:
slot_uri: cim:BushingInfo.c1Capacitance
range: Capacitance
required: false
multivalued: false
description: Factory measured capacitance, measured between the power factor
tap and the bushing conductor.
c1PowerFactor:
slot_uri: cim:BushingInfo.c1PowerFactor
range: PerCent
required: false
multivalued: false
description: Factory measured insulation power factor, measured between the
power factor tap and the bushing conductor.
c2Capacitance:
slot_uri: cim:BushingInfo.c2Capacitance
range: Capacitance
required: false
multivalued: false
description: Factory measured capacitance measured between the power factor
tap and ground.
c2PowerFactor:
slot_uri: cim:BushingInfo.c2PowerFactor
range: PerCent
required: false
multivalued: false
description: Factory measured insulation power factor, measured between the
power factor tap and ground.
insulationKind:
slot_uri: cim:BushingInfo.insulationKind
range: BushingInsulationKind
required: false
multivalued: false
description: Kind of insulation.
ratedCurrent:
slot_uri: cim:BushingInfo.ratedCurrent
range: CurrentFlow
required: false
multivalued: false
description: Rated current for bushing as installed.
ratedImpulseWithstandVoltage:
slot_uri: cim:BushingInfo.ratedImpulseWithstandVoltage
range: Voltage
required: false
multivalued: false
description: Rated impulse withstand voltage, also known as BIL (Basic Impulse
Level).
ratedLineToGroundVoltage:
slot_uri: cim:BushingInfo.ratedLineToGroundVoltage
range: Voltage
required: false
multivalued: false
description: Rated line-to-ground voltage. Also referred to as Uy on bushing
nameplate.
ratedVoltage:
slot_uri: cim:BushingInfo.ratedVoltage
range: Voltage
required: false
multivalued: false
description: Rated voltage. Can be referred to as Um, system voltage or class
on bushing nameplate.
OverheadWireInfo:
class_uri: cim:OverheadWireInfo
is_a: WireInfo
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetInfo
description: "Overhead wire data.\r\n"
TapChangerInfo:
class_uri: cim:TapChangerInfo
is_a: AssetInfo
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetInfo
description: "Tap changer data.\r\n"
attributes:
bil:
slot_uri: cim:TapChangerInfo.bil
range: Voltage
required: false
multivalued: false
description: "Basic Insulation Level (BIL) expressed as the impulse crest\
\ voltage of a nominal wave, typically 1.2 X 50 microsecond. This is a measure\
\ of the ability of the insulation to withstand very high voltage surges.\r\
\n"
ctRating:
slot_uri: cim:TapChangerInfo.ctRating
range: CurrentFlow
required: false
multivalued: false
description: Built-in current transformer primary rating.
ctRatio:
slot_uri: cim:TapChangerInfo.ctRatio
range: float
required: false
multivalued: false
description: Built-in current transducer ratio.
frequency:
slot_uri: cim:TapChangerInfo.frequency
range: Frequency
required: false
multivalued: false
description: "Frequency at which the ratings apply.\r\n"
highStep:
slot_uri: cim:TapChangerInfo.highStep
range: integer
required: false
multivalued: false
description: "Highest possible tap step position, advance from neutral.\r\n"
isTcul:
slot_uri: cim:TapChangerInfo.isTcul
range: boolean
required: false
multivalued: false
description: "Whether this tap changer has under load tap changing capabilities.\r\
\n"
lowStep:
slot_uri: cim:TapChangerInfo.lowStep
range: integer
required: false
multivalued: false
description: "Lowest possible tap step position, retard from neutral.\r\n"
neutralStep:
slot_uri: cim:TapChangerInfo.neutralStep
range: integer
required: false
multivalued: false
description: "The neutral tap step position for the winding.\r\n"
neutralU:
slot_uri: cim:TapChangerInfo.neutralU
range: Voltage
required: false
multivalued: false
description: Voltage at which the winding operates at the neutral tap setting.
ptRatio:
slot_uri: cim:TapChangerInfo.ptRatio
range: float
required: false
multivalued: false
description: Built-in voltage transducer ratio.
ratedApparentPower:
slot_uri: cim:TapChangerInfo.ratedApparentPower
range: ApparentPower
required: false
multivalued: false
description: Rated apparent power.
ratedCurrent:
slot_uri: cim:TapChangerInfo.ratedCurrent
range: CurrentFlow
required: false
multivalued: false
description: Rated current.
ratedVoltage:
slot_uri: cim:TapChangerInfo.ratedVoltage
range: Voltage
required: false
multivalued: false
description: Rated voltage.
stepPhaseIncrement:
slot_uri: cim:TapChangerInfo.stepPhaseIncrement
range: AngleDegrees
required: false
multivalued: false
description: "Phase shift per step position.\r\n"
stepVoltageIncrement:
slot_uri: cim:TapChangerInfo.stepVoltageIncrement
range: PerCent
required: false
multivalued: false
description: "Tap step increment, in per cent of rated voltage, per step position.\r\
\n"
InterrupterUnitInfo:
class_uri: cim:InterrupterUnitInfo
is_a: AssetInfo
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetInfo
description: Interrupter datasheet information.
attributes:
interruptingMedium:
slot_uri: cim:InterrupterUnitInfo.interruptingMedium
range: InterruptingMediumKind
required: false
multivalued: false
description: Interrupting medium.
ConcentricNeutralCableInfo:
class_uri: cim:ConcentricNeutralCableInfo
is_a: CableInfo
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetInfo
description: Concentric neutral cable data.
attributes:
diameterOverNeutral:
slot_uri: cim:ConcentricNeutralCableInfo.diameterOverNeutral
range: Length
required: false
multivalued: false
description: Diameter over the concentric neutral strands.
neutralStrandCount:
slot_uri: cim:ConcentricNeutralCableInfo.neutralStrandCount
range: integer
required: false
multivalued: false
description: Number of concentric neutral strands.
neutralStrandGmr:
slot_uri: cim:ConcentricNeutralCableInfo.neutralStrandGmr
range: Length
required: false
multivalued: false
description: "Geometric mean radius of the neutral strand.\r\n"
neutralStrandRadius:
slot_uri: cim:ConcentricNeutralCableInfo.neutralStrandRadius
range: Length
required: false
multivalued: false
description: "Outside radius of the neutral strand.\r\n"
neutralStrandRDC20:
slot_uri: cim:ConcentricNeutralCableInfo.neutralStrandRDC20
range: ResistancePerLength
required: false
multivalued: false
description: "DC resistance per unit length of the neutral strand at 20 \xB0\
C.\r\n"
BusbarSectionInfo:
class_uri: cim:BusbarSectionInfo
is_a: AssetInfo
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetInfo
description: "Busbar section data.\r\n"
attributes:
ratedCurrent:
slot_uri: cim:BusbarSectionInfo.ratedCurrent
range: CurrentFlow
required: false
multivalued: false
description: Rated current.
ratedVoltage:
slot_uri: cim:BusbarSectionInfo.ratedVoltage
range: Voltage
required: false
multivalued: false
description: Rated voltage.
UndergroundStructure:
class_uri: cim:UndergroundStructure
is_a: Structure
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfAssets
description: "Underground structure.\r\n"
attributes:
hasVentilation:
slot_uri: cim:UndergroundStructure.hasVentilation
range: boolean
required: false
multivalued: false
description: True if vault is ventilating.
kind:
slot_uri: cim:UndergroundStructure.kind
range: UndergroundStructureKind
required: false
multivalued: false
description: True if vault is ventilating.
material:
slot_uri: cim:UndergroundStructure.material
range: string
required: false
multivalued: false
description: Primary material of underground structure.
sealingWarrantyExpiresDate:
slot_uri: cim:UndergroundStructure.sealingWarrantyExpiresDate
range: date
required: false
multivalued: false
description: "Date sealing warranty expires.\r\n"
Tower:
class_uri: cim:Tower
is_a: Structure
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfAssets
description: "Tower asset. Dimensions of the Tower are specified in associated\
\ DimensionsInfo class.\r\nWhen used for planning purposes, a transmission tower\
\ carrying two 3-phase circuits will have 2 instances of Connection, each of\
\ which will have 3 MountingPoint instances, one for each phase all with coordinates\
\ relative to a common origin on the tower. (It may also have a 3rd Connection\
\ with a single MountingPoint for the Neutral line).\r\n"
attributes:
constructionKind:
slot_uri: cim:Tower.constructionKind
range: TowerConstructionKind
required: false
multivalued: false
description: Construction structure on the tower.
ExtensionItem:
class_uri: cim:ExtensionItem
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Common
description: Specifies the extensions list items
attributes:
extName:
slot_uri: cim:ExtensionItem.extName
range: string
required: false
multivalued: false
description: the name of the extension
extType:
slot_uri: cim:ExtensionItem.extType
range: string
required: false
multivalued: false
description: The type of the extension
extValue:
slot_uri: cim:ExtensionItem.extValue
range: string
required: false
multivalued: false
description: the value of the extension
ExtensionsList:
class_uri: cim:ExtensionsList
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Common
description: Specifies the enumeration of the extension item
attributes:
extensionsItem:
slot_uri: cim:ExtensionsList.extensionsItem
range: ExtensionItem
required: false
multivalued: false
description: 'a compound type that defines the extension name, type and value '
MagneticField:
class_uri: cim:MagneticField
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental.EnvDomain
description: Magnetic field in nanotesla.
attributes:
multiplier:
slot_uri: cim:MagneticField.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:MagneticField.unit
range: UnitSymbol
required: false
multivalued: false
value:
slot_uri: cim:MagneticField.value
range: float
required: false
multivalued: false
RelativeDisplacement:
class_uri: cim:RelativeDisplacement
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental.EnvDomain
description: Vertical displacement relative to either sealevel, ground or the
center of the earth.
attributes:
displacement:
slot_uri: cim:RelativeDisplacement.displacement
range: Displacement
required: false
multivalued: false
kind:
slot_uri: cim:RelativeDisplacement.kind
range: RelativeDisplacementKind
required: false
multivalued: false
ParticulateDensity:
class_uri: cim:ParticulateDensity
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental.EnvDomain
description: Particulate density as kg/m3.
attributes:
multiplier:
slot_uri: cim:ParticulateDensity.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:ParticulateDensity.unit
range: UnitSymbol
required: false
multivalued: false
value:
slot_uri: cim:ParticulateDensity.value
range: float
required: false
multivalued: false
Bearing:
class_uri: cim:Bearing
annotations:
represents_cim_data_type: true
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental.EnvDomain
description: The bearing in degrees (with 360 degrees being True North). Measured
in degrees clockwise from True North. 0 degrees indicates no direction being
given.
attributes:
multiplier:
slot_uri: cim:Bearing.multiplier
range: UnitMultiplier
required: false
multivalued: false
unit:
slot_uri: cim:Bearing.unit
range: UnitSymbol
required: false
multivalued: false
value:
slot_uri: cim:Bearing.value
range: float
required: false
multivalued: false
Participation:
class_uri: cim:Participation
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfMarketOperations
description: "Participation level of a given Pnode in a given AggregatePnode.\r\
\n"
attributes:
factor:
slot_uri: cim:Participation.factor
range: float
required: false
multivalued: false
description: "Used to calculate \"participation\" of Pnode in an AggregatePnode.\
\ For example, for regulation region this factor is 1 and total sum of all\
\ factors for a specific regulation region does not have to be 1. For pricing\
\ zone the total sum of all factors has to be 1.\r\n"
BilateralTransaction:
class_uri: cim:BilateralTransaction
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfMarketOperations
description: "Bilateral transaction\r\n"
attributes:
curtailTimeMax:
slot_uri: cim:BilateralTransaction.curtailTimeMax
range: integer
required: false
multivalued: false
description: "Maximum curtailment time in number of trading intervals\r\n"
curtailTimeMin:
slot_uri: cim:BilateralTransaction.curtailTimeMin
range: integer
required: false
multivalued: false
description: "Minimum curtailment time in number of trading intervals\r\n"
marketType:
slot_uri: cim:BilateralTransaction.marketType
range: string
required: false
multivalued: false
description: "Market type (default=DA)\r\nDA - Day Ahead\r\nRT - Real Time\r\
\nHA - Hour Ahead\r\n"
purchaseTimeMax:
slot_uri: cim:BilateralTransaction.purchaseTimeMax
range: integer
required: false
multivalued: false
description: "Maximum purchase time in number of trading intervals\r\n"
purchaseTimeMin:
slot_uri: cim:BilateralTransaction.purchaseTimeMin
range: integer
required: false
multivalued: false
description: "Minimum purchase time in number of trading intervals\r\n"
scope:
slot_uri: cim:BilateralTransaction.scope
range: string
required: false
multivalued: false
description: "Transaction scope:\r\n'Internal' (default)\r\n'External'\r\n"
totalTranChargeMax:
slot_uri: cim:BilateralTransaction.totalTranChargeMax
range: Money
required: false
multivalued: false
description: "Maximum total transmission (congestion) charges in monetary\
\ units\r\n"
transactionType:
slot_uri: cim:BilateralTransaction.transactionType
range: string
required: false
multivalued: false
description: "Transaction type (default 1)\r\n1 - Fixed\r\n2 - Dispatchable\
\ continuous\r\n3 - Dispatchable block-loading\r\n"
AuxiliaryCost:
class_uri: cim:AuxiliaryCost
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketQualitySystem
description: "Models Market clearing results for Auxiliary costs.\r\n"
attributes:
intervalStartTime:
slot_uri: cim:AuxiliaryCost.intervalStartTime
range: date
required: false
multivalued: false
marketType:
slot_uri: cim:AuxiliaryCost.marketType
range: MarketType
required: false
multivalued: false
updateTimeStamp:
slot_uri: cim:AuxiliaryCost.updateTimeStamp
range: date
required: false
multivalued: false
updateUser:
slot_uri: cim:AuxiliaryCost.updateUser
range: string
required: false
multivalued: false
AuxillaryValues:
slot_uri: cim:AuxiliaryCost.AuxillaryValues
range: AuxiliaryValues
required: true
multivalued: true
AuxiliaryValues:
class_uri: cim:AuxiliaryValues
is_a: AuxiliaryObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketQualitySystem
description: "Models Auxiliary Values.\r\n"
attributes:
availUndispatchedQ:
slot_uri: cim:AuxiliaryValues.availUndispatchedQ
range: float
required: false
multivalued: false
incrementalORAvail:
slot_uri: cim:AuxiliaryValues.incrementalORAvail
range: float
required: false
multivalued: false
maxExpostCapacity:
slot_uri: cim:AuxiliaryValues.maxExpostCapacity
range: float
required: false
multivalued: false
minExpostCapacity:
slot_uri: cim:AuxiliaryValues.minExpostCapacity
range: float
required: false
multivalued: false
noLoadCost:
slot_uri: cim:AuxiliaryValues.noLoadCost
range: float
required: false
multivalued: false
noLoadCostEligibilityFlag:
slot_uri: cim:AuxiliaryValues.noLoadCostEligibilityFlag
range: YesNo
required: false
multivalued: false
startUpCost:
slot_uri: cim:AuxiliaryValues.startUpCost
range: float
required: false
multivalued: false
startUpCostEligibilityFlag:
slot_uri: cim:AuxiliaryValues.startUpCostEligibilityFlag
range: YesNo
required: false
multivalued: false
FiveMinAuxillaryData:
slot_uri: cim:AuxiliaryValues.FiveMinAuxillaryData
range: FiveMinAuxiliaryData
required: true
multivalued: false
TenMinAuxillaryData:
slot_uri: cim:AuxiliaryValues.TenMinAuxillaryData
range: TenMinAuxiliaryData
required: true
multivalued: false
AuxillaryCost:
slot_uri: cim:AuxiliaryValues.AuxillaryCost
range: AuxiliaryCost
required: true
multivalued: false
FiveMinAuxiliaryData:
class_uri: cim:FiveMinAuxiliaryData
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketQualitySystem
description: "Models 5-Minutes Auxiliary Data.\r\n"
attributes:
intervalStartTime:
slot_uri: cim:FiveMinAuxiliaryData.intervalStartTime
range: date
required: false
multivalued: false
updateTimeStamp:
slot_uri: cim:FiveMinAuxiliaryData.updateTimeStamp
range: date
required: false
multivalued: false
updateUser:
slot_uri: cim:FiveMinAuxiliaryData.updateUser
range: string
required: false
multivalued: false
AuxillaryValues:
slot_uri: cim:FiveMinAuxiliaryData.AuxillaryValues
range: AuxiliaryValues
required: true
multivalued: true
TenMinAuxiliaryData:
class_uri: cim:TenMinAuxiliaryData
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketQualitySystem
description: "Models 10-Minutes Auxiliary Data.\r\n"
attributes:
intervalStartTime:
slot_uri: cim:TenMinAuxiliaryData.intervalStartTime
range: date
required: false
multivalued: false
updateTimeStamp:
slot_uri: cim:TenMinAuxiliaryData.updateTimeStamp
range: date
required: false
multivalued: false
updateUser:
slot_uri: cim:TenMinAuxiliaryData.updateUser
range: string
required: false
multivalued: false
AuxillaryData:
slot_uri: cim:TenMinAuxiliaryData.AuxillaryData
range: AuxiliaryValues
required: true
multivalued: true
PumpingShutDownCostSchedule:
class_uri: cim:PumpingShutDownCostSchedule
is_a: BidHourlyProductSchedule
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ParticipantInterfaces
description: "The cost to shutdown a Pump Storage Hydro Unit (in pump mode) or\
\ a pump.\r\n\r\nThis schedule is assocated with the hourly parameters in a\
\ resource bid associated with a specific product within the bid.\r\n"
attributes:
value:
slot_uri: cim:PumpingShutDownCostSchedule.value
range: float
required: false
multivalued: false
PumpingLevelSchedule:
class_uri: cim:PumpingLevelSchedule
is_a: BidHourlyProductSchedule
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ParticipantInterfaces
description: "The fixed operating level of a Pump Storage Hydro Unit operating\
\ as a hydro pump. Associated with the energy market product type.\r\n\r\nThis\
\ schedule is assocated with the hourly parameters in a resource bid associated\
\ with a specific product within the bid.\r\n"
attributes:
value:
slot_uri: cim:PumpingLevelSchedule.value
range: float
required: false
multivalued: false
HourlyPreDispatchSchedule:
class_uri: cim:HourlyPreDispatchSchedule
is_a: BidHourlySchedule
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ParticipantInterfaces
description: "An indicator specifying that a resource shall have an Hourly Pre-Dispatch.\
\ The resource could be a RegisteredGenerator or a RegisteredInterTie.\r\n\r\
\nThis schedule is assocated with the hourly parameters in a resource bid."
attributes:
value:
slot_uri: cim:HourlyPreDispatchSchedule.value
range: boolean
required: false
multivalued: false
description: Flag defining that for this hour in the resource bid the resource
shall have an hourly pre-dispatch.
PumpingCostSchedule:
class_uri: cim:PumpingCostSchedule
is_a: BidHourlyProductSchedule
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ParticipantInterfaces
description: "The operating cost of a Pump Storage Hydro Unit operating as a hydro\
\ pump.\r\n\r\nThis schedule is assocated with the hourly parameters in a resource\
\ bid associated with a specific product within the bid.\r\n"
attributes:
value:
slot_uri: cim:PumpingCostSchedule.value
range: float
required: false
multivalued: false
OpenTieSchedule:
class_uri: cim:OpenTieSchedule
is_a: BidHourlySchedule
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ParticipantInterfaces
description: "Result of bid validation against conditions that may exist on an\
\ interchange that becomes disconnected or is heavily discounted with respect\
\ the MW flow.\r\n\r\nThis schedule is assocated with the hourly parameters\
\ in a resource bid.\r\n"
attributes:
value:
slot_uri: cim:OpenTieSchedule.value
range: boolean
required: false
multivalued: false
CloudCondition:
class_uri: cim:CloudCondition
is_a: AtmosphericPhenomenon
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental
description: A classified cloud phenomenon with a type.
attributes:
kind:
slot_uri: cim:CloudCondition.kind
range: CloudKind
required: false
multivalued: false
description: The type of the cloud as defined by the CloudKind enumeration.
AtmosphericPhenomenon:
class_uri: cim:AtmosphericPhenomenon
is_a: EnvironmentalPhenomenon
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental
description: An atmospheric phenomenon with a base and altitude providing the
vertical coverage (combined with the Location to provide three dimensional space).
attributes:
altitude:
slot_uri: cim:AtmosphericPhenomenon.altitude
range: RelativeDisplacement
required: false
multivalued: false
description: The maximum altitude of the phenomenon.
base:
slot_uri: cim:AtmosphericPhenomenon.base
range: RelativeDisplacement
required: false
multivalued: false
description: The base altitude of the phenomenon.
direction:
slot_uri: cim:AtmosphericPhenomenon.direction
range: Bearing
required: false
multivalued: false
description: The direction the phenomenon is moving.
maxCoverage:
slot_uri: cim:AtmosphericPhenomenon.maxCoverage
range: PerCent
required: false
multivalued: false
description: The maximum percentage coverage
minCoverage:
slot_uri: cim:AtmosphericPhenomenon.minCoverage
range: PerCent
required: false
multivalued: false
description: 'The minimum percentage coverage '
speed:
slot_uri: cim:AtmosphericPhenomenon.speed
range: Speed
required: false
multivalued: false
description: The speed of the phenomenon
GeosphericAnalog:
class_uri: cim:GeosphericAnalog
is_a: EnvironmentalAnalog
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental
description: Analog (float) measuring a geospheric condition.
attributes:
kind:
slot_uri: cim:GeosphericAnalog.kind
range: GeosphericAnalogKind
required: false
multivalued: false
description: Kind of geospheric analog.
Hurricane:
class_uri: cim:Hurricane
is_a: Cyclone
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental
description: A hurricane, a subtype of cyclone occurring in the North Atlantic
Ocean or North-eastern Pacific Ocean whose intensity is measured using the Saffir-Simpson
Hurricane Scale.
attributes:
category:
slot_uri: cim:Hurricane.category
range: integer
required: false
multivalued: false
description: The hurricane's category during the time interval, using Saffir-Simpson
Hurricane Wind Scale, a 1 to 5 rating based on a hurricane's sustained wind
speed.
Cyclone:
class_uri: cim:Cyclone
is_a: AtmosphericPhenomenon
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental
description: A cyclone (or tropical cyclone), a rapidly-rotating storm system
characterized by a low-pressure center, strong winds, and a spiral arrangement
of thunderstorms that produce heavy rain.
attributes:
centralPressure:
slot_uri: cim:Cyclone.centralPressure
range: Pressure
required: false
multivalued: false
description: The central pressure of the cyclone during the time interval.
maxSurfaceWindSpeed:
slot_uri: cim:Cyclone.maxSurfaceWindSpeed
range: Speed
required: false
multivalued: false
description: The maximum surface wind speed of the cyclone during the time
interval.
windForce:
slot_uri: cim:Cyclone.windForce
range: integer
required: false
multivalued: false
description: Wind Force as classified on the Beaufort Scale (0-12) during
the time interval.
HydrosphericAnalog:
class_uri: cim:HydrosphericAnalog
is_a: EnvironmentalAnalog
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental
description: Analog (float) measuring a hydrospheric condition.
attributes:
kind:
slot_uri: cim:HydrosphericAnalog.kind
range: HydrosphericAnalogKind
required: false
multivalued: false
description: Kind of hydrospheric analog.
AtmosphericAnalog:
class_uri: cim:AtmosphericAnalog
is_a: EnvironmentalAnalog
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental
description: Analog (float) measuring an atmospheric condition.
attributes:
kind:
slot_uri: cim:AtmosphericAnalog.kind
range: AtmosphericAnalogKind
required: false
multivalued: false
description: Kind of atmospheric analog.
Landslide:
class_uri: cim:Landslide
is_a: GeosphericPhenomenon
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental
description: A landslide, a large mass of rocks and earth that suddenly and quickly
moves down the side of a mountain or hill.
GeosphericPhenomenon:
class_uri: cim:GeosphericPhenomenon
is_a: EnvironmentalPhenomenon
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental
description: A geospheric phenomenon.
VolcanicAshCloud:
class_uri: cim:VolcanicAshCloud
is_a: AtmosphericPhenomenon
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental
description: An ash cloud formed as a result of a volcanic eruption.
attributes:
density:
slot_uri: cim:VolcanicAshCloud.density
range: ParticulateDensity
required: false
multivalued: false
description: Particulate density of the ash cloud during the time interval.
particleSize:
slot_uri: cim:VolcanicAshCloud.particleSize
range: Length
required: false
multivalued: false
description: The diameter of the particles during the time interval.
Whirlpool:
class_uri: cim:Whirlpool
is_a: HydrosphericPhenomenon
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental
description: A whirlpool, a rapidly rotating mass of water in a river or sea into
which objects may be drawn, typically caused by the meeting of conflicting currents.
HydrosphericPhenomenon:
class_uri: cim:HydrosphericPhenomenon
is_a: EnvironmentalPhenomenon
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental
description: A hydrospheric phenomenon.
SpaceAnalog:
class_uri: cim:SpaceAnalog
is_a: EnvironmentalAnalog
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental
description: Analog (float) measuring a space (extra-terrestrial) condition.
attributes:
kind:
slot_uri: cim:SpaceAnalog.kind
range: SpaceAnalogKind
required: false
multivalued: false
description: Kind of space analog.
Flood:
class_uri: cim:Flood
is_a: HydrosphericPhenomenon
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental
description: A flood, an overflowing of a large amount of water beyond its normal
confines, esp. over what is normally dry land.
Earthquake:
class_uri: cim:Earthquake
is_a: GeosphericPhenomenon
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental
description: An earthquake.
attributes:
focalDepth:
slot_uri: cim:Earthquake.focalDepth
range: RelativeDisplacement
required: false
multivalued: false
description: The depth below the earth's surface of the earthquake's focal
point.
intensity:
slot_uri: cim:Earthquake.intensity
range: integer
required: false
multivalued: false
description: The intensity of the earthquake as defined by the Modified Mercalli
Intensity (MMI) scale. Possible values are 1-12, corresponding to I-XII.
magnitude:
slot_uri: cim:Earthquake.magnitude
range: float
required: false
multivalued: false
description: The magnitude of the earthquake as defined on the Moment Magnitude
(Mw) scale, which measures the size of earthquakes in terms of
the energy released. Must be greater than zero.
Tsunami:
class_uri: cim:Tsunami
is_a: HydrosphericPhenomenon
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental
description: A tsunami (tidal wave), a long high sea wave caused by an earthquake,
submarine landslide, or other disturbance.
attributes:
intensity:
slot_uri: cim:Tsunami.intensity
range: integer
required: false
multivalued: false
description: Tsunami intensity on the Papadopoulos-Imamura tsunami intensity
scale. Possible values are 1-12, corresponding to I-XII.
magnitude:
slot_uri: cim:Tsunami.magnitude
range: float
required: false
multivalued: false
description: Tsunami magnitude in the Tsunami Magnitude Scale (Mt). Is greater
than zero.
Forecast:
class_uri: cim:Forecast
is_a: EnvironmentalInformation
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental
description: A forecast group of value sets and/or phenomena characteristics.
attributes:
validFor:
slot_uri: cim:Forecast.validFor
range: DateTimeInterval
required: false
multivalued: false
description: The interval for which the forecast is valid. For example, a
forecast issued now for tomorrow might be valid for the next 2 hours.
MagneticStorm:
class_uri: cim:MagneticStorm
is_a: SpacePhenomenon
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental
description: A magnetic storm, a temporary disturbance of the earth's magnetic
field, induced by radiation and streams of charged particles from the sun.
attributes:
changeDst:
slot_uri: cim:MagneticStorm.changeDst
range: MagneticField
required: false
multivalued: false
description: "Change in the disturbance - storm time (Dst) index. The size\
\ of a geomagnetic storm is classified as:\r\n- moderate ( -50 nT >minimum\
\ of Dst > -100 nT)\r\n- intense (-100 nT > minimum Dst > -250\
\ nT) or \r\n- super-storm ( minimum of Dst < -250 nT)."
SpacePhenomenon:
class_uri: cim:SpacePhenomenon
is_a: EnvironmentalPhenomenon
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental
description: An extra-terrestrial phenomenon.
Fire:
class_uri: cim:Fire
is_a: GeosphericPhenomenon
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental
description: A fire, often uncontrolled, covering an area of land which typically
contains combustible vegetation. Associated location information is assumed
to describe the total area burned as of a specified time.
Observation:
class_uri: cim:Observation
is_a: EnvironmentalInformation
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental
description: Observed (actual non-forecast) values sets and/or phenomena characteristics.
EnvironmentalCodedValue:
class_uri: cim:EnvironmentalCodedValue
is_a: StringMeasurementValue
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental
description: An environmental value described using a coded value. A triplicate
of enumerated values representing intensity, coverage, type of weather is used.
These may be concatenated into the string value.
attributes:
coverageKind:
slot_uri: cim:EnvironmentalCodedValue.coverageKind
range: CoverageCodeKind
required: false
multivalued: false
description: Code representing the coverage of the weather condition.
intensityKind:
slot_uri: cim:EnvironmentalCodedValue.intensityKind
range: IntensityCodeKind
required: false
multivalued: false
description: Code representing the intensity of the weather condition.
probabilityPercent:
slot_uri: cim:EnvironmentalCodedValue.probabilityPercent
range: PerCent
required: false
multivalued: false
description: Probability of weather condition occurring during the time interval
expressed as a percentage. Applicable only when weather condition is related
to a forecast (not an observation).
weatherKind:
slot_uri: cim:EnvironmentalCodedValue.weatherKind
range: WeatherCodeKind
required: false
multivalued: false
description: Code representing the type of weather condition.
LightningStrike:
class_uri: cim:LightningStrike
is_a: GeosphericPhenomenon
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental
description: A cloud-to-ground lightning strike at a particular location.
attributes:
errorEllipseConfidence:
slot_uri: cim:LightningStrike.errorEllipseConfidence
range: PerCent
required: false
multivalued: false
description: Likelihood that strike fell within errorEllipse.
errorEllipseMajorSemiAxis:
slot_uri: cim:LightningStrike.errorEllipseMajorSemiAxis
range: Length
required: false
multivalued: false
description: Length of major semi-axis (longest radius) of the error ellipse.
errorEllipseMinorSemiAxis:
slot_uri: cim:LightningStrike.errorEllipseMinorSemiAxis
range: Length
required: true
multivalued: false
description: Length of minor semi-axis (shortest radius) of the error ellipse.
errorEllipseOrientation:
slot_uri: cim:LightningStrike.errorEllipseOrientation
range: Bearing
required: false
multivalued: false
description: The orientation of the major semi- axis in degrees from True
North.
negativePolarity:
slot_uri: cim:LightningStrike.negativePolarity
range: boolean
required: false
multivalued: false
description: The polarity of the strike, with T meaning negative. About 90%
of all lightning strokes are negative strokes, meaning that they were initiated
by a large concentration of negative charge in the cloud-base; this tends
to induce an area of positive charge on the ground.
peakAmplitude:
slot_uri: cim:LightningStrike.peakAmplitude
range: CurrentFlow
required: false
multivalued: false
description: Peak current of strike.
Tornado:
class_uri: cim:Tornado
is_a: AtmosphericPhenomenon
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental
description: A tornado, a violent destructive whirling wind accompanied by a funnel-shaped
cloud that progresses in a narrow path over the land.
attributes:
fScale:
slot_uri: cim:Tornado.fScale
range: FScale
required: false
multivalued: false
description: Fujita scale (referred to as EF-scale starting in 2007) for the
tornado.
width:
slot_uri: cim:Tornado.width
range: Length
required: true
multivalued: false
description: Width of the tornado during the time interval.
TropicalCycloneAustralia:
class_uri: cim:TropicalCycloneAustralia
is_a: Cyclone
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental
description: "A tropical cyclone, a subtype of cyclone that forms to the east\
\ of 90\xB0E in the Southern Hemisphere whose intensity is measured by the Australian\
\ tropical cyclone intensity scale."
attributes:
category:
slot_uri: cim:TropicalCycloneAustralia.category
range: integer
required: false
multivalued: false
description: "Strength of tropical cyclone during the time interval, based\
\ on Australian Bureau of Meteorology Category System where:\r\n1 - tropical\
\ cyclone, with typical gusts over flat land 90-125 km/h\r\n2 - tropical\
\ cyclone, with typical gusts over flat land 125-164 km/h\r\n3 - severe\
\ tropical cyclone, with typical gusts over flat land 165-224 km/h\r\n4\
\ - severe tropical cyclone, with typical gusts over flat land 225-279 km/h\r\
\n5 - severe tropical cyclone, with typical gusts over flat land greater\
\ than 280 km/h."
ControlAreaSolutionData:
class_uri: cim:ControlAreaSolutionData
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.ExternalInputs
description: "State Estimator Solution Pool Interchange and Losses.\r\n"
attributes:
solvedInterchange:
slot_uri: cim:ControlAreaSolutionData.solvedInterchange
range: float
required: false
multivalued: false
description: "Pool MW Interchange \r\nAttribute Usage: The active power interchange\
\ of the pool\r\n"
solvedLosses:
slot_uri: cim:ControlAreaSolutionData.solvedLosses
range: float
required: false
multivalued: false
description: "Pool Losses MW \r\nAttribute Usage: The active power losses\
\ of the pool in MW\r\n"
MktControlArea:
slot_uri: cim:ControlAreaSolutionData.MktControlArea
range: MktControlArea
required: false
multivalued: false
MktControlArea:
class_uri: cim:MktControlArea
is_a: ControlArea
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.ExternalInputs
description: Market subclass of IEC 61970:ControlArea.
attributes:
ControlAreaSolutionData:
slot_uri: cim:MktControlArea.ControlAreaSolutionData
range: ControlAreaSolutionData
required: false
multivalued: true
ShuntCompensatorDynamicData:
class_uri: cim:ShuntCompensatorDynamicData
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.ExternalInputs
description: "Optimal Power Flow or State Estimator Filter Bank Data for OTS.\
\ This is used for RealTime, Study and Maintenance Users.\r\n"
attributes:
connectionStatus:
slot_uri: cim:ShuntCompensatorDynamicData.connectionStatus
range: integer
required: false
multivalued: false
description: "The current status for the Voltage Control Capacitor 1= Connected\
\ 0 = Disconnected\r\n"
desiredVoltage:
slot_uri: cim:ShuntCompensatorDynamicData.desiredVoltage
range: float
required: false
multivalued: false
description: "The desired voltage for the Voltage Control Capacitor\r\n"
mVARInjection:
slot_uri: cim:ShuntCompensatorDynamicData.mVARInjection
range: float
required: false
multivalued: false
description: "The injection of reactive power of the filter bank in the NA\
\ solution or VCS reactive power production\r\n"
stepPosition:
slot_uri: cim:ShuntCompensatorDynamicData.stepPosition
range: integer
required: false
multivalued: false
description: "Voltage control capacitor step position\r\n"
voltageRegulationStatus:
slot_uri: cim:ShuntCompensatorDynamicData.voltageRegulationStatus
range: boolean
required: false
multivalued: false
description: "Indicator if the voltage control this is regulating True = Yes,\
\ False = No\r\n"
MktShuntCompensator:
slot_uri: cim:ShuntCompensatorDynamicData.MktShuntCompensator
range: MktShuntCompensator
required: true
multivalued: false
MktShuntCompensator:
class_uri: cim:MktShuntCompensator
is_a: ShuntCompensator
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.ExternalInputs
description: Subclass of IEC 61970:Wires:ShuntCompensator.
attributes:
ShuntCompensatorDynamicData:
slot_uri: cim:MktShuntCompensator.ShuntCompensatorDynamicData
range: ShuntCompensatorDynamicData
required: false
multivalued: true
DefaultBidCurveData:
class_uri: cim:DefaultBidCurveData
is_a: CurveData
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.ExternalInputs
description: "Curve data for default bid curve and startup cost curve.\r\n"
attributes:
bidSegmentCalcType:
slot_uri: cim:DefaultBidCurveData.bidSegmentCalcType
range: BidCalculationBasis
required: false
multivalued: false
description: "Type of calculation basis used to define the default bid segment\
\ curve.\r\n"
MktSwitch:
class_uri: cim:MktSwitch
is_a: Switch
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.ExternalInputs
description: Subclass of IEC 61970:Wires:Switch.
attributes:
SwitchStatus:
slot_uri: cim:MktSwitch.SwitchStatus
range: SwitchStatus
required: false
multivalued: true
SwitchStatus:
class_uri: cim:SwitchStatus
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.ExternalInputs
description: "Optimal Power Flow or State Estimator Circuit Breaker Status.\r\n"
attributes:
switchStatus:
slot_uri: cim:SwitchStatus.switchStatus
range: SwitchStatusType
required: false
multivalued: false
description: "Circuit Breaker Status (closed or open) of the circuit breaker\
\ from the power flow.\r\n"
MktSwitch:
slot_uri: cim:SwitchStatus.MktSwitch
range: MktSwitch
required: true
multivalued: false
MktAnalogLimit:
class_uri: cim:MktAnalogLimit
is_a: AnalogLimit
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.ExternalInputs
description: Subclass of IEC 61970:Meas:AnalogLimit.
attributes:
exceededLimit:
slot_uri: cim:MktAnalogLimit.exceededLimit
range: boolean
required: false
multivalued: false
description: "true if limit exceeded\r\n"
limitType:
slot_uri: cim:MktAnalogLimit.limitType
range: AnalogLimitType
required: false
multivalued: false
description: "The type of limit the value represents\r\nBranch Limit Types:\r\
\nShort Term\r\nMedium Term\r\nLong Term\r\nVoltage Limits:\r\nHigh\r\n\
Low\r\n"
SCADAInformation:
class_uri: cim:SCADAInformation
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.ExternalInputs
description: "Contains information about the update from SCADA.\r\n"
attributes:
timeStamp:
slot_uri: cim:SCADAInformation.timeStamp
range: date
required: false
multivalued: false
description: "time of the update from SCADA\r\n"
DiscreteMeasurementValueQuality:
class_uri: cim:DiscreteMeasurementValueQuality
is_a: MeasurementValueQuality
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.ExternalInputs
description: Measurement quality flags for Discrete Values.
attributes:
manualReplaceIndicator:
slot_uri: cim:DiscreteMeasurementValueQuality.manualReplaceIndicator
range: boolean
required: false
multivalued: false
description: Switch Manual Replace Indicator. Flag indicating that the switch
is manual replace.
removeFromOperationIndicator:
slot_uri: cim:DiscreteMeasurementValueQuality.removeFromOperationIndicator
range: boolean
required: false
multivalued: false
description: Removed From Operation Indicator. Flag indicating that the switch
is removed from operation.
ProfileData:
class_uri: cim:ProfileData
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.ExternalInputs
description: "Data for profile.\r\n"
attributes:
bidPrice:
slot_uri: cim:ProfileData.bidPrice
range: float
required: false
multivalued: false
description: "Bid price associated with contract\r\n"
capacityLevel:
slot_uri: cim:ProfileData.capacityLevel
range: ActivePower
required: false
multivalued: false
description: "Capacity level for the profile, in MW.\r\n"
energyLevel:
slot_uri: cim:ProfileData.energyLevel
range: RealEnergy
required: false
multivalued: false
description: "Energy level for the profile, in MWH.\r\n"
minimumLevel:
slot_uri: cim:ProfileData.minimumLevel
range: float
required: false
multivalued: false
description: "Minimum MW value of contract\r\n"
sequenceNumber:
slot_uri: cim:ProfileData.sequenceNumber
range: integer
required: false
multivalued: false
description: "Sequence to provide item numbering for the profile. { greater\
\ than or equal to 1 }\r\n"
startDateTime:
slot_uri: cim:ProfileData.startDateTime
range: date
required: false
multivalued: false
description: "Start date/time for this profile.\r\n"
stopDateTime:
slot_uri: cim:ProfileData.stopDateTime
range: date
required: false
multivalued: false
description: "Stop date/time for this profile.\r\n"
Profile:
slot_uri: cim:ProfileData.Profile
range: Profile
required: false
multivalued: true
description: A profile has profile data associated with it.
TapChangerDynamicData:
class_uri: cim:TapChangerDynamicData
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.ExternalInputs
description: "Optimal Power Flow or State Estimator Phase Shifter Data. This is\
\ used for RealTime, Study and Maintenance Users. SE Solution Phase Shifter\
\ Measurements from the last run of SE.\r\n"
attributes:
angleRegulationStatus:
slot_uri: cim:TapChangerDynamicData.angleRegulationStatus
range: boolean
required: false
multivalued: false
description: "True means the phase shifter is regulating.\r\n"
desiredMW:
slot_uri: cim:TapChangerDynamicData.desiredMW
range: float
required: false
multivalued: false
description: "Phase Shifter Desired MW. The active power regulation setpoint\
\ of the phase shifter\r\n"
desiredVoltage:
slot_uri: cim:TapChangerDynamicData.desiredVoltage
range: float
required: false
multivalued: false
description: "The desired voltage for the LTC\r\n"
maximumAngle:
slot_uri: cim:TapChangerDynamicData.maximumAngle
range: float
required: false
multivalued: false
description: "The maximum phase angle shift of the phase shifter\r\n"
minimumAngle:
slot_uri: cim:TapChangerDynamicData.minimumAngle
range: float
required: false
multivalued: false
description: "The minimum phase angle shift of the phase shifter\r\n"
solvedAngle:
slot_uri: cim:TapChangerDynamicData.solvedAngle
range: float
required: false
multivalued: false
description: "Phase Shifter Angle. The solved phase angle shift of the phase\
\ shifter\r\n"
tapPosition:
slot_uri: cim:TapChangerDynamicData.tapPosition
range: float
required: false
multivalued: false
description: "Tap position of the phase shifter, high-side tap position of\
\ the transformer, or low-side tap position of the transformer\r\n"
voltageRegulationStatus:
slot_uri: cim:TapChangerDynamicData.voltageRegulationStatus
range: boolean
required: false
multivalued: false
description: "Indicator if the LTC transformer is regulating True = Yes, False\
\ = No\r\n"
MktTapChanger:
slot_uri: cim:TapChangerDynamicData.MktTapChanger
range: MktTapChanger
required: true
multivalued: false
MktTapChanger:
class_uri: cim:MktTapChanger
is_a: TapChanger
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.ExternalInputs
description: Subclass of IEC 61970:Wires:TapChanger.
attributes:
TapChangerDynamicData:
slot_uri: cim:MktTapChanger.TapChangerDynamicData
range: TapChangerDynamicData
required: false
multivalued: true
MktAnalogLimitSet:
class_uri: cim:MktAnalogLimitSet
is_a: AnalogLimitSet
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.ExternalInputs
description: Subclass of IEC 61970:Meas:AnalogLimitSet.
attributes:
ratingSet:
slot_uri: cim:MktAnalogLimitSet.ratingSet
range: integer
required: false
multivalued: false
description: "Rating set numbers\r\n"
AnalogMeasurementValueQuality:
class_uri: cim:AnalogMeasurementValueQuality
is_a: MeasurementValueQuality
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.ExternalInputs
description: Measurement quality flags for Analog Values.
attributes:
scadaQualityCode:
slot_uri: cim:AnalogMeasurementValueQuality.scadaQualityCode
range: string
required: false
multivalued: false
description: The quality code for the given Analog Value.
SecurityConstraintsClearing:
class_uri: cim:SecurityConstraintsClearing
is_a: MarketFactors
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfMarketResults
description: "Binding security constrained clearing results posted for a given\
\ settlement period.\r\n"
attributes:
mwFlow:
slot_uri: cim:SecurityConstraintsClearing.mwFlow
range: ActivePower
required: false
multivalued: false
description: "Optimal MW flow\r\n"
mwLimit:
slot_uri: cim:SecurityConstraintsClearing.mwLimit
range: ActivePower
required: false
multivalued: false
description: "Binding MW limit.\r\n"
shadowPrice:
slot_uri: cim:SecurityConstraintsClearing.shadowPrice
range: Money
required: false
multivalued: false
description: "Security constraint shadow price.\r\n"
IEC62325CIMVersion:
class_uri: cim:IEC62325CIMVersion
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325
description: IEC 62325 version number assigned to this UML model.
attributes:
date:
slot_uri: cim:IEC62325CIMVersion.date
range: date
required: false
multivalued: false
description: Form is YYYY-MM-DD for example for January 5, 2009 it is 2009-01-05.
version:
slot_uri: cim:IEC62325CIMVersion.version
range: string
required: false
multivalued: false
description: Form is IEC62325CIMXXvYY where XX is the major CIM package version
and the YY is the minor version. For example IEC62325CIM10v03.
LoadReductionTimeCurve:
class_uri: cim:LoadReductionTimeCurve
is_a: Curve
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfReferenceData
description: "This is the cureve that describes the load reduction time. Relationship\
\ between time (Y1-axis) vs. MW (X-axis).\r\n"
attributes:
loadReductionTimeCurveType:
slot_uri: cim:LoadReductionTimeCurve.loadReductionTimeCurveType
range: string
required: false
multivalued: false
description: "type of the curve: Possible values are but not limited to:\r\
\n\r\nMax, Min,\r\n"
RegisteredControllableLoad:
class_uri: cim:RegisteredControllableLoad
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfReferenceData
description: Temporary holding for load reduction attributes removed from RegisteredLoad.
Use for future use case when developing the RegisteredDistributedResource specialized
classes.
attributes:
maxBaseLoad:
slot_uri: cim:RegisteredControllableLoad.maxBaseLoad
range: ActivePower
required: false
multivalued: false
description: Maximum Base Load (MW), per Participating Load Resource
maxDeploymentTime:
slot_uri: cim:RegisteredControllableLoad.maxDeploymentTime
range: float
required: false
multivalued: false
description: Maximum Deployment time (seconds)
maxLoadRedTimesPerDay:
slot_uri: cim:RegisteredControllableLoad.maxLoadRedTimesPerDay
range: integer
required: false
multivalued: false
description: Maximum Number of Daily Load Curtailments
maxLoadReduction:
slot_uri: cim:RegisteredControllableLoad.maxLoadReduction
range: ActivePower
required: false
multivalued: false
description: maximum load reduction
maxReductionTime:
slot_uri: cim:RegisteredControllableLoad.maxReductionTime
range: float
required: false
multivalued: false
description: Maxiimum Load Reduction Time (min), per Participating Load Resource
maxWeeklyDeployment:
slot_uri: cim:RegisteredControllableLoad.maxWeeklyDeployment
range: integer
required: false
multivalued: false
description: Maximum weekly deployments
minLoadReduction:
slot_uri: cim:RegisteredControllableLoad.minLoadReduction
range: ActivePower
required: false
multivalued: false
description: "Minimum MW for a load reduction (e.g., MW rating of a discrete\
\ pump.\r\n\r\nThis attribute may be used also in the LoadBid class. The\
\ reason that the attribute is also modeled in this class is that it is\
\ resource attribute and needs to be persistently stored."
minLoadReductionCost:
slot_uri: cim:RegisteredControllableLoad.minLoadReductionCost
range: CostPerEnergyUnit
required: false
multivalued: false
description: minimum load reduction cost. Single number for the load
minLoadReductionInterval:
slot_uri: cim:RegisteredControllableLoad.minLoadReductionInterval
range: float
required: false
multivalued: false
description: "Shortest period load reduction shall be maintained before load\
\ can be restored to normal levels.\r\n\r\nThis attribute may be used also\
\ in the LoadBid class. The reason that the attribute is also modeled in\
\ this class is that it is resource attribute and needs to be persistently\
\ stored."
minReductionTime:
slot_uri: cim:RegisteredControllableLoad.minReductionTime
range: float
required: false
multivalued: false
description: Minimum Load Reduction Time (min), per Participating Load Resource
minTimeBetLoadRed:
slot_uri: cim:RegisteredControllableLoad.minTimeBetLoadRed
range: float
required: false
multivalued: false
description: "Shortest time that load shall be left at normal levels before\
\ a new load reduction.\r\n\r\nThis attribute may be used also in the LoadBid\
\ class. The reason that the attribute is also modeled in this class is\
\ that it is resource attribute and needs to be persistently stored."
reqNoticeTime:
slot_uri: cim:RegisteredControllableLoad.reqNoticeTime
range: float
required: false
multivalued: false
description: "Time period that is required from an order to reduce a load\
\ to the time that it takes to get to the minimum load reduction.\r\n\r\n\
This attribute may be used also in the LoadBid class. The reason that the\
\ attribute is also modeled in this class is that it is resource attribute\
\ and needs to be persistently stored."
CurrentEmergencyScheduledInterchange:
class_uri: cim:CurrentEmergencyScheduledInterchange
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfEnergyScheduling
description: "Control area emergency schedules\r\n"
attributes:
emergencyScheduleMW:
slot_uri: cim:CurrentEmergencyScheduledInterchange.emergencyScheduleMW
range: float
required: false
multivalued: false
description: "Net tie MW. These are three entries, the current emergency schedule\
\ interchange and the two future schedules if they exist.\r\n"
emergencyScheduleRampTime:
slot_uri: cim:CurrentEmergencyScheduledInterchange.emergencyScheduleRampTime
range: integer
required: false
multivalued: false
description: "Ramp time, the ramping time for a schedule. This is calculated\
\ as the remaining time to ramp if a schedule is ramping. Measured in seconds,\
\ but can be negattive.\r\n"
emergencyScheduleStartTime:
slot_uri: cim:CurrentEmergencyScheduledInterchange.emergencyScheduleStartTime
range: date
required: false
multivalued: false
description: "Net tie time, the start time for a schedule. This is calculated\
\ as the current time if a schedule is ramping.\r\n"
InternalControlArea:
slot_uri: cim:CurrentEmergencyScheduledInterchange.InternalControlArea
range: InternalControlArea
required: true
multivalued: false
InternalControlArea:
class_uri: cim:InternalControlArea
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfEnergyScheduling
description: "There is one internal control area in the system, which is the single\
\ control area in the primary network company. Real time generation control\
\ affects only the internal control area.\r\n"
attributes:
CurrentScheduledInterchange:
slot_uri: cim:InternalControlArea.CurrentScheduledInterchange
range: CurrentScheduledInterchange
required: false
multivalued: false
CurrentEmergencySI:
slot_uri: cim:InternalControlArea.CurrentEmergencySI
range: CurrentEmergencyScheduledInterchange
required: false
multivalued: true
CurrentScheduledInterchange:
class_uri: cim:CurrentScheduledInterchange
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfEnergyScheduling
description: "Control area current net tie (scheduled interchange) sent to real\
\ time dispatch.\r\n"
attributes:
currentNetTieMW:
slot_uri: cim:CurrentScheduledInterchange.currentNetTieMW
range: float
required: false
multivalued: false
description: "Current control area net tie MW (the sum of the tie line flows,\
\ i.e the sum of flows into and out of the control area), the current instantaneous\
\ scheduled interchange.\r\n"
useEmergencySchedule:
slot_uri: cim:CurrentScheduledInterchange.useEmergencySchedule
range: boolean
required: false
multivalued: false
description: "Use Emergency Schedule \r\nAttribute Usage: Emergency use indicator,\
\ false = Emergency Schedular OFF, true = Emergency Schedular ON.\r\n"
InternalControlArea:
slot_uri: cim:CurrentScheduledInterchange.InternalControlArea
range: InternalControlArea
required: true
multivalued: false
LoadAggregationPoint:
class_uri: cim:LoadAggregationPoint
is_a: AggregateNode
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: "A specialized class of type AggregatedNode type. Defines Load Aggregation\
\ Points.\r\n"
RegisteredDistributedResource:
class_uri: cim:RegisteredDistributedResource
is_a: RegisteredResource
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: 'A registered resource that represents a distributed energy resource,
such as a micro-generator, fuel cell, photo-voltaic energy source, etc. '
attributes:
distributedResourceType:
slot_uri: cim:RegisteredDistributedResource.distributedResourceType
range: string
required: false
multivalued: false
description: 'The type of resource. Examples include: fuel cell, flywheel,
photovoltaic, micro-turbine, CHP (combined heat power), V2G (vehicle to
grid), DES (distributed energy storage), and others.'
ResourcePerformanceRatings:
slot_uri: cim:RegisteredDistributedResource.ResourcePerformanceRatings
range: ResourcePerformanceRating
required: false
multivalued: true
ResponseMethods:
slot_uri: cim:RegisteredDistributedResource.ResponseMethods
range: ResponseMethod
required: false
multivalued: true
ResourcePerformanceRating:
class_uri: cim:ResourcePerformanceRating
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MarketSystem.MarketResults
description: Rating of a resource for its demand response performance. e.g. given
a set on monthly resource demand response performance evaluations, the resource
may be rated with excellent, average, or poor performance for the sample set.
attributes:
effectiveEndTime:
slot_uri: cim:ResourcePerformanceRating.effectiveEndTime
range: date
required: false
multivalued: false
description: starting date time that the rating is valid for
effectiveStartTime:
slot_uri: cim:ResourcePerformanceRating.effectiveStartTime
range: date
required: false
multivalued: false
description: ending date time that the rating is valid for
ratingDescription:
slot_uri: cim:ResourcePerformanceRating.ratingDescription
range: string
required: false
multivalued: false
description: the resource's demand response rating description
ratingType:
slot_uri: cim:ResourcePerformanceRating.ratingType
range: string
required: true
multivalued: false
description: the type of performance rating, e.g. which market or product
the rating is for
ratingValue:
slot_uri: cim:ResourcePerformanceRating.ratingValue
range: string
required: false
multivalued: false
description: the resource's demand response rating
RegisteredResource:
slot_uri: cim:ResourcePerformanceRating.RegisteredResource
range: RegisteredDistributedResource
required: true
multivalued: false
ResponseMethod:
class_uri: cim:ResponseMethod
is_a: IdentifiedObject
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: Specifies a category of energy usage that the demand response applies
for; e.g. energy from lighting, HVAC, other.
attributes:
activePower:
slot_uri: cim:ResponseMethod.activePower
range: float
required: false
multivalued: false
description: The active power value for the demand adjustment type. This supports
requests to be made to a resource for some amount of active power provided
by a particular response method, as specified by the method attribute (e.g.
lighting, HVAC, wall mounted air conditioners, etc.).
activePowerUOM:
slot_uri: cim:ResponseMethod.activePowerUOM
range: string
required: false
multivalued: false
description: The unit of measure of active power, e.g. kiloWatts (kW), megaWatts
(mW), etc.
method:
slot_uri: cim:ResponseMethod.method
range: string
required: false
multivalued: false
description: The response method (e.g. lighting, HVAC, wall mounted air conditioners,
etc.).
siteMultiplier:
slot_uri: cim:ResponseMethod.siteMultiplier
range: integer
required: false
multivalued: false
description: This value provides for scaling of a response method's active
power. For example, a response method of air conditioning could utilize
a small amount of active power from each air conditioning unit (e.g. 0.1
kiloWatt), but the site multiplier could be used to produce a the total
active power adjustment by multiplying the response method active power
by this value (e.g. a building with 100 window air conditioning units,
so 100 * 0.1 kW = 10 kW).
RegisteredResource:
slot_uri: cim:ResponseMethod.RegisteredResource
range: RegisteredDistributedResource
required: true
multivalued: false
MktConductingEquipment:
class_uri: cim:MktConductingEquipment
is_a: ConductingEquipment
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: Subclass of IEC 61970:Core:ConductingEquipment.
MaxStartUpCostCurve:
class_uri: cim:MaxStartUpCostCurve
is_a: Curve
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.ReferenceData
description: "The maximum Startup costs and time as a function of down time. \
\ Relationship between unit startup cost (Y1-axis) vs. unit elapsed down time\
\ (X-axis). This is used to validate the information provided in the Bid.\r\n"
WheelingReferenceSchedule:
class_uri: cim:WheelingReferenceSchedule
is_a: BidHourlySchedule
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfParticipantInterfaces
description: "A unique identifier of a wheeling transaction. A wheeling transaction\
\ is a balanced Energy exchange among Supply and Demand Resources.\r\n\r\nThis\
\ schedule is assocated with the hourly parameters in a resource bid.\r\n"
attributes:
value:
slot_uri: cim:WheelingReferenceSchedule.value
range: string
required: false
multivalued: false
IntSchedAgreement:
class_uri: cim:IntSchedAgreement
is_a: Agreement
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfFinancial
description: "A type of agreement that provides the default method by which interchange\
\ schedules are to be integrated to obtain hourly MWh schedules for accounting.\
\ \r\n"
attributes:
defaultIntegrationMethod:
slot_uri: cim:IntSchedAgreement.defaultIntegrationMethod
range: string
required: false
multivalued: false
description: "The default method by which interchange schedules are to be\
\ integrated to obtain hourly MWh schedules for accounting. Method #1 is\
\ to integrate the instantaneous schedule between the hourly boundaries.\
\ Method #2 compensates for any up/down ramping that occurs across the hourly\
\ boundary (this is called block accounting).\r\n"
OpenAccessProduct:
class_uri: cim:OpenAccessProduct
is_a: Agreement
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfFinancial
description: "Contracts for services offered commercially.\r\n"
BidTimeSeries:
class_uri: cim:BidTimeSeries
is_a: TimeSeries
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketManagement
description: The formal specification of specific characteristics related to a
bid.
attributes:
blockBid:
slot_uri: cim:BidTimeSeries.blockBid
range: string
required: false
multivalued: false
description: Indication that the values in the period are considered as a
whole. They cannot be changed or subdivided.
direction:
slot_uri: cim:BidTimeSeries.direction
range: string
required: false
multivalued: false
description: "The coded identification of the energy flow.\r\n"
divisible:
slot_uri: cim:BidTimeSeries.divisible
range: string
required: false
multivalued: false
description: An indication whether or not each element of the bid may be partially
accepted or not.
exclusiveBidsIdentification:
slot_uri: cim:BidTimeSeries.exclusiveBidsIdentification
range: string
required: false
multivalued: false
description: "Unique identification associated with all linked tenders.\r\n\
The identification of a set of tenders that are linked together signifying\
\ that only one can be accepted. \r\nThis identification is defined by the\
\ tenderer and must be unique for a given auction."
linkedBidsIdentification:
slot_uri: cim:BidTimeSeries.linkedBidsIdentification
range: string
required: false
multivalued: false
description: "Unique identification associated with all linked bids.\r\n"
minimumActivationQuantity:
slot_uri: cim:BidTimeSeries.minimumActivationQuantity
range: double
required: false
multivalued: false
description: "The minimum quantity of energy that can be activated at a given\
\ time interval.\r\n"
priority:
slot_uri: cim:BidTimeSeries.priority
range: integer
required: false
multivalued: false
description: The numeric local priority given to a bid. Lower numeric values
will have higher priority.
status:
slot_uri: cim:BidTimeSeries.status
range: string
required: false
multivalued: false
description: The information about the status of the bid, such as "shared",
"restricted", ...
stepIncrementQuantity:
slot_uri: cim:BidTimeSeries.stepIncrementQuantity
range: double
required: false
multivalued: false
description: "The minimum increment that can be applied for an increase in\
\ an activation request.\r\n"
Series:
class_uri: cim:Series
is_a: TimeSeries
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketManagement
description: A set of similar physical or conceptual objects defined for the same
period or point of time.
attributes:
lastUpdateDate:
slot_uri: cim:Series.lastUpdateDate
range: date
required: false
multivalued: false
description: The date of the last update related to this market object.
methodType:
slot_uri: cim:Series.methodType
range: string
required: false
multivalued: false
description: Type of method used in the business process related to this Series,
e.g. metering method.
registrationDate:
slot_uri: cim:Series.registrationDate
range: date
required: false
multivalued: false
description: For a market object, the date of registration of a contract,
e.g. the date of change of supplier for a customer.
SelfSeries:
slot_uri: cim:Series.SelfSeries
range: Series
required: false
multivalued: true
Series:
slot_uri: cim:Series.Series
range: Series
required: false
multivalued: true
MarketAgreement:
class_uri: cim:MarketAgreement
is_a: MarketDocument
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketManagement
description: "An identification or eventually the contents of an agreement between\
\ two or more parties.\r\n"
PackageDependenciesCIMVersion:
class_uri: cim:PackageDependenciesCIMVersion
from_schema: https://cim.ucaiug.io/ns#TC57CIM.PackageDependencies
description: "The version of dependencies description among top level subpackages\
\ of the combined CIM model. This is not the same as the combined packages\
\ version.\r\n"
attributes:
date:
slot_uri: cim:PackageDependenciesCIMVersion.date
range: date
required: false
multivalued: false
description: Date of last change to the main package dependencies in format
YYYY-MM-DD. This is updated when the version attribute is updated.
version:
slot_uri: cim:PackageDependenciesCIMVersion.version
range: string
required: false
multivalued: false
description: The version of the main subpackages of the combined CIM model. The
format is simply an integer. The version (and date) initial values should
be updated any time the dependencies in the model change and require an
actual change to the diagrams within this package.
enums:
UnitMultiplier:
enum_uri: cim:UnitMultiplier
description: "The unit multipliers defined for the CIM. When applied to unit\
\ symbols, the unit symbol is treated as a derived unit. Regardless of the contents\
\ of the unit symbol text, the unit symbol shall be treated as if it were a\
\ single-character unit symbol. Unit symbols should not contain multipliers,\
\ and it should be left to the multiplier to define the multiple for an entire\
\ data type. \r\n\r\nFor example, if a unit symbol is \"m2Pers\" and the multiplier\
\ is \"k\", then the value is k(m**2/s), and the multiplier applies to the entire\
\ final value, not to any individual part of the value. This can be conceptualized\
\ by substituting a derived unit symbol for the unit type. If one imagines that\
\ the symbol \"\xDE\" represents the derived unit \"m2Pers\", then applying\
\ the multiplier \"k\" can be conceptualized simply as \"k\xDE\".\r\n\r\nFor\
\ example, the SI unit for mass is \"kg\" and not \"g\". If the unit symbol\
\ is defined as \"kg\", then the multiplier is applied to \"kg\" as a whole\
\ and does not replace the \"k\" in front of the \"g\". In this case, the multiplier\
\ of \"m\" would be used with the unit symbol of \"kg\" to represent one gram.\
\ As a text string, this violates the instructions in IEC 80000-1. However,\
\ because the unit symbol in CIM is treated as a derived unit instead of as\
\ an SI unit, it makes more sense to conceptualize the \"kg\" as if it were\
\ replaced by one of the proposed replacements for the SI mass symbol. If one\
\ imagines that the \"kg\" were replaced by a symbol \"\xDE\", then it is easier\
\ to conceptualize the multiplier \"m\" as creating the proper unit \"m\xDE\"\
, and not the forbidden unit \"mkg\"."
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
permissible_values:
a:
meaning: cim:UnitMultiplier.a
c:
meaning: cim:UnitMultiplier.c
d:
meaning: cim:UnitMultiplier.d
da:
meaning: cim:UnitMultiplier.da
E:
meaning: cim:UnitMultiplier.E
f:
meaning: cim:UnitMultiplier.f
G:
meaning: cim:UnitMultiplier.G
h:
meaning: cim:UnitMultiplier.h
k:
meaning: cim:UnitMultiplier.k
m:
meaning: cim:UnitMultiplier.m
M:
meaning: cim:UnitMultiplier.M
micro:
meaning: cim:UnitMultiplier.micro
n:
meaning: cim:UnitMultiplier.n
none:
meaning: cim:UnitMultiplier.none
p:
meaning: cim:UnitMultiplier.p
P:
meaning: cim:UnitMultiplier.P
T:
meaning: cim:UnitMultiplier.T
y:
meaning: cim:UnitMultiplier.y
Y:
meaning: cim:UnitMultiplier.Y
z:
meaning: cim:UnitMultiplier.z
Z:
meaning: cim:UnitMultiplier.Z
UnitSymbol:
enum_uri: cim:UnitSymbol
description: "The derived units defined for usage in the CIM. In some cases, the\
\ derived unit is equal to an SI unit. Whenever possible, the standard derived\
\ symbol is used instead of the formula for the derived unit. For example, the\
\ unit symbol Farad is defined as \"F\" instead of \"CPerV\". In cases where\
\ a standard symbol does not exist for a derived unit, the formula for the unit\
\ is used as the unit symbol. For example, density does not have a standard\
\ symbol and so it is represented as \"kgPerm3\". With the exception of the\
\ \"kg\", which is an SI unit, the unit symbols do not contain multipliers and\
\ therefore represent the base derived unit to which a multiplier can be applied\
\ as a whole. \r\nEvery unit symbol is treated as an unparseable text as if\
\ it were a single-letter symbol. The meaning of each unit symbol is defined\
\ by the accompanying descriptive text and not by the text contents of the unit\
\ symbol.\r\nTo allow the widest possible range of serializations without requiring\
\ special character handling, several substitutions are made which deviate from\
\ the format described in IEC 80000-1. The division symbol \"/\" is replaced\
\ by the letters \"Per\". Exponents are written in plain text after the unit\
\ as \"m3\" instead of being formatted as \"m\" with a superscript of 3 or\
\ introducing a symbol as in \"m^3\". The degree symbol \"\xB0\" is replaced\
\ with the letters \"deg\". Any clarification of the meaning for a substitution\
\ is included in the description for the unit symbol.\r\nNon-SI units are included\
\ in list of unit symbols to allow sources of data to be correctly labelled\
\ with their non-SI units (for example, a GPS sensor that is reporting numbers\
\ that represent feet instead of meters). This allows software to use the unit\
\ symbol information correctly convert and scale the raw data of those sources\
\ into SI-based units. \r\nThe integer values are used for harmonization with\
\ IEC 61850."
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
permissible_values:
A:
meaning: cim:UnitSymbol.A
A2:
meaning: cim:UnitSymbol.A2
A2h:
meaning: cim:UnitSymbol.A2h
A2s:
meaning: cim:UnitSymbol.A2s
Ah:
meaning: cim:UnitSymbol.Ah
anglemin:
meaning: cim:UnitSymbol.anglemin
anglesec:
meaning: cim:UnitSymbol.anglesec
APerA:
meaning: cim:UnitSymbol.APerA
APerm:
meaning: cim:UnitSymbol.APerm
As:
meaning: cim:UnitSymbol.As
bar:
meaning: cim:UnitSymbol.bar
Bq:
meaning: cim:UnitSymbol.Bq
Btu:
meaning: cim:UnitSymbol.Btu
C:
meaning: cim:UnitSymbol.C
cd:
meaning: cim:UnitSymbol.cd
character:
meaning: cim:UnitSymbol.character
charPers:
meaning: cim:UnitSymbol.charPers
cosPhi:
meaning: cim:UnitSymbol.cosPhi
count:
meaning: cim:UnitSymbol.count
CPerkg:
meaning: cim:UnitSymbol.CPerkg
CPerm2:
meaning: cim:UnitSymbol.CPerm2
CPerm3:
meaning: cim:UnitSymbol.CPerm3
d:
meaning: cim:UnitSymbol.d
dB:
meaning: cim:UnitSymbol.dB
dBm:
meaning: cim:UnitSymbol.dBm
deg:
meaning: cim:UnitSymbol.deg
degC:
meaning: cim:UnitSymbol.degC
F:
meaning: cim:UnitSymbol.F
FPerm:
meaning: cim:UnitSymbol.FPerm
ft3:
meaning: cim:UnitSymbol.ft3
G:
meaning: cim:UnitSymbol.G
gal:
meaning: cim:UnitSymbol.gal
gPerg:
meaning: cim:UnitSymbol.gPerg
Gy:
meaning: cim:UnitSymbol.Gy
GyPers:
meaning: cim:UnitSymbol.GyPers
H:
meaning: cim:UnitSymbol.H
h:
meaning: cim:UnitSymbol.h
ha:
meaning: cim:UnitSymbol.ha
HPerm:
meaning: cim:UnitSymbol.HPerm
Hz:
meaning: cim:UnitSymbol.Hz
HzPerHz:
meaning: cim:UnitSymbol.HzPerHz
HzPers:
meaning: cim:UnitSymbol.HzPers
J:
meaning: cim:UnitSymbol.J
JPerK:
meaning: cim:UnitSymbol.JPerK
JPerkg:
meaning: cim:UnitSymbol.JPerkg
JPerkgK:
meaning: cim:UnitSymbol.JPerkgK
JPerm2:
meaning: cim:UnitSymbol.JPerm2
JPerm3:
meaning: cim:UnitSymbol.JPerm3
JPermol:
meaning: cim:UnitSymbol.JPermol
JPermolK:
meaning: cim:UnitSymbol.JPermolK
JPers:
meaning: cim:UnitSymbol.JPers
K:
meaning: cim:UnitSymbol.K
kat:
meaning: cim:UnitSymbol.kat
katPerm3:
meaning: cim:UnitSymbol.katPerm3
kg:
meaning: cim:UnitSymbol.kg
kgm:
meaning: cim:UnitSymbol.kgm
kgm2:
meaning: cim:UnitSymbol.kgm2
kgPerJ:
meaning: cim:UnitSymbol.kgPerJ
kgPerm3:
meaning: cim:UnitSymbol.kgPerm3
kn:
meaning: cim:UnitSymbol.kn
KPers:
meaning: cim:UnitSymbol.KPers
l:
meaning: cim:UnitSymbol.l
lm:
meaning: cim:UnitSymbol.lm
lPerh:
meaning: cim:UnitSymbol.lPerh
lPerl:
meaning: cim:UnitSymbol.lPerl
lPers:
meaning: cim:UnitSymbol.lPers
lx:
meaning: cim:UnitSymbol.lx
m:
meaning: cim:UnitSymbol.m
M:
meaning: cim:UnitSymbol.M
m2:
meaning: cim:UnitSymbol.m2
m2Pers:
meaning: cim:UnitSymbol.m2Pers
m3:
meaning: cim:UnitSymbol.m3
m3Compensated:
meaning: cim:UnitSymbol.m3Compensated
m3Perh:
meaning: cim:UnitSymbol.m3Perh
m3Perkg:
meaning: cim:UnitSymbol.m3Perkg
m3Pers:
meaning: cim:UnitSymbol.m3Pers
m3Uncompensated:
meaning: cim:UnitSymbol.m3Uncompensated
min:
meaning: cim:UnitSymbol.min
mmHg:
meaning: cim:UnitSymbol.mmHg
mol:
meaning: cim:UnitSymbol.mol
molPerkg:
meaning: cim:UnitSymbol.molPerkg
molPerm3:
meaning: cim:UnitSymbol.molPerm3
molPermol:
meaning: cim:UnitSymbol.molPermol
mPerm3:
meaning: cim:UnitSymbol.mPerm3
mPers:
meaning: cim:UnitSymbol.mPers
mPers2:
meaning: cim:UnitSymbol.mPers2
Mx:
meaning: cim:UnitSymbol.Mx
N:
meaning: cim:UnitSymbol.N
Nm:
meaning: cim:UnitSymbol.Nm
none:
meaning: cim:UnitSymbol.none
NPerm:
meaning: cim:UnitSymbol.NPerm
Oe:
meaning: cim:UnitSymbol.Oe
ohm:
meaning: cim:UnitSymbol.ohm
ohmm:
meaning: cim:UnitSymbol.ohmm
ohmPerm:
meaning: cim:UnitSymbol.ohmPerm
onePerHz:
meaning: cim:UnitSymbol.onePerHz
onePerm:
meaning: cim:UnitSymbol.onePerm
Pa:
meaning: cim:UnitSymbol.Pa
PaPers:
meaning: cim:UnitSymbol.PaPers
Pas:
meaning: cim:UnitSymbol.Pas
ppm:
meaning: cim:UnitSymbol.ppm
Q:
meaning: cim:UnitSymbol.Q
Qh:
meaning: cim:UnitSymbol.Qh
rad:
meaning: cim:UnitSymbol.rad
radPers:
meaning: cim:UnitSymbol.radPers
radPers2:
meaning: cim:UnitSymbol.radPers2
rev:
meaning: cim:UnitSymbol.rev
rotPers:
meaning: cim:UnitSymbol.rotPers
s:
meaning: cim:UnitSymbol.s
S:
meaning: cim:UnitSymbol.S
SPerm:
meaning: cim:UnitSymbol.SPerm
sPers:
meaning: cim:UnitSymbol.sPers
sr:
meaning: cim:UnitSymbol.sr
Sv:
meaning: cim:UnitSymbol.Sv
T:
meaning: cim:UnitSymbol.T
therm:
meaning: cim:UnitSymbol.therm
tonne:
meaning: cim:UnitSymbol.tonne
V:
meaning: cim:UnitSymbol.V
V2:
meaning: cim:UnitSymbol.V2
V2h:
meaning: cim:UnitSymbol.V2h
VA:
meaning: cim:UnitSymbol.VA
VAh:
meaning: cim:UnitSymbol.VAh
VAr:
meaning: cim:UnitSymbol.VAr
VArh:
meaning: cim:UnitSymbol.VArh
Vh:
meaning: cim:UnitSymbol.Vh
VPerHz:
meaning: cim:UnitSymbol.VPerHz
VPerm:
meaning: cim:UnitSymbol.VPerm
VPerV:
meaning: cim:UnitSymbol.VPerV
VPerVA:
meaning: cim:UnitSymbol.VPerVA
VPerVAr:
meaning: cim:UnitSymbol.VPerVAr
Vs:
meaning: cim:UnitSymbol.Vs
W:
meaning: cim:UnitSymbol.W
Wb:
meaning: cim:UnitSymbol.Wb
Wh:
meaning: cim:UnitSymbol.Wh
WPerA:
meaning: cim:UnitSymbol.WPerA
WPerm2:
meaning: cim:UnitSymbol.WPerm2
WPerm2sr:
meaning: cim:UnitSymbol.WPerm2sr
WPermK:
meaning: cim:UnitSymbol.WPermK
WPers:
meaning: cim:UnitSymbol.WPers
WPersr:
meaning: cim:UnitSymbol.WPersr
WPerW:
meaning: cim:UnitSymbol.WPerW
Currency:
enum_uri: cim:Currency
description: Monetary currencies. ISO 4217 standard including 3-character currency
code.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
permissible_values:
AED:
meaning: cim:Currency.AED
AFN:
meaning: cim:Currency.AFN
ALL:
meaning: cim:Currency.ALL
AMD:
meaning: cim:Currency.AMD
ANG:
meaning: cim:Currency.ANG
AOA:
meaning: cim:Currency.AOA
ARS:
meaning: cim:Currency.ARS
AUD:
meaning: cim:Currency.AUD
AWG:
meaning: cim:Currency.AWG
AZN:
meaning: cim:Currency.AZN
BAM:
meaning: cim:Currency.BAM
BBD:
meaning: cim:Currency.BBD
BDT:
meaning: cim:Currency.BDT
BGN:
meaning: cim:Currency.BGN
BHD:
meaning: cim:Currency.BHD
BIF:
meaning: cim:Currency.BIF
BMD:
meaning: cim:Currency.BMD
BND:
meaning: cim:Currency.BND
BOB:
meaning: cim:Currency.BOB
BOV:
meaning: cim:Currency.BOV
BRL:
meaning: cim:Currency.BRL
BSD:
meaning: cim:Currency.BSD
BTN:
meaning: cim:Currency.BTN
BWP:
meaning: cim:Currency.BWP
BYR:
meaning: cim:Currency.BYR
BZD:
meaning: cim:Currency.BZD
CAD:
meaning: cim:Currency.CAD
CDF:
meaning: cim:Currency.CDF
CHF:
meaning: cim:Currency.CHF
CLF:
meaning: cim:Currency.CLF
CLP:
meaning: cim:Currency.CLP
CNY:
meaning: cim:Currency.CNY
COP:
meaning: cim:Currency.COP
COU:
meaning: cim:Currency.COU
CRC:
meaning: cim:Currency.CRC
CUC:
meaning: cim:Currency.CUC
CUP:
meaning: cim:Currency.CUP
CVE:
meaning: cim:Currency.CVE
CZK:
meaning: cim:Currency.CZK
DJF:
meaning: cim:Currency.DJF
DKK:
meaning: cim:Currency.DKK
DOP:
meaning: cim:Currency.DOP
DZD:
meaning: cim:Currency.DZD
EEK:
meaning: cim:Currency.EEK
EGP:
meaning: cim:Currency.EGP
ERN:
meaning: cim:Currency.ERN
ETB:
meaning: cim:Currency.ETB
EUR:
meaning: cim:Currency.EUR
FJD:
meaning: cim:Currency.FJD
FKP:
meaning: cim:Currency.FKP
GBP:
meaning: cim:Currency.GBP
GEL:
meaning: cim:Currency.GEL
GHS:
meaning: cim:Currency.GHS
GIP:
meaning: cim:Currency.GIP
GMD:
meaning: cim:Currency.GMD
GNF:
meaning: cim:Currency.GNF
GTQ:
meaning: cim:Currency.GTQ
GYD:
meaning: cim:Currency.GYD
HKD:
meaning: cim:Currency.HKD
HNL:
meaning: cim:Currency.HNL
HRK:
meaning: cim:Currency.HRK
HTG:
meaning: cim:Currency.HTG
HUF:
meaning: cim:Currency.HUF
IDR:
meaning: cim:Currency.IDR
ILS:
meaning: cim:Currency.ILS
INR:
meaning: cim:Currency.INR
IQD:
meaning: cim:Currency.IQD
IRR:
meaning: cim:Currency.IRR
ISK:
meaning: cim:Currency.ISK
JMD:
meaning: cim:Currency.JMD
JOD:
meaning: cim:Currency.JOD
JPY:
meaning: cim:Currency.JPY
KES:
meaning: cim:Currency.KES
KGS:
meaning: cim:Currency.KGS
KHR:
meaning: cim:Currency.KHR
KMF:
meaning: cim:Currency.KMF
KPW:
meaning: cim:Currency.KPW
KRW:
meaning: cim:Currency.KRW
KWD:
meaning: cim:Currency.KWD
KYD:
meaning: cim:Currency.KYD
KZT:
meaning: cim:Currency.KZT
LAK:
meaning: cim:Currency.LAK
LBP:
meaning: cim:Currency.LBP
LKR:
meaning: cim:Currency.LKR
LRD:
meaning: cim:Currency.LRD
LSL:
meaning: cim:Currency.LSL
LTL:
meaning: cim:Currency.LTL
LVL:
meaning: cim:Currency.LVL
LYD:
meaning: cim:Currency.LYD
MAD:
meaning: cim:Currency.MAD
MDL:
meaning: cim:Currency.MDL
MGA:
meaning: cim:Currency.MGA
MKD:
meaning: cim:Currency.MKD
MMK:
meaning: cim:Currency.MMK
MNT:
meaning: cim:Currency.MNT
MOP:
meaning: cim:Currency.MOP
MRO:
meaning: cim:Currency.MRO
MUR:
meaning: cim:Currency.MUR
MVR:
meaning: cim:Currency.MVR
MWK:
meaning: cim:Currency.MWK
MXN:
meaning: cim:Currency.MXN
MYR:
meaning: cim:Currency.MYR
MZN:
meaning: cim:Currency.MZN
NAD:
meaning: cim:Currency.NAD
NGN:
meaning: cim:Currency.NGN
NIO:
meaning: cim:Currency.NIO
NOK:
meaning: cim:Currency.NOK
NPR:
meaning: cim:Currency.NPR
NZD:
meaning: cim:Currency.NZD
OMR:
meaning: cim:Currency.OMR
PAB:
meaning: cim:Currency.PAB
PEN:
meaning: cim:Currency.PEN
PGK:
meaning: cim:Currency.PGK
PHP:
meaning: cim:Currency.PHP
PKR:
meaning: cim:Currency.PKR
PLN:
meaning: cim:Currency.PLN
PYG:
meaning: cim:Currency.PYG
QAR:
meaning: cim:Currency.QAR
RON:
meaning: cim:Currency.RON
RSD:
meaning: cim:Currency.RSD
RUB:
meaning: cim:Currency.RUB
RWF:
meaning: cim:Currency.RWF
SAR:
meaning: cim:Currency.SAR
SBD:
meaning: cim:Currency.SBD
SCR:
meaning: cim:Currency.SCR
SDG:
meaning: cim:Currency.SDG
SEK:
meaning: cim:Currency.SEK
SGD:
meaning: cim:Currency.SGD
SHP:
meaning: cim:Currency.SHP
SLL:
meaning: cim:Currency.SLL
SOS:
meaning: cim:Currency.SOS
SRD:
meaning: cim:Currency.SRD
STD:
meaning: cim:Currency.STD
SYP:
meaning: cim:Currency.SYP
SZL:
meaning: cim:Currency.SZL
THB:
meaning: cim:Currency.THB
TJS:
meaning: cim:Currency.TJS
TMT:
meaning: cim:Currency.TMT
TND:
meaning: cim:Currency.TND
TOP:
meaning: cim:Currency.TOP
TRY:
meaning: cim:Currency.TRY
TTD:
meaning: cim:Currency.TTD
TWD:
meaning: cim:Currency.TWD
TZS:
meaning: cim:Currency.TZS
UAH:
meaning: cim:Currency.UAH
UGX:
meaning: cim:Currency.UGX
USD:
meaning: cim:Currency.USD
UYU:
meaning: cim:Currency.UYU
UZS:
meaning: cim:Currency.UZS
VEF:
meaning: cim:Currency.VEF
VND:
meaning: cim:Currency.VND
VUV:
meaning: cim:Currency.VUV
WST:
meaning: cim:Currency.WST
XAF:
meaning: cim:Currency.XAF
XCD:
meaning: cim:Currency.XCD
XOF:
meaning: cim:Currency.XOF
XPF:
meaning: cim:Currency.XPF
YER:
meaning: cim:Currency.YER
ZAR:
meaning: cim:Currency.ZAR
ZMK:
meaning: cim:Currency.ZMK
ZWL:
meaning: cim:Currency.ZWL
DependencyKind:
enum_uri: cim:DependencyKind
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfPart303.NetworkModelProjects
permissible_values:
mutuallyExclusive:
meaning: cim:DependencyKind.mutuallyExclusive
required:
meaning: cim:DependencyKind.required
OrientationKind:
enum_uri: cim:OrientationKind
description: "The orientation of the coordinate system with respect to top, left,\
\ and the coordinate number system.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.DiagramLayout
permissible_values:
negative:
meaning: cim:OrientationKind.negative
positive:
meaning: cim:OrientationKind.positive
ContingencyEquipmentStatusKind:
enum_uri: cim:ContingencyEquipmentStatusKind
description: Indicates the state which the contingency equipment is to be in when
the contingency is applied.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Contingency
permissible_values:
inService:
meaning: cim:ContingencyEquipmentStatusKind.inService
outOfService:
meaning: cim:ContingencyEquipmentStatusKind.outOfService
SinglePhaseKind:
enum_uri: cim:SinglePhaseKind
description: "Enumeration of single phase identifiers. Allows designation of single\
\ phases for both transmission and distribution equipment, circuits and loads.\r\
\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
permissible_values:
A:
meaning: cim:SinglePhaseKind.A
B:
meaning: cim:SinglePhaseKind.B
C:
meaning: cim:SinglePhaseKind.C
N:
meaning: cim:SinglePhaseKind.N
s1:
meaning: cim:SinglePhaseKind.s1
s2:
meaning: cim:SinglePhaseKind.s2
PhaseCode:
enum_uri: cim:PhaseCode
description: "An unordered enumeration of phase identifiers. Allows designation\
\ of phases for both transmission and distribution equipment, circuits and loads.\
\ The enumeration, by itself, does not describe how the phases are connected\
\ together or connected to ground. Ground is not explicitly denoted as a phase.\r\
\nResidential and small commercial loads are often served from single-phase,\
\ or split-phase, secondary circuits. For the example of s12N, phases 1 and\
\ 2 refer to hot wires that are 180 degrees out of phase, while N refers to\
\ the neutral wire. Through single-phase transformer connections, these secondary\
\ circuits may be served from one or two of the primary phases A, B, and C.\
\ For three-phase loads, use the A, B, C phase codes instead of s12N.\r\nThe\
\ integer values are from IEC 61968-9 to support revenue metering applications."
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Core
permissible_values:
A:
meaning: cim:PhaseCode.A
AB:
meaning: cim:PhaseCode.AB
ABC:
meaning: cim:PhaseCode.ABC
ABCN:
meaning: cim:PhaseCode.ABCN
ABN:
meaning: cim:PhaseCode.ABN
AC:
meaning: cim:PhaseCode.AC
ACN:
meaning: cim:PhaseCode.ACN
AN:
meaning: cim:PhaseCode.AN
B:
meaning: cim:PhaseCode.B
BC:
meaning: cim:PhaseCode.BC
BCN:
meaning: cim:PhaseCode.BCN
BN:
meaning: cim:PhaseCode.BN
C:
meaning: cim:PhaseCode.C
CN:
meaning: cim:PhaseCode.CN
N:
meaning: cim:PhaseCode.N
none:
meaning: cim:PhaseCode.none
s1:
meaning: cim:PhaseCode.s1
s12:
meaning: cim:PhaseCode.s12
s12N:
meaning: cim:PhaseCode.s12N
s1N:
meaning: cim:PhaseCode.s1N
s2:
meaning: cim:PhaseCode.s2
s2N:
meaning: cim:PhaseCode.s2N
X:
meaning: cim:PhaseCode.X
XN:
meaning: cim:PhaseCode.XN
XY:
meaning: cim:PhaseCode.XY
XYN:
meaning: cim:PhaseCode.XYN
InUseStateKind:
enum_uri: cim:InUseStateKind
description: Possible 'in use' states that an asset can be in.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
permissible_values:
inUse:
meaning: cim:InUseStateKind.inUse
notReadyForUse:
meaning: cim:InUseStateKind.notReadyForUse
readyForUse:
meaning: cim:InUseStateKind.readyForUse
AssetKind:
enum_uri: cim:AssetKind
description: Kinds of assets or asset components.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
permissible_values:
breakerAirBlastBreaker:
meaning: cim:AssetKind.breakerAirBlastBreaker
breakerBulkOilBreaker:
meaning: cim:AssetKind.breakerBulkOilBreaker
breakerInsulatingStackAssembly:
meaning: cim:AssetKind.breakerInsulatingStackAssembly
breakerMinimumOilBreaker:
meaning: cim:AssetKind.breakerMinimumOilBreaker
breakerSF6DeadTankBreaker:
meaning: cim:AssetKind.breakerSF6DeadTankBreaker
breakerSF6LiveTankBreaker:
meaning: cim:AssetKind.breakerSF6LiveTankBreaker
breakerTankAssembly:
meaning: cim:AssetKind.breakerTankAssembly
other:
meaning: cim:AssetKind.other
transformer:
meaning: cim:AssetKind.transformer
transformerTank:
meaning: cim:AssetKind.transformerTank
AssetLifecycleStateKind:
enum_uri: cim:AssetLifecycleStateKind
description: "Lifecycle states an asset can be in.\r\nWhile the possible lifecycle\
\ states are standardized, the allowed transitions are not - they are intended\
\ to be defined by the business process requirements of local implementations."
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
permissible_values:
disposedOf:
meaning: cim:AssetLifecycleStateKind.disposedOf
manufactured:
meaning: cim:AssetLifecycleStateKind.manufactured
purchased:
meaning: cim:AssetLifecycleStateKind.purchased
received:
meaning: cim:AssetLifecycleStateKind.received
retired:
meaning: cim:AssetLifecycleStateKind.retired
RetiredReasonKind:
enum_uri: cim:RetiredReasonKind
description: Reason asset retired.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
permissible_values:
environmental:
meaning: cim:RetiredReasonKind.environmental
excessiveMaintenance:
meaning: cim:RetiredReasonKind.excessiveMaintenance
facilitiesUpgrade:
meaning: cim:RetiredReasonKind.facilitiesUpgrade
failed:
meaning: cim:RetiredReasonKind.failed
obsolescence:
meaning: cim:RetiredReasonKind.obsolescence
other:
meaning: cim:RetiredReasonKind.other
sold:
meaning: cim:RetiredReasonKind.sold
ServiceRequestKind:
enum_uri: cim:ServiceRequestKind
description: Kinds of service requests
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Customers
permissible_values:
connect:
meaning: cim:ServiceRequestKind.connect
construction:
meaning: cim:ServiceRequestKind.construction
disconnect:
meaning: cim:ServiceRequestKind.disconnect
inspection:
meaning: cim:ServiceRequestKind.inspection
newservice:
meaning: cim:ServiceRequestKind.newservice
other:
meaning: cim:ServiceRequestKind.other
reconnect:
meaning: cim:ServiceRequestKind.reconnect
repair:
meaning: cim:ServiceRequestKind.repair
replace:
meaning: cim:ServiceRequestKind.replace
test:
meaning: cim:ServiceRequestKind.test
turn-off:
meaning: cim:ServiceRequestKind.turn-off
turn-on:
meaning: cim:ServiceRequestKind.turn-on
WorkStatusKind:
enum_uri: cim:WorkStatusKind
description: Kind of status, specific to work.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Work
permissible_values:
approved:
meaning: cim:WorkStatusKind.approved
cancelled:
meaning: cim:WorkStatusKind.cancelled
closed:
meaning: cim:WorkStatusKind.closed
completed:
meaning: cim:WorkStatusKind.completed
dispatched:
meaning: cim:WorkStatusKind.dispatched
enroute:
meaning: cim:WorkStatusKind.enroute
inProgress:
meaning: cim:WorkStatusKind.inProgress
onSite:
meaning: cim:WorkStatusKind.onSite
scheduled:
meaning: cim:WorkStatusKind.scheduled
waitingOnApproval:
meaning: cim:WorkStatusKind.waitingOnApproval
waitingOnMaterial:
meaning: cim:WorkStatusKind.waitingOnMaterial
waitingToBeScheduled:
meaning: cim:WorkStatusKind.waitingToBeScheduled
AmiBillingReadyKind:
enum_uri: cim:AmiBillingReadyKind
description: "Lifecycle states of the metering installation at a usage point with\
\ respect to readiness for billing via advanced metering infrastructure reads.\r\
\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
permissible_values:
amiCapable:
meaning: cim:AmiBillingReadyKind.amiCapable
amiDisabled:
meaning: cim:AmiBillingReadyKind.amiDisabled
billingApproved:
meaning: cim:AmiBillingReadyKind.billingApproved
enabled:
meaning: cim:AmiBillingReadyKind.enabled
nonAmi:
meaning: cim:AmiBillingReadyKind.nonAmi
nonMetered:
meaning: cim:AmiBillingReadyKind.nonMetered
operable:
meaning: cim:AmiBillingReadyKind.operable
UsagePointConnectedKind:
enum_uri: cim:UsagePointConnectedKind
description: "State of the usage point with respect to connection to the network.\r\
\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
permissible_values:
connected:
meaning: cim:UsagePointConnectedKind.connected
logicallyDisconnected:
meaning: cim:UsagePointConnectedKind.logicallyDisconnected
physicallyDisconnected:
meaning: cim:UsagePointConnectedKind.physicallyDisconnected
CustomerBillingKind:
enum_uri: cim:CustomerBillingKind
description: Kind of customer billing.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfCustomers
permissible_values:
consolidatedEss:
meaning: cim:CustomerBillingKind.consolidatedEss
consolidatedUdc:
meaning: cim:CustomerBillingKind.consolidatedUdc
other:
meaning: cim:CustomerBillingKind.other
separateEssUdc:
meaning: cim:CustomerBillingKind.separateEssUdc
ErpInvoiceLineItemKind:
enum_uri: cim:ErpInvoiceLineItemKind
description: Kind of invoice line item.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfERPSupport
permissible_values:
initial:
meaning: cim:ErpInvoiceLineItemKind.initial
other:
meaning: cim:ErpInvoiceLineItemKind.other
recalculation:
meaning: cim:ErpInvoiceLineItemKind.recalculation
CorporateStandardKind:
enum_uri: cim:CorporateStandardKind
description: Kind of corporate standard.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
permissible_values:
experimental:
meaning: cim:CorporateStandardKind.experimental
other:
meaning: cim:CorporateStandardKind.other
standard:
meaning: cim:CorporateStandardKind.standard
underEvaluation:
meaning: cim:CorporateStandardKind.underEvaluation
AssetModelUsageKind:
enum_uri: cim:AssetModelUsageKind
description: Usage for an asset model.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
permissible_values:
customerSubstation:
meaning: cim:AssetModelUsageKind.customerSubstation
distributionOverhead:
meaning: cim:AssetModelUsageKind.distributionOverhead
distributionUnderground:
meaning: cim:AssetModelUsageKind.distributionUnderground
other:
meaning: cim:AssetModelUsageKind.other
streetlight:
meaning: cim:AssetModelUsageKind.streetlight
substation:
meaning: cim:AssetModelUsageKind.substation
transmission:
meaning: cim:AssetModelUsageKind.transmission
unknown:
meaning: cim:AssetModelUsageKind.unknown
SkillLevelKind:
enum_uri: cim:SkillLevelKind
description: Kind of skill level.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfCommon
permissible_values:
apprentice:
meaning: cim:SkillLevelKind.apprentice
master:
meaning: cim:SkillLevelKind.master
other:
meaning: cim:SkillLevelKind.other
standard:
meaning: cim:SkillLevelKind.standard
DesignKind:
enum_uri: cim:DesignKind
description: Kind of design.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfWork
permissible_values:
asBuilt:
meaning: cim:DesignKind.asBuilt
estimated:
meaning: cim:DesignKind.estimated
other:
meaning: cim:DesignKind.other
WorkActionKind:
enum_uri: cim:WorkActionKind
description: Kinds of activities to be performed on a Compatible Unit.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfWork
permissible_values:
abandon:
meaning: cim:WorkActionKind.abandon
install:
meaning: cim:WorkActionKind.install
remove:
meaning: cim:WorkActionKind.remove
transfer:
meaning: cim:WorkActionKind.transfer
ConditionFactorKind:
enum_uri: cim:ConditionFactorKind
description: Kind of condition factor.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfWork
permissible_values:
accountAllocation:
meaning: cim:ConditionFactorKind.accountAllocation
labor:
meaning: cim:ConditionFactorKind.labor
material:
meaning: cim:ConditionFactorKind.material
other:
meaning: cim:ConditionFactorKind.other
travel:
meaning: cim:ConditionFactorKind.travel
DemographicKind:
enum_uri: cim:DemographicKind
description: Demographic kind of a land property.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfLocations
permissible_values:
other:
meaning: cim:DemographicKind.other
rural:
meaning: cim:DemographicKind.rural
urban:
meaning: cim:DemographicKind.urban
LandPropertyKind:
enum_uri: cim:LandPropertyKind
description: Kind of (land) property.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfLocations
permissible_values:
building:
meaning: cim:LandPropertyKind.building
customerPremise:
meaning: cim:LandPropertyKind.customerPremise
depot:
meaning: cim:LandPropertyKind.depot
external:
meaning: cim:LandPropertyKind.external
gridSupplyPoint:
meaning: cim:LandPropertyKind.gridSupplyPoint
store:
meaning: cim:LandPropertyKind.store
substation:
meaning: cim:LandPropertyKind.substation
SealConditionKind:
enum_uri: cim:SealConditionKind
description: Kind of seal condition.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
permissible_values:
broken:
meaning: cim:SealConditionKind.broken
locked:
meaning: cim:SealConditionKind.locked
missing:
meaning: cim:SealConditionKind.missing
open:
meaning: cim:SealConditionKind.open
other:
meaning: cim:SealConditionKind.other
SealKind:
enum_uri: cim:SealKind
description: Kind of seal.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
permissible_values:
lead:
meaning: cim:SealKind.lead
lock:
meaning: cim:SealKind.lock
other:
meaning: cim:SealKind.other
steel:
meaning: cim:SealKind.steel
RemoteUnitType:
enum_uri: cim:RemoteUnitType
description: "Type of remote unit.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.SCADA
permissible_values:
ControlCenter:
meaning: cim:RemoteUnitType.ControlCenter
IED:
meaning: cim:RemoteUnitType.IED
RTU:
meaning: cim:RemoteUnitType.RTU
SubstationControlSystem:
meaning: cim:RemoteUnitType.SubstationControlSystem
Source:
enum_uri: cim:Source
description: "Source gives information related to the origin of a value.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.SCADA
permissible_values:
DEFAULTED:
meaning: cim:Source.DEFAULTED
PROCESS:
meaning: cim:Source.PROCESS
SUBSTITUTED:
meaning: cim:Source.SUBSTITUTED
Validity:
enum_uri: cim:Validity
description: "Validity for MeasurementValue.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Meas
permissible_values:
GOOD:
meaning: cim:Validity.GOOD
INVALID:
meaning: cim:Validity.INVALID
QUESTIONABLE:
meaning: cim:Validity.QUESTIONABLE
CalculationModeKind:
enum_uri: cim:CalculationModeKind
description: "The mode of the calculation (total, periodic, sliding).\r\n."
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetMeas
permissible_values:
period:
meaning: cim:CalculationModeKind.period
sliding:
meaning: cim:CalculationModeKind.sliding
total:
meaning: cim:CalculationModeKind.total
CalculationTechniqueKind:
enum_uri: cim:CalculationTechniqueKind
description: "Possible calculation techniques.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetMeas
permissible_values:
average:
meaning: cim:CalculationTechniqueKind.average
maximum:
meaning: cim:CalculationTechniqueKind.maximum
minimum:
meaning: cim:CalculationTechniqueKind.minimum
trueRMS:
meaning: cim:CalculationTechniqueKind.trueRMS
AnalogToDigitalLogicKind:
enum_uri: cim:AnalogToDigitalLogicKind
description: Categories of analog to digital (or logical result) comparison.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfSIPS
permissible_values:
eq:
meaning: cim:AnalogToDigitalLogicKind.eq
ge:
meaning: cim:AnalogToDigitalLogicKind.ge
gt:
meaning: cim:AnalogToDigitalLogicKind.gt
le:
meaning: cim:AnalogToDigitalLogicKind.le
lt:
meaning: cim:AnalogToDigitalLogicKind.lt
ne:
meaning: cim:AnalogToDigitalLogicKind.ne
GateLogicKind:
enum_uri: cim:GateLogicKind
description: Define the different logical operations.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfSIPS
permissible_values:
and:
meaning: cim:GateLogicKind.and
nand:
meaning: cim:GateLogicKind.nand
nor:
meaning: cim:GateLogicKind.nor
not:
meaning: cim:GateLogicKind.not
or:
meaning: cim:GateLogicKind.or
xnor:
meaning: cim:GateLogicKind.xnor
xor:
meaning: cim:GateLogicKind.xor
BreakerConfiguration:
enum_uri: cim:BreakerConfiguration
description: "Switching arrangement for bay. \r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Core
permissible_values:
breakerAndAHalf:
meaning: cim:BreakerConfiguration.breakerAndAHalf
doubleBreaker:
meaning: cim:BreakerConfiguration.doubleBreaker
noBreaker:
meaning: cim:BreakerConfiguration.noBreaker
singleBreaker:
meaning: cim:BreakerConfiguration.singleBreaker
BusbarConfiguration:
enum_uri: cim:BusbarConfiguration
description: "Busbar layout for bay.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Core
permissible_values:
doubleBus:
meaning: cim:BusbarConfiguration.doubleBus
mainWithTransfer:
meaning: cim:BusbarConfiguration.mainWithTransfer
ringBus:
meaning: cim:BusbarConfiguration.ringBus
singleBus:
meaning: cim:BusbarConfiguration.singleBus
DCConverterOperatingModeKind:
enum_uri: cim:DCConverterOperatingModeKind
description: The operating mode of an HVDC bipole.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.DC
permissible_values:
bipolar:
meaning: cim:DCConverterOperatingModeKind.bipolar
monopolarGroundReturn:
meaning: cim:DCConverterOperatingModeKind.monopolarGroundReturn
monopolarMetallicReturn:
meaning: cim:DCConverterOperatingModeKind.monopolarMetallicReturn
BreakerApplicationKind:
enum_uri: cim:BreakerApplicationKind
description: "Classifications of network roles in which breakers can be deployed.\
\ The classifications are intended to reflect both criticality of breaker in\
\ network operations and typical usage experienced by breaker.\r\nNote: This\
\ enumeration provides essential information to asset health analytics. The\
\ existing list is a starting point and is anticipated to be fleshed out further\
\ as requirements are better understood (PAB 2016/01/09)."
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
permissible_values:
busBreaker:
meaning: cim:BreakerApplicationKind.busBreaker
busTieBreaker:
meaning: cim:BreakerApplicationKind.busTieBreaker
capacitorOrReactorBankBreaker:
meaning: cim:BreakerApplicationKind.capacitorOrReactorBankBreaker
feederBreaker:
meaning: cim:BreakerApplicationKind.feederBreaker
other:
meaning: cim:BreakerApplicationKind.other
spare:
meaning: cim:BreakerApplicationKind.spare
stepUpTransformerBreakerFossil:
meaning: cim:BreakerApplicationKind.stepUpTransformerBreakerFossil
stepUpTransformerBreakerHydro:
meaning: cim:BreakerApplicationKind.stepUpTransformerBreakerHydro
stepUpTransformerBreakerNuclear:
meaning: cim:BreakerApplicationKind.stepUpTransformerBreakerNuclear
stepUpTransformerBreakerPumpedStorage:
meaning: cim:BreakerApplicationKind.stepUpTransformerBreakerPumpedStorage
substationTransformerBreaker:
meaning: cim:BreakerApplicationKind.substationTransformerBreaker
transmissionFlowGateLineBreaker:
meaning: cim:BreakerApplicationKind.transmissionFlowGateLineBreaker
transmissionLineBreaker:
meaning: cim:BreakerApplicationKind.transmissionLineBreaker
transmissionTieLineBreaker:
meaning: cim:BreakerApplicationKind.transmissionTieLineBreaker
DeploymentStateKind:
enum_uri: cim:DeploymentStateKind
description: Possible states of asset deployment.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
permissible_values:
inService:
meaning: cim:DeploymentStateKind.inService
installed:
meaning: cim:DeploymentStateKind.installed
notYetInstalled:
meaning: cim:DeploymentStateKind.notYetInstalled
outOfService:
meaning: cim:DeploymentStateKind.outOfService
removed:
meaning: cim:DeploymentStateKind.removed
FacilityKind:
enum_uri: cim:FacilityKind
description: Types of facilities at which an asset can be deployed.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
permissible_values:
distributionPoleTop:
meaning: cim:FacilityKind.distributionPoleTop
substationDistribution:
meaning: cim:FacilityKind.substationDistribution
substationFossilPlant:
meaning: cim:FacilityKind.substationFossilPlant
substationHydroPlant:
meaning: cim:FacilityKind.substationHydroPlant
substationNuclearPlant:
meaning: cim:FacilityKind.substationNuclearPlant
substationSubTransmission:
meaning: cim:FacilityKind.substationSubTransmission
substationTransmission:
meaning: cim:FacilityKind.substationTransmission
TransformerApplicationKind:
enum_uri: cim:TransformerApplicationKind
description: "Classifications of network roles in which transformers can be deployed.\
\ The classifications are intended to reflect both criticality of transformer\
\ in network operations and typical usage experienced by transformer.\r\nNote:\
\ This enumeration provides essential information to asset health analytics.\
\ The existing list is a starting point and is anticipated to be fleshed out\
\ further as requirements are better understood (PAB 2016/01/09)."
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
permissible_values:
distribution:
meaning: cim:TransformerApplicationKind.distribution
generatorStepUp:
meaning: cim:TransformerApplicationKind.generatorStepUp
transmissionBusToBus:
meaning: cim:TransformerApplicationKind.transmissionBusToBus
transmissionBusToDistribution:
meaning: cim:TransformerApplicationKind.transmissionBusToDistribution
RevisionKind:
enum_uri: cim:RevisionKind
description: List of the kinds of revisions that can be made to a SwitchingStep.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Operations
permissible_values:
added:
meaning: cim:RevisionKind.added
void:
meaning: cim:RevisionKind.void
CrewStatusKind:
enum_uri: cim:CrewStatusKind
description: Defines the current status of the Crew - assigned, arrived, etc.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Common
permissible_values:
arrived:
meaning: cim:CrewStatusKind.arrived
assigned:
meaning: cim:CrewStatusKind.assigned
awaitingCrewAssignment:
meaning: cim:CrewStatusKind.awaitingCrewAssignment
enroute:
meaning: cim:CrewStatusKind.enroute
fieldComplete:
meaning: cim:CrewStatusKind.fieldComplete
OutageStatusKind:
enum_uri: cim:OutageStatusKind
description: This defines if the outage have been predicted or confirmed
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Operations
permissible_values:
closed:
meaning: cim:OutageStatusKind.closed
confirmed:
meaning: cim:OutageStatusKind.confirmed
partiallyRestored:
meaning: cim:OutageStatusKind.partiallyRestored
predicted:
meaning: cim:OutageStatusKind.predicted
restored:
meaning: cim:OutageStatusKind.restored
ERTConfidenceKind:
enum_uri: cim:ERTConfidenceKind
description: The estimated restoration time (ERT) is the amount of time estimated
to correct the outage and can have a confidence factor applied such as high
or low confidence that the ERT will be accomplished. This confidence factor
may be updated as needed during the outage period - just as the actual ERT can
be updated.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Operations
permissible_values:
high:
meaning: cim:ERTConfidenceKind.high
low:
meaning: cim:ERTConfidenceKind.low
AreaKind:
enum_uri: cim:AreaKind
description: Enumeration for the type of area defined; e.g., county, state, parish,
zipcode, etc.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Operations
permissible_values:
borough:
meaning: cim:AreaKind.borough
county:
meaning: cim:AreaKind.county
parish:
meaning: cim:AreaKind.parish
serviceArea:
meaning: cim:AreaKind.serviceArea
state:
meaning: cim:AreaKind.state
township:
meaning: cim:AreaKind.township
ward:
meaning: cim:AreaKind.ward
zipcode:
meaning: cim:AreaKind.zipcode
SwitchActionKind:
enum_uri: cim:SwitchActionKind
description: Kind of action on switch.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Operations
permissible_values:
close:
meaning: cim:SwitchActionKind.close
disableReclosing:
meaning: cim:SwitchActionKind.disableReclosing
enableReclosing:
meaning: cim:SwitchActionKind.enableReclosing
open:
meaning: cim:SwitchActionKind.open
PhaseConnectedFaultKind:
enum_uri: cim:PhaseConnectedFaultKind
description: The type of fault connection among phases.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Faults
permissible_values:
lineOpen:
meaning: cim:PhaseConnectedFaultKind.lineOpen
lineToGround:
meaning: cim:PhaseConnectedFaultKind.lineToGround
lineToLine:
meaning: cim:PhaseConnectedFaultKind.lineToLine
lineToLineToGround:
meaning: cim:PhaseConnectedFaultKind.lineToLineToGround
ServiceKind:
enum_uri: cim:ServiceKind
description: Kind of service.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Customers
permissible_values:
air:
meaning: cim:ServiceKind.air
electricity:
meaning: cim:ServiceKind.electricity
gas:
meaning: cim:ServiceKind.gas
heat:
meaning: cim:ServiceKind.heat
heatingFluid:
meaning: cim:ServiceKind.heatingFluid
internet:
meaning: cim:ServiceKind.internet
naturalGas:
meaning: cim:ServiceKind.naturalGas
other:
meaning: cim:ServiceKind.other
propane:
meaning: cim:ServiceKind.propane
rates:
meaning: cim:ServiceKind.rates
refuse:
meaning: cim:ServiceKind.refuse
sewerage:
meaning: cim:ServiceKind.sewerage
steam:
meaning: cim:ServiceKind.steam
time:
meaning: cim:ServiceKind.time
tvLicence:
meaning: cim:ServiceKind.tvLicence
water:
meaning: cim:ServiceKind.water
RevenueKind:
enum_uri: cim:RevenueKind
description: "Accounting classification of the type of revenue collected for the\
\ customer agreement, typically used to break down accounts for revenue accounting.\r\
\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Customers
permissible_values:
commercial:
meaning: cim:RevenueKind.commercial
industrial:
meaning: cim:RevenueKind.industrial
irrigation:
meaning: cim:RevenueKind.irrigation
nonResidential:
meaning: cim:RevenueKind.nonResidential
other:
meaning: cim:RevenueKind.other
residential:
meaning: cim:RevenueKind.residential
streetLight:
meaning: cim:RevenueKind.streetLight
TransactionKind:
enum_uri: cim:TransactionKind
description: Kind of transaction.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.PaymentMetering
permissible_values:
accountPayment:
meaning: cim:TransactionKind.accountPayment
auxiliaryChargePayment:
meaning: cim:TransactionKind.auxiliaryChargePayment
diversePayment:
meaning: cim:TransactionKind.diversePayment
meterConfigurationToken:
meaning: cim:TransactionKind.meterConfigurationToken
other:
meaning: cim:TransactionKind.other
serviceChargePayment:
meaning: cim:TransactionKind.serviceChargePayment
taxChargePayment:
meaning: cim:TransactionKind.taxChargePayment
tokenCancellation:
meaning: cim:TransactionKind.tokenCancellation
tokenExchange:
meaning: cim:TransactionKind.tokenExchange
tokenFreeIssue:
meaning: cim:TransactionKind.tokenFreeIssue
tokenGrant:
meaning: cim:TransactionKind.tokenGrant
tokenSalePayment:
meaning: cim:TransactionKind.tokenSalePayment
transactionReversal:
meaning: cim:TransactionKind.transactionReversal
ErpAccountKind:
enum_uri: cim:ErpAccountKind
description: Kind of ERP account.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfERPSupport
permissible_values:
estimate:
meaning: cim:ErpAccountKind.estimate
normal:
meaning: cim:ErpAccountKind.normal
reversal:
meaning: cim:ErpAccountKind.reversal
statistical:
meaning: cim:ErpAccountKind.statistical
ProcedureKind:
enum_uri: cim:ProcedureKind
description: Kind of procedure.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
permissible_values:
diagnosis:
meaning: cim:ProcedureKind.diagnosis
inspection:
meaning: cim:ProcedureKind.inspection
maintenance:
meaning: cim:ProcedureKind.maintenance
other:
meaning: cim:ProcedureKind.other
test:
meaning: cim:ProcedureKind.test
CoolingKind:
enum_uri: cim:CoolingKind
description: Kind of cooling.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfAssets
permissible_values:
forcedAir:
meaning: cim:CoolingKind.forcedAir
forcedOilAndAir:
meaning: cim:CoolingKind.forcedOilAndAir
other:
meaning: cim:CoolingKind.other
selfCooling:
meaning: cim:CoolingKind.selfCooling
BushingInsulationPfTestKind:
enum_uri: cim:BushingInsulationPfTestKind
description: Kind of PF test for bushing insulation.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfAssets
permissible_values:
c1:
meaning: cim:BushingInsulationPfTestKind.c1
c2:
meaning: cim:BushingInsulationPfTestKind.c2
WindingConnection:
enum_uri: cim:WindingConnection
description: "Winding connection type.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
permissible_values:
A:
meaning: cim:WindingConnection.A
D:
meaning: cim:WindingConnection.D
I:
meaning: cim:WindingConnection.I
Y:
meaning: cim:WindingConnection.Y
Yn:
meaning: cim:WindingConnection.Yn
Z:
meaning: cim:WindingConnection.Z
Zn:
meaning: cim:WindingConnection.Zn
CurveStyle:
enum_uri: cim:CurveStyle
description: Style or shape of curve.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Core
permissible_values:
constantYValue:
meaning: cim:CurveStyle.constantYValue
straightLineYValues:
meaning: cim:CurveStyle.straightLineYValues
MediumKind:
enum_uri: cim:MediumKind
description: Kind of medium.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
permissible_values:
air:
meaning: cim:MediumKind.air
gas:
meaning: cim:MediumKind.gas
liquid:
meaning: cim:MediumKind.liquid
mineralOil:
meaning: cim:MediumKind.mineralOil
SF6:
meaning: cim:MediumKind.SF6
SF6CF4:
meaning: cim:MediumKind.SF6CF4
SF6N2:
meaning: cim:MediumKind.SF6N2
solid:
meaning: cim:MediumKind.solid
TenderKind:
enum_uri: cim:TenderKind
description: Kind of tender.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.PaymentMetering
permissible_values:
card:
meaning: cim:TenderKind.card
cash:
meaning: cim:TenderKind.cash
cheque:
meaning: cim:TenderKind.cheque
other:
meaning: cim:TenderKind.other
unspecified:
meaning: cim:TenderKind.unspecified
ChequeKind:
enum_uri: cim:ChequeKind
description: Kind of cheque.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.PaymentMetering
permissible_values:
bankOrder:
meaning: cim:ChequeKind.bankOrder
other:
meaning: cim:ChequeKind.other
postalOrder:
meaning: cim:ChequeKind.postalOrder
ChargeKind:
enum_uri: cim:ChargeKind
description: "Kind of charge.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.PaymentMetering
permissible_values:
auxiliaryCharge:
meaning: cim:ChargeKind.auxiliaryCharge
consumptionCharge:
meaning: cim:ChargeKind.consumptionCharge
demandCharge:
meaning: cim:ChargeKind.demandCharge
other:
meaning: cim:ChargeKind.other
taxCharge:
meaning: cim:ChargeKind.taxCharge
AccumulationKind:
enum_uri: cim:AccumulationKind
description: Kind of accumulation behaviour for read / measured values from individual
end points.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
permissible_values:
boundedQuantity:
meaning: cim:AccumulationKind.boundedQuantity
bulkQuantity:
meaning: cim:AccumulationKind.bulkQuantity
continuousCumulative:
meaning: cim:AccumulationKind.continuousCumulative
cumulative:
meaning: cim:AccumulationKind.cumulative
deltaData:
meaning: cim:AccumulationKind.deltaData
indicating:
meaning: cim:AccumulationKind.indicating
instantaneous:
meaning: cim:AccumulationKind.instantaneous
latchingQuantity:
meaning: cim:AccumulationKind.latchingQuantity
none:
meaning: cim:AccumulationKind.none
summation:
meaning: cim:AccumulationKind.summation
timeDelay:
meaning: cim:AccumulationKind.timeDelay
AggregateKind:
enum_uri: cim:AggregateKind
description: Kind of aggregation for read / measured values from multiple end
points.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
permissible_values:
average:
meaning: cim:AggregateKind.average
excess:
meaning: cim:AggregateKind.excess
fifthMaximum:
meaning: cim:AggregateKind.fifthMaximum
fourthMaximum:
meaning: cim:AggregateKind.fourthMaximum
highThreshold:
meaning: cim:AggregateKind.highThreshold
lowThreshold:
meaning: cim:AggregateKind.lowThreshold
maximum:
meaning: cim:AggregateKind.maximum
minimum:
meaning: cim:AggregateKind.minimum
nominal:
meaning: cim:AggregateKind.nominal
none:
meaning: cim:AggregateKind.none
normal:
meaning: cim:AggregateKind.normal
secondMaximum:
meaning: cim:AggregateKind.secondMaximum
secondMinimum:
meaning: cim:AggregateKind.secondMinimum
sum:
meaning: cim:AggregateKind.sum
thirdMaximum:
meaning: cim:AggregateKind.thirdMaximum
CommodityKind:
enum_uri: cim:CommodityKind
description: Kind of commodity being measured.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
permissible_values:
air:
meaning: cim:CommodityKind.air
carbon:
meaning: cim:CommodityKind.carbon
ch4:
meaning: cim:CommodityKind.ch4
co2:
meaning: cim:CommodityKind.co2
communication:
meaning: cim:CommodityKind.communication
coolingFluid:
meaning: cim:CommodityKind.coolingFluid
electricityPrimaryMetered:
meaning: cim:CommodityKind.electricityPrimaryMetered
electricitySecondaryMetered:
meaning: cim:CommodityKind.electricitySecondaryMetered
hch:
meaning: cim:CommodityKind.hch
heatingFluid:
meaning: cim:CommodityKind.heatingFluid
insulativeGas:
meaning: cim:CommodityKind.insulativeGas
insulativeOil:
meaning: cim:CommodityKind.insulativeOil
internet:
meaning: cim:CommodityKind.internet
naturalGas:
meaning: cim:CommodityKind.naturalGas
none:
meaning: cim:CommodityKind.none
nonpotableWater:
meaning: cim:CommodityKind.nonpotableWater
nox:
meaning: cim:CommodityKind.nox
pfc:
meaning: cim:CommodityKind.pfc
potableWater:
meaning: cim:CommodityKind.potableWater
propane:
meaning: cim:CommodityKind.propane
refuse:
meaning: cim:CommodityKind.refuse
sf6:
meaning: cim:CommodityKind.sf6
so2:
meaning: cim:CommodityKind.so2
steam:
meaning: cim:CommodityKind.steam
tvLicence:
meaning: cim:CommodityKind.tvLicence
wasteWater:
meaning: cim:CommodityKind.wasteWater
FlowDirectionKind:
enum_uri: cim:FlowDirectionKind
description: Kind of flow direction for reading/measured values proper to some
commodities such as, for example, energy, power, demand.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
permissible_values:
forward:
meaning: cim:FlowDirectionKind.forward
lagging:
meaning: cim:FlowDirectionKind.lagging
leading:
meaning: cim:FlowDirectionKind.leading
net:
meaning: cim:FlowDirectionKind.net
none:
meaning: cim:FlowDirectionKind.none
q1minusQ4:
meaning: cim:FlowDirectionKind.q1minusQ4
q1plusQ2:
meaning: cim:FlowDirectionKind.q1plusQ2
q1plusQ3:
meaning: cim:FlowDirectionKind.q1plusQ3
q1plusQ4:
meaning: cim:FlowDirectionKind.q1plusQ4
q2minusQ3:
meaning: cim:FlowDirectionKind.q2minusQ3
q2plusQ3:
meaning: cim:FlowDirectionKind.q2plusQ3
q2plusQ4:
meaning: cim:FlowDirectionKind.q2plusQ4
q3minusQ2:
meaning: cim:FlowDirectionKind.q3minusQ2
q3plusQ4:
meaning: cim:FlowDirectionKind.q3plusQ4
quadrant1:
meaning: cim:FlowDirectionKind.quadrant1
quadrant2:
meaning: cim:FlowDirectionKind.quadrant2
quadrant3:
meaning: cim:FlowDirectionKind.quadrant3
quadrant4:
meaning: cim:FlowDirectionKind.quadrant4
reverse:
meaning: cim:FlowDirectionKind.reverse
total:
meaning: cim:FlowDirectionKind.total
totalByPhase:
meaning: cim:FlowDirectionKind.totalByPhase
MacroPeriodKind:
enum_uri: cim:MacroPeriodKind
description: Kind of macro period for calculations on read / measured values.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
permissible_values:
billingPeriod:
meaning: cim:MacroPeriodKind.billingPeriod
daily:
meaning: cim:MacroPeriodKind.daily
monthly:
meaning: cim:MacroPeriodKind.monthly
none:
meaning: cim:MacroPeriodKind.none
seasonal:
meaning: cim:MacroPeriodKind.seasonal
specifiedPeriod:
meaning: cim:MacroPeriodKind.specifiedPeriod
weekly:
meaning: cim:MacroPeriodKind.weekly
MeasurementKind:
enum_uri: cim:MeasurementKind
description: Kind of read / measured value.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
permissible_values:
alarm:
meaning: cim:MeasurementKind.alarm
apparentPowerFactor:
meaning: cim:MeasurementKind.apparentPowerFactor
applicationContext:
meaning: cim:MeasurementKind.applicationContext
apTitle:
meaning: cim:MeasurementKind.apTitle
assetNumber:
meaning: cim:MeasurementKind.assetNumber
audibleVolume:
meaning: cim:MeasurementKind.audibleVolume
bandwidth:
meaning: cim:MeasurementKind.bandwidth
batteryCarryover:
meaning: cim:MeasurementKind.batteryCarryover
batteryVoltage:
meaning: cim:MeasurementKind.batteryVoltage
billCarryover:
meaning: cim:MeasurementKind.billCarryover
billLastPeriod:
meaning: cim:MeasurementKind.billLastPeriod
billToDate:
meaning: cim:MeasurementKind.billToDate
broadcastAddress:
meaning: cim:MeasurementKind.broadcastAddress
connectionFee:
meaning: cim:MeasurementKind.connectionFee
currency:
meaning: cim:MeasurementKind.currency
current:
meaning: cim:MeasurementKind.current
currentAngle:
meaning: cim:MeasurementKind.currentAngle
currentImbalance:
meaning: cim:MeasurementKind.currentImbalance
dataOverflowAlarm:
meaning: cim:MeasurementKind.dataOverflowAlarm
date:
meaning: cim:MeasurementKind.date
demand:
meaning: cim:MeasurementKind.demand
demandLimit:
meaning: cim:MeasurementKind.demandLimit
demandReset:
meaning: cim:MeasurementKind.demandReset
deviceAddressType1:
meaning: cim:MeasurementKind.deviceAddressType1
deviceAddressType2:
meaning: cim:MeasurementKind.deviceAddressType2
deviceAddressType3:
meaning: cim:MeasurementKind.deviceAddressType3
deviceAddressType4:
meaning: cim:MeasurementKind.deviceAddressType4
deviceClass:
meaning: cim:MeasurementKind.deviceClass
diagnostic:
meaning: cim:MeasurementKind.diagnostic
distance:
meaning: cim:MeasurementKind.distance
distortionPowerFactor:
meaning: cim:MeasurementKind.distortionPowerFactor
distortionVoltAmp:
meaning: cim:MeasurementKind.distortionVoltAmp
electronicSerialNumber:
meaning: cim:MeasurementKind.electronicSerialNumber
emergencyLimit:
meaning: cim:MeasurementKind.emergencyLimit
encoderTamper:
meaning: cim:MeasurementKind.encoderTamper
endDeviceID:
meaning: cim:MeasurementKind.endDeviceID
energization:
meaning: cim:MeasurementKind.energization
energizationLoadSide:
meaning: cim:MeasurementKind.energizationLoadSide
energy:
meaning: cim:MeasurementKind.energy
fan:
meaning: cim:MeasurementKind.fan
frequency:
meaning: cim:MeasurementKind.frequency
frequencyExcursion:
meaning: cim:MeasurementKind.frequencyExcursion
fund:
meaning: cim:MeasurementKind.fund
groupAddressType1:
meaning: cim:MeasurementKind.groupAddressType1
groupAddressType2:
meaning: cim:MeasurementKind.groupAddressType2
groupAddressType3:
meaning: cim:MeasurementKind.groupAddressType3
groupAddressType4:
meaning: cim:MeasurementKind.groupAddressType4
ieee1366ASAI:
meaning: cim:MeasurementKind.ieee1366ASAI
ieee1366ASIDI:
meaning: cim:MeasurementKind.ieee1366ASIDI
ieee1366ASIFI:
meaning: cim:MeasurementKind.ieee1366ASIFI
ieee1366CAIDI:
meaning: cim:MeasurementKind.ieee1366CAIDI
ieee1366CAIFI:
meaning: cim:MeasurementKind.ieee1366CAIFI
ieee1366CEMIn:
meaning: cim:MeasurementKind.ieee1366CEMIn
ieee1366CEMSMIn:
meaning: cim:MeasurementKind.ieee1366CEMSMIn
ieee1366CTAIDI:
meaning: cim:MeasurementKind.ieee1366CTAIDI
ieee1366MAIFI:
meaning: cim:MeasurementKind.ieee1366MAIFI
ieee1366MAIFIe:
meaning: cim:MeasurementKind.ieee1366MAIFIe
ieee1366MomentaryInterruption:
meaning: cim:MeasurementKind.ieee1366MomentaryInterruption
ieee1366MomentaryInterruptionEvent:
meaning: cim:MeasurementKind.ieee1366MomentaryInterruptionEvent
ieee1366SAIDI:
meaning: cim:MeasurementKind.ieee1366SAIDI
ieee1366SAIFI:
meaning: cim:MeasurementKind.ieee1366SAIFI
ieee1366SustainedInterruption:
meaning: cim:MeasurementKind.ieee1366SustainedInterruption
interruptionBehaviour:
meaning: cim:MeasurementKind.interruptionBehaviour
inversionTamper:
meaning: cim:MeasurementKind.inversionTamper
ipAddress:
meaning: cim:MeasurementKind.ipAddress
lineLoss:
meaning: cim:MeasurementKind.lineLoss
loadInterrupt:
meaning: cim:MeasurementKind.loadInterrupt
loadShed:
meaning: cim:MeasurementKind.loadShed
loss:
meaning: cim:MeasurementKind.loss
macAddress:
meaning: cim:MeasurementKind.macAddress
maintenance:
meaning: cim:MeasurementKind.maintenance
mfgAssignedConfigurationID:
meaning: cim:MeasurementKind.mfgAssignedConfigurationID
mfgAssignedPhysicalSerialNumber:
meaning: cim:MeasurementKind.mfgAssignedPhysicalSerialNumber
mfgAssignedProductNumber:
meaning: cim:MeasurementKind.mfgAssignedProductNumber
mfgAssignedUniqueCommunicationAddress:
meaning: cim:MeasurementKind.mfgAssignedUniqueCommunicationAddress
multiCastAddress:
meaning: cim:MeasurementKind.multiCastAddress
negativeSequence:
meaning: cim:MeasurementKind.negativeSequence
none:
meaning: cim:MeasurementKind.none
oneWayAddress:
meaning: cim:MeasurementKind.oneWayAddress
phasorPowerFactor:
meaning: cim:MeasurementKind.phasorPowerFactor
phasorReactivePower:
meaning: cim:MeasurementKind.phasorReactivePower
physicalTamper:
meaning: cim:MeasurementKind.physicalTamper
positiveSequence:
meaning: cim:MeasurementKind.positiveSequence
power:
meaning: cim:MeasurementKind.power
powerFactor:
meaning: cim:MeasurementKind.powerFactor
powerLossTamper:
meaning: cim:MeasurementKind.powerLossTamper
powerOutage:
meaning: cim:MeasurementKind.powerOutage
powerQuality:
meaning: cim:MeasurementKind.powerQuality
powerRestoration:
meaning: cim:MeasurementKind.powerRestoration
programmed:
meaning: cim:MeasurementKind.programmed
pushbutton:
meaning: cim:MeasurementKind.pushbutton
quantityPower:
meaning: cim:MeasurementKind.quantityPower
relayActivation:
meaning: cim:MeasurementKind.relayActivation
relayCycle:
meaning: cim:MeasurementKind.relayCycle
removalTamper:
meaning: cim:MeasurementKind.removalTamper
reprogrammingTamper:
meaning: cim:MeasurementKind.reprogrammingTamper
reverseRotationTamper:
meaning: cim:MeasurementKind.reverseRotationTamper
sag:
meaning: cim:MeasurementKind.sag
signalStrength:
meaning: cim:MeasurementKind.signalStrength
signaltoNoiseRatio:
meaning: cim:MeasurementKind.signaltoNoiseRatio
swell:
meaning: cim:MeasurementKind.swell
switchArmed:
meaning: cim:MeasurementKind.switchArmed
switchDisabled:
meaning: cim:MeasurementKind.switchDisabled
switchPosition:
meaning: cim:MeasurementKind.switchPosition
tamper:
meaning: cim:MeasurementKind.tamper
tapPosition:
meaning: cim:MeasurementKind.tapPosition
tariffRate:
meaning: cim:MeasurementKind.tariffRate
temperature:
meaning: cim:MeasurementKind.temperature
totalHarmonicDistortion:
meaning: cim:MeasurementKind.totalHarmonicDistortion
transformerLoss:
meaning: cim:MeasurementKind.transformerLoss
twoWayAddress:
meaning: cim:MeasurementKind.twoWayAddress
unipedeVoltageDip10to15:
meaning: cim:MeasurementKind.unipedeVoltageDip10to15
unipedeVoltageDip15to30:
meaning: cim:MeasurementKind.unipedeVoltageDip15to30
unipedeVoltageDip30to60:
meaning: cim:MeasurementKind.unipedeVoltageDip30to60
unipedeVoltageDip60to90:
meaning: cim:MeasurementKind.unipedeVoltageDip60to90
unipedeVoltageDip90to100:
meaning: cim:MeasurementKind.unipedeVoltageDip90to100
voltage:
meaning: cim:MeasurementKind.voltage
voltageAngle:
meaning: cim:MeasurementKind.voltageAngle
voltageExcursion:
meaning: cim:MeasurementKind.voltageExcursion
voltageImbalance:
meaning: cim:MeasurementKind.voltageImbalance
volume:
meaning: cim:MeasurementKind.volume
volumetricFlow:
meaning: cim:MeasurementKind.volumetricFlow
watchdogTimeout:
meaning: cim:MeasurementKind.watchdogTimeout
zeroFlowDuration:
meaning: cim:MeasurementKind.zeroFlowDuration
zeroSequence:
meaning: cim:MeasurementKind.zeroSequence
MeasuringPeriodKind:
enum_uri: cim:MeasuringPeriodKind
description: Kind of period for reading / measuring values.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
permissible_values:
fifteenMinute:
meaning: cim:MeasuringPeriodKind.fifteenMinute
fiveMinute:
meaning: cim:MeasuringPeriodKind.fiveMinute
fixedBlock10Min:
meaning: cim:MeasuringPeriodKind.fixedBlock10Min
fixedBlock15Min:
meaning: cim:MeasuringPeriodKind.fixedBlock15Min
fixedBlock1Min:
meaning: cim:MeasuringPeriodKind.fixedBlock1Min
fixedBlock20Min:
meaning: cim:MeasuringPeriodKind.fixedBlock20Min
fixedBlock30Min:
meaning: cim:MeasuringPeriodKind.fixedBlock30Min
fixedBlock5Min:
meaning: cim:MeasuringPeriodKind.fixedBlock5Min
fixedBlock60Min:
meaning: cim:MeasuringPeriodKind.fixedBlock60Min
none:
meaning: cim:MeasuringPeriodKind.none
oneMinute:
meaning: cim:MeasuringPeriodKind.oneMinute
present:
meaning: cim:MeasuringPeriodKind.present
previous:
meaning: cim:MeasuringPeriodKind.previous
rollingBlock10MinIntvl1MinSubIntvl:
meaning: cim:MeasuringPeriodKind.rollingBlock10MinIntvl1MinSubIntvl
rollingBlock10MinIntvl2MinSubIntvl:
meaning: cim:MeasuringPeriodKind.rollingBlock10MinIntvl2MinSubIntvl
rollingBlock10MinIntvl5MinSubIntvl:
meaning: cim:MeasuringPeriodKind.rollingBlock10MinIntvl5MinSubIntvl
rollingBlock15MinIntvl1MinSubIntvl:
meaning: cim:MeasuringPeriodKind.rollingBlock15MinIntvl1MinSubIntvl
rollingBlock15MinIntvl3MinSubIntvl:
meaning: cim:MeasuringPeriodKind.rollingBlock15MinIntvl3MinSubIntvl
rollingBlock15MinIntvl5MinSubIntvl:
meaning: cim:MeasuringPeriodKind.rollingBlock15MinIntvl5MinSubIntvl
rollingBlock30MinIntvl10MinSubIntvl:
meaning: cim:MeasuringPeriodKind.rollingBlock30MinIntvl10MinSubIntvl
rollingBlock30MinIntvl15MinSubIntvl:
meaning: cim:MeasuringPeriodKind.rollingBlock30MinIntvl15MinSubIntvl
rollingBlock30MinIntvl2MinSubIntvl:
meaning: cim:MeasuringPeriodKind.rollingBlock30MinIntvl2MinSubIntvl
rollingBlock30MinIntvl3MinSubIntvl:
meaning: cim:MeasuringPeriodKind.rollingBlock30MinIntvl3MinSubIntvl
rollingBlock30MinIntvl5MinSubIntvl:
meaning: cim:MeasuringPeriodKind.rollingBlock30MinIntvl5MinSubIntvl
rollingBlock30MinIntvl6MinSubIntvl:
meaning: cim:MeasuringPeriodKind.rollingBlock30MinIntvl6MinSubIntvl
rollingBlock5MinIntvl1MinSubIntvl:
meaning: cim:MeasuringPeriodKind.rollingBlock5MinIntvl1MinSubIntvl
rollingBlock60MinIntvl10MinSubIntvl:
meaning: cim:MeasuringPeriodKind.rollingBlock60MinIntvl10MinSubIntvl
rollingBlock60MinIntvl12MinSubIntvl:
meaning: cim:MeasuringPeriodKind.rollingBlock60MinIntvl12MinSubIntvl
rollingBlock60MinIntvl15MinSubIntvl:
meaning: cim:MeasuringPeriodKind.rollingBlock60MinIntvl15MinSubIntvl
rollingBlock60MinIntvl20MinSubIntvl:
meaning: cim:MeasuringPeriodKind.rollingBlock60MinIntvl20MinSubIntvl
rollingBlock60MinIntvl30MinSubIntvl:
meaning: cim:MeasuringPeriodKind.rollingBlock60MinIntvl30MinSubIntvl
rollingBlock60MinIntvl4MinSubIntvl:
meaning: cim:MeasuringPeriodKind.rollingBlock60MinIntvl4MinSubIntvl
rollingBlock60MinIntvl5MinSubIntvl:
meaning: cim:MeasuringPeriodKind.rollingBlock60MinIntvl5MinSubIntvl
rollingBlock60MinIntvl6MinSubIntvl:
meaning: cim:MeasuringPeriodKind.rollingBlock60MinIntvl6MinSubIntvl
sixtyMinute:
meaning: cim:MeasuringPeriodKind.sixtyMinute
tenMinute:
meaning: cim:MeasuringPeriodKind.tenMinute
thirtyMinute:
meaning: cim:MeasuringPeriodKind.thirtyMinute
threeMinute:
meaning: cim:MeasuringPeriodKind.threeMinute
twentyfourHour:
meaning: cim:MeasuringPeriodKind.twentyfourHour
twentyMinute:
meaning: cim:MeasuringPeriodKind.twentyMinute
twoMinute:
meaning: cim:MeasuringPeriodKind.twoMinute
ReadingReasonKind:
enum_uri: cim:ReadingReasonKind
description: "Reason for the reading being taken.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
permissible_values:
billing:
meaning: cim:ReadingReasonKind.billing
demandReset:
meaning: cim:ReadingReasonKind.demandReset
inquiry:
meaning: cim:ReadingReasonKind.inquiry
installation:
meaning: cim:ReadingReasonKind.installation
loadManagement:
meaning: cim:ReadingReasonKind.loadManagement
loadResearch:
meaning: cim:ReadingReasonKind.loadResearch
moveIn:
meaning: cim:ReadingReasonKind.moveIn
moveOut:
meaning: cim:ReadingReasonKind.moveOut
other:
meaning: cim:ReadingReasonKind.other
removal:
meaning: cim:ReadingReasonKind.removal
serviceConnect:
meaning: cim:ReadingReasonKind.serviceConnect
serviceDisconnect:
meaning: cim:ReadingReasonKind.serviceDisconnect
RandomisationKind:
enum_uri: cim:RandomisationKind
description: "Kind of randomisation to be applied to control the timing of end\
\ device control commands and/or the definition of demand response and load\
\ control events. Value other than 'none' is typically used to mitigate potential\
\ deleterious effects of simultaneous operation of multiple devices.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
permissible_values:
default:
meaning: cim:RandomisationKind.default
end:
meaning: cim:RandomisationKind.end
none:
meaning: cim:RandomisationKind.none
start:
meaning: cim:RandomisationKind.start
startAndEnd:
meaning: cim:RandomisationKind.startAndEnd
DERParameterKind:
enum_uri: cim:DERParameterKind
description: "Specifies the DER parameters related to the unit of power, ramp\
\ rate and regulation flows.\r\n\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.DER
permissible_values:
activePower:
meaning: cim:DERParameterKind.activePower
apparentPower:
meaning: cim:DERParameterKind.apparentPower
decreasingRampRate:
meaning: cim:DERParameterKind.decreasingRampRate
highFilterBiDirectionalRegulation:
meaning: cim:DERParameterKind.highFilterBiDirectionalRegulation
highFilterDownRegulation:
meaning: cim:DERParameterKind.highFilterDownRegulation
highFilterUpRegulation:
meaning: cim:DERParameterKind.highFilterUpRegulation
increasingRampRate:
meaning: cim:DERParameterKind.increasingRampRate
lowFilterBiDirectionalRegulation:
meaning: cim:DERParameterKind.lowFilterBiDirectionalRegulation
lowFilterDownRegulation:
meaning: cim:DERParameterKind.lowFilterDownRegulation
lowFilterUpRegulation:
meaning: cim:DERParameterKind.lowFilterUpRegulation
reactivePower:
meaning: cim:DERParameterKind.reactivePower
voltage:
meaning: cim:DERParameterKind.voltage
DERUnitSymbol:
enum_uri: cim:DERUnitSymbol
description: "The units defined for usage in DER related contexts. This class\
\ is a subset plus possible additions of the UnitSymbol Class in the CIM Domain\
\ Package.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.DER
permissible_values:
A:
meaning: cim:DERUnitSymbol.A
Ah:
meaning: cim:DERUnitSymbol.Ah
As:
meaning: cim:DERUnitSymbol.As
Btu:
meaning: cim:DERUnitSymbol.Btu
deg:
meaning: cim:DERUnitSymbol.deg
degC:
meaning: cim:DERUnitSymbol.degC
h:
meaning: cim:DERUnitSymbol.h
Hz:
meaning: cim:DERUnitSymbol.Hz
min:
meaning: cim:DERUnitSymbol.min
ohm:
meaning: cim:DERUnitSymbol.ohm
ohmm:
meaning: cim:DERUnitSymbol.ohmm
ohmPerm:
meaning: cim:DERUnitSymbol.ohmPerm
onePerHz:
meaning: cim:DERUnitSymbol.onePerHz
Q:
meaning: cim:DERUnitSymbol.Q
Qh:
meaning: cim:DERUnitSymbol.Qh
s:
meaning: cim:DERUnitSymbol.s
therm:
meaning: cim:DERUnitSymbol.therm
V:
meaning: cim:DERUnitSymbol.V
VA:
meaning: cim:DERUnitSymbol.VA
VAh:
meaning: cim:DERUnitSymbol.VAh
VAr:
meaning: cim:DERUnitSymbol.VAr
VArh:
meaning: cim:DERUnitSymbol.VArh
Vh:
meaning: cim:DERUnitSymbol.Vh
VPerVA:
meaning: cim:DERUnitSymbol.VPerVA
VPerVAr:
meaning: cim:DERUnitSymbol.VPerVAr
Vs:
meaning: cim:DERUnitSymbol.Vs
W:
meaning: cim:DERUnitSymbol.W
Wh:
meaning: cim:DERUnitSymbol.Wh
WPerA:
meaning: cim:DERUnitSymbol.WPerA
WPers:
meaning: cim:DERUnitSymbol.WPers
TimeIntervalKind:
enum_uri: cim:TimeIntervalKind
description: "Specifies the unit of time for the intervals in the schedule.\r\n\
\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.DER
permissible_values:
D:
meaning: cim:TimeIntervalKind.D
h:
meaning: cim:TimeIntervalKind.h
m:
meaning: cim:TimeIntervalKind.m
M:
meaning: cim:TimeIntervalKind.M
s:
meaning: cim:TimeIntervalKind.s
Y:
meaning: cim:TimeIntervalKind.Y
TroubleReportingKind:
enum_uri: cim:TroubleReportingKind
description: Kind of trouble reporting.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Customers
permissible_values:
app:
meaning: cim:TroubleReportingKind.app
call:
meaning: cim:TroubleReportingKind.call
email:
meaning: cim:TroubleReportingKind.email
ivr:
meaning: cim:TroubleReportingKind.ivr
letter:
meaning: cim:TroubleReportingKind.letter
other:
meaning: cim:TroubleReportingKind.other
sms:
meaning: cim:TroubleReportingKind.sms
web:
meaning: cim:TroubleReportingKind.web
TroubleSymptomsExtentKind:
enum_uri: cim:TroubleSymptomsExtentKind
description: The enumerated values that define the extent of the problem.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Customers
permissible_values:
entireNeighbourhood:
meaning: cim:TroubleSymptomsExtentKind.entireNeighbourhood
neighbour:
meaning: cim:TroubleSymptomsExtentKind.neighbour
ok:
meaning: cim:TroubleSymptomsExtentKind.ok
other:
meaning: cim:TroubleSymptomsExtentKind.other
singleCustomer:
meaning: cim:TroubleSymptomsExtentKind.singleCustomer
TroubleSymptomsLightKind:
enum_uri: cim:TroubleSymptomsLightKind
description: The list of values that define the light problem.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Customers
permissible_values:
allOut:
meaning: cim:TroubleSymptomsLightKind.allOut
dim:
meaning: cim:TroubleSymptomsLightKind.dim
flickering:
meaning: cim:TroubleSymptomsLightKind.flickering
ok:
meaning: cim:TroubleSymptomsLightKind.ok
other:
meaning: cim:TroubleSymptomsLightKind.other
partOut:
meaning: cim:TroubleSymptomsLightKind.partOut
TroubleSymptomsPoleKind:
enum_uri: cim:TroubleSymptomsPoleKind
description: The list of values that define the Pole problem.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Customers
permissible_values:
down:
meaning: cim:TroubleSymptomsPoleKind.down
hit:
meaning: cim:TroubleSymptomsPoleKind.hit
leaning:
meaning: cim:TroubleSymptomsPoleKind.leaning
ok:
meaning: cim:TroubleSymptomsPoleKind.ok
other:
meaning: cim:TroubleSymptomsPoleKind.other
TroubleSymptomsTransformerKind:
enum_uri: cim:TroubleSymptomsTransformerKind
description: The list of items that define the transformer problem.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Customers
permissible_values:
burning:
meaning: cim:TroubleSymptomsTransformerKind.burning
ok:
meaning: cim:TroubleSymptomsTransformerKind.ok
other:
meaning: cim:TroubleSymptomsTransformerKind.other
TroubleSymptomsTree Kind:
enum_uri: cim:TroubleSymptomsTree%20Kind
description: The list of items that define the tree problem.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Customers
permissible_values:
limbOnService:
meaning: cim:TroubleSymptomsTree%20Kind.limbOnService
limbOnWire:
meaning: cim:TroubleSymptomsTree%20Kind.limbOnWire
ok:
meaning: cim:TroubleSymptomsTree%20Kind.ok
other:
meaning: cim:TroubleSymptomsTree%20Kind.other
TroubleSymptomsWireKind:
enum_uri: cim:TroubleSymptomsWireKind
description: The list of items that define the wire problem.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Customers
permissible_values:
digIn:
meaning: cim:TroubleSymptomsWireKind.digIn
ok:
meaning: cim:TroubleSymptomsWireKind.ok
other:
meaning: cim:TroubleSymptomsWireKind.other
serviceDown:
meaning: cim:TroubleSymptomsWireKind.serviceDown
wireburning:
meaning: cim:TroubleSymptomsWireKind.wireburning
wireDown:
meaning: cim:TroubleSymptomsWireKind.wireDown
NotificationTriggerKind:
enum_uri: cim:NotificationTriggerKind
description: Kind of trigger to notify customer.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Customers
permissible_values:
etrChange:
meaning: cim:NotificationTriggerKind.etrChange
informDispatched:
meaning: cim:NotificationTriggerKind.informDispatched
initialEtr:
meaning: cim:NotificationTriggerKind.initialEtr
powerOut:
meaning: cim:NotificationTriggerKind.powerOut
powerRestored:
meaning: cim:NotificationTriggerKind.powerRestored
OutageCauseKind:
enum_uri: cim:OutageCauseKind
description: This enumeration describes the primary cause of the outage - planned,
unplanned, etc.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Operations
permissible_values:
animal:
meaning: cim:OutageCauseKind.animal
lightingStrike:
meaning: cim:OutageCauseKind.lightingStrike
lineDown:
meaning: cim:OutageCauseKind.lineDown
poleDown:
meaning: cim:OutageCauseKind.poleDown
treeDown:
meaning: cim:OutageCauseKind.treeDown
MeterMultiplierKind:
enum_uri: cim:MeterMultiplierKind
description: "Kind of meter multiplier.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
permissible_values:
ctRatio:
meaning: cim:MeterMultiplierKind.ctRatio
kE:
meaning: cim:MeterMultiplierKind.kE
kH:
meaning: cim:MeterMultiplierKind.kH
kR:
meaning: cim:MeterMultiplierKind.kR
ptRatio:
meaning: cim:MeterMultiplierKind.ptRatio
transformerRatio:
meaning: cim:MeterMultiplierKind.transformerRatio
TempEquipActionKind:
enum_uri: cim:TempEquipActionKind
description: Kind of action on temporary equipment (such as cut, jumper, ground,
energy source).
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Operations
permissible_values:
connect:
meaning: cim:TempEquipActionKind.connect
disconnect:
meaning: cim:TempEquipActionKind.disconnect
place:
meaning: cim:TempEquipActionKind.place
remove:
meaning: cim:TempEquipActionKind.remove
WireUsageKind:
enum_uri: cim:WireUsageKind
description: "Kind of wire usage.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetInfo
permissible_values:
distribution:
meaning: cim:WireUsageKind.distribution
other:
meaning: cim:WireUsageKind.other
secondary:
meaning: cim:WireUsageKind.secondary
transmission:
meaning: cim:WireUsageKind.transmission
StructureMaterialKind:
enum_uri: cim:StructureMaterialKind
description: Kind of material used for structures.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfAssets
permissible_values:
concrete:
meaning: cim:StructureMaterialKind.concrete
other:
meaning: cim:StructureMaterialKind.other
steel:
meaning: cim:StructureMaterialKind.steel
wood:
meaning: cim:StructureMaterialKind.wood
AnchorKind:
enum_uri: cim:AnchorKind
description: Kind of anchor.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfAssets
permissible_values:
concrete:
meaning: cim:AnchorKind.concrete
helix:
meaning: cim:AnchorKind.helix
multiHelix:
meaning: cim:AnchorKind.multiHelix
other:
meaning: cim:AnchorKind.other
rod:
meaning: cim:AnchorKind.rod
screw:
meaning: cim:AnchorKind.screw
unknown:
meaning: cim:AnchorKind.unknown
StructureSupportKind:
enum_uri: cim:StructureSupportKind
description: Kind of structure support.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfAssets
permissible_values:
anchor:
meaning: cim:StructureSupportKind.anchor
guy:
meaning: cim:StructureSupportKind.guy
WireInsulationKind:
enum_uri: cim:WireInsulationKind
description: "Kind of wire insulation.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetInfo
permissible_values:
asbestosAndVarnishedCambric:
meaning: cim:WireInsulationKind.asbestosAndVarnishedCambric
beltedPilc:
meaning: cim:WireInsulationKind.beltedPilc
butyl:
meaning: cim:WireInsulationKind.butyl
crosslinkedPolyethylene:
meaning: cim:WireInsulationKind.crosslinkedPolyethylene
ethylenePropyleneRubber:
meaning: cim:WireInsulationKind.ethylenePropyleneRubber
highMolecularWeightPolyethylene:
meaning: cim:WireInsulationKind.highMolecularWeightPolyethylene
highPressureFluidFilled:
meaning: cim:WireInsulationKind.highPressureFluidFilled
lowCapacitanceRubber:
meaning: cim:WireInsulationKind.lowCapacitanceRubber
oilPaper:
meaning: cim:WireInsulationKind.oilPaper
other:
meaning: cim:WireInsulationKind.other
ozoneResistantRubber:
meaning: cim:WireInsulationKind.ozoneResistantRubber
rubber:
meaning: cim:WireInsulationKind.rubber
siliconRubber:
meaning: cim:WireInsulationKind.siliconRubber
treeResistantHighMolecularWeightPolyethylene:
meaning: cim:WireInsulationKind.treeResistantHighMolecularWeightPolyethylene
treeRetardantCrosslinkedPolyethylene:
meaning: cim:WireInsulationKind.treeRetardantCrosslinkedPolyethylene
unbeltedPilc:
meaning: cim:WireInsulationKind.unbeltedPilc
varnishedCambricCloth:
meaning: cim:WireInsulationKind.varnishedCambricCloth
varnishedDacronGlass:
meaning: cim:WireInsulationKind.varnishedDacronGlass
WireMaterialKind:
enum_uri: cim:WireMaterialKind
description: "Kind of wire material.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetInfo
permissible_values:
aaac:
meaning: cim:WireMaterialKind.aaac
acsr:
meaning: cim:WireMaterialKind.acsr
aluminum:
meaning: cim:WireMaterialKind.aluminum
aluminumAlloy:
meaning: cim:WireMaterialKind.aluminumAlloy
aluminumAlloySteel:
meaning: cim:WireMaterialKind.aluminumAlloySteel
aluminumSteel:
meaning: cim:WireMaterialKind.aluminumSteel
copper:
meaning: cim:WireMaterialKind.copper
other:
meaning: cim:WireMaterialKind.other
steel:
meaning: cim:WireMaterialKind.steel
ProtectiveActionAdjustmentKind:
enum_uri: cim:ProtectiveActionAdjustmentKind
description: Categorisation of different protective action adjustments that can
be performed on equipment.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfSIPS
permissible_values:
byPercentage:
meaning: cim:ProtectiveActionAdjustmentKind.byPercentage
byValue:
meaning: cim:ProtectiveActionAdjustmentKind.byValue
measurement:
meaning: cim:ProtectiveActionAdjustmentKind.measurement
setValue:
meaning: cim:ProtectiveActionAdjustmentKind.setValue
RemedialActionSchemeKind:
enum_uri: cim:RemedialActionSchemeKind
description: Classification of Remedial Action Scheme.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfSIPS
permissible_values:
rAP:
meaning: cim:RemedialActionSchemeKind.rAP
rAS:
meaning: cim:RemedialActionSchemeKind.rAS
CalculationKind:
enum_uri: cim:CalculationKind
description: Categorisation of calculation operation that can be done to Measurement.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfSIPS
permissible_values:
div:
meaning: cim:CalculationKind.div
mul:
meaning: cim:CalculationKind.mul
sqrt:
meaning: cim:CalculationKind.sqrt
sum:
meaning: cim:CalculationKind.sum
BillMediaKind:
enum_uri: cim:BillMediaKind
description: Kind of bill media.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfERPSupport
permissible_values:
electronic:
meaning: cim:BillMediaKind.electronic
other:
meaning: cim:BillMediaKind.other
paper:
meaning: cim:BillMediaKind.paper
ErpInvoiceKind:
enum_uri: cim:ErpInvoiceKind
description: Kind of ERP invoice.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfERPSupport
permissible_values:
purchase:
meaning: cim:ErpInvoiceKind.purchase
sale:
meaning: cim:ErpInvoiceKind.sale
SupplierKind:
enum_uri: cim:SupplierKind
description: Kind of supplier.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.PaymentMetering
permissible_values:
lse:
meaning: cim:SupplierKind.lse
mdma:
meaning: cim:SupplierKind.mdma
msp:
meaning: cim:SupplierKind.msp
other:
meaning: cim:SupplierKind.other
retailer:
meaning: cim:SupplierKind.retailer
utility:
meaning: cim:SupplierKind.utility
YesNo:
enum_uri: cim:YesNo
description: Used as a flag set to Yes or No.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
'NO':
meaning: cim:YesNo.NO
'YES':
meaning: cim:YesNo.YES
ResourceRegistrationStatus:
enum_uri: cim:ResourceRegistrationStatus
description: "Types of resource registration status, for example:\r\n\r\nActive\r\
\nMothballed\r\nPlanned\r\nDecommissioned\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
Active:
meaning: cim:ResourceRegistrationStatus.Active
Decommissioned:
meaning: cim:ResourceRegistrationStatus.Decommissioned
Mothballed:
meaning: cim:ResourceRegistrationStatus.Mothballed
Planned:
meaning: cim:ResourceRegistrationStatus.Planned
ExecutionType:
enum_uri: cim:ExecutionType
description: "Execution types of Market Runs.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
DA:
meaning: cim:ExecutionType.DA
HASP:
meaning: cim:ExecutionType.HASP
RTD:
meaning: cim:ExecutionType.RTD
RTPD:
meaning: cim:ExecutionType.RTPD
MarketType:
enum_uri: cim:MarketType
description: Market type.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
DAM:
meaning: cim:MarketType.DAM
HAM:
meaning: cim:MarketType.HAM
RTM:
meaning: cim:MarketType.RTM
RUC:
meaning: cim:MarketType.RUC
MarketEventStatusKind:
enum_uri: cim:MarketEventStatusKind
description: Market event status types.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
active:
meaning: cim:MarketEventStatusKind.active
cancelled:
meaning: cim:MarketEventStatusKind.cancelled
completed:
meaning: cim:MarketEventStatusKind.completed
planned:
meaning: cim:MarketEventStatusKind.planned
MarketProductType:
enum_uri: cim:MarketProductType
description: "For example:\r\nEnergy, Reg Up, Reg Down, Spin Reserve, Nonspin\
\ Reserve, RUC, Load Folloing Up, and Load Following Down."
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
EN:
meaning: cim:MarketProductType.EN
LFD:
meaning: cim:MarketProductType.LFD
LFU:
meaning: cim:MarketProductType.LFU
NR:
meaning: cim:MarketProductType.NR
RC:
meaning: cim:MarketProductType.RC
RD:
meaning: cim:MarketProductType.RD
REG:
meaning: cim:MarketProductType.REG
RU:
meaning: cim:MarketProductType.RU
SR:
meaning: cim:MarketProductType.SR
PurposeFlagType:
enum_uri: cim:PurposeFlagType
description: "MPM Purpose Flag, for example:\r\n\r\nNature of threshold data:\r\
\n'M' - Mitigation threshold\r\n'R' - Reporting threshold\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
M:
meaning: cim:PurposeFlagType.M
R:
meaning: cim:PurposeFlagType.R
MPMTestIdentifierType:
enum_uri: cim:MPMTestIdentifierType
description: "Market power mitigation test identifier type, for example:\r\n\r\
\n1 - Global Price Test\r\n2 - Global Conduct Test\r\n3 - Global Impact Test\r\
\n4 - Local Price Test\r\n5 - Local Conduct Test\r\n6 - Local Impact Test"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
'1':
meaning: cim:MPMTestIdentifierType.1
'2':
meaning: cim:MPMTestIdentifierType.2
'3':
meaning: cim:MPMTestIdentifierType.3
'4':
meaning: cim:MPMTestIdentifierType.4
'5':
meaning: cim:MPMTestIdentifierType.5
'6':
meaning: cim:MPMTestIdentifierType.6
MPMTestMethodType:
enum_uri: cim:MPMTestMethodType
description: "Market power mitigation test method type.\r\n\r\nTests with the\
\ normal (default) thresholds or tests with the alternate thresholds."
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
ALTERNATE:
meaning: cim:MPMTestMethodType.ALTERNATE
NORMAL:
meaning: cim:MPMTestMethodType.NORMAL
EnergyTransactionType:
enum_uri: cim:EnergyTransactionType
description: "Defines the state of a transaction.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
approve:
meaning: cim:EnergyTransactionType.approve
deny:
meaning: cim:EnergyTransactionType.deny
study:
meaning: cim:EnergyTransactionType.study
InterTieDirection:
enum_uri: cim:InterTieDirection
description: Direction of an intertie.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
E:
meaning: cim:InterTieDirection.E
I:
meaning: cim:InterTieDirection.I
AreaControlMode:
enum_uri: cim:AreaControlMode
description: "Area's present control mode.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
CF:
meaning: cim:AreaControlMode.CF
CTL:
meaning: cim:AreaControlMode.CTL
'OFF':
meaning: cim:AreaControlMode.OFF
TLB:
meaning: cim:AreaControlMode.TLB
BidTypeRMR:
enum_uri: cim:BidTypeRMR
description: "Bid self schedule type has two types as the required output of requirements\
\ and qualified pre-dispatch.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
QUALIFIED_PREDISPATCH:
meaning: cim:BidTypeRMR.QUALIFIED_PREDISPATCH
REQUIREMENTS:
meaning: cim:BidTypeRMR.REQUIREMENTS
SelfSchedReferenceType:
enum_uri: cim:SelfSchedReferenceType
description: "Indication of which type of self schedule is being referenced.\r\
\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
ETC:
meaning: cim:SelfSchedReferenceType.ETC
TOR:
meaning: cim:SelfSchedReferenceType.TOR
MarketProductSelfSchedType:
enum_uri: cim:MarketProductSelfSchedType
description: "Market product self schedule bid types.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
ETC:
meaning: cim:MarketProductSelfSchedType.ETC
LPT:
meaning: cim:MarketProductSelfSchedType.LPT
PT:
meaning: cim:MarketProductSelfSchedType.PT
RA:
meaning: cim:MarketProductSelfSchedType.RA
RGMR:
meaning: cim:MarketProductSelfSchedType.RGMR
RMR:
meaning: cim:MarketProductSelfSchedType.RMR
RMT:
meaning: cim:MarketProductSelfSchedType.RMT
SP:
meaning: cim:MarketProductSelfSchedType.SP
TOR:
meaning: cim:MarketProductSelfSchedType.TOR
MQSCHGType:
enum_uri: cim:MQSCHGType
description: "For example:\r\nADD - add\r\nCHG - change\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
ADD:
meaning: cim:MQSCHGType.ADD
CHG:
meaning: cim:MQSCHGType.CHG
ContractType:
enum_uri: cim:ContractType
description: "Transmission Contract Type, For example:\r\nO - Other \r\nTE - Transmission\
\ Export \r\nTI - Transmission Import \r\nETC - Existing Transmission Contract\
\ \r\nRMT - RMT Contract \r\nTOR - Transmission Ownership Right \r\nRMR - Reliability\
\ Must Run Contract \r\nCVR - Converted contract\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
CVR:
meaning: cim:ContractType.CVR
ETC:
meaning: cim:ContractType.ETC
O:
meaning: cim:ContractType.O
RMR:
meaning: cim:ContractType.RMR
RMT:
meaning: cim:ContractType.RMT
TE:
meaning: cim:ContractType.TE
TI:
meaning: cim:ContractType.TI
TOR:
meaning: cim:ContractType.TOR
TRType:
enum_uri: cim:TRType
description: "Transmission Contract Right type -for example:\r\nindividual or\
\ chain of contract rights\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
CHAIN:
meaning: cim:TRType.CHAIN
INDIVIDUAL:
meaning: cim:TRType.INDIVIDUAL
FuelSource:
enum_uri: cim:FuelSource
description: "For example:\r\nBio Gas (Landfill, Sewage, Digester, etc.)\r\nBiomass\r\
\nCoal\r\nDIST\r\nNatural Gas\r\nGeothermal\r\nHRCV\r\nNone\r\nNuclear\r\nOil\r\
\nOther\r\nSolar\r\nWaste to Energy\r\nWater\r\nWind\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
BGAS:
meaning: cim:FuelSource.BGAS
BIOM:
meaning: cim:FuelSource.BIOM
COAL:
meaning: cim:FuelSource.COAL
DIST:
meaning: cim:FuelSource.DIST
GAS:
meaning: cim:FuelSource.GAS
GEOT:
meaning: cim:FuelSource.GEOT
HRCV:
meaning: cim:FuelSource.HRCV
NG:
meaning: cim:FuelSource.NG
NNG:
meaning: cim:FuelSource.NNG
NONE:
meaning: cim:FuelSource.NONE
NUCL:
meaning: cim:FuelSource.NUCL
OIL:
meaning: cim:FuelSource.OIL
OTHR:
meaning: cim:FuelSource.OTHR
SOLR:
meaning: cim:FuelSource.SOLR
WAST:
meaning: cim:FuelSource.WAST
WATR:
meaning: cim:FuelSource.WATR
WIND:
meaning: cim:FuelSource.WIND
CostBasis:
enum_uri: cim:CostBasis
description: "For example:\r\nBid Cost\r\nProxy Cost\r\nRegistered Cost\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
BIDC:
meaning: cim:CostBasis.BIDC
PRXC:
meaning: cim:CostBasis.PRXC
REGC:
meaning: cim:CostBasis.REGC
RampCurveType:
enum_uri: cim:RampCurveType
description: "For example:\r\n0 - Fixed ramp rate independent of rate function\
\ unit MW output\r\n1 - Static ramp rates as a function of unit MW output only\
\ \r\n2 - Dynamic ramp rates as a function of unit MW output and ramping time\r\
\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
'0':
meaning: cim:RampCurveType.0
'1':
meaning: cim:RampCurveType.1
'2':
meaning: cim:RampCurveType.2
UnitRegulationKind:
enum_uri: cim:UnitRegulationKind
description: Unit regulation kind.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
'0':
meaning: cim:UnitRegulationKind.0
'1':
meaning: cim:UnitRegulationKind.1
'2':
meaning: cim:UnitRegulationKind.2
FlagTypeRMR:
enum_uri: cim:FlagTypeRMR
description: "Indicates whether the unit is RMR and it's condition type, for example:\r\
\nN' - not an RMR unit\r\n'1' - RMR Condition 1 unit\r\n'2' - RMR Condition\
\ 2 unit\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
'1':
meaning: cim:FlagTypeRMR.1
'2':
meaning: cim:FlagTypeRMR.2
N:
meaning: cim:FlagTypeRMR.N
UnitType:
enum_uri: cim:UnitType
description: "Combined Cycle\r\nGas Turbine\r\nHydro Turbine\r\nOther\r\nPhotovoltaic\r\
\nHydro Pump-Turbine\r\nReciprocating Engine\r\nSteam Turbine\r\nSynchronous\
\ Condenser\r\nWind Turbine\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
CCYC:
meaning: cim:UnitType.CCYC
GTUR:
meaning: cim:UnitType.GTUR
HYDR:
meaning: cim:UnitType.HYDR
OTHR:
meaning: cim:UnitType.OTHR
PHOT:
meaning: cim:UnitType.PHOT
PTUR:
meaning: cim:UnitType.PTUR
RECP:
meaning: cim:UnitType.RECP
STUR:
meaning: cim:UnitType.STUR
SYNC:
meaning: cim:UnitType.SYNC
WIND:
meaning: cim:UnitType.WIND
RampRateCondition:
enum_uri: cim:RampRateCondition
description: Ramp rate condition.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
BEST:
meaning: cim:RampRateCondition.BEST
NA:
meaning: cim:RampRateCondition.NA
NORMAL:
meaning: cim:RampRateCondition.NORMAL
WORST:
meaning: cim:RampRateCondition.WORST
ConstraintRampType:
enum_uri: cim:ConstraintRampType
description: "Constraint Ramp type.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
FAST:
meaning: cim:ConstraintRampType.FAST
SLOW:
meaning: cim:ConstraintRampType.SLOW
RampRateType:
enum_uri: cim:RampRateType
description: Ramp rate curve type.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
INTERTIE:
meaning: cim:RampRateType.INTERTIE
LD_DROP:
meaning: cim:RampRateType.LD_DROP
LD_PICKUP:
meaning: cim:RampRateType.LD_PICKUP
OP:
meaning: cim:RampRateType.OP
OP_RES:
meaning: cim:RampRateType.OP_RES
REG:
meaning: cim:RampRateType.REG
EnergyProductType:
enum_uri: cim:EnergyProductType
description: "Energy product type.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
DYN:
meaning: cim:EnergyProductType.DYN
FIRM:
meaning: cim:EnergyProductType.FIRM
NFRM:
meaning: cim:EnergyProductType.NFRM
WHL:
meaning: cim:EnergyProductType.WHL
CheckOutType:
enum_uri: cim:CheckOutType
description: "To indicate a check out type such as adjusted capacity or dispatch\
\ capacity.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
AFTER_THE_FACT:
meaning: cim:CheckOutType.AFTER_THE_FACT
PRE_HOUR:
meaning: cim:CheckOutType.PRE_HOUR
PRE_SCHEDULE:
meaning: cim:CheckOutType.PRE_SCHEDULE
DispatchResponseType:
enum_uri: cim:DispatchResponseType
description: "For example:\r\nNON_RESPONSE\r\nACCEPT\r\nDECLINE\r\nPARTIAL\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
ACCEPT:
meaning: cim:DispatchResponseType.ACCEPT
DECLINE:
meaning: cim:DispatchResponseType.DECLINE
NON_RESPONSE:
meaning: cim:DispatchResponseType.NON_RESPONSE
PARTIAL:
meaning: cim:DispatchResponseType.PARTIAL
PassIndicatorType:
enum_uri: cim:PassIndicatorType
description: "Defines the individual passes that produce results per execution\
\ type/market type.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
DA:
meaning: cim:PassIndicatorType.DA
HA-SCUC:
meaning: cim:PassIndicatorType.HA-SCUC
MPM-1:
meaning: cim:PassIndicatorType.MPM-1
MPM-2:
meaning: cim:PassIndicatorType.MPM-2
MPM-3:
meaning: cim:PassIndicatorType.MPM-3
MPM-4:
meaning: cim:PassIndicatorType.MPM-4
RTED:
meaning: cim:PassIndicatorType.RTED
RTPD:
meaning: cim:PassIndicatorType.RTPD
RUC:
meaning: cim:PassIndicatorType.RUC
EnergyPriceIndexType:
enum_uri: cim:EnergyPriceIndexType
description: "For example:\r\nWHOLESALE\r\nRETAIL\r\nBOTH\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
BOTH:
meaning: cim:EnergyPriceIndexType.BOTH
RETAIL:
meaning: cim:EnergyPriceIndexType.RETAIL
WHOLESALE:
meaning: cim:EnergyPriceIndexType.WHOLESALE
GeneratorControlMode:
enum_uri: cim:GeneratorControlMode
description: "Unit control modes.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.Production
permissible_values:
pulse:
meaning: cim:GeneratorControlMode.pulse
setpoint:
meaning: cim:GeneratorControlMode.setpoint
GeneratorControlSource:
enum_uri: cim:GeneratorControlSource
description: "The source of controls for a generating unit.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.Production
permissible_values:
offAGC:
meaning: cim:GeneratorControlSource.offAGC
onAGC:
meaning: cim:GeneratorControlSource.onAGC
plantControl:
meaning: cim:GeneratorControlSource.plantControl
unavailable:
meaning: cim:GeneratorControlSource.unavailable
ControlAreaTypeKind:
enum_uri: cim:ControlAreaTypeKind
description: "The type of control area.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.ControlArea
permissible_values:
AGC:
meaning: cim:ControlAreaTypeKind.AGC
Forecast:
meaning: cim:ControlAreaTypeKind.Forecast
Interchange:
meaning: cim:ControlAreaTypeKind.Interchange
EnergyTypeKind:
enum_uri: cim:EnergyTypeKind
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.EnergyArea
permissible_values:
ConsumerLoad:
meaning: cim:EnergyTypeKind.ConsumerLoad
IndustrialLoad:
meaning: cim:EnergyTypeKind.IndustrialLoad
Other:
meaning: cim:EnergyTypeKind.Other
PVpark:
meaning: cim:EnergyTypeKind.PVpark
WindPark:
meaning: cim:EnergyTypeKind.WindPark
RegulatingControlModeKind:
enum_uri: cim:RegulatingControlModeKind
description: The kind of regulation model. For example regulating voltage, reactive
power, active power, etc.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
permissible_values:
activePower:
meaning: cim:RegulatingControlModeKind.activePower
admittance:
meaning: cim:RegulatingControlModeKind.admittance
currentFlow:
meaning: cim:RegulatingControlModeKind.currentFlow
powerFactor:
meaning: cim:RegulatingControlModeKind.powerFactor
reactivePower:
meaning: cim:RegulatingControlModeKind.reactivePower
temperature:
meaning: cim:RegulatingControlModeKind.temperature
timeScheduled:
meaning: cim:RegulatingControlModeKind.timeScheduled
voltage:
meaning: cim:RegulatingControlModeKind.voltage
HydroPlantStorageKind:
enum_uri: cim:HydroPlantStorageKind
description: "The type of hydro power plant.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.Production
permissible_values:
pumpedStorage:
meaning: cim:HydroPlantStorageKind.pumpedStorage
runOfRiver:
meaning: cim:HydroPlantStorageKind.runOfRiver
storage:
meaning: cim:HydroPlantStorageKind.storage
HydroEnergyConversionKind:
enum_uri: cim:HydroEnergyConversionKind
description: "Specifies the capability of the hydro generating unit to convert\
\ energy as a generator or pump.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.Production
permissible_values:
generator:
meaning: cim:HydroEnergyConversionKind.generator
pumpAndGenerator:
meaning: cim:HydroEnergyConversionKind.pumpAndGenerator
HydroTurbineKind:
enum_uri: cim:HydroTurbineKind
description: Type of turbine.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.GenerationTrainingSimulation
permissible_values:
francis:
meaning: cim:HydroTurbineKind.francis
kaplan:
meaning: cim:HydroTurbineKind.kaplan
pelton:
meaning: cim:HydroTurbineKind.pelton
FuelType:
enum_uri: cim:FuelType
description: Type of fuel.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.Production
permissible_values:
brownCoalLignite:
meaning: cim:FuelType.brownCoalLignite
coal:
meaning: cim:FuelType.coal
coalDerivedGas:
meaning: cim:FuelType.coalDerivedGas
gas:
meaning: cim:FuelType.gas
hardCoal:
meaning: cim:FuelType.hardCoal
lignite:
meaning: cim:FuelType.lignite
oil:
meaning: cim:FuelType.oil
oilShale:
meaning: cim:FuelType.oilShale
other:
meaning: cim:FuelType.other
peat:
meaning: cim:FuelType.peat
EmissionType:
enum_uri: cim:EmissionType
description: "The type of emission.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.Production
permissible_values:
carbonDioxide:
meaning: cim:EmissionType.carbonDioxide
carbonDisulfide:
meaning: cim:EmissionType.carbonDisulfide
chlorine:
meaning: cim:EmissionType.chlorine
hydrogenSulfide:
meaning: cim:EmissionType.hydrogenSulfide
nitrogenOxide:
meaning: cim:EmissionType.nitrogenOxide
sulfurDioxide:
meaning: cim:EmissionType.sulfurDioxide
CoolantType:
enum_uri: cim:CoolantType
description: "Method of cooling a machine.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
permissible_values:
air:
meaning: cim:CoolantType.air
hydrogenGas:
meaning: cim:CoolantType.hydrogenGas
water:
meaning: cim:CoolantType.water
SynchronousMachineOperatingMode:
enum_uri: cim:SynchronousMachineOperatingMode
description: Synchronous machine operating mode.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
permissible_values:
condenser:
meaning: cim:SynchronousMachineOperatingMode.condenser
generator:
meaning: cim:SynchronousMachineOperatingMode.generator
motor:
meaning: cim:SynchronousMachineOperatingMode.motor
ShortCircuitRotorKind:
enum_uri: cim:ShortCircuitRotorKind
description: Type of rotor, used by short circuit applications.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
permissible_values:
salientPole1:
meaning: cim:ShortCircuitRotorKind.salientPole1
salientPole2:
meaning: cim:ShortCircuitRotorKind.salientPole2
turboSeries1:
meaning: cim:ShortCircuitRotorKind.turboSeries1
turboSeries2:
meaning: cim:ShortCircuitRotorKind.turboSeries2
SynchronousMachineKind:
enum_uri: cim:SynchronousMachineKind
description: Synchronous machine type.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
permissible_values:
condenser:
meaning: cim:SynchronousMachineKind.condenser
generator:
meaning: cim:SynchronousMachineKind.generator
generatorOrCondenser:
meaning: cim:SynchronousMachineKind.generatorOrCondenser
generatorOrCondenserOrMotor:
meaning: cim:SynchronousMachineKind.generatorOrCondenserOrMotor
generatorOrMotor:
meaning: cim:SynchronousMachineKind.generatorOrMotor
motor:
meaning: cim:SynchronousMachineKind.motor
motorOrCondenser:
meaning: cim:SynchronousMachineKind.motorOrCondenser
RemoteSignalKind:
enum_uri: cim:RemoteSignalKind
description: Type of input signal coming from remote bus.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardInterconnections
permissible_values:
remoteBranchCurrentAmplitude:
meaning: cim:RemoteSignalKind.remoteBranchCurrentAmplitude
remoteBusFrequency:
meaning: cim:RemoteSignalKind.remoteBusFrequency
remoteBusFrequencyDeviation:
meaning: cim:RemoteSignalKind.remoteBusFrequencyDeviation
remoteBusVoltage:
meaning: cim:RemoteSignalKind.remoteBusVoltage
remoteBusVoltageAmplitude:
meaning: cim:RemoteSignalKind.remoteBusVoltageAmplitude
remoteBusVoltageAmplitudeDerivative:
meaning: cim:RemoteSignalKind.remoteBusVoltageAmplitudeDerivative
remoteBusVoltageFrequency:
meaning: cim:RemoteSignalKind.remoteBusVoltageFrequency
remoteBusVoltageFrequencyDeviation:
meaning: cim:RemoteSignalKind.remoteBusVoltageFrequencyDeviation
remotePuBusVoltageDerivative:
meaning: cim:RemoteSignalKind.remotePuBusVoltageDerivative
AsynchronousMachineKind:
enum_uri: cim:AsynchronousMachineKind
description: Kind of Asynchronous Machine.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
permissible_values:
generator:
meaning: cim:AsynchronousMachineKind.generator
motor:
meaning: cim:AsynchronousMachineKind.motor
BoilerControlMode:
enum_uri: cim:BoilerControlMode
description: "Boiler control mode.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.GenerationTrainingSimulation
permissible_values:
coordinated:
meaning: cim:BoilerControlMode.coordinated
following:
meaning: cim:BoilerControlMode.following
EmissionValueSource:
enum_uri: cim:EmissionValueSource
description: "The source of the emission value.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.Production
permissible_values:
calculated:
meaning: cim:EmissionValueSource.calculated
measured:
meaning: cim:EmissionValueSource.measured
ActionType:
enum_uri: cim:ActionType
description: "Action type associated with an ActionRequest against a ParticipantInterfaces::Trade.\r\
\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
CANCEL:
meaning: cim:ActionType.CANCEL
TradeType:
enum_uri: cim:TradeType
description: Trade type.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
AST:
meaning: cim:TradeType.AST
IST:
meaning: cim:TradeType.IST
UCT:
meaning: cim:TradeType.UCT
BidMitigationType:
enum_uri: cim:BidMitigationType
description: "For example:\r\nInitial\r\nFinal\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
F:
meaning: cim:BidMitigationType.F
I:
meaning: cim:BidMitigationType.I
BidMitigationStatus:
enum_uri: cim:BidMitigationStatus
description: "For example:\r\n'S' - Mitigated by SMPM because of \"misconduct\"\
\r\n'L; - Mitigated by LMPM because of \"misconduct\"\r\n'R' - Modified by LMPM\
\ because of RMR rules\r\n'M' - Mitigated because of \"misconduct\" both by\
\ SMPM and LMPM\r\n'B' - Mitigated because of \"misconduct\" both by SMPM and\
\ modified by LMLM because of RMR rules\r\n'O' - original\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
B:
meaning: cim:BidMitigationStatus.B
L:
meaning: cim:BidMitigationStatus.L
M:
meaning: cim:BidMitigationStatus.M
O:
meaning: cim:BidMitigationStatus.O
R:
meaning: cim:BidMitigationStatus.R
S:
meaning: cim:BidMitigationStatus.S
AnodeType:
enum_uri: cim:AnodeType
description: "Aggregated Nodes Types for example:\r\n\r\n\t- SYS - System\
\ Zone/Region;
\r\n
\r\n\r\n\t- RUC - RUC Zone;
\r\n
\r\
\n\r\n\t- LFZ - Load Forecast Zone;
\r\n
\r\n\r\n\t- REG\
\ - Market Energy/Ancillary Service Region;
\r\n
\r\n\r\n\t- AGR\
\ - Aggregate Generation Resource;
\r\n
\r\n\r\n\t- POD - Point\
\ of Delivery;
\r\n
\r\n\r\n\t- ALR - Aggregate Load Resource;\
\
\r\n
\r\n\r\n\t- LTAC - Load TransmissionAccessCharge (TAC)\
\ Group;
\r\n
\r\n\r\n\t- ACA - Adjacent Control Area
\r\
\n
\r\n\r\n\t- ASR - Aggregated System Resource
\r\n
\r\n\
\r\n\t- ECA - Embedded Control Area
\r\n
"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
ACA:
meaning: cim:AnodeType.ACA
AGR:
meaning: cim:AnodeType.AGR
ALR:
meaning: cim:AnodeType.ALR
ASR:
meaning: cim:AnodeType.ASR
DER:
meaning: cim:AnodeType.DER
ECA:
meaning: cim:AnodeType.ECA
LFZ:
meaning: cim:AnodeType.LFZ
LTAC:
meaning: cim:AnodeType.LTAC
POD:
meaning: cim:AnodeType.POD
REG:
meaning: cim:AnodeType.REG
RUC:
meaning: cim:AnodeType.RUC
SYS:
meaning: cim:AnodeType.SYS
LoadForecastType:
enum_uri: cim:LoadForecastType
description: "Load forecast zone types.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
LFZ:
meaning: cim:LoadForecastType.LFZ
LZMS:
meaning: cim:LoadForecastType.LZMS
MQSInstructionSource:
enum_uri: cim:MQSInstructionSource
description: "Valid values, for example: \r\nINS - Instruction from RTM\r\nACT\
\ - Actual instruction after the fact\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
ACT:
meaning: cim:MQSInstructionSource.ACT
INS:
meaning: cim:MQSInstructionSource.INS
AutomaticDispInstTypeCommitment:
enum_uri: cim:AutomaticDispInstTypeCommitment
description: Commitment instruction types.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
DR_ADJUSTMENT:
meaning: cim:AutomaticDispInstTypeCommitment.DR_ADJUSTMENT
DR_DEPLOY:
meaning: cim:AutomaticDispInstTypeCommitment.DR_DEPLOY
DR_RELEASE:
meaning: cim:AutomaticDispInstTypeCommitment.DR_RELEASE
SHUT_DOWN:
meaning: cim:AutomaticDispInstTypeCommitment.SHUT_DOWN
START_UP:
meaning: cim:AutomaticDispInstTypeCommitment.START_UP
ResultsConstraintType:
enum_uri: cim:ResultsConstraintType
description: "Market results binding constraint types.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
Actual:
meaning: cim:ResultsConstraintType.Actual
Contingency:
meaning: cim:ResultsConstraintType.Contingency
FG_act:
meaning: cim:ResultsConstraintType.FG_act
Interface:
meaning: cim:ResultsConstraintType.Interface
ConstraintLimitType:
enum_uri: cim:ConstraintLimitType
description: "Binding constraint results limit type, For example:\r\nMAXIMUM\r\
\nMINIMUM\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
MAXIMUM:
meaning: cim:ConstraintLimitType.MAXIMUM
MINIMUM:
meaning: cim:ConstraintLimitType.MINIMUM
CRRCategoryType:
enum_uri: cim:CRRCategoryType
description: "Congestion Revenue Rights category types.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
NSR:
meaning: cim:CRRCategoryType.NSR
PTP:
meaning: cim:CRRCategoryType.PTP
CRRSegmentType:
enum_uri: cim:CRRSegmentType
description: Type of the CRR, from the possible type definitions in the CRR System
(e.g. 'LSE', 'ETC').
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
AUC:
meaning: cim:CRRSegmentType.AUC
CAP:
meaning: cim:CRRSegmentType.CAP
CF:
meaning: cim:CRRSegmentType.CF
CVR:
meaning: cim:CRRSegmentType.CVR
ETC:
meaning: cim:CRRSegmentType.ETC
LSE:
meaning: cim:CRRSegmentType.LSE
MT:
meaning: cim:CRRSegmentType.MT
TOR:
meaning: cim:CRRSegmentType.TOR
CRRHedgeType:
enum_uri: cim:CRRHedgeType
description: "Congestion Revenue Right hedge type.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
OBLIGATION:
meaning: cim:CRRHedgeType.OBLIGATION
OPTION:
meaning: cim:CRRHedgeType.OPTION
TimeOfUse:
enum_uri: cim:TimeOfUse
description: Time of Use used by a CRR definition for specifying the time the
CRR spans. ON - CRR spans the on peak hours of the day, OFF - CRR spans the
off peak hours of the day, 24HR - CRR spans the entire day.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
24HR:
meaning: cim:TimeOfUse.24HR
'OFF':
meaning: cim:TimeOfUse.OFF
'ON':
meaning: cim:TimeOfUse.ON
CRRRoleType:
enum_uri: cim:CRRRoleType
description: Role types an organisation can play with respect to a congestion
revenue right.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
BUYER:
meaning: cim:CRRRoleType.BUYER
OWNER:
meaning: cim:CRRRoleType.OWNER
SELLER:
meaning: cim:CRRRoleType.SELLER
FlowDirectionType:
enum_uri: cim:FlowDirectionType
description: "Specifies the direction of energy flow in the flowgate.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
Forward:
meaning: cim:FlowDirectionType.Forward
Reverse:
meaning: cim:FlowDirectionType.Reverse
PriceTypeKind:
enum_uri: cim:PriceTypeKind
description: Value of this enumeration for different prices include "total" for
the complete/full/all-in price, "congestion" for the congestion cost associated
with the total price, the "loss" for the loss price associated with the total
price, "capacity" for prices related to installed or reserved capacity, "mileage"
for use-based accounting, "system" for system-wide/copper-plate prices, and
"delivery" for distribution-based prices.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
capacity:
meaning: cim:PriceTypeKind.capacity
congestion:
meaning: cim:PriceTypeKind.congestion
delivery:
meaning: cim:PriceTypeKind.delivery
loss:
meaning: cim:PriceTypeKind.loss
mileage:
meaning: cim:PriceTypeKind.mileage
system:
meaning: cim:PriceTypeKind.system
total:
meaning: cim:PriceTypeKind.total
ApnodeType:
enum_uri: cim:ApnodeType
description: "Aggregate Node Types for example:\r\nAG - Aggregated Generation\r\
\nCPZ - Custom Price Zone\r\nDPZ - Default Price Zone\r\nLAP - Load Aggregation\
\ Point\r\nTH - Trading Hub\r\nSYS - System Zone\r\nCA - Control Area\r\n\r\
\nGA - generic aggregation\r\nEHV - 500 kV\r\nGH - generic hub\r\nZN - zone\r\
\nINT - Interface\r\nBUS - Bus\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
AG:
meaning: cim:ApnodeType.AG
BUS:
meaning: cim:ApnodeType.BUS
CA:
meaning: cim:ApnodeType.CA
CPZ:
meaning: cim:ApnodeType.CPZ
DCA:
meaning: cim:ApnodeType.DCA
DPZ:
meaning: cim:ApnodeType.DPZ
EHV:
meaning: cim:ApnodeType.EHV
GA:
meaning: cim:ApnodeType.GA
GH:
meaning: cim:ApnodeType.GH
INT:
meaning: cim:ApnodeType.INT
SYS:
meaning: cim:ApnodeType.SYS
TH:
meaning: cim:ApnodeType.TH
ZN:
meaning: cim:ApnodeType.ZN
ParticipationCategoryMPM:
enum_uri: cim:ParticipationCategoryMPM
description: "For example:\r\n'Y' - Participates in both LMPM and SMPM\r\n'N'\
\ - Not included in LMP price measures\r\n'S' - Participates in SMPM price measures\r\
\n'L' - Participates in LMPM price measures\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
L:
meaning: cim:ParticipationCategoryMPM.L
N:
meaning: cim:ParticipationCategoryMPM.N
S:
meaning: cim:ParticipationCategoryMPM.S
Y:
meaning: cim:ParticipationCategoryMPM.Y
MPMTestOutcome:
enum_uri: cim:MPMTestOutcome
description: "For example:\r\nPassed\r\nFailed\r\nDisabled\r\nSkipped\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
D:
meaning: cim:MPMTestOutcome.D
F:
meaning: cim:MPMTestOutcome.F
P:
meaning: cim:MPMTestOutcome.P
S:
meaning: cim:MPMTestOutcome.S
MktBillMediaKind:
enum_uri: cim:MktBillMediaKind
description: Kind of bill media.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
electronic:
meaning: cim:MktBillMediaKind.electronic
other:
meaning: cim:MktBillMediaKind.other
paper:
meaning: cim:MktBillMediaKind.paper
MktAccountKind:
enum_uri: cim:MktAccountKind
description: Kind of Market account.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
estimate:
meaning: cim:MktAccountKind.estimate
normal:
meaning: cim:MktAccountKind.normal
reversal:
meaning: cim:MktAccountKind.reversal
statistical:
meaning: cim:MktAccountKind.statistical
MktInvoiceLineItemKind:
enum_uri: cim:MktInvoiceLineItemKind
description: Kind of invoice line item.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
initial:
meaning: cim:MktInvoiceLineItemKind.initial
other:
meaning: cim:MktInvoiceLineItemKind.other
recalculation:
meaning: cim:MktInvoiceLineItemKind.recalculation
ResourceLimitIndicator:
enum_uri: cim:ResourceLimitIndicator
description: "Locational AS Flags indicating whether the Upper or Lower Bound\
\ limit of the AS regional procurement is binding.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
LOWER:
meaning: cim:ResourceLimitIndicator.LOWER
UPPER:
meaning: cim:ResourceLimitIndicator.UPPER
ReserveRequirementType:
enum_uri: cim:ReserveRequirementType
description: "For example:\r\nOperating Reserve, Regulation, Contingency"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
CONT:
meaning: cim:ReserveRequirementType.CONT
OPRSV:
meaning: cim:ReserveRequirementType.OPRSV
REG:
meaning: cim:ReserveRequirementType.REG
AutomaticDispatchMode:
enum_uri: cim:AutomaticDispatchMode
description: "Automatic Dispatch mode.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
CONTINGENCY:
meaning: cim:AutomaticDispatchMode.CONTINGENCY
INTERVAL:
meaning: cim:AutomaticDispatchMode.INTERVAL
MANUAL:
meaning: cim:AutomaticDispatchMode.MANUAL
SelfScheduleBreakdownType:
enum_uri: cim:SelfScheduleBreakdownType
description: "Self schedule breakdown type.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
ETC:
meaning: cim:SelfScheduleBreakdownType.ETC
LPT:
meaning: cim:SelfScheduleBreakdownType.LPT
TOR:
meaning: cim:SelfScheduleBreakdownType.TOR
EquipmentStatusType:
enum_uri: cim:EquipmentStatusType
description: "Status of equipment.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
In:
meaning: cim:EquipmentStatusType.In
Out:
meaning: cim:EquipmentStatusType.Out
BidType:
enum_uri: cim:BidType
description: "For example:\r\nDEFAULT_ENERGY_BID\r\nDEFAULT_STARTUP_BID\r\nDEFAULT_MINIMUM_LOAD_BID\r\
\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
DEFAULT_ENERGY_BID:
meaning: cim:BidType.DEFAULT_ENERGY_BID
DEFAULT_MINIMUM_LOAD_BID:
meaning: cim:BidType.DEFAULT_MINIMUM_LOAD_BID
DEFAULT_STARTUP_BID:
meaning: cim:BidType.DEFAULT_STARTUP_BID
OnOff:
enum_uri: cim:OnOff
description: "ON\r\nOFF\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
'OFF':
meaning: cim:OnOff.OFF
'ON':
meaning: cim:OnOff.ON
ResourceCapacityType:
enum_uri: cim:ResourceCapacityType
description: Resource capacity type.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
FO:
meaning: cim:ResourceCapacityType.FO
MO:
meaning: cim:ResourceCapacityType.MO
NR:
meaning: cim:ResourceCapacityType.NR
RA:
meaning: cim:ResourceCapacityType.RA
RD:
meaning: cim:ResourceCapacityType.RD
RMR:
meaning: cim:ResourceCapacityType.RMR
RU:
meaning: cim:ResourceCapacityType.RU
SR:
meaning: cim:ResourceCapacityType.SR
CommitmentType:
enum_uri: cim:CommitmentType
description: "For example:\r\nSELF - Self commitment\r\nISO - New commitment for\
\ this market period\r\nUC - Existing commitment that was a hold over from a\
\ previous market\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
ISO:
meaning: cim:CommitmentType.ISO
SELF:
meaning: cim:CommitmentType.SELF
UC:
meaning: cim:CommitmentType.UC
ResourceAssnType:
enum_uri: cim:ResourceAssnType
description: "For example:\r\nAsset Owner Sink designator for use by CRR\r\nAsset\
\ Owner Source designator for use by CRR\r\nReliability Must Run \r\nScheduling\
\ Coordinator \r\nLoad Serving Entity\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
CSNK:
meaning: cim:ResourceAssnType.CSNK
CSRC:
meaning: cim:ResourceAssnType.CSRC
LSE:
meaning: cim:ResourceAssnType.LSE
RMR:
meaning: cim:ResourceAssnType.RMR
SC:
meaning: cim:ResourceAssnType.SC
CalculationIntervalUnitKind:
enum_uri: cim:CalculationIntervalUnitKind
description: "Units in which calculation interval period is defined.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetMeas
permissible_values:
cycle:
meaning: cim:CalculationIntervalUnitKind.cycle
day:
meaning: cim:CalculationIntervalUnitKind.day
hour:
meaning: cim:CalculationIntervalUnitKind.hour
milliSecond:
meaning: cim:CalculationIntervalUnitKind.milliSecond
minute:
meaning: cim:CalculationIntervalUnitKind.minute
month:
meaning: cim:CalculationIntervalUnitKind.month
perCycle:
meaning: cim:CalculationIntervalUnitKind.perCycle
season:
meaning: cim:CalculationIntervalUnitKind.season
second:
meaning: cim:CalculationIntervalUnitKind.second
week:
meaning: cim:CalculationIntervalUnitKind.week
year:
meaning: cim:CalculationIntervalUnitKind.year
ReportingMethodKind:
enum_uri: cim:ReportingMethodKind
description: Method by which information is gathered from station.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental.EnvDomain
permissible_values:
automated:
meaning: cim:ReportingMethodKind.automated
manual:
meaning: cim:ReportingMethodKind.manual
queried:
meaning: cim:ReportingMethodKind.queried
TestKind:
enum_uri: cim:TestKind
description: The test applied to determine if the condition is met.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental.EnvDomain
permissible_values:
equalTo:
meaning: cim:TestKind.equalTo
greaterThan:
meaning: cim:TestKind.greaterThan
greaterThanOrEqualTo:
meaning: cim:TestKind.greaterThanOrEqualTo
lessThan:
meaning: cim:TestKind.lessThan
lessThanOrEqualTo:
meaning: cim:TestKind.lessThanOrEqualTo
LocationKind:
enum_uri: cim:LocationKind
description: The nature of the location being defined for an environmental entity.
Possible values are center, perimeter, primary, secondary.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental.EnvDomain
permissible_values:
center:
meaning: cim:LocationKind.center
extent:
meaning: cim:LocationKind.extent
primary:
meaning: cim:LocationKind.primary
secondary:
meaning: cim:LocationKind.secondary
EnvironmentalDiscreteKind:
enum_uri: cim:EnvironmentalDiscreteKind
description: Discrete (integer) measuring an environmental condition.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental.EnvDomain
permissible_values:
cloudCover:
meaning: cim:EnvironmentalDiscreteKind.cloudCover
ServiceMultiplierKind:
enum_uri: cim:ServiceMultiplierKind
description: "Kind of service multiplier.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
permissible_values:
ctRatio:
meaning: cim:ServiceMultiplierKind.ctRatio
ptRatio:
meaning: cim:ServiceMultiplierKind.ptRatio
transformerRatio:
meaning: cim:ServiceMultiplierKind.transformerRatio
WorkTimeScheduleKind:
enum_uri: cim:WorkTimeScheduleKind
description: Kind of work schedule.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Work
permissible_values:
actual:
meaning: cim:WorkTimeScheduleKind.actual
earliest:
meaning: cim:WorkTimeScheduleKind.earliest
estimate:
meaning: cim:WorkTimeScheduleKind.estimate
immediate:
meaning: cim:WorkTimeScheduleKind.immediate
latest:
meaning: cim:WorkTimeScheduleKind.latest
request:
meaning: cim:WorkTimeScheduleKind.request
WorkTaskKind:
enum_uri: cim:WorkTaskKind
description: Kinds of work tasks.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Work
permissible_values:
exchange:
meaning: cim:WorkTaskKind.exchange
install:
meaning: cim:WorkTaskKind.install
investigate:
meaning: cim:WorkTaskKind.investigate
remove:
meaning: cim:WorkTaskKind.remove
AssetHazardKind:
enum_uri: cim:AssetHazardKind
description: "Type of hazard that is posed to asset in this location.\r\nNote:\
\ This enumeration provides essential information to asset health analytics.\
\ The existing list is a starting point and is anticipated to be fleshed out\
\ further as requirements are better understood (PAB 2016/01/09)."
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
permissible_values:
ambientTempAbove38:
meaning: cim:AssetHazardKind.ambientTempAbove38
ambientTempBelowMinus12:
meaning: cim:AssetHazardKind.ambientTempBelowMinus12
childrenAtPlay:
meaning: cim:AssetHazardKind.childrenAtPlay
fishingArea:
meaning: cim:AssetHazardKind.fishingArea
other:
meaning: cim:AssetHazardKind.other
vegetation:
meaning: cim:AssetHazardKind.vegetation
CustomerKind:
enum_uri: cim:CustomerKind
description: Kind of customer.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Customers
permissible_values:
commercialIndustrial:
meaning: cim:CustomerKind.commercialIndustrial
energyServiceScheduler:
meaning: cim:CustomerKind.energyServiceScheduler
energyServiceSupplier:
meaning: cim:CustomerKind.energyServiceSupplier
enterprise:
meaning: cim:CustomerKind.enterprise
internalUse:
meaning: cim:CustomerKind.internalUse
other:
meaning: cim:CustomerKind.other
pumpingLoad:
meaning: cim:CustomerKind.pumpingLoad
regionalOperator:
meaning: cim:CustomerKind.regionalOperator
residential:
meaning: cim:CustomerKind.residential
residentialAndCommercial:
meaning: cim:CustomerKind.residentialAndCommercial
residentialAndStreetlight:
meaning: cim:CustomerKind.residentialAndStreetlight
residentialFarmService:
meaning: cim:CustomerKind.residentialFarmService
residentialStreetlightOthers:
meaning: cim:CustomerKind.residentialStreetlightOthers
subsidiary:
meaning: cim:CustomerKind.subsidiary
windMachine:
meaning: cim:CustomerKind.windMachine
AnalyticKind:
enum_uri: cim:AnalyticKind
description: Possible kinds of analytics.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
permissible_values:
agingAnalytic:
meaning: cim:AnalyticKind.agingAnalytic
faultAnalytic:
meaning: cim:AnalyticKind.faultAnalytic
healthAnalytic:
meaning: cim:AnalyticKind.healthAnalytic
other:
meaning: cim:AnalyticKind.other
replacementAnalytic:
meaning: cim:AnalyticKind.replacementAnalytic
riskAnalytic:
meaning: cim:AnalyticKind.riskAnalytic
ScaleKind:
enum_uri: cim:ScaleKind
description: Kinds of scaling.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
permissible_values:
exponential:
meaning: cim:ScaleKind.exponential
linear:
meaning: cim:ScaleKind.linear
AssetGroupKind:
enum_uri: cim:AssetGroupKind
description: Possible kinds of asset groups.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
permissible_values:
analysisGroup:
meaning: cim:AssetGroupKind.analysisGroup
complianceGroup:
meaning: cim:AssetGroupKind.complianceGroup
functionalGroup:
meaning: cim:AssetGroupKind.functionalGroup
inventoryGroup:
meaning: cim:AssetGroupKind.inventoryGroup
other:
meaning: cim:AssetGroupKind.other
TagActionKind:
enum_uri: cim:TagActionKind
description: Kind of action on tag.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Operations
permissible_values:
place:
meaning: cim:TagActionKind.place
remove:
meaning: cim:TagActionKind.remove
verify:
meaning: cim:TagActionKind.verify
TransformerControlMode:
enum_uri: cim:TransformerControlMode
description: "Control modes for a transformer.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
permissible_values:
reactive:
meaning: cim:TransformerControlMode.reactive
volt:
meaning: cim:TransformerControlMode.volt
PinBranchGroupKind:
enum_uri: cim:PinBranchGroupKind
description: Categorisation of type of compare done on a branch group.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfSIPS
permissible_values:
activePower:
meaning: cim:PinBranchGroupKind.activePower
reactivePower:
meaning: cim:PinBranchGroupKind.reactivePower
DCPolarityKind:
enum_uri: cim:DCPolarityKind
description: Polarity for DC circuits.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.DC
permissible_values:
middle:
meaning: cim:DCPolarityKind.middle
negative:
meaning: cim:DCPolarityKind.negative
positive:
meaning: cim:DCPolarityKind.positive
PinTerminalKind:
enum_uri: cim:PinTerminalKind
description: Categorisation of type of compare done on Terminal.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfSIPS
permissible_values:
activePower:
meaning: cim:PinTerminalKind.activePower
apparentPower:
meaning: cim:PinTerminalKind.apparentPower
reactivePower:
meaning: cim:PinTerminalKind.reactivePower
voltage:
meaning: cim:PinTerminalKind.voltage
PinEquipmentKind:
enum_uri: cim:PinEquipmentKind
description: Categorisation of type of compare done on Equipment.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfSIPS
permissible_values:
activePowerLimit:
meaning: cim:PinEquipmentKind.activePowerLimit
apparentPowerLimit:
meaning: cim:PinEquipmentKind.apparentPowerLimit
connected:
meaning: cim:PinEquipmentKind.connected
currentLimit:
meaning: cim:PinEquipmentKind.currentLimit
inService:
meaning: cim:PinEquipmentKind.inService
ratedCurrent:
meaning: cim:PinEquipmentKind.ratedCurrent
voltageLimit:
meaning: cim:PinEquipmentKind.voltageLimit
OperationalLimitDirectionKind:
enum_uri: cim:OperationalLimitDirectionKind
description: The direction attribute describes the side of a limit that is a
violation.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.OperationalLimits
permissible_values:
absoluteValue:
meaning: cim:OperationalLimitDirectionKind.absoluteValue
high:
meaning: cim:OperationalLimitDirectionKind.high
low:
meaning: cim:OperationalLimitDirectionKind.low
ClearanceActionKind:
enum_uri: cim:ClearanceActionKind
description: Type of clearance action.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Operations
permissible_values:
issue:
meaning: cim:ClearanceActionKind.issue
release:
meaning: cim:ClearanceActionKind.release
update:
meaning: cim:ClearanceActionKind.update
PSREventKind:
enum_uri: cim:PSREventKind
description: Kind of power system resource (PSR) event.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Operations
permissible_values:
inService:
meaning: cim:PSREventKind.inService
other:
meaning: cim:PSREventKind.other
outOfService:
meaning: cim:PSREventKind.outOfService
pendingAdd:
meaning: cim:PSREventKind.pendingAdd
pendingRemove:
meaning: cim:PSREventKind.pendingRemove
pendingReplace:
meaning: cim:PSREventKind.pendingReplace
unknown:
meaning: cim:PSREventKind.unknown
PhaseShuntConnectionKind:
enum_uri: cim:PhaseShuntConnectionKind
description: The configuration of phase connections for a single terminal device
such as a load or capacitor.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
permissible_values:
D:
meaning: cim:PhaseShuntConnectionKind.D
G:
meaning: cim:PhaseShuntConnectionKind.G
I:
meaning: cim:PhaseShuntConnectionKind.I
Y:
meaning: cim:PhaseShuntConnectionKind.Y
Yn:
meaning: cim:PhaseShuntConnectionKind.Yn
SVCControlMode:
enum_uri: cim:SVCControlMode
description: "Static VAr Compensator control mode.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
permissible_values:
reactivePower:
meaning: cim:SVCControlMode.reactivePower
voltage:
meaning: cim:SVCControlMode.voltage
PetersenCoilModeKind:
enum_uri: cim:PetersenCoilModeKind
description: The mode of operation for a Petersen coil.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Wires
permissible_values:
automaticPositioning:
meaning: cim:PetersenCoilModeKind.automaticPositioning
fixed:
meaning: cim:PetersenCoilModeKind.fixed
manual:
meaning: cim:PetersenCoilModeKind.manual
WindGenUnitKind:
enum_uri: cim:WindGenUnitKind
description: Kind of wind generating unit.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.Production
permissible_values:
offshore:
meaning: cim:WindGenUnitKind.offshore
onshore:
meaning: cim:WindGenUnitKind.onshore
BatteryStateKind:
enum_uri: cim:BatteryStateKind
description: The state of the battery unit.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Generation.Production
permissible_values:
charging:
meaning: cim:BatteryStateKind.charging
discharging:
meaning: cim:BatteryStateKind.discharging
empty:
meaning: cim:BatteryStateKind.empty
full:
meaning: cim:BatteryStateKind.full
waiting:
meaning: cim:BatteryStateKind.waiting
PotentialTransformerKind:
enum_uri: cim:PotentialTransformerKind
description: The construction kind of the potential transformer.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.AuxiliaryEquipment
permissible_values:
capacitiveCoupling:
meaning: cim:PotentialTransformerKind.capacitiveCoupling
inductive:
meaning: cim:PotentialTransformerKind.inductive
CsPpccControlKind:
enum_uri: cim:CsPpccControlKind
description: Active power control modes for HVDC line operating as Current Source
Converter.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.DC
permissible_values:
activePower:
meaning: cim:CsPpccControlKind.activePower
dcCurrent:
meaning: cim:CsPpccControlKind.dcCurrent
dcVoltage:
meaning: cim:CsPpccControlKind.dcVoltage
CsOperatingModeKind:
enum_uri: cim:CsOperatingModeKind
description: Operating mode for HVDC line operating as Current Source Converter.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.DC
permissible_values:
inverter:
meaning: cim:CsOperatingModeKind.inverter
rectifier:
meaning: cim:CsOperatingModeKind.rectifier
VsPpccControlKind:
enum_uri: cim:VsPpccControlKind
description: Types applicable to the control of real power and/or DC voltage by
voltage source converter.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.DC
permissible_values:
phasePcc:
meaning: cim:VsPpccControlKind.phasePcc
pPcc:
meaning: cim:VsPpccControlKind.pPcc
pPccAndUdcDroop:
meaning: cim:VsPpccControlKind.pPccAndUdcDroop
pPccAndUdcDroopPilot:
meaning: cim:VsPpccControlKind.pPccAndUdcDroopPilot
pPccAndUdcDroopWithCompensation:
meaning: cim:VsPpccControlKind.pPccAndUdcDroopWithCompensation
udc:
meaning: cim:VsPpccControlKind.udc
VsQpccControlKind:
enum_uri: cim:VsQpccControlKind
description: Kind of reactive power control at point of common coupling for a
voltage source converter.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.DC
permissible_values:
powerFactorPcc:
meaning: cim:VsQpccControlKind.powerFactorPcc
pulseWidthModulation:
meaning: cim:VsQpccControlKind.pulseWidthModulation
reactivePcc:
meaning: cim:VsQpccControlKind.reactivePcc
voltagePcc:
meaning: cim:VsQpccControlKind.voltagePcc
ProjectStatusKind:
enum_uri: cim:ProjectStatusKind
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.InfIEC61970.InfPart303.NetworkModelProjects
permissible_values:
cancelled:
meaning: cim:ProjectStatusKind.cancelled
closed:
meaning: cim:ProjectStatusKind.closed
draft:
meaning: cim:ProjectStatusKind.draft
frozen:
meaning: cim:ProjectStatusKind.frozen
ICCPPointKind:
enum_uri: cim:ICCPPointKind
description: The kind of ICCP point that is to be conveyed.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.ICCPConfiguration
permissible_values:
discrete:
meaning: cim:ICCPPointKind.discrete
packedProtectionEvent:
meaning: cim:ICCPPointKind.packedProtectionEvent
real:
meaning: cim:ICCPPointKind.real
singleProtectionEvent:
meaning: cim:ICCPPointKind.singleProtectionEvent
state:
meaning: cim:ICCPPointKind.state
stateSupplemental:
meaning: cim:ICCPPointKind.stateSupplemental
IPAddressKind:
enum_uri: cim:IPAddressKind
description: Indicates if the addressing of the IPAccessPoint, gateway, and subnet
are per IPv4 or IPv6.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.ICCPConfiguration
permissible_values:
iPv4:
meaning: cim:IPAddressKind.iPv4
iPv6:
meaning: cim:IPAddressKind.iPv6
ICCPScopeKind:
enum_uri: cim:ICCPScopeKind
description: Specifies the control centre scope.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.ICCPConfiguration
permissible_values:
iCC:
meaning: cim:ICCPScopeKind.iCC
vCC:
meaning: cim:ICCPScopeKind.vCC
ApplicationSecurityKind:
enum_uri: cim:ApplicationSecurityKind
description: Specifies the expected security mechanism, per IEC 62351-4, to be
utilized.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.ICCPConfiguration
permissible_values:
endToEndSecure:
meaning: cim:ApplicationSecurityKind.endToEndSecure
nonSecure:
meaning: cim:ApplicationSecurityKind.nonSecure
secure:
meaning: cim:ApplicationSecurityKind.secure
ICCPQualityKind:
enum_uri: cim:ICCPQualityKind
description: Indicates the type of quality information that is to be exchanged.
For protection events the value shall be "none".
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.ICCPConfiguration
permissible_values:
extended:
meaning: cim:ICCPQualityKind.extended
extendedwithQualityTime:
meaning: cim:ICCPQualityKind.extendedwithQualityTime
none:
meaning: cim:ICCPQualityKind.none
qualityAndTime:
meaning: cim:ICCPQualityKind.qualityAndTime
qualityOnly:
meaning: cim:ICCPQualityKind.qualityOnly
ICCPAccessPrivilegeKind:
enum_uri: cim:ICCPAccessPrivilegeKind
description: Provides access privilege information regarding an ICCP point.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.ICCPConfiguration
permissible_values:
readOnly:
meaning: cim:ICCPAccessPrivilegeKind.readOnly
readWrite:
meaning: cim:ICCPAccessPrivilegeKind.readWrite
IfdBaseKind:
enum_uri: cim:IfdBaseKind
description: Excitation base system mode.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.SynchronousMachineDynamics
permissible_values:
ifag:
meaning: cim:IfdBaseKind.ifag
iffl:
meaning: cim:IfdBaseKind.iffl
ifnl:
meaning: cim:IfdBaseKind.ifnl
SynchronousMachineModelKind:
enum_uri: cim:SynchronousMachineModelKind
description: Type of synchronous machine model used in dynamic simulation applications.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.SynchronousMachineDynamics
permissible_values:
subtransient:
meaning: cim:SynchronousMachineModelKind.subtransient
subtransientSimplified:
meaning: cim:SynchronousMachineModelKind.subtransientSimplified
subtransientSimplifiedDirectAxis:
meaning: cim:SynchronousMachineModelKind.subtransientSimplifiedDirectAxis
subtransientTypeF:
meaning: cim:SynchronousMachineModelKind.subtransientTypeF
subtransientTypeJ:
meaning: cim:SynchronousMachineModelKind.subtransientTypeJ
RotorKind:
enum_uri: cim:RotorKind
description: Type of rotor on physical machine.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.SynchronousMachineDynamics
permissible_values:
roundRotor:
meaning: cim:RotorKind.roundRotor
salientPole:
meaning: cim:RotorKind.salientPole
DroopSignalFeedbackKind:
enum_uri: cim:DroopSignalFeedbackKind
description: Governor droop signal feedback source.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.TurbineGovernorDynamics
permissible_values:
electricalPower:
meaning: cim:DroopSignalFeedbackKind.electricalPower
fuelValveStroke:
meaning: cim:DroopSignalFeedbackKind.fuelValveStroke
governorOutput:
meaning: cim:DroopSignalFeedbackKind.governorOutput
none:
meaning: cim:DroopSignalFeedbackKind.none
GovHydro4ModelKind:
enum_uri: cim:GovHydro4ModelKind
description: Possible types of GovHydro4 models.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.TurbineGovernorDynamics
permissible_values:
francisPelton:
meaning: cim:GovHydro4ModelKind.francisPelton
kaplan:
meaning: cim:GovHydro4ModelKind.kaplan
simple:
meaning: cim:GovHydro4ModelKind.simple
FrancisGovernorControlKind:
enum_uri: cim:FrancisGovernorControlKind
description: Governor control flag for Francis hydro model.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.TurbineGovernorDynamics
permissible_values:
electromechanicalElectrohydraulic:
meaning: cim:FrancisGovernorControlKind.electromechanicalElectrohydraulic
mechanicHydraulicTransientFeedback:
meaning: cim:FrancisGovernorControlKind.mechanicHydraulicTransientFeedback
mechanicHydrolicTachoAccelerator:
meaning: cim:FrancisGovernorControlKind.mechanicHydrolicTachoAccelerator
ExcIEEEST1AUELselectorKind:
enum_uri: cim:ExcIEEEST1AUELselectorKind
description: Types of connections for the UEL input used in ExcIEEEST1A.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
permissible_values:
ignoreUELsignal:
meaning: cim:ExcIEEEST1AUELselectorKind.ignoreUELsignal
inputAddedToErrorSignal:
meaning: cim:ExcIEEEST1AUELselectorKind.inputAddedToErrorSignal
inputHVgateErrorSignal:
meaning: cim:ExcIEEEST1AUELselectorKind.inputHVgateErrorSignal
inputHVgateVoltageOutput:
meaning: cim:ExcIEEEST1AUELselectorKind.inputHVgateVoltageOutput
ExcST6BOELselectorKind:
enum_uri: cim:ExcST6BOELselectorKind
description: Types of connections for the OEL input used for static excitation
systems type 6B.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
permissible_values:
afterUEL:
meaning: cim:ExcST6BOELselectorKind.afterUEL
beforeUEL:
meaning: cim:ExcST6BOELselectorKind.beforeUEL
noOELinput:
meaning: cim:ExcST6BOELselectorKind.noOELinput
ExcST7BOELselectorKind:
enum_uri: cim:ExcST7BOELselectorKind
description: Types of connections for the OEL input used for static excitation
systems type 7B.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
permissible_values:
addVref:
meaning: cim:ExcST7BOELselectorKind.addVref
inputLVgate:
meaning: cim:ExcST7BOELselectorKind.inputLVgate
noOELinput:
meaning: cim:ExcST7BOELselectorKind.noOELinput
outputLVgate:
meaning: cim:ExcST7BOELselectorKind.outputLVgate
ExcST7BUELselectorKind:
enum_uri: cim:ExcST7BUELselectorKind
description: Types of connections for the UEL input used for static excitation
systems type 7B.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
permissible_values:
addVref:
meaning: cim:ExcST7BUELselectorKind.addVref
inputHVgate:
meaning: cim:ExcST7BUELselectorKind.inputHVgate
noUELinput:
meaning: cim:ExcST7BUELselectorKind.noUELinput
outputHVgate:
meaning: cim:ExcST7BUELselectorKind.outputHVgate
ExcREXSFeedbackSignalKind:
enum_uri: cim:ExcREXSFeedbackSignalKind
description: 'Types of rate feedback signals. '
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.ExcitationSystemDynamics
permissible_values:
fieldCurrent:
meaning: cim:ExcREXSFeedbackSignalKind.fieldCurrent
fieldVoltage:
meaning: cim:ExcREXSFeedbackSignalKind.fieldVoltage
outputVoltage:
meaning: cim:ExcREXSFeedbackSignalKind.outputVoltage
InputSignalKind:
enum_uri: cim:InputSignalKind
description: Types of input signals. In dynamics modelling, commonly represented
by the j parameter.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.PowerSystemStabilizerDynamics
permissible_values:
branchCurrent:
meaning: cim:InputSignalKind.branchCurrent
busFrequency:
meaning: cim:InputSignalKind.busFrequency
busFrequencyDeviation:
meaning: cim:InputSignalKind.busFrequencyDeviation
busVoltage:
meaning: cim:InputSignalKind.busVoltage
busVoltageDerivative:
meaning: cim:InputSignalKind.busVoltageDerivative
fieldCurrent:
meaning: cim:InputSignalKind.fieldCurrent
generatorAcceleratingPower:
meaning: cim:InputSignalKind.generatorAcceleratingPower
generatorElectricalPower:
meaning: cim:InputSignalKind.generatorElectricalPower
generatorMechanicalPower:
meaning: cim:InputSignalKind.generatorMechanicalPower
rotorAngularFrequencyDeviation:
meaning: cim:InputSignalKind.rotorAngularFrequencyDeviation
rotorSpeed:
meaning: cim:InputSignalKind.rotorSpeed
WindLookupTableFunctionKind:
enum_uri: cim:WindLookupTableFunctionKind
description: Function of the lookup table.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.WindDynamics
permissible_values:
ipmax:
meaning: cim:WindLookupTableFunctionKind.ipmax
iqmax:
meaning: cim:WindLookupTableFunctionKind.iqmax
omegap:
meaning: cim:WindLookupTableFunctionKind.omegap
prr:
meaning: cim:WindLookupTableFunctionKind.prr
pwp:
meaning: cim:WindLookupTableFunctionKind.pwp
qmaxp:
meaning: cim:WindLookupTableFunctionKind.qmaxp
qmaxu:
meaning: cim:WindLookupTableFunctionKind.qmaxu
qminp:
meaning: cim:WindLookupTableFunctionKind.qminp
qminu:
meaning: cim:WindLookupTableFunctionKind.qminu
qwp:
meaning: cim:WindLookupTableFunctionKind.qwp
tcwdu:
meaning: cim:WindLookupTableFunctionKind.tcwdu
tduwt:
meaning: cim:WindLookupTableFunctionKind.tduwt
tfover:
meaning: cim:WindLookupTableFunctionKind.tfover
tfunder:
meaning: cim:WindLookupTableFunctionKind.tfunder
tuover:
meaning: cim:WindLookupTableFunctionKind.tuover
tuunder:
meaning: cim:WindLookupTableFunctionKind.tuunder
WindPlantQcontrolModeKind:
enum_uri: cim:WindPlantQcontrolModeKind
description: Reactive power/voltage controller mode.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.WindDynamics
permissible_values:
powerFactor:
meaning: cim:WindPlantQcontrolModeKind.powerFactor
reactivePower:
meaning: cim:WindPlantQcontrolModeKind.reactivePower
uqStatic:
meaning: cim:WindPlantQcontrolModeKind.uqStatic
voltageControl:
meaning: cim:WindPlantQcontrolModeKind.voltageControl
WindQcontrolModeKind:
enum_uri: cim:WindQcontrolModeKind
description: General wind turbine Q control modes MqG.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.WindDynamics
permissible_values:
openLooppowerFactor:
meaning: cim:WindQcontrolModeKind.openLooppowerFactor
openLoopReactivePower:
meaning: cim:WindQcontrolModeKind.openLoopReactivePower
powerFactor:
meaning: cim:WindQcontrolModeKind.powerFactor
reactivePower:
meaning: cim:WindQcontrolModeKind.reactivePower
voltage:
meaning: cim:WindQcontrolModeKind.voltage
WindUVRTQcontrolModeKind:
enum_uri: cim:WindUVRTQcontrolModeKind
description: UVRT Q control modes MqUVRT.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.WindDynamics
permissible_values:
mode0:
meaning: cim:WindUVRTQcontrolModeKind.mode0
mode1:
meaning: cim:WindUVRTQcontrolModeKind.mode1
mode2:
meaning: cim:WindUVRTQcontrolModeKind.mode2
GenericNonLinearLoadModelKind:
enum_uri: cim:GenericNonLinearLoadModelKind
description: Type of generic non-linear load model.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.LoadDynamics
permissible_values:
exponentialRecovery:
meaning: cim:GenericNonLinearLoadModelKind.exponentialRecovery
loadAdaptive:
meaning: cim:GenericNonLinearLoadModelKind.loadAdaptive
StaticLoadModelKind:
enum_uri: cim:StaticLoadModelKind
description: Type of static load model.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.LoadDynamics
permissible_values:
constantZ:
meaning: cim:StaticLoadModelKind.constantZ
exponential:
meaning: cim:StaticLoadModelKind.exponential
zIP1:
meaning: cim:StaticLoadModelKind.zIP1
zIP2:
meaning: cim:StaticLoadModelKind.zIP2
LookUpTableFunctionKind:
enum_uri: cim:LookUpTableFunctionKind
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Dynamics.StandardModels.InfHVDCDynamics
permissible_values:
additionalQcurrent:
meaning: cim:LookUpTableFunctionKind.additionalQcurrent
vdcol:
meaning: cim:LookUpTableFunctionKind.vdcol
TroubleCallKind:
enum_uri: cim:TroubleCallKind
description: Describes the type of Trouble, based on customer input.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Customers
permissible_values:
lineDown:
meaning: cim:TroubleCallKind.lineDown
powerOut:
meaning: cim:TroubleCallKind.powerOut
ZoneKind:
enum_uri: cim:ZoneKind
description: Kind of zone.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfLocations
permissible_values:
electricalNetwork:
meaning: cim:ZoneKind.electricalNetwork
other:
meaning: cim:ZoneKind.other
specialRestrictionLand:
meaning: cim:ZoneKind.specialRestrictionLand
weatherZone:
meaning: cim:ZoneKind.weatherZone
InspectionDiscreteKind:
enum_uri: cim:InspectionDiscreteKind
description: "Discretes representing breaker inspection result.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetMeas
permissible_values:
bushingOilLevelsOK:
meaning: cim:InspectionDiscreteKind.bushingOilLevelsOK
checkOilLevelOK:
meaning: cim:InspectionDiscreteKind.checkOilLevelOK
controlCabinetHeaterOn:
meaning: cim:InspectionDiscreteKind.controlCabinetHeaterOn
gasIndicatorNormal:
meaning: cim:InspectionDiscreteKind.gasIndicatorNormal
hydraulicFluidLevelOK:
meaning: cim:InspectionDiscreteKind.hydraulicFluidLevelOK
hydraulicOilLevelOK:
meaning: cim:InspectionDiscreteKind.hydraulicOilLevelOK
lowToHighPressureCount:
meaning: cim:InspectionDiscreteKind.lowToHighPressureCount
motorOperationsCount:
meaning: cim:InspectionDiscreteKind.motorOperationsCount
oilTankLevelsOK:
meaning: cim:InspectionDiscreteKind.oilTankLevelsOK
operationCount:
meaning: cim:InspectionDiscreteKind.operationCount
pumpMotorOperationCount:
meaning: cim:InspectionDiscreteKind.pumpMotorOperationCount
springPressureReadingOK:
meaning: cim:InspectionDiscreteKind.springPressureReadingOK
visibleDamageOrLeaks:
meaning: cim:InspectionDiscreteKind.visibleDamageOrLeaks
OilAnalysisMetalsAnalogKind:
enum_uri: cim:OilAnalysisMetalsAnalogKind
description: "Analogs representing oil metals and elements analysis result.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetMeas
permissible_values:
aluminum:
meaning: cim:OilAnalysisMetalsAnalogKind.aluminum
aluminumParticulate:
meaning: cim:OilAnalysisMetalsAnalogKind.aluminumParticulate
barium:
meaning: cim:OilAnalysisMetalsAnalogKind.barium
boron:
meaning: cim:OilAnalysisMetalsAnalogKind.boron
cadmium:
meaning: cim:OilAnalysisMetalsAnalogKind.cadmium
calcium:
meaning: cim:OilAnalysisMetalsAnalogKind.calcium
chromium:
meaning: cim:OilAnalysisMetalsAnalogKind.chromium
copper:
meaning: cim:OilAnalysisMetalsAnalogKind.copper
copperParticulate:
meaning: cim:OilAnalysisMetalsAnalogKind.copperParticulate
iron:
meaning: cim:OilAnalysisMetalsAnalogKind.iron
ironParticulate:
meaning: cim:OilAnalysisMetalsAnalogKind.ironParticulate
lead:
meaning: cim:OilAnalysisMetalsAnalogKind.lead
leadParticulate:
meaning: cim:OilAnalysisMetalsAnalogKind.leadParticulate
lithium:
meaning: cim:OilAnalysisMetalsAnalogKind.lithium
magnesium:
meaning: cim:OilAnalysisMetalsAnalogKind.magnesium
molybdenum:
meaning: cim:OilAnalysisMetalsAnalogKind.molybdenum
nickel:
meaning: cim:OilAnalysisMetalsAnalogKind.nickel
phosphorus:
meaning: cim:OilAnalysisMetalsAnalogKind.phosphorus
silicon:
meaning: cim:OilAnalysisMetalsAnalogKind.silicon
silver:
meaning: cim:OilAnalysisMetalsAnalogKind.silver
silverParticulate:
meaning: cim:OilAnalysisMetalsAnalogKind.silverParticulate
sodium:
meaning: cim:OilAnalysisMetalsAnalogKind.sodium
tin:
meaning: cim:OilAnalysisMetalsAnalogKind.tin
titanium:
meaning: cim:OilAnalysisMetalsAnalogKind.titanium
tungsten:
meaning: cim:OilAnalysisMetalsAnalogKind.tungsten
vanadium:
meaning: cim:OilAnalysisMetalsAnalogKind.vanadium
zinc:
meaning: cim:OilAnalysisMetalsAnalogKind.zinc
zincParticulate:
meaning: cim:OilAnalysisMetalsAnalogKind.zincParticulate
TestMethod:
enum_uri: cim:TestMethod
description: Possible test methods.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
permissible_values:
60567ByDisplacement:
meaning: cim:TestMethod.60567ByDisplacement
60567ByPartition:
meaning: cim:TestMethod.60567ByPartition
60567ByVacuum:
meaning: cim:TestMethod.60567ByVacuum
60970Automatic:
meaning: cim:TestMethod.60970Automatic
60970Manual1:
meaning: cim:TestMethod.60970Manual1
60970Manual2:
meaning: cim:TestMethod.60970Manual2
61125A:
meaning: cim:TestMethod.61125A
61125B:
meaning: cim:TestMethod.61125B
61125C:
meaning: cim:TestMethod.61125C
62270AnnexA:
meaning: cim:TestMethod.62270AnnexA
62535AnnexA:
meaning: cim:TestMethod.62535AnnexA
62535Main:
meaning: cim:TestMethod.62535Main
D1275A:
meaning: cim:TestMethod.D1275A
D1275B:
meaning: cim:TestMethod.D1275B
D3612A:
meaning: cim:TestMethod.D3612A
D3612B:
meaning: cim:TestMethod.D3612B
D3612C:
meaning: cim:TestMethod.D3612C
ASTMStandardEditionKind:
enum_uri: cim:ASTMStandardEditionKind
description: List of editions of ASTM standards.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
permissible_values:
00(2005):
meaning: cim:ASTMStandardEditionKind.00%282005%29
00(2005)e1:
meaning: cim:ASTMStandardEditionKind.00%282005%29e1
00(2010):
meaning: cim:ASTMStandardEditionKind.00%282010%29
'01':
meaning: cim:ASTMStandardEditionKind.01
01a(2007):
meaning: cim:ASTMStandardEditionKind.01a%282007%29
01e1:
meaning: cim:ASTMStandardEditionKind.01e1
'02':
meaning: cim:ASTMStandardEditionKind.02
02(2007):
meaning: cim:ASTMStandardEditionKind.02%282007%29
02(2008):
meaning: cim:ASTMStandardEditionKind.02%282008%29
02(2009):
meaning: cim:ASTMStandardEditionKind.02%282009%29
02(2012):
meaning: cim:ASTMStandardEditionKind.02%282012%29
02(2014):
meaning: cim:ASTMStandardEditionKind.02%282014%29
02a:
meaning: cim:ASTMStandardEditionKind.02a
02b:
meaning: cim:ASTMStandardEditionKind.02b
02e1:
meaning: cim:ASTMStandardEditionKind.02e1
'03':
meaning: cim:ASTMStandardEditionKind.03
03(2008):
meaning: cim:ASTMStandardEditionKind.03%282008%29
03(2014):
meaning: cim:ASTMStandardEditionKind.03%282014%29
03a:
meaning: cim:ASTMStandardEditionKind.03a
'04':
meaning: cim:ASTMStandardEditionKind.04
04a:
meaning: cim:ASTMStandardEditionKind.04a
04ae1:
meaning: cim:ASTMStandardEditionKind.04ae1
04e1:
meaning: cim:ASTMStandardEditionKind.04e1
04e2:
meaning: cim:ASTMStandardEditionKind.04e2
'05':
meaning: cim:ASTMStandardEditionKind.05
05(2010):
meaning: cim:ASTMStandardEditionKind.05%282010%29
05a:
meaning: cim:ASTMStandardEditionKind.05a
05a(2010):
meaning: cim:ASTMStandardEditionKind.05a%282010%29
'06':
meaning: cim:ASTMStandardEditionKind.06
'07':
meaning: cim:ASTMStandardEditionKind.07
07(2013):
meaning: cim:ASTMStandardEditionKind.07%282013%29
08:
meaning: cim:ASTMStandardEditionKind.08
08e1:
meaning: cim:ASTMStandardEditionKind.08e1
09:
meaning: cim:ASTMStandardEditionKind.09
09(2013):
meaning: cim:ASTMStandardEditionKind.09%282013%29
'10':
meaning: cim:ASTMStandardEditionKind.10
10a:
meaning: cim:ASTMStandardEditionKind.10a
'11':
meaning: cim:ASTMStandardEditionKind.11
11a:
meaning: cim:ASTMStandardEditionKind.11a
'12':
meaning: cim:ASTMStandardEditionKind.12
12a:
meaning: cim:ASTMStandardEditionKind.12a
12b:
meaning: cim:ASTMStandardEditionKind.12b
'13':
meaning: cim:ASTMStandardEditionKind.13
13e1:
meaning: cim:ASTMStandardEditionKind.13e1
'14':
meaning: cim:ASTMStandardEditionKind.14
14a:
meaning: cim:ASTMStandardEditionKind.14a
14e1:
meaning: cim:ASTMStandardEditionKind.14e1
14e2:
meaning: cim:ASTMStandardEditionKind.14e2
'15':
meaning: cim:ASTMStandardEditionKind.15
15a:
meaning: cim:ASTMStandardEditionKind.15a
'65':
meaning: cim:ASTMStandardEditionKind.65
'71':
meaning: cim:ASTMStandardEditionKind.71
'74':
meaning: cim:ASTMStandardEditionKind.74
80e1:
meaning: cim:ASTMStandardEditionKind.80e1
'82':
meaning: cim:ASTMStandardEditionKind.82
83(1996)e1:
meaning: cim:ASTMStandardEditionKind.83%281996%29e1
'85':
meaning: cim:ASTMStandardEditionKind.85
85(1990)e1:
meaning: cim:ASTMStandardEditionKind.85%281990%29e1
87(1995):
meaning: cim:ASTMStandardEditionKind.87%281995%29
87e1:
meaning: cim:ASTMStandardEditionKind.87e1
'88':
meaning: cim:ASTMStandardEditionKind.88
90e1:
meaning: cim:ASTMStandardEditionKind.90e1
'91':
meaning: cim:ASTMStandardEditionKind.91
'92':
meaning: cim:ASTMStandardEditionKind.92
'94':
meaning: cim:ASTMStandardEditionKind.94
94(1999):
meaning: cim:ASTMStandardEditionKind.94%281999%29
94(2004):
meaning: cim:ASTMStandardEditionKind.94%282004%29
94(2010):
meaning: cim:ASTMStandardEditionKind.94%282010%29
94e1:
meaning: cim:ASTMStandardEditionKind.94e1
'95':
meaning: cim:ASTMStandardEditionKind.95
95(2000)e1:
meaning: cim:ASTMStandardEditionKind.95%282000%29e1
'96':
meaning: cim:ASTMStandardEditionKind.96
96(2002)e1:
meaning: cim:ASTMStandardEditionKind.96%282002%29e1
96a:
meaning: cim:ASTMStandardEditionKind.96a
96e1:
meaning: cim:ASTMStandardEditionKind.96e1
'97':
meaning: cim:ASTMStandardEditionKind.97
97(2002):
meaning: cim:ASTMStandardEditionKind.97%282002%29
97(2003):
meaning: cim:ASTMStandardEditionKind.97%282003%29
97(2008):
meaning: cim:ASTMStandardEditionKind.97%282008%29
97a:
meaning: cim:ASTMStandardEditionKind.97a
97a(2004):
meaning: cim:ASTMStandardEditionKind.97a%282004%29
'98':
meaning: cim:ASTMStandardEditionKind.98
98a:
meaning: cim:ASTMStandardEditionKind.98a
'99':
meaning: cim:ASTMStandardEditionKind.99
99(2004)e1:
meaning: cim:ASTMStandardEditionKind.99%282004%29e1
99(2005):
meaning: cim:ASTMStandardEditionKind.99%282005%29
99(2009):
meaning: cim:ASTMStandardEditionKind.99%282009%29
99a:
meaning: cim:ASTMStandardEditionKind.99a
99a(2004):
meaning: cim:ASTMStandardEditionKind.99a%282004%29
99e1:
meaning: cim:ASTMStandardEditionKind.99e1
99e2:
meaning: cim:ASTMStandardEditionKind.99e2
none:
meaning: cim:ASTMStandardEditionKind.none
unknown:
meaning: cim:ASTMStandardEditionKind.unknown
ASTMStandardKind:
enum_uri: cim:ASTMStandardKind
description: List of ASTM standards.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
permissible_values:
D1169:
meaning: cim:ASTMStandardKind.D1169
D1275:
meaning: cim:ASTMStandardKind.D1275
D1298:
meaning: cim:ASTMStandardKind.D1298
D149:
meaning: cim:ASTMStandardKind.D149
D1500:
meaning: cim:ASTMStandardKind.D1500
D1524:
meaning: cim:ASTMStandardKind.D1524
D1533:
meaning: cim:ASTMStandardKind.D1533
D1816:
meaning: cim:ASTMStandardKind.D1816
D2029:
meaning: cim:ASTMStandardKind.D2029
D2112:
meaning: cim:ASTMStandardKind.D2112
D2129:
meaning: cim:ASTMStandardKind.D2129
D2140:
meaning: cim:ASTMStandardKind.D2140
D2144:
meaning: cim:ASTMStandardKind.D2144
D2668:
meaning: cim:ASTMStandardKind.D2668
D3612:
meaning: cim:ASTMStandardKind.D3612
D4052:
meaning: cim:ASTMStandardKind.D4052
D4059:
meaning: cim:ASTMStandardKind.D4059
D4230:
meaning: cim:ASTMStandardKind.D4230
D4243:
meaning: cim:ASTMStandardKind.D4243
D445:
meaning: cim:ASTMStandardKind.D445
D4768:
meaning: cim:ASTMStandardKind.D4768
D5837:
meaning: cim:ASTMStandardKind.D5837
D5853:
meaning: cim:ASTMStandardKind.D5853
D5949:
meaning: cim:ASTMStandardKind.D5949
D5950:
meaning: cim:ASTMStandardKind.D5950
D5985:
meaning: cim:ASTMStandardKind.D5985
D6304:
meaning: cim:ASTMStandardKind.D6304
D6749:
meaning: cim:ASTMStandardKind.D6749
D6786:
meaning: cim:ASTMStandardKind.D6786
D6892:
meaning: cim:ASTMStandardKind.D6892
D7151:
meaning: cim:ASTMStandardKind.D7151
D7346:
meaning: cim:ASTMStandardKind.D7346
D828:
meaning: cim:ASTMStandardKind.D828
D877:
meaning: cim:ASTMStandardKind.D877
D877/D877M:
meaning: cim:ASTMStandardKind.D877/D877M
D92:
meaning: cim:ASTMStandardKind.D92
D924:
meaning: cim:ASTMStandardKind.D924
D93:
meaning: cim:ASTMStandardKind.D93
D97:
meaning: cim:ASTMStandardKind.D97
D974:
meaning: cim:ASTMStandardKind.D974
CIGREStandardEditionKind:
enum_uri: cim:CIGREStandardEditionKind
description: List of editions for CIGRE standards.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
permissible_values:
'2000':
meaning: cim:CIGREStandardEditionKind.2000
none:
meaning: cim:CIGREStandardEditionKind.none
unknown:
meaning: cim:CIGREStandardEditionKind.unknown
CIGREStandardKind:
enum_uri: cim:CIGREStandardKind
description: List of CIGRE standards.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
permissible_values:
TB 170:
meaning: cim:CIGREStandardKind.TB%20170
DINStandardEditionKind:
enum_uri: cim:DINStandardEditionKind
description: List of editions for DIN standards.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
permissible_values:
'1985':
meaning: cim:DINStandardEditionKind.1985
none:
meaning: cim:DINStandardEditionKind.none
unknown:
meaning: cim:DINStandardEditionKind.unknown
DINStandardKind:
enum_uri: cim:DINStandardKind
description: List of DIN standards.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
permissible_values:
'51353':
meaning: cim:DINStandardKind.51353
DobleStandardEditionKind:
enum_uri: cim:DobleStandardEditionKind
description: List of editions for Doble standards.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
permissible_values:
none:
meaning: cim:DobleStandardEditionKind.none
unknown:
meaning: cim:DobleStandardEditionKind.unknown
DobleStandardKind:
enum_uri: cim:DobleStandardKind
description: List of Doble standards.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
permissible_values:
methanol:
meaning: cim:DobleStandardKind.methanol
EPAStandardEditionKind:
enum_uri: cim:EPAStandardEditionKind
description: List of editions for EPA standards.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
permissible_values:
A:
meaning: cim:EPAStandardEditionKind.A
none:
meaning: cim:EPAStandardEditionKind.none
unknown:
meaning: cim:EPAStandardEditionKind.unknown
EPAStandardKind:
enum_uri: cim:EPAStandardKind
description: List of EPA standards.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
permissible_values:
'8082':
meaning: cim:EPAStandardKind.8082
IECStandardEditionKind:
enum_uri: cim:IECStandardEditionKind
description: List of editions for IEC standards.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
permissible_values:
'1963':
meaning: cim:IECStandardEditionKind.1963
'1967':
meaning: cim:IECStandardEditionKind.1967
'1973':
meaning: cim:IECStandardEditionKind.1973
'1974':
meaning: cim:IECStandardEditionKind.1974
'1977':
meaning: cim:IECStandardEditionKind.1977
'1978':
meaning: cim:IECStandardEditionKind.1978
'1979':
meaning: cim:IECStandardEditionKind.1979
'1985':
meaning: cim:IECStandardEditionKind.1985
'1989':
meaning: cim:IECStandardEditionKind.1989
'1992':
meaning: cim:IECStandardEditionKind.1992
1992/AMD1:2004:
meaning: cim:IECStandardEditionKind.1992/AMD1%3A2004
1992/COR1:1992:
meaning: cim:IECStandardEditionKind.1992/COR1%3A1992
'1993':
meaning: cim:IECStandardEditionKind.1993
'1995':
meaning: cim:IECStandardEditionKind.1995
'1997':
meaning: cim:IECStandardEditionKind.1997
'1998':
meaning: cim:IECStandardEditionKind.1998
'2004':
meaning: cim:IECStandardEditionKind.2004
2004/AMD1:2007:
meaning: cim:IECStandardEditionKind.2004/AMD1%3A2007
2004/AMD1:2007CSV:
meaning: cim:IECStandardEditionKind.2004/AMD1%3A2007CSV
'2005':
meaning: cim:IECStandardEditionKind.2005
'2007':
meaning: cim:IECStandardEditionKind.2007
'2008':
meaning: cim:IECStandardEditionKind.2008
'2010':
meaning: cim:IECStandardEditionKind.2010
'2011':
meaning: cim:IECStandardEditionKind.2011
'2012':
meaning: cim:IECStandardEditionKind.2012
'2013':
meaning: cim:IECStandardEditionKind.2013
2013/COR:2013:
meaning: cim:IECStandardEditionKind.2013/COR%3A2013
none:
meaning: cim:IECStandardEditionKind.none
unknown:
meaning: cim:IECStandardEditionKind.unknown
IECStandardKind:
enum_uri: cim:IECStandardKind
description: List of IEC standards.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
permissible_values:
'60156':
meaning: cim:IECStandardKind.60156
60243-1:
meaning: cim:IECStandardKind.60243-1
60243-2:
meaning: cim:IECStandardKind.60243-2
60243-3:
meaning: cim:IECStandardKind.60243-3
'60247':
meaning: cim:IECStandardKind.60247
'60422':
meaning: cim:IECStandardKind.60422
'60450':
meaning: cim:IECStandardKind.60450
'60567':
meaning: cim:IECStandardKind.60567
'60666':
meaning: cim:IECStandardKind.60666
'60814':
meaning: cim:IECStandardKind.60814
'60970':
meaning: cim:IECStandardKind.60970
'60997':
meaning: cim:IECStandardKind.60997
'61125':
meaning: cim:IECStandardKind.61125
'61198':
meaning: cim:IECStandardKind.61198
'61619':
meaning: cim:IECStandardKind.61619
'61868':
meaning: cim:IECStandardKind.61868
'62535':
meaning: cim:IECStandardKind.62535
62697-1:
meaning: cim:IECStandardKind.62697-1
'62770':
meaning: cim:IECStandardKind.62770
IEEEStandardEditionKind:
enum_uri: cim:IEEEStandardEditionKind
description: List of editions for IEEE standards.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
permissible_values:
'1978':
meaning: cim:IEEEStandardEditionKind.1978
'1995':
meaning: cim:IEEEStandardEditionKind.1995
none:
meaning: cim:IEEEStandardEditionKind.none
unknown:
meaning: cim:IEEEStandardEditionKind.unknown
IEEEStandardKind:
enum_uri: cim:IEEEStandardKind
description: List of IEEE standards.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
permissible_values:
'62':
meaning: cim:IEEEStandardKind.62
ISOStandardEditionKind:
enum_uri: cim:ISOStandardEditionKind
description: List of editions for ISO standards.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
permissible_values:
'1973':
meaning: cim:ISOStandardEditionKind.1973
'1974':
meaning: cim:ISOStandardEditionKind.1974
'1976':
meaning: cim:ISOStandardEditionKind.1976
'1983':
meaning: cim:ISOStandardEditionKind.1983
'1985':
meaning: cim:ISOStandardEditionKind.1985
'1988':
meaning: cim:ISOStandardEditionKind.1988
'1992':
meaning: cim:ISOStandardEditionKind.1992
'1993':
meaning: cim:ISOStandardEditionKind.1993
'1994':
meaning: cim:ISOStandardEditionKind.1994
1994/Cor1:1997:
meaning: cim:ISOStandardEditionKind.1994/Cor1%3A1997
'1998':
meaning: cim:ISOStandardEditionKind.1998
'2000':
meaning: cim:ISOStandardEditionKind.2000
'2002':
meaning: cim:ISOStandardEditionKind.2002
'2005':
meaning: cim:ISOStandardEditionKind.2005
'2008':
meaning: cim:ISOStandardEditionKind.2008
none:
meaning: cim:ISOStandardEditionKind.none
unknown:
meaning: cim:ISOStandardEditionKind.unknown
ISOStandardKind:
enum_uri: cim:ISOStandardKind
description: List of ISO standards.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
permissible_values:
'1924':
meaning: cim:ISOStandardKind.1924
1924-1:
meaning: cim:ISOStandardKind.1924-1
1924-2:
meaning: cim:ISOStandardKind.1924-2
1924-3:
meaning: cim:ISOStandardKind.1924-3
'2592':
meaning: cim:ISOStandardKind.2592
'2719':
meaning: cim:ISOStandardKind.2719
'3016':
meaning: cim:ISOStandardKind.3016
'3104':
meaning: cim:ISOStandardKind.3104
'3675':
meaning: cim:ISOStandardKind.3675
LaborelecStandardEditionKind:
enum_uri: cim:LaborelecStandardEditionKind
description: List of editions for Laborelec standards.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
permissible_values:
none:
meaning: cim:LaborelecStandardEditionKind.none
unknown:
meaning: cim:LaborelecStandardEditionKind.unknown
LaborelecStandardKind:
enum_uri: cim:LaborelecStandardKind
description: List of Laborelec standards.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
permissible_values:
methanol:
meaning: cim:LaborelecStandardKind.methanol
TAPPIStandardEditionKind:
enum_uri: cim:TAPPIStandardEditionKind
description: List of editions for TAPPI standards.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
permissible_values:
'2009':
meaning: cim:TAPPIStandardEditionKind.2009
none:
meaning: cim:TAPPIStandardEditionKind.none
unknown:
meaning: cim:TAPPIStandardEditionKind.unknown
TAPPIStandardKind:
enum_uri: cim:TAPPIStandardKind
description: List of TAPPI standards.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
permissible_values:
T494:
meaning: cim:TAPPIStandardKind.T494
UKMinistryOfDefenceStandardEditionKind:
enum_uri: cim:UKMinistryOfDefenceStandardEditionKind
description: List of editions for UK Ministry of Defence standards.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
permissible_values:
Issue 1:
meaning: cim:UKMinistryOfDefenceStandardEditionKind.Issue%201
none:
meaning: cim:UKMinistryOfDefenceStandardEditionKind.none
unknown:
meaning: cim:UKMinistryOfDefenceStandardEditionKind.unknown
UKMinistryofDefenceStandardKind:
enum_uri: cim:UKMinistryofDefenceStandardKind
description: List of UK Ministry of Defence standards.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
permissible_values:
05-50 (Part 65):
meaning: cim:UKMinistryofDefenceStandardKind.05-50%20%28Part%2065%29
WEPStandardEditionKind:
enum_uri: cim:WEPStandardEditionKind
description: List of editions for WEP standards.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
permissible_values:
none:
meaning: cim:WEPStandardEditionKind.none
unknown:
meaning: cim:WEPStandardEditionKind.unknown
WEPStandardKind:
enum_uri: cim:WEPStandardKind
description: List of WEP standards.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
permissible_values:
12, 1254E:
meaning: cim:WEPStandardKind.12%2C%201254E
TestVariantKind:
enum_uri: cim:TestVariantKind
description: Test variants.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
permissible_values:
0C:
meaning: cim:TestVariantKind.0C
100C:
meaning: cim:TestVariantKind.100C
164hours:
meaning: cim:TestVariantKind.164hours
1mm:
meaning: cim:TestVariantKind.1mm
25C:
meaning: cim:TestVariantKind.25C
2mm:
meaning: cim:TestVariantKind.2mm
30C:
meaning: cim:TestVariantKind.30C
40C:
meaning: cim:TestVariantKind.40C
72hours:
meaning: cim:TestVariantKind.72hours
minus30C:
meaning: cim:TestVariantKind.minus30C
minus40C:
meaning: cim:TestVariantKind.minus40C
AssetStringKind:
enum_uri: cim:AssetStringKind
description: "Definition of type of string useful in asset domain.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetMeas
permissible_values:
visualExamRemarks:
meaning: cim:AssetStringKind.visualExamRemarks
OilAnalysisMoistureAnalogKind:
enum_uri: cim:OilAnalysisMoistureAnalogKind
description: "Analogs representing oil moisture analysis result.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetMeas
permissible_values:
dewPoint:
meaning: cim:OilAnalysisMoistureAnalogKind.dewPoint
relativeSaturation:
meaning: cim:OilAnalysisMoistureAnalogKind.relativeSaturation
relativeSaturationCalculated:
meaning: cim:OilAnalysisMoistureAnalogKind.relativeSaturationCalculated
waterContent:
meaning: cim:OilAnalysisMoistureAnalogKind.waterContent
waterContentMonitoredViaAluminumOxide:
meaning: cim:OilAnalysisMoistureAnalogKind.waterContentMonitoredViaAluminumOxide
waterContentMonitoredViaCapacitance:
meaning: cim:OilAnalysisMoistureAnalogKind.waterContentMonitoredViaCapacitance
waterContentMonitoredViaInfrared:
meaning: cim:OilAnalysisMoistureAnalogKind.waterContentMonitoredViaInfrared
waterContentMonitoredViaOther:
meaning: cim:OilAnalysisMoistureAnalogKind.waterContentMonitoredViaOther
InspectionAnalogKind:
enum_uri: cim:InspectionAnalogKind
description: "Analogs typically recorded during a field inspection.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetMeas
permissible_values:
airPressureHPSystemReading:
meaning: cim:InspectionAnalogKind.airPressureHPSystemReading
airPressureLPSystemReading:
meaning: cim:InspectionAnalogKind.airPressureLPSystemReading
airPressureReading:
meaning: cim:InspectionAnalogKind.airPressureReading
compressorHourMeterReading:
meaning: cim:InspectionAnalogKind.compressorHourMeterReading
sF6PressureReading:
meaning: cim:InspectionAnalogKind.sF6PressureReading
AssetTemperaturePressureAnalogKind:
enum_uri: cim:AssetTemperaturePressureAnalogKind
description: "Analogs representing temperatures or pressures related to assets.\r\
\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetMeas
permissible_values:
oilPressureAtValve:
meaning: cim:AssetTemperaturePressureAnalogKind.oilPressureAtValve
oilTemperatureAtValve:
meaning: cim:AssetTemperaturePressureAnalogKind.oilTemperatureAtValve
OilAnalysisPCBAnalogKind:
enum_uri: cim:OilAnalysisPCBAnalogKind
description: "Analogs representing oil PCB analysis result.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetMeas
permissible_values:
aroclor1016:
meaning: cim:OilAnalysisPCBAnalogKind.aroclor1016
aroclor1221:
meaning: cim:OilAnalysisPCBAnalogKind.aroclor1221
aroclor1242:
meaning: cim:OilAnalysisPCBAnalogKind.aroclor1242
aroclor1254:
meaning: cim:OilAnalysisPCBAnalogKind.aroclor1254
aroclor1260:
meaning: cim:OilAnalysisPCBAnalogKind.aroclor1260
totalPCB:
meaning: cim:OilAnalysisPCBAnalogKind.totalPCB
OilAnalysisFluidDiscreteKind:
enum_uri: cim:OilAnalysisFluidDiscreteKind
description: "Discretes representing oil fluid test analysis result.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetMeas
permissible_values:
colorNumber:
meaning: cim:OilAnalysisFluidDiscreteKind.colorNumber
colorNumberPlatinumCobaltScale:
meaning: cim:OilAnalysisFluidDiscreteKind.colorNumberPlatinumCobaltScale
corrosiveSulphurBy51353:
meaning: cim:OilAnalysisFluidDiscreteKind.corrosiveSulphurBy51353
corrosiveSulphurBy62535:
meaning: cim:OilAnalysisFluidDiscreteKind.corrosiveSulphurBy62535
corrosiveSulphurByD1275:
meaning: cim:OilAnalysisFluidDiscreteKind.corrosiveSulphurByD1275
sludgePrecipitation:
meaning: cim:OilAnalysisFluidDiscreteKind.sludgePrecipitation
tarnishLevel:
meaning: cim:OilAnalysisFluidDiscreteKind.tarnishLevel
OilAnalysisPCBDiscreteKind:
enum_uri: cim:OilAnalysisPCBDiscreteKind
description: "Discretes representing oil PCB test analysis result.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetMeas
permissible_values:
testKitPCB:
meaning: cim:OilAnalysisPCBDiscreteKind.testKitPCB
OilAnalysisParticleDiscreteKind:
enum_uri: cim:OilAnalysisParticleDiscreteKind
description: "Discretes representing oil particulate analysis result.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetMeas
permissible_values:
opacity:
meaning: cim:OilAnalysisParticleDiscreteKind.opacity
OilAnalysisFluidAnalogKind:
enum_uri: cim:OilAnalysisFluidAnalogKind
description: "Analogs representing oil fluid test analysis result.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetMeas
permissible_values:
acidNumber:
meaning: cim:OilAnalysisFluidAnalogKind.acidNumber
additiveDBDS:
meaning: cim:OilAnalysisFluidAnalogKind.additiveDBDS
aromatics:
meaning: cim:OilAnalysisFluidAnalogKind.aromatics
carbonyl:
meaning: cim:OilAnalysisFluidAnalogKind.carbonyl
density:
meaning: cim:OilAnalysisFluidAnalogKind.density
dielectricBreakdown:
meaning: cim:OilAnalysisFluidAnalogKind.dielectricBreakdown
dissipationFactor:
meaning: cim:OilAnalysisFluidAnalogKind.dissipationFactor
dissipationFactorPercent:
meaning: cim:OilAnalysisFluidAnalogKind.dissipationFactorPercent
duration61125MethodC:
meaning: cim:OilAnalysisFluidAnalogKind.duration61125MethodC
firePoint:
meaning: cim:OilAnalysisFluidAnalogKind.firePoint
flashPointClosedCup:
meaning: cim:OilAnalysisFluidAnalogKind.flashPointClosedCup
flashPointOpenCup:
meaning: cim:OilAnalysisFluidAnalogKind.flashPointOpenCup
inductionTime:
meaning: cim:OilAnalysisFluidAnalogKind.inductionTime
inhibitor61125MethodC:
meaning: cim:OilAnalysisFluidAnalogKind.inhibitor61125MethodC
interfacialTension:
meaning: cim:OilAnalysisFluidAnalogKind.interfacialTension
kinematicViscosity:
meaning: cim:OilAnalysisFluidAnalogKind.kinematicViscosity
oxidation:
meaning: cim:OilAnalysisFluidAnalogKind.oxidation
oxidationInhibitorD2668:
meaning: cim:OilAnalysisFluidAnalogKind.oxidationInhibitorD2668
oxidationInhibitorDBP:
meaning: cim:OilAnalysisFluidAnalogKind.oxidationInhibitorDBP
oxidationInhibitorDBPC:
meaning: cim:OilAnalysisFluidAnalogKind.oxidationInhibitorDBPC
passivatorBTA:
meaning: cim:OilAnalysisFluidAnalogKind.passivatorBTA
passivatorContent:
meaning: cim:OilAnalysisFluidAnalogKind.passivatorContent
passivatorIrgamet39:
meaning: cim:OilAnalysisFluidAnalogKind.passivatorIrgamet39
passivatorTTA:
meaning: cim:OilAnalysisFluidAnalogKind.passivatorTTA
petroleumOrigin:
meaning: cim:OilAnalysisFluidAnalogKind.petroleumOrigin
pourPoint:
meaning: cim:OilAnalysisFluidAnalogKind.pourPoint
pourPointAutomatic:
meaning: cim:OilAnalysisFluidAnalogKind.pourPointAutomatic
powerFactorPercent:
meaning: cim:OilAnalysisFluidAnalogKind.powerFactorPercent
resistivity:
meaning: cim:OilAnalysisFluidAnalogKind.resistivity
sedimentAndSludgePercent:
meaning: cim:OilAnalysisFluidAnalogKind.sedimentAndSludgePercent
sludge:
meaning: cim:OilAnalysisFluidAnalogKind.sludge
solubleAcids:
meaning: cim:OilAnalysisFluidAnalogKind.solubleAcids
specificGravity:
meaning: cim:OilAnalysisFluidAnalogKind.specificGravity
staticElectrification:
meaning: cim:OilAnalysisFluidAnalogKind.staticElectrification
totalAcids:
meaning: cim:OilAnalysisFluidAnalogKind.totalAcids
volatileAcids:
meaning: cim:OilAnalysisFluidAnalogKind.volatileAcids
OilAnalysisGasAnalogKind:
enum_uri: cim:OilAnalysisGasAnalogKind
description: "Analogs representing oil dissolved gas analysis result.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetMeas
permissible_values:
acetylene:
meaning: cim:OilAnalysisGasAnalogKind.acetylene
butane:
meaning: cim:OilAnalysisGasAnalogKind.butane
carbon:
meaning: cim:OilAnalysisGasAnalogKind.carbon
carbon3:
meaning: cim:OilAnalysisGasAnalogKind.carbon3
carbon4:
meaning: cim:OilAnalysisGasAnalogKind.carbon4
carbonDioxide:
meaning: cim:OilAnalysisGasAnalogKind.carbonDioxide
carbonMonoxide:
meaning: cim:OilAnalysisGasAnalogKind.carbonMonoxide
equivalentTCGPercent:
meaning: cim:OilAnalysisGasAnalogKind.equivalentTCGPercent
estimatedSafeHandlingLimit:
meaning: cim:OilAnalysisGasAnalogKind.estimatedSafeHandlingLimit
ethane:
meaning: cim:OilAnalysisGasAnalogKind.ethane
ethylene:
meaning: cim:OilAnalysisGasAnalogKind.ethylene
hydran:
meaning: cim:OilAnalysisGasAnalogKind.hydran
hydranPredicted:
meaning: cim:OilAnalysisGasAnalogKind.hydranPredicted
hydrogen:
meaning: cim:OilAnalysisGasAnalogKind.hydrogen
isobutane:
meaning: cim:OilAnalysisGasAnalogKind.isobutane
methane:
meaning: cim:OilAnalysisGasAnalogKind.methane
nitrogen:
meaning: cim:OilAnalysisGasAnalogKind.nitrogen
oxygen:
meaning: cim:OilAnalysisGasAnalogKind.oxygen
propane:
meaning: cim:OilAnalysisGasAnalogKind.propane
propene:
meaning: cim:OilAnalysisGasAnalogKind.propene
totalCombustibleGasPercent:
meaning: cim:OilAnalysisGasAnalogKind.totalCombustibleGasPercent
totalDissolvedCombustibleGas:
meaning: cim:OilAnalysisGasAnalogKind.totalDissolvedCombustibleGas
totalDissolvedGasPercent:
meaning: cim:OilAnalysisGasAnalogKind.totalDissolvedGasPercent
totalHeatGas:
meaning: cim:OilAnalysisGasAnalogKind.totalHeatGas
totalPartialPressure:
meaning: cim:OilAnalysisGasAnalogKind.totalPartialPressure
OilAnalysisParticleAnalogKind:
enum_uri: cim:OilAnalysisParticleAnalogKind
description: "Analogs representing oil particulate analysis result.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetMeas
permissible_values:
carbonPercent:
meaning: cim:OilAnalysisParticleAnalogKind.carbonPercent
count100Plus:
meaning: cim:OilAnalysisParticleAnalogKind.count100Plus
count10Plus:
meaning: cim:OilAnalysisParticleAnalogKind.count10Plus
count14Plus:
meaning: cim:OilAnalysisParticleAnalogKind.count14Plus
count15Plus:
meaning: cim:OilAnalysisParticleAnalogKind.count15Plus
count21Plus:
meaning: cim:OilAnalysisParticleAnalogKind.count21Plus
count25Plus:
meaning: cim:OilAnalysisParticleAnalogKind.count25Plus
count2Plus:
meaning: cim:OilAnalysisParticleAnalogKind.count2Plus
count38Plus:
meaning: cim:OilAnalysisParticleAnalogKind.count38Plus
count4Plus:
meaning: cim:OilAnalysisParticleAnalogKind.count4Plus
count50Plus:
meaning: cim:OilAnalysisParticleAnalogKind.count50Plus
count5Plus:
meaning: cim:OilAnalysisParticleAnalogKind.count5Plus
count6Plus:
meaning: cim:OilAnalysisParticleAnalogKind.count6Plus
count70Plus:
meaning: cim:OilAnalysisParticleAnalogKind.count70Plus
fibrePercent:
meaning: cim:OilAnalysisParticleAnalogKind.fibrePercent
metalPercent:
meaning: cim:OilAnalysisParticleAnalogKind.metalPercent
otherPercent:
meaning: cim:OilAnalysisParticleAnalogKind.otherPercent
OilAnalysisPaperAnalogKind:
enum_uri: cim:OilAnalysisPaperAnalogKind
description: "Analogs representing oil paper degradation analysis result.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetMeas
permissible_values:
acetylfuran:
meaning: cim:OilAnalysisPaperAnalogKind.acetylfuran
degreeOfPolymerization:
meaning: cim:OilAnalysisPaperAnalogKind.degreeOfPolymerization
degreeOfPolymerizationCalculated:
meaning: cim:OilAnalysisPaperAnalogKind.degreeOfPolymerizationCalculated
ethanol:
meaning: cim:OilAnalysisPaperAnalogKind.ethanol
furfural:
meaning: cim:OilAnalysisPaperAnalogKind.furfural
furfurylAlcohol:
meaning: cim:OilAnalysisPaperAnalogKind.furfurylAlcohol
hydroxymethylfurfural:
meaning: cim:OilAnalysisPaperAnalogKind.hydroxymethylfurfural
methanol:
meaning: cim:OilAnalysisPaperAnalogKind.methanol
methylfurfural:
meaning: cim:OilAnalysisPaperAnalogKind.methylfurfural
solidInsulationDielectricStrength:
meaning: cim:OilAnalysisPaperAnalogKind.solidInsulationDielectricStrength
tensileStrength:
meaning: cim:OilAnalysisPaperAnalogKind.tensileStrength
totalFuran:
meaning: cim:OilAnalysisPaperAnalogKind.totalFuran
FaultIndicatorResetKind:
enum_uri: cim:FaultIndicatorResetKind
description: Kind of resetting the fault indicators.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfAssetInfo
permissible_values:
automatic:
meaning: cim:FaultIndicatorResetKind.automatic
manual:
meaning: cim:FaultIndicatorResetKind.manual
other:
meaning: cim:FaultIndicatorResetKind.other
remote:
meaning: cim:FaultIndicatorResetKind.remote
RegulationBranchKind:
enum_uri: cim:RegulationBranchKind
description: Kind of regulation branch for shunt impedance.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfAssetInfo
permissible_values:
breaker:
meaning: cim:RegulationBranchKind.breaker
fuse:
meaning: cim:RegulationBranchKind.fuse
line:
meaning: cim:RegulationBranchKind.line
other:
meaning: cim:RegulationBranchKind.other
recloser:
meaning: cim:RegulationBranchKind.recloser
sectionner:
meaning: cim:RegulationBranchKind.sectionner
switch:
meaning: cim:RegulationBranchKind.switch
transformer:
meaning: cim:RegulationBranchKind.transformer
TransformerCoreKind:
enum_uri: cim:TransformerCoreKind
description: Kind of transformer construction.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfAssetInfo
permissible_values:
core:
meaning: cim:TransformerCoreKind.core
shell:
meaning: cim:TransformerCoreKind.shell
ShuntImpedanceLocalControlKind:
enum_uri: cim:ShuntImpedanceLocalControlKind
description: Kind of local control for shunt impedance.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfAssetInfo
permissible_values:
current:
meaning: cim:ShuntImpedanceLocalControlKind.current
none:
meaning: cim:ShuntImpedanceLocalControlKind.none
powerFactor:
meaning: cim:ShuntImpedanceLocalControlKind.powerFactor
reactivePower:
meaning: cim:ShuntImpedanceLocalControlKind.reactivePower
temperature:
meaning: cim:ShuntImpedanceLocalControlKind.temperature
time:
meaning: cim:ShuntImpedanceLocalControlKind.time
voltage:
meaning: cim:ShuntImpedanceLocalControlKind.voltage
TransformerConstructionKind:
enum_uri: cim:TransformerConstructionKind
description: Kind of transformer construction.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfAssetInfo
permissible_values:
aerial:
meaning: cim:TransformerConstructionKind.aerial
dryType:
meaning: cim:TransformerConstructionKind.dryType
network:
meaning: cim:TransformerConstructionKind.network
onePhase:
meaning: cim:TransformerConstructionKind.onePhase
overhead:
meaning: cim:TransformerConstructionKind.overhead
padmountDeadFront:
meaning: cim:TransformerConstructionKind.padmountDeadFront
padmounted:
meaning: cim:TransformerConstructionKind.padmounted
padmountFeedThrough:
meaning: cim:TransformerConstructionKind.padmountFeedThrough
padmountLiveFront:
meaning: cim:TransformerConstructionKind.padmountLiveFront
padmountLoopThrough:
meaning: cim:TransformerConstructionKind.padmountLoopThrough
subway:
meaning: cim:TransformerConstructionKind.subway
threePhase:
meaning: cim:TransformerConstructionKind.threePhase
underground:
meaning: cim:TransformerConstructionKind.underground
unknown:
meaning: cim:TransformerConstructionKind.unknown
vault:
meaning: cim:TransformerConstructionKind.vault
vaultThreePhase:
meaning: cim:TransformerConstructionKind.vaultThreePhase
TransformerFunctionKind:
enum_uri: cim:TransformerFunctionKind
description: Function of a transformer.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfAssetInfo
permissible_values:
autotransformer:
meaning: cim:TransformerFunctionKind.autotransformer
other:
meaning: cim:TransformerFunctionKind.other
powerTransformer:
meaning: cim:TransformerFunctionKind.powerTransformer
secondaryTransformer:
meaning: cim:TransformerFunctionKind.secondaryTransformer
voltageRegulator:
meaning: cim:TransformerFunctionKind.voltageRegulator
OilPreservationKind:
enum_uri: cim:OilPreservationKind
description: Kind of oil preservation.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfAssetInfo
permissible_values:
conservator:
meaning: cim:OilPreservationKind.conservator
freeBreathing:
meaning: cim:OilPreservationKind.freeBreathing
nitrogenBlanket:
meaning: cim:OilPreservationKind.nitrogenBlanket
other:
meaning: cim:OilPreservationKind.other
ShuntImpedanceControlKind:
enum_uri: cim:ShuntImpedanceControlKind
description: Kind of control for shunt impedance.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfAssetInfo
permissible_values:
fixed:
meaning: cim:ShuntImpedanceControlKind.fixed
localOnly:
meaning: cim:ShuntImpedanceControlKind.localOnly
remoteOnly:
meaning: cim:ShuntImpedanceControlKind.remoteOnly
remoteWithLocalOverride:
meaning: cim:ShuntImpedanceControlKind.remoteWithLocalOverride
CompositeSwitchKind:
enum_uri: cim:CompositeSwitchKind
description: Kind of composite switch.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfAssetInfo
permissible_values:
escoThrowOver:
meaning: cim:CompositeSwitchKind.escoThrowOver
gral:
meaning: cim:CompositeSwitchKind.gral
other:
meaning: cim:CompositeSwitchKind.other
ral:
meaning: cim:CompositeSwitchKind.ral
regulatorBypass:
meaning: cim:CompositeSwitchKind.regulatorBypass
throwOver:
meaning: cim:CompositeSwitchKind.throwOver
ugMultiSwitch:
meaning: cim:CompositeSwitchKind.ugMultiSwitch
WindingInsulationKind:
enum_uri: cim:WindingInsulationKind
description: Insulation kind for windings.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfAssetInfo
permissible_values:
nomex:
meaning: cim:WindingInsulationKind.nomex
other:
meaning: cim:WindingInsulationKind.other
paper:
meaning: cim:WindingInsulationKind.paper
thermallyUpgradedPaper:
meaning: cim:WindingInsulationKind.thermallyUpgradedPaper
AssetFailureClassification:
enum_uri: cim:AssetFailureClassification
description: Classifications of asset failures.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
permissible_values:
defect:
meaning: cim:AssetFailureClassification.defect
major:
meaning: cim:AssetFailureClassification.major
majorNeedsReplacement:
meaning: cim:AssetFailureClassification.majorNeedsReplacement
minor:
meaning: cim:AssetFailureClassification.minor
FailureIsolationMethodKind:
enum_uri: cim:FailureIsolationMethodKind
description: How the failure has been isolated.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
permissible_values:
breakerOperation:
meaning: cim:FailureIsolationMethodKind.breakerOperation
burnedInTheClear:
meaning: cim:FailureIsolationMethodKind.burnedInTheClear
fuse:
meaning: cim:FailureIsolationMethodKind.fuse
manuallyIsolated:
meaning: cim:FailureIsolationMethodKind.manuallyIsolated
other:
meaning: cim:FailureIsolationMethodKind.other
RiskScoreKind:
enum_uri: cim:RiskScoreKind
description: Types of risk scores.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
permissible_values:
customerRisk:
meaning: cim:RiskScoreKind.customerRisk
financialRisk:
meaning: cim:RiskScoreKind.financialRisk
safetyRisk:
meaning: cim:RiskScoreKind.safetyRisk
TransformerFailureReasonKind:
enum_uri: cim:TransformerFailureReasonKind
description: "Reason for transformer failure.\r\nNote: This enumeration provides\
\ essential information to asset health analytics. The existing list is a starting\
\ point and is anticipated to be fleshed out further as requirements are better\
\ understood. (PAB 2016/01/09)."
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
permissible_values:
bushingFailure:
meaning: cim:TransformerFailureReasonKind.bushingFailure
lossOfOil:
meaning: cim:TransformerFailureReasonKind.lossOfOil
oilRelatedFailure:
meaning: cim:TransformerFailureReasonKind.oilRelatedFailure
poorOilQuality:
meaning: cim:TransformerFailureReasonKind.poorOilQuality
BreakerFailureReasonKind:
enum_uri: cim:BreakerFailureReasonKind
description: "Reason for breaker failure.\r\nNote: This enumeration provides essential\
\ information to asset health analytics. The existing list is a starting point\
\ and is anticipated to be fleshed out further as requirements are better understood\
\ (PAB 2016/01/09)."
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
permissible_values:
blastValveFailure:
meaning: cim:BreakerFailureReasonKind.blastValveFailure
bushingFailure:
meaning: cim:BreakerFailureReasonKind.bushingFailure
closeCoilOpenShortedFailed:
meaning: cim:BreakerFailureReasonKind.closeCoilOpenShortedFailed
contaminatedAir:
meaning: cim:BreakerFailureReasonKind.contaminatedAir
contaminatedArcChutes:
meaning: cim:BreakerFailureReasonKind.contaminatedArcChutes
contaminatedGas:
meaning: cim:BreakerFailureReasonKind.contaminatedGas
contaminatedGasAir:
meaning: cim:BreakerFailureReasonKind.contaminatedGasAir
controlCircuitFailure:
meaning: cim:BreakerFailureReasonKind.controlCircuitFailure
degradedLubrication:
meaning: cim:BreakerFailureReasonKind.degradedLubrication
externalOrInternalContamination:
meaning: cim:BreakerFailureReasonKind.externalOrInternalContamination
highPressureAirPlant:
meaning: cim:BreakerFailureReasonKind.highPressureAirPlant
highResistanceLoadPath:
meaning: cim:BreakerFailureReasonKind.highResistanceLoadPath
highResistancePath:
meaning: cim:BreakerFailureReasonKind.highResistancePath
interrupterContactFailure:
meaning: cim:BreakerFailureReasonKind.interrupterContactFailure
interrupterFailure:
meaning: cim:BreakerFailureReasonKind.interrupterFailure
linkageFailure:
meaning: cim:BreakerFailureReasonKind.linkageFailure
lossOfOil:
meaning: cim:BreakerFailureReasonKind.lossOfOil
lossOfVacuum:
meaning: cim:BreakerFailureReasonKind.lossOfVacuum
lowGasPressure:
meaning: cim:BreakerFailureReasonKind.lowGasPressure
mechanismFailure:
meaning: cim:BreakerFailureReasonKind.mechanismFailure
mechanismOrLinkageFailure:
meaning: cim:BreakerFailureReasonKind.mechanismOrLinkageFailure
oilRelatedFailure:
meaning: cim:BreakerFailureReasonKind.oilRelatedFailure
poorOilQuality:
meaning: cim:BreakerFailureReasonKind.poorOilQuality
rackingMechanismFailure:
meaning: cim:BreakerFailureReasonKind.rackingMechanismFailure
resistorFailure:
meaning: cim:BreakerFailureReasonKind.resistorFailure
resistorGradingCapacitorFailure:
meaning: cim:BreakerFailureReasonKind.resistorGradingCapacitorFailure
SF6BlastValveFailure:
meaning: cim:BreakerFailureReasonKind.SF6BlastValveFailure
SF6PufferFailure:
meaning: cim:BreakerFailureReasonKind.SF6PufferFailure
solidDielectricFailure:
meaning: cim:BreakerFailureReasonKind.solidDielectricFailure
storedEnergyFailure:
meaning: cim:BreakerFailureReasonKind.storedEnergyFailure
tripCoilOpenShortedFailed:
meaning: cim:BreakerFailureReasonKind.tripCoilOpenShortedFailed
AssetFailureMode:
enum_uri: cim:AssetFailureMode
description: "What asset has failed to be able to do.\r\nReason for breaker failure.\r\
\nNote: This enumeration provides essential information to asset health analytics.\
\ The existing list is a starting point and is anticipated to be fleshed out\
\ further as requirements are better understood (PAB 2016/01/09)."
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
permissible_values:
failToCarryLoad:
meaning: cim:AssetFailureMode.failToCarryLoad
failToClose:
meaning: cim:AssetFailureMode.failToClose
failToInterrupt:
meaning: cim:AssetFailureMode.failToInterrupt
failToOpen:
meaning: cim:AssetFailureMode.failToOpen
failToProvideInsulationLevel:
meaning: cim:AssetFailureMode.failToProvideInsulationLevel
StreetlightLampKind:
enum_uri: cim:StreetlightLampKind
description: Kind of lamp for the streetlight.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfAssets
permissible_values:
highPressureSodium:
meaning: cim:StreetlightLampKind.highPressureSodium
mercuryVapor:
meaning: cim:StreetlightLampKind.mercuryVapor
metalHalide:
meaning: cim:StreetlightLampKind.metalHalide
other:
meaning: cim:StreetlightLampKind.other
PoleBaseKind:
enum_uri: cim:PoleBaseKind
description: Kind of base for poles.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfAssets
permissible_values:
asphalt:
meaning: cim:PoleBaseKind.asphalt
cement:
meaning: cim:PoleBaseKind.cement
dirt:
meaning: cim:PoleBaseKind.dirt
other:
meaning: cim:PoleBaseKind.other
unknown:
meaning: cim:PoleBaseKind.unknown
PolePreservativeKind:
enum_uri: cim:PolePreservativeKind
description: Preservative kind for poles.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfAssets
permissible_values:
cellon:
meaning: cim:PolePreservativeKind.cellon
chemonite:
meaning: cim:PolePreservativeKind.chemonite
creosote:
meaning: cim:PolePreservativeKind.creosote
naphthena:
meaning: cim:PolePreservativeKind.naphthena
other:
meaning: cim:PolePreservativeKind.other
penta:
meaning: cim:PolePreservativeKind.penta
unknown:
meaning: cim:PolePreservativeKind.unknown
PoleTreatmentKind:
enum_uri: cim:PoleTreatmentKind
description: Kind of treatment for poles.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfAssets
permissible_values:
butt:
meaning: cim:PoleTreatmentKind.butt
full:
meaning: cim:PoleTreatmentKind.full
grayStain:
meaning: cim:PoleTreatmentKind.grayStain
greenStain:
meaning: cim:PoleTreatmentKind.greenStain
natural:
meaning: cim:PoleTreatmentKind.natural
other:
meaning: cim:PoleTreatmentKind.other
penta:
meaning: cim:PoleTreatmentKind.penta
unknown:
meaning: cim:PoleTreatmentKind.unknown
TestReason:
enum_uri: cim:TestReason
description: Reason for test.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
permissible_values:
postOilTreatment:
meaning: cim:TestReason.postOilTreatment
postOperationFault:
meaning: cim:TestReason.postOperationFault
postRepair:
meaning: cim:TestReason.postRepair
routine:
meaning: cim:TestReason.routine
OilSampleLocation:
enum_uri: cim:OilSampleLocation
description: "Locations where oil can be sampled.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
permissible_values:
oilDrainageDevice:
meaning: cim:OilSampleLocation.oilDrainageDevice
oilSampleValve:
meaning: cim:OilSampleLocation.oilSampleValve
other:
meaning: cim:OilSampleLocation.other
OilTemperatureSource:
enum_uri: cim:OilTemperatureSource
description: Sources for oil temperature.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
permissible_values:
infraredGun:
meaning: cim:OilTemperatureSource.infraredGun
other:
meaning: cim:OilTemperatureSource.other
topOilTemperatureGauge:
meaning: cim:OilTemperatureSource.topOilTemperatureGauge
SampleContainerType:
enum_uri: cim:SampleContainerType
description: "Types of sample containers.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Assets
permissible_values:
glassCan:
meaning: cim:SampleContainerType.glassCan
metalCan:
meaning: cim:SampleContainerType.metalCan
syringe:
meaning: cim:SampleContainerType.syringe
FACTSDeviceKind:
enum_uri: cim:FACTSDeviceKind
description: Kind of FACTS device.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfAssets
permissible_values:
statcom:
meaning: cim:FACTSDeviceKind.statcom
svc:
meaning: cim:FACTSDeviceKind.svc
tcpar:
meaning: cim:FACTSDeviceKind.tcpar
tcsc:
meaning: cim:FACTSDeviceKind.tcsc
tcvl:
meaning: cim:FACTSDeviceKind.tcvl
tsbr:
meaning: cim:FACTSDeviceKind.tsbr
tssc:
meaning: cim:FACTSDeviceKind.tssc
upfc:
meaning: cim:FACTSDeviceKind.upfc
JointConfigurationKind:
enum_uri: cim:JointConfigurationKind
description: Kind of configuration for joints.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfAssets
permissible_values:
other:
meaning: cim:JointConfigurationKind.other
wires1to1:
meaning: cim:JointConfigurationKind.wires1to1
wires2to1:
meaning: cim:JointConfigurationKind.wires2to1
wires3to1:
meaning: cim:JointConfigurationKind.wires3to1
JointFillKind:
enum_uri: cim:JointFillKind
description: Kind of fill for Joint.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfAssets
permissible_values:
airNoFilling:
meaning: cim:JointFillKind.airNoFilling
asphaltic:
meaning: cim:JointFillKind.asphaltic
bluefill254:
meaning: cim:JointFillKind.bluefill254
epoxy:
meaning: cim:JointFillKind.epoxy
insoluseal:
meaning: cim:JointFillKind.insoluseal
noFillPrefab:
meaning: cim:JointFillKind.noFillPrefab
noVoid:
meaning: cim:JointFillKind.noVoid
oil:
meaning: cim:JointFillKind.oil
other:
meaning: cim:JointFillKind.other
petrolatum:
meaning: cim:JointFillKind.petrolatum
TransformerRepairItemKind:
enum_uri: cim:TransformerRepairItemKind
description: "Transformer components and problem areas which can be the focus\
\ of a repair work task.\r\nWorkTimeScheduleKind enumeration\r\nKind of work\
\ schedule."
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Work
TransformerMaintenanceKind:
enum_uri: cim:TransformerMaintenanceKind
description: "Kinds of transformer maintenance.\r\nBreakerMaintenanceKind enumeration\r\
\nPossible types of breaker maintenance work."
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Work
BreakerMaintenanceKind:
enum_uri: cim:BreakerMaintenanceKind
description: Possible types of breaker maintenance work.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Work
permissible_values:
externalOutOfService:
meaning: cim:BreakerMaintenanceKind.externalOutOfService
internalOutOfService:
meaning: cim:BreakerMaintenanceKind.internalOutOfService
interrupterOverhaul:
meaning: cim:BreakerMaintenanceKind.interrupterOverhaul
BreakerRepairItemKind:
enum_uri: cim:BreakerRepairItemKind
description: Breaker components and problem areas which can be the focus of a
repair work task.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Work
permissible_values:
airCompressor:
meaning: cim:BreakerRepairItemKind.airCompressor
auxiliarySwitchAndLinkage:
meaning: cim:BreakerRepairItemKind.auxiliarySwitchAndLinkage
busConnection:
meaning: cim:BreakerRepairItemKind.busConnection
checkValve:
meaning: cim:BreakerRepairItemKind.checkValve
closeCoil:
meaning: cim:BreakerRepairItemKind.closeCoil
contactor:
meaning: cim:BreakerRepairItemKind.contactor
controlCircuit:
meaning: cim:BreakerRepairItemKind.controlCircuit
corrosion:
meaning: cim:BreakerRepairItemKind.corrosion
gasDensitySupervision:
meaning: cim:BreakerRepairItemKind.gasDensitySupervision
heaterOrThermostat:
meaning: cim:BreakerRepairItemKind.heaterOrThermostat
hydraulicFluidLeak:
meaning: cim:BreakerRepairItemKind.hydraulicFluidLeak
interrupterAssembly:
meaning: cim:BreakerRepairItemKind.interrupterAssembly
other:
meaning: cim:BreakerRepairItemKind.other
positionIndicator:
meaning: cim:BreakerRepairItemKind.positionIndicator
pressureSwitch:
meaning: cim:BreakerRepairItemKind.pressureSwitch
pumpOrMotor:
meaning: cim:BreakerRepairItemKind.pumpOrMotor
relay:
meaning: cim:BreakerRepairItemKind.relay
SF6GasLeak:
meaning: cim:BreakerRepairItemKind.SF6GasLeak
storedEnergySystem:
meaning: cim:BreakerRepairItemKind.storedEnergySystem
tripCoil:
meaning: cim:BreakerRepairItemKind.tripCoil
tripControlValve:
meaning: cim:BreakerRepairItemKind.tripControlValve
wiring:
meaning: cim:BreakerRepairItemKind.wiring
VehicleUsageKind:
enum_uri: cim:VehicleUsageKind
description: Usage of a vehicle.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Work
permissible_values:
contractor:
meaning: cim:VehicleUsageKind.contractor
crew:
meaning: cim:VehicleUsageKind.crew
other:
meaning: cim:VehicleUsageKind.other
user:
meaning: cim:VehicleUsageKind.user
ComDirectionKind:
enum_uri: cim:ComDirectionKind
description: "Kind of communication direction.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
permissible_values:
biDirectional:
meaning: cim:ComDirectionKind.biDirectional
fromDevice:
meaning: cim:ComDirectionKind.fromDevice
toDevice:
meaning: cim:ComDirectionKind.toDevice
ComTechnologyKind:
enum_uri: cim:ComTechnologyKind
description: "Kind of communication technology.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
permissible_values:
cellular:
meaning: cim:ComTechnologyKind.cellular
ethernet:
meaning: cim:ComTechnologyKind.ethernet
homePlug:
meaning: cim:ComTechnologyKind.homePlug
pager:
meaning: cim:ComTechnologyKind.pager
phone:
meaning: cim:ComTechnologyKind.phone
plc:
meaning: cim:ComTechnologyKind.plc
rf:
meaning: cim:ComTechnologyKind.rf
rfMesh:
meaning: cim:ComTechnologyKind.rfMesh
zigbee:
meaning: cim:ComTechnologyKind.zigbee
EndDeviceFunctionKind:
enum_uri: cim:EndDeviceFunctionKind
description: "Kind of end device function.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
permissible_values:
autonomousDst:
meaning: cim:EndDeviceFunctionKind.autonomousDst
demandResponse:
meaning: cim:EndDeviceFunctionKind.demandResponse
electricMetering:
meaning: cim:EndDeviceFunctionKind.electricMetering
gasMetering:
meaning: cim:EndDeviceFunctionKind.gasMetering
metrology:
meaning: cim:EndDeviceFunctionKind.metrology
onRequestRead:
meaning: cim:EndDeviceFunctionKind.onRequestRead
outageHistory:
meaning: cim:EndDeviceFunctionKind.outageHistory
relaysProgramming:
meaning: cim:EndDeviceFunctionKind.relaysProgramming
reverseFlow:
meaning: cim:EndDeviceFunctionKind.reverseFlow
waterMetering:
meaning: cim:EndDeviceFunctionKind.waterMetering
TransmissionModeKind:
enum_uri: cim:TransmissionModeKind
description: 'Transmission mode for end device display controls, applicable to
premises area network (PAN) devices. '
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
permissible_values:
anonymous:
meaning: cim:TransmissionModeKind.anonymous
both:
meaning: cim:TransmissionModeKind.both
normal:
meaning: cim:TransmissionModeKind.normal
MeasurementKind-Old:
enum_uri: cim:MeasurementKind-Old
description: Kind of read / measured value.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Metering
permissible_values:
alarm:
meaning: cim:MeasurementKind-Old.alarm
apparentPowerFactor:
meaning: cim:MeasurementKind-Old.apparentPowerFactor
applicationContext:
meaning: cim:MeasurementKind-Old.applicationContext
apTitle:
meaning: cim:MeasurementKind-Old.apTitle
assetNumber:
meaning: cim:MeasurementKind-Old.assetNumber
audibleVolume:
meaning: cim:MeasurementKind-Old.audibleVolume
bandwidth:
meaning: cim:MeasurementKind-Old.bandwidth
batteryCarryover:
meaning: cim:MeasurementKind-Old.batteryCarryover
batteryVoltage:
meaning: cim:MeasurementKind-Old.batteryVoltage
billCarryover:
meaning: cim:MeasurementKind-Old.billCarryover
billLastPeriod:
meaning: cim:MeasurementKind-Old.billLastPeriod
billToDate:
meaning: cim:MeasurementKind-Old.billToDate
broadcastAddress:
meaning: cim:MeasurementKind-Old.broadcastAddress
connectionFee:
meaning: cim:MeasurementKind-Old.connectionFee
currency:
meaning: cim:MeasurementKind-Old.currency
current:
meaning: cim:MeasurementKind-Old.current
currentAngle:
meaning: cim:MeasurementKind-Old.currentAngle
currentImbalance:
meaning: cim:MeasurementKind-Old.currentImbalance
dataOverflowAlarm:
meaning: cim:MeasurementKind-Old.dataOverflowAlarm
date:
meaning: cim:MeasurementKind-Old.date
demand:
meaning: cim:MeasurementKind-Old.demand
demandLimit:
meaning: cim:MeasurementKind-Old.demandLimit
demandReset:
meaning: cim:MeasurementKind-Old.demandReset
deviceAddressType1:
meaning: cim:MeasurementKind-Old.deviceAddressType1
deviceAddressType2:
meaning: cim:MeasurementKind-Old.deviceAddressType2
deviceAddressType3:
meaning: cim:MeasurementKind-Old.deviceAddressType3
deviceAddressType4:
meaning: cim:MeasurementKind-Old.deviceAddressType4
deviceClass:
meaning: cim:MeasurementKind-Old.deviceClass
diagnostic:
meaning: cim:MeasurementKind-Old.diagnostic
distance:
meaning: cim:MeasurementKind-Old.distance
distortionPowerFactor:
meaning: cim:MeasurementKind-Old.distortionPowerFactor
distortionVoltAmp:
meaning: cim:MeasurementKind-Old.distortionVoltAmp
electronicSerialNumber:
meaning: cim:MeasurementKind-Old.electronicSerialNumber
emergencyLimit:
meaning: cim:MeasurementKind-Old.emergencyLimit
encoderTamper:
meaning: cim:MeasurementKind-Old.encoderTamper
endDeviceID:
meaning: cim:MeasurementKind-Old.endDeviceID
energization:
meaning: cim:MeasurementKind-Old.energization
energizationLoadSide:
meaning: cim:MeasurementKind-Old.energizationLoadSide
energy:
meaning: cim:MeasurementKind-Old.energy
fan:
meaning: cim:MeasurementKind-Old.fan
frequency:
meaning: cim:MeasurementKind-Old.frequency
frequencyExcursion:
meaning: cim:MeasurementKind-Old.frequencyExcursion
fund:
meaning: cim:MeasurementKind-Old.fund
groupAddressType1:
meaning: cim:MeasurementKind-Old.groupAddressType1
groupAddressType2:
meaning: cim:MeasurementKind-Old.groupAddressType2
groupAddressType3:
meaning: cim:MeasurementKind-Old.groupAddressType3
groupAddressType4:
meaning: cim:MeasurementKind-Old.groupAddressType4
ieee1366ASAI:
meaning: cim:MeasurementKind-Old.ieee1366ASAI
ieee1366ASIDI:
meaning: cim:MeasurementKind-Old.ieee1366ASIDI
ieee1366ASIFI:
meaning: cim:MeasurementKind-Old.ieee1366ASIFI
ieee1366CAIDI:
meaning: cim:MeasurementKind-Old.ieee1366CAIDI
ieee1366CAIFI:
meaning: cim:MeasurementKind-Old.ieee1366CAIFI
ieee1366CEMIn:
meaning: cim:MeasurementKind-Old.ieee1366CEMIn
ieee1366CEMSMIn:
meaning: cim:MeasurementKind-Old.ieee1366CEMSMIn
ieee1366CTAIDI:
meaning: cim:MeasurementKind-Old.ieee1366CTAIDI
ieee1366MAIFI:
meaning: cim:MeasurementKind-Old.ieee1366MAIFI
ieee1366MAIFIe:
meaning: cim:MeasurementKind-Old.ieee1366MAIFIe
ieee1366MomentaryInterruption:
meaning: cim:MeasurementKind-Old.ieee1366MomentaryInterruption
ieee1366MomentaryInterruptionEvent:
meaning: cim:MeasurementKind-Old.ieee1366MomentaryInterruptionEvent
ieee1366SAIDI:
meaning: cim:MeasurementKind-Old.ieee1366SAIDI
ieee1366SAIFI:
meaning: cim:MeasurementKind-Old.ieee1366SAIFI
ieee1366SustainedInterruption:
meaning: cim:MeasurementKind-Old.ieee1366SustainedInterruption
interruptionBehaviour:
meaning: cim:MeasurementKind-Old.interruptionBehaviour
inversionTamper:
meaning: cim:MeasurementKind-Old.inversionTamper
ipAddress:
meaning: cim:MeasurementKind-Old.ipAddress
lineLoss:
meaning: cim:MeasurementKind-Old.lineLoss
loadInterrupt:
meaning: cim:MeasurementKind-Old.loadInterrupt
loadShed:
meaning: cim:MeasurementKind-Old.loadShed
loss:
meaning: cim:MeasurementKind-Old.loss
macAddress:
meaning: cim:MeasurementKind-Old.macAddress
maintenance:
meaning: cim:MeasurementKind-Old.maintenance
mfgAssignedConfigurationID:
meaning: cim:MeasurementKind-Old.mfgAssignedConfigurationID
mfgAssignedPhysicalSerialNumber:
meaning: cim:MeasurementKind-Old.mfgAssignedPhysicalSerialNumber
mfgAssignedProductNumber:
meaning: cim:MeasurementKind-Old.mfgAssignedProductNumber
mfgAssignedUniqueCommunicationAddress:
meaning: cim:MeasurementKind-Old.mfgAssignedUniqueCommunicationAddress
multiCastAddress:
meaning: cim:MeasurementKind-Old.multiCastAddress
negativeSequence:
meaning: cim:MeasurementKind-Old.negativeSequence
none:
meaning: cim:MeasurementKind-Old.none
oneWayAddress:
meaning: cim:MeasurementKind-Old.oneWayAddress
phasorPowerFactor:
meaning: cim:MeasurementKind-Old.phasorPowerFactor
phasorReactivePower:
meaning: cim:MeasurementKind-Old.phasorReactivePower
physicalTamper:
meaning: cim:MeasurementKind-Old.physicalTamper
positiveSequence:
meaning: cim:MeasurementKind-Old.positiveSequence
power:
meaning: cim:MeasurementKind-Old.power
powerFactor:
meaning: cim:MeasurementKind-Old.powerFactor
powerLossTamper:
meaning: cim:MeasurementKind-Old.powerLossTamper
powerOutage:
meaning: cim:MeasurementKind-Old.powerOutage
powerQuality:
meaning: cim:MeasurementKind-Old.powerQuality
powerRestoration:
meaning: cim:MeasurementKind-Old.powerRestoration
programmed:
meaning: cim:MeasurementKind-Old.programmed
pushbutton:
meaning: cim:MeasurementKind-Old.pushbutton
quantityPower:
meaning: cim:MeasurementKind-Old.quantityPower
relayActivation:
meaning: cim:MeasurementKind-Old.relayActivation
relayCycle:
meaning: cim:MeasurementKind-Old.relayCycle
removalTamper:
meaning: cim:MeasurementKind-Old.removalTamper
reprogrammingTamper:
meaning: cim:MeasurementKind-Old.reprogrammingTamper
reverseRotationTamper:
meaning: cim:MeasurementKind-Old.reverseRotationTamper
sag:
meaning: cim:MeasurementKind-Old.sag
signalStrength:
meaning: cim:MeasurementKind-Old.signalStrength
signaltoNoiseRatio:
meaning: cim:MeasurementKind-Old.signaltoNoiseRatio
swell:
meaning: cim:MeasurementKind-Old.swell
switchArmed:
meaning: cim:MeasurementKind-Old.switchArmed
switchDisabled:
meaning: cim:MeasurementKind-Old.switchDisabled
switchPosition:
meaning: cim:MeasurementKind-Old.switchPosition
tamper:
meaning: cim:MeasurementKind-Old.tamper
tapPosition:
meaning: cim:MeasurementKind-Old.tapPosition
tariffRate:
meaning: cim:MeasurementKind-Old.tariffRate
temperature:
meaning: cim:MeasurementKind-Old.temperature
totalHarmonicDistortion:
meaning: cim:MeasurementKind-Old.totalHarmonicDistortion
transformerLoss:
meaning: cim:MeasurementKind-Old.transformerLoss
twoWayAddress:
meaning: cim:MeasurementKind-Old.twoWayAddress
unipedeVoltageDip10to15:
meaning: cim:MeasurementKind-Old.unipedeVoltageDip10to15
unipedeVoltageDip15to30:
meaning: cim:MeasurementKind-Old.unipedeVoltageDip15to30
unipedeVoltageDip30to60:
meaning: cim:MeasurementKind-Old.unipedeVoltageDip30to60
unipedeVoltageDip60to90:
meaning: cim:MeasurementKind-Old.unipedeVoltageDip60to90
unipedeVoltageDip90to100:
meaning: cim:MeasurementKind-Old.unipedeVoltageDip90to100
voltage:
meaning: cim:MeasurementKind-Old.voltage
voltageAngle:
meaning: cim:MeasurementKind-Old.voltageAngle
voltageExcursion:
meaning: cim:MeasurementKind-Old.voltageExcursion
voltageImbalance:
meaning: cim:MeasurementKind-Old.voltageImbalance
volume:
meaning: cim:MeasurementKind-Old.volume
volumetricFlow:
meaning: cim:MeasurementKind-Old.volumetricFlow
watchdogTimeout:
meaning: cim:MeasurementKind-Old.watchdogTimeout
zeroFlowDuration:
meaning: cim:MeasurementKind-Old.zeroFlowDuration
zeroSequence:
meaning: cim:MeasurementKind-Old.zeroSequence
CableConstructionKind:
enum_uri: cim:CableConstructionKind
description: Kind of cable construction.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetInfo
permissible_values:
compacted:
meaning: cim:CableConstructionKind.compacted
compressed:
meaning: cim:CableConstructionKind.compressed
other:
meaning: cim:CableConstructionKind.other
sector:
meaning: cim:CableConstructionKind.sector
segmental:
meaning: cim:CableConstructionKind.segmental
solid:
meaning: cim:CableConstructionKind.solid
stranded:
meaning: cim:CableConstructionKind.stranded
CableOuterJacketKind:
enum_uri: cim:CableOuterJacketKind
description: Kind of cable outer jacket.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetInfo
permissible_values:
insulating:
meaning: cim:CableOuterJacketKind.insulating
linearLowDensityPolyethylene:
meaning: cim:CableOuterJacketKind.linearLowDensityPolyethylene
none:
meaning: cim:CableOuterJacketKind.none
other:
meaning: cim:CableOuterJacketKind.other
polyethylene:
meaning: cim:CableOuterJacketKind.polyethylene
pvc:
meaning: cim:CableOuterJacketKind.pvc
semiconducting:
meaning: cim:CableOuterJacketKind.semiconducting
CableShieldMaterialKind:
enum_uri: cim:CableShieldMaterialKind
description: Kind of cable shield material.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetInfo
permissible_values:
aluminum:
meaning: cim:CableShieldMaterialKind.aluminum
copper:
meaning: cim:CableShieldMaterialKind.copper
lead:
meaning: cim:CableShieldMaterialKind.lead
other:
meaning: cim:CableShieldMaterialKind.other
steel:
meaning: cim:CableShieldMaterialKind.steel
OperatingMechanismKind:
enum_uri: cim:OperatingMechanismKind
description: Kinds of operating mechanisms.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetInfo
permissible_values:
capacitorTrip:
meaning: cim:OperatingMechanismKind.capacitorTrip
hydraulic:
meaning: cim:OperatingMechanismKind.hydraulic
pneudraulic:
meaning: cim:OperatingMechanismKind.pneudraulic
pneumatic:
meaning: cim:OperatingMechanismKind.pneumatic
solenoid:
meaning: cim:OperatingMechanismKind.solenoid
spring:
meaning: cim:OperatingMechanismKind.spring
springHandCrank:
meaning: cim:OperatingMechanismKind.springHandCrank
springHydraulic:
meaning: cim:OperatingMechanismKind.springHydraulic
springMotor:
meaning: cim:OperatingMechanismKind.springMotor
InterruptingMediumKind:
enum_uri: cim:InterruptingMediumKind
description: Kinds of interrupting mediums.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetInfo
permissible_values:
airBlast:
meaning: cim:InterruptingMediumKind.airBlast
airMagnetic:
meaning: cim:InterruptingMediumKind.airMagnetic
bulkOil:
meaning: cim:InterruptingMediumKind.bulkOil
gasSinglePressure:
meaning: cim:InterruptingMediumKind.gasSinglePressure
gasTwoPressure:
meaning: cim:InterruptingMediumKind.gasTwoPressure
minimumOil:
meaning: cim:InterruptingMediumKind.minimumOil
vacuum:
meaning: cim:InterruptingMediumKind.vacuum
BushingInsulationKind:
enum_uri: cim:BushingInsulationKind
description: Insulation kind for bushings.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.AssetInfo
permissible_values:
compound:
meaning: cim:BushingInsulationKind.compound
oilImpregnatedPaper:
meaning: cim:BushingInsulationKind.oilImpregnatedPaper
other:
meaning: cim:BushingInsulationKind.other
resinBondedPaper:
meaning: cim:BushingInsulationKind.resinBondedPaper
resinImpregnatedPaper:
meaning: cim:BushingInsulationKind.resinImpregnatedPaper
solidPorcelain:
meaning: cim:BushingInsulationKind.solidPorcelain
TowerConstructionKind:
enum_uri: cim:TowerConstructionKind
description: Kind of tower construction.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfAssets
permissible_values:
suspension:
meaning: cim:TowerConstructionKind.suspension
tension:
meaning: cim:TowerConstructionKind.tension
UndergroundStructureKind:
enum_uri: cim:UndergroundStructureKind
description: Kind of underground structure.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.InfIEC61968.InfAssets
permissible_values:
burd:
meaning: cim:UndergroundStructureKind.burd
enclosure:
meaning: cim:UndergroundStructureKind.enclosure
handhole:
meaning: cim:UndergroundStructureKind.handhole
manhole:
meaning: cim:UndergroundStructureKind.manhole
pad:
meaning: cim:UndergroundStructureKind.pad
pullbox:
meaning: cim:UndergroundStructureKind.pullbox
subsurfaceEnclosure:
meaning: cim:UndergroundStructureKind.subsurfaceEnclosure
trench:
meaning: cim:UndergroundStructureKind.trench
tunnel:
meaning: cim:UndergroundStructureKind.tunnel
vault:
meaning: cim:UndergroundStructureKind.vault
AtmosphericAnalogKind:
enum_uri: cim:AtmosphericAnalogKind
description: Kinds of analogs (floats) measuring an atmospheric condition.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental.EnvDomain
permissible_values:
albedo:
meaning: cim:AtmosphericAnalogKind.albedo
ambientTemperature:
meaning: cim:AtmosphericAnalogKind.ambientTemperature
atmosphericPressure:
meaning: cim:AtmosphericAnalogKind.atmosphericPressure
ceiling:
meaning: cim:AtmosphericAnalogKind.ceiling
dewPoint:
meaning: cim:AtmosphericAnalogKind.dewPoint
heatIndex:
meaning: cim:AtmosphericAnalogKind.heatIndex
horizontalVisibility:
meaning: cim:AtmosphericAnalogKind.horizontalVisibility
humidity:
meaning: cim:AtmosphericAnalogKind.humidity
ice:
meaning: cim:AtmosphericAnalogKind.ice
illuminanceDiffuseHorizontal:
meaning: cim:AtmosphericAnalogKind.illuminanceDiffuseHorizontal
illuminanceDirectNormal:
meaning: cim:AtmosphericAnalogKind.illuminanceDirectNormal
illuminanceGlobalHorizontal:
meaning: cim:AtmosphericAnalogKind.illuminanceGlobalHorizontal
irradianceDiffuseHorizonal:
meaning: cim:AtmosphericAnalogKind.irradianceDiffuseHorizonal
irradianceDirectNormal:
meaning: cim:AtmosphericAnalogKind.irradianceDirectNormal
irradianceExtraTerrestrialHorizontal:
meaning: cim:AtmosphericAnalogKind.irradianceExtraTerrestrialHorizontal
irradianceExtraTerrestrialVertical:
meaning: cim:AtmosphericAnalogKind.irradianceExtraTerrestrialVertical
irradianceGlobalHorizontal:
meaning: cim:AtmosphericAnalogKind.irradianceGlobalHorizontal
luminanceZenith:
meaning: cim:AtmosphericAnalogKind.luminanceZenith
precipitation:
meaning: cim:AtmosphericAnalogKind.precipitation
rain:
meaning: cim:AtmosphericAnalogKind.rain
skyCoverageOpaque:
meaning: cim:AtmosphericAnalogKind.skyCoverageOpaque
skyCoverageTotal:
meaning: cim:AtmosphericAnalogKind.skyCoverageTotal
snow:
meaning: cim:AtmosphericAnalogKind.snow
verticalVisibility:
meaning: cim:AtmosphericAnalogKind.verticalVisibility
windChill:
meaning: cim:AtmosphericAnalogKind.windChill
windSpeedGust:
meaning: cim:AtmosphericAnalogKind.windSpeedGust
windSpeedInstantaneous:
meaning: cim:AtmosphericAnalogKind.windSpeedInstantaneous
windSpeedPeak:
meaning: cim:AtmosphericAnalogKind.windSpeedPeak
windSpeedSustained:
meaning: cim:AtmosphericAnalogKind.windSpeedSustained
UncertaintyKind:
enum_uri: cim:UncertaintyKind
description: The type of uncertainty for a reading.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental.EnvDomain
permissible_values:
estimated:
meaning: cim:UncertaintyKind.estimated
interpolated:
meaning: cim:UncertaintyKind.interpolated
standard:
meaning: cim:UncertaintyKind.standard
unknown:
meaning: cim:UncertaintyKind.unknown
CoverageCodeKind:
enum_uri: cim:CoverageCodeKind
description: Kinds of weather condition coverage.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental.EnvDomain
permissible_values:
brief:
meaning: cim:CoverageCodeKind.brief
frequent:
meaning: cim:CoverageCodeKind.frequent
intermittant:
meaning: cim:CoverageCodeKind.intermittant
isolated:
meaning: cim:CoverageCodeKind.isolated
numerous:
meaning: cim:CoverageCodeKind.numerous
occasional:
meaning: cim:CoverageCodeKind.occasional
partly:
meaning: cim:CoverageCodeKind.partly
patchy:
meaning: cim:CoverageCodeKind.patchy
periodsOf:
meaning: cim:CoverageCodeKind.periodsOf
scattered:
meaning: cim:CoverageCodeKind.scattered
widespread:
meaning: cim:CoverageCodeKind.widespread
FScale:
enum_uri: cim:FScale
description: "Fujita scale (referred to as EF-scale starting in 2007) for tornado\
\ damage. A set of wind estimates (not measurements) based on damage. It uses\
\ three-second gusts estimated at the point of damage based on a judgment of\
\ 8 levels of damage to 28 indicators. These estimates vary with height and\
\ exposure. \r\nThe 3 second gust is not the same wind as in standard surface\
\ observations.\r\nEnumerations based on NOAA conventions."
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental.EnvDomain
permissible_values:
five:
meaning: cim:FScale.five
four:
meaning: cim:FScale.four
minusNine:
meaning: cim:FScale.minusNine
one:
meaning: cim:FScale.one
three:
meaning: cim:FScale.three
two:
meaning: cim:FScale.two
zero:
meaning: cim:FScale.zero
WeatherCodeKind:
enum_uri: cim:WeatherCodeKind
description: Kinds of weather conditions.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental.EnvDomain
permissible_values:
blowingDust:
meaning: cim:WeatherCodeKind.blowingDust
blowingSand:
meaning: cim:WeatherCodeKind.blowingSand
blowingSnow:
meaning: cim:WeatherCodeKind.blowingSnow
cloudy:
meaning: cim:WeatherCodeKind.cloudy
drizzle:
meaning: cim:WeatherCodeKind.drizzle
fog:
meaning: cim:WeatherCodeKind.fog
freezingDrizzle:
meaning: cim:WeatherCodeKind.freezingDrizzle
freezingRain:
meaning: cim:WeatherCodeKind.freezingRain
freezingSpray:
meaning: cim:WeatherCodeKind.freezingSpray
frost:
meaning: cim:WeatherCodeKind.frost
hail:
meaning: cim:WeatherCodeKind.hail
haze:
meaning: cim:WeatherCodeKind.haze
iceCrystals:
meaning: cim:WeatherCodeKind.iceCrystals
iceFog:
meaning: cim:WeatherCodeKind.iceFog
mist:
meaning: cim:WeatherCodeKind.mist
rain:
meaning: cim:WeatherCodeKind.rain
rainShowers:
meaning: cim:WeatherCodeKind.rainShowers
rainSnowMix:
meaning: cim:WeatherCodeKind.rainSnowMix
sleet:
meaning: cim:WeatherCodeKind.sleet
smoke:
meaning: cim:WeatherCodeKind.smoke
snow:
meaning: cim:WeatherCodeKind.snow
snowShowers:
meaning: cim:WeatherCodeKind.snowShowers
snowSleetMix:
meaning: cim:WeatherCodeKind.snowSleetMix
sunny:
meaning: cim:WeatherCodeKind.sunny
thunderStorms:
meaning: cim:WeatherCodeKind.thunderStorms
volcanicAsh:
meaning: cim:WeatherCodeKind.volcanicAsh
waterSpouts:
meaning: cim:WeatherCodeKind.waterSpouts
wintryMix:
meaning: cim:WeatherCodeKind.wintryMix
RelativeDisplacementKind:
enum_uri: cim:RelativeDisplacementKind
description: The types of relative displacement
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental.EnvDomain
permissible_values:
centreEarth:
meaning: cim:RelativeDisplacementKind.centreEarth
ground:
meaning: cim:RelativeDisplacementKind.ground
seaLevel:
meaning: cim:RelativeDisplacementKind.seaLevel
HydrosphericAnalogKind:
enum_uri: cim:HydrosphericAnalogKind
description: Kinds of analogs (floats) measuring a hydrospheric condition.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental.EnvDomain
permissible_values:
floodLevel:
meaning: cim:HydrosphericAnalogKind.floodLevel
stormSurgeHeight:
meaning: cim:HydrosphericAnalogKind.stormSurgeHeight
surfaceTemperature:
meaning: cim:HydrosphericAnalogKind.surfaceTemperature
waterTemperature:
meaning: cim:HydrosphericAnalogKind.waterTemperature
waveHeight:
meaning: cim:HydrosphericAnalogKind.waveHeight
TimePeriodUnit:
enum_uri: cim:TimePeriodUnit
description: Units in which reporting frequency is specified.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental.EnvDomain
permissible_values:
days:
meaning: cim:TimePeriodUnit.days
hours:
meaning: cim:TimePeriodUnit.hours
minutes:
meaning: cim:TimePeriodUnit.minutes
months:
meaning: cim:TimePeriodUnit.months
seconds:
meaning: cim:TimePeriodUnit.seconds
weeks:
meaning: cim:TimePeriodUnit.weeks
GeosphericAnalogKind:
enum_uri: cim:GeosphericAnalogKind
description: Kinds of analogs (floats) measuring a geospheric condition.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental.EnvDomain
permissible_values:
lightningDensity:
meaning: cim:GeosphericAnalogKind.lightningDensity
seismicEastWest:
meaning: cim:GeosphericAnalogKind.seismicEastWest
seismicNorthSouth:
meaning: cim:GeosphericAnalogKind.seismicNorthSouth
seismicVertical:
meaning: cim:GeosphericAnalogKind.seismicVertical
snowPackDepth:
meaning: cim:GeosphericAnalogKind.snowPackDepth
temperature:
meaning: cim:GeosphericAnalogKind.temperature
SpaceAnalogKind:
enum_uri: cim:SpaceAnalogKind
description: Kinds of analogs (floats) measuring a space condition.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental.EnvDomain
permissible_values:
magneticFieldDirection:
meaning: cim:SpaceAnalogKind.magneticFieldDirection
magneticFieldStrength:
meaning: cim:SpaceAnalogKind.magneticFieldStrength
CloudKind:
enum_uri: cim:CloudKind
description: Kind of cloud.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental.EnvDomain
permissible_values:
altoCumulus:
meaning: cim:CloudKind.altoCumulus
altoStratus:
meaning: cim:CloudKind.altoStratus
cirroCumulus:
meaning: cim:CloudKind.cirroCumulus
cirroStratus:
meaning: cim:CloudKind.cirroStratus
cirrus:
meaning: cim:CloudKind.cirrus
cumuloNimbus:
meaning: cim:CloudKind.cumuloNimbus
cumulus:
meaning: cim:CloudKind.cumulus
nimboStratus:
meaning: cim:CloudKind.nimboStratus
other:
meaning: cim:CloudKind.other
stratoCumulus:
meaning: cim:CloudKind.stratoCumulus
stratus:
meaning: cim:CloudKind.stratus
toweringCumulus:
meaning: cim:CloudKind.toweringCumulus
IntensityCodeKind:
enum_uri: cim:IntensityCodeKind
description: Kinds of weather condition intensity.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.Environmental.EnvDomain
permissible_values:
heavy:
meaning: cim:IntensityCodeKind.heavy
light:
meaning: cim:IntensityCodeKind.light
veryHeavy:
meaning: cim:IntensityCodeKind.veryHeavy
veryLight:
meaning: cim:IntensityCodeKind.veryLight
ResourceCertificationKind:
enum_uri: cim:ResourceCertificationKind
description: Types used for resource certification.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
BLACKSTART:
meaning: cim:ResourceCertificationKind.BLACKSTART
Capacity:
meaning: cim:ResourceCertificationKind.Capacity
DemandSideResponse:
meaning: cim:ResourceCertificationKind.DemandSideResponse
Energy:
meaning: cim:ResourceCertificationKind.Energy
IntermittentResource:
meaning: cim:ResourceCertificationKind.IntermittentResource
NonSpinningReserve:
meaning: cim:ResourceCertificationKind.NonSpinningReserve
RegulationDown:
meaning: cim:ResourceCertificationKind.RegulationDown
RegulationUp:
meaning: cim:ResourceCertificationKind.RegulationUp
ReliabilityMustRun:
meaning: cim:ResourceCertificationKind.ReliabilityMustRun
ReliabilityUnitCommitment:
meaning: cim:ResourceCertificationKind.ReliabilityUnitCommitment
SpinningReserve:
meaning: cim:ResourceCertificationKind.SpinningReserve
SynchronousCondenser:
meaning: cim:ResourceCertificationKind.SynchronousCondenser
BidCalculationBasis:
enum_uri: cim:BidCalculationBasis
description: "The basis used to calculate the bid price curve for an energy default\
\ bid.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
COST_BASED:
meaning: cim:BidCalculationBasis.COST_BASED
LMP_BASED:
meaning: cim:BidCalculationBasis.LMP_BASED
NEGOTIATED:
meaning: cim:BidCalculationBasis.NEGOTIATED
AnalogLimitType:
enum_uri: cim:AnalogLimitType
description: "Limit type specified for AnalogLimits.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
BranchLongTerm:
meaning: cim:AnalogLimitType.BranchLongTerm
BranchMediumTerm:
meaning: cim:AnalogLimitType.BranchMediumTerm
BranchShortTerm:
meaning: cim:AnalogLimitType.BranchShortTerm
VoltageHigh:
meaning: cim:AnalogLimitType.VoltageHigh
VoltageLow:
meaning: cim:AnalogLimitType.VoltageLow
SwitchStatusType:
enum_uri: cim:SwitchStatusType
description: "Circuit Breaker Status (closed or open) of the circuit breaker.\r\
\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.MarketOperations.MktDomain
permissible_values:
Closed:
meaning: cim:SwitchStatusType.Closed
Open:
meaning: cim:SwitchStatusType.Open
MarketRoleKind:
enum_uri: cim:MarketRoleKind
description: Kind of market role an organisation can have. This list is not exhausted,
as other roles may exist.
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfMarketOpCommon
permissible_values:
BalanceResponsibleParty:
meaning: cim:MarketRoleKind.BalanceResponsibleParty
BalanceSupplier:
meaning: cim:MarketRoleKind.BalanceSupplier
balancingAuthority:
meaning: cim:MarketRoleKind.balancingAuthority
BillingAgent:
meaning: cim:MarketRoleKind.BillingAgent
BlockEnergyTrader:
meaning: cim:MarketRoleKind.BlockEnergyTrader
CapacityCoordinator:
meaning: cim:MarketRoleKind.CapacityCoordinator
CapacityTrader:
meaning: cim:MarketRoleKind.CapacityTrader
competitiveRetailer:
meaning: cim:MarketRoleKind.competitiveRetailer
complianceMonitor:
meaning: cim:MarketRoleKind.complianceMonitor
Consumer:
meaning: cim:MarketRoleKind.Consumer
ConsumptionResponsibleParty:
meaning: cim:MarketRoleKind.ConsumptionResponsibleParty
ControlAreaOperator:
meaning: cim:MarketRoleKind.ControlAreaOperator
ControlBlockOperator:
meaning: cim:MarketRoleKind.ControlBlockOperator
CoordinationCenterOperator:
meaning: cim:MarketRoleKind.CoordinationCenterOperator
distributionProvider:
meaning: cim:MarketRoleKind.distributionProvider
energyServiceConsumer:
meaning: cim:MarketRoleKind.energyServiceConsumer
generatorOperator:
meaning: cim:MarketRoleKind.generatorOperator
generatorOwner:
meaning: cim:MarketRoleKind.generatorOwner
GridAccessProvider:
meaning: cim:MarketRoleKind.GridAccessProvider
GridOperator:
meaning: cim:MarketRoleKind.GridOperator
ImbalanceSettlementResponsible:
meaning: cim:MarketRoleKind.ImbalanceSettlementResponsible
interchangeAuthority:
meaning: cim:MarketRoleKind.interchangeAuthority
InterconnectionTradeResponsible:
meaning: cim:MarketRoleKind.InterconnectionTradeResponsible
loadServingEntity:
meaning: cim:MarketRoleKind.loadServingEntity
MarketInformationAggregator:
meaning: cim:MarketRoleKind.MarketInformationAggregator
MarketOperator:
meaning: cim:MarketRoleKind.MarketOperator
MeterAdministrator:
meaning: cim:MarketRoleKind.MeterAdministrator
MeteredDataAggregator:
meaning: cim:MarketRoleKind.MeteredDataAggregator
MeteredDataCollector:
meaning: cim:MarketRoleKind.MeteredDataCollector
MeteredDataResponsible:
meaning: cim:MarketRoleKind.MeteredDataResponsible
MeteringPointAdministrator:
meaning: cim:MarketRoleKind.MeteringPointAdministrator
MeterOperator:
meaning: cim:MarketRoleKind.MeterOperator
MOLResponsible:
meaning: cim:MarketRoleKind.MOLResponsible
NominationValidator:
meaning: cim:MarketRoleKind.NominationValidator
PartyConnectedToTheGrid:
meaning: cim:MarketRoleKind.PartyConnectedToTheGrid
planningAuthority:
meaning: cim:MarketRoleKind.planningAuthority
Producer:
meaning: cim:MarketRoleKind.Producer
ProductionResponsibleParty:
meaning: cim:MarketRoleKind.ProductionResponsibleParty
purchasingSellingEntity:
meaning: cim:MarketRoleKind.purchasingSellingEntity
ReconciliationAccountable:
meaning: cim:MarketRoleKind.ReconciliationAccountable
ReconciliationResponsible:
meaning: cim:MarketRoleKind.ReconciliationResponsible
reliabilityAuthority:
meaning: cim:MarketRoleKind.reliabilityAuthority
ReserveAllocator:
meaning: cim:MarketRoleKind.ReserveAllocator
resourcePlanner:
meaning: cim:MarketRoleKind.resourcePlanner
ResourceProvider:
meaning: cim:MarketRoleKind.ResourceProvider
SchedulingCoordinator:
meaning: cim:MarketRoleKind.SchedulingCoordinator
standardsDeveloper:
meaning: cim:MarketRoleKind.standardsDeveloper
SystemOperator:
meaning: cim:MarketRoleKind.SystemOperator
TradeResponsibleParty:
meaning: cim:MarketRoleKind.TradeResponsibleParty
TransmissionCapacityAllocator:
meaning: cim:MarketRoleKind.TransmissionCapacityAllocator
transmissionOperator:
meaning: cim:MarketRoleKind.transmissionOperator
transmissionOwner:
meaning: cim:MarketRoleKind.transmissionOwner
transmissionPlanner:
meaning: cim:MarketRoleKind.transmissionPlanner
transmissionServiceProvider:
meaning: cim:MarketRoleKind.transmissionServiceProvider
RequestorRmrTest:
enum_uri: cim:RequestorRmrTest
description: "MP\r\nISO\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
ISO:
meaning: cim:RequestorRmrTest.ISO
MP:
meaning: cim:RequestorRmrTest.MP
OrganisationCode:
enum_uri: cim:OrganisationCode
description: "organization code\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
BILL_TO:
meaning: cim:OrganisationCode.BILL_TO
PAY_TO:
meaning: cim:OrganisationCode.PAY_TO
PROVIDED_BY:
meaning: cim:OrganisationCode.PROVIDED_BY
SOLD_TO:
meaning: cim:OrganisationCode.SOLD_TO
SchedClassType:
enum_uri: cim:SchedClassType
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
F:
meaning: cim:SchedClassType.F
P:
meaning: cim:SchedClassType.P
R:
meaning: cim:SchedClassType.R
ResourceCertificationCategory:
enum_uri: cim:ResourceCertificationCategory
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
DAM:
meaning: cim:ResourceCertificationCategory.DAM
GT:
meaning: cim:ResourceCertificationCategory.GT
RC:
meaning: cim:ResourceCertificationCategory.RC
RTM:
meaning: cim:ResourceCertificationCategory.RTM
UOMType:
enum_uri: cim:UOMType
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
$/lb:
meaning: cim:UOMType.%24/lb
$/mmBTU:
meaning: cim:UOMType.%24/mmBTU
'%':
meaning: cim:UOMType.%25
FACTOR:
meaning: cim:UOMType.FACTOR
FLAG:
meaning: cim:UOMType.FLAG
INTEGER:
meaning: cim:UOMType.INTEGER
MW:
meaning: cim:UOMType.MW
MWh:
meaning: cim:UOMType.MWh
US$:
meaning: cim:UOMType.US%24
US$/MW:
meaning: cim:UOMType.US%24/MW
US$/MWh:
meaning: cim:UOMType.US%24/MWh
OASISMarketType:
enum_uri: cim:OASISMarketType
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
All:
meaning: cim:OASISMarketType.All
HASP:
meaning: cim:OASISMarketType.HASP
IFM:
meaning: cim:OASISMarketType.IFM
N/A:
meaning: cim:OASISMarketType.N/A
RTM:
meaning: cim:OASISMarketType.RTM
RUC:
meaning: cim:OASISMarketType.RUC
OASISDataItems:
enum_uri: cim:OASISDataItems
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
AS_CLEAR_ASMP_IFM:
meaning: cim:OASISDataItems.AS_CLEAR_ASMP_IFM
AS_CLEAR_ASMP_RTM:
meaning: cim:OASISDataItems.AS_CLEAR_ASMP_RTM
AS_CLEAR_COST_IFM:
meaning: cim:OASISDataItems.AS_CLEAR_COST_IFM
AS_CLEAR_COST_RTM:
meaning: cim:OASISDataItems.AS_CLEAR_COST_RTM
AS_CLEAR_MW_IFM:
meaning: cim:OASISDataItems.AS_CLEAR_MW_IFM
AS_CLEAR_MW_RTM:
meaning: cim:OASISDataItems.AS_CLEAR_MW_RTM
AS_GEN_TOTAL_MW_IFM:
meaning: cim:OASISDataItems.AS_GEN_TOTAL_MW_IFM
AS_GEN_TOTAL_MW_RTM:
meaning: cim:OASISDataItems.AS_GEN_TOTAL_MW_RTM
AS_IMP_TOTAL_MW_IFM:
meaning: cim:OASISDataItems.AS_IMP_TOTAL_MW_IFM
AS_IMP_TOTAL_MW_RTM:
meaning: cim:OASISDataItems.AS_IMP_TOTAL_MW_RTM
AS_LOAD_TOTAL_MW_IFM:
meaning: cim:OASISDataItems.AS_LOAD_TOTAL_MW_IFM
AS_LOAD_TOTAL_MW_RTM:
meaning: cim:OASISDataItems.AS_LOAD_TOTAL_MW_RTM
AS_REGION_REQ_MAX:
meaning: cim:OASISDataItems.AS_REGION_REQ_MAX
AS_REGION_REQ_MIN:
meaning: cim:OASISDataItems.AS_REGION_REQ_MIN
AS_REGION_value:
meaning: cim:OASISDataItems.AS_REGION_value
AS_SELF_MW_IFM:
meaning: cim:OASISDataItems.AS_SELF_MW_IFM
AS_SELF_MW_RTM:
meaning: cim:OASISDataItems.AS_SELF_MW_RTM
AS_TOTAL_MW:
meaning: cim:OASISDataItems.AS_TOTAL_MW
AS_TOTAL_MW_IFM:
meaning: cim:OASISDataItems.AS_TOTAL_MW_IFM
AS_TOTAL_MW_RTM:
meaning: cim:OASISDataItems.AS_TOTAL_MW_RTM
AS_TYPE:
meaning: cim:OASISDataItems.AS_TYPE
AS_USER_RATE:
meaning: cim:OASISDataItems.AS_USER_RATE
CA_value:
meaning: cim:OASISDataItems.CA_value
CMMT_MINLOAD_MLC:
meaning: cim:OASISDataItems.CMMT_MINLOAD_MLC
CMMT_MINLOAD_MW:
meaning: cim:OASISDataItems.CMMT_MINLOAD_MW
CMMT_RA_MLC:
meaning: cim:OASISDataItems.CMMT_RA_MLC
CMMT_RA_MW:
meaning: cim:OASISDataItems.CMMT_RA_MW
CMMT_RA_START_COST:
meaning: cim:OASISDataItems.CMMT_RA_START_COST
CMMT_RA_UNITS:
meaning: cim:OASISDataItems.CMMT_RA_UNITS
CMMT_TOTAL_MW:
meaning: cim:OASISDataItems.CMMT_TOTAL_MW
CMMT_TOTAL_START_COST:
meaning: cim:OASISDataItems.CMMT_TOTAL_START_COST
CMMT_TOTAL_UNITS:
meaning: cim:OASISDataItems.CMMT_TOTAL_UNITS
CRR_CAT:
meaning: cim:OASISDataItems.CRR_CAT
CRR_MARKET_value:
meaning: cim:OASISDataItems.CRR_MARKET_value
CRR_MW:
meaning: cim:OASISDataItems.CRR_MW
CRR_NSR:
meaning: cim:OASISDataItems.CRR_NSR
CRR_OPTION:
meaning: cim:OASISDataItems.CRR_OPTION
CRR_OWNER:
meaning: cim:OASISDataItems.CRR_OWNER
CRR_SEGMENT:
meaning: cim:OASISDataItems.CRR_SEGMENT
CRR_TERM:
meaning: cim:OASISDataItems.CRR_TERM
CRR_TOU:
meaning: cim:OASISDataItems.CRR_TOU
CRR_TYPE:
meaning: cim:OASISDataItems.CRR_TYPE
ENE_EA_DA:
meaning: cim:OASISDataItems.ENE_EA_DA
ENE_EA_EXCEPT:
meaning: cim:OASISDataItems.ENE_EA_EXCEPT
ENE_EA_HASP:
meaning: cim:OASISDataItems.ENE_EA_HASP
ENE_EA_MLE:
meaning: cim:OASISDataItems.ENE_EA_MLE
ENE_EA_MSSLF:
meaning: cim:OASISDataItems.ENE_EA_MSSLF
ENE_EA_OPTIMAL:
meaning: cim:OASISDataItems.ENE_EA_OPTIMAL
ENE_EA_RAMP_DEV:
meaning: cim:OASISDataItems.ENE_EA_RAMP_DEV
ENE_EA_RAMP_STD:
meaning: cim:OASISDataItems.ENE_EA_RAMP_STD
ENE_EA_RESIDUAL:
meaning: cim:OASISDataItems.ENE_EA_RESIDUAL
ENE_EA_RMR:
meaning: cim:OASISDataItems.ENE_EA_RMR
ENE_EA_SELF:
meaning: cim:OASISDataItems.ENE_EA_SELF
ENE_EA_SLIC:
meaning: cim:OASISDataItems.ENE_EA_SLIC
ENE_EXP_CLEAR_HASP:
meaning: cim:OASISDataItems.ENE_EXP_CLEAR_HASP
ENE_EXP_CLEAR_IFM:
meaning: cim:OASISDataItems.ENE_EXP_CLEAR_IFM
ENE_EXP_CLEAR_RTM:
meaning: cim:OASISDataItems.ENE_EXP_CLEAR_RTM
ENE_GEN_CLEAR_HASP:
meaning: cim:OASISDataItems.ENE_GEN_CLEAR_HASP
ENE_GEN_CLEAR_IFM:
meaning: cim:OASISDataItems.ENE_GEN_CLEAR_IFM
ENE_GEN_CLEAR_RTM:
meaning: cim:OASISDataItems.ENE_GEN_CLEAR_RTM
ENE_IMP_CLEAR_HASP:
meaning: cim:OASISDataItems.ENE_IMP_CLEAR_HASP
ENE_IMP_CLEAR_IFM:
meaning: cim:OASISDataItems.ENE_IMP_CLEAR_IFM
ENE_IMP_CLEAR_RTM:
meaning: cim:OASISDataItems.ENE_IMP_CLEAR_RTM
ENE_LOAD_ACTUAL:
meaning: cim:OASISDataItems.ENE_LOAD_ACTUAL
ENE_LOAD_CLEAR_HASP:
meaning: cim:OASISDataItems.ENE_LOAD_CLEAR_HASP
ENE_LOAD_CLEAR_IFM:
meaning: cim:OASISDataItems.ENE_LOAD_CLEAR_IFM
ENE_LOAD_CLEAR_RTM:
meaning: cim:OASISDataItems.ENE_LOAD_CLEAR_RTM
ENE_LOAD_FCST:
meaning: cim:OASISDataItems.ENE_LOAD_FCST
ENE_PEAK_HOUR:
meaning: cim:OASISDataItems.ENE_PEAK_HOUR
ENE_PEAK_LOAD:
meaning: cim:OASISDataItems.ENE_PEAK_LOAD
FUEL_REGION_value:
meaning: cim:OASISDataItems.FUEL_REGION_value
INVT_DATETIME:
meaning: cim:OASISDataItems.INVT_DATETIME
LOAD_ACTUAL:
meaning: cim:OASISDataItems.LOAD_ACTUAL
LOAD_CLEAR_RTM:
meaning: cim:OASISDataItems.LOAD_CLEAR_RTM
LOSS_TOTAL_COST_HASP:
meaning: cim:OASISDataItems.LOSS_TOTAL_COST_HASP
LOSS_TOTAL_COST_RTM:
meaning: cim:OASISDataItems.LOSS_TOTAL_COST_RTM
LOSS_TOTAL_MW_HASP:
meaning: cim:OASISDataItems.LOSS_TOTAL_MW_HASP
LOSS_TOTAL_MW_RTM:
meaning: cim:OASISDataItems.LOSS_TOTAL_MW_RTM
MPM_FLAG:
meaning: cim:OASISDataItems.MPM_FLAG
OP_RSRV_TOTAL:
meaning: cim:OASISDataItems.OP_RSRV_TOTAL
PRC_NG:
meaning: cim:OASISDataItems.PRC_NG
PRC_SHADOW:
meaning: cim:OASISDataItems.PRC_SHADOW
RATING_ATC:
meaning: cim:OASISDataItems.RATING_ATC
RMR_DETER_DAM:
meaning: cim:OASISDataItems.RMR_DETER_DAM
RMR_DETER_HASP:
meaning: cim:OASISDataItems.RMR_DETER_HASP
RMR_DISPATCH_DAM:
meaning: cim:OASISDataItems.RMR_DISPATCH_DAM
RMR_DISPATCH_HASP:
meaning: cim:OASISDataItems.RMR_DISPATCH_HASP
RMR_TOTAL:
meaning: cim:OASISDataItems.RMR_TOTAL
RMR_TOTAL_AVAIL:
meaning: cim:OASISDataItems.RMR_TOTAL_AVAIL
RUC_GEN_CLEAR_RUC:
meaning: cim:OASISDataItems.RUC_GEN_CLEAR_RUC
RUC_IMP_CLEAR_RUC:
meaning: cim:OASISDataItems.RUC_IMP_CLEAR_RUC
RUC_LOAD_CLEAR_RUC:
meaning: cim:OASISDataItems.RUC_LOAD_CLEAR_RUC
RUC_ZONE_value:
meaning: cim:OASISDataItems.RUC_ZONE_value
TAC_AREA_value:
meaning: cim:OASISDataItems.TAC_AREA_value
TINTRFCE_value:
meaning: cim:OASISDataItems.TINTRFCE_value
TRNS_AS_IMPORT:
meaning: cim:OASISDataItems.TRNS_AS_IMPORT
TRNS_ENE_IMPORT:
meaning: cim:OASISDataItems.TRNS_ENE_IMPORT
TRNS_EQUIP_value:
meaning: cim:OASISDataItems.TRNS_EQUIP_value
TRNS_RATING_CBM:
meaning: cim:OASISDataItems.TRNS_RATING_CBM
TRNS_RATING_DIRECTION:
meaning: cim:OASISDataItems.TRNS_RATING_DIRECTION
TRNS_RATING_OTC:
meaning: cim:OASISDataItems.TRNS_RATING_OTC
TRNS_RATING_OTC_DERATE:
meaning: cim:OASISDataItems.TRNS_RATING_OTC_DERATE
TRNS_RATING_TTC:
meaning: cim:OASISDataItems.TRNS_RATING_TTC
TRNS_TI_value:
meaning: cim:OASISDataItems.TRNS_TI_value
TRNS_TR_ENTMTS:
meaning: cim:OASISDataItems.TRNS_TR_ENTMTS
TRNS_TR_USEAGE:
meaning: cim:OASISDataItems.TRNS_TR_USEAGE
OASISMeasType:
enum_uri: cim:OASISMeasType
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
'%':
meaning: cim:OASISMeasType.%25
FACTOR:
meaning: cim:OASISMeasType.FACTOR
FLAG:
meaning: cim:OASISMeasType.FLAG
INTEGER:
meaning: cim:OASISMeasType.INTEGER
MW:
meaning: cim:OASISMeasType.MW
MWh:
meaning: cim:OASISMeasType.MWh
US$:
meaning: cim:OASISMeasType.US%24
US$/MW:
meaning: cim:OASISMeasType.US%24/MW
US$/MWh:
meaning: cim:OASISMeasType.US%24/MWh
SegmentCurveType:
enum_uri: cim:SegmentCurveType
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
CONSULTATIVE:
meaning: cim:SegmentCurveType.CONSULTATIVE
COST:
meaning: cim:SegmentCurveType.COST
OrganisationType:
enum_uri: cim:OrganisationType
description: "organization type\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
CUSTOMER:
meaning: cim:OrganisationType.CUSTOMER
RTO:
meaning: cim:OrganisationType.RTO
SelfScheduleTypeMB:
enum_uri: cim:SelfScheduleTypeMB
description: "Self Schedule Types applicable to Mitigated Bid\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
RMR:
meaning: cim:SelfScheduleTypeMB.RMR
MarketStatementLineItemAliasName:
enum_uri: cim:MarketStatementLineItemAliasName
description: "market statement line item alias name\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
CHARGE_CODE_INTERVAL_DETAIL:
meaning: cim:MarketStatementLineItemAliasName.CHARGE_CODE_INTERVAL_DETAIL
CHARGE_CODE_INTERVAL_TOTAL:
meaning: cim:MarketStatementLineItemAliasName.CHARGE_CODE_INTERVAL_TOTAL
CHARGE_CODE_SUMMARY:
meaning: cim:MarketStatementLineItemAliasName.CHARGE_CODE_SUMMARY
CHARGE_GROUP:
meaning: cim:MarketStatementLineItemAliasName.CHARGE_GROUP
PARENT_CHARGE_GROUP:
meaning: cim:MarketStatementLineItemAliasName.PARENT_CHARGE_GROUP
TRADE_DATE:
meaning: cim:MarketStatementLineItemAliasName.TRADE_DATE
TradeStatusType:
enum_uri: cim:TradeStatusType
description: "RJ - Rejected Trade\r\nI - Invalid Trade\r\nV - Valid Trade\r\n\
M - Modified Trade\r\nCV - Conditionally Valid Trade\r\nCM - Conditionally Modified\
\ Trade\r\nCI - Conditionally Invalid Trade\r\nCX - Cancelled Trade\r\nO - Obsolete\
\ Trade\r\nMT - Matched Trade\r\nU - Unmatched Trade\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
CI:
meaning: cim:TradeStatusType.CI
CM:
meaning: cim:TradeStatusType.CM
CV:
meaning: cim:TradeStatusType.CV
CX:
meaning: cim:TradeStatusType.CX
I:
meaning: cim:TradeStatusType.I
M:
meaning: cim:TradeStatusType.M
MT:
meaning: cim:TradeStatusType.MT
O:
meaning: cim:TradeStatusType.O
RJ:
meaning: cim:TradeStatusType.RJ
U:
meaning: cim:TradeStatusType.U
V:
meaning: cim:TradeStatusType.V
ZoneType:
enum_uri: cim:ZoneType
description: "zone type\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
ASREGION:
meaning: cim:ZoneType.ASREGION
DCA:
meaning: cim:ZoneType.DCA
LOADZONE:
meaning: cim:ZoneType.LOADZONE
RUCZONE:
meaning: cim:ZoneType.RUCZONE
TRADINGHUB:
meaning: cim:ZoneType.TRADINGHUB
MarketStatementDescription:
enum_uri: cim:MarketStatementDescription
description: "Description of market statement\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
DAILY_INITIAL_CREDIT:
meaning: cim:MarketStatementDescription.DAILY_INITIAL_CREDIT
DAILY_INITIAL_MARKET:
meaning: cim:MarketStatementDescription.DAILY_INITIAL_MARKET
DAILY_RECALC_MARKET:
meaning: cim:MarketStatementDescription.DAILY_RECALC_MARKET
MONTHLY_INITIAL_MARKET:
meaning: cim:MarketStatementDescription.MONTHLY_INITIAL_MARKET
MONTHLY_RECALC_MARKET:
meaning: cim:MarketStatementDescription.MONTHLY_RECALC_MARKET
OASISStatusType:
enum_uri: cim:OASISStatusType
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
Data_Transfer_Procedure_Initiated:
meaning: cim:OASISStatusType.Data_Transfer_Procedure_Initiated
Data_Transfer_Succesful:
meaning: cim:OASISStatusType.Data_Transfer_Succesful
Forced_Termination:
meaning: cim:OASISStatusType.Forced_Termination
Obsolete:
meaning: cim:OASISStatusType.Obsolete
Push_Failed:
meaning: cim:OASISStatusType.Push_Failed
Valid:
meaning: cim:OASISStatusType.Valid
OASISReportType:
enum_uri: cim:OASISReportType
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
AS_DA_RESULT:
meaning: cim:OASISReportType.AS_DA_RESULT
AS_OP_RSRV:
meaning: cim:OASISReportType.AS_OP_RSRV
AS_REQ:
meaning: cim:OASISReportType.AS_REQ
AS_RTM_RESULT:
meaning: cim:OASISReportType.AS_RTM_RESULT
BIDS_PUBLIC:
meaning: cim:OASISReportType.BIDS_PUBLIC
CMMT_RA_MLC:
meaning: cim:OASISReportType.CMMT_RA_MLC
CMMT_RMR:
meaning: cim:OASISReportType.CMMT_RMR
CRR_CLEARING:
meaning: cim:OASISReportType.CRR_CLEARING
CRR_INVENTORY:
meaning: cim:OASISReportType.CRR_INVENTORY
ENE_EA:
meaning: cim:OASISReportType.ENE_EA
ENE_HASP:
meaning: cim:OASISReportType.ENE_HASP
ENE_IFM:
meaning: cim:OASISReportType.ENE_IFM
ENE_MPM:
meaning: cim:OASISReportType.ENE_MPM
ENE_RTM:
meaning: cim:OASISReportType.ENE_RTM
ENE_RUC:
meaning: cim:OASISReportType.ENE_RUC
LOSS_DA_HASP:
meaning: cim:OASISReportType.LOSS_DA_HASP
LOSS_RTM:
meaning: cim:OASISReportType.LOSS_RTM
PRC_AS:
meaning: cim:OASISReportType.PRC_AS
PRC_CNSTR:
meaning: cim:OASISReportType.PRC_CNSTR
PRC_FUEL:
meaning: cim:OASISReportType.PRC_FUEL
PRC_HRLY_LMP:
meaning: cim:OASISReportType.PRC_HRLY_LMP
PRC_INTVL_LMP:
meaning: cim:OASISReportType.PRC_INTVL_LMP
SLD_FCST:
meaning: cim:OASISReportType.SLD_FCST
SLD_FCST_PEAK:
meaning: cim:OASISReportType.SLD_FCST_PEAK
SLD_MKTS:
meaning: cim:OASISReportType.SLD_MKTS
TRNS_ATC:
meaning: cim:OASISReportType.TRNS_ATC
TRNS_OUTAGE:
meaning: cim:OASISReportType.TRNS_OUTAGE
TRNS_USAGE:
meaning: cim:OASISReportType.TRNS_USAGE
MarketStatementDocStatus:
enum_uri: cim:MarketStatementDocStatus
description: "market statement document status\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
APPROVED:
meaning: cim:MarketStatementDocStatus.APPROVED
CANCELLED:
meaning: cim:MarketStatementDocStatus.CANCELLED
OASISErrCode:
enum_uri: cim:OASISErrCode
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
'1000':
meaning: cim:OASISErrCode.1000
'1001':
meaning: cim:OASISErrCode.1001
'1002':
meaning: cim:OASISErrCode.1002
'1003':
meaning: cim:OASISErrCode.1003
'1004':
meaning: cim:OASISErrCode.1004
'1005':
meaning: cim:OASISErrCode.1005
'1006':
meaning: cim:OASISErrCode.1006
'1007':
meaning: cim:OASISErrCode.1007
'1008':
meaning: cim:OASISErrCode.1008
'1009':
meaning: cim:OASISErrCode.1009
'1010':
meaning: cim:OASISErrCode.1010
PriceSetFlag:
enum_uri: cim:PriceSetFlag
description: "Y - indicates a resource is capable of setting the Markte Clearing\
\ Price \r\nS - indicates the resource must submit bids for energy at $ 0\r\n\
N - indicates the resource does not have to submit bids for energy at $ 0\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
N:
meaning: cim:PriceSetFlag.N
S:
meaning: cim:PriceSetFlag.S
Y:
meaning: cim:PriceSetFlag.Y
JobScheduleType:
enum_uri: cim:JobScheduleType
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
CRITICAL:
meaning: cim:JobScheduleType.CRITICAL
NONCRITICAL:
meaning: cim:JobScheduleType.NONCRITICAL
AdderType:
enum_uri: cim:AdderType
description: "BASELI NE\r\nNEGOTIATED\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
BASELINE:
meaning: cim:AdderType.BASELINE
NEGOTIATED:
meaning: cim:AdderType.NEGOTIATED
SpinningEventNameType:
enum_uri: cim:SpinningEventNameType
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
EASTERN:
meaning: cim:SpinningEventNameType.EASTERN
PJM:
meaning: cim:SpinningEventNameType.PJM
RFC-SR:
meaning: cim:SpinningEventNameType.RFC-SR
SOUTH-S:
meaning: cim:SpinningEventNameType.SOUTH-S
ADSInstructionTypeOOS:
enum_uri: cim:ADSInstructionTypeOOS
description: "MIN_CONSTRAINT\r\nMAX_CONSTRAINT\r\nFIXED_CONSTRAINT\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
FIXED_CONSTRAINT:
meaning: cim:ADSInstructionTypeOOS.FIXED_CONSTRAINT
MAX_CONSTRAINT:
meaning: cim:ADSInstructionTypeOOS.MAX_CONSTRAINT
MIN_CONSTRAINT:
meaning: cim:ADSInstructionTypeOOS.MIN_CONSTRAINT
DAMMarketType:
enum_uri: cim:DAMMarketType
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
DAM:
meaning: cim:DAMMarketType.DAM
OASISMasterType:
enum_uri: cim:OASISMasterType
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
ATL_APNODE:
meaning: cim:OASISMasterType.ATL_APNODE
ATL_AS_REGION:
meaning: cim:OASISMasterType.ATL_AS_REGION
ATL_AS_REGION_MAP:
meaning: cim:OASISMasterType.ATL_AS_REGION_MAP
ATL_HUB:
meaning: cim:OASISMasterType.ATL_HUB
ATL_LAP:
meaning: cim:OASISMasterType.ATL_LAP
ATL_LDF:
meaning: cim:OASISMasterType.ATL_LDF
ATL_PNODE:
meaning: cim:OASISMasterType.ATL_PNODE
ATL_PNODE_MAP:
meaning: cim:OASISMasterType.ATL_PNODE_MAP
ATL_PUB:
meaning: cim:OASISMasterType.ATL_PUB
ATL_PUB_SCHED:
meaning: cim:OASISMasterType.ATL_PUB_SCHED
ATL_RESOURCE:
meaning: cim:OASISMasterType.ATL_RESOURCE
ATL_RUC_ZONE:
meaning: cim:OASISMasterType.ATL_RUC_ZONE
ATL_RUC_ZONE_MAP:
meaning: cim:OASISMasterType.ATL_RUC_ZONE_MAP
ATL_STAT:
meaning: cim:OASISMasterType.ATL_STAT
ATL_TAC_AREA:
meaning: cim:OASISMasterType.ATL_TAC_AREA
ATL_TAC_AREA_MAP:
meaning: cim:OASISMasterType.ATL_TAC_AREA_MAP
ATL_TI:
meaning: cim:OASISMasterType.ATL_TI
ATL_TIEPOINT:
meaning: cim:OASISMasterType.ATL_TIEPOINT
ATL_XREF:
meaning: cim:OASISMasterType.ATL_XREF
SelfSchedTypeRawBid:
enum_uri: cim:SelfSchedTypeRawBid
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
BAS:
meaning: cim:SelfSchedTypeRawBid.BAS
ETC:
meaning: cim:SelfSchedTypeRawBid.ETC
LOF:
meaning: cim:SelfSchedTypeRawBid.LOF
LPT:
meaning: cim:SelfSchedTypeRawBid.LPT
PT:
meaning: cim:SelfSchedTypeRawBid.PT
RA:
meaning: cim:SelfSchedTypeRawBid.RA
RMT:
meaning: cim:SelfSchedTypeRawBid.RMT
SP:
meaning: cim:SelfSchedTypeRawBid.SP
TOR:
meaning: cim:SelfSchedTypeRawBid.TOR
WHL:
meaning: cim:SelfSchedTypeRawBid.WHL
OASISIntervalType:
enum_uri: cim:OASISIntervalType
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
BEGINNING:
meaning: cim:OASISIntervalType.BEGINNING
ENDING:
meaning: cim:OASISIntervalType.ENDING
MarketScheduleServices:
enum_uri: cim:MarketScheduleServices
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
retrieveDefaultBidCurves:
meaning: cim:MarketScheduleServices.retrieveDefaultBidCurves
retrieveMarketAwards:
meaning: cim:MarketScheduleServices.retrieveMarketAwards
retrieveMPMResults:
meaning: cim:MarketScheduleServices.retrieveMPMResults
retrieveSchedulePrices:
meaning: cim:MarketScheduleServices.retrieveSchedulePrices
retrieveStartUpShutDownInstructions:
meaning: cim:MarketScheduleServices.retrieveStartUpShutDownInstructions
SpinningEventType:
enum_uri: cim:SpinningEventType
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
AA:
meaning: cim:SpinningEventType.AA
CA:
meaning: cim:SpinningEventType.CA
RZ:
meaning: cim:SpinningEventType.RZ
AllocationEnergyTypeCode:
enum_uri: cim:AllocationEnergyTypeCode
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
ACNG:
meaning: cim:AllocationEnergyTypeCode.ACNG
BS:
meaning: cim:AllocationEnergyTypeCode.BS
DAPE:
meaning: cim:AllocationEnergyTypeCode.DAPE
DASE:
meaning: cim:AllocationEnergyTypeCode.DASE
ESRT:
meaning: cim:AllocationEnergyTypeCode.ESRT
ESYS:
meaning: cim:AllocationEnergyTypeCode.ESYS
ETC:
meaning: cim:AllocationEnergyTypeCode.ETC
HASE:
meaning: cim:AllocationEnergyTypeCode.HASE
LMPM:
meaning: cim:AllocationEnergyTypeCode.LMPM
MINL:
meaning: cim:AllocationEnergyTypeCode.MINL
MLE:
meaning: cim:AllocationEnergyTypeCode.MLE
MSSLFE:
meaning: cim:AllocationEnergyTypeCode.MSSLFE
OE:
meaning: cim:AllocationEnergyTypeCode.OE
OTHER:
meaning: cim:AllocationEnergyTypeCode.OTHER
OVGN:
meaning: cim:AllocationEnergyTypeCode.OVGN
PE:
meaning: cim:AllocationEnergyTypeCode.PE
RCNG:
meaning: cim:AllocationEnergyTypeCode.RCNG
RE:
meaning: cim:AllocationEnergyTypeCode.RE
RED:
meaning: cim:AllocationEnergyTypeCode.RED
RMRD:
meaning: cim:AllocationEnergyTypeCode.RMRD
RMRH:
meaning: cim:AllocationEnergyTypeCode.RMRH
RMRR:
meaning: cim:AllocationEnergyTypeCode.RMRR
RMRS:
meaning: cim:AllocationEnergyTypeCode.RMRS
RMRT:
meaning: cim:AllocationEnergyTypeCode.RMRT
RSYS:
meaning: cim:AllocationEnergyTypeCode.RSYS
RTSSE:
meaning: cim:AllocationEnergyTypeCode.RTSSE
SDWN:
meaning: cim:AllocationEnergyTypeCode.SDWN
SE:
meaning: cim:AllocationEnergyTypeCode.SE
SLIC:
meaning: cim:AllocationEnergyTypeCode.SLIC
SRE:
meaning: cim:AllocationEnergyTypeCode.SRE
STRT:
meaning: cim:AllocationEnergyTypeCode.STRT
SUMR:
meaning: cim:AllocationEnergyTypeCode.SUMR
TCNG:
meaning: cim:AllocationEnergyTypeCode.TCNG
TEST:
meaning: cim:AllocationEnergyTypeCode.TEST
TOR:
meaning: cim:AllocationEnergyTypeCode.TOR
VS:
meaning: cim:AllocationEnergyTypeCode.VS
MarketProductTypeAsReq:
enum_uri: cim:MarketProductTypeAsReq
description: "RU - Regulation Up\r\nRD - Regulation Down\r\nSR - Spin Reserve\r\
\nNR - Nonspin Reserve\r\nAS - Upward Ancillary Service\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
AS:
meaning: cim:MarketProductTypeAsReq.AS
NR:
meaning: cim:MarketProductTypeAsReq.NR
RD:
meaning: cim:MarketProductTypeAsReq.RD
RU:
meaning: cim:MarketProductTypeAsReq.RU
SR:
meaning: cim:MarketProductTypeAsReq.SR
AncillaryCommodityType:
enum_uri: cim:AncillaryCommodityType
description: "ancillary serivce types\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
NONSPIN:
meaning: cim:AncillaryCommodityType.NONSPIN
REGDN:
meaning: cim:AncillaryCommodityType.REGDN
REGUP:
meaning: cim:AncillaryCommodityType.REGUP
SPIN:
meaning: cim:AncillaryCommodityType.SPIN
SourceSinkFlag:
enum_uri: cim:SourceSinkFlag
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
CSNK:
meaning: cim:SourceSinkFlag.CSNK
CSRC:
meaning: cim:SourceSinkFlag.CSRC
BidStatusType:
enum_uri: cim:BidStatusType
description: "Status indication for bids\r\n\r\nCV - Conditionally Valid Bid\r\
\nCM - Conditionally Modified Bid\r\nV - Valid Bid\r\nM - Modified Bid\r\nRJ\
\ - Rejected Bid\r\nI - Invalid Bid\r\nCX - Cancelled Bid\r\nO - Obsolete Bid\r\
\nCL - Clean Bid\r\nRP - Replicated Bid\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
CL:
meaning: cim:BidStatusType.CL
CM:
meaning: cim:BidStatusType.CM
CV:
meaning: cim:BidStatusType.CV
CX:
meaning: cim:BidStatusType.CX
I:
meaning: cim:BidStatusType.I
M:
meaning: cim:BidStatusType.M
O:
meaning: cim:BidStatusType.O
RJ:
meaning: cim:BidStatusType.RJ
RP:
meaning: cim:BidStatusType.RP
V:
meaning: cim:BidStatusType.V
SourceSinkType:
enum_uri: cim:SourceSinkType
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
Neither:
meaning: cim:SourceSinkType.Neither
Sink:
meaning: cim:SourceSinkType.Sink
Source:
meaning: cim:SourceSinkType.Source
DispatchTransactionType:
enum_uri: cim:DispatchTransactionType
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
Purchase:
meaning: cim:DispatchTransactionType.Purchase
Sale:
meaning: cim:DispatchTransactionType.Sale
CleanTradeProductType:
enum_uri: cim:CleanTradeProductType
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
APN:
meaning: cim:CleanTradeProductType.APN
CPT:
meaning: cim:CleanTradeProductType.CPT
NRT:
meaning: cim:CleanTradeProductType.NRT
PHY:
meaning: cim:CleanTradeProductType.PHY
RDT:
meaning: cim:CleanTradeProductType.RDT
RUT:
meaning: cim:CleanTradeProductType.RUT
SRT:
meaning: cim:CleanTradeProductType.SRT
EnergyTypeCode:
enum_uri: cim:EnergyTypeCode
description: "Valid Enumerations:\r\n1) DASE Day Ahead Scheduled Energy; \r\n\
2) DSSE Day Ahead Incremental Self Schedule Energy; \r\n3) DABE Day Ahead Incremental\
\ Energy Bid Awarded Energy; \r\n4) OE Optimal Energy; \r\n5) HASE Hour ahead\
\ pre-dispatched schedule energy; \r\n6) SRE Standard Ramping Energy; \r\n7)\
\ RED Ramping Energy Deviation; \r\n8) EDE Exceptional Dispatch energy; \r\n\
9) RMRE RMR Energy; \r\n10) MSSLFE MSSLF Energy; \r\n11) RE Residual Energy;\
\ \r\n12) MLE Minimum Load Energy; \r\n13) SE SLIC Energy; \r\n14) RTSSE Real\
\ time self scheduled energy; \r\n15) DMLE Day ahead minimum load energy; \r\
\n16) PE Pumping Energy; \r\n17) TEE Total Expected Energy; \r\n18) DAPE - Day-Ahead\
\ Pumping Energy;\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
DABE:
meaning: cim:EnergyTypeCode.DABE
DAPE:
meaning: cim:EnergyTypeCode.DAPE
DASE:
meaning: cim:EnergyTypeCode.DASE
DMLE:
meaning: cim:EnergyTypeCode.DMLE
DSSE:
meaning: cim:EnergyTypeCode.DSSE
EDE:
meaning: cim:EnergyTypeCode.EDE
HASE:
meaning: cim:EnergyTypeCode.HASE
MLE:
meaning: cim:EnergyTypeCode.MLE
MSSLFE:
meaning: cim:EnergyTypeCode.MSSLFE
OE:
meaning: cim:EnergyTypeCode.OE
PE:
meaning: cim:EnergyTypeCode.PE
RE:
meaning: cim:EnergyTypeCode.RE
RED:
meaning: cim:EnergyTypeCode.RED
RMRE:
meaning: cim:EnergyTypeCode.RMRE
RTSSE:
meaning: cim:EnergyTypeCode.RTSSE
SE:
meaning: cim:EnergyTypeCode.SE
SRE:
meaning: cim:EnergyTypeCode.SRE
TEE:
meaning: cim:EnergyTypeCode.TEE
LFCResourceType:
enum_uri: cim:LFCResourceType
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
GEN:
meaning: cim:LFCResourceType.GEN
PUMP:
meaning: cim:LFCResourceType.PUMP
MQSDELType:
enum_uri: cim:MQSDELType
description: "ADD - add\r\nDEL - delete\r\nCHG - change\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
ADD:
meaning: cim:MQSDELType.ADD
CHG:
meaning: cim:MQSDELType.CHG
DEL:
meaning: cim:MQSDELType.DEL
OASISErrDescription:
enum_uri: cim:OASISErrDescription
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
Data can be requested for period of 31 days only:
meaning: cim:OASISErrDescription.Data%20can%20be%20requested%20for%20period%20of%2031%20days%20only
Exceptions in reading and writing of XML files:
meaning: cim:OASISErrDescription.Exceptions%20in%20reading%20and%20writing%20of%20XML%20files
Invalid date format, please use valid date format:
meaning: cim:OASISErrDescription.Invalid%20date%20format%2C%20please%20use%20valid%20date%20format
No data returned for the specified selection:
meaning: cim:OASISErrDescription.No%20data%20returned%20for%20the%20specified%20selection
Out of memory exception:
meaning: cim:OASISErrDescription.Out%20of%20memory%20exception
Report name does not exit, please use valid report name:
meaning: cim:OASISErrDescription.Report%20name%20does%20not%20exit%2C%20please%20use%20valid%20report%20name
Required file does not exist:
meaning: cim:OASISErrDescription.Required%20file%20does%20not%20exist
System Error:
meaning: cim:OASISErrDescription.System%20Error
Timed out waiting for query response:
meaning: cim:OASISErrDescription.Timed%20out%20waiting%20for%20query%20response
Validation exception during transformation of XML:
meaning: cim:OASISErrDescription.Validation%20exception%20during%20transformation%20of%20XML
ADSInstructionTypeCommitment:
enum_uri: cim:ADSInstructionTypeCommitment
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
SHUT_DOWN:
meaning: cim:ADSInstructionTypeCommitment.SHUT_DOWN
START_UP:
meaning: cim:ADSInstructionTypeCommitment.START_UP
LoadFollowingCapacityType:
enum_uri: cim:LoadFollowingCapacityType
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
DOWN:
meaning: cim:LoadFollowingCapacityType.DOWN
UP:
meaning: cim:LoadFollowingCapacityType.UP
SelfScheduleType:
enum_uri: cim:SelfScheduleType
description: "self schedule types\r\n\r\nPT\r\nETC\r\nTOR\r\nRMR\r\nRMT\r\nRGMR\r\
\nORFC\r\nSP\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
BAS:
meaning: cim:SelfScheduleType.BAS
ETC:
meaning: cim:SelfScheduleType.ETC
IFM:
meaning: cim:SelfScheduleType.IFM
LOF:
meaning: cim:SelfScheduleType.LOF
ORFC:
meaning: cim:SelfScheduleType.ORFC
PT:
meaning: cim:SelfScheduleType.PT
PUMP_ETC:
meaning: cim:SelfScheduleType.PUMP_ETC
PUMP_TOR:
meaning: cim:SelfScheduleType.PUMP_TOR
RA:
meaning: cim:SelfScheduleType.RA
RGMR:
meaning: cim:SelfScheduleType.RGMR
RMR:
meaning: cim:SelfScheduleType.RMR
RMT:
meaning: cim:SelfScheduleType.RMT
RUC:
meaning: cim:SelfScheduleType.RUC
SP:
meaning: cim:SelfScheduleType.SP
TOR:
meaning: cim:SelfScheduleType.TOR
WHL:
meaning: cim:SelfScheduleType.WHL
ResourceCertificationType:
enum_uri: cim:ResourceCertificationType
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
GT:
meaning: cim:ResourceCertificationType.GT
IR:
meaning: cim:ResourceCertificationType.IR
NR:
meaning: cim:ResourceCertificationType.NR
RG:
meaning: cim:ResourceCertificationType.RG
SR:
meaning: cim:ResourceCertificationType.SR
runTypeCAISO:
enum_uri: cim:runTypeCAISO
description: "S - Scheduling\r\nP - Pricing\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
P:
meaning: cim:runTypeCAISO.P
S:
meaning: cim:runTypeCAISO.S
CurrentStatusSC:
enum_uri: cim:CurrentStatusSC
description: "ACTIVE\r\nINACTIVE\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
ACTIVE:
meaning: cim:CurrentStatusSC.ACTIVE
INACTIVE:
meaning: cim:CurrentStatusSC.INACTIVE
DispatchAcceptStatus:
enum_uri: cim:DispatchAcceptStatus
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
ACCEPT:
meaning: cim:DispatchAcceptStatus.ACCEPT
CANNOT:
meaning: cim:DispatchAcceptStatus.CANNOT
DECLINE:
meaning: cim:DispatchAcceptStatus.DECLINE
NON_RESPONSE:
meaning: cim:DispatchAcceptStatus.NON_RESPONSE
OK:
meaning: cim:DispatchAcceptStatus.OK
PARTIAL:
meaning: cim:DispatchAcceptStatus.PARTIAL
TimeZoneType:
enum_uri: cim:TimeZoneType
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
PPT:
meaning: cim:TimeZoneType.PPT
UnitTypeEMS:
enum_uri: cim:UnitTypeEMS
description: "MW\r\nFLAG\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
FLAG:
meaning: cim:UnitTypeEMS.FLAG
MW:
meaning: cim:UnitTypeEMS.MW
BidPriceCapType:
enum_uri: cim:BidPriceCapType
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
AS:
meaning: cim:BidPriceCapType.AS
ENERGY:
meaning: cim:BidPriceCapType.ENERGY
RUC:
meaning: cim:BidPriceCapType.RUC
JobStartEndType:
enum_uri: cim:JobStartEndType
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
END:
meaning: cim:JobStartEndType.END
NA:
meaning: cim:JobStartEndType.NA
START:
meaning: cim:JobStartEndType.START
TradeProductType:
enum_uri: cim:TradeProductType
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
APN:
meaning: cim:TradeProductType.APN
CAP:
meaning: cim:TradeProductType.CAP
NRT:
meaning: cim:TradeProductType.NRT
PHY:
meaning: cim:TradeProductType.PHY
RDT:
meaning: cim:TradeProductType.RDT
RUT:
meaning: cim:TradeProductType.RUT
SRT:
meaning: cim:TradeProductType.SRT
MeasurementTypeEMS:
enum_uri: cim:MeasurementTypeEMS
description: "Path Flow - PF\r\nPath Inflow Limit - PIL\r\nPath Inflow Available\
\ Limit - PIAL \r\nPath Inflow Armed Limit - PIML\r\nPath Outflow Limit - POL\r\
\nPath Outflow Available Limit - POAL \r\nPath Outflow Armed Limit - OARL\r\n\
Generation Output - GO \r\nGeneration Max Operating Limit - GMOL \r\nGeneration\
\ Min Operating Limit - GNOL \r\nGeneration Regulation - GR \r\nGeneration Status\
\ - GS \r\nPump Production - PP \r\nSystem Load - SL \r\nSystem ACE - ACE\r\n\
System INADV - INADV\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
ACE:
meaning: cim:MeasurementTypeEMS.ACE
GMOL:
meaning: cim:MeasurementTypeEMS.GMOL
GNOL:
meaning: cim:MeasurementTypeEMS.GNOL
GO:
meaning: cim:MeasurementTypeEMS.GO
GR:
meaning: cim:MeasurementTypeEMS.GR
GS:
meaning: cim:MeasurementTypeEMS.GS
INADV:
meaning: cim:MeasurementTypeEMS.INADV
OARL:
meaning: cim:MeasurementTypeEMS.OARL
PF:
meaning: cim:MeasurementTypeEMS.PF
PIAL:
meaning: cim:MeasurementTypeEMS.PIAL
PIL:
meaning: cim:MeasurementTypeEMS.PIL
PIML:
meaning: cim:MeasurementTypeEMS.PIML
POAL:
meaning: cim:MeasurementTypeEMS.POAL
POL:
meaning: cim:MeasurementTypeEMS.POL
PP:
meaning: cim:MeasurementTypeEMS.PP
SL:
meaning: cim:MeasurementTypeEMS.SL
JobFlagType:
enum_uri: cim:JobFlagType
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
CREATED:
meaning: cim:JobFlagType.CREATED
DELETED:
meaning: cim:JobFlagType.DELETED
MODIFIED:
meaning: cim:JobFlagType.MODIFIED
SystemType:
enum_uri: cim:SystemType
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
OASIS:
meaning: cim:SystemType.OASIS
MktSubClassType:
enum_uri: cim:MktSubClassType
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
Branch_Group_Derates:
meaning: cim:MktSubClassType.Branch_Group_Derates
Day_Ahead_Final_Market_Info:
meaning: cim:MktSubClassType.Day_Ahead_Final_Market_Info
Day_Ahead_Forecast_Information:
meaning: cim:MktSubClassType.Day_Ahead_Forecast_Information
Day_Ahead_Interim_Market_Info:
meaning: cim:MktSubClassType.Day_Ahead_Interim_Market_Info
Day_Ahead_RMR:
meaning: cim:MktSubClassType.Day_Ahead_RMR
Forecasted_UDC_Direct_Access_Load:
meaning: cim:MktSubClassType.Forecasted_UDC_Direct_Access_Load
Hour_Ahead_Market_Info:
meaning: cim:MktSubClassType.Hour_Ahead_Market_Info
Hourly_Expost_Market_Info:
meaning: cim:MktSubClassType.Hourly_Expost_Market_Info
Public_Bid_Data:
meaning: cim:MktSubClassType.Public_Bid_Data
Ten_Min_Expost_Market_Info:
meaning: cim:MktSubClassType.Ten_Min_Expost_Market_Info
TTC/ATC_Forecast_Information:
meaning: cim:MktSubClassType.TTC/ATC_Forecast_Information
TTC/ATC_Hourly_Forecast:
meaning: cim:MktSubClassType.TTC/ATC_Hourly_Forecast
AlarmDisplayType:
enum_uri: cim:AlarmDisplayType
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
Appear:
meaning: cim:AlarmDisplayType.Appear
Disappear:
meaning: cim:AlarmDisplayType.Disappear
Fleeting:
meaning: cim:AlarmDisplayType.Fleeting
OASISBidReportType:
enum_uri: cim:OASISBidReportType
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
BIDS_PUBLIC:
meaning: cim:OASISBidReportType.BIDS_PUBLIC
SelfSchedTypeCleanBid:
enum_uri: cim:SelfSchedTypeCleanBid
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
BAS:
meaning: cim:SelfSchedTypeCleanBid.BAS
ETC:
meaning: cim:SelfSchedTypeCleanBid.ETC
IFM:
meaning: cim:SelfSchedTypeCleanBid.IFM
LOF:
meaning: cim:SelfSchedTypeCleanBid.LOF
LPT:
meaning: cim:SelfSchedTypeCleanBid.LPT
PT:
meaning: cim:SelfSchedTypeCleanBid.PT
RA:
meaning: cim:SelfSchedTypeCleanBid.RA
RMT:
meaning: cim:SelfSchedTypeCleanBid.RMT
SP:
meaning: cim:SelfSchedTypeCleanBid.SP
TOR:
meaning: cim:SelfSchedTypeCleanBid.TOR
WHL:
meaning: cim:SelfSchedTypeCleanBid.WHL
MarketStatementDocType:
enum_uri: cim:MarketStatementDocType
description: "market statement document type\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC62325.InfIEC62325.InfDomain
permissible_values:
CREDIT:
meaning: cim:MarketStatementDocType.CREDIT
MARKET_INITIAL:
meaning: cim:MarketStatementDocType.MARKET_INITIAL
MARKET_RECALC:
meaning: cim:MarketStatementDocType.MARKET_RECALC