Class: ShuntCompensatorControl
Distribution capacitor bank control settings.
URI: cim:ShuntCompensatorControl
classDiagram
class ShuntCompensatorControl
RegulatingControl <|-- ShuntCompensatorControl
ShuntCompensatorControl : alias_name
ShuntCompensatorControl : asset_datasheet
ShuntCompensatorControl --> AssetInfo : asset_datasheet
ShuntCompensatorControl : assets
ShuntCompensatorControl --> Asset : assets
ShuntCompensatorControl : branch_direct
ShuntCompensatorControl : cell_size
ShuntCompensatorControl --> ReactivePower : cell_size
ShuntCompensatorControl : clearances
ShuntCompensatorControl --> ClearanceDocument : clearances
ShuntCompensatorControl : configuration_event
ShuntCompensatorControl --> ConfigurationEvent : configuration_event
ShuntCompensatorControl : control_kind
ShuntCompensatorControl --> ShuntImpedanceControlKind : control_kind
ShuntCompensatorControl : controls
ShuntCompensatorControl --> Control : controls
ShuntCompensatorControl : description
ShuntCompensatorControl : diagram_objects
ShuntCompensatorControl --> DiagramObject : diagram_objects
ShuntCompensatorControl : discrete
ShuntCompensatorControl : enabled
ShuntCompensatorControl : generic_action
ShuntCompensatorControl --> GenericAction : generic_action
ShuntCompensatorControl : high_voltage_override
ShuntCompensatorControl --> PU : high_voltage_override
ShuntCompensatorControl : instance_set
ShuntCompensatorControl --> InstanceSet : instance_set
ShuntCompensatorControl : local_control_kind
ShuntCompensatorControl --> ShuntImpedanceLocalControlKind : local_control_kind
ShuntCompensatorControl : local_off_level
ShuntCompensatorControl : local_on_level
ShuntCompensatorControl : local_override
ShuntCompensatorControl : location
ShuntCompensatorControl --> Location : location
ShuntCompensatorControl : low_voltage_override
ShuntCompensatorControl --> PU : low_voltage_override
ShuntCompensatorControl : m_rid
ShuntCompensatorControl : max_allowed_target_value
ShuntCompensatorControl : max_switch_operation_count
ShuntCompensatorControl : measurements
ShuntCompensatorControl --> Measurement : measurements
ShuntCompensatorControl : min_allowed_target_value
ShuntCompensatorControl : mode
ShuntCompensatorControl --> RegulatingControlModeKind : mode
ShuntCompensatorControl : monitored_phase
ShuntCompensatorControl --> PhaseCode : monitored_phase
ShuntCompensatorControl : names
ShuntCompensatorControl --> Name : names
ShuntCompensatorControl : normal_open
ShuntCompensatorControl : operating_share
ShuntCompensatorControl --> OperatingShare : operating_share
ShuntCompensatorControl : operational_tags
ShuntCompensatorControl --> OperationalTag : operational_tags
ShuntCompensatorControl : properties_cimdata_object
ShuntCompensatorControl --> ChangeSetMember : properties_cimdata_object
ShuntCompensatorControl : protective_action_regulation
ShuntCompensatorControl --> ProtectiveActionRegulation : protective_action_regulation
ShuntCompensatorControl : psrevents
ShuntCompensatorControl --> PSREvent : psrevents
ShuntCompensatorControl : psrtype
ShuntCompensatorControl --> PSRType : psrtype
ShuntCompensatorControl : reg_branch
ShuntCompensatorControl : reg_branch_end
ShuntCompensatorControl : reg_branch_kind
ShuntCompensatorControl --> RegulationBranchKind : reg_branch_kind
ShuntCompensatorControl : regulating_cond_eq
ShuntCompensatorControl --> RegulatingCondEq : regulating_cond_eq
ShuntCompensatorControl : regulation_schedule
ShuntCompensatorControl --> RegulationSchedule : regulation_schedule
ShuntCompensatorControl : reporting_group
ShuntCompensatorControl --> ReportingGroup : reporting_group
ShuntCompensatorControl : sensing_phase_code
ShuntCompensatorControl --> PhaseCode : sensing_phase_code
ShuntCompensatorControl : shunt_compensator_info
ShuntCompensatorControl --> ShuntCompensatorInfo : shunt_compensator_info
ShuntCompensatorControl : switch_operation_cycle
ShuntCompensatorControl --> Hours : switch_operation_cycle
ShuntCompensatorControl : target_deadband
ShuntCompensatorControl : target_value
ShuntCompensatorControl : target_value_unit_multiplier
ShuntCompensatorControl --> UnitMultiplier : target_value_unit_multiplier
ShuntCompensatorControl : targeting_cimdata_object
ShuntCompensatorControl --> ChangeSetMember : targeting_cimdata_object
ShuntCompensatorControl : terminal
ShuntCompensatorControl --> Terminal : terminal
ShuntCompensatorControl : v_reg_line_line
ShuntCompensatorControl : verification_action
ShuntCompensatorControl --> VerificationAction : verification_action
Inheritance
- IdentifiedObject
- PowerSystemResource
- RegulatingControl
- ShuntCompensatorControl
- RegulatingControl
- PowerSystemResource
Slots
| Name | Cardinality and Range | Description | Inheritance |
|---|---|---|---|
| branch_direct | 0..1 Integer |
For VAR, amp, or power factor locally controlled shunt impedances, the flow d... | direct |
| cell_size | 0..1 ReactivePower |
The size of the individual units that make up the bank | direct |
| control_kind | 0..1 ShuntImpedanceControlKind |
Kind of control (if any) | direct |
| high_voltage_override | 0..1 PU |
For locally controlled shunt impedances which have a voltage override feature... | direct |
| local_control_kind | 0..1 ShuntImpedanceLocalControlKind |
Kind of local controller | direct |
| local_off_level | 0..1 String |
Upper control setting | direct |
| local_on_level | 0..1 String |
Lower control setting | direct |
| local_override | 0..1 Boolean |
True if the locally controlled capacitor has voltage override capability | direct |
| low_voltage_override | 0..1 PU |
For locally controlled shunt impedances which have a voltage override feature... | direct |
| max_switch_operation_count | 0..1 Integer |
IdmsShuntImpedanceData | direct |
| normal_open | 0..1 Boolean |
True if open is normal status for a fixed capacitor bank, otherwise normal st... | direct |
| reg_branch | 0..1 String |
For VAR, amp, or power factor locally controlled shunt impedances, the index ... | direct |
| reg_branch_end | 0..1 Integer |
For VAR, amp, or power factor locally controlled shunt impedances, the end of... | direct |
| reg_branch_kind | 0..1 RegulationBranchKind |
(For VAR, amp, or power factor locally controlled shunt impedances) Kind of r... | direct |
| sensing_phase_code | 0..1 PhaseCode |
Phases that are measured for controlling the device | direct |
| switch_operation_cycle | 0..1 Hours |
Time interval between consecutive switching operations | direct |
| v_reg_line_line | 0..1 Boolean |
True if regulated voltages are measured line to line, otherwise they are meas... | direct |
| shunt_compensator_info | 0..1 ShuntCompensatorInfo |
direct | |
| discrete | 0..1 Boolean |
The regulation is performed in a discrete mode | RegulatingControl |
| enabled | 0..1 Boolean |
The flag tells if regulation is enabled | RegulatingControl |
| max_allowed_target_value | 0..1 Float |
Maximum allowed target value (RegulatingControl | RegulatingControl |
| min_allowed_target_value | 0..1 Float |
Minimum allowed target value (RegulatingControl | RegulatingControl |
| mode | 0..1 RegulatingControlModeKind |
The regulating control mode presently available | RegulatingControl |
| monitored_phase | 0..1 PhaseCode |
Phase voltage controlling this regulator, measured at regulator location | RegulatingControl |
| target_deadband | 0..1 Float |
This is a deadband used with discrete control to avoid excessive update of co... | RegulatingControl |
| target_value | 0..1 Float |
The target value specified for case input | RegulatingControl |
| target_value_unit_multiplier | 0..1 UnitMultiplier |
Specify the multiplier for used for the targetValue | RegulatingControl |
| regulating_cond_eq | 0..* RegulatingCondEq |
The equipment that participates in this regulating control scheme | RegulatingControl |
| regulation_schedule | 0..* RegulationSchedule |
Schedule for this regulating control | RegulatingControl |
| terminal | 0..1 Terminal |
The terminal associated with this regulating control | RegulatingControl |
| protective_action_regulation | 0..* ProtectiveActionRegulation |
Enable/disable a regulating control or set new target value | RegulatingControl |
| controls | 0..* Control |
The controller outputs used to actually govern a regulating device, e | PowerSystemResource |
| measurements | 0..* Measurement |
The measurements associated with this power system resource | PowerSystemResource |
| psrtype | 0..1 PSRType |
Custom classification for this power system resource | PowerSystemResource |
| configuration_event | 0..* ConfigurationEvent |
All configuration events created for this Power System resource | PowerSystemResource |
| reporting_group | 0..* ReportingGroup |
Reporting groups to which this power system resource belongs | PowerSystemResource |
| operating_share | 0..* OperatingShare |
The operating shares of this power system resource | PowerSystemResource |
| asset_datasheet | 0..1 AssetInfo |
Datasheet information for this power system resource | PowerSystemResource |
| verification_action | 0..* VerificationAction |
The verification action that is performed on the power system resource | PowerSystemResource |
| clearances | 0..* ClearanceDocument |
All clearances applicable to this power system resource | PowerSystemResource |
| generic_action | 0..* GenericAction |
The generic action that is performed on the power system resource | PowerSystemResource |
| psrevents | 0..* PSREvent |
All events associated with this power system resource | PowerSystemResource |
| assets | 0..* Asset |
All assets represented by this power system resource | PowerSystemResource |
| location | 0..1 Location |
Location of this power system resource | PowerSystemResource |
| operational_tags | 0..* OperationalTag |
All operational tags placed on this power system resource | PowerSystemResource |
| alias_name | 0..1 String |
The aliasName is free text human readable name of the object alternative to I... | IdentifiedObject |
| description | 0..1 String |
The description is a free human readable text describing or naming the object | IdentifiedObject |
| m_rid | 0..1 String |
Master resource identifier issued by a model authority | IdentifiedObject |
| diagram_objects | 0..* DiagramObject |
The diagram objects that are associated with the domain object | IdentifiedObject |
| instance_set | 1..1 InstanceSet |
Dataset containing the data objects | IdentifiedObject |
| names | 0..* Name |
All names of this identified object | IdentifiedObject |
| properties_cimdata_object | 0..1 ChangeSetMember |
The single CIM data object in the appropriate dataset context | IdentifiedObject |
| targeting_cimdata_object | 0..* ChangeSetMember |
Data objects registered | IdentifiedObject |
Usages
| used by | used in | type | used |
|---|---|---|---|
| ShuntCompensatorInfo | shunt_compensator_control | range | ShuntCompensatorControl |
Identifier and Mapping Information
Schema Source
- from schema: https://cim.ucaiug.io/ns#TC57CIM
Mappings
| Mapping Type | Mapped Value |
|---|---|
| self | cim:ShuntCompensatorControl |
| native | cim:ShuntCompensatorControl |
LinkML Source
Direct
name: ShuntCompensatorControl
description: Distribution capacitor bank control settings.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: RegulatingControl
attributes:
branch_direct:
name: branch_direct
description: 'For VAR, amp, or power factor locally controlled shunt impedances,
the flow direction: in, out.'
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ShuntCompensatorControl.branchDirect
multivalued: false
domain_of:
- ShuntCompensatorControl
range: integer
required: false
cell_size:
name: cell_size
description: The size of the individual units that make up the bank.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ShuntCompensatorControl.cellSize
multivalued: false
domain_of:
- ShuntCompensatorControl
range: ReactivePower
required: false
control_kind:
name: control_kind
description: Kind of control (if any).
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ShuntCompensatorControl.controlKind
multivalued: false
domain_of:
- ShuntCompensatorControl
range: ShuntImpedanceControlKind
required: false
high_voltage_override:
name: high_voltage_override
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.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ShuntCompensatorControl.highVoltageOverride
multivalued: false
domain_of:
- ShuntCompensatorControl
range: PU
required: false
local_control_kind:
name: local_control_kind
description: Kind of local controller.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ShuntCompensatorControl.localControlKind
multivalued: false
domain_of:
- ShuntCompensatorControl
range: ShuntImpedanceLocalControlKind
required: false
local_off_level:
name: local_off_level
description: Upper control setting.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ShuntCompensatorControl.localOffLevel
multivalued: false
domain_of:
- ShuntCompensatorControl
range: string
required: false
local_on_level:
name: local_on_level
description: Lower control setting.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ShuntCompensatorControl.localOnLevel
multivalued: false
domain_of:
- ShuntCompensatorControl
range: string
required: false
local_override:
name: local_override
description: True if the locally controlled capacitor has voltage override capability.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ShuntCompensatorControl.localOverride
multivalued: false
domain_of:
- ShuntCompensatorControl
range: boolean
required: false
low_voltage_override:
name: low_voltage_override
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.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ShuntCompensatorControl.lowVoltageOverride
multivalued: false
domain_of:
- ShuntCompensatorControl
range: PU
required: false
max_switch_operation_count:
name: max_switch_operation_count
description: "IdmsShuntImpedanceData.maxNumSwitchOps.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ShuntCompensatorControl.maxSwitchOperationCount
multivalued: false
domain_of:
- ShuntCompensatorControl
range: integer
required: false
normal_open:
name: normal_open
description: True if open is normal status for a fixed capacitor bank, otherwise
normal status is closed.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:ShuntCompensatorControl.normalOpen
multivalued: false
domain_of:
- Switch
- SwitchPhase
- ShuntCompensatorControl
range: boolean
required: false
reg_branch:
name: reg_branch
description: For VAR, amp, or power factor locally controlled shunt impedances,
the index of the regulation branch.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ShuntCompensatorControl.regBranch
multivalued: false
domain_of:
- ShuntCompensatorControl
range: string
required: false
reg_branch_end:
name: reg_branch_end
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).'
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ShuntCompensatorControl.regBranchEnd
multivalued: false
domain_of:
- ShuntCompensatorControl
range: integer
required: false
reg_branch_kind:
name: reg_branch_kind
description: (For VAR, amp, or power factor locally controlled shunt impedances)
Kind of regulation branch.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ShuntCompensatorControl.regBranchKind
multivalued: false
domain_of:
- ShuntCompensatorControl
range: RegulationBranchKind
required: false
sensing_phase_code:
name: sensing_phase_code
description: Phases that are measured for controlling the device.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ShuntCompensatorControl.sensingPhaseCode
multivalued: false
domain_of:
- ShuntCompensatorControl
range: PhaseCode
required: false
switch_operation_cycle:
name: switch_operation_cycle
description: Time interval between consecutive switching operations.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ShuntCompensatorControl.switchOperationCycle
multivalued: false
domain_of:
- ShuntCompensatorControl
range: Hours
required: false
v_reg_line_line:
name: v_reg_line_line
description: True if regulated voltages are measured line to line, otherwise they
are measured line to ground.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ShuntCompensatorControl.vRegLineLine
multivalued: false
domain_of:
- ShuntCompensatorControl
range: boolean
required: false
shunt_compensator_info:
name: shunt_compensator_info
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ShuntCompensatorControl.ShuntCompensatorInfo
multivalued: false
domain_of:
- ShuntCompensatorControl
range: ShuntCompensatorInfo
required: false
class_uri: cim:ShuntCompensatorControl
Induced
name: ShuntCompensatorControl
description: Distribution capacitor bank control settings.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: RegulatingControl
attributes:
branch_direct:
name: branch_direct
description: 'For VAR, amp, or power factor locally controlled shunt impedances,
the flow direction: in, out.'
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ShuntCompensatorControl.branchDirect
multivalued: false
alias: branch_direct
owner: ShuntCompensatorControl
domain_of:
- ShuntCompensatorControl
range: integer
required: false
cell_size:
name: cell_size
description: The size of the individual units that make up the bank.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ShuntCompensatorControl.cellSize
multivalued: false
alias: cell_size
owner: ShuntCompensatorControl
domain_of:
- ShuntCompensatorControl
range: ReactivePower
required: false
control_kind:
name: control_kind
description: Kind of control (if any).
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ShuntCompensatorControl.controlKind
multivalued: false
alias: control_kind
owner: ShuntCompensatorControl
domain_of:
- ShuntCompensatorControl
range: ShuntImpedanceControlKind
required: false
high_voltage_override:
name: high_voltage_override
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.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ShuntCompensatorControl.highVoltageOverride
multivalued: false
alias: high_voltage_override
owner: ShuntCompensatorControl
domain_of:
- ShuntCompensatorControl
range: PU
required: false
local_control_kind:
name: local_control_kind
description: Kind of local controller.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ShuntCompensatorControl.localControlKind
multivalued: false
alias: local_control_kind
owner: ShuntCompensatorControl
domain_of:
- ShuntCompensatorControl
range: ShuntImpedanceLocalControlKind
required: false
local_off_level:
name: local_off_level
description: Upper control setting.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ShuntCompensatorControl.localOffLevel
multivalued: false
alias: local_off_level
owner: ShuntCompensatorControl
domain_of:
- ShuntCompensatorControl
range: string
required: false
local_on_level:
name: local_on_level
description: Lower control setting.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ShuntCompensatorControl.localOnLevel
multivalued: false
alias: local_on_level
owner: ShuntCompensatorControl
domain_of:
- ShuntCompensatorControl
range: string
required: false
local_override:
name: local_override
description: True if the locally controlled capacitor has voltage override capability.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ShuntCompensatorControl.localOverride
multivalued: false
alias: local_override
owner: ShuntCompensatorControl
domain_of:
- ShuntCompensatorControl
range: boolean
required: false
low_voltage_override:
name: low_voltage_override
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.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ShuntCompensatorControl.lowVoltageOverride
multivalued: false
alias: low_voltage_override
owner: ShuntCompensatorControl
domain_of:
- ShuntCompensatorControl
range: PU
required: false
max_switch_operation_count:
name: max_switch_operation_count
description: "IdmsShuntImpedanceData.maxNumSwitchOps.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ShuntCompensatorControl.maxSwitchOperationCount
multivalued: false
alias: max_switch_operation_count
owner: ShuntCompensatorControl
domain_of:
- ShuntCompensatorControl
range: integer
required: false
normal_open:
name: normal_open
description: True if open is normal status for a fixed capacitor bank, otherwise
normal status is closed.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:ShuntCompensatorControl.normalOpen
multivalued: false
alias: normal_open
owner: ShuntCompensatorControl
domain_of:
- Switch
- SwitchPhase
- ShuntCompensatorControl
range: boolean
required: false
reg_branch:
name: reg_branch
description: For VAR, amp, or power factor locally controlled shunt impedances,
the index of the regulation branch.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ShuntCompensatorControl.regBranch
multivalued: false
alias: reg_branch
owner: ShuntCompensatorControl
domain_of:
- ShuntCompensatorControl
range: string
required: false
reg_branch_end:
name: reg_branch_end
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).'
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ShuntCompensatorControl.regBranchEnd
multivalued: false
alias: reg_branch_end
owner: ShuntCompensatorControl
domain_of:
- ShuntCompensatorControl
range: integer
required: false
reg_branch_kind:
name: reg_branch_kind
description: (For VAR, amp, or power factor locally controlled shunt impedances)
Kind of regulation branch.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ShuntCompensatorControl.regBranchKind
multivalued: false
alias: reg_branch_kind
owner: ShuntCompensatorControl
domain_of:
- ShuntCompensatorControl
range: RegulationBranchKind
required: false
sensing_phase_code:
name: sensing_phase_code
description: Phases that are measured for controlling the device.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ShuntCompensatorControl.sensingPhaseCode
multivalued: false
alias: sensing_phase_code
owner: ShuntCompensatorControl
domain_of:
- ShuntCompensatorControl
range: PhaseCode
required: false
switch_operation_cycle:
name: switch_operation_cycle
description: Time interval between consecutive switching operations.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ShuntCompensatorControl.switchOperationCycle
multivalued: false
alias: switch_operation_cycle
owner: ShuntCompensatorControl
domain_of:
- ShuntCompensatorControl
range: Hours
required: false
v_reg_line_line:
name: v_reg_line_line
description: True if regulated voltages are measured line to line, otherwise they
are measured line to ground.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ShuntCompensatorControl.vRegLineLine
multivalued: false
alias: v_reg_line_line
owner: ShuntCompensatorControl
domain_of:
- ShuntCompensatorControl
range: boolean
required: false
shunt_compensator_info:
name: shunt_compensator_info
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ShuntCompensatorControl.ShuntCompensatorInfo
multivalued: false
alias: shunt_compensator_info
owner: ShuntCompensatorControl
domain_of:
- ShuntCompensatorControl
range: ShuntCompensatorInfo
required: false
discrete:
name: discrete
description: The regulation is performed in a discrete mode. This applies to equipment
with discrete controls, e.g. tap changers and shunt compensators.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:RegulatingControl.discrete
multivalued: false
alias: discrete
owner: ShuntCompensatorControl
domain_of:
- RegulatingControl
- DiscreteValue
range: boolean
required: false
enabled:
name: enabled
description: The flag tells if regulation is enabled.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:RegulatingControl.enabled
multivalued: false
alias: enabled
owner: ShuntCompensatorControl
domain_of:
- ProtectiveAction
- EndDeviceFunction
- RegulatingControl
- DynamicsFunctionBlock
range: boolean
required: false
max_allowed_target_value:
name: max_allowed_target_value
description: Maximum allowed target value (RegulatingControl.targetValue).
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:RegulatingControl.maxAllowedTargetValue
multivalued: false
alias: max_allowed_target_value
owner: ShuntCompensatorControl
domain_of:
- RegulatingControl
range: float
required: false
min_allowed_target_value:
name: min_allowed_target_value
description: "Minimum allowed target value (RegulatingControl.targetValue).\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:RegulatingControl.minAllowedTargetValue
multivalued: false
alias: min_allowed_target_value
owner: ShuntCompensatorControl
domain_of:
- RegulatingControl
range: float
required: false
mode:
name: mode
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.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:RegulatingControl.mode
multivalued: false
alias: mode
owner: ShuntCompensatorControl
domain_of:
- RegulatingControl
- PetersenCoil
range: RegulatingControlModeKind
required: false
monitored_phase:
name: monitored_phase
description: Phase voltage controlling this regulator, measured at regulator location.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:RegulatingControl.monitoredPhase
multivalued: false
alias: monitored_phase
owner: ShuntCompensatorControl
domain_of:
- RegulatingControl
range: PhaseCode
required: false
target_deadband:
name: target_deadband
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."
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:RegulatingControl.targetDeadband
multivalued: false
alias: target_deadband
owner: ShuntCompensatorControl
domain_of:
- RegulatingControl
range: float
required: false
target_value:
name: target_value
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.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:RegulatingControl.targetValue
multivalued: false
alias: target_value
owner: ShuntCompensatorControl
domain_of:
- RegulatingControl
- ProtectiveActionRegulation
range: float
required: false
target_value_unit_multiplier:
name: target_value_unit_multiplier
description: Specify the multiplier for used for the targetValue.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:RegulatingControl.targetValueUnitMultiplier
multivalued: false
alias: target_value_unit_multiplier
owner: ShuntCompensatorControl
domain_of:
- RegulatingControl
range: UnitMultiplier
required: false
regulating_cond_eq:
name: regulating_cond_eq
description: The equipment that participates in this regulating control scheme.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:RegulatingControl.RegulatingCondEq
multivalued: true
alias: regulating_cond_eq
owner: ShuntCompensatorControl
domain_of:
- RegulatingControl
range: RegulatingCondEq
required: false
regulation_schedule:
name: regulation_schedule
description: Schedule for this regulating control.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:RegulatingControl.RegulationSchedule
multivalued: true
alias: regulation_schedule
owner: ShuntCompensatorControl
domain_of:
- RegulatingControl
- VoltageControlZone
range: RegulationSchedule
required: false
terminal:
name: terminal
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. '
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:RegulatingControl.Terminal
multivalued: false
alias: terminal
owner: ShuntCompensatorControl
domain_of:
- BusNameMarker
- OperationalLimitSet
- TopologicalNode
- TransformerEnd
- Measurement
- Bushing
- TieFlow
- SvPowerFlow
- RegulatingControl
- RemoteInputSignal
- BranchGroupTerminal
- AuxiliaryEquipment
- EquipmentFault
- PinTerminal
range: Terminal
required: false
protective_action_regulation:
name: protective_action_regulation
description: Enable/disable a regulating control or set new target value.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:RegulatingControl.ProtectiveActionRegulation
multivalued: true
alias: protective_action_regulation
owner: ShuntCompensatorControl
domain_of:
- RegulatingControl
range: ProtectiveActionRegulation
required: false
controls:
name: controls
description: The controller outputs used to actually govern a regulating device,
e.g. the magnetization of a synchronous machine or capacitor bank breaker actuator.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:PowerSystemResource.Controls
multivalued: true
alias: controls
owner: ShuntCompensatorControl
domain_of:
- PowerSystemResource
- HostControlArea
range: Control
required: false
measurements:
name: measurements
description: The measurements associated with this power system resource.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:PowerSystemResource.Measurements
multivalued: true
alias: measurements
owner: ShuntCompensatorControl
domain_of:
- PowerSystemResource
- ACDCTerminal
- Asset
- Location
- Procedure
- AnalogLimitSet
- AccumulatorLimitSet
range: Measurement
required: false
psrtype:
name: psrtype
description: Custom classification for this power system resource.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:PowerSystemResource.PSRType
multivalued: false
alias: psrtype
owner: ShuntCompensatorControl
domain_of:
- PowerSystemResource
range: PSRType
required: false
configuration_event:
name: configuration_event
description: All configuration events created for this Power System resource.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:PowerSystemResource.ConfigurationEvent
multivalued: true
alias: configuration_event
owner: ShuntCompensatorControl
domain_of:
- PowerSystemResource
- FaultCauseType
range: ConfigurationEvent
required: false
reporting_group:
name: reporting_group
description: Reporting groups to which this power system resource belongs.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:PowerSystemResource.ReportingGroup
multivalued: true
alias: reporting_group
owner: ShuntCompensatorControl
domain_of:
- PowerSystemResource
- BusNameMarker
- TopologicalNode
- ReportingSuperGroup
range: ReportingGroup
required: false
operating_share:
name: operating_share
description: The operating shares of this power system resource.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:PowerSystemResource.OperatingShare
multivalued: true
alias: operating_share
owner: ShuntCompensatorControl
domain_of:
- PowerSystemResource
- OperatingParticipant
range: OperatingShare
required: false
asset_datasheet:
name: asset_datasheet
description: Datasheet information for this power system resource.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:PowerSystemResource.AssetDatasheet
multivalued: false
alias: asset_datasheet
owner: ShuntCompensatorControl
domain_of:
- PowerSystemResource
range: AssetInfo
required: false
verification_action:
name: verification_action
description: The verification action that is performed on the power system resource
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:PowerSystemResource.VerificationAction
multivalued: true
alias: verification_action
owner: ShuntCompensatorControl
domain_of:
- PowerSystemResource
range: VerificationAction
required: false
clearances:
name: clearances
description: All clearances applicable to this power system resource.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:PowerSystemResource.Clearances
multivalued: true
alias: clearances
owner: ShuntCompensatorControl
domain_of:
- PowerSystemResource
range: ClearanceDocument
required: false
generic_action:
name: generic_action
description: The generic action that is performed on the power system resource
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:PowerSystemResource.GenericAction
multivalued: true
alias: generic_action
owner: ShuntCompensatorControl
domain_of:
- PowerSystemResource
range: GenericAction
required: false
psrevents:
name: psrevents
description: All events associated with this power system resource.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:PowerSystemResource.PSREvents
multivalued: true
alias: psrevents
owner: ShuntCompensatorControl
domain_of:
- PowerSystemResource
range: PSREvent
required: false
assets:
name: assets
description: All assets represented by this power system resource. For example,
multiple conductor assets are electrically modelled as a single AC line segment.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:PowerSystemResource.Assets
multivalued: true
alias: assets
owner: ShuntCompensatorControl
domain_of:
- PowerSystemResource
- AssetInfo
- Location
- WorkTask
- ErpRecDelvLineItem
- AssetContainer
- ActivityRecord
- Procedure
- ReliabilityInfo
- AssetPropertyCurve
- AssetOrganisationRole
- ScheduledEvent
range: Asset
required: false
location:
name: location
description: Location of this power system resource.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:PowerSystemResource.Location
multivalued: false
alias: location
owner: ShuntCompensatorControl
domain_of:
- PowerSystemResource
- Asset
- Incident
- SwitchingOrder
- TroubleOrder
- Crew
- Fault
- PointOfSale
- TroubleTicket
- OutageOrder
- EnvironmentalMonitoringStation
- EnvironmentalLocationType
- PositionPoint
- FailureEvent
range: Location
required: false
operational_tags:
name: operational_tags
description: All operational tags placed on this power system resource.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:PowerSystemResource.OperationalTags
multivalued: true
alias: operational_tags
owner: ShuntCompensatorControl
domain_of:
- PowerSystemResource
- Asset
range: OperationalTag
required: false
alias_name:
name: alias_name
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"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:IdentifiedObject.aliasName
multivalued: false
alias: alias_name
owner: ShuntCompensatorControl
domain_of:
- IdentifiedObject
range: string
required: false
description:
name: description
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.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:IdentifiedObject.description
multivalued: false
alias: description
owner: ShuntCompensatorControl
domain_of:
- IdentifiedObject
- NameType
- NameTypeAuthority
- DataSet
- SwitchingStepGroup
- AreaReserveSpec
range: string
required: false
m_rid:
name: m_rid
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."
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:IdentifiedObject.mRID
multivalued: false
alias: m_rid
owner: ShuntCompensatorControl
domain_of:
- IdentifiedObject
- DataSet
range: string
required: false
diagram_objects:
name: diagram_objects
description: The diagram objects that are associated with the domain object.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:IdentifiedObject.DiagramObjects
multivalued: true
alias: diagram_objects
owner: ShuntCompensatorControl
domain_of:
- IdentifiedObject
range: DiagramObject
required: false
instance_set:
name: instance_set
description: Dataset containing the data objects.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:IdentifiedObject.InstanceSet
multivalued: false
alias: instance_set
owner: ShuntCompensatorControl
domain_of:
- IdentifiedObject
range: InstanceSet
required: true
names:
name: names
description: All names of this identified object.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:IdentifiedObject.Names
multivalued: true
alias: names
owner: ShuntCompensatorControl
domain_of:
- IdentifiedObject
- NameType
range: Name
required: false
properties_cimdata_object:
name: properties_cimdata_object
description: The single CIM data object in the appropriate dataset context.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:IdentifiedObject.PropertiesCIMDataObject
multivalued: false
alias: properties_cimdata_object
owner: ShuntCompensatorControl
domain_of:
- IdentifiedObject
range: ChangeSetMember
required: false
targeting_cimdata_object:
name: targeting_cimdata_object
description: Data objects registered.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:IdentifiedObject.TargetingCIMDataObject
multivalued: true
alias: targeting_cimdata_object
owner: ShuntCompensatorControl
domain_of:
- IdentifiedObject
range: ChangeSetMember
required: false
class_uri: cim:ShuntCompensatorControl