[Previous]
[Next]
PROJECT:
HESSI
NAME:
UNIVERSAL SUPERCLASS DEFINITION
PURPOSE:
Provides data structures and methods used by any
classes
CATEGORY:
Object
;
CONSTRUCTION:
obj = Obj_New( 'Universal' )
PUBLIC METHODS:
Compute: performs the operations required to put the object in
a consistent state. (Do nothing in this class)
Get(): accessor method to retrieve specific object parameter values
Set: accessor method to assign specific object parameter values
Print: prints all object parameters
Plot: in this class, do nothing
Need_Update(): tells if the procedure "Compute" must be called
for the current class.
Update_Done, term: takes the term "term" out of the list in
need_update.
INPUTS:
Through the accessor method "Set"
obj->Set, KEYWORD=value, KEYWORD=value, ...
where KEYWORD is one of those listed below
Keywords can also be set for each of the public methods
OUTPUTS:
Through the accessor method "Get"
value = obj->Get( /KEYWORD )
where KEYWORD is one of those listed below
KEYWORDS:
ASK (Get, Set): asks before performing a critical operation
(e.g. remove files, etc...) Either 0B or
1B. Default is 1B.
FILENAME (Get, Set): the file name where data associated with
the class is stored. Default is ''.
NEED_UPDATE:
PLOT (Get, Set): plots data while performing. This is the
"display" equivalent to "verbose".
Either 0B or 1B. Default is 1B.
VERBOSE (Get, Set): Prints informational messages on the tty
whenever required. Either 0B or 1B.
Default is 1B.
CALLS: ***
GREP, STR_CHOP, UNIVERSAL::CLEANUP, UNIVERSAL::GET, UNIVERSAL::INIT
UNIVERSAL::NEED_UPDATE_UNSET, UNIVERSAL::RESTORE, UNIVERSAL::SAVE
UNIVERSAL::SET, UNIVERSAL::UNSET, UNIVERSAL__DEFINE
HISTORY:
Based on hsi_super__define, but generalized.
June 28, 1999, A Csillaghy, csillag@ssl.berkeley.edu
hsi_super: March 4, 1999, for Release 2
A Csillaghy, csillag@ssl.berkeley.edu