.. highlightlang:: us

.. index:: auto_LoadCompressorMap

.. _auto_LoadCompressorMap:

auto_LoadCompressorMap
======================

.. us.tag  auto_LoadCompressorMap ENGLISH New5506

:ref:`auto_LoadCompressorMap` creates a compressor map from the given
NC file and adds the map the the given layer.

.. function::  hvData = auto_LoadCompressorMap(ssNCName, hLayer, svVarName)
    hvData = auto_LoadCompressorMap(ssNCName, hLayer, svVarName, svConfig)

.. us.return

**Return Value**

*hvData* is a vector of handles of the new dataset. hvData[1] is the map.
hvData[2] is the surge curve, hvData[3] is the choke curve followed by the 
handles of the speed curves. In case of an error *hvData* is 0.

.. us.params

**Parameters**

.. uparam:: ssNCName

   *ssNCName* is the file name of an NC file or a valid ncid, see :ref:`nc_open`.

.. uparam:: hLayer

   *hLayer* is the handle of a layer.

.. uparam:: svVarName

   *svVarName* is a vector with four channel names. The first three channels 
   specify the map and the fourth channel contains the speed channel name. 
   Example: ``["MassFlowRate", "PressureRatio", "Efficiency", "Speed"]``.

.. uparam:: svConfig

   *svConfig* is a string vector with 5 elements: 

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

      * - Value
        - Meaning
      * - ``"0"`` or ``"1"``
        - Display surge limit
      * - ``"0"`` or ``"1"``
        - Display choke limit
      * - ``"0"`` or ``"1"``
        - Display max. efficiency curve
      * - ``"0"`` or ``"1"``
        - Map with color gradient
      * - ``"0"`` or ``"1"``
        - Label speed curves on right side (``"1"``), Label speed curves on left side (``"0"``). 

.. us.comment

**Comment**

Creates a compressor map.

.. us.example

**Example**

::

   <hDoc, hPage> = _UT_CreateEmptyPage();
   hLayer = LayerCreate();
   PageAddLayer(hPage, hLayer);
   ssDataFile = GetRootDirectory() + "\\samples\\compressor.xls";
   ssNC = auto_ImportData(ssDataFile);
   svVar = ["MassFlowRate", "PressureRatio", "Efficiency", "Speed"];
   svConfig = ["1", "1", "1", "1", "1"];
   auto_LoadCompressorMap(ssNC, hLayer, svVar, svConfig);
   LayerAutoScale(hLayer);
   PageUpdateFields(hPage);
   PageReplot(hPage);

.. us.history

**History**

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

   * - Version
     - Description
   * - R2013.6
     - New

.. seealso::
   :ref:`overview-automation`,
   :ref:`auto_LoadTemplate`,
   :ref:`auto_SetTemplate`, 
   :ref:`auto_LoadMatrixDataset`

:sub:`id-1813023`