idllib

Personal IDL library for M. Galloy

single page | use frames     summary     class     fields     routine details     file attributes

netcdf/

mgffncfile__define.pro

file i/o, netcdf, sdf

includes main-level program

The MGffNCFile represents a netCDF file.

Class description for mgffncfile

Inheritance

All ancestor classes: mgffncbase idl_object

Properties

filename get init

filename of netCDF file

_ref_extra get
groups get

names of child groups

attributes get

names of attributes of object

variables get

names of child variables

Routines

mgffncfile::getProperty, attributes=attributes, groups=groups, variables=variables, filename=filename, _ref_extra=_ref_extra

Get properties.

result = mgffncfile::_overloadHelp(varname)

Returns the output display by HELP on an object of the class.

result = mgffncfile::dump( [indent=string])

Get output for use with PRINT

result = mgffncfile::_overloadPrint()

Get output for use with PRINT

result = mgffncfile::_overloadBracketsRightSide(isRange, ss1 [, ss2] [, ss3] [, ss4] [, ss5] [, ss6] [, ss7] [, ss8])

Get attributes, groups, or variables from a file.

mgffncfile::cleanup

Free resources.

result = mgffncfile::init(filename=filename)

Create an MGffNCFile object.

mgffncfile__define

Define instance variables and class inheritance.

Routine details

top source mgffncfile::getProperty

mgffncfile::getProperty, attributes=attributes, groups=groups, variables=variables, filename=filename, _ref_extra=_ref_extra

Get properties.

Keywords

attributes

names of attributes of object

groups

names of child groups

variables

names of child variables

filename

filename of netCDF file

_ref_extra

top source mgffncfile::_overloadHelp

result = mgffncfile::_overloadHelp(varname)

Returns the output display by HELP on an object of the class.

Return value

string

Parameters

varname in required type=string

name of the variable to get help about, passed in to display in HELP output

top source mgffncfile::dump

result = mgffncfile::dump( [indent=string])

Get output for use with PRINT

Return value

string

Keywords

indent in optional type=string

indent to use when printing message

top source mgffncfile::_overloadPrint

result = mgffncfile::_overloadPrint()

Get output for use with PRINT

Return value

string

top source mgffncfile::_overloadBracketsRightSide

result = mgffncfile::_overloadBracketsRightSide(isRange, ss1 [, ss2] [, ss3] [, ss4] [, ss5] [, ss6] [, ss7] [, ss8])

Get attributes, groups, or variables from a file.

Return value

attribute value, group object, or variable object

Parameters

isRange in required type=lonarr(ndims)

array indicating whether each dimensions present is a range or a list of indices

ss1 in required type=string

name of subgroup or variable

ss2 in optional type=any

unused

ss3 in optional type=any

unused

ss4 in optional type=any

unused

ss5 in optional type=any

unused

ss6 in optional type=any

unused

ss7 in optional type=any

unused

ss8 in optional type=any

unused

top source mgffncfile::cleanup

mgffncfile::cleanup

Free resources.

top source mgffncfile::init

result = mgffncfile::init(filename=filename)

Create an MGffNCFile object.

Return value

1 for success, 0 for failure

Keywords

filename

filename of netCDF file

top source mgffncfile__define

mgffncfile__define

Define instance variables and class inheritance.

File attributes

Modification date: Fri Feb 4 15:24:40 2011
Lines: 316
Docformat: rst rst
Personal library of Michael Galloy
Contact me if you have enhancement requests or bug fixes.