# coyote: NCDF_DIMENSION__DEFINE

- coyote/FileIO
- [Source code]

NAME

      NCDF_DIMENSION

PURPOSE

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

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> dimObj = Obj_New('NCDF_DIMENSION', dimName, parent)

ARGUMENTS

      dimName:   The case sensitive name of a netCDF dimension 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.
      dimName = dimObject -> GetID()
      dimName = dimObject -> GetName()
      dimName = dimObject -> GetSize()
      propertyValue = dimObject -> GetProperty(dimProperty)
      dimValue = dimObject -> GetValue()
      dimName = dimObject -> GetUnlimited()
      dimObject -> ParseAttribute

MODIFICATION HISTORY

      Written by:  David W. Fanning, 3 Feb 2010.