Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Search for 

nco_c++/nco_fl.hh File Reference

#include <iostream>
#include <string>
#include <netcdf.h>
#include <nco_utl.hh>

Include dependency graph for nco_fl.hh:

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

Go to the source code of this file.

Functions

int nco_create (const std::string &fl_nm, const int &cmode, int &nc_id)
int nco_create (const std::string &fl_nm, const int &cmode)
int nco_open (const std::string &fl_nm, const int &cmode, int &nc_id)
int nco_open (const std::string &fl_nm, const int &cmode)
int nco_inq (const int &nc_id, int &dmn_nbr, int &var_nbr, int &att_nbr, int &rec_dmn_id, const int &rcd_opt=NC_NOERR)
int nco_inq_ndims (const int &nc_id, int &dmn_nbr, const int &rcd_opt=NC_NOERR)
int nco_inq_ndims (const int &nc_id)
int nco_inq_nvars (const int &nc_id, int &var_nbr, const int &rcd_opt=NC_NOERR)
int nco_inq_nvars (const int &nc_id)
int nco_inq_natts (const int &nc_id, int &att_nbr, const int &rcd_opt=NC_NOERR)
int nco_inq_unlimdim (const int &nc_id, int &dmn_id, const int &rcd_opt=NC_NOERR)
int nco_redef (const int &nc_id, const int &rcd_opt=NC_NOERR)
int nco_enddef (const int &nc_id, const int &rcd_opt=NC_NOERR)
int nco_set_fill (const int &nc_id, const int &fillmode, int &oldmode)
int nco_close (const int &nc_id)

Function Documentation

int nco_close (  const int &  nc_id  ) 
 

Definition at line 222 of file nco_fl.cc.

References nc_close, NC_NOERR, and nco_err_exit().

00223 {
00224   /* Purpose: Wrapper for nc_close() 
00225      Usage: rcd=nco_close(nc_id); */
00226   int rcd=nc_close(nc_id);
00227   if(rcd != NC_NOERR) nco_err_exit(rcd,"nco_close");
00228   return rcd;
00229 } // end nco_close()

int nco_create (  const std::string &  fl_nm,
const int &  cmode
) 
 

Definition at line 46 of file nco_fl.cc.

References nco_create().

00048 {
00049   /* Purpose: Wrapper for nc_create() 
00050      Usage: nc_id=nco_create(fl_nm,NC_NOWRITE); */
00051   int nc_id; // O [id] netCDF file ID
00052   int rcd=nco_create(fl_nm,cmode,nc_id);
00053   rcd+=0; // CEWI
00054   return nc_id;
00055 } // end nco_create()

int nco_create (  const std::string &  fl_nm,
const int &  cmode,
int &  nc_id
) 
 

Definition at line 34 of file nco_fl.cc.

References nc_create, NC_NOERR, and nco_err_exit().

00037 {
00038   /* Purpose: Wrapper for nc_create() */
00039   int rcd=nc_create(fl_nm.c_str(),cmode,&nc_id);
00040   if(rcd != NC_NOERR) nco_err_exit(rcd,"nco_create","Failed to create "+fl_nm);
00041   return rcd;
00042 } // end nco_create()

int nco_enddef (  const int &  nc_id,
const int &  rcd_opt = NC_NOERR
) 
 

Definition at line 198 of file nco_fl.cc.

References nc_enddef, NC_NOERR, and nco_err_exit().

00200 {
00201   // Purpose: Wrapper for nc_enddef()
00202   int rcd=nc_enddef(nc_id);
00203   if(rcd != NC_NOERR && rcd != rcd_opt) nco_err_exit(rcd,"nco_enddef");
00204   return rcd;
00205 } // end nco_enddef()

int nco_inq (  const int &  nc_id,
int &  dmn_nbr,
int &  var_nbr,
int &  att_nbr,
int &  rec_dmn_id,
const int &  rcd_opt = NC_NOERR
) 
 

Definition at line 90 of file nco_fl.cc.

References nc_inq, NC_NOERR, and nco_err_exit().

00096 {
00097   /* Purpose: Wrapper for nc_inq()
00098      User may omit rcd_opt, or supply value of non-fatal netCDF return code */
00099   int rcd=nc_inq(nc_id,&dmn_nbr,&var_nbr,&att_nbr,&rec_dmn_id);
00100   if(rcd != NC_NOERR && rcd != rcd_opt) nco_err_exit(rcd,"nco_inq");
00101   return rcd;
00102 } // end nco_inq()

int nco_inq_natts (  const int &  nc_id,
int &  att_nbr,
const int &  rcd_opt = NC_NOERR
) 
 

Definition at line 161 of file nco_fl.cc.

References nc_inq_natts, NC_NOERR, and nco_err_exit().

00164 {
00165   /* Purpose: Wrapper for nc_inq_natts()
00166      User may omit rcd_opt, or supply value of non-fatal netCDF return code */
00167   int rcd=nc_inq_natts(nc_id,&att_nbr);
00168   if(rcd != NC_NOERR && rcd != rcd_opt) nco_err_exit(rcd,"nco_inq_natts");
00169   return rcd;
00170 } // end nco_inq_natts()

int nco_inq_ndims (  const int &  nc_id  ) 
 

Definition at line 121 of file nco_fl.cc.

References nc_inq_ndims.

00122 {
00123   // Purpose: Wrapper for nco_inq_ndims()
00124   int dmn_nbr; // O [nbr] Number of dimensions
00125   int rcd=nc_inq_ndims(nc_id,&dmn_nbr);
00126   rcd+=0; // CEWI
00127   return dmn_nbr;
00128 } // end nco_inq_ndims()

int nco_inq_ndims (  const int &  nc_id,
int &  dmn_nbr,
const int &  rcd_opt = NC_NOERR
) 
 

Definition at line 108 of file nco_fl.cc.

References nc_inq_ndims, NC_NOERR, and nco_err_exit().

00111 {
00112   /* Purpose: Wrapper for nc_inq_ndims()
00113      User may omit rcd_opt, or supply value of non-fatal netCDF return code */
00114   int rcd=nc_inq_ndims(nc_id,&dmn_nbr);
00115   if(rcd != NC_NOERR && rcd != rcd_opt) nco_err_exit(rcd,"nco_inq_ndims");
00116   return rcd;
00117 } // end nco_inq_ndims()

int nco_inq_nvars (  const int &  nc_id  ) 
 

Definition at line 148 of file nco_fl.cc.

References nc_inq_nvars.

00149 {
00150   // Purpose: Wrapper for nco_inq_nvars()
00151   int var_nbr; // O [nbr] Number of variables
00152   int rcd=nc_inq_nvars(nc_id,&var_nbr);
00153   rcd+=0; // CEWI
00154   return var_nbr;
00155 } // end nco_inq_nvars()

int nco_inq_nvars (  const int &  nc_id,
int &  var_nbr,
const int &  rcd_opt = NC_NOERR
) 
 

Definition at line 135 of file nco_fl.cc.

References nc_inq_nvars, NC_NOERR, and nco_err_exit().

00138 {
00139   /* Purpose: Wrapper for nc_inq_nvars()
00140      User may omit rcd_opt, or supply value of non-fatal netCDF return code */
00141   int rcd=nc_inq_nvars(nc_id,&var_nbr);
00142   if(rcd != NC_NOERR && rcd != rcd_opt) nco_err_exit(rcd,"nco_inq_nvars");
00143   return rcd;
00144 } // end nco_inq_nvars()

int nco_inq_unlimdim (  const int &  nc_id,
int &  dmn_id,
const int &  rcd_opt = NC_NOERR
) 
 

Definition at line 174 of file nco_fl.cc.

References nc_inq_unlimdim, NC_NOERR, and nco_err_exit().

00177 {
00178   /* Purpose: Wrapper for nc_inq_unlimdim()
00179      User may omit rcd_opt, or supply value of non-fatal netCDF return code */
00180   int rcd=nc_inq_unlimdim(nc_id,&dmn_id);
00181   if(rcd != NC_NOERR && rcd != rcd_opt) nco_err_exit(rcd,"nco_inq_unlimdim");
00182   return rcd;
00183 } // end nco_inq_unlimdim()

int nco_open (  const std::string &  fl_nm,
const int &  cmode
) 
 

Definition at line 75 of file nco_fl.cc.

References nco_open().

00077 {
00078   /* Purpose: Wrapper for nc_open() 
00079      Usage: nc_id=nco_open(fl_nm,NC_NOWRITE); */
00080   int nc_id; // O [id] netCDF file ID
00081   int rcd=nco_open(fl_nm,cmode,nc_id);
00082   rcd+=0; // CEWI
00083   return nc_id;
00084 } // end nco_open()

int nco_open (  const std::string &  fl_nm,
const int &  cmode,
int &  nc_id
) 
 

Definition at line 62 of file nco_fl.cc.

References NC_NOERR, nc_open, and nco_err_exit().

00065 {
00066   /* Purpose: Wrapper for nc_open() 
00067      Usage: rcd=nco_open(fl_nm,NC_NOWRITE,nc_id); */
00068   int rcd=nc_open(fl_nm.c_str(),cmode,&nc_id);
00069   if(rcd != NC_NOERR) nco_err_exit(rcd,"nco_open","Failed to open "+fl_nm);
00070   return rcd;
00071 } // end nco_open()

int nco_redef (  const int &  nc_id,
const int &  rcd_opt = NC_NOERR
) 
 

Definition at line 187 of file nco_fl.cc.

References NC_NOERR, nc_redef, and nco_err_exit().

00189 {
00190   // Purpose: Wrapper for nc_redef()
00191   int rcd=nc_redef(nc_id);
00192   if(rcd != NC_NOERR && rcd != rcd_opt) nco_err_exit(rcd,"nco_redef");
00193   return rcd;
00194 } // end nco_redef()

int nco_set_fill (  const int &  nc_id,
const int &  fillmode,
int &  oldmode
) 
 

Definition at line 209 of file nco_fl.cc.

References NC_NOERR, nc_set_fill, and nco_err_exit().

00212 {
00213   /* Purpose: Wrapper for nc_set_fill()
00214      Usage: rcd=nco_set_fill(nc_id,NC_NOFILL,oldfill); */
00215   int rcd=nc_set_fill(nc_id,fillmode,&oldmode);
00216   if(rcd != NC_NOERR) nco_err_exit(rcd,"nco_set_fill");
00217   return rcd;
00218 } // end nco_set_fill()

Generated on Thu Mar 16 18:17:19 2006 for nco by  doxygen 1.4.4