1e60f3be82
* update after a1-a6 drive * intrduction of targets - POLDI writing - Moved HKL calculation 4 TRICS to fourlib
229 lines
8.4 KiB
C
229 lines
8.4 KiB
C
/*---------------------------------------------------------------------------
|
|
NeXus - Neutron & X-ray Common Data Format
|
|
|
|
NeXus API header file
|
|
|
|
Copyright (C) 2000-2003 Mark Koennecke, Uwe Filges
|
|
|
|
This library is free software; you can redistribute it and/or
|
|
modify it under the terms of the GNU Lesser General Public
|
|
License as published by the Free Software Foundation; either
|
|
version 2 of the License, or (at your option) any later version.
|
|
|
|
This library is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
Lesser General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Lesser General Public
|
|
License along with this library; if not, write to the Free Software
|
|
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
|
|
|
Contact : Mark Koennecke <Mark.Koennecke@psi.ch>
|
|
Uwe Filges <Uwe.Filges@psi.ch>
|
|
Labor fuer Neutronenstreuung
|
|
Paul Scherrer Institut
|
|
CH-5232 Villigen-PSI
|
|
Switzerland
|
|
|
|
|
|
For further information, see <http://www.neutron.anl.gov/NeXus/>
|
|
|
|
----------------------------------------------------------------------------*/
|
|
|
|
#ifndef NEXUSAPI
|
|
#define NEXUSAPI
|
|
|
|
/* NeXus HDF45 */
|
|
#define NEXUS_VERSION "2.1.0." /* major.minor.patch */
|
|
|
|
#define CONSTCHAR char
|
|
|
|
#define NX_EXTERNAL
|
|
|
|
typedef void* NXhandle; /* really a pointer to a NexusFile structure */
|
|
typedef int NXstatus;
|
|
typedef char NXname[128];
|
|
|
|
typedef enum {NXACC_READ=1, NXACC_RDWR=2, NXACC_CREATE=3, NXACC_CREATE5=4} NXaccess;
|
|
|
|
typedef struct {
|
|
char *iname;
|
|
int type;
|
|
}info_type, *pinfo;
|
|
|
|
#define NX_OK 1
|
|
#define NX_ERROR 0
|
|
#define NX_EOD -1
|
|
|
|
#define NX_UNLIMITED -1
|
|
|
|
#define NX_MAXRANK 32
|
|
#define NX_MAXNAMELEN 64
|
|
|
|
|
|
|
|
|
|
|
|
/*-------------------------------------------------------------------------
|
|
HDF Datatype values for datatype parameters
|
|
in the Nexus API
|
|
|
|
NX_FLOAT32 32 bit float
|
|
NX_FLOAT64 64 nit float == double
|
|
NX_INT8 8 bit integer == byte
|
|
NX_UINT8 8 bit unsigned integer
|
|
NX_INT16 16 bit integer
|
|
NX_UINT16 16 bit unsigned integer
|
|
NX_INT32 32 bit integer
|
|
NX_UINT32 32 bit unsigned integer
|
|
NX_CHAR 8 bit character
|
|
|
|
This list is a edited version of the one found in the HDF header file
|
|
htndefs.h. That source will always be the real reference, this is
|
|
documented here for your convenience.
|
|
--------------------------------------------------------------------------*/
|
|
|
|
|
|
/* Map NeXus to HDF types */
|
|
#define NX_FLOAT32 5
|
|
#define NX_FLOAT64 6
|
|
#define NX_INT8 20
|
|
#define NX_UINT8 21
|
|
#define NX_INT16 22
|
|
#define NX_UINT16 23
|
|
#define NX_INT32 24
|
|
#define NX_UINT32 25
|
|
#define NX_CHAR 4
|
|
|
|
/* Map NeXus compression methods to HDF compression methods */
|
|
#define NX_COMP_NONE 100
|
|
#define NX_COMP_LZW 200
|
|
#define NX_COMP_RLE 300
|
|
#define NX_COMP_HUF 400
|
|
|
|
|
|
#ifdef HDF4
|
|
#include <mfhdf.h>
|
|
#endif
|
|
|
|
typedef struct {
|
|
#ifdef HDF4
|
|
int32 iTag; /* HDF4 variable */
|
|
int32 iRef; /* HDF4 variable */
|
|
#endif
|
|
|
|
#ifdef HDF5
|
|
char iTag5[1024]; /* HDF5 variable */
|
|
char iRef5[1024]; /* HDF5 variable */
|
|
char iRefd[1024]; /* HDF5 variable */
|
|
#endif
|
|
} NXlink;
|
|
|
|
|
|
|
|
#define NXMAXSTACK 50
|
|
|
|
#define CONCAT(__a,__b) __a##__b /* token concatenation */
|
|
|
|
#define MANGLE(__arg) CONCAT(__arg,_)
|
|
|
|
#define CALLING_STYLE /* blank */
|
|
|
|
# define NXopen MANGLE(nxiopen)
|
|
# define NXclose MANGLE(nxiclose)
|
|
# define NXmakegroup MANGLE(nximakegroup)
|
|
# define NXopengroup MANGLE(nxiopengroup)
|
|
# define NXclosegroup MANGLE(nxiclosegroup)
|
|
# define NXmakedata MANGLE(nximakedata)
|
|
# define NXcompmakedata MANGLE(nxicompmakedata)
|
|
# define NXcompress MANGLE(nxicompress)
|
|
# define NXopendata MANGLE(nxiopendata)
|
|
# define NXclosedata MANGLE(nxiclosedata)
|
|
# define NXputdata MANGLE(nxiputdata)
|
|
# define NXputslab MANGLE(nxiputslab)
|
|
# define NXputattr MANGLE(nxiputattr)
|
|
# define NXgetdataID MANGLE(nxigetdataid)
|
|
# define NXmakelink MANGLE(nximakelink)
|
|
# define NXmalloc MANGLE(nximalloc)
|
|
# define NXfree MANGLE(nxifree)
|
|
# define NXflush MANGLE(nxiflush)
|
|
|
|
# define NXgetinfo MANGLE(nxigetinfo)
|
|
# define NXgetnextentry MANGLE(nxigetnextentry)
|
|
# define NXgetdata MANGLE(nxigetdata)
|
|
|
|
# define NXgetslab MANGLE(nxigetslab)
|
|
# define NXgetnextattr MANGLE(nxigetnextattr)
|
|
# define NXgetattr MANGLE(nxigetattr)
|
|
# define NXgetattrinfo MANGLE(nxigetattrinfo)
|
|
# define NXgetgroupID MANGLE(nxigetgroupid)
|
|
# define NXgetgroupinfo MANGLE(nxigetgroupinfo)
|
|
# define NXinitgroupdir MANGLE(nxiinitgroupdir)
|
|
# define NXinitattrdir MANGLE(nxiinitattrdir)
|
|
# define NXsetcache MANGLE(nxisetcache)
|
|
/* FORTRAN helpers - for NeXus internal use only */
|
|
# define NXfopen MANGLE(nxifopen)
|
|
# define NXfclose MANGLE(nxifclose)
|
|
# define NXfflush MANGLE(nxifflush)
|
|
# define NXfmakedata MANGLE(nxifmakedata)
|
|
# define NXfcompmakedata MANGLE(nxifcompmakedata)
|
|
# define NXfcompress MANGLE(nxifcompress)
|
|
# define NXfputattr MANGLE(nxifputattr)
|
|
|
|
/*
|
|
* Standard interface
|
|
*/
|
|
|
|
NX_EXTERNAL NXstatus CALLING_STYLE NXopen(CONSTCHAR * filename, NXaccess access_method, NXhandle* pHandle);
|
|
NX_EXTERNAL NXstatus CALLING_STYLE NXclose(NXhandle* pHandle);
|
|
NX_EXTERNAL NXstatus CALLING_STYLE NXflush(NXhandle* pHandle);
|
|
|
|
NX_EXTERNAL NXstatus CALLING_STYLE NXmakegroup (NXhandle handle, CONSTCHAR *name, char* NXclass);
|
|
NX_EXTERNAL NXstatus CALLING_STYLE NXopengroup (NXhandle handle, CONSTCHAR *name, char* NXclass);
|
|
NX_EXTERNAL NXstatus CALLING_STYLE NXclosegroup(NXhandle handle);
|
|
|
|
NX_EXTERNAL NXstatus CALLING_STYLE NXmakedata (NXhandle handle, CONSTCHAR* label, int datatype, int rank, int dim[]);
|
|
NX_EXTERNAL NXstatus CALLING_STYLE NXcompmakedata (NXhandle handle, CONSTCHAR* label, int datatype, int rank, int dim[], int comp_typ, int bufsize[]);
|
|
NX_EXTERNAL NXstatus CALLING_STYLE NXcompress (NXhandle handle, int compr_type);
|
|
NX_EXTERNAL NXstatus CALLING_STYLE NXopendata (NXhandle handle, CONSTCHAR* label);
|
|
NX_EXTERNAL NXstatus CALLING_STYLE NXclosedata(NXhandle handle);
|
|
NX_EXTERNAL NXstatus CALLING_STYLE NXputdata(NXhandle handle, void* data);
|
|
|
|
NX_EXTERNAL NXstatus CALLING_STYLE NXputattr(NXhandle handle, CONSTCHAR* name, void* data, int iDataLen, int iType);
|
|
NX_EXTERNAL NXstatus CALLING_STYLE NXputslab(NXhandle handle, void* data, int start[], int size[]);
|
|
|
|
NX_EXTERNAL NXstatus CALLING_STYLE NXgetdataID(NXhandle handle, NXlink* pLink);
|
|
NX_EXTERNAL NXstatus CALLING_STYLE NXmakelink(NXhandle handle, NXlink* pLink);
|
|
|
|
NX_EXTERNAL NXstatus CALLING_STYLE NXgetdata(NXhandle handle, void* data);
|
|
NX_EXTERNAL NXstatus CALLING_STYLE NXgetinfo(NXhandle handle, int* rank, int dimension[], int* datatype);
|
|
NX_EXTERNAL NXstatus CALLING_STYLE NXgetnextentry(NXhandle handle, NXname name, NXname nxclass, int* datatype);
|
|
|
|
NX_EXTERNAL NXstatus CALLING_STYLE NXgetslab(NXhandle handle, void* data, int start[], int size[]);
|
|
NX_EXTERNAL NXstatus CALLING_STYLE NXgetnextattr(NXhandle handle, NXname pName, int *iLength, int *iType);
|
|
NX_EXTERNAL NXstatus CALLING_STYLE NXgetattr(NXhandle handle, char* name, void* data, int* iDataLen, int* iType);
|
|
NX_EXTERNAL NXstatus CALLING_STYLE NXgetattrinfo(NXhandle handle, int* no_items);
|
|
NX_EXTERNAL NXstatus CALLING_STYLE NXgetgroupID(NXhandle handle, NXlink* pLink);
|
|
NX_EXTERNAL NXstatus CALLING_STYLE NXgetgroupinfo(NXhandle handle, int* no_items, NXname name, NXname nxclass);
|
|
|
|
NX_EXTERNAL NXstatus CALLING_STYLE NXinitgroupdir(NXhandle handle);
|
|
NX_EXTERNAL NXstatus CALLING_STYLE NXinitattrdir(NXhandle handle);
|
|
|
|
NX_EXTERNAL NXstatus CALLING_STYLE NXmalloc(void** data, int rank, int dimensions[], int datatype);
|
|
NX_EXTERNAL NXstatus CALLING_STYLE NXfree(void** data);
|
|
|
|
|
|
/*-----------------------------------------------------------------------
|
|
A non Nexus standard function to set an error handler
|
|
*/
|
|
NX_EXTERNAL void CALLING_STYLE NXMSetError(void *pData, void (*ErrFunc)(void *pD, char *text));
|
|
|
|
/*
|
|
another special function for setting the default cache size for HDF-5
|
|
*/
|
|
NX_EXTERNAL NXstatus CALLING_STYLE NXsetcache(long newVal);
|
|
|
|
#endif /*NEXUSAPI*/
|
|
|