MGHNCFILE__DEFINE

Name

Class MGHncFile

Purpose

This class encapsulates a netCDF file for READ and WRITE
access. It exposes methods for manipulating dimensions, variables
and attributes. C.f. the MGHncReadFile class, which allows
read-only access.

Properties

ATT_NAMES (Get)
A list of global attributes taken from the netCDF file. If the
file has no attributes, then this property returns an empty string.
See N_ATTS.
FILE_NAME (Init, Get)
The name of the netCDF file wrapped by the MGHncFile object.
N_ATTS (Get)
The number of global attributes in the netCDF file.
###########################################################################
This software is provided subject to the following conditions:
1. NIWA makes no representations or warranties regarding the
accuracy of the software, the use to which the software may
be put or the results to be obtained from the use of the
software. Accordingly NIWA accepts no liability for any loss
or damage (whether direct of indirect) incurred by any person
through the use of or reliance on the software.
2. NIWA is to be acknowledged as the original author of the
software where the software is used or presented in any form.
###########################################################################

Modification History

Mark Hadfield, 1997-04:
Written as NcFile
Mark Hadfield, 1999-05:
Renamed to MGHncFile.
Mark Hadfield, 2000-05:
Minor changes to property & keyword names.
Mark Hadfield, 2000-11:
Retrieve method rewritten to use the MGH_STRUCT_BUILD function.
Mark Hadfield, 2001-06:
Updated for IDL 5.5.
Mark Hadfield, 2001-11:
Major overhaul of interface along with MGHncReadFile and
MGHncSequence.
Mark Hadfield, 2003-01:
The VarGet method has been enhanced in the same ways as
MGHncReadFile's VarGet method: a zero value in the COUNT vector
means get all data and a negative value in the OFFSET vector
specifies an offset relative to the end of the dataset.
Mark Hadfield, 2003-05:
Discovered & fixed a long-standing bug in the VarGet method:
in the code activated by AUTOSCALE=1, the WHERE function was
returning a variable "count" which trampled on the keyword variable
of the same name. It becomes a problem when the keyword variable
is passed back to the caller and used in a second call to VarGet.
It's amazing I never hit this one before.
Mark Hadfield, 2003-05:
Code now upgraded for IDL 6.0, including its new features for
logical data. Added the new (experimental) NONULL keyword to
all calls to NCDF_ATTPUT.
Mark Hadfield, 2006-11:
Fixed bug: HasAtt didn't work on variable attributes. How did this
stay undiscovered for so long?!
Mark Hadfield, 2007-06:
Fixed bug reported by Metthew Savoie: UNLIMITED property incorrect
when the first dimension in the file is unlimited.