Documentation for /home/davin/idl/socware/

Generated by IDLdoc

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

spedas/gui/objects/

spd_ui_coordinate_systems__define.pro


NAME: spd_ui_coordinate_systems PURPOSE: This object exists for two purposes: 1) Maintain the list of coordinate systems used throughout SPEDAS in a single location 2) Encapsulate the methods that produce coordinate system lists for different contexts, e.g., the verify data panel, load data panel, data processing panel, etc. Both are ultimately for code maintenance KEYWORDS: METHODS: makeCoordSysList: creates and returns a list of valid coordinate systems makeCoordSysListForSpinModel: creates and returns a list of valid coordinate systems that don't require spin model variables to be loaded makeCoordSysListForTHEMIS: creates and returns a list of valid THEMIS-centric coordinate systems ('dsl', 'ssl', 'spg') makeCoordSysListForTHEMISReqPos: creates and returns a list of valid THEMIS coordinate systems that require position data to be transformed to/from EXAMPLES: To make a simple list of general purpose coordinate systems: SPEDAS> coordSysObj = obj_new('spd_ui_coordinate_systems') ; create the object SPEDAS> print, coordSysObj->makeCoordSysList(/uppercase) ; make the list DSL SSL SPG GSM AGSM GSE GEI SM GEO MAG SEL SSE SPEDAS> print, coordSysObj->makeCoordSysList(/uppercase, /include_none) ; include N/A N/A DSL SSL SPG GSM GSE GEI SM GEO MAG SEL SSE SPEDAS> print, coordSysObj->makeCoordSysList(/uppercase, /include_none, /include_all) ; includes 'N/A' and 'ALL' N/A DSL SSL SPG GSM GSE GEI SM GEO MAG SEL SSE ALL SPEDAS> obj_destroy, coordSysObj ; delete the object NOTE: All coordinate system lists exist in this object's constructor, with pointers to the lists in the objects state structure Changes to this object should be reflected in the corresponding test procedure, spd_ui_test_coordinate_systems_obj $LastChangedBy: egrimes $ $LastChangedDate: 2014-09-25 16:30:09 -0700 (Thu, 25 Sep 2014) $ $LastChangedRevision: 15868 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/spedas/gui/objects/spd_ui_coordinate_systems__define.pro $

Class description for spd_ui_coordinate_systems

Fields

Fields in spd_ui_coordinate_systems

COORDINATE_SYSTEMS ptr_new()
FGM_SCM_LOAD_LIST ptr_new()
FIT_ESA_LOAD_LIST ptr_new()
GEOMAG_COORD_SYS_LIST ptr_new()
MISC_COORD_SYS_LIST ptr_new()
THEMIS_COORD_SYS_LIST ptr_new()
THEMIS_POS_DATA_REQ_LIST ptr_new()

Routines

Routines from spd_ui_coordinate_systems__define.pro

result = spd_ui_coordinate_systems::cleanup()
result = spd_ui_coordinate_systems::init()
result = spd_ui_coordinate_systems::makeCoordSysList(include_all=include_all, include_none=include_none, include_misc=include_misc, uppercase=uppercase, instrument=instrument)
result = spd_ui_coordinate_systems::makeCoordSysListForSpinModel(include_dsl=include_dsl)
result = spd_ui_coordinate_systems::makeCoordSysListForTHEMIS(include_dsl=include_dsl)
result = spd_ui_coordinate_systems::makeCoordSysListForTHEMISReqPos()
spd_ui_coordinate_systems__define

Routine details

top source spd_ui_coordinate_systems::cleanup

result = spd_ui_coordinate_systems::cleanup()

top source spd_ui_coordinate_systems::init

result = spd_ui_coordinate_systems::init()

top source spd_ui_coordinate_systems::makeCoordSysList

result = spd_ui_coordinate_systems::makeCoordSysList(include_all=include_all, include_none=include_none, include_misc=include_misc, uppercase=uppercase, instrument=instrument)

Keywords

include_all
include_none
include_misc
uppercase
instrument

top source spd_ui_coordinate_systems::makeCoordSysListForSpinModel

result = spd_ui_coordinate_systems::makeCoordSysListForSpinModel(include_dsl=include_dsl)

Keywords

include_dsl

top source spd_ui_coordinate_systems::makeCoordSysListForTHEMIS

result = spd_ui_coordinate_systems::makeCoordSysListForTHEMIS(include_dsl=include_dsl)

Keywords

include_dsl

top source spd_ui_coordinate_systems::makeCoordSysListForTHEMISReqPos

result = spd_ui_coordinate_systems::makeCoordSysListForTHEMISReqPos()

top source spd_ui_coordinate_systems__define

spd_ui_coordinate_systems__define

File attributes

Modification date: Tue Oct 21 13:53:42 2014
Lines: 88