.. highlightlang:: us

.. index:: auto_CalculateNCFormula

.. _auto_calculatencformula:

auto_CalculateNCFormula
=======================

.. us.tag  auto_CalculateNCFormula GERMAN New5603

:ref:`auto_CalculateNCFormula` fügt einer NC-Datei einen berechneten Kanal zu.

.. function::  ssError = auto_CalculateNCFormula(ssNCFile, oFormula)
               ssError = auto_CalculateNCFormula(ncid, oFormula)

.. us.return

**Returnwert**

**Return Value**

*ssError* ist ein leerer string (``""``), falls die Formel berechnet werden konnte.
Falls ein Fehler auftritt, enthält *ssError* eine Fehlermeldung.

.. us.params

**Parameter**

**Parameters**

.. uparam:: ssNCFile

   *ssNCFile*

.. uparam:: ncid

   *ncid*

.. uparam:: oFormula

   *oFormula* ist ein Objekt mit den folgenden optionalen Elementen
   (siehe Beispiel):

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

      * - Element
        - Default Value
        - Description
      * - ssFormula
        - required
        - Ist der Formeltext. In der Formel können alle in der NC-Datei 
          vorhandenen Kanäle verwendet werden. Siehe :ref:`defining-formulas`.
      * - ssOutputName
        - required
        - Ist der Name des Ergebniskanals. Der Name darf nur Buchstaben und 
          Unterstriche und Zahlen enthalten und nicht mit einer Zahl beginnen.
      * - ssUnit
        - ``""``
        - Ist die Einheit des Ergebniskanals.
      * - ssDescription
        - ``""``
        - Ist eine Beschreibung der Formel.
      * - ssOnlyIf
        - ``""``
        - Ist der Name einer Bedingung.
      * - ssFormat
        - ``""``
        - Ist ein Formatstring. Beispiele: %g oder %.2lf. 
      * - ssUseSIUnits
        - ``"0"``
        - Wenn "1" angegeben wird, rechnet die Formel mit SI-Einheiten.
      * - rsDeleteICFile
        - TRUE (1)
        - Beim Wert 0 wird die Formel nicht aus dem Temp-Verzeichnis gelöscht.

.. us.comment

**Kommentar**

Wie eine Formel definiert werden kann, wird im Artikel :ref:`formula-interpreter`
beschrieben. Alle in der Formel verwendeten Kanäle müssen in der Datei 
existieren. In der Formel können Funktionen aufgerufen werden, siehe 
:ref:`formula-location-identifier`. Die Formel wird nicht registriert. Die Formel
wird nur einmal berechnet.

.. us.example

**Beispiel**

.. include:: ../include/test_auto_CalculateNCFormula.ic

.. us.history

**History**

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

   * - Version
     - Beschreibung
   * - R2014.3
     - Neu.

.. seealso::
   :ref:`uberblick-automatisierung-der-diagrammerstellung`,
   :ref:`auto_ImportData`,
   :ref:`defining-formulas`,
   :ref:`obj_create`

:sub:`id-681772`