Class: TopologicalNode

name: TopologicalNode
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\"."
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: IdentifiedObject
attributes:
  p_injection:
    name: p_injection
    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. "
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TopologicalNode.pInjection
    multivalued: false
    domain_of:
    - TopologicalNode
    - SvInjection
    range: ActivePower
    required: false
  q_injection:
    name: q_injection
    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."
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TopologicalNode.qInjection
    multivalued: false
    domain_of:
    - TopologicalNode
    - SvInjection
    range: ReactivePower
    required: false
  topological_island:
    name: topological_island
    description: A topological node belongs to a topological island.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TopologicalNode.TopologicalIsland
    multivalued: false
    domain_of:
    - TopologicalNode
    range: TopologicalIsland
    required: false
  reporting_group:
    name: reporting_group
    description: The reporting group to which the topological node belongs.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:TopologicalNode.ReportingGroup
    multivalued: false
    domain_of:
    - PowerSystemResource
    - BusNameMarker
    - TopologicalNode
    - ReportingSuperGroup
    range: ReportingGroup
    required: false
  connectivity_node_container:
    name: connectivity_node_container
    description: The connectivity node container to which the topological node belongs.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TopologicalNode.ConnectivityNodeContainer
    multivalued: false
    domain_of:
    - TopologicalNode
    - ConnectivityNode
    range: ConnectivityNodeContainer
    required: false
  base_voltage:
    name: base_voltage
    description: The base voltage of the topological node.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TopologicalNode.BaseVoltage
    multivalued: false
    domain_of:
    - TopologicalNode
    - TransformerEnd
    - ConductingEquipment
    - VoltageLevel
    - AssetDeployment
    range: BaseVoltage
    required: false
  sv_injection:
    name: sv_injection
    description: The injection flows state variables associated with the topological
      node.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TopologicalNode.SvInjection
    multivalued: true
    domain_of:
    - TopologicalNode
    range: SvInjection
    required: false
  sv_voltage:
    name: sv_voltage
    description: The state voltage associated with the topological node.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TopologicalNode.SvVoltage
    multivalued: true
    domain_of:
    - TopologicalNode
    range: SvVoltage
    required: false
  angle_ref_topological_island:
    name: angle_ref_topological_island
    description: The island for which the node is an angle reference.   Normally there
      is one angle reference node for each island.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TopologicalNode.AngleRefTopologicalIsland
    multivalued: false
    domain_of:
    - TopologicalNode
    range: TopologicalIsland
    required: false
  connectivity_nodes:
    name: connectivity_nodes
    description: The connectivity nodes combine together to form this topological
      node.  May depend on the current state of switches in the network.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:TopologicalNode.ConnectivityNodes
    multivalued: true
    domain_of:
    - ConnectivityNodeContainer
    - TopologicalNode
    range: ConnectivityNode
    required: false
  terminal:
    name: terminal
    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.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:TopologicalNode.Terminal
    multivalued: true
    domain_of:
    - BusNameMarker
    - OperationalLimitSet
    - TopologicalNode
    - TransformerEnd
    - Measurement
    - Bushing
    - TieFlow
    - SvPowerFlow
    - RegulatingControl
    - RemoteInputSignal
    - BranchGroupTerminal
    - AuxiliaryEquipment
    - EquipmentFault
    - PinTerminal
    range: Terminal
    required: false
  bus_name_marker:
    name: bus_name_marker
    description: BusnameMarkers that may refer to a pre defined TopologicalNode.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:TopologicalNode.BusNameMarker
    multivalued: true
    domain_of:
    - ReportingGroup
    - ACDCTerminal
    - TopologicalNode
    range: BusNameMarker
    required: false
class_uri: cim:TopologicalNode

name: TopologicalNode
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\"."
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: IdentifiedObject
attributes:
  p_injection:
    name: p_injection
    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. "
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TopologicalNode.pInjection
    multivalued: false
    alias: p_injection
    owner: TopologicalNode
    domain_of:
    - TopologicalNode
    - SvInjection
    range: ActivePower
    required: false
  q_injection:
    name: q_injection
    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."
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TopologicalNode.qInjection
    multivalued: false
    alias: q_injection
    owner: TopologicalNode
    domain_of:
    - TopologicalNode
    - SvInjection
    range: ReactivePower
    required: false
  topological_island:
    name: topological_island
    description: A topological node belongs to a topological island.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TopologicalNode.TopologicalIsland
    multivalued: false
    alias: topological_island
    owner: TopologicalNode
    domain_of:
    - TopologicalNode
    range: TopologicalIsland
    required: false
  reporting_group:
    name: reporting_group
    description: The reporting group to which the topological node belongs.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:TopologicalNode.ReportingGroup
    multivalued: false
    alias: reporting_group
    owner: TopologicalNode
    domain_of:
    - PowerSystemResource
    - BusNameMarker
    - TopologicalNode
    - ReportingSuperGroup
    range: ReportingGroup
    required: false
  connectivity_node_container:
    name: connectivity_node_container
    description: The connectivity node container to which the topological node belongs.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TopologicalNode.ConnectivityNodeContainer
    multivalued: false
    alias: connectivity_node_container
    owner: TopologicalNode
    domain_of:
    - TopologicalNode
    - ConnectivityNode
    range: ConnectivityNodeContainer
    required: false
  base_voltage:
    name: base_voltage
    description: The base voltage of the topological node.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TopologicalNode.BaseVoltage
    multivalued: false
    alias: base_voltage
    owner: TopologicalNode
    domain_of:
    - TopologicalNode
    - TransformerEnd
    - ConductingEquipment
    - VoltageLevel
    - AssetDeployment
    range: BaseVoltage
    required: false
  sv_injection:
    name: sv_injection
    description: The injection flows state variables associated with the topological
      node.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TopologicalNode.SvInjection
    multivalued: true
    alias: sv_injection
    owner: TopologicalNode
    domain_of:
    - TopologicalNode
    range: SvInjection
    required: false
  sv_voltage:
    name: sv_voltage
    description: The state voltage associated with the topological node.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TopologicalNode.SvVoltage
    multivalued: true
    alias: sv_voltage
    owner: TopologicalNode
    domain_of:
    - TopologicalNode
    range: SvVoltage
    required: false
  angle_ref_topological_island:
    name: angle_ref_topological_island
    description: The island for which the node is an angle reference.   Normally there
      is one angle reference node for each island.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TopologicalNode.AngleRefTopologicalIsland
    multivalued: false
    alias: angle_ref_topological_island
    owner: TopologicalNode
    domain_of:
    - TopologicalNode
    range: TopologicalIsland
    required: false
  connectivity_nodes:
    name: connectivity_nodes
    description: The connectivity nodes combine together to form this topological
      node.  May depend on the current state of switches in the network.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:TopologicalNode.ConnectivityNodes
    multivalued: true
    alias: connectivity_nodes
    owner: TopologicalNode
    domain_of:
    - ConnectivityNodeContainer
    - TopologicalNode
    range: ConnectivityNode
    required: false
  terminal:
    name: terminal
    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.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:TopologicalNode.Terminal
    multivalued: true
    alias: terminal
    owner: TopologicalNode
    domain_of:
    - BusNameMarker
    - OperationalLimitSet
    - TopologicalNode
    - TransformerEnd
    - Measurement
    - Bushing
    - TieFlow
    - SvPowerFlow
    - RegulatingControl
    - RemoteInputSignal
    - BranchGroupTerminal
    - AuxiliaryEquipment
    - EquipmentFault
    - PinTerminal
    range: Terminal
    required: false
  bus_name_marker:
    name: bus_name_marker
    description: BusnameMarkers that may refer to a pre defined TopologicalNode.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:TopologicalNode.BusNameMarker
    multivalued: true
    alias: bus_name_marker
    owner: TopologicalNode
    domain_of:
    - ReportingGroup
    - ACDCTerminal
    - TopologicalNode
    range: BusNameMarker
    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: TopologicalNode
    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: TopologicalNode
    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: TopologicalNode
    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: TopologicalNode
    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: TopologicalNode
    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: TopologicalNode
    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: TopologicalNode
    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: TopologicalNode
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:TopologicalNode