mglib

Personal IDL library for M. Galloy

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

fileio/

mg_savefile__define.pro

includes main-level program

Subclass of IDL_Savefile that provides easier to use functionality for examining the contents of a save file.

Examples

Try the main-level example at the end of this file:

IDL> .run mg_savefile__define

Class description for mg_savefile

Inheritance

Properties

Properties in mg_savefile

_extra init

Routines

Methods inherited from idl_object

Routines from mg_savefile__define.pro

result = mg_savefile::_overloadHelp(varname)

Print the help string for all the regular variables in a .sav file.

result = mg_savefile::_overloadPrint()

Returns names of each type of save file item in the file.

result = mg_savefile::_overloadBracketsRightSide(isRange, ss1)

Allow hash-like subscripting to retrieve variable values.

result = mg_savefile::get(saveitem [, _ref_extra=keywords])

Return a particular item in the .sav file.

result = mg_savefile::init( [filename] [, _extra=keywords])
mg_savefile__define

Define instance variables and inheritance.

Routine details

top mg_savefile::_overloadHelp

result = mg_savefile::_overloadHelp(varname)

Print the help string for all the regular variables in a .sav file.

Parameters

varname in required type=any

variable to find declaration statement for

top mg_savefile::_overloadPrint

result = mg_savefile::_overloadPrint()

Returns names of each type of save file item in the file.

Return value

string

top mg_savefile::_overloadBracketsRightSide

result = mg_savefile::_overloadBracketsRightSide(isRange, ss1)

Allow hash-like subscripting to retrieve variable values.

Return value

string

Parameters

isRange in required type=lonarr

whether each corresponding index is a range

ss1 in required type=string

name of variable to extract

top mg_savefile::get

result = mg_savefile::get(saveitem [, _ref_extra=keywords])

Return a particular item in the .sav file.

Return value

save file item, if a standard variable

Parameters

saveitem

Keywords

_ref_extra in out optional type=keywords

keywords to IDL_Savefile::restore

top mg_savefile::init

result = mg_savefile::init( [filename] [, _extra=keywords])

Return value

1 for success, 0 for failure

Parameters

filename in optional type=string

filename of save file

Keywords

_extra in optional type=keywords

keywords to IDL_Savefile

top mg_savefile__define

mg_savefile__define

Define instance variables and inheritance.

File attributes

Modification date: Wed May 14 15:07:14 2014
Lines: 136
Docformat: rst rst
Personal library of Michael Galloy
Contact me if you have enhancement requests or bug fixes.