Documentation for /home/davin/idl/socware/

Generated by IDLdoc

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

spedas/gui/spedas_plugin_api/

spedas_terms_of_use.pro


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/trunk/spedas/gui/spedas_plugin_api/spedas_terms_of_use.pro $

Routines

Routines from spedas_terms_of_use.pro

result = spedas_config_dir()
result = spedas_read_file(filename)
result = terms_of_use_check(mission_name)
result = spedas_terms_of_use_set(mission_name, value)
mission_terms_of_use_event, event
mission_terms_of_use, mission_name=mission_name, agreement_text=agreement_text
result = spedas_terms_of_use(mission_name, filename=filename, agreement_text=agreement_text)

Routine details

top source spedas_config_dir

result = spedas_config_dir()

top source spedas_read_file

result = spedas_read_file(filename)

Parameters

filename

top source terms_of_use_check

result = terms_of_use_check(mission_name)

Parameters

mission_name

top source spedas_terms_of_use_set

result = spedas_terms_of_use_set(mission_name, value)

Parameters

mission_name
value

top source mission_terms_of_use_event

mission_terms_of_use_event, event

Parameters

event

top source mission_terms_of_use

mission_terms_of_use, mission_name=mission_name, agreement_text=agreement_text

Keywords

mission_name
agreement_text

top source spedas_terms_of_use

result = spedas_terms_of_use(mission_name, filename=filename, agreement_text=agreement_text)

Parameters

mission_name

Keywords

filename
agreement_text

File attributes

Modification date: Thu Feb 13 16:41:37 2014
Lines: 158