These functions help with the definition and reading of time coordinate variables and dimensions.
More...
Functions |
| int | nccf_def_time (int ncid, const char *name, size_t len, nc_type xtype, const char *units, const char *standard_name, int *time_dimidp, int *time_varidp) |
| | Define a coordinate variable and dimension with all the CF recommended attribute accessories for time.
|
| int | nccf_inq_time (int ncid, char *name, size_t *lenp, nc_type *xtypep, int *time_dimidp, int *time_varidp) |
| | Inquire about a time dimension and coordinate variable.
|
Detailed Description
These functions help with the definition and reading of time coordinate variables and dimensions.
Function Documentation
| int nccf_def_time |
( |
int |
ncid, |
|
|
const char * |
name, |
|
|
size_t |
len, |
|
|
nc_type |
xtype, |
|
|
const char * |
units, |
|
|
const char * |
standard_name, |
|
|
int * |
time_dimidp, |
|
|
int * |
time_varidp |
|
) |
| |
Define a coordinate variable and dimension with all the CF recommended attribute accessories for time.
- Parameters:
-
| ncid | The ncid of the file. |
| name | the name of the dimension and variable. |
| len | The length of this coordinate dimension. |
| xtype | The type of this coordinate variable. |
| standard_name | If non-NULL, a string which will be written as the ``standard_name'' attribute on the coordinate variable. |
| units | If non-NULL, a string which will be written as the ``units'' attribute on the coordinate variable. |
| time_dimidp | If non-NULL, nccf_def_time will write the dimension ID of the netCDF dimension for the time here. |
| time_varidp | If non-NULL, nccf_def_time will write the variable ID of the netCDF coordinate variable for the time here. |
- Returns:
- 0 for success, error code otherwise.
Definition at line 2408 of file cfcvars.c.
| int nccf_inq_time |
( |
int |
ncid, |
|
|
char * |
name, |
|
|
size_t * |
lenp, |
|
|
nc_type * |
xtypep, |
|
|
int * |
time_dimidp, |
|
|
int * |
time_varidp |
|
) |
| |
Inquire about a time dimension and coordinate variable.
- Parameters:
-
| ncid | The ncid of the file. |
| name | If non-NULL the name of the time dimension and variable will be copied here. |
| lenp | If non-NULL, the length of the time dimension will be copied here by nccf_inq_time. |
| xtypep | If non-NULL, the type of the coordinate variable will be copied here. |
| time_dimidp | If non-NULL, the dimid of the time dimension will be copied here. |
| time_varidp | If non-NULL, the varid of the time coordinate variable will be copied here. |
- Returns:
- 0 for success, error code otherwise.
Definition at line 2442 of file cfcvars.c.
