Documentation for /home/davin/idl/socware/

Generated by IDLdoc

single page | use frames     summary     class     fields     routine details     file attributes

general/missions/ace/

spdf_file_source.pro


NAME: spdf_file_source( [default_source] ) PURPOSE: Returns a structure that contains all the information (or options) needed to download and return SPDF data file names. The structure is stored in a common block variable and has persistance. This funtion is used primarily by the routine mvn_pfp_file_source(). However users might wish to change the default values. see "file_retrieve" for specific information on how to use the options in this structure. Typical Usage: source=spdf_file_source() ; get the options printdat, source ; display the options Examples: #1a: tempsource = spdf_file_source(verbose=4,local_data_dir='tempdir/') ; temporarily change VERBOSE and LOCAL_DATA_DIR files = maven_pfp_file_retrieve(source=tempsource) INPUT: default_source (optional) if this is a structure then it will be returned as the output KEYWORDS: SET = [0,1] : If set, then new options (KEYWORDS or DEFAULT_SOURCE) are made to the common block variable are therefor persistant. DO NOT USE THIS KEYWORD INSIDE publically distributed code - IT WILL PRODUCE SIDE EFFECTS FOR OTHERS! ! RESET = [0,1] : If set then the default is restored. DO NOT USE THIS KEYWORD INSIDE publically distributed code - IT WILL PRODUCE SIDE EFFECTS FOR OTHERS! ! EXAMPLE 1: printdat, mvn_file_source(/set, USER_PASS='user:password') ; Add the user and password to enable authentication on the remote server. #1b help,/structure, mvn_file_source(verbose=3,/set) ; Permanentaly change the verbose level for all subsequent calls files = mvn_pfp_file_retrieve() #1c help,/structure, mvn_file_source(no_server=1,/set) ; Permanently disable searching on the remote server #2 help,/structure, mvn_file_source(/reset) ; reset structure to the default. OUTPUT: Structure: see "FILE_RETRIEVE" for a description of each structure element. $LastChangedBy: davin-mac $ $LastChangedDate: 2014-06-14 11:34:33 -0700 (Sat, 14 Jun 2014) $ $LastChangedRevision: 15371 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/maven/general/mvn_file_source.pro $

Routines

top source spdf_file_source

result = spdf_file_source(DEFAULT_SOURCE, set=set, reset=reset, _extra=_extra)

Parameters

DEFAULT_SOURCE

Keywords

set
reset
_extra

File attributes

Modification date: Tue Oct 21 13:53:52 2014
Lines: 30