# coyote: NCDF_ATTRIBUTE__DEFINE

- coyote/FileIO
- [Source code]

NAME

      NCDF_ATTRIBUTE

PURPOSE

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

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> attrObj = Obj_New('NCDF_ATTRIBUTE', attrName, parent, VARNAME=varName)

ARGUMENTS

      attrName:  The case sensitive name of a netCDF attribute 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

      varName:   If this is a variable attribute, this is the case sensitive name of the
                 variable that the attribute is attached to. (Input and required for variable
                 attributes.) Note that a variable object reference may be used in place of the
                 variable name.

METHODS

      The following methods are available. Each is documented in front of the method.
      attrName = attrObject -> GetName()
      propertyValue = attrObject -> GetProperty(attrProperty)
      attrValue = attrObject -> GetValue()
      attrObject -> ParseAttribute

MODIFICATION HISTORY

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