.. _Collection:

================================================================================
Collection
================================================================================
Collection of topology models

Common Parameters: u, name, idx

Available models:
Area_,
Zone_

.. _Area:

--------------------------------------------------------------------------------
Area
--------------------------------------------------------------------------------
Area model.

Parameters
----------

+-------+-----------+-------------------+---------+--------+------------+
| Name  |  Symbol   |    Description    | Default |  Unit  | Properties |
+=======+===========+===================+=========+========+============+
|  idx  |           | unique device idx |         |        |            |
+-------+-----------+-------------------+---------+--------+------------+
|  u    | :math:`u` | connection status | 1       | *bool* |            |
+-------+-----------+-------------------+---------+--------+------------+
|  name |           | device name       |         |        |            |
+-------+-----------+-------------------+---------+--------+------------+

Services
----------

+-------------+-------------+--------------------+---------+
|    Name     | Description |       Symbol       |  Type   |
+=============+=============+====================+=========+
|  Bus        |             | :math:`Bus`        | BackRef |
+-------------+-------------+--------------------+---------+
|  ACTopology |             | :math:`ACTopology` | BackRef |
+-------------+-------------+--------------------+---------+


.. _Zone:

--------------------------------------------------------------------------------
Zone
--------------------------------------------------------------------------------
Zone model for zonal items.

An ``area`` can have multiple zones.

Notes
-----
1. Zone is a collection of buses.
2. Model ``Zone`` is not actually defined in ANDES.

Parameters
----------

+-------+-----------+-------------------+---------+--------+------------+
| Name  |  Symbol   |    Description    | Default |  Unit  | Properties |
+=======+===========+===================+=========+========+============+
|  idx  |           | unique device idx |         |        |            |
+-------+-----------+-------------------+---------+--------+------------+
|  u    | :math:`u` | connection status | 1       | *bool* |            |
+-------+-----------+-------------------+---------+--------+------------+
|  name |           | device name       |         |        |            |
+-------+-----------+-------------------+---------+--------+------------+

Services
----------

+-------------+-------------+--------------------+---------+
|    Name     | Description |       Symbol       |  Type   |
+=============+=============+====================+=========+
|  Bus        |             | :math:`Bus`        | BackRef |
+-------------+-------------+--------------------+---------+
|  ACTopology |             | :math:`ACTopology` | BackRef |
+-------------+-------------+--------------------+---------+