KDM__DEFINE
Class Name
KDM
Purpose
A KDM object is a generic top-level object that all other objects
I write should inherit.
Category
Object
Superclasses
None
Subclasses
Almost all of my other objects
Creation
kdm = OBJ_NEW( 'kdm' )
Methods
GetProperty (procedure and function)
SetProperty
Clone
Cleanup
Init
Modification History
Written by: Ken Mankoff. 2009
2009-09-22: Added documentation
=============================================================
METHODNAME:
KDM::GetProperty
Purpose
The GetProperty function returns any property of this or any
subclass. This function is similar to the KDM::GetProprety
procedure except that it is a function.
Calling Sequence
result = kdm->getProperty(/aProperty [,/ALL])
Keyword Parameters
aProperty: Any property
ALL: return a structure containing all of the properties
of this object
Outputs
The property is returned. If it is a pointer it is dereferenced.
Procedure
See http://www.dfanning.com/tips/getproperty.html
Example
To get the debug_kdm property from the KDM object:
o = obj_new( 'kdm' )
print, o->getProperty(/debug_kdm)
=============================================================
METHODNAME:
kdm::GetProperty
Purpose
This procedure is similar to the KDM::GetProperty function except
it is a procedure. This allows more than one property to be
returned in a single call
Calling Sequence
kdm->GetProperty, p0=p0, p1=p1, ..., pN=pN
Keyword Parameters
p0: One property you would like to have from this object
P1: Another.
Outputs
The properties requested are returned. Any properties that are
pointers are dereferenced.
Procedure
See http://www.dfanning.com/tips/getproperty.html
Example
To get the debug_kdm property from the KDM object:
o = obj_new( 'kdm' )
o->getProperty, debug_kdm=debug
=============================================================
METHODNAME:
KDM::SetProperty
Purpose
This procedure sets a property for this object or any object that
inherits this one
Calling Sequence
KDM->SetProperty, PROPERTY=p
Keyword Parameters
PROPERTY: A property of this or a subclass. The property is set to p
Side Effects
The property of the object is changed to the input value
Procedure
See http://www.dfanning.com/tips/getproperty.html
Example
To set the debug_kdm property to 1:
o = obj_new( 'kdm' )
o->setProperty, debug_kdm=1
=============================================================
METHODNAME:
KDM::Clone
Purpose
Deep-clone an object
Calling Sequence
Result = Obj -> Clone()
Outputs
A copy of the object and all of the object properties (deep, recursive)
Side Effects
A save file is temporarily created in the current directory
Restrictions
Must have write access to the current directory
Procedure
See http://www.dfanning.com/tips/copy_objects.html
Example
To clone an object:
o = obj_new( 'kdm' )
o2 = o->Clone()