IscEquivalentBranch
====================

The ``IscEquivalentBranch`` class provides access to an IPSA equivalent branch (generated by network reduction), to set and get data values and to retrieve load flow results.

Field Values
-------------

.. tabularcolumns:: |\Y{0.15}|\Y{0.25}|\Y{0.6}|
.. list-table:: **IscEquivalentBranch Field Values**
   :widths: 2 5 15
   :class: tight-table, longtable
   :header-rows: 1

   * - Type
     - Field Name
     - Description
   * - Integer
     - FromUID
     - Gets the unique component ID for the “From” busbar.
   * - Integer
     - ToUID
     - Gets the unique component ID for the “To” busbar.
   * - String
     - FromBusName
     - Gets the sending busbar name.
   * - String
     - ToBusName
     - Gets the receiving busbar name.
   * - String
     - Name
     - Gets the branch name.
   * - Integer
     - Status
     - Status:

        - 0 = Switched in
        - -1 = Switched out
   * - Float
     - ResistancePU
     - Gets and sets the positive sequence from-to resistance in per unit.
   * - Float
     - ReactancePU
     - Gets and sets the positive sequence from-to reactance in per unit.
   * - Float
     - ResistanceReversePU
     - Gets and sets the positive sequence to-from resistance in per unit.
   * - Float
     - ReactanceReversePU
     - Gets and sets the positive sequence to-from reactance in per unit.
   * - Boolean
     - HideLabel
     - ``True`` if the branch label (usually the name and any results) should be hidden on the diagram.
   * - String
     - Comment
     - Gets and sets the comments.


IscEquivalentBranch Class
----------------------------

.. autoclass:: ipsa.IscEquivalentBranch
   :members: