nco/nco.h File Reference

#include <stdio.h>
#include <netcdf.h>
#include "nco_typ.h"

Include dependency graph for nco.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  lmt_sct
struct  lmt_all_sct
struct  nm_id_sct
struct  rnm_sct
union  ptr_unn
union  val_unn
struct  scv_sct
struct  aed_sct
struct  att_sct
struct  dmn_sct_tag
struct  var_sct_tag

Defines

#define CST_X_PTR_CST_PTR_CST_Y(x, y)   x * const * const y
#define X_CST_PTR_CST_PTR_Y(x, y)   x * const * y
#define nco_bool   int
#define bool   int
#define True   1
#define False   0
#define NULL_CEWI   NULL
#define char_CEWI   '\0'
#define double_CEWI   0.0
#define float_CEWI   0.0
#define int_CEWI   0
#define long_CEWI   0L
#define nco_byte_CEWI   0
#define nco_char_CEWI   '\0'
#define nco_int_CEWI   0L
#define short_CEWI   0
#define size_t_CEWI   0UL
#define NCO_REC_DMN_UNDEFINED   -1
#define NC_NETCDF4   (0x1000)
#define NC_CLASSIC_MODEL   (0x0008)
#define NC_FORMAT_CLASSIC   (1)
#define NC_FORMAT_64BIT   (2)
#define NC_FORMAT_NETCDF4   (3)
#define NC_FORMAT_NETCDF4_CLASSIC   (4)
#define EXIT_SUCCESS   0
#define EXIT_FAILURE   1

Typedefs

typedef dmn_sct_tag dmn_sct
typedef var_sct_tag var_sct

Enumerations

enum  prg {
  ncap, ncatted, ncbo, ncea,
  ncecat, ncflint, ncks, ncpdq,
  ncra, ncrcat, ncrename, ncwa
}
enum  aed {
  aed_append, aed_create, aed_delete, aed_modify,
  aed_overwrite
}
enum  nco_rlt_opr {
  nco_op_eq, nco_op_ne, nco_op_lt, nco_op_gt,
  nco_op_le, nco_op_ge
}
enum  nco_op_typ {
  nco_op_add, nco_op_dvd, nco_op_mlt, nco_op_sbt,
  nco_op_avg, nco_op_min, nco_op_max, nco_op_ttl,
  nco_op_sqravg, nco_op_avgsqr, nco_op_sqrt, nco_op_rms,
  nco_op_rmssdn, nco_op_nil
}
enum  nod_typ_enm { typ_scv, typ_sym, typ_opr }
enum  nco_mmr_typ_enm { nco_mmr_calloc, nco_mmr_free, nco_mmr_malloc, nco_mmr_realloc }

Functions

char * prg_nm_get (void)
int prg_get (void)
unsigned short dbg_lvl_get (void)


Define Documentation

#define bool   int
 

Definition at line 57 of file nco.h.

#define char_CEWI   '\0'
 

Definition at line 73 of file nco.h.

Referenced by nco_prn_var_val_lmt().

#define CST_X_PTR_CST_PTR_CST_Y x,
 )     x * const * const y
 

Definition at line 31 of file nco.h.

#define double_CEWI   0.0
 

Definition at line 74 of file nco.h.

Referenced by main(), nco_var_avg_reduce_max(), nco_var_avg_reduce_min(), nco_var_avg_reduce_ttl(), nco_var_msk(), and nco_var_pck().

#define EXIT_FAILURE   1
 

Definition at line 141 of file nco.h.

Referenced by error(), indexx(), indexx_alpha(), main(), ncap_mk_cst(), ncap_var_cnf_dmn(), ncap_var_stretch(), ncap_var_var_op(), nco_aed_prc(), nco_att_cpy(), nco_bnr_close(), nco_bnr_open(), nco_bnr_wrt(), nco_calloc(), nco_cpy_var_val(), nco_cpy_var_val_lmt(), nco_cpy_var_val_mlt_lmt(), nco_create_mode_mrg(), nco_create_mode_prs(), nco_dfl_case_nctype_err(), nco_err_exit(), nco_fl_cp(), nco_fl_lst_mk(), nco_fl_mk_lcl(), nco_fl_mv(), nco_fl_out_cls(), nco_fl_out_open(), nco_is_packable(), nco_lmt_evl(), nco_lmt_prs(), nco_lmt_sct_mk(), nco_lmt_udu_cnv(), nco_malloc(), nco_malloc_dbg(), nco_malloc_flg(), nco_mmr_stt(), nco_nd2endm(), nco_op_prs_rlt(), nco_op_typ_get(), nco_openmp_ini(), nco_pck_map_get(), nco_pck_plc_get(), nco_prn_var_val_lmt(), nco_prs_aed_lst(), nco_prs_att(), nco_prs_rnm_lst(), nco_realloc(), nco_var_cnf_dmn(), nco_var_dmn_rdr_mtd(), nco_var_fll(), nco_var_lst_dvd(), nco_var_lst_mk(), nco_var_lst_mk_old(), nco_var_lst_mrg(), nco_var_msk(), nco_var_pck(), nco_var_upk_swp(), nco_zero_long(), prg_prs(), ptr_unn_2_scl_dbl(), sng_lst_cat(), and usage().

#define EXIT_SUCCESS   0
 

Definition at line 138 of file nco.h.

Referenced by main(), nco_exit(), nco_exit_gracefully(), and nco_fl_out_open().

#define False   0
 

Definition at line 64 of file nco.h.

Referenced by arm_inq(), cvs_vrs_prs(), main(), ncap_do_cst(), ncap_var_init(), ncap_var_stretch(), ncap_var_write(), nco_aed_prc(), nco_cnv_ccm_ccsm_cf_inq(), nco_cpy_var_val_lmt(), nco_dmn_fll(), nco_dmn_lst_ass_var(), nco_fl_lst_mk(), nco_fl_mk_lcl(), nco_fl_nm_prs(), nco_fl_out_open(), nco_is_mlt_fl_opr(), nco_is_packable(), nco_is_rth_opr(), nco_lmt_evl(), nco_lmt_prs(), nco_lmt_sct_mk(), nco_lst_comma2hash(), nco_msa_clc_idx(), nco_msa_min_idx(), nco_msa_prn_idx(), nco_msa_prn_var_val(), nco_mss_val_cnf(), nco_mss_val_cp(), nco_mss_val_get(), nco_op_prs_rlt(), nco_op_typ_get(), nco_openmp_ini(), nco_pck_dsk_inq(), nco_pck_plc_typ_get(), nco_pck_val(), nco_prn_var_val_lmt(), nco_prs_aed_lst(), nco_put_var_pck(), nco_var_avg(), nco_var_avg_reduce_max(), nco_var_avg_reduce_min(), nco_var_cnf_dmn(), nco_var_dfn(), nco_var_dmn_rdr_mtd(), nco_var_dmn_rdr_val(), nco_var_fll(), nco_var_get(), nco_var_lst_add(), nco_var_lst_dvd(), nco_var_lst_mk_old(), nco_var_lst_sub(), nco_var_pck(), nco_var_upk(), sng_ascii_trn(), and var_dfl_set().

#define float_CEWI   0.0
 

Definition at line 75 of file nco.h.

Referenced by nco_var_avg_reduce_max(), nco_var_avg_reduce_min(), nco_var_avg_reduce_ttl(), and nco_var_msk().

#define int_CEWI   0
 

Definition at line 76 of file nco.h.

Referenced by main(), nco_lmt_evl(), nco_openmp_ini(), and nco_prn_var_val_lmt().

#define long_CEWI   0L
 

Definition at line 77 of file nco.h.

Referenced by nco_aed_prc(), nco_msa_clc_idx(), nco_mss_val_cnf(), nco_prn_var_val_lmt(), and nco_var_cnf_typ().

#define NC_CLASSIC_MODEL   (0x0008)
 

Definition at line 121 of file nco.h.

Referenced by create_file(), find_nc4_file(), find_nc4_grp(), gen_c(), gen_fortran(), main(), nc4_get_att(), nc4_put_att(), nc_create_file(), nc_def_dim(), nc_def_grp(), nc_def_var_full(), nc_del_att(), nc_inq_format(), nc_rename_att(), nc_rename_var(), nc_sync(), NcFile::NcFile(), nco_create_mode_mrg(), pg_vara(), pg_varm(), read_grp_atts(), rec_write_metadata(), sync_netcdf4_file(), and test_redef().

#define NC_FORMAT_64BIT   (2)
 

Definition at line 127 of file nco.h.

Referenced by create_file(), NcFile::get_format(), main(), nc__create_mp(), nc_copy_var(), nc_create_file(), nc_get_file_version(), nc_inq_format(), nc_set_default_format(), nco_create_mode_mrg(), nco_create_mode_prs(), pr_fmtvariant(), pr_fmtvariantx(), test_nc_set_default_format(), and test_redef().

#define NC_FORMAT_CLASSIC   (1)
 

Definition at line 124 of file nco.h.

Referenced by NcFile::get_format(), main(), nc_copy_var(), nc_get_file_version(), nc_inq_format(), nc_set_default_format(), nco_create_mode_prs(), pr_fmtvariant(), and pr_fmtvariantx().

#define NC_FORMAT_NETCDF4   (3)
 

Definition at line 130 of file nco.h.

Referenced by check_file(), create_file(), do_ncdump_rec(), NcFile::get_format(), main(), nc_copy_var(), nc_create_file(), nc_inq_format(), nc_set_default_format(), nco_create_mode_mrg(), nco_create_mode_prs(), pr_fmtvariant(), pr_fmtvariantx(), and test_redef().

#define NC_FORMAT_NETCDF4_CLASSIC   (4)
 

Definition at line 133 of file nco.h.

Referenced by check_file(), create_file(), NcFile::get_format(), main(), nc_create_file(), nc_inq_format(), nc_set_default_format(), nco_create_mode_mrg(), nco_create_mode_prs(), pr_fmtvariant(), pr_fmtvariantx(), and test_redef().

#define NC_NETCDF4   (0x1000)
 

Definition at line 118 of file nco.h.

Referenced by create_file(), gen_c(), gen_fortran(), main(), nc_create_file(), nc_create_par(), nc_open_par(), NcFile::NcFile(), nco_create_mode_mrg(), and test_redef().

#define nco_bool   int
 

Definition at line 54 of file nco.h.

Referenced by arm_inq(), main(), ncap_var_cnf_dmn(), ncap_var_stretch(), ncap_var_var_op(), nco_cnv_ccm_ccsm_cf_inq(), nco_var_cnf_dmn(), nco_var_dmn_rdr_val(), nco_var_lst_add(), and nco_var_lst_sub().

#define nco_byte_CEWI   0
 

Definition at line 78 of file nco.h.

Referenced by nco_var_msk().

#define nco_char_CEWI   '\0'
 

Definition at line 79 of file nco.h.

Referenced by nco_var_msk().

#define nco_int_CEWI   0L
 

Definition at line 80 of file nco.h.

Referenced by main(), nco_var_avg_reduce_max(), nco_var_avg_reduce_min(), nco_var_avg_reduce_ttl(), and nco_var_msk().

#define NCO_REC_DMN_UNDEFINED   -1
 

Definition at line 88 of file nco.h.

Referenced by main(), nco_var_dmn_rdr_mtd(), and rec_var_dbg().

#define NULL_CEWI   NULL
 

Definition at line 72 of file nco.h.

Referenced by main(), ncap_var_init(), nco_aed_prc(), nco_fl_lst_mk(), nco_lmt_prs(), nco_msa_prn_var_val(), nco_nm_id_lst_crd_make(), nco_prn_att(), nco_prn_var_dfn(), nco_prn_var_val_lmt(), nco_prs_aed_lst(), nco_usg_prn(), and nco_var_lst_dvd().

#define short_CEWI   0
 

Definition at line 81 of file nco.h.

Referenced by nco_prn_var_val_lmt(), nco_var_avg_reduce_max(), nco_var_avg_reduce_min(), nco_var_avg_reduce_ttl(), and nco_var_msk().

#define size_t_CEWI   0UL
 

Definition at line 82 of file nco.h.

Referenced by main().

#define True   1
 

Definition at line 61 of file nco.h.

Referenced by arm_inq(), cvs_vrs_prs(), main(), ncap_var_cnf_dmn(), ncap_var_init(), ncap_var_stretch(), ncap_var_var_add(), ncap_var_var_dvd(), ncap_var_var_mlt(), ncap_var_var_mod(), ncap_var_var_pwr(), ncap_var_var_sub(), ncap_var_write(), nco_cnv_ccm_ccsm_cf_inq(), nco_cpy_var_val_lmt(), nco_dmn_fll(), nco_dmn_lst_ass_var(), nco_fl_lst_mk(), nco_fl_mk_lcl(), nco_is_mlt_fl_opr(), nco_is_packable(), nco_is_rth_opr(), nco_lmt_evl(), nco_lmt_prs(), nco_lmt_sct_mk(), nco_lst_comma2hash(), nco_mmr_stt(), nco_msa_clc_idx(), nco_msa_min_idx(), nco_msa_prn_var_val(), nco_msa_rec_clc(), nco_msa_wrp_splt(), nco_mss_val_cp(), nco_mss_val_get(), nco_openmp_ini(), nco_pck_dsk_inq(), nco_pck_plc_typ_get(), nco_prn_var_val_lmt(), nco_var_avg(), nco_var_avg_reduce_max(), nco_var_avg_reduce_min(), nco_var_avg_reduce_ttl(), nco_var_cnf_dmn(), nco_var_dfn(), nco_var_dmn_rdr_val(), nco_var_fll(), nco_var_lst_add(), nco_var_lst_dvd(), nco_var_lst_mk(), nco_var_lst_mk_old(), nco_var_lst_sub(), nco_var_pck(), sng_ascii_trn(), and var_dfl_set().

#define X_CST_PTR_CST_PTR_Y x,
 )     x * const * y
 

Definition at line 32 of file nco.h.


Typedef Documentation

typedef struct dmn_sct_tag dmn_sct
 

typedef struct var_sct_tag var_sct
 


Enumeration Type Documentation

enum aed
 

Enumerator:
aed_append 
aed_create 
aed_delete 
aed_modify 
aed_overwrite 

Definition at line 159 of file nco.h.

00159           { /* [enm] Attribute editor mode */
00160     aed_append,
00161     aed_create,
00162     aed_delete,
00163     aed_modify,
00164     aed_overwrite
00165   }; /* end enum */

enum nco_mmr_typ_enm
 

Enumerator:
nco_mmr_calloc 
nco_mmr_free 
nco_mmr_malloc 
nco_mmr_realloc 

Definition at line 203 of file nco.h.

00203                { /* [enm] Memory allocation type */
00204     nco_mmr_calloc, /* [enm] nco_calloc() */
00205     nco_mmr_free, /* [enm] nco_free() */
00206     nco_mmr_malloc, /* [enm] nco_malloc() */
00207     nco_mmr_realloc /* [enm] nco_realloc() */
00208   } nco_mmr_typ_enm; /* end nco_mmr_typ enum */

enum nco_op_typ
 

Enumerator:
nco_op_add 
nco_op_dvd 
nco_op_mlt 
nco_op_sbt 
nco_op_avg 
nco_op_min 
nco_op_max 
nco_op_ttl 
nco_op_sqravg 
nco_op_avgsqr 
nco_op_sqrt 
nco_op_rms 
nco_op_rmssdn 
nco_op_nil 

Definition at line 176 of file nco.h.

00176                  { /* [enm] Operation type */
00177     /* Types used in ncbo(): */
00178     nco_op_add, /* [enm] Add file_1 to file_2 */
00179     nco_op_dvd, /* [enm] Divide file_1 by file_2 */
00180     nco_op_mlt, /* [enm] Multiply file_1 by file_2 */
00181     nco_op_sbt, /* [enm] Subtract file_2 from file_1 */
00182     /* Types used in ncra(), ncrcat(), ncwa(): */
00183     nco_op_avg, /* [enm] Average */
00184     nco_op_min, /* [enm] Minimum value */
00185     nco_op_max, /* [enm] Maximum value */
00186     nco_op_ttl, /* [enm] Linear sum */
00187     nco_op_sqravg, /* [enm] Square of mean */
00188     nco_op_avgsqr, /* [enm] Mean of sum of squares */
00189     nco_op_sqrt, /* [enm] Square root of mean */
00190     nco_op_rms, /* [enm] Root-mean-square (normalized by N) */
00191     nco_op_rmssdn, /* [enm] Root-mean square normalized by N-1 */
00192     nco_op_nil /* [enm] Nil or undefined operation type  */
00193   }; /* end nco_op_typ enum */

enum nco_rlt_opr
 

Enumerator:
nco_op_eq 
nco_op_ne 
nco_op_lt 
nco_op_gt 
nco_op_le 
nco_op_ge 

Definition at line 167 of file nco.h.

00167                   { /* [enm] Arithmetic relations (comparisons) for masking */
00168     nco_op_eq, /* Equality */
00169     nco_op_ne, /* Inequality */
00170     nco_op_lt, /* Less than */
00171     nco_op_gt, /* Greater than */
00172     nco_op_le, /* Less than or equal to */
00173     nco_op_ge /* Greater than or equal to */
00174   }; /* end enum */

enum nod_typ_enm
 

Enumerator:
typ_scv 
typ_sym 
typ_opr 

Definition at line 196 of file nco.h.

00196                { /* [enm] Node enumerator Nie02 nodeEnum */
00197     typ_scv, /* [enm] Scalar value */
00198     typ_sym, /* [enm] Symbol identifier */
00199     typ_opr /* [enm] Operator */
00200   } nod_typ_enm;

enum prg
 

Enumerator:
ncap 
ncatted 
ncbo 
ncea 
ncecat 
ncflint 
ncks 
ncpdq 
ncra 
ncrcat 
ncrename 
ncwa 

Definition at line 144 of file nco.h.

00144           { /* [enm] Key value for all netCDF operators */
00145     ncap,
00146     ncatted,
00147     ncbo,
00148     ncea,
00149     ncecat,
00150     ncflint,
00151     ncks,
00152     ncpdq,
00153     ncra,
00154     ncrcat,
00155     ncrename,
00156     ncwa
00157   }; /* end prg enum */


Function Documentation

unsigned short dbg_lvl_get void   ) 
 

Referenced by arm_inq(), cvs_vrs_prs(), lst_prs_1D(), lst_prs_2D(), main(), ncap_do_cst(), ncap_mk_cst(), ncap_var_init(), ncap_var_stretch(), ncap_var_write(), nco_bnr_close(), nco_bnr_open(), nco_bnr_wrt(), nco_cmp_get(), nco_cnv_ccm_ccsm_cf_inq(), nco_cnv_mss_val_typ(), nco_cpy_var_val_lmt(), nco_exit(), nco_fl_cp(), nco_fl_lst_mk(), nco_fl_mk_lcl(), nco_fl_mv(), nco_fl_out_open(), nco_fl_rm(), nco_lmt_evl(), nco_mpi_get(), nco_openmp_ini(), nco_pck_dsk_inq(), nco_pck_mtd(), nco_pck_val(), nco_prn_var_val_lmt(), nco_prs_aed_lst(), nco_prs_rnm_lst(), nco_var_avg(), nco_var_cnf_dmn(), nco_var_cnf_typ(), nco_var_dfn(), nco_var_dmn_rdr_mtd(), nco_var_dmn_rdr_val(), nco_var_pck(), nco_var_upk(), nco_var_upk_swp(), and sng_ascii_trn().

int prg_get void   ) 
 

Referenced by nco_fl_lst_mk(), nco_fl_mk_lcl(), nco_fl_out_open(), nco_lmt_evl(), nco_op_typ_get(), nco_openmp_ini(), nco_pck_dsk_inq(), nco_usg_prn(), nco_var_dfn(), nco_var_get(), nco_var_lst_dvd(), and nco_var_mtd_refresh().

char* prg_nm_get void   ) 
 

Referenced by arm_inq(), arm_time_mk(), copyright_prn(), cvs_vrs_prs(), err_prn(), indexx(), indexx_alpha(), main(), ncap_do_cst(), ncap_mk_cst(), ncap_var_cnf_dmn(), ncap_var_init(), ncap_var_stretch(), ncap_var_var_op(), ncap_var_write(), nco_aed_prc(), nco_arm_time_install(), nco_att_cpy(), nco_bnr_close(), nco_bnr_open(), nco_bnr_wrt(), nco_calloc(), nco_cmp_get(), nco_cnv_ccm_ccsm_cf_date(), nco_cnv_ccm_ccsm_cf_inq(), nco_cnv_mss_val_typ(), nco_cpy_var_dfn(), nco_cpy_var_dfn_lmt(), nco_cpy_var_val(), nco_cpy_var_val_lmt(), nco_cpy_var_val_mlt_lmt(), nco_create_mode_mrg(), nco_create_mode_prs(), nco_dmn_dfn(), nco_exit(), nco_exit_gracefully(), nco_fl_cp(), nco_fl_info_get(), nco_fl_lst_mk(), nco_fl_mk_lcl(), nco_fl_mv(), nco_fl_out_cls(), nco_fl_out_open(), nco_fl_rm(), nco_hst_att_cat(), nco_is_packable(), nco_lbr_vrs_prn(), nco_lmt_evl(), nco_lmt_prs(), nco_lmt_sct_mk(), nco_malloc(), nco_malloc_dbg(), nco_malloc_err_hnt_prn(), nco_malloc_flg(), nco_mmr_rusage_prn(), nco_mmr_stt(), nco_mpi_get(), nco_mss_val_cnf(), nco_mss_val_get(), nco_nd2endm(), nco_op_prs_rlt(), nco_op_typ_get(), nco_openmp_ini(), nco_pck_dsk_inq(), nco_pck_map_get(), nco_pck_mtd(), nco_pck_plc_get(), nco_pck_plc_typ_get(), nco_pck_val(), nco_prn_var_val_lmt(), nco_prs_aed_lst(), nco_prs_att(), nco_realloc(), nco_usg_prn(), nco_var_avg(), nco_var_cnf_dmn(), nco_var_cnf_typ(), nco_var_dfn(), nco_var_dmn_rdr_mtd(), nco_var_dmn_rdr_val(), nco_var_fll(), nco_var_get(), nco_var_lst_dvd(), nco_var_lst_mk(), nco_var_lst_mk_old(), nco_var_lst_mrg(), nco_var_msk(), nco_var_mtd_refresh(), nco_var_pck(), nco_var_prc_crr_prn(), nco_var_pwr(), nco_var_upk(), nco_var_upk_swp(), nco_zero_long(), ptr_unn_2_scl_dbl(), rec_crd_chk(), rec_var_dbg(), sng_ascii_trn(), and sng_lst_cat().


Generated on Thu Mar 16 18:15:08 2006 for nco by  doxygen 1.4.4