NEP 4.0.0
NetCDF Expansion Pack
Loading...
Searching...
No Matches
Macros | Functions | Variables
nextcdf4dispatch.h File Reference

Public dispatch declarations for the NEXTCDF-4 UDF backend. More...

#include "config.h"
#include "ncdispatch.h"
#include "nep.h"

Go to the source code of this file.

Macros

#define NC_FORMATX_NEXTCDF4   NC_FORMATX_UDF9
 

Functions

int NEXTCDF4_create (const char *path, int cmode, size_t initialsz, int basepe, size_t *chunksizehintp, void *parameters, const NC_Dispatch *dispatch, int ncid)
 
int NEXTCDF4_open (const char *path, int mode, int basepe, size_t *chunksizehintp, void *parameters, const NC_Dispatch *dispatch, int ncid)
 
int NEXTCDF4_abort (int ncid)
 
int NEXTCDF4_close (int ncid, void *parameters)
 
int NEXTCDF4_sync (int ncid)
 
int NEXTCDF4_inq_format (int ncid, int *formatp)
 
int NEXTCDF4_inq_format_extended (int ncid, int *formatp, int *modep)
 
NC_Dispatch * NC_NEXTCDF4_initialize (void)
 
int NC_NEXTCDF4_finalize (void)
 

Variables

const NC_Dispatch * NEXTCDF4_dispatch_table
 

Detailed Description

Public dispatch declarations for the NEXTCDF-4 UDF backend.

Author
Edward Hartnett
Date
2026-08-28

Macro Definition Documentation

◆ NC_FORMATX_NEXTCDF4

#define NC_FORMATX_NEXTCDF4   NC_FORMATX_UDF9

Extended format identifier used by the NEXTCDF-4 dispatch table.

Function Documentation

◆ NC_NEXTCDF4_finalize()

int NC_NEXTCDF4_finalize ( void  )
extern

Finalize process-wide NEXTCDF-4 dispatch state.

Returns
NC_NOERR.

◆ NC_NEXTCDF4_initialize()

NC_Dispatch * NC_NEXTCDF4_initialize ( void  )
extern

Register the NEXTCDF-4 dispatch table in UDF slot 9.

Returns
Pointer to the NEXTCDF-4 dispatch table.

◆ NEXTCDF4_abort()

int NEXTCDF4_abort ( int  ncid)
extern

Abort a NEXTCDF-4 file operation and release its resources.

Parameters
ncidNetCDF file identifier.
Returns
NC_NOERR on success, or a NetCDF error code.

◆ NEXTCDF4_close()

int NEXTCDF4_close ( int  ncid,
void *  parameters 
)
extern

Close a NEXTCDF-4 file and release its resources.

Parameters
ncidNetCDF file identifier.
parametersOptional close parameters; currently ignored.
Returns
NC_NOERR on success, or a NetCDF error code.

◆ NEXTCDF4_create()

int NEXTCDF4_create ( const char *  path,
int  cmode,
size_t  initialsz,
int  basepe,
size_t *  chunksizehintp,
void *  parameters,
const NC_Dispatch *  dispatch,
int  ncid 
)
extern

Create an empty NEXTCDF-4 file.

Parameters
pathFile-system path to create.
cmodeNetCDF create-mode flags.
initialszRequested initial file size; currently ignored.
basepeBase processing element; currently ignored.
chunksizehintpChunk-size hint; currently ignored.
parametersOptional dispatch parameters; currently ignored.
dispatchDispatch table selected by netcdf-c.
ncidNetCDF file identifier allocated by netcdf-c.
Returns
NC_NOERR on success, or a NetCDF error code.

◆ NEXTCDF4_inq_format()

int NEXTCDF4_inq_format ( int  ncid,
int *  formatp 
)
extern

Inquire the public NetCDF format class.

Parameters
ncidNetCDF file identifier.
formatpOptional destination for NC_FORMAT_NETCDF4.
Returns
NC_NOERR on success, or a NetCDF error code.

◆ NEXTCDF4_inq_format_extended()

int NEXTCDF4_inq_format_extended ( int  ncid,
int *  formatp,
int *  modep 
)
extern

Inquire the extended NEXTCDF-4 format and effective mode.

Parameters
ncidNetCDF file identifier.
formatpOptional destination for NC_FORMATX_NEXTCDF4.
modepOptional destination for the effective open/create mode.
Returns
NC_NOERR on success, or a NetCDF error code.

◆ NEXTCDF4_open()

int NEXTCDF4_open ( const char *  path,
int  mode,
int  basepe,
size_t *  chunksizehintp,
void *  parameters,
const NC_Dispatch *  dispatch,
int  ncid 
)
extern

Open an empty, marked NEXTCDF-4 file.

Parameters
pathFile-system path to open.
modeNetCDF open-mode flags.
basepeBase processing element; currently ignored.
chunksizehintpChunk-size hint; currently ignored.
parametersOptional dispatch parameters; currently ignored.
dispatchDispatch table selected by netcdf-c.
ncidNetCDF file identifier allocated by netcdf-c.
Returns
NC_NOERR on success, or a NetCDF error code.

◆ NEXTCDF4_sync()

int NEXTCDF4_sync ( int  ncid)
extern

Flush a writable NEXTCDF-4 file to storage.

Parameters
ncidNetCDF file identifier.
Returns
NC_NOERR on success, or a NetCDF error code.

Variable Documentation

◆ NEXTCDF4_dispatch_table

const NC_Dispatch* NEXTCDF4_dispatch_table
extern

Active NEXTCDF-4 dispatch table, or NULL before initialization.