Directory Listing of Routines

spedas_gui/spedas_plugin_api

SPEDAS_TERMS_OF_USE
Terms of use for the data of missions included in SPEDAS

Routine Descriptions

SPEDAS_TERMS_OF_USE

 NAME:
 spedas_terms_of_use

 PURPOSE:
 Terms of use for the data of missions included in SPEDAS

 INPUT
 mission_name: (string) the name of the mission
 KEYWORD ARGUMENTS
 filename: (string) the full path of a text file with the terms of use, or ''
 agreement_text: (string) the actual string of terms of use

 OUTPUT
 1 (terms accepted) or 0 (terms rejected)

 CALLING SEQUENCE:
 spedas_terms_of_use(mission_name)  ; same as filename=''
 or spedas_terms_of_use(mission_name, filename='path_to_agreement_text') 
 or spedas_terms_of_use(mission_name, agreement_text='text of agreement') 
 
 to reset: spedas_terms_of_use_set(mission_name, 0)

 NOTES:
 Works both from Command Line and GUI. Detects it automatically.
 Caller should provide either the filename or agreement_text keyword arguments.

 If the filename is '', we assume that there is a file mission_name.txt inside the Resources/terms_of_use directory.
 Writes lines to the file terms_of_use.txt which resides in user's data folder.
 If the user has not agreed before it will show terms of use. If the user has agreed it will just return 1.
 It can be reset (for example when the interface starts) using spedas_terms_of_use_set(mission_name, 0).


 HISTORY:;
 $LastChangedBy: nikos $
 $LastChangedDate: 2013-03-22 15:47:22 -0700 (Fri, 22 Mar 2013) $
 $LastChangedRevision: 11876 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/spedas_gui/spedas_plugin_api/spedas_terms_of_use.pro $

(See spedas_gui/spedas_plugin_api/spedas_terms_of_use.pro)