Code_Saturne
CFD tool
ecs_famille.h
Go to the documentation of this file.
1 #ifndef _ECS_FAMILLE_H_
2 #define _ECS_FAMILLE_H_
3 
4 /*============================================================================
5  * Prototypes des fonctions de base
6  * associées à la structure `ecs_famille_t' décrivant une famille
7  *============================================================================*/
8 
9 /*
10  This file is part of Code_Saturne, a general-purpose CFD tool.
11 
12  Copyright (C) 1998-2012 EDF S.A.
13 
14  This program is free software; you can redistribute it and/or modify it under
15  the terms of the GNU General Public License as published by the Free Software
16  Foundation; either version 2 of the License, or (at your option) any later
17  version.
18 
19  This program is distributed in the hope that it will be useful, but WITHOUT
20  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
21  FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
22  details.
23 
24  You should have received a copy of the GNU General Public License along with
25  this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
26  Street, Fifth Floor, Boston, MA 02110-1301, USA.
27 */
28 
29 /*----------------------------------------------------------------------------*/
30 
31 /*============================================================================
32  * Visibilité
33  *============================================================================*/
34 
35 /*---------------------------------------------------------------------------
36  * Fichiers `include' librairie standard C ou BFT
37  *----------------------------------------------------------------------------*/
38 
39 #include <stdio.h>
40 
41 
42 /*---------------------------------------------------------------------------
43  * Fichiers `include' publics du paquetage global "Utilitaire"
44  *----------------------------------------------------------------------------*/
45 
46 #include "ecs_def.h"
47 #include "ecs_tab.h"
48 
49 
50 /*---------------------------------------------------------------------------
51  * Fichiers `include' publics des paquetages visibles
52  *----------------------------------------------------------------------------*/
53 
54 #include "ecs_descr.h"
55 
56 
57 /*---------------------------------------------------------------------------
58  * Fichiers `include' publics du paquetage courant
59  *----------------------------------------------------------------------------*/
60 
61 
62 /*============================================================================
63  * Déclaration de la structure
64  *============================================================================*/
65 
67 
68 
69 /*============================================================================
70  * Définition d'enumération
71  *============================================================================*/
72 
73 /*============================================================================
74  * Prototypes de fonctions publiques
75  *============================================================================*/
76 
77 /*---------------------------------------------------------------------------
78  * Fonction de création d'une structure de famille `ecs_famille_t'
79  *----------------------------------------------------------------------------*/
80 
83  ecs_descr_t *descr_tete);
84 
85 /*---------------------------------------------------------------------------
86  * Fonction libérant la structure `ecs_famille_t' donnée en argument.
87  * Elle renvoie un pointeur NULL
88  *----------------------------------------------------------------------------*/
89 
92 
93 /*---------------------------------------------------------------------------
94  * Fonction imprimant le contenu d'une structure `ecs_famille_t' donnée
95  * sur le flux décrit par la structure `ecs_file_t'
96  *----------------------------------------------------------------------------*/
97 
98 void
99 ecs_famille__imprime(const ecs_famille_t *this_fam,
100  int imp_col,
101  FILE *fic_imp);
102 
103 /*----------------------------------------------------------------------------
104  * Fonction qui renvoie la taille en octets d'une structure `ecs_famille_t'
105  *----------------------------------------------------------------------------*/
106 
107 float
108 ecs_famille__ret_taille(const ecs_famille_t *this_fam);
109 
110 /*----------------------------------------------------------------------------
111  * Fonction qui renvoie le nombre et la liste des des pointeurs sur les noms
112  * des descripteurs de la famille donnée en argument
113  *----------------------------------------------------------------------------*/
114 
116 ecs_famille__ret_nom(const ecs_famille_t *this_fam);
117 
118 /*----------------------------------------------------------------------------
119  * Fonction qui alloue une structure `ecs_famille_t' et qui remplit
120  * son contenu en copiant le contenu de la structure donnée en argument
121  *----------------------------------------------------------------------------*/
122 
124 ecs_famille__copie(ecs_famille_t *this_famille);
125 
126 /*----------------------------------------------------------------------------
127  * Fonction qui affiche la définition de la famille
128  *----------------------------------------------------------------------------*/
129 
130 void
131 ecs_famille__affiche(const ecs_famille_t *this_fam);
132 
133 /*----------------------------------------------------------------------------*/
134 
135 #endif /* _ECS_FAMILLE_H_ */
float ecs_famille__ret_taille(const ecs_famille_t *this_fam)
Definition: ecs_famille.c:194
Definition: ecs_descr_priv.h:58
Definition: ecs_tab.h:44
ecs_famille_t * ecs_famille__cree(int num, ecs_descr_t *descr_tete)
Definition: ecs_famille.c:97
ecs_tab_char_t ecs_famille__ret_nom(const ecs_famille_t *this_fam)
Definition: ecs_famille.c:215
ecs_famille_t * ecs_famille__detruit(ecs_famille_t *this_fam)
Definition: ecs_famille.c:128
Definition: ecs_famille_priv.h:70
void ecs_famille__imprime(const ecs_famille_t *this_fam, int imp_col, FILE *fic_imp)
Definition: ecs_famille.c:149
int num
Definition: ecs_famille_priv.h:72
ecs_famille_t * ecs_famille__copie(ecs_famille_t *this_famille)
Definition: ecs_famille.c:230
void ecs_famille__affiche(const ecs_famille_t *this_fam)
Definition: ecs_famille.c:251