![[attach.png]](../../../idldoc-resources/attach.png)
spedas/gui/objects/
spd_ui_loaded_data__define.pro
NAME: spd_ui_loaded_data__define PURPOSE: This is an array of data objects and represents all the data that has been loaded for this session. CALLING SEQUENCE: OUTPUT: reference to data object array ATTRIBUTES: array of data objects METHODS: Add adds a new tplot variable to the loaded data object by tplot variable name AddTvarObject An add routine replaces an object that was returned by getTvarObject in this data structure Remove removes an object from the array by name or group name GetAll returns an array of all data names GetActive returns a list of all data that is currently displayed GetChildren returns a list of the children for a particular variable name SetActive makes a data object active given a tplot name IsActive Checks if a variable with a given name is active IsParent Checks if a variable with a given name is a parent IsChild Checks if a variable with a given name is a child ClearActive makes a data object inactive ClearAllActive clears all active data objects GetVarData gets the data component from a variable. For a group variable, the routine will need to compose the data first GetTvarData gets a tplot variable, For a group data structure it will construct a new tplot variable. GetTvarObject gets object with an assembled data component from getTvarData, but with the appropriate associated meta data GetObjects returns an array of all data objects, can also take a name or group name NOTE: 1. You should use 'getTvarData' or 'getTvarObject' to generate a tplot variable that has all the dimensions of the variable composed as a single entity. After you have modified the variable you should you 'add', to add the data back in to the data structure. 2. Note also, that you don't need to have separate rules to data process parents and children, if you use the same getTvarData/add workflow above for children variables, it will work fine. 3. INIT takes an argument, /autoload. If that is set, the load routine will load all the tplot variables in memory, but not all the metadata for the variables will be set correctly. HISTORY: $LastChangedBy: pcruce $ $LastChangedDate: 2014-11-18 16:47:42 -0800 (Tue, 18 Nov 2014) $ $LastChangedRevision: 16236 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/spedas/gui/objects/spd_ui_loaded_data__define.pro $
Class description for SPD_UI_LOADED_DATA
Fields
Fields in SPD_UI_LOADED_DATA
- DATAID 0L
- GROUPID 0L
- GROUPNAMES ptr_new()
- GROUPOBJS ptr_new()
- INSNAMES ptr_new()
- MISNAMES ptr_new()
- OBSNAMES ptr_new()
Routines
Routines from spd_ui_loaded_data__define.pro
result = SPD_UI_LOADED_DATA::Add(name, file=file, mission=mission, observatory=observatory, coordSys=coordSys, instrument=instrument, timerange=timerange, isSpect=isSpect, groupname=groupname, component_names=component_names, added_name=added_name, units=units, yaxisunits=yaxisunits, isYaxis=isYaxis, suffix=suffix, indepName=indepName, yaxisparent=yaxisparent)result = spd_ui_loaded_data::addData(in_name, d, limit=limit, dlimit=dlimit, file=file, mission=mission, observatory=observatory, coordSys=coordSys, instrument=instrument, timerange=timerange, isSpect=isSpect, groupname=groupname, component_names=component_names, added_name=added_name, units=units, yaxisunits=yaxisunits, isYaxis=isYaxis, suffix=suffix, indepName=indepName, yaxisparent=yaxisparent)spd_ui_loaded_data::detectDlimits, name, dl, mission=mission, observatory=observatory, instrument=instrument, file=file, coordsys=coordsys, units=units, st_type=st_typeresult = SPD_UI_LOADED_DATA::detectSttype(name, dl)result = SPD_UI_LOADED_DATA::detectMission(name, dl)result = SPD_UI_LOADED_DATA::detectObservatory(name, dl, mission)result = SPD_UI_LOADED_DATA::detectInstrument(name, dl, mission)result = SPD_UI_LOADED_DATA::detectFilename(name, dl)result = SPD_UI_LOADED_DATA::detectCoordsys(name, dl)result = SPD_UI_LOADED_DATA::detectunits(name, dl)result = SPD_UI_LOADED_DATA::addTvarObject(obj, component_names=component_names, added_name=added_name)result = SPD_UI_LOADED_DATA::Remove(name, nodelete=nodelete)result = SPD_UI_LOADED_DATA::GetAll(Parent=Parent, Child=Child, Times=Times)result = SPD_UI_LOADED_DATA::GetActive(Parent=Parent, Child=Child)result = SPD_UI_LOADED_DATA::getChildren(name)SPD_UI_LOADED_DATA::SetActive, nameresult = SPD_UI_LOADED_DATA::IsActive(name)result = SPD_UI_LOADED_DATA::IsChild(name)result = SPD_UI_LOADED_DATA::IsParent(name)SPD_UI_LOADED_DATA::ClearActive, thisNameSPD_UI_LOADED_DATA::ClearAllActiveSPD_UI_LOADED_DATA::GetVarData, name=name, time=time, data=data, yaxis=yaxis, limits=limits, dlimits=dlimits, mission=mission, observatory=observatory, coordsys=coordsys, instrument=instrument, trange=trange, units=units, isTime=isTime, tmName=tmName, duplicate=duplicateresult = SPD_UI_LOADED_DATA::GetTvarData(name)spd_ui_loaded_data::getdatainfo, name, mission=mission, observatory=observatory, instrument=instrument, units=units, coordinate_system=coordinate_system, filename=filename, limit=limit, dlimit=dlimit, fail=fail, st_type=st_typespd_ui_loaded_data::setDataInfo, name, newname=newname, mission=mission, observatory=observatory, instrument=instrument, units=units, coordinate_system=coordinate_system, windowstorage=windowstorage, fail=fail, st_type=st_typeSPD_UI_LOADED_DATA::Cleanupresult = SPD_UI_LOADED_DATA::GetTvarObject(name)result = SPD_UI_LOADED_DATA::GetObjects(name=name)result = spd_ui_loaded_data::getGroup(name)result = spd_ui_loaded_data::getGroupNames()spd_ui_loaded_data::SplitVecPtr, name, d, outnames=outnames, outptrs=outptrs, suffixes=suffixesresult = spd_ui_loaded_data::getTreeData()spd_ui_loaded_data::resetresult = SPD_UI_LOADED_DATA::Init()SPD_UI_LOADED_DATA__DEFINE
Routine details
top source SPD_UI_LOADED_DATA::Add
result = SPD_UI_LOADED_DATA::Add(name, file=file, mission=mission, observatory=observatory, coordSys=coordSys, instrument=instrument, timerange=timerange, isSpect=isSpect, groupname=groupname, component_names=component_names, added_name=added_name, units=units, yaxisunits=yaxisunits, isYaxis=isYaxis, suffix=suffix, indepName=indepName, yaxisparent=yaxisparent)
Parameters
- name
Keywords
- file
- mission
- observatory
- coordSys
- instrument
- timerange
- isSpect
- groupname
- component_names
- added_name
- units
- yaxisunits
- isYaxis
- suffix
- indepName
- yaxisparent
top source spd_ui_loaded_data::addData
result = spd_ui_loaded_data::addData(in_name, d, limit=limit, dlimit=dlimit, file=file, mission=mission, observatory=observatory, coordSys=coordSys, instrument=instrument, timerange=timerange, isSpect=isSpect, groupname=groupname, component_names=component_names, added_name=added_name, units=units, yaxisunits=yaxisunits, isYaxis=isYaxis, suffix=suffix, indepName=indepName, yaxisparent=yaxisparent)
Parameters
- in_name
- d
Keywords
- limit
- dlimit
- file
- mission
- observatory
- coordSys
- instrument
- timerange
- isSpect
- groupname
- component_names
- added_name
- units
- yaxisunits
- isYaxis
- suffix
- indepName
- yaxisparent
top source spd_ui_loaded_data::detectDlimits
spd_ui_loaded_data::detectDlimits, name, dl, mission=mission, observatory=observatory, instrument=instrument, file=file, coordsys=coordsys, units=units, st_type=st_type
Parameters
- name
- dl
Keywords
- mission
- observatory
- instrument
- file
- coordsys
- units
- st_type
top source SPD_UI_LOADED_DATA::detectSttype
result = SPD_UI_LOADED_DATA::detectSttype(name, dl)
Parameters
- name
- dl
top source SPD_UI_LOADED_DATA::detectMission
result = SPD_UI_LOADED_DATA::detectMission(name, dl)
Parameters
- name
- dl
top source SPD_UI_LOADED_DATA::detectObservatory
result = SPD_UI_LOADED_DATA::detectObservatory(name, dl, mission)
Parameters
- name
- dl
- mission
top source SPD_UI_LOADED_DATA::detectInstrument
result = SPD_UI_LOADED_DATA::detectInstrument(name, dl, mission)
Parameters
- name
- dl
- mission
top source SPD_UI_LOADED_DATA::detectFilename
result = SPD_UI_LOADED_DATA::detectFilename(name, dl)
Parameters
- name
- dl
top source SPD_UI_LOADED_DATA::detectCoordsys
result = SPD_UI_LOADED_DATA::detectCoordsys(name, dl)
Parameters
- name
- dl
top source SPD_UI_LOADED_DATA::detectunits
result = SPD_UI_LOADED_DATA::detectunits(name, dl)
Parameters
- name
- dl
top source SPD_UI_LOADED_DATA::addTvarObject
result = SPD_UI_LOADED_DATA::addTvarObject(obj, component_names=component_names, added_name=added_name)
Parameters
- obj
Keywords
- component_names
- added_name
top source SPD_UI_LOADED_DATA::Remove
result = SPD_UI_LOADED_DATA::Remove(name, nodelete=nodelete)
Parameters
- name
Keywords
- nodelete
top source SPD_UI_LOADED_DATA::GetAll
result = SPD_UI_LOADED_DATA::GetAll(Parent=Parent, Child=Child, Times=Times)
Keywords
- Parent
- Child
- Times
top source SPD_UI_LOADED_DATA::GetActive
result = SPD_UI_LOADED_DATA::GetActive(Parent=Parent, Child=Child)
Keywords
- Parent
- Child
top source SPD_UI_LOADED_DATA::getChildren
result = SPD_UI_LOADED_DATA::getChildren(name)
Parameters
- name
top source SPD_UI_LOADED_DATA::ClearActive
SPD_UI_LOADED_DATA::ClearActive, thisName
Parameters
- thisName
top source SPD_UI_LOADED_DATA::GetVarData
SPD_UI_LOADED_DATA::GetVarData, name=name, time=time, data=data, yaxis=yaxis, limits=limits, dlimits=dlimits, mission=mission, observatory=observatory, coordsys=coordsys, instrument=instrument, trange=trange, units=units, isTime=isTime, tmName=tmName, duplicate=duplicate
Keywords
- name
- time
- data
- yaxis
- limits
- dlimits
- mission
- observatory
- coordsys
- instrument
- trange
- units
- isTime
- tmName
- duplicate
top source SPD_UI_LOADED_DATA::GetTvarData
result = SPD_UI_LOADED_DATA::GetTvarData(name)
Parameters
- name
top source spd_ui_loaded_data::getdatainfo
spd_ui_loaded_data::getdatainfo, name, mission=mission, observatory=observatory, instrument=instrument, units=units, coordinate_system=coordinate_system, filename=filename, limit=limit, dlimit=dlimit, fail=fail, st_type=st_type
Parameters
- name
Keywords
- mission
- observatory
- instrument
- units
- coordinate_system
- filename
- limit
- dlimit
- fail
- st_type
top source spd_ui_loaded_data::setDataInfo
spd_ui_loaded_data::setDataInfo, name, newname=newname, mission=mission, observatory=observatory, instrument=instrument, units=units, coordinate_system=coordinate_system, windowstorage=windowstorage, fail=fail, st_type=st_type
Parameters
- name
Keywords
- newname
- mission
- observatory
- instrument
- units
- coordinate_system
- windowstorage
- fail
- st_type
top source SPD_UI_LOADED_DATA::GetTvarObject
result = SPD_UI_LOADED_DATA::GetTvarObject(name)
Parameters
- name
top source SPD_UI_LOADED_DATA::GetObjects
result = SPD_UI_LOADED_DATA::GetObjects(name=name)
Keywords
- name
File attributes
| Modification date: | Fri Nov 21 06:43:07 2014 |
| Lines: | 1,278 |