.. _accessWind:

============
**Windings**
============

.. role:: red
.. role:: big

Befehle, die das Lesen und Zuweisen der Werte und Eigenschaften von Wicklungen (Leitern) ermöglichen.

Geometrische Größen (Koordinaten, Längen und Flächen) entsprechen der global gewählten Längeneinheit (gobal_unit, siehe :any:`settings`). Übergebene oder zurückgelieferte Vektoren (Komponenten der Vektoren) beziehen sich, wenn in der Funktionsbeschreibung nicht explizit angegeben, auf das kartesisches System. Zur einfachen Umrechnung zwischen unerschiedlichen Bezugssystemen stehen Funktionen zur :any:`trans` zur Verfügung.


:big:`Übersicht`

----------------------------------------------------------------------

+------------+--------------+---------+-----------------+----------------------------------------------------------------+
| Bezeichner | Anzahl Werte | Einheit | Zugriff get/set | Beschreibung                                                   |
+------------+--------------+---------+-----------------+----------------------------------------------------------------+
| valid      | 1            | -       | g               | Gültigkeit                                                     |
+------------+--------------+---------+-----------------+----------------------------------------------------------------+
| key        | 1            | -       | g               | Nummer                                                         |
+------------+--------------+---------+-----------------+----------------------------------------------------------------+
| srkeys     | [N]          | -       | g               | Nummern aller N Subregionen der Wicklung                       |
+------------+--------------+---------+-----------------+----------------------------------------------------------------+
| nturns     | 1            | -       | g               | Leiterzahl                                                     |
+------------+--------------+---------+-----------------+----------------------------------------------------------------+
| cur        | 2            | A       | g               | Strangstrom (Realteil, Imaginärteil)                           |
+------------+--------------+---------+-----------------+----------------------------------------------------------------+
| flux       | 2            | Vs/gu   | g               | Flussverkettung des Wicklungsstranges (Realteil, Imaginärteil) |
+------------+--------------+---------+-----------------+----------------------------------------------------------------+
| volt       | 2            | V/gu    | g               | Spannung über dem Wicklungsstrang (Realteil, Imaginärteil)     |
+------------+--------------+---------+-----------------+----------------------------------------------------------------+

gu = globale Längeneinheit

:big:`Befehlsbeschreibung`

----------------------------------------------------------------------

.. admonition:: Funktion:   	*key* 	  =   	get_wdg_key 	( 	*x, y* 	 ) 
	
 Gibt die Nummer einer Wicklung zurück, die über die kartesischen Koordinaten x und y adressiert wird.

 **Parameter**
  | [in] :red:`x` Coordinate 1
  | [in] :red:`y` Coordiante 2

 **Return value**
  :red:`key` Wicklungsnummer

 Beispiel
 ::

  key = get_wdg_key(x,y)         -- Get the winding number
  print("winding key = %d",key)  -- Output to shell

.. admonition:: Command:   	get_wdg_keys 	( 	*"var"* 	 ) 
	
 Gibt die Nummern aller Wicklungsobjeke des Modells zurück.

 **Parameter**
  [out]	:red:`var` Bezeichner des Arrays in dem die Wicklungsnummers zurückgegeben werden

 Beispiel
 ::
    
  get_wdg_key("keys")        -- Get all windings and bars of the model
  N = table.getn(keys)       -- Number of elements in array

.. admonition:: Funktion:   	*d1, d2, ...* 	  =   	get_wdg_data 	( 	*"identifier", key* 	 ) 
	
 Liest Daten einer Wicklung und gibt diese zurück.

 **Parameter**
  | [in] :red:`identifier` Art der auszulesenden Daten (siehe Tabelle)
  | [in] :red:`key` Nummer der Wicklung

 **Return value**
  | :red:`d1` Erster Rückgabewert
  | :red:`d2` Zweiter Rückgabewert

 Beispiel: Ermittlung des Strangstromes
 ::

  Ire, Iim = get_wdg_data("cur",key)
  printf("Ire = %g, Iim = %g",Ire,Iim)

 Alternativ zu key kann die Wicklung auch über kartesische Koordinaten in der globalen Einheit adressiert werden.
 ::

  Ire, Iim = get_wdg_data("cur",x,y)
  printf("Ire = %g, Iim = %g",Ire,Iim)