IscGridInfeed
==============

The ``IscGridInfeed`` class provides access to an IPSA grid infeed, to set and get data values and to retrieve load flow and fault level results.

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

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

   * - Type
     - Field Name
     - Description
   * - Integer
     - FromUID
     - Gets the unique ID for busbar.
   * - String
     - BusName
     - Gets the busbar name.
   * - String
     - Name
     - Gets the grid infeed name.
   * - Integer
     - Status
     - Status:

        - 0 = Switched in
        - -1 = Switched out
   * - Float
     - VoltPU
     - Per unit voltage target.
   * - Float
     - GenMW
     - Generated real power.
   * - Float
     - GenMVAr
     - Generated reactive power.
   * - Integer
     - ProfileUID
     - Gets or sets the profile, ``ProfileUID``, to be applied to the universal machine.
   * - Float
     - PeakLLL
     - Peak asymmetric three phase fault contribution in MVA.
   * - Float
     - RMSLLL
     - RMS three phase fault contribution in MVA at the break time specified by ``Tbreak``.
   * - Float
     - X2RLLL
     - Three phase X / R ratio determining the DC decay. A single exponential decay is modelled.
   * - Float
     - PeakLG
     - Peak asymmetric single phase to ground fault contribution in MVA.
   * - Float
     - RMSLG
     - RMS single phase to ground contribution in MVA at the break time specified by ``Tbreak``.
   * - Float
     - Tac
     - AC decay time constant for three phase faults, in seconds.
   * - Float
     - Tbreak
     - RMS fault time in seconds.
   * - Boolean
     - EnergyStorage
     - ``True`` if the grid infeed can be used for energy storage.
   * - Float
     - StorageIERatio
     - For energy storage components, this is the ratio between where a storage unit behaves as an import or an export.
       If the storage is flipped from export to import, the real power is multiplied by this ratio. Default is 1.
   * - Integer
     - GridPlanningStage
     - The stage the load is currently at:

        - 0 = Proposed
        - 1 = Accepted
        - 2 = Completed
        - 3 = Energised (default, in service)
   * - String
     - Comment
     - Gets and sets the comments.
   * - Boolean
     - Aggregate
     - An equivalent for a collection of the same object.

IscGridInfeed Class
--------------------

.. autoclass:: ipsa.IscGridInfeed
   :members: