;+
; NAME:
; SAVETOMAIN
;
; PURPOSE:
;
; This is used primarily in debugging mode to save a variable to
; the main IDL level for later inspection.
;
; 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:
;
; Utilities
;
; CALLING SEQUENCE:
;
; SaveToMain, variable, nameOfVariable
;
; ARGUMENTS:
;
; variable: The variable you wish to save at the main IDL level.
;
; nameOfVariable: The name of the variable at the main IDL level. If undefined,
; the variable will have the same name as the variable that was
; used as the variable argument.
;
; KEYWORDRS:
;
; None.
;
; MODIFICATION HISTORY:
;
; Written by: David W. Fanning, 2 July 2009.
;-
;******************************************************************************************;
; Copyright (c) 2009, by Fanning Software Consulting, Inc. ;
; All rights reserved. ;
; ;
; Redistribution and use in source and binary forms, with or without ;
; modification, are permitted provided that the following conditions are met: ;
; ;
; * Redistributions of source code must retain the above copyright ;
; notice, this list of conditions and the following disclaimer. ;
; * Redistributions in binary form must reproduce the above copyright ;
; notice, this list of conditions and the following disclaimer in the ;
; documentation and/or other materials provided with the distribution. ;
; * Neither the name of Fanning Software Consulting, Inc. nor the names of its ;
; contributors may be used to endorse or promote products derived from this ;
; software without specific prior written permission. ;
; ;
; THIS SOFTWARE IS PROVIDED BY FANNING SOFTWARE CONSULTING, INC. ''AS IS'' AND ANY ;
; EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES ;
; OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT ;
; SHALL FANNING SOFTWARE CONSULTING, INC. BE LIABLE FOR ANY DIRECT, INDIRECT, ;
; INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED ;
; TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; ;
; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ;
; ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT ;
; (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS ;
; SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ;
;******************************************************************************************;
PRO SaveToMain, data, name
; Return to caller on error.
On_Error, 2
IF N_Elements(data) EQ 0 THEN Message, 'Must pass a data variable to save at the main IDL level.'
IF N_Elements(name) EQ 0 THEN name = Scope_VarName(data, LEVEL=(-1))
; Store the variable at the main level.
(Scope_VarFetch(name, LEVEL=1, /ENTER)) = data
END