# coyote: NCDF_VARIABLE__DEFINE

- coyote/FileIO
- [Source code]

NAME

      NCDF_VARIABLE

PURPOSE

      The pupose of this NCDF_Variable object is to store information about
      a netCDF variable. The object is principally used as a utility routine
      for the NCDF_FILE object. Given the variable name, the object will acquire
      additional information about the variable from the netCDF file containing
      the variable.

AUTHOR

      FANNING SOFTWARE CONSULTING
      David Fanning, Ph.D.
      1645 Sheely Drive
      Fort Collins, CO 80526 USA
      Phone: 970-221-0438
      E-mail: david@idlcoyote.com
      Coyote's Guide to IDL Programming: http://www.idlcoyote.com

CATEGORY

      File I/O

CALLING SEQUENCE

      IDL> varObj = Obj_New('NCDF_VARIABLE', varName, parent)

ARGUMENTS

      varName:   The case sensitive name of a netCDF variable that is stored in the
                 netCDF file. (Input and required.)
      parent:    The object reference (NCDF_FILE object) of the netCDF file. In other words, the
                 object reference of the file that contains this attribute. (Input and required.)

KEYWORD PARAMETERS

      None.

METHODS

      The following methods are available. Each is documented in front of the method.
      varObject -> AddAttr
      varAttrNames = varObject -> GetAttrNames()
      dimIDs = varObject -> GetDimIDs()
      dimNames = varObject -> GetDimNames()
      varAttrValue = varObject -> GetAttrValue()
      varID = varObject -> GetID()
      varName = varObject -> GetName()
      propertyValue = varObject -> GetProperty(attrProperty)
      varValue = varObject -> GetValue()
      varObject -> ParseVariable

MODIFICATION HISTORY

      Written by:  David W. Fanning, 3 Feb 2010.
      Changes to the way dimensions of length 0 are handled. 11 Feb 2010. DWF.
      Added GetInfo method. 20 Mar 2010. DWF.
      Added MISSINGINDICES and FILLVALUE keywords to GetValue method to return the indices
          and the value of missing data. 20 Mar 2010. DWF.
      Modified the GetValue method so that if the data returned is scaled and/or offset
          then the "missing" data value is preserved, although its data type may change.
          In other words, the "missing" data is not scaled or offset. 20 Mar 2010. DWF.
      Added output keywords SCALE_FACTOR, ADD_OFFSET, and DATATYPE to the GetValue method
          so that these values can be returned to the caller at run-time. 29 April 2010. DWF.
      Modified AddAttr method to allow for additional data types in attributes, specifically
          INT data type. 3 June 2013. DWF.
      Had to modify AddAttr method again to allow compatibility with IDL
          versions below 8.1. 26 July 2013. DWF.
      Set Default attribute searching to case insensitive via
      idl-coyote/coyote#13 21 Oct 2017. MHS (mandrakos)