ni_measurement_plugin_sdk_service.measurement.info
==================================================

.. py:module:: ni_measurement_plugin_sdk_service.measurement.info

.. autoapi-nested-parse::

   Measurement service metadata classes and enums.



Classes
-------

.. autoapisummary::

   ni_measurement_plugin_sdk_service.measurement.info.MeasurementInfo
   ni_measurement_plugin_sdk_service.measurement.info.TypeSpecialization
   ni_measurement_plugin_sdk_service.measurement.info.DataType


Module Contents
---------------

.. py:class:: MeasurementInfo

   Bases: :py:obj:`NamedTuple`


   A named tuple providing information about a measurement.


   .. py:attribute:: display_name
      :type:  str

      The user visible name of the measurement.


   .. py:attribute:: version
      :type:  str

      The current version of the measurement.


   .. py:attribute:: ui_file_paths
      :type:  list[pathlib.Path]

      Absolute paths to user interface files for the measurement (e.g. ``.measui`` or ``.vi``
      files).


.. py:class:: TypeSpecialization(*args, **kwds)

   Bases: :py:obj:`enum.Enum`


   Enum that represents the type specializations for measurement parameters.


   .. py:attribute:: NoType
      :value: ''



   .. py:attribute:: Pin
      :value: 'pin'



   .. py:attribute:: Path
      :value: 'path'



   .. py:attribute:: Enum
      :value: 'enum'



   .. py:attribute:: IOResource
      :value: 'ioresource'



.. py:class:: DataType(*args, **kwds)

   Bases: :py:obj:`enum.Enum`


   Enum that represents the supported data types.


   .. py:attribute:: Int32
      :value: 0



   .. py:attribute:: Int64
      :value: 1



   .. py:attribute:: UInt32
      :value: 2



   .. py:attribute:: UInt64
      :value: 3



   .. py:attribute:: Float
      :value: 4



   .. py:attribute:: Double
      :value: 5



   .. py:attribute:: Boolean
      :value: 6



   .. py:attribute:: String
      :value: 7



   .. py:attribute:: Pin
      :value: 8



   .. py:attribute:: Path
      :value: 9



   .. py:attribute:: Enum
      :value: 10



   .. py:attribute:: DoubleXYData
      :value: 11



   .. py:attribute:: IOResource
      :value: 12



   .. py:attribute:: Double2DArray
      :value: 13



   .. py:attribute:: String2DArray
      :value: 14



   .. py:attribute:: Int32Array1D
      :value: 100



   .. py:attribute:: Int64Array1D
      :value: 101



   .. py:attribute:: UInt32Array1D
      :value: 102



   .. py:attribute:: UInt64Array1D
      :value: 103



   .. py:attribute:: FloatArray1D
      :value: 104



   .. py:attribute:: DoubleArray1D
      :value: 105



   .. py:attribute:: BooleanArray1D
      :value: 106



   .. py:attribute:: StringArray1D
      :value: 107



   .. py:attribute:: PinArray1D
      :value: 108



   .. py:attribute:: PathArray1D
      :value: 109



   .. py:attribute:: EnumArray1D
      :value: 110



   .. py:attribute:: DoubleXYDataArray1D
      :value: 111



   .. py:attribute:: IOResourceArray1D
      :value: 112