Skip to content

Class: ProtectiveActionRegulation

Protective action to change regulation to Equipment.

URI: cim:ProtectiveActionRegulation

 classDiagram
    class ProtectiveActionRegulation
      ProtectiveAction <|-- ProtectiveActionRegulation

      ProtectiveActionRegulation : alias_name

      ProtectiveActionRegulation : description

      ProtectiveActionRegulation : diagram_objects

          ProtectiveActionRegulation --> DiagramObject : diagram_objects

      ProtectiveActionRegulation : enabled

      ProtectiveActionRegulation : gate_com_condition

          ProtectiveActionRegulation --> Gate : gate_com_condition

      ProtectiveActionRegulation : gate_enabled_condition

          ProtectiveActionRegulation --> Gate : gate_enabled_condition

      ProtectiveActionRegulation : instance_set

          ProtectiveActionRegulation --> InstanceSet : instance_set

      ProtectiveActionRegulation : is_regulating

      ProtectiveActionRegulation : m_rid

      ProtectiveActionRegulation : names

          ProtectiveActionRegulation --> Name : names

      ProtectiveActionRegulation : normal_enabled

      ProtectiveActionRegulation : properties_cimdata_object

          ProtectiveActionRegulation --> ChangeSetMember : properties_cimdata_object

      ProtectiveActionRegulation : protection_equipment

          ProtectiveActionRegulation --> ProtectionEquipment : protection_equipment

      ProtectiveActionRegulation : protective_action_collection

          ProtectiveActionRegulation --> ProtectiveActionCollection : protective_action_collection

      ProtectiveActionRegulation : regulating_control

          ProtectiveActionRegulation --> RegulatingControl : regulating_control

      ProtectiveActionRegulation : target_value

      ProtectiveActionRegulation : targeting_cimdata_object

          ProtectiveActionRegulation --> ChangeSetMember : targeting_cimdata_object

Inheritance

Slots

Name Cardinality and Range Description Inheritance
is_regulating 0..1
Boolean		 If true the regulator is put in-service, otherwise out-of-service (no regulat... direct
target_value 0..1
Float		 The target value specified the new case input for the regulator direct
regulating_control 1..1
RegulatingControl		 direct
enabled 0..1
Boolean		 The status of the class set by operation or by signal ProtectiveAction
normal_enabled 0..1
Boolean		 The default/normal value used when other active signal/values are missing ProtectiveAction
gate_com_condition 0..1
Gate		 ProtectiveAction
gate_enabled_condition 0..1
Gate		 Association to a Gate that through a gate logic and input pin defines enablin... ProtectiveAction
protection_equipment 0..1
ProtectionEquipment		 ProtectiveAction
protective_action_collection 1..1
ProtectiveActionCollection		 ProtectiveAction
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
RegulatingControl protective_action_regulation range ProtectiveActionRegulation
TapChangerControl protective_action_regulation range ProtectiveActionRegulation
ShuntCompensatorControl protective_action_regulation range ProtectiveActionRegulation

Identifier and Mapping Information

Schema Source

  • from schema: https://cim.ucaiug.io/ns#TC57CIM

Mappings

Mapping Type Mapped Value
self cim:ProtectiveActionRegulation
native cim:ProtectiveActionRegulation

LinkML Source

Direct

name: ProtectiveActionRegulation
description: Protective action to change regulation to Equipment.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: ProtectiveAction
attributes:
  is_regulating:
    name: is_regulating
    description: If true the regulator is put in-service, otherwise out-of-service
      (no regulation).
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:ProtectiveActionRegulation.isRegulating
    multivalued: false
    domain_of:
    - ProtectiveActionRegulation
    range: boolean
    required: false
  target_value:
    name: target_value
    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.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:ProtectiveActionRegulation.targetValue
    multivalued: false
    domain_of:
    - RegulatingControl
    - ProtectiveActionRegulation
    range: float
    required: false
  regulating_control:
    name: regulating_control
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:ProtectiveActionRegulation.RegulatingControl
    multivalued: false
    domain_of:
    - Terminal
    - RegulatingCondEq
    - RegulationSchedule
    - ProtectiveActionRegulation
    range: RegulatingControl
    required: true
class_uri: cim:ProtectiveActionRegulation

Induced

name: ProtectiveActionRegulation
description: Protective action to change regulation to Equipment.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: ProtectiveAction
attributes:
  is_regulating:
    name: is_regulating
    description: If true the regulator is put in-service, otherwise out-of-service
      (no regulation).
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:ProtectiveActionRegulation.isRegulating
    multivalued: false
    alias: is_regulating
    owner: ProtectiveActionRegulation
    domain_of:
    - ProtectiveActionRegulation
    range: boolean
    required: false
  target_value:
    name: target_value
    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.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:ProtectiveActionRegulation.targetValue
    multivalued: false
    alias: target_value
    owner: ProtectiveActionRegulation
    domain_of:
    - RegulatingControl
    - ProtectiveActionRegulation
    range: float
    required: false
  regulating_control:
    name: regulating_control
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:ProtectiveActionRegulation.RegulatingControl
    multivalued: false
    alias: regulating_control
    owner: ProtectiveActionRegulation
    domain_of:
    - Terminal
    - RegulatingCondEq
    - RegulationSchedule
    - ProtectiveActionRegulation
    range: RegulatingControl
    required: true
  enabled:
    name: enabled
    description: The status of the class set by operation or by signal. Optional field
      that will override other status fields.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:ProtectiveAction.enabled
    multivalued: false
    alias: enabled
    owner: ProtectiveActionRegulation
    domain_of:
    - ProtectiveAction
    - EndDeviceFunction
    - RegulatingControl
    - DynamicsFunctionBlock
    range: boolean
    required: false
  normal_enabled:
    name: normal_enabled
    description: The default/normal value used when other active signal/values are
      missing.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:ProtectiveAction.normalEnabled
    multivalued: false
    alias: normal_enabled
    owner: ProtectiveActionRegulation
    domain_of:
    - ProtectiveAction
    range: boolean
    required: false
  gate_com_condition:
    name: gate_com_condition
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:ProtectiveAction.GateComCondition
    multivalued: false
    alias: gate_com_condition
    owner: ProtectiveActionRegulation
    domain_of:
    - StageTrigger
    - ProtectiveAction
    range: Gate
    required: false
  gate_enabled_condition:
    name: gate_enabled_condition
    description: Association to a Gate that through a gate logic and input pin defines
      enabling of the ProtectiveAction.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:ProtectiveAction.GateEnabledCondition
    multivalued: false
    alias: gate_enabled_condition
    owner: ProtectiveActionRegulation
    domain_of:
    - ProtectiveAction
    range: Gate
    required: false
  protection_equipment:
    name: protection_equipment
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:ProtectiveAction.ProtectionEquipment
    multivalued: false
    alias: protection_equipment
    owner: ProtectiveActionRegulation
    domain_of:
    - ProtectiveAction
    range: ProtectionEquipment
    required: false
  protective_action_collection:
    name: protective_action_collection
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:ProtectiveAction.ProtectiveActionCollection
    multivalued: false
    alias: protective_action_collection
    owner: ProtectiveActionRegulation
    domain_of:
    - StageTrigger
    - ProtectiveAction
    range: ProtectiveActionCollection
    required: true
  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: ProtectiveActionRegulation
    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: ProtectiveActionRegulation
    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: ProtectiveActionRegulation
    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: ProtectiveActionRegulation
    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: ProtectiveActionRegulation
    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: ProtectiveActionRegulation
    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: ProtectiveActionRegulation
    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: ProtectiveActionRegulation
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:ProtectiveActionRegulation