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 struct casefilter;
  32
  33 /* Casereader functions */
  34
  35 struct casefile *casereader_get_casefile (const struct casereader *r);
  36
  37 unsigned long casereader_cnum (const struct casereader *r);
  38
  39 bool casereader_read (struct casereader *r, struct ccase *c);
  40
  41 bool casereader_read_xfer (struct casereader *r, struct ccase *c);
  42
  43 void casereader_destroy (struct casereader *r);
  44
  45 struct casereader *casereader_clone(const struct casereader *r);
  46
  47
  48 /* Casefile functions */
  49
  50 void casefile_destroy (struct casefile *cf);
  51
  52 bool casefile_error (const struct casefile *cf);
  53
  54 unsigned long casefile_get_case_cnt (const struct casefile *cf);
  55
  56 size_t casefile_get_value_cnt (const struct casefile *cf);
  57
  58 struct casereader *casefile_get_reader (const struct casefile *cf, struct casefilter *filter);
  59
  60 struct casereader *casefile_get_destructive_reader (struct casefile *cf);
  61
  62 bool casefile_append (struct casefile *cf, const struct ccase *c);
  63
  64 bool casefile_append_xfer (struct casefile *cf, struct ccase *c);
  65
  66 bool casefile_sleep (const struct casefile *cf);
  67
  68 bool casefile_in_core (const struct casefile *cf);
  69
  70 bool casefile_to_disk (const struct casefile *cf);
  71
  72 #endif