>  Docs Center  >  Libraries  >  Coyote  >  GET_OBJECT_ID

GET_OBJECT_ID

GET_OBJECT_ID

Name


    GET_OBJECT_ID

Purpose



    The purpose of this function is to be able to obtain a unique
    object identifier string for a heap variable (object or pointer).

Author



  FANNING SOFTWARE CONSULTING
  David Fanning, Ph.D.
  1645 Sheely Drive
  Fort Collins, CO 80526 USA
  Phone: 970-221-0438
  E-mail: david@idlcoyote.com
  Coyote's Guide to IDL Programming: http://www.idlcoyote.com/

Category



    Utility.

Calling Sequence



    objectID = Get_Object_ID(theObject)

Inputs



    theObject: The object or pointer for which an identifier is requested. If
                  this is a null object, the function returns the string
                  "NullObject". If it is a null pointer, "NullPointer".

Outputs



    objectID: The unique object or pointer identifier.

Keywords



    NUMBER: If this keyword is set, the function returns the unique
                  number identifier associated with a valid pointer or object.
                  The number is returned as a STRING variable. The string
                  "-999" is returned if the pointer or object is invalid and
                  this keyword is set.

Example



    Create a trackball object and obtain its unique object ID.
      IDL> theObject = Obj_New('TRACKBALL', [100,100], 50)
      IDL> objectID = Get_Object_ID(theObject, NUMBER=number)
      IDL> Print, objectID
              ObjHeapVar71(TRACKBALL)
      IDL> Print, number
              71

Modification History



    Written by: David W. Fanning, 4 September 2003.
    Added NUMBER keyword. DWF, 22 September 2008.



© 2019 Harris Geospatial Solutions, Inc. |  Legal
My Account    |    Store    |    Contact Us