edisgo.network.components.Switch
================================

.. py:class:: edisgo.network.components.Switch(**kwargs)

   Bases: :py:obj:`BasicComponent`

   .. autoapi-inheritance-diagram:: edisgo.network.components.Switch
      :parts: 1


   Switch object

   Switches are for example medium voltage disconnecting points (points
   where MV rings are split under normal operation conditions). They are
   represented as branches and can have two states: 'open' or 'closed'. When
   the switch is open the branch it is represented by connects some bus and
   the bus specified in `bus_open`. When it is closed bus `bus_open` is
   substitued by the bus specified in `bus_closed`.




   .. py:property:: type

      Type of switch.

      So far edisgo only considers switch disconnectors.

      :param type: Type of switch.
      :type type: :obj:`str`

      :returns: Type of switch.
      :rtype: :obj:`str`


   .. py:property:: bus_open

      Bus ID of bus the switch is 'connected' to when state is 'open'.

      As switches are represented as branches they connect two buses.
      `bus_open` specifies the bus the branch is connected to in the open
      state.

      :returns: Bus in 'open' state.
      :rtype: :obj:`str`


   .. py:property:: bus_closed

      Bus ID of bus the switch is 'connected' to when state is 'closed'.

      As switches are represented as branches they connect two buses.
      `bus_closed` specifies the bus the branch is connected to in the closed
      state.

      :returns: Bus in 'closed' state.
      :rtype: :obj:`str`


   .. py:property:: state

      State of switch (open or closed).

      :returns: State of switch: 'open' or 'closed'.
      :rtype: str


   .. py:property:: branch

      Branch the switch is represented by.

      :returns: Branch the switch is represented by.
      :rtype: str


   .. py:property:: grid

      Grid switch is in.

      :returns: Grid switch is in.
      :rtype: :class:`~.topology.grids.Grid`


   .. py:method:: open()

      Open switch.




   .. py:method:: close()

      Close switch.