Patch #5209
[pspp-builds.git] / src / data / casefile.h
1 /* PSPP - computes sample statistics.
2    Copyright (C) 2004, 2006 Free Software Foundation, Inc.
3    Written by Ben Pfaff <blp@gnu.org>.
4
5    This program is free software; you can redistribute it and/or
6    modify it under the terms of the GNU General Public License as
7    published by the Free Software Foundation; either version 2 of the
8    License, or (at your option) any later version.
9
10    This program is distributed in the hope that it will be useful, but
11    WITHOUT ANY WARRANTY; without even the implied warranty of
12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13    General Public License for more details.
14
15    You should have received a copy of the GNU General Public License
16    along with this program; if not, write to the Free Software
17    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
18    02110-1301, USA. */
19
20 #ifndef CASEFILE_H
21 #define CASEFILE_H
22
23 #include <config.h>
24 #include <stddef.h>
25 #include <stdbool.h>
26
27
28 struct ccase;
29 struct casereader;
30 struct casefile;
31
32
33
34 struct casefile *casereader_get_casefile (const struct casereader *r);
35
36 unsigned long casereader_cnum (const struct casereader *r);
37
38 bool casereader_read (struct casereader *r, struct ccase *c);
39
40 bool casereader_read_xfer (struct casereader *r, struct ccase *c);
41
42 void casereader_destroy (struct casereader *r);
43
44 void casefile_destroy (struct casefile *cf);
45
46 bool casefile_error (const struct casefile *cf);
47
48 unsigned long casefile_get_case_cnt (const struct casefile *cf);
49
50 size_t casefile_get_value_cnt (const struct casefile *cf);
51
52 struct casereader *casefile_get_reader (const struct casefile *cf);
53 struct casereader *casefile_get_destructive_reader (struct casefile *cf);
54
55
56
57 bool casefile_append (struct casefile *cf, const struct ccase *c);
58
59 bool casefile_append_xfer (struct casefile *cf, struct ccase *c);
60
61 bool casefile_sleep (const struct casefile *cf);
62
63 bool casefile_in_core (const struct casefile *cf);
64
65 bool casefile_to_disk (const struct casefile *cf);
66
67 #endif