mglib

Personal IDL library for M. Galloy

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

netcdf/

mgffncvariable__define.pro

file i/o, netcdf, sdf


Class representing netCDF variable.

Routines

Routines from mgffncvariable__define.pro

mgffncvariable::getProperty, attributes=attributes, groups=groups, variables=variables, name=name, data_type=data_type, n_dimensions=n_dimensions, n_attributes=n_attributes, dimensions=dimensions, _ref_extra=_ref_extra

Get properties.

result = mgffncvariable::_overloadHelp(varname)

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

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

Get output for use with PRINT.

result = mgffncvariable::_overloadPrint()

Get output for use with PRINT

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

Get attributes, groups, or variables from a file.

mgffncvariable::cleanup

Free resources.

result = mgffncvariable::init(_extra=_extra)

Create a netCDF variable object.

mgffncvariable__define

Define instance variables.

Routine details

top mgffncvariable::getProperty

mgffncvariable::getProperty, attributes=attributes, groups=groups, variables=variables, name=name, data_type=data_type, n_dimensions=n_dimensions, n_attributes=n_attributes, dimensions=dimensions, _ref_extra=_ref_extra

Get properties.

Keywords

attributes
groups
variables
name
data_type
n_dimensions
n_attributes
dimensions
_ref_extra

top mgffncvariable::_overloadHelp

result = mgffncvariable::_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 mgffncvariable::dump

result = mgffncvariable::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 mgffncvariable::_overloadPrint

result = mgffncvariable::_overloadPrint()

Get output for use with PRINT

Return value

string

top mgffncvariable::_overloadBracketsRightSide

result = mgffncvariable::_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=lonarr

if corresponding element of isRange is 1B, then ss1 is a 3-element array specifying start index, end index, and stride, otherwise an n element list of indices

ss2 in required type=lonarr

if corresponding element of isRange is 1B, then ss2 is a 3-element array specifying start index, end index, and stride, otherwise an n element list of indices

ss3 in required type=lonarr

if corresponding element of isRange is 1B, then ss3 is a 3-element array specifying start index, end index, and stride, otherwise an n element list of indices

ss4 in required type=lonarr

if corresponding element of isRange is 1B, then ss4 is a 3-element array specifying start index, end index, and stride, otherwise an n element list of indices

ss5 in required type=lonarr

if corresponding element of isRange is 1B, then ss5 is a 3-element array specifying start index, end index, and stride, otherwise an n element list of indices

ss6 in required type=lonarr

if corresponding element of isRange is 1B, then ss6 is a 3-element array specifying start index, end index, and stride, otherwise an n element list of indices

ss7 in required type=lonarr

if corresponding element of isRange is 1B, then ss7 is a 3-element array specifying start index, end index, and stride, otherwise an n element list of indices

ss8 in required type=lonarr

if corresponding element of isRange is 1B, then ss8 is a 3-element array specifying start index, end index, and stride, otherwise an n element list of indices

top mgffncvariable::cleanup

mgffncvariable::cleanup

Free resources.

top mgffncvariable::init

result = mgffncvariable::init(_extra=_extra)

Create a netCDF variable object.

Return value

1 for success, 0 for failure

Keywords

_extra

top mgffncvariable__define

mgffncvariable__define

Define instance variables.

File attributes

Modification date: Thu Jun 12 14:28:46 2014
Lines: 152
Docformat: rst rst
Personal library of Michael Galloy
Contact me if you have enhancement requests or bug fixes.