Arcane  v3.16.6.0
Documentation utilisateur
Chargement...
Recherche...
Aucune correspondance
ITimerMng.h
1// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
2//-----------------------------------------------------------------------------
3// Copyright 2000-2025 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
4// See the top-level COPYRIGHT file for details.
5// SPDX-License-Identifier: Apache-2.0
6//-----------------------------------------------------------------------------
7/*---------------------------------------------------------------------------*/
8/* ITimerMng.h (C) 2000-2025 */
9/* */
10/* Interface d'un gestionnaire de timer. */
11/*---------------------------------------------------------------------------*/
12#ifndef ARCANE_CORE_ITIMERMNG_H
13#define ARCANE_CORE_ITIMERMNG_H
14/*---------------------------------------------------------------------------*/
15/*---------------------------------------------------------------------------*/
16
18
19/*---------------------------------------------------------------------------*/
20/*---------------------------------------------------------------------------*/
21
22namespace Arcane
23{
24
25/*---------------------------------------------------------------------------*/
26/*---------------------------------------------------------------------------*/
27/*!
28 * \brief Interface d'un gestionnaire de timer.
29 *
30 * Ce gestionnaire est utilisé exclusivement par les timers de
31 * l'architecture (Timer) et ne doit pas être utilisé directement.
32 *
33 * Un timer utilise la méthode beginTimer() pour indiquer
34 * à ce gestionnaire qu'il souhaite débuter une mesure temporelle et
35 * la méthode endTimer() pour indiquer que la mesure est terminée et
36 * obtenir le temps écoulé depuis l'appel à beginTimer(). Il est aussi
37 * possible d'obtenir le temps écoulé sans arrêter le timer par appel
38 * à la fonction getTime().
39 *
40 * Les timers de même type s'imbriquent les uns dans les autres et doivent respecter
41 * le principe des piles pour les appels à beginTimer() et endTimer(): le
42 * timer qui appelle endTimer() doit être le dernier à avoir appelé beginTimer().
43 *
44 * Le type de temps utilisé est déterminé par le Timer::type(). Il s'agit soit du
45 * temps CPU, soit du temps réel.
46 *
47 */
49{
50 public:
51
52 /*!
53 * \brief Libère les ressources.
54 * \pre !hasTimer()
55 */
56 virtual ~ITimerMng() = default;
57
58 public:
59
60 /*!
61 * \brief Attache le timer \a timer à ce gestionnaire.
62 *
63 * \pre !\a timer
64 * \pre !hasTimer(\a timer)
65 * \post hasTimer(\a timer)
66 */
67 virtual void beginTimer(Timer* timer) = 0;
68
69 /*!
70 * \brief Relâche le timer \a timer.
71 *
72 * \return le temps écoulé depuis l'appel à beginTimer().
73 *
74 * \pre !\a timer
75 * \pre hasTimer(\a timer)
76 * \post !hasTimer(\a timer)
77 */
78 virtual Real endTimer(Timer* timer) = 0;
79
80 /*!
81 * \brief Temps écoulé depuis le dernier appel à beginTimer().
82 *
83 * \pre !\a timer
84 * \pre hasTimer(\a timer)
85 */
86 virtual Real getTime(Timer* timer) = 0;
87
88 /*!
89 * \brief Indique si le timer \a timer est enregistré.
90 *
91 * \pre !\a timer
92 * \deprecated Cette fonction sera supprimé à terme. Ne plus utiliser.
93 */
94 ARCCORE_DEPRECATED_2019("Do not use this method")
95 virtual bool hasTimer(Timer* timer) = 0;
96};
97
98/*---------------------------------------------------------------------------*/
99/*---------------------------------------------------------------------------*/
100
101} // namespace Arcane
102
103/*---------------------------------------------------------------------------*/
104/*---------------------------------------------------------------------------*/
105
106#endif
Déclarations des types généraux de Arcane.
Interface d'un gestionnaire de timer.
Definition ITimerMng.h:49
virtual Real endTimer(Timer *timer)=0
Relâche le timer timer.
virtual bool hasTimer(Timer *timer)=0
Indique si le timer timer est enregistré.
virtual void beginTimer(Timer *timer)=0
Attache le timer timer à ce gestionnaire.
virtual ~ITimerMng()=default
Libère les ressources.
virtual Real getTime(Timer *timer)=0
Temps écoulé depuis le dernier appel à beginTimer().
Gestion d'un timer.
Definition Timer.h:62
-*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
double Real
Type représentant un réel.