Skip to content

Class: BranchGroup

_A group of branch terminals whose directed flow summation is to be monitored. A branch group need not form a cutset of the network. _

__

URI: cim:BranchGroup

 classDiagram
    class BranchGroup
      IdentifiedObject <|-- BranchGroup

      BranchGroup : alias_name

      BranchGroup : branch_group_terminal

          BranchGroup --> BranchGroupTerminal : branch_group_terminal

      BranchGroup : description

      BranchGroup : diagram_objects

          BranchGroup --> DiagramObject : diagram_objects

      BranchGroup : instance_set

          BranchGroup --> InstanceSet : instance_set

      BranchGroup : m_rid

      BranchGroup : maximum_active_power

          BranchGroup --> ActivePower : maximum_active_power

      BranchGroup : maximum_reactive_power

          BranchGroup --> ReactivePower : maximum_reactive_power

      BranchGroup : minimum_active_power

          BranchGroup --> ActivePower : minimum_active_power

      BranchGroup : minimum_reactive_power

          BranchGroup --> ReactivePower : minimum_reactive_power

      BranchGroup : monitor_active_power

      BranchGroup : monitor_reactive_power

      BranchGroup : names

          BranchGroup --> Name : names

      BranchGroup : pin_branch_group

          BranchGroup --> PinBranchGroup : pin_branch_group

      BranchGroup : properties_cimdata_object

          BranchGroup --> ChangeSetMember : properties_cimdata_object

      BranchGroup : targeting_cimdata_object

          BranchGroup --> ChangeSetMember : targeting_cimdata_object

Inheritance

Slots

Name Cardinality and Range Description Inheritance
maximum_active_power 0..1
ActivePower		 The maximum active power flow direct
maximum_reactive_power 0..1
ReactivePower		 The maximum reactive power flow direct
minimum_active_power 0..1
ActivePower		 The minimum active power flow direct
minimum_reactive_power 0..1
ReactivePower		 The minimum reactive power flow direct
monitor_active_power 0..1
Boolean		 Monitor the active power flow direct
monitor_reactive_power 0..1
Boolean		 Monitor the reactive power flow direct
branch_group_terminal 0..*
BranchGroupTerminal		 The directed branch group terminals to be summed direct
pin_branch_group 0..*
PinBranchGroup		 direct
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
BranchGroupTerminal branch_group range BranchGroup
PinBranchGroup branch_group range BranchGroup

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: BranchGroup
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"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: IdentifiedObject
attributes:
  maximum_active_power:
    name: maximum_active_power
    description: The maximum active power flow.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:BranchGroup.maximumActivePower
    multivalued: false
    domain_of:
    - BranchGroup
    range: ActivePower
    required: false
  maximum_reactive_power:
    name: maximum_reactive_power
    description: The maximum reactive power flow.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:BranchGroup.maximumReactivePower
    multivalued: false
    domain_of:
    - BranchGroup
    range: ReactivePower
    required: false
  minimum_active_power:
    name: minimum_active_power
    description: The minimum active power flow.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:BranchGroup.minimumActivePower
    multivalued: false
    domain_of:
    - BranchGroup
    range: ActivePower
    required: false
  minimum_reactive_power:
    name: minimum_reactive_power
    description: The minimum reactive power flow.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:BranchGroup.minimumReactivePower
    multivalued: false
    domain_of:
    - BranchGroup
    range: ReactivePower
    required: false
  monitor_active_power:
    name: monitor_active_power
    description: Monitor the active power flow.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:BranchGroup.monitorActivePower
    multivalued: false
    domain_of:
    - BranchGroup
    range: boolean
    required: false
  monitor_reactive_power:
    name: monitor_reactive_power
    description: Monitor the reactive power flow.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:BranchGroup.monitorReactivePower
    multivalued: false
    domain_of:
    - BranchGroup
    range: boolean
    required: false
  branch_group_terminal:
    name: branch_group_terminal
    description: The directed branch group terminals to be summed.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:BranchGroup.BranchGroupTerminal
    multivalued: true
    domain_of:
    - Terminal
    - BranchGroup
    range: BranchGroupTerminal
    required: false
  pin_branch_group:
    name: pin_branch_group
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:BranchGroup.PinBranchGroup
    multivalued: true
    domain_of:
    - BranchGroup
    range: PinBranchGroup
    required: false
class_uri: cim:BranchGroup

Induced

name: BranchGroup
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"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: IdentifiedObject
attributes:
  maximum_active_power:
    name: maximum_active_power
    description: The maximum active power flow.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:BranchGroup.maximumActivePower
    multivalued: false
    alias: maximum_active_power
    owner: BranchGroup
    domain_of:
    - BranchGroup
    range: ActivePower
    required: false
  maximum_reactive_power:
    name: maximum_reactive_power
    description: The maximum reactive power flow.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:BranchGroup.maximumReactivePower
    multivalued: false
    alias: maximum_reactive_power
    owner: BranchGroup
    domain_of:
    - BranchGroup
    range: ReactivePower
    required: false
  minimum_active_power:
    name: minimum_active_power
    description: The minimum active power flow.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:BranchGroup.minimumActivePower
    multivalued: false
    alias: minimum_active_power
    owner: BranchGroup
    domain_of:
    - BranchGroup
    range: ActivePower
    required: false
  minimum_reactive_power:
    name: minimum_reactive_power
    description: The minimum reactive power flow.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:BranchGroup.minimumReactivePower
    multivalued: false
    alias: minimum_reactive_power
    owner: BranchGroup
    domain_of:
    - BranchGroup
    range: ReactivePower
    required: false
  monitor_active_power:
    name: monitor_active_power
    description: Monitor the active power flow.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:BranchGroup.monitorActivePower
    multivalued: false
    alias: monitor_active_power
    owner: BranchGroup
    domain_of:
    - BranchGroup
    range: boolean
    required: false
  monitor_reactive_power:
    name: monitor_reactive_power
    description: Monitor the reactive power flow.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:BranchGroup.monitorReactivePower
    multivalued: false
    alias: monitor_reactive_power
    owner: BranchGroup
    domain_of:
    - BranchGroup
    range: boolean
    required: false
  branch_group_terminal:
    name: branch_group_terminal
    description: The directed branch group terminals to be summed.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:BranchGroup.BranchGroupTerminal
    multivalued: true
    alias: branch_group_terminal
    owner: BranchGroup
    domain_of:
    - Terminal
    - BranchGroup
    range: BranchGroupTerminal
    required: false
  pin_branch_group:
    name: pin_branch_group
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:BranchGroup.PinBranchGroup
    multivalued: true
    alias: pin_branch_group
    owner: BranchGroup
    domain_of:
    - BranchGroup
    range: PinBranchGroup
    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: BranchGroup
    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: BranchGroup
    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: BranchGroup
    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: BranchGroup
    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: BranchGroup
    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: BranchGroup
    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: BranchGroup
    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: BranchGroup
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:BranchGroup