Host file

All the files composing a mosaic a linked together in a ``host'' file where grids files, data, and mosaic files are listed. More...

Functions
int	nccf_def_host (const char *coordinates_id, const char *data_id, int nTimeSlices, int *hostid)
	Define an empty host file (in memory).
int	nccf_add_host_file (int hostid, const char *filename, int force)
	Add a file to host.
int	nccf_def_host_from_file (const char *filename, int *hostid)
	Define (construct) a host file from a netcdf file.
int	nccf_free_host (int hostid)
	Free all memory associated with a host (acts as a destructor).
int	nccf_put_host (int ncid, int hostid)
	Write the host to file.
int	nccf_add_host_global_att (int hostid, const char *attname, const char *value)
	Add a global attribute the a host object.
int	nccf_get_host_global_att (int hostid, const char *attname, char *value)
	Get a global attribute the a host object.
int	nccf_inq_host_ngrids (int hostid, int *ngrids)
	Get the number of grid files from a host file.
int	nccf_inq_host_nstaticdata (int hostid, int *nstaticdata)
	Get the number of static data files from host file.
int	nccf_inq_host_ntimedata (int hostid, int *ntimedata)
	Get the number of time data files from host file.
int	nccf_inq_host_ntimes (int hostid, int *ntimes)
	Get the number of time slice files.
int	nccf_inq_host_statfilename (int hostid, int vfindx, int gfindx, char *fname)
	Get the file name of static data file.
int	nccf_inq_host_timefilename (int hostid, int tfindx, int vfindx, int gfindx, char *fname)
	Get the file name of a time dependent data file.
int	nccf_inq_host_gridfilename (int hostid, int gfindx, char *filename)
	Return the grid file name.
int	nccf_inq_host_gridname (int hostid, int gfindx, char *gridname)
	Return the grid name.
int	nccf_inq_host_mosaicfilename (int hostid, char *mosaicfilename)
	Get a mosaic filename from a host file.

---

Detailed Description

All the files composing a mosaic a linked together in a ``host'' file where grids files, data, and mosaic files are listed.

---

Function Documentation

int nccf_add_host_file	(	int	hostid,
		const char *	filename,
		int	force
	)

Add a file to host.

Parameters:

hostid	the ID for the host object
filename	name of the file, can be a data file, a grid file, or a mosaic file
force	set to 1 if file should be added regardless of whether the uuid in the file matches, otherwise uuid must match

Returns:

NC_NOERR on success

Author:

Alexander Pletzer and David Kindig, Tech-X Corp.

Id:

nccf_add_host_file.c 496 2011-02-11 23:44:34Z dkindig

Definition at line 8 of file nccf_add_host_file.c.

int nccf_add_host_global_att	(	int	hostid,
		const char *	attname,
		const char *	value
	)

Add a global attribute the a host object.

Parameters:

hostid	the ID for the host object
attname	The attribute name to be added
value	The string to be added

Returns:

NC_NOERR on success

Author:

Alexander Pletzer and Dave Kindig, Tech-X Corp

Add a global attribute the a host object.

Id:

nccf_add_host_global_att.c 357 2011-01-10 22:38:32Z dkindig

Definition at line 9 of file nccf_add_host_global_att.c.

int nccf_def_host	(	const char *	coordinates_id,
		const char *	data_id,
		int	nTimeSlices,
		int *	hostid
	)

Define an empty host file (in memory).

Parameters:

coordinates_id	the unique identifier binding the coordinates together
data_id	the unique identifier binding the data together
nTimeSlices	Number of files for one grid and one time dependent variable.
hostid	(output) the created ID for the host object

Returns:

NC_NOERR on success

Note:

nTimeSlices is not the number of time steps within a file.

Author:

Alexander Pletzer and David Kindig, Tech-X Corp.

Definition at line 14 of file nccf_def_host.c.

int nccf_def_host_from_file	(	const char *	filename,
		int *	hostid
	)

Define (construct) a host file from a netcdf file.

Parameters:

filename	the host filename
hostid	(output) the ID for the host object

Returns:

NC_NOERR on success

Author:

Alexander Pletzer and David Kindig, Tech-X Corp.

Definition at line 25 of file nccf_def_host_from_file.c.

int nccf_free_host

(

int

hostid

)

Free all memory associated with a host (acts as a destructor).

Parameters:

hostid

The ID for the host object

Returns:

NC_NOERR on success

Author:

Alexander Pletzer and David Kindig, Tech-X Corp.

Free all memory associated with a host (acts as a destructor).

"$Id: nccf_free_host.c 496 2011-02-11 23:44:34Z dkindig $"

Definition at line 10 of file nccf_free_host.c.

int nccf_get_host_global_att	(	int	hostid,
		const char *	attname,
		char *	value
	)

Get a global attribute the a host object.

Parameters:

hostid	the ID for the host object
attname	The attribute name to be retrived
value	The string to be retrieved

Returns:

NC_NOERR on success

Author:

Alexander Pletzer and Dave Kindig, Tech-X Corp

Get a global attribute the a host object.

Id:

nccf_get_host_global_att.c 357 2011-01-10 22:38:32Z dkindig

Definition at line 10 of file nccf_get_host_global_att.c.

int nccf_inq_host_gridfilename	(	int	hostid,
		int	gfindx,
		char *	filename
	)

Return the grid file name.

Parameters:

hostid	the ID for the host object
gfindx	Grid file index varying from 0...ngrids-1
filename	Filename for given Id from dataset

Returns:

NC_NOERR on success

Author:

Alexander Pletzer and Dave Kindig, Tech-X Corp

Return the grid file name.

Id:

nccf_inq_host_gridfilename.c 514 2011-02-14 22:58:38Z dkindig

Definition at line 16 of file nccf_inq_host_gridfilename.c.

int nccf_inq_host_gridname	(	int	hostid,
		int	gfindx,
		char *	gridname
	)

Return the grid name.

Parameters:

hostid	the ID for the host object
gfindx	Id of grid, index varying from 0...ngrids-1
gridname	grid name for Id in dataset

Returns:

NC_NOERR on success

Author:

Alexander Pletzer and Dave Kindig, Tech-X Corp

int nccf_inq_host_mosaicfilename	(	int	hostid,
		char *	mosaicfilename
	)

Get a mosaic filename from a host file.

Parameters:

hostid	the ID for the host object
mosaicfilename	Mosaic filename

Returns:

NC_NOERR on success

Author:

Alexander Pletzer and Dave Kindig, Tech-X Corp

Get a mosaic filename from a host file.

Id:

nccf_inq_host_mosaicfilename.c 402 2011-01-19 00:36:31Z dkindig

Definition at line 10 of file nccf_inq_host_mosaicfilename.c.

int nccf_inq_host_ngrids	(	int	hostid,
		int *	ngrids
	)

Get the number of grid files from a host file.

Parameters:

hostid	the ID for the host object
ngrids	number of grids

Returns:

NC_NOERR on success

Author:

Dave Kindig and Alexander Pletzer, Tech-X Corp

Get the number of grid files from a host file.

Id:

nccf_inq_host_ngrids.c 513 2011-02-14 22:48:17Z dkindig

Definition at line 16 of file nccf_inq_host_ngrids.c.

int nccf_inq_host_nstaticdata	(	int	hostid,
		int *	nstaticdata
	)

Get the number of static data files from host file.

Parameters:

hostid	the ID for the host object
nstaticdata	number of static data files

Returns:

NC_NOERR on success

Author:

Alexander Pletzer and Dave Kindig, Tech-X Corp

Id:

nccf_inq_host_nstaticdata.c 516 2011-02-14 23:24:59Z dkindig

Definition at line 16 of file nccf_inq_host_nstaticdata.c.

int nccf_inq_host_ntimedata	(	int	hostid,
		int *	ntimedata
	)

Get the number of time data files from host file.

Parameters:

hostid	the ID for the host object
ntimedata	number of time data files

Returns:

NC_NOERR on success

Author:

Alexander Pletzer and Dave Kindig, Tech-X Corp

Id:

nccf_inq_host_ntimedata.c 516 2011-02-14 23:24:59Z dkindig

Definition at line 16 of file nccf_inq_host_ntimedata.c.

int nccf_inq_host_ntimes	(	int	hostid,
		int *	ntimes
	)

Get the number of time slice files.

Parameters:

hostid	the ID for the host object
ntimes	number of time slices

Returns:

NC_NOERR on success

Author:

Alexander Pletzer and Dave Kindig, Tech-X Corp

Get the number of time slice files.

Id:

nccf_inq_host_ntimes.c 515 2011-02-14 23:22:55Z dkindig

Definition at line 16 of file nccf_inq_host_ntimes.c.

int nccf_inq_host_statfilename	(	int	hostid,
		int	vfindx,
		int	gfindx,
		char *	fname
	)

Get the file name of static data file.

Parameters:

hostid	the ID for the host object
vfindx	variable file index, ranges from 0...nstaticdata-1
gfindx	grid file index, ranges from 0...ngrids
fname	file name (output)

Returns:

NC_NOERR on success

Definition at line 13 of file nccf_inq_host_statfilename.c.

int nccf_inq_host_timefilename	(	int	hostid,
		int	tfindx,
		int	vfindx,
		int	gfindx,
		char *	fname
	)

Get the file name of a time dependent data file.

Parameters:

hostid	the ID for the host object
tfindx	time file index, ranges from 0...ntimes-1
vfindx	variable file index, ranges from 0...nstaticdata-1
gfindx	grid file index, ranges from 0...ngrids-1
fname	file name (output)

Returns:

NC_NOERR on success

Definition at line 8 of file nccf_inq_host_timefilename.c.

int nccf_put_host	(	int	ncid,
		int	hostid
	)

Write the host to file.

Parameters:

ncid	the ID for a created netcdf file.
hostid	the ID for the host object

Returns:

NC_NOERR on success

Author:

Alexander Pletzer and David Kindig, Tech-X Corp.

Write the host to file.

"$Id: nccf_put_host.c 491 2011-02-10 02:01:24Z dkindig $"

Definition at line 11 of file nccf_put_host.c.