ITOOLWATPMGR__DEFINE
Class Name
itoolwatpmgr
Purpose (one Line)
To define, edit, and manage itool photometry templates.
Category
Widgets
Superclasses
Subclasses
Creation
See itoolwatpmgr::init
Methods
itoolwatpmgr::cleanup
itoolwatpmgr::getproperty
itoolwatpmgr::setproperty
itoolwatpmgr::refreshobjects
itoolwatpmgr::realize
itoolwatpmgr::init
itoolwatpmgr::refreshtemplates
itoolwatpmgr::addtemplate
itoolwatpmgr::purgetemplates
itoolwatpmgr::load
itoolwatpmgr::save
Modification History
Written by Doug Loucks, consultant for Lowell Observatory, March / April
2004.
Adapted from cw_tpmgr.pro and cw_tplat.pro.
Removed all remnants of compound-widget code; replaced with
stand-alone code that is compaitble with the new object-oriented version
of itool.
Modified the usage of the state-structure variable. A pointer to
the state structure is stored in the object instance of this tool and
this tool's object reference is stored in its top-level base.
-----------------------------------------------------------------------------
METHOD NAME:
itoolwatpmgr::cleanup
Purpose
Self-explanatory
Calling Sequence
obj_destroy, oref
Inputs
oref : An itoolwatpmgr object reference.
Optional Inputs
Keyword Parameters
Outputs
Optional Outputs
Common Blocks
Side Effects
Restrictions
Procedure
Example
Modification History
-----------------------------------------------------------------------------
METHOD NAME:
itoolwatpmgr::getproperty
Purpose
To retrieve "properties" defined for the itoolwatpmgr object
class. Properties are specified as keyword arguments.
Calling Sequence
oref->getproperty
Inputs
Optional Inputs
Keyword Parameters
NUM_TPLATES : Set this keyword to a named variable into which will be
placed the number of templates currently defined.
OITOOL : Set this keyword to a named variable into which will be
placed a copy of the object reference of a host instance
of the "itool" object class.
PIDX_TPLATES : Set this keyword to a named variable into which will be
placed a pointer to the array of sorted indices of
the templates. Templates are sorted by their names.
PSTATE : Set this keyword to a named variable into which will be
placed a pointer to the state structure.
PTPLATES : Set this keyword to a named variable into which will be
placed a pointer to the array of template-reference
structures.
SELECTED : Set this keyword to a named variable into which will be
placed the sorted index of the selected template. If
a template has not been selected, -1 will be returned.
The user selects a template by clicking in the list
widget that displays the list of templates.
TPLATE : Set this keyword to a named variable into which will be
placed a copy of the currently-selected template
reference. If a template has not been selected, a blank
template-reference structure will be returned (null name
string and null object reference).
A template reference is defined by the itool_templatelist
object class. The object-reference tag in a template-
reference structure is used to access the template data
and to call method routines that operate on the
template data.
Outputs
Optional Outputs
Common Blocks
Side Effects
Restrictions
Procedure
Example
Modification History
-----------------------------------------------------------------------------
METHOD NAME:
itoolwatpmgr::setproperty
Purpose
To set "properties" defined for the itoolwatpmgr object
class. Properties are specified as keyword arguments.
Calling Sequence
Inputs
Optional Inputs
Keyword Parameters
NUM_TPLATES : The number of templates currently defined.
SELECTED : The sorted index of the currently-selected template.
Outputs
Optional Outputs
Common Blocks
Side Effects
Restrictions
Procedure
Example
Modification History
-----------------------------------------------------------------------------
METHOD NAME:
itoolwatpmgr::refreshobjects
Purpose
To refresh the list widget that displays the list of objects.
Calling Sequence
oref->refreshobjects
Inputs
Optional Inputs
Keyword Parameters
Outputs
Optional Outputs
Common Blocks
Side Effects
Restrictions
Procedure
Example
Modification History
-----------------------------------------------------------------------------
METHOD NAME:
itoolwatpmgr::realize
Purpose
To realize a new, managed instance of the itoolwatpmgr object class.
Calling Sequence
oref->realize
Inputs
Optional Inputs
Keyword Parameters
NO_BLOCK : Set this keyword to cause the widget application to run
in non-blocked mode.
Outputs
Optional Outputs
Common Blocks
Side Effects
Restrictions
Procedure
Example
Modification History
-----------------------------------------------------------------------------
METHOD NAME:
itoolwatpmgr::init
Purpose
To initialize a new instance of the itoolwatpmgr object class.
Calling Sequence
oref = obj_new('itoolwatpmgr', oitool)
Inputs
oitool : An object reference of a host instance of the object class
"itool."
Optional Inputs
Keyword Parameters
GROUP_LEADER : The group leader for this tool.
TMPLFILE : The name of a file containing a list templates.
Outputs
oref = The object reference of the new instance of the itoolwatpmgr
object class.
Optional Outputs
Common Blocks
Side Effects
Restrictions
Procedure
After creating a new instance of this object-oriented widget application,
it must be realized.
Example
oref = obj_new('itoolwatpmgr', oitool, GROUP_LEADER=group_leader)
oref->realize
Modification History
-----------------------------------------------------------------------------
METHOD NAME:
itoolwatpmgr::refreshtemplates
Purpose
To refresh the list widget that displays the list of templates.
Calling Sequence
Inputs
Optional Inputs
Keyword Parameters
Outputs
Optional Outputs
Common Blocks
Side Effects
Restrictions
Procedure
Example
Modification History
-----------------------------------------------------------------------------
METHOD NAME:
itoolwatpmgr::addtemplate
Purpose
To add a template.
Calling Sequence
oref->addtemplate, name, objnam, x, y
Inputs
name : String scalar containing the name of the template.
objnam : String array containing the names of the objects.
x : Array of x-coordinates of the objects.
y : Array of y-coordinates of the objects.
Optional Inputs
Keyword Parameters
Outputs
Optional Outputs
Common Blocks
Side Effects
Restrictions
Procedure
Example
Modification History
-----------------------------------------------------------------------------
METHOD NAME:
itoolwatpmgr::purgetemplates
Purpose
To purge the current list of templates.
Calling Sequence
oref->purgetemplates
Inputs
Optional Inputs
Keyword Parameters
Outputs
Optional Outputs
Common Blocks
Side Effects
Restrictions
Procedure
Example
Modification History
-----------------------------------------------------------------------------
METHOD NAME:
itoolwatpmgr::load
Purpose
To load a set of templates from a file.
Calling Sequence
oref->load
Inputs
Optional Inputs
Keyword Parameters
Outputs
Optional Outputs
Common Blocks
Side Effects
Restrictions
Procedure
The file name is taken from the tmplfile tag of the state structure.
Example
Modification History
-----------------------------------------------------------------------------
METHOD NAME:
itoolwatpmgr::save
Purpose
To save the current list of templates to a file.
Calling Sequence
oref->save, fname
Inputs
fname : Scalar string containing the name of the template file to
to be written.
Optional Inputs
Keyword Parameters
Outputs
Optional Outputs
Common Blocks
Side Effects
Restrictions
Procedure
Example
Modification History