=======================
The TimeTagger Library
=======================

The Time Tagger Library contains classes for hardware access and data processing. 
This section covers the units and terminology definitions as well as describes constants and functions defined at the library level. 


Units of measurement
--------------------

.. cpp:class:: timestamp_t
    :no-typesetting:
.. doxygendefine:: timestamp_t

Analog voltage levels are specified in volts.


Channel numbers
---------------

.. cpp:class:: channel_t
    :no-typesetting:
.. doxygendefine:: channel_t

Unused channels
---------------
There might be the need to leave a parameter undefined when calling a class constructor.
Depending on the programming language you are using, you pass an undefined channel via the static constant :cpp:var:`CHANNEL_UNUSED`, which can be found in the ``TT`` class for .NET and in the ``TimeTagger`` class in MATLAB.


Constants
----------------

.. doxygenvariable:: CHANNEL_UNUSED


Enumerations
------------

.. doxygenenum:: AccessMode

.. doxygenenum:: ChannelEdge

.. doxygenenum:: CoincidenceTimestamp

.. doxygenenum:: FpgaLinkInterface

.. doxygenenum:: GatedChannelInitial

.. doxygenenum:: Resolution

.. doxygenenum:: Tag::Type

.. doxygenenum:: UsageStatisticsStatus

.. doxygenenum:: TestSignalSource


.. _time-tagger-library-functions:

Functions
---------

.. doxygenfunction:: createTimeTagger

.. doxygenfunction:: createTimeTaggerVirtual

.. doxygenfunction:: createTimeTaggerNetwork

.. doxygenfunction:: extractDeviceLicense

.. doxygenfunction:: flashLicense

.. doxygenfunction:: getTimeTaggerServerInfo

.. doxygenfunction:: freeTimeTagger

.. doxygenfunction:: scanTimeTagger

.. doxygenfunction:: scanTimeTaggerServers

.. doxygenfunction:: setLogger

.. doxygenfunction:: mergeStreamFiles

.. doxygenfunction:: getVersion

.. _api-usage-statistics:

.. rubric:: Usage statistics data collection

See also the section :doc:`/gettingStarted/UsageStatistics`.

.. doxygenfunction:: setUsageStatisticsStatus

.. doxygenfunction:: getUsageStatisticsStatus

.. doxygenfunction:: getUsageStatisticsReport


Helper classes
---------------

.. doxygenclass:: ChannelGate
