ShuntCompensatorControl

Distribution capacitor bank control settings.

Type

Class

URI

cim:ShuntCompensatorControl

CIM standard (perspective)

IEC61968 (Enterprise)

Class hierarchy

Slots

Associated classes
Figure 1. Associated classes
Name Cardinality Type Description

InstanceSet

1

InstanceSet

Dataset containing the data objects.

ShuntCompensatorInfo

0..1

ShuntCompensatorInfo

n/a

branchDirect

0..1

integer

For VAR, amp, or power factor locally controlled shunt impedances, the flow direction: in, out.

cellSize

0..1

ReactivePower

The size of the individual units that make up the bank.

controlKind

0..1

ShuntImpedanceControlKind

Kind of control (if any).

highVoltageOverride

0..1

PU

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

0..1

ShuntImpedanceLocalControlKind

Kind of local controller.

localOffLevel

0..1

string

Upper control setting.

localOnLevel

0..1

string

Lower control setting.

localOverride

0..1

boolean

True if the locally controlled capacitor has voltage override capability.

lowVoltageOverride

0..1

PU

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

0..1

integer

IdmsShuntImpedanceData.maxNumSwitchOps.

normalOpen

0..1

boolean

True if open is normal status for a fixed capacitor bank, otherwise normal status is closed.

regBranch

0..1

string

For VAR, amp, or power factor locally controlled shunt impedances, the index of the regulation branch.

regBranchEnd

0..1

integer

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

0..1

RegulationBranchKind

(For VAR, amp, or power factor locally controlled shunt impedances) Kind of regulation branch.

sensingPhaseCode

0..1

PhaseCode

Phases that are measured for controlling the device.

switchOperationCycle

0..1

Hours

Time interval between consecutive switching operations.

vRegLineLine

0..1

boolean

True if regulated voltages are measured line to line, otherwise they are measured line to ground.

AssetDatasheet

0..1

AssetInfo

Datasheet information for this power system resource.

Location

0..1

Location

Location of this power system resource.

PSRType

0..1

PSRType

Custom classification for this power system resource.

PropertiesCIMDataObject

0..1

ChangeSetMember

The single CIM data object in the appropriate dataset context.

Terminal

0..1

Terminal

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.

aliasName

0..1

string

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

description

0..1

string

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

discrete

0..1

boolean

The regulation is performed in a discrete mode. This applies to equipment with discrete controls, e.g. tap changers and shunt compensators.

enabled

0..1

boolean

The flag tells if regulation is enabled.

mRID

0..1

string

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

maxAllowedTargetValue

0..1

float

Maximum allowed target value (RegulatingControl.targetValue).

minAllowedTargetValue

0..1

float

Minimum allowed target value (RegulatingControl.targetValue).

mode

0..1

RegulatingControlModeKind

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

0..1

PhaseCode

Phase voltage controlling this regulator, measured at regulator location.

name

0..1

string

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

targetDeadband

0..1

float

This is a deadband used with discrete control to avoid excessive update of controls like tap changers and shunt compensator banks while regulating. The units of those appropriate for the mode. The attribute shall be a positive value or zero. If RegulatingControl.discrete is set to "false", the RegulatingControl.targetDeadband is to be ignored. Note that for instance, if the targetValue is 100 kV and the targetDeadband is 2 kV the range is from 99 to 101 kV.

targetValue

0..1

float

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

0..1

UnitMultiplier

Specify the multiplier for used for the targetValue.

Assets

0..*

Asset

All assets represented by this power system resource. For example, multiple conductor assets are electrically modelled as a single AC line segment.

Clearances

0..*

ClearanceDocument

All clearances applicable to this power system resource.

ConfigurationEvent

0..*

ConfigurationEvent

All configuration events created for this Power System resource.

Controls

0..*

Control

The controller outputs used to actually govern a regulating device, e.g. the magnetization of a synchronous machine or capacitor bank breaker actuator.

DiagramObjects

0..*

DiagramObject

The diagram objects that are associated with the domain object.

GenericAction

0..*

GenericAction

The generic action that is performed on the power system resource

Measurements

0..*

Measurement

The measurements associated with this power system resource.

Names

0..*

Name

All names of this identified object.

OperatingShare

0..*

OperatingShare

The operating shares of this power system resource.

OperationalTags

0..*

OperationalTag

All operational tags placed on this power system resource.

PSREvents

0..*

PSREvent

All events associated with this power system resource.

ProtectiveActionRegulation

0..*

ProtectiveActionRegulation

Enable/disable a regulating control or set new target value.

RegulatingCondEq

0..*

RegulatingCondEq

The equipment that participates in this regulating control scheme.

RegulationSchedule

0..*

RegulationSchedule

Schedule for this regulating control.

ReportingGroup

0..*

ReportingGroup

Reporting groups to which this power system resource belongs.

TargetingCIMDataObject

0..*

ChangeSetMember

Data objects registered.

VerificationAction

0..*

VerificationAction

The verification action that is performed on the power system resource


aliasName

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

URI

cim:IdentifiedObject.aliasName

Cardinality

0..1

Type

string

Inherited from

IdentifiedObject

AssetDatasheet

Datasheet information for this power system resource.

URI

cim:PowerSystemResource.AssetDatasheet

Cardinality

0..1

Type

AssetInfo

Inherited from

PowerSystemResource

Assets

All assets represented by this power system resource. For example, multiple conductor assets are electrically modelled as a single AC line segment.

URI

cim:PowerSystemResource.Assets

Cardinality

0..*

Type

Asset

Inherited from

PowerSystemResource

branchDirect

For VAR, amp, or power factor locally controlled shunt impedances, the flow direction: in, out.

URI

cim:ShuntCompensatorControl.branchDirect

Cardinality

0..1

Type

integer

cellSize

The size of the individual units that make up the bank.

URI

cim:ShuntCompensatorControl.cellSize

Cardinality

0..1

Type

ReactivePower

Clearances

All clearances applicable to this power system resource.

URI

cim:PowerSystemResource.Clearances

Cardinality

0..*

Type

ClearanceDocument

Inherited from

PowerSystemResource

ConfigurationEvent

All configuration events created for this Power System resource.

URI

cim:PowerSystemResource.ConfigurationEvent

Cardinality

0..*

Type

ConfigurationEvent

Inherited from

PowerSystemResource

controlKind

Kind of control (if any).

URI

cim:ShuntCompensatorControl.controlKind

Cardinality

0..1

Type

ShuntImpedanceControlKind

Controls

The controller outputs used to actually govern a regulating device, e.g. the magnetization of a synchronous machine or capacitor bank breaker actuator.

URI

cim:PowerSystemResource.Controls

Cardinality

0..*

Type

Control

Inherited from

PowerSystemResource

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.

URI

cim:IdentifiedObject.description

Cardinality

0..1

Type

string

Inherited from

IdentifiedObject

DiagramObjects

The diagram objects that are associated with the domain object.

URI

cim:IdentifiedObject.DiagramObjects

Cardinality

0..*

Type

DiagramObject

Inherited from

IdentifiedObject

discrete

The regulation is performed in a discrete mode. This applies to equipment with discrete controls, e.g. tap changers and shunt compensators.

URI

cim:RegulatingControl.discrete

Cardinality

0..1

Type

boolean

Inherited from

RegulatingControl

enabled

The flag tells if regulation is enabled.

URI

cim:RegulatingControl.enabled

Cardinality

0..1

Type

boolean

Inherited from

RegulatingControl

GenericAction

The generic action that is performed on the power system resource

URI

cim:PowerSystemResource.GenericAction

Cardinality

0..*

Type

GenericAction

Inherited from

PowerSystemResource

highVoltageOverride

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.

URI

cim:ShuntCompensatorControl.highVoltageOverride

Cardinality

0..1

Type

PU

InstanceSet

Dataset containing the data objects.

URI

cim:IdentifiedObject.InstanceSet

Cardinality

1

Type

InstanceSet

Inherited from

IdentifiedObject

localControlKind

Kind of local controller.

URI

cim:ShuntCompensatorControl.localControlKind

Cardinality

0..1

Type

ShuntImpedanceLocalControlKind

localOffLevel

Upper control setting.

URI

cim:ShuntCompensatorControl.localOffLevel

Cardinality

0..1

Type

string

localOnLevel

Lower control setting.

URI

cim:ShuntCompensatorControl.localOnLevel

Cardinality

0..1

Type

string

localOverride

True if the locally controlled capacitor has voltage override capability.

URI

cim:ShuntCompensatorControl.localOverride

Cardinality

0..1

Type

boolean

Location

Location of this power system resource.

URI

cim:PowerSystemResource.Location

Cardinality

0..1

Type

Location

Inherited from

PowerSystemResource

lowVoltageOverride

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.

URI

cim:ShuntCompensatorControl.lowVoltageOverride

Cardinality

0..1

Type

PU

maxAllowedTargetValue

Maximum allowed target value (RegulatingControl.targetValue).

URI

cim:RegulatingControl.maxAllowedTargetValue

Cardinality

0..1

Type

float

Inherited from

RegulatingControl

maxSwitchOperationCount

IdmsShuntImpedanceData.maxNumSwitchOps.

URI

cim:ShuntCompensatorControl.maxSwitchOperationCount

Cardinality

0..1

Type

integer

Measurements

The measurements associated with this power system resource.

URI

cim:PowerSystemResource.Measurements

Cardinality

0..*

Type

Measurement

Inherited from

PowerSystemResource

minAllowedTargetValue

Minimum allowed target value (RegulatingControl.targetValue).

URI

cim:RegulatingControl.minAllowedTargetValue

Cardinality

0..1

Type

float

Inherited from

RegulatingControl

mode

The regulating control mode presently available. This specification allows for determining the kind of regulation without need for obtaining the units from a schedule.

URI

cim:RegulatingControl.mode

Cardinality

0..1

Type

RegulatingControlModeKind

Inherited from

RegulatingControl

monitoredPhase

Phase voltage controlling this regulator, measured at regulator location.

URI

cim:RegulatingControl.monitoredPhase

Cardinality

0..1

Type

PhaseCode

Inherited from

RegulatingControl

mRID

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

URI

cim:IdentifiedObject.mRID

Cardinality

0..1

Type

string

Inherited from

IdentifiedObject

name

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

URI

cim:IdentifiedObject.name

Cardinality

0..1

Type

string

Inherited from

IdentifiedObject

Names

All names of this identified object.

URI

cim:IdentifiedObject.Names

Cardinality

0..*

Type

Name

Inherited from

IdentifiedObject

normalOpen

True if open is normal status for a fixed capacitor bank, otherwise normal status is closed.

URI

cim:ShuntCompensatorControl.normalOpen

Cardinality

0..1

Type

boolean

OperatingShare

The operating shares of this power system resource.

URI

cim:PowerSystemResource.OperatingShare

Cardinality

0..*

Type

OperatingShare

Inherited from

PowerSystemResource

OperationalTags

All operational tags placed on this power system resource.

URI

cim:PowerSystemResource.OperationalTags

Cardinality

0..*

Type

OperationalTag

Inherited from

PowerSystemResource

PropertiesCIMDataObject

The single CIM data object in the appropriate dataset context.

URI

cim:IdentifiedObject.PropertiesCIMDataObject

Cardinality

0..1

Type

ChangeSetMember

Inherited from

IdentifiedObject

ProtectiveActionRegulation

Enable/disable a regulating control or set new target value.

URI

cim:RegulatingControl.ProtectiveActionRegulation

Cardinality

0..*

Type

ProtectiveActionRegulation

Inherited from

RegulatingControl

PSREvents

All events associated with this power system resource.

URI

cim:PowerSystemResource.PSREvents

Cardinality

0..*

Type

PSREvent

Inherited from

PowerSystemResource

PSRType

Custom classification for this power system resource.

URI

cim:PowerSystemResource.PSRType

Cardinality

0..1

Type

PSRType

Inherited from

PowerSystemResource

regBranch

For VAR, amp, or power factor locally controlled shunt impedances, the index of the regulation branch.

URI

cim:ShuntCompensatorControl.regBranch

Cardinality

0..1

Type

string

regBranchEnd

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

URI

cim:ShuntCompensatorControl.regBranchEnd

Cardinality

0..1

Type

integer

regBranchKind

(For VAR, amp, or power factor locally controlled shunt impedances) Kind of regulation branch.

URI

cim:ShuntCompensatorControl.regBranchKind

Cardinality

0..1

Type

RegulationBranchKind

RegulatingCondEq

The equipment that participates in this regulating control scheme.

URI

cim:RegulatingControl.RegulatingCondEq

Cardinality

0..*

Type

RegulatingCondEq

Inherited from

RegulatingControl

RegulationSchedule

Schedule for this regulating control.

URI

cim:RegulatingControl.RegulationSchedule

Cardinality

0..*

Type

RegulationSchedule

Inherited from

RegulatingControl

ReportingGroup

Reporting groups to which this power system resource belongs.

URI

cim:PowerSystemResource.ReportingGroup

Cardinality

0..*

Type

ReportingGroup

Inherited from

PowerSystemResource

sensingPhaseCode

Phases that are measured for controlling the device.

URI

cim:ShuntCompensatorControl.sensingPhaseCode

Cardinality

0..1

Type

PhaseCode

ShuntCompensatorInfo

URI

cim:ShuntCompensatorControl.ShuntCompensatorInfo

Cardinality

0..1

Type

ShuntCompensatorInfo

switchOperationCycle

Time interval between consecutive switching operations.

URI

cim:ShuntCompensatorControl.switchOperationCycle

Cardinality

0..1

Type

Hours

targetDeadband

This is a deadband used with discrete control to avoid excessive update of controls like tap changers and shunt compensator banks while regulating. The units of those appropriate for the mode. The attribute shall be a positive value or zero. If RegulatingControl.discrete is set to "false", the RegulatingControl.targetDeadband is to be ignored. Note that for instance, if the targetValue is 100 kV and the targetDeadband is 2 kV the range is from 99 to 101 kV.

URI

cim:RegulatingControl.targetDeadband

Cardinality

0..1

Type

float

Inherited from

RegulatingControl

TargetingCIMDataObject

Data objects registered.

URI

cim:IdentifiedObject.TargetingCIMDataObject

Cardinality

0..*

Type

ChangeSetMember

Inherited from

IdentifiedObject

targetValue

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.

URI

cim:RegulatingControl.targetValue

Cardinality

0..1

Type

float

Inherited from

RegulatingControl

targetValueUnitMultiplier

Specify the multiplier for used for the targetValue.

URI

cim:RegulatingControl.targetValueUnitMultiplier

Cardinality

0..1

Type

UnitMultiplier

Inherited from

RegulatingControl

Terminal

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.

URI

cim:RegulatingControl.Terminal

Cardinality

0..1

Type

Terminal

Inherited from

RegulatingControl

VerificationAction

The verification action that is performed on the power system resource

URI

cim:PowerSystemResource.VerificationAction

Cardinality

0..*

Type

VerificationAction

Inherited from

PowerSystemResource

vRegLineLine

True if regulated voltages are measured line to line, otherwise they are measured line to ground.

URI

cim:ShuntCompensatorControl.vRegLineLine

Cardinality

0..1

Type

boolean