GIRAFFE Pipeline Reference Manual

gitable.h
1/*
2 * This file is part of the GIRAFFE Pipeline
3 * Copyright (C) 2002-2019 European Southern Observatory
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU 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 St, Fifth Floor, Boston, MA 02110-1301 USA
18 */
19
20#ifndef GITABLE_H
21#define GITABLE_H
22
23#include <cxtypes.h>
24
25#include <cpl_macros.h>
26#include <cpl_table.h>
27#include <cpl_matrix.h>
28#include <cpl_propertylist.h>
29#include <cpl_frameset.h>
30
31#include <giutils.h>
32
33
34#ifdef __cplusplus
35extern "C" {
36#endif
37
38
39//typedef struct GiTable GiTable;
40
41
42/*
43 * Create, copy and destroy operations
44 */
45
46GiTable *giraffe_table_new(void);
47GiTable *giraffe_table_create(cpl_table *, cpl_propertylist *);
48void giraffe_table_delete(GiTable *);
49GiTable *giraffe_table_duplicate(const GiTable *);
50
51void giraffe_table_clear(GiTable *);
52
53cxint giraffe_table_copy_matrix(GiTable *, const cxchar *, cpl_matrix *);
54
55/*
56 * Non-modifying operations
57 */
58
59cxint giraffe_table_is_empty(GiTable *);
60
61/*
62 * Accessors
63 */
64
65cpl_table *giraffe_table_get(const GiTable *);
66cxint giraffe_table_set(GiTable *, cpl_table *);
67cpl_propertylist *giraffe_table_get_properties(const GiTable *);
68cxint giraffe_table_set_properties(GiTable *, cpl_propertylist *);
69
70/*
71 * Loading and saving operations
72 */
73
74cxint giraffe_table_load(GiTable *self, const cxchar *filename,
75 cxint position, const cxchar *id);
76
77cxint giraffe_table_save(GiTable *self, const cxchar *filename);
78
79cxint giraffe_table_attach(GiTable *self, const cxchar *filename,
80 cxint position, const cxchar *id);
81
82cxint giraffe_table_add_info(GiTable *, const GiRecipeInfo *,
83 const cpl_frameset *);
84
85
86#ifdef __cplusplus
87}
88#endif
89
90#endif /* GITABLE_H */
cxint giraffe_table_set(GiTable *, cpl_table *)
Sets the table data.
Definition: gitable.c:456
GiTable * giraffe_table_create(cpl_table *, cpl_propertylist *)
Creates a Giraffe table from a table and a property list.
Definition: gitable.c:115
cxint giraffe_table_save(GiTable *self, const cxchar *filename)
Write a Giraffe table to a file.
Definition: gitable.c:636
GiTable * giraffe_table_new(void)
Creates a new, empty Giraffe table.
Definition: gitable.c:85
GiTable * giraffe_table_duplicate(const GiTable *)
Duplicate a Giraffe table.
Definition: gitable.c:176
cxint giraffe_table_load(GiTable *self, const cxchar *filename, cxint position, const cxchar *id)
Reads a data set from a file into a Giraffe table.
Definition: gitable.c:562
cxint giraffe_table_copy_matrix(GiTable *, const cxchar *, cpl_matrix *)
Copies matrix elements into a table.
Definition: gitable.c:259
void giraffe_table_clear(GiTable *)
Clears a Giraffe table.
Definition: gitable.c:220
cxint giraffe_table_attach(GiTable *self, const cxchar *filename, cxint position, const cxchar *id)
Attach a Giraffe table to a file.
Definition: gitable.c:749
void giraffe_table_delete(GiTable *)
Destroys a Giraffe table.
Definition: gitable.c:154
cpl_table * giraffe_table_get(const GiTable *)
Get the table data from a Giraffe table.
Definition: gitable.c:433
cxint giraffe_table_is_empty(GiTable *)
Check whether a Giraffe table is empty.
Definition: gitable.c:408
cpl_propertylist * giraffe_table_get_properties(const GiTable *)
Gets the table properties.
Definition: gitable.c:489
cxint giraffe_table_add_info(GiTable *, const GiRecipeInfo *, const cpl_frameset *)
Add additional frame information to a table.
Definition: gitable.c:836
cxint giraffe_table_set_properties(GiTable *, cpl_propertylist *)
Attaches a property list to an table.
Definition: gitable.c:516

This file is part of the GIRAFFE Pipeline Reference Manual 2.17.1.
Documentation copyright © 2002-2006 European Southern Observatory.
Generated on Thu Feb 13 2025 14:13:57 by doxygen 1.9.6 written by Dimitri van Heesch, © 1997-2004