NeXus  4.4.3
 All Data Structures Files Functions Variables Typedefs Macros Pages
napiu.h
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------
2  NeXus - Neutron & X-ray Common Data Format
3 
4  NeXus Utility (NXU) Application Program Interface Header File
5 
6  Copyright (C) 2005 Freddie Akeroyd
7 
8  This library is free software; you can redistribute it and/or
9  modify it under the terms of the GNU Lesser General Public
10  License as published by the Free Software Foundation; either
11  version 2 of the License, or (at your option) any later version.
12 
13  This library is distributed in the hope that it will be useful,
14  but WITHOUT ANY WARRANTY; without even the implied warranty of
15  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16  Lesser General Public License for more details.
17 
18  You should have received a copy of the GNU Lesser General Public
19  License along with this library; if not, write to the Free Software
20  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 
22  For further information, see <http://www.nexus.anl.gov/>
23 
24  $Id$
25 
26  ----------------------------------------------------------------------------*/
27 
28 #ifndef NEXUSAPIU
29 #define NEXUSAPIU
30 
31 #include "napi.h"
32 
33 #ifdef __cplusplus
34 extern "C" {
35 #endif /* __cplusplus */
36 
37 extern NXstatus NXUwriteglobals(NXhandle file_id, const char* user, const char* affiliation, const char* address, const char* phone, const char* fax, const char* email);
38 
39 extern NXstatus NXUwritegroup(NXhandle file_id, const char* group_name, const char* group_class);
40 
41 extern NXstatus NXUwritedata(NXhandle file_id, const char* data_name, const void* data, int data_type, int rank, const int dim[], const char* units, const int start[], const int size[]);
42 
43 extern NXstatus NXUreaddata(NXhandle file_id, const char* data_name, void* data, char* units, const int start[], const int size[]);
44 
45 extern NXstatus NXUwritehistogram(NXhandle file_id, const char* data_name, const void* data, const char* units);
46 
47 extern NXstatus NXUreadhistogram(NXhandle file_id, const char* data_name, void* data, char* units);
48 
49 extern NXstatus NXUsetcompress(NXhandle file_id, int comp_type, int comp_size);
50 
51 extern NXstatus NXUfindgroup(NXhandle file_id, const char* group_name, char* group_class);
52 
53 extern NXstatus NXUfindclass(NXhandle file_id, const char* group_class, char* group_name, int find_index);
54 
55 extern NXstatus NXUfinddata(NXhandle file_id, const char* data_name);
56 
57 extern NXstatus NXUfindattr(NXhandle file_id, const char* attr_name);
58 
59 extern NXstatus NXUfindsignal(NXhandle file_id, int signal, char* data_name, int* data_rank, int* data_type, int data_dimensions[]);
60 
61 extern NXstatus NXUfindaxis(NXhandle file_id, int axis, int primary, char* data_name, int* data_rank, int* data_type, int data_dimensions[]);
62 
63 extern NXstatus NXUfindlink(NXhandle file_id, NXlink* group_id, const char* group_class);
64 
65 extern NXstatus NXUresumelink(NXhandle file_id, NXlink group_id);
66 
67 #ifdef __cplusplus
68 }
69 #endif /* __cplusplus */
70 
71 #endif /*NEXUSAPIU*/
72 
NXstatus NXUfindlink(NXhandle file_id, NXlink *group_id, const char *group_class)
Definition: napiu.c:151
NXstatus NXUfinddata(NXhandle file_id, const char *data_name)
Definition: napiu.c:131
NXstatus NXUfindaxis(NXhandle file_id, int axis, int primary, char *data_name, int *data_rank, int *data_type, int data_dimensions[])
Definition: napiu.c:146
NXstatus NXUsetcompress(NXhandle file_id, int comp_type, int comp_size)
Definition: napiu.c:91
NXstatus NXUfindattr(NXhandle file_id, const char *attr_name)
Definition: napiu.c:136
NXstatus NXUfindgroup(NXhandle file_id, const char *group_name, char *group_class)
Definition: napiu.c:113
NXstatus NXUwritegroup(NXhandle file_id, const char *group_name, const char *group_class)
Definition: napiu.c:56
NXstatus NXUwritehistogram(NXhandle file_id, const char *data_name, const void *data, const char *units)
Definition: napiu.c:77
NXstatus NXUreadhistogram(NXhandle file_id, const char *data_name, void *data, char *units)
Definition: napiu.c:82
NXstatus NXUresumelink(NXhandle file_id, NXlink group_id)
Definition: napiu.c:156
NXstatus NXUfindclass(NXhandle file_id, const char *group_class, char *group_name, int find_index)
Definition: napiu.c:125
NXstatus NXUwriteglobals(NXhandle file_id, const char *user, const char *affiliation, const char *address, const char *telephone_number, const char *fax_number, const char *email)
Definition: napiu.c:44
NXstatus NXUfindsignal(NXhandle file_id, int signal, char *data_name, int *data_rank, int *data_type, int data_dimensions[])
Definition: napiu.c:141
NXstatus NXUwritedata(NXhandle file_id, const char *data_name, const void *data, int data_type, int rank, const int dim[], const char *units, const int start[], const int size[])
Definition: napiu.c:67
NXstatus NXUreaddata(NXhandle file_id, const char *data_name, void *data, char *units, const int start[], const int size[])
Definition: napiu.c:72