VDC_c.h File Reference

Go to the source code of this file.

Macros
#define	VDC_AccessMode_R   1
#define	VDC_AccessMode_W   2
#define	VDC_AccessMode_A   3
#define	VDC_XType   int
#define	VDC_XType_INVALID   -1
#define	VDC_XType_FLOAT   1
#define	VDC_XType_DOUBLE   2
#define	VDC_XType_INT32   3
#define	VDC_XType_INT64   4
#define	VDC_XType_TEXT   5
#define	VDCDimension_Axis_X   0
#define	VDCDimension_Axis_Y   1
#define	VDCDimension_Axis_Z   2
#define	VDCDimension_Axis_T   3

Typedefs
typedef struct VDCNetCDF	VDC
typedef struct VDCDimension	VDCDimension
typedef struct VDCBaseVar	VDCBaseVar
typedef struct VDCAuxVar	VDCAuxVar
typedef struct VDCDataVar	VDCDataVar
typedef struct VDCCoordVar	VDCCoordVar

Functions
VDCDimension *	VDCDimension_new ()
void	VDCDimension_delete (VDCDimension *p)
void	VDCDimension_GetName (const VDCDimension *p, char **name)
size_t	VDCDimension_GetLength (const VDCDimension *p)
int	VDCDimension_IsTimeVarying (const VDCDimension *p)
VDCBaseVar *	VDCBaseVar_new ()
void	VDCBaseVar_delete (VDCBaseVar *p)
void	VDCBaseVar_GetName (const VDCBaseVar *p, char **name)
void	VDCBaseVar_GetUnits (const VDCBaseVar *p, char **units)
int	VDCBaseVar_GetXType (const VDCBaseVar *p)
void	VDCBaseVar_GetWName (const VDCBaseVar *p, char **name)
void	VDCBaseVar_GetCRatios (const VDCBaseVar *p, size_t **ratios, int *count)
void	VDCBaseVar_GetBS (const VDCBaseVar *p, size_t **bs, int *count)
void	VDCBaseVar_GetPeriodic (const VDCBaseVar *p, long **periodic, int *count)
void	VDCBaseVar_GetAttributeNames (const VDCBaseVar *p, char ***names, int *count)
int	VDCBaseVar_IsCompressed (const VDCBaseVar *p)
VDCAuxVar *	VDCAuxVar_new ()
void	VDCAuxVar_delete (VDCAuxVar *p)
void	VDCAuxVar_GetDimNames (const VDCAuxVar *p, char ***names, int *count)
VDCDataVar *	VDCDataVar_new ()
void	VDCDataVar_delete (VDCDataVar *p)
void	VDCDataVar_GetMeshName (const VDCDataVar *p, char **name)
void	VDCDataVar_GetTimeCoordVar (const VDCDataVar *p, char **name)
void	VDCDataVar_GetMaskvar (const VDCDataVar *p, char **name)
int	VDCDataVar_GetHasMissing (const VDCDataVar *p)
double	VDCDataVar_GetMissingValue (const VDCDataVar *p)
VDCCoordVar *	VDCCoordVar_new ()
void	VDCCoordVar_delete (VDCCoordVar *p)
void	VDCCoordVar_GetDimNames (const VDCCoordVar *p, char ***names, int *count)
void	VDCCoordVar_GetTimeDimName (const VDCCoordVar *p, char **name)
int	VDCCoordVar_GetAxis (const VDCCoordVar *p)
int	VDCCoordVar_GetUniform (const VDCCoordVar *p)
VDC *	VDC_new ()
void	VDC_delete (VDC *p)
int	VDC_InitializeDefaultBS (VDC *p, const char *path, int mode)
int	VDC_Initialize (VDC *p, const char *path, int mode, size_t *bs, int bsCount)
int	VDC_GetDimension (const VDC *p, const char *dimname, VDCDimension *dimension)
void	VDC_GetDimensionNames (const VDC *p, char ***names, int *count)
int	VDC_GetCoordVarInfo (const VDC *p, const char *varname, VDCCoordVar *var)
int	VDC_GetDataVarInfo (const VDC *p, const char *varname, VDCDataVar *var)
int	VDC_GetBaseVarInfo (const VDC *p, const char *varname, VDCBaseVar *var)
void	VDC_GetDataVarNames (const VDC *p, char ***names, int *count)
void	VDC_GetCoordVarNames (const VDC *p, char ***names, int *count)
int	VDC_GetNumRefLevels (const VDC *p, const char *varname)
int	VDC_GetAtt_long (const VDC *p, const char *varname, const char *attname, long **values, int *count)
int	VDC_GetAtt_double (const VDC *p, const char *varname, const char *attname, double **values, int *count)
int	VDC_GetAtt_text (const VDC *p, const char *varname, const char *attname, char **text)
int	VDC_GetAtt_Count (const VDC *p, const char *varname, const char *attname, int *count)
void	VDC_GetAttNames (const VDC *p, const char *varname, char ***names, int *count)
int	VDC_GetAttType (const VDC *p, const char *varname, const char *attname)
int	VDC_VariableExists (const VDC *p, size_t ts, const char *varname, int reflevel, int lod)
int	VDC_IsTimeVarying (const VDC *p, const char *varname)
int	VDC_CoordVarExists (const VDC *p, const char *varname)
int	VDC_GetCRatios (const VDC *p, const char *varname, size_t **ratios, int *count)
int	VDC_GetCRatiosCount (const VDC *p, const char *varname)
int	VDC_GetVarDimLens (const VDC *p, const char *varname, int spatial, size_t **lens, int *count)
int	VDC_GetVarDimNames (const VDC *p, const char *varname, int spatial, char ***names, int *count)
int	VDC_GetVarCoordVars (const VDC *p, const char *varname, int spatial, char ***names, int *count)
int	VDC_GetVarDimLensAtLevel (const VDC *p, const char *varname, int level, size_t **lens, int *count)
int	VDC_OpenVariableRead (VDC *p, size_t ts, const char *varname, int level, int lod)
int	VDC_CloseVariable (VDC *p, int fd)
int	VDC_Read (VDC *p, int fd, float *region)
int	VDC_ReadSlice (VDC *p, int fd, float *slice)
int	VDC_ReadRegion (VDC *p, int fd, const size_t *min, const size_t *max, const int dims, float *region)
int	VDC_GetVar (VDC *p, const char *varname, int level, int lod, float *data)
int	VDC_GetVarAtTimeStep (VDC *p, size_t ts, const char *varname, int level, int lod, float *data)
int	VDC_SetCompressionBlock (VDC *p, const char *wname, const size_t *cratios, int cratiosCount)
int	VDC_DefineDimension (VDC *p, const char *dimname, size_t length)
int	VDC_DefineDimensionWithAxis (VDC *p, const char *dimname, size_t length, int axis)
int	VDC_DefineDataVar (VDC *p, const char *varname, const char **dimnames, size_t dimnamesCount, const char **coordvars, size_t coordvarCount, const char *units, VDC_XType xtype, int compressed)
int	VDC_DefineCoordVar (VDC *p, const char *varname, const char **dimnames, size_t dimnamesCount, const char *time_dim_name, const char *units, int axis, VDC_XType xtype, int compressed)
int	VDC_DefineCoordVarUniform (VDC *p, const char *varname, const char **dimnames, size_t dimnamesCount, const char *time_dim_name, const char *units, int axis, VDC_XType xtype, int compressed)
int	VDC_PutAtt (VDC *p, const char *varname, const char *attname, VDC_XType xtype, const void *values, size_t count)
int	VDC_PutAtt_double (VDC *p, const char *varname, const char *attname, VDC_XType xtype, const double *values, size_t count)
int	VDC_PutAtt_long (VDC *p, const char *varname, const char *attname, VDC_XType xtype, const long *values, size_t count)
int	VDC_PutAtt_text (VDC *p, const char *varname, const char *attname, VDC_XType xtype, const char *values)
int	VDC_EndDefine (VDC *p)
int	VDC_PutVar (VDC *p, const char *varname, int lod, const float *data)
int	VDC_PutVarAtTimeStep (VDC *p, size_t ts, const char *varname, int lod, const float *data)
const char *	VDC_GetErrMsg ()
void	VDC_FreeStringArray (char ***str, int *count)
void	VDC_FreeString (char **str)
void	VDC_FreeLongArray (long **data)
void	VDC_FreeDoubleArray (double **data)
void	VDC_FreeSize_tArray (size_t **data)
void	VDC_ReverseSize_tArray (size_t *data, int count)

Macro Definition Documentation

VDC_AccessMode_A

#define VDC_AccessMode_A   3

Definition at line 6 of file VDC_c.h.

VDC_AccessMode_R

#define VDC_AccessMode_R   1

Definition at line 4 of file VDC_c.h.

VDC_AccessMode_W

#define VDC_AccessMode_W   2

Definition at line 5 of file VDC_c.h.

VDC_XType

#define VDC_XType   int

Definition at line 8 of file VDC_c.h.

VDC_XType_DOUBLE

#define VDC_XType_DOUBLE   2

Definition at line 11 of file VDC_c.h.

VDC_XType_FLOAT

#define VDC_XType_FLOAT   1

Definition at line 10 of file VDC_c.h.

VDC_XType_INT32

#define VDC_XType_INT32   3

Definition at line 12 of file VDC_c.h.

VDC_XType_INT64

#define VDC_XType_INT64   4

Definition at line 13 of file VDC_c.h.

VDC_XType_INVALID

#define VDC_XType_INVALID   -1

Definition at line 9 of file VDC_c.h.

VDC_XType_TEXT

#define VDC_XType_TEXT   5

Definition at line 14 of file VDC_c.h.

VDCDimension_Axis_T

#define VDCDimension_Axis_T   3

Definition at line 19 of file VDC_c.h.

VDCDimension_Axis_X

#define VDCDimension_Axis_X   0

Definition at line 16 of file VDC_c.h.

VDCDimension_Axis_Y

#define VDCDimension_Axis_Y   1

Definition at line 17 of file VDC_c.h.

VDCDimension_Axis_Z

#define VDCDimension_Axis_Z   2

Definition at line 18 of file VDC_c.h.

Typedef Documentation

VDC

typedef struct VDCNetCDF VDC

Definition at line 34 of file VDC_c.h.

VDCAuxVar

typedef struct VDCAuxVar VDCAuxVar

Definition at line 37 of file VDC_c.h.

VDCBaseVar

typedef struct VDCBaseVar VDCBaseVar

Definition at line 36 of file VDC_c.h.

VDCCoordVar

typedef struct VDCCoordVar VDCCoordVar

Definition at line 39 of file VDC_c.h.

VDCDataVar

typedef struct VDCDataVar VDCDataVar

Definition at line 38 of file VDC_c.h.

VDCDimension

typedef struct VDCDimension VDCDimension

Definition at line 35 of file VDC_c.h.

Function Documentation

VDC_CloseVariable()

int VDC_CloseVariable	(	VDC *	p,
		int	fd
	)

VDC_CoordVarExists()

int VDC_CoordVarExists	(	const VDC *	p,
		const char *	varname
	)

VDC_DefineCoordVar()

int VDC_DefineCoordVar	(	VDC *	p,
		const char *	varname,
		const char **	dimnames,
		size_t	dimnamesCount,
		const char *	time_dim_name,
		const char *	units,
		int	axis,
		VDC_XType	xtype,
		int	compressed
	)

VDC_DefineCoordVarUniform()

int VDC_DefineCoordVarUniform	(	VDC *	p,
		const char *	varname,
		const char **	dimnames,
		size_t	dimnamesCount,
		const char *	time_dim_name,
		const char *	units,
		int	axis,
		VDC_XType	xtype,
		int	compressed
	)

VDC_DefineDataVar()

int VDC_DefineDataVar	(	VDC *	p,
		const char *	varname,
		const char **	dimnames,
		size_t	dimnamesCount,
		const char **	coordvars,
		size_t	coordvarCount,
		const char *	units,
		VDC_XType	xtype,
		int	compressed
	)

VDC_DefineDimension()

int VDC_DefineDimension	(	VDC *	p,
		const char *	dimname,
		size_t	length
	)

VDC_DefineDimensionWithAxis()

int VDC_DefineDimensionWithAxis	(	VDC *	p,
		const char *	dimname,
		size_t	length,
		int	axis
	)

VDC_delete()

void VDC_delete

(

VDC *

p

)

VDC_EndDefine()

int VDC_EndDefine

(

VDC *

p

)

VDC_FreeDoubleArray()

void VDC_FreeDoubleArray

(

double **

data

)

VDC_FreeLongArray()

void VDC_FreeLongArray

(

long **

data

)

VDC_FreeSize_tArray()

void VDC_FreeSize_tArray

(

size_t **

data

)

VDC_FreeString()

void VDC_FreeString

(

char **

str

)

VDC_FreeStringArray()

void VDC_FreeStringArray	(	char ***	str,
		int *	count
	)

VDC_GetAtt_Count()

int VDC_GetAtt_Count	(	const VDC *	p,
		const char *	varname,
		const char *	attname,
		int *	count
	)

VDC_GetAtt_double()

int VDC_GetAtt_double	(	const VDC *	p,
		const char *	varname,
		const char *	attname,
		double **	values,
		int *	count
	)

VDC_GetAtt_long()

int VDC_GetAtt_long	(	const VDC *	p,
		const char *	varname,
		const char *	attname,
		long **	values,
		int *	count
	)

VDC_GetAtt_text()

int VDC_GetAtt_text	(	const VDC *	p,
		const char *	varname,
		const char *	attname,
		char **	text
	)

VDC_GetAttNames()

void VDC_GetAttNames	(	const VDC *	p,
		const char *	varname,
		char ***	names,
		int *	count
	)

VDC_GetAttType()

int VDC_GetAttType	(	const VDC *	p,
		const char *	varname,
		const char *	attname
	)

VDC_GetBaseVarInfo()

int VDC_GetBaseVarInfo	(	const VDC *	p,
		const char *	varname,
		VDCBaseVar *	var
	)

VDC_GetCoordVarInfo()

int VDC_GetCoordVarInfo	(	const VDC *	p,
		const char *	varname,
		VDCCoordVar *	var
	)

VDC_GetCoordVarNames()

void VDC_GetCoordVarNames	(	const VDC *	p,
		char ***	names,
		int *	count
	)

VDC_GetCRatios()

int VDC_GetCRatios	(	const VDC *	p,
		const char *	varname,
		size_t **	ratios,
		int *	count
	)

VDC_GetCRatiosCount()

int VDC_GetCRatiosCount	(	const VDC *	p,
		const char *	varname
	)

VDC_GetDataVarInfo()

int VDC_GetDataVarInfo	(	const VDC *	p,
		const char *	varname,
		VDCDataVar *	var
	)

VDC_GetDataVarNames()

void VDC_GetDataVarNames	(	const VDC *	p,
		char ***	names,
		int *	count
	)

VDC_GetDimension()

int VDC_GetDimension	(	const VDC *	p,
		const char *	dimname,
		VDCDimension *	dimension
	)

VDC_GetDimensionNames()

void VDC_GetDimensionNames	(	const VDC *	p,
		char ***	names,
		int *	count
	)

VDC_GetErrMsg()

const char * VDC_GetErrMsg

(

)

VDC_GetNumRefLevels()

int VDC_GetNumRefLevels	(	const VDC *	p,
		const char *	varname
	)

VDC_GetVar()

int VDC_GetVar	(	VDC *	p,
		const char *	varname,
		int	level,
		int	lod,
		float *	data
	)

VDC_GetVarAtTimeStep()

int VDC_GetVarAtTimeStep	(	VDC *	p,
		size_t	ts,
		const char *	varname,
		int	level,
		int	lod,
		float *	data
	)

VDC_GetVarCoordVars()

int VDC_GetVarCoordVars	(	const VDC *	p,
		const char *	varname,
		int	spatial,
		char ***	names,
		int *	count
	)

VDC_GetVarDimLens()

int VDC_GetVarDimLens	(	const VDC *	p,
		const char *	varname,
		int	spatial,
		size_t **	lens,
		int *	count
	)

VDC_GetVarDimLensAtLevel()

int VDC_GetVarDimLensAtLevel	(	const VDC *	p,
		const char *	varname,
		int	level,
		size_t **	lens,
		int *	count
	)

VDC_GetVarDimNames()

int VDC_GetVarDimNames	(	const VDC *	p,
		const char *	varname,
		int	spatial,
		char ***	names,
		int *	count
	)

VDC_Initialize()

int VDC_Initialize	(	VDC *	p,
		const char *	path,
		int	mode,
		size_t *	bs,
		int	bsCount
	)

VDC_InitializeDefaultBS()

int VDC_InitializeDefaultBS	(	VDC *	p,
		const char *	path,
		int	mode
	)

VDC_IsTimeVarying()

int VDC_IsTimeVarying	(	const VDC *	p,
		const char *	varname
	)

VDC_new()

VDC * VDC_new

(

)

VDC_OpenVariableRead()

int VDC_OpenVariableRead	(	VDC *	p,
		size_t	ts,
		const char *	varname,
		int	level,
		int	lod
	)

VDC_PutAtt()

int VDC_PutAtt	(	VDC *	p,
		const char *	varname,
		const char *	attname,
		VDC_XType	xtype,
		const void *	values,
		size_t	count
	)

VDC_PutAtt_double()

int VDC_PutAtt_double	(	VDC *	p,
		const char *	varname,
		const char *	attname,
		VDC_XType	xtype,
		const double *	values,
		size_t	count
	)

VDC_PutAtt_long()

int VDC_PutAtt_long	(	VDC *	p,
		const char *	varname,
		const char *	attname,
		VDC_XType	xtype,
		const long *	values,
		size_t	count
	)

VDC_PutAtt_text()

int VDC_PutAtt_text	(	VDC *	p,
		const char *	varname,
		const char *	attname,
		VDC_XType	xtype,
		const char *	values
	)

VDC_PutVar()

int VDC_PutVar	(	VDC *	p,
		const char *	varname,
		int	lod,
		const float *	data
	)

VDC_PutVarAtTimeStep()

int VDC_PutVarAtTimeStep	(	VDC *	p,
		size_t	ts,
		const char *	varname,
		int	lod,
		const float *	data
	)

VDC_Read()

int VDC_Read	(	VDC *	p,
		int	fd,
		float *	region
	)

VDC_ReadRegion()

int VDC_ReadRegion	(	VDC *	p,
		int	fd,
		const size_t *	min,
		const size_t *	max,
		const int	dims,
		float *	region
	)

VDC_ReadSlice()

int VDC_ReadSlice	(	VDC *	p,
		int	fd,
		float *	slice
	)

VDC_ReverseSize_tArray()

void VDC_ReverseSize_tArray	(	size_t *	data,
		int	count
	)

VDC_SetCompressionBlock()

int VDC_SetCompressionBlock	(	VDC *	p,
		const char *	wname,
		const size_t *	cratios,
		int	cratiosCount
	)

VDC_VariableExists()

int VDC_VariableExists	(	const VDC *	p,
		size_t	ts,
		const char *	varname,
		int	reflevel,
		int	lod
	)

VDCAuxVar_delete()

void VDCAuxVar_delete

(

VDCAuxVar *

p

)

VDCAuxVar_GetDimNames()

void VDCAuxVar_GetDimNames	(	const VDCAuxVar *	p,
		char ***	names,
		int *	count
	)

VDCAuxVar_new()

VDCAuxVar * VDCAuxVar_new

(

)

VDCBaseVar_delete()

void VDCBaseVar_delete

(

VDCBaseVar *

p

)

VDCBaseVar_GetAttributeNames()

void VDCBaseVar_GetAttributeNames	(	const VDCBaseVar *	p,
		char ***	names,
		int *	count
	)

VDCBaseVar_GetBS()

void VDCBaseVar_GetBS	(	const VDCBaseVar *	p,
		size_t **	bs,
		int *	count
	)

VDCBaseVar_GetCRatios()

void VDCBaseVar_GetCRatios	(	const VDCBaseVar *	p,
		size_t **	ratios,
		int *	count
	)

VDCBaseVar_GetName()

void VDCBaseVar_GetName	(	const VDCBaseVar *	p,
		char **	name
	)

VDCBaseVar_GetPeriodic()

void VDCBaseVar_GetPeriodic	(	const VDCBaseVar *	p,
		long **	periodic,
		int *	count
	)

VDCBaseVar_GetUnits()

void VDCBaseVar_GetUnits	(	const VDCBaseVar *	p,
		char **	units
	)

VDCBaseVar_GetWName()

void VDCBaseVar_GetWName	(	const VDCBaseVar *	p,
		char **	name
	)

VDCBaseVar_GetXType()

int VDCBaseVar_GetXType

(

const VDCBaseVar *

p

)

VDCBaseVar_IsCompressed()

int VDCBaseVar_IsCompressed

(

const VDCBaseVar *

p

)

VDCBaseVar_new()

VDCBaseVar * VDCBaseVar_new

(

)

VDCCoordVar_delete()

void VDCCoordVar_delete

(

VDCCoordVar *

p

)

VDCCoordVar_GetAxis()

int VDCCoordVar_GetAxis

(

const VDCCoordVar *

p

)

VDCCoordVar_GetDimNames()

void VDCCoordVar_GetDimNames	(	const VDCCoordVar *	p,
		char ***	names,
		int *	count
	)

VDCCoordVar_GetTimeDimName()

void VDCCoordVar_GetTimeDimName	(	const VDCCoordVar *	p,
		char **	name
	)

VDCCoordVar_GetUniform()

int VDCCoordVar_GetUniform

(

const VDCCoordVar *

p

)

VDCCoordVar_new()

VDCCoordVar * VDCCoordVar_new

(

)

VDCDataVar_delete()

void VDCDataVar_delete

(

VDCDataVar *

p

)

VDCDataVar_GetHasMissing()

int VDCDataVar_GetHasMissing

(

const VDCDataVar *

p

)

VDCDataVar_GetMaskvar()

void VDCDataVar_GetMaskvar	(	const VDCDataVar *	p,
		char **	name
	)

VDCDataVar_GetMeshName()

void VDCDataVar_GetMeshName	(	const VDCDataVar *	p,
		char **	name
	)

VDCDataVar_GetMissingValue()

double VDCDataVar_GetMissingValue

(

const VDCDataVar *

p

)

VDCDataVar_GetTimeCoordVar()

void VDCDataVar_GetTimeCoordVar	(	const VDCDataVar *	p,
		char **	name
	)

VDCDataVar_new()

VDCDataVar * VDCDataVar_new

(

)

VDCDimension_delete()

void VDCDimension_delete

(

VDCDimension *

p

)

VDCDimension_GetLength()

size_t VDCDimension_GetLength

(

const VDCDimension *

p

)

VDCDimension_GetName()

void VDCDimension_GetName	(	const VDCDimension *	p,
		char **	name
	)

VDCDimension_IsTimeVarying()

int VDCDimension_IsTimeVarying

(

const VDCDimension *

p

)

VDCDimension_new()

VDCDimension * VDCDimension_new

(

)