.. highlightlang:: us

.. index:: nc_from_obj

.. _nc_from_obj:

nc_from_obj
===========

.. us.tag nc_from_obj NOTREADYGERMAN nc.tools New5147

:ref:`nc_from_obj` erzeugt eine netCDF-Datendatei aus einem speziellen 
UniScript-Objekt (Struktur).

.. function:: bool = nc_from_obj(obj, ssNCFilename)

.. us.return

**Returnwert**

*bool* ist TRUE (1), wenn die Funktion erfolgreich war und sonst FALSE (0).

.. us.params

**Parameter**

.. uparam:: obj

   *obj* ist ein Objekt, das Kanäle enthält und optional folgende Elemente: 
   ``globals``, ``channel_info`` und ``order``. ``globals`` ist ein Objekt, 
   das die globalen Attribute enthält. ``channel_info`` ist ein Objekt, das für
   jeden Kanal ein Objekt mit den Kanalattributen enthält. ``order`` ist ein
   Objekt mit den Kanalnamen, das die Reihenfolge der Kanäle in der
   netCDF-Datei festlegt. 

.. uparam:: ssNCFilename

   *ssNCFilename* ist der vollständige Name mit Pfad der zu erzeugenden
   netCDF-Datei.

.. us.comment

**Kommentar**

Die Funktion schreibt die Kanäle und Attribute mit dem Datentyp 
``double`` bzw. ``char``. Falls im Element *channel_info* für einen Kanal das 
Element *datatype* definiert ist, wird der Datentyp für die Kanaldefinition 
übernommen. Beispiel ``o.channel_info["speed"].datatype = "real4"`` schreibt
einen Kanal vom Typ NC_FLOAT. 

Das Element ``order`` ist optional. Wenn das Element existiert, müssen
alle Kanäle aufgezählt werden, die in die NC-Datei geschrieben werden sollen. 
``order[1]`` enthält den ersten Kanalnamen, ``order[2]`` enthät den zweiten
Kanalnamen, usw.

Siehe :ref:`format-description-for-csv,-text-and-excel-files--datatype`.

.. us.example

**Beispiel**

::

   ssNCFileName = GetUserDirectory() + "test.nc";
   nc_from_obj([. x = [1,2,3], y = [4,5,2]], ssNCFileName); 
   NC_Edit(ssNCFileName);

.. us.example

**Beispiel**

::

   def test()
   {
       ssNCFileName = GetUserDirectory() + "test.nc";
 
       x = linspace(0,2*PI*100, 1e6);
       y = sin(x);
       o = [. 
           x = x,
           y = y,
           order = [. 1 = "y", 2 = "x"],
           globals = [. 
             Comment = "Simple Test"
           ],
           channel_info = [. x = [. a = 1], y = [. b = 2]];
       ];

      nc_from_obj(o, ssNCFileName); 
      NC_Edit(ssNCFileName);
      return o;
   }
   o = test()

.. us.history

**History**

.. list-table::
   :header-rows: 1

   * - Version
     - Beschreibung
   * - R2013.11
     - Attribut datatype wird für die Bestimmung des Datentyps in der NC-Datei
       verwendet.
   * - 5.14.7
     - Neu.

.. seealso::
   :ref:`uberblick-netcdf-dateien`,
   :ref:`nc_to_obj`,
   :ref:`NC_Edit`

:sub:`id-54330`