njtbx-icon
Netcdf-Java Toolbox
previous Method getVerticalAxis
Method getAttributes Next

 
 
Class mVar

PURPOSE ^

mVar class constructor - creates a netcdf variable (non-gridded/gridded) object

SYNOPSIS ^

function result = mVar(mDatasetObj, varName)

DESCRIPTION ^

mVariable class constructor -  creates a netcdf variable (non-gridded/gridded) object

   mvar=mVar(mDatasetObj, varName) reads the variable and create a variable object.
   where,
       varName - variable name, e.g. 'temp' (gridded or non-gridded)
       mDatasetObj - mDataset object
   returns,
       mvar: This will create 'mvar' object of class 'mVar'.
          In order to know the methods available for data access under
          class 'mVar', use matlab 'builtin' function
          'methods(className).
          i.e. methods(mvar)      

    Methods for class mVar:          

           a. getAttributes(mvar,attName) - get attribute(s) associated with the variable 
              
           b. getData(mvar, start, count, stride) - get data from variable           
              data=mvar(i,j, ...) - get data  using matlab subscripting reference.
              
           c. getJNetcdfDataset(mvar) - Retrieves a java JNetcdfDataset object.(For experience java users).
           
           d. getShape(mvar) - get variable shape     
           
           e. getTimes(mvar, timeIndex) - Get time(s) in DATENUM format.                  
 
           f. isGridded(mvar) - Is variable a grid variable ?

     See also mDataset/getVar

CROSS-REFERENCE INFORMATION ^

See functions using mVar:
  • nj_varget NJ_VARGET - get variable data from local NetCDF file, NetCDF URL or OpenDAP URL


previous Method getVerticalAxis
Method getAttributes Next
© 2006-2009   Mississippi State University   • License Terms   • Credits