Arcane  v3.16.6.0
Documentation utilisateur
Chargement...
Recherche...
Aucune correspondance
ICheckpointReader.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/* ICheckpointReader.h (C) 2000-2025 */
9/* */
10/* Interface du service de lecture d'une protection/reprise. */
11/*---------------------------------------------------------------------------*/
12#ifndef ARCANE_CORE_ICHECKPOINTREADER_H
13#define ARCANE_CORE_ICHECKPOINTREADER_H
14/*---------------------------------------------------------------------------*/
15/*---------------------------------------------------------------------------*/
16
18
19/*---------------------------------------------------------------------------*/
20/*---------------------------------------------------------------------------*/
21
22namespace Arcane
23{
24
25/*---------------------------------------------------------------------------*/
26/*---------------------------------------------------------------------------*/
27/*!
28 * \ingroup StandardService
29 * \brief Interface du service de lecture d'une protection/reprise.
30 */
31class ARCANE_CORE_EXPORT ICheckpointReader
32{
33 public:
34
35 //! Libère les ressources
36 virtual ~ICheckpointReader() = default;
37
38 public:
39
40 //! Retourne le lecteur associé
41 virtual IDataReader* dataReader() = 0;
42
43 //! Notifie qu'une protection va être lue avec les paramètres courants
44 virtual void notifyBeginRead() = 0;
45
46 //! Notifie qu'une protection vient d'être lue
47 virtual void notifyEndRead() = 0;
48
49 //! Positionne le nom du fichier de la protection
50 virtual void setFileName(const String& file_name) = 0;
51
52 //! Nom du fichier de la protection
53 virtual String fileName() const = 0;
54
55 //! Positionne le nom du répertoire de base de la protection
56 virtual void setBaseDirectoryName(const String& dirname) = 0;
57
58 //! Nom du répertoire de base de la protection
59 virtual String baseDirectoryName() const = 0;
60
61 //! Méta données associées à ce lecteur.
62 virtual void setReaderMetaData(const String&) = 0;
63
64 //! Positionne le temps et l'indice de la protection à lire
65 virtual void setCurrentTimeAndIndex(Real current_time, Integer current_index) = 0;
66};
67
68/*---------------------------------------------------------------------------*/
69/*---------------------------------------------------------------------------*/
70/*!
71 * \ingroup StandardService
72 * \brief Interface du service de lecture d'une protection/reprise (V2)
73 */
74class ARCANE_CORE_EXPORT ICheckpointReader2
75{
76 public:
77
78 //! Libère les ressources
79 virtual ~ICheckpointReader2() = default;
80
81 public:
82
83 //! Retourne le lecteur de données associé à ce lecteur de protection
84 virtual IDataReader2* dataReader() = 0;
85
86 /*!
87 * \brief Notifie qu'une protection va être lue avec les informations
88 * issues de \a checkpoint_info.
89 */
90 virtual void notifyBeginRead(const CheckpointReadInfo& cri) = 0;
91
92 //! Notifie de la fin de la lecture d'une protection.
93 virtual void notifyEndRead() = 0;
94};
95
96/*---------------------------------------------------------------------------*/
97/*---------------------------------------------------------------------------*/
98
99} // namespace Arcane
100
101/*---------------------------------------------------------------------------*/
102/*---------------------------------------------------------------------------*/
103
104#endif
105
Déclarations des types généraux de Arcane.
Informations de relecture d'une protection.
Interface du service de lecture d'une protection/reprise (V2)
virtual void notifyEndRead()=0
Notifie de la fin de la lecture d'une protection.
virtual void notifyBeginRead(const CheckpointReadInfo &cri)=0
Notifie qu'une protection va être lue avec les informations issues de checkpoint_info.
virtual IDataReader2 * dataReader()=0
Retourne le lecteur de données associé à ce lecteur de protection.
virtual ~ICheckpointReader2()=default
Libère les ressources.
Interface du service de lecture d'une protection/reprise.
virtual String baseDirectoryName() const =0
Nom du répertoire de base de la protection.
virtual void setFileName(const String &file_name)=0
Positionne le nom du fichier de la protection.
virtual String fileName() const =0
Nom du fichier de la protection.
virtual void notifyBeginRead()=0
Notifie qu'une protection va être lue avec les paramètres courants.
virtual ~ICheckpointReader()=default
Libère les ressources.
virtual void setCurrentTimeAndIndex(Real current_time, Integer current_index)=0
Positionne le temps et l'indice de la protection à lire.
virtual void setBaseDirectoryName(const String &dirname)=0
Positionne le nom du répertoire de base de la protection.
virtual void setReaderMetaData(const String &)=0
Méta données associées à ce lecteur.
virtual void notifyEndRead()=0
Notifie qu'une protection vient d'être lue.
virtual IDataReader * dataReader()=0
Retourne le lecteur associé
Interface de lecture des données d'une variable (Version 2)
Interface de lecture des données d'une variable.
Definition IDataReader.h:34
Chaîne de caractères unicode.
-*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
Int32 Integer
Type représentant un entier.
double Real
Type représentant un réel.