mglib

Personal IDL library for M. Galloy

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

netcdf/

mgffncgroup__define.pro

file i/o, netcdf, sdf


Class representing a netCDF group.

Other file information

Requires:

IDL 8.0

Class description for mgffncvariable

Inheritance

All ancestor classes: mgffncbase idl_object

Properties

Properties in mgffncvariable

attributes

names of attributes of object

fullname

full path to object inside the netCDF hierarchy

groups

names of child groups

name

name of the group

variables

names of child variables

Class description for mgffncgroup

Inheritance

All ancestor classes: mgffncbase idl_object

Properties

Properties in mgffncgroup

_extra init
_ref_extra get
attributes get
fullname get
groups get
name get
variables get

Routines

Methods inherited from idl_object

Methods inherited from mgffncbase

Methods inherited from idl_object

Methods inherited from mgffncbase

Routines from mgffncgroup__define.pro

mgffncgroup::getProperty, attributes=attributes, groups=groups, variables=variables, name=name, fullname=fullname, _ref_extra=_ref_extra

Get properties.

result = mgffncgroup::_overloadHelp(varname)

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

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

Get output for use with PRINT.

result = mgffncgroup::_overloadPrint()

Get output for use with PRINT.

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

Get attributes, groups, or variables from a file.

mgffncgroup::cleanup

Free resources.

result = mgffncgroup::init(_extra=_extra)

Create a netCDF group object.

mgffncgroup__define

Define instance variables and class inheritance.

Routine details

top mgffncgroup::getProperty

mgffncgroup::getProperty, attributes=attributes, groups=groups, variables=variables, name=name, fullname=fullname, _ref_extra=_ref_extra

Get properties.

Keywords

attributes
groups
variables
name
fullname
_ref_extra

top mgffncgroup::_overloadHelp

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

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

result = mgffncgroup::_overloadPrint()

Get output for use with PRINT.

Return value

string

top mgffncgroup::_overloadBracketsRightSide

result = mgffncgroup::_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 mgffncgroup::cleanup

mgffncgroup::cleanup

Free resources.

top mgffncgroup::init

result = mgffncgroup::init(_extra=_extra)

Create a netCDF group object.

Return value

1 for success, 0 for failure

Keywords

_extra

top mgffncgroup__define

mgffncgroup__define

Define instance variables and class inheritance.

File attributes

Modification date: Fri Jun 20 11:18:47 2014
Lines: 134
Docformat: rst rst
Personal library of Michael Galloy
Contact me if you have enhancement requests or bug fixes.