ITAHPT.h 2.34 KB
Newer Older
Jonas Stienen's avatar
Jonas Stienen committed
1
/*
2 3 4 5
 * ----------------------------------------------------------------
 *
 *		ITA core libs
 *		(c) Copyright Institute of Technical Acoustics (ITA)
6
 *		RWTH Aachen University, Germany, 2015-2018
7 8 9 10 11 12 13 14 15 16 17
 *
 * ----------------------------------------------------------------
 *				    ____  __________  _______
 *				   //  / //__   ___/ //  _   |
 *				  //  /    //  /    //  /_|  |
 *				 //  /    //  /    //  ___   |
 *				//__/    //__/    //__/   |__|
 *
 * ----------------------------------------------------------------
 *
 */
Jonas Stienen's avatar
Jonas Stienen committed
18 19 20 21 22 23 24

#ifndef INCLUDE_WATCHER_ITA_HPT
#define INCLUDE_WATCHER_ITA_HPT

#include <ITABaseDefinitions.h>

#include <string>
Fabian Schlieper's avatar
Fabian Schlieper committed
25
#ifdef WIN32
26
 #ifndef  _WIN32_WINNT // @todo: remove
27
  #define _WIN32_WINNT 0x0501
28
 #endif
Jonas Stienen's avatar
Jonas Stienen committed
29
#include <windows.h>
Fabian Schlieper's avatar
Fabian Schlieper committed
30 31 32 33 34
#else
#include <stdio.h>
#include <linux/types.h>
#define __int64 int64_t
#endif
Jonas Stienen's avatar
Jonas Stienen committed
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78

// Definition des Datentyps für Timerticks
typedef __int64 ITATimerTicks;

//! Timerfunktionalität initialisieren
/**
 * Initialisiert die Timerfunktionalität.
 * Ein expliziter Aufruf dieser Funktion ist nicht nötig.
 * Alle anderen HPT-Funktionen führen automatisch eine
 * Initialisierung durch, sofern diese noch nicht erfolgte.
 * Der Grund das diese Funktion dennoch frei zugänglich ist,
 * ist der das in manchen Fällen der Zeitpunkt der Initialisierung
 * frei gewählt werden muss, da das Einmessen der Timer ein
 * wenig Laufzeit benötigt.
 */
ITA_BASE_API void ITAHPT_init();

//! Aktuellen Stand des Tickzählers ermitteln
ITA_BASE_API ITATimerTicks ITAHPT_now();

//! Gibt die Frequenz des Zeitmessers zurück [Einheit: Hertz]
/** Die Frequenz ist die Anzahl der Ticks pro Sekunde */
ITA_BASE_API double ITAHPT_frequency();

//! Gibt die Auflösung des Zeitmessers zurück [Einheit: Sekunden]
/** Die Auflösung ist Periodendauer eines Ticks. */
ITA_BASE_API double ITAHPT_resolution();

//! Konvertierung einer allgemeinen Zeit (in Sekunden) in Ticks
ITA_BASE_API ITATimerTicks toTimerTicks(double t);

//! Konvertierung von Ticks in eine Zeit in Sekunden
ITA_BASE_API double toSeconds(ITATimerTicks n);

//! Konvertierung einer Zeit in Ticks in einen String
ITA_BASE_API std::string toString(ITATimerTicks n);

//! Schöne Formatierung einer Zeitangabe in Sekunden (Menschen lesbar)
/**
  * \note [stienen] Code nach ITAStringUtils \timeToString() kopiert ...
  */
ITA_BASE_API std::string convertTimeToHumanReadableString(double dSeconds);

#endif //