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_data__define.pro


NAME: spd_ui_data__define PURPOSE: This is a data object that contains names ids (self, group, and parent) CALLING SEQUENCE: To Create: myDataObj = Obj_New("SPD_UI_DATA") To Use: data = myDataObj->GetData() OUTPUT: reference to a data object ATTRIBUTES: name name of data timeName name of the time component of this data dataPtr ptr to the data component of this data yaxisName name of the yaxis component of this data indepName name of variable to use on indep axis instead of time limitPtr ptr to the limit struct from the tplot variable that it originated dlimitPtr ptr to the dlimit struct from the tplot variable that it originated id unique identifier for this data object groupName group name fileName data file name isTime this boolean indicates whether a data object represents time isSpect flag set when data is spectrographic mission the mission the data is for observatory spacecraft or groundstation of the data coordSys coordinate system of the data, if applicable instrument instrument of the data units the units for this data qunatity yaxisunits the units of the yaxis for this quantity(not important internally, but when we are passing around metadata during a tplot operation, it becomes more important) suffix the suffix of the quantity(if applicable) settings object representing the default data settings OUTPUT: data object METHODS: getName getDataPtr getRange Copy SetProperty GetProperty GetAll NOTES: Methods: GetProperty,SetProperty,GetAll,SetAll are now managed automatically using the parent class spd_ui_getset. You can still call these methods when using objects of type spd_ui_data, and call them in the same way as before $LastChangedBy: egrimes $ $LastChangedDate: 2014-02-20 14:07:15 -0800 (Thu, 20 Feb 2014) $ $LastChangedRevision: 14405 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/spedas/gui/objects/spd_ui_data__define.pro $

Class description for spd_ui_data

Inheritance

Properties

Properties in spd_ui_getset

Properties in spd_ui_data

FileName init
GroupName init
coordSys init
dataPtr init
dlimitPtr init
indepName init
instrument init
isSpect init
isTime init
isYaxis init
limitPtr init
mission init
observatory init
settings init
st_type init
suffix init
timeName init
timerange init
units init
yaxisName init
yaxisunits init

Fields

Fields in spd_ui_getset

Fields in spd_ui_data

COORDSYS ''
DATAPTR ptr_new()
DLIMITPTR ptr_new()
FILENAME ''
GROUPNAME ''
ID 0S
INDEPNAME ''
INSTRUMENT ''
ISSPECT 0S
ISTIME 0S
ISYAXIS 0S
LIMITPTR ptr_new()
MISSION ''
NAME ''
OBSERVATORY ''
SETTINGS obj_new()
ST_TYPE ''
SUFFIX ''
TIMENAME ''
TIMERANGE obj_new()
UNITS ''
YAXISNAME ''
YAXISUNITS ''

Routines

Methods inherited from spd_ui_getset

Routines from spd_ui_data__define.pro

result = spd_ui_data::getName()
result = spd_ui_data::getDataPtr()
result = spd_ui_data::getRange()
result = spd_ui_data::getGroupName()
spd_ui_data::updateDlimits
spd_ui_data::updateLabels, oldname, newname
result = SPD_UI_DATA::Copy()
result = SPD_UI_DATA::Init(name, id, timeName=timeName, dataPtr=dataPtr, yaxisName=yaxisName, indepName=indepName, limitPtr=limitPtr, dlimitPtr=dlimitPtr, GroupName=GroupName, FileName=FileName, isTime=isTime, isYaxis=isYaxis, isSpect=isSpect, mission=mission, observatory=observatory, coordSys=coordSys, instrument=instrument, timerange=timerange, units=units, st_type=st_type, yaxisunits=yaxisunits, suffix=suffix, settings=settings)
SPD_UI_DATA__DEFINE

Routine details

top source spd_ui_data::getName

result = spd_ui_data::getName()

top source spd_ui_data::getDataPtr

result = spd_ui_data::getDataPtr()

top source spd_ui_data::getRange

result = spd_ui_data::getRange()

top source spd_ui_data::getGroupName

result = spd_ui_data::getGroupName()

top source spd_ui_data::updateDlimits

spd_ui_data::updateDlimits

top source spd_ui_data::updateLabels

spd_ui_data::updateLabels, oldname, newname

Parameters

oldname
newname

top source SPD_UI_DATA::Copy

result = SPD_UI_DATA::Copy()

top source SPD_UI_DATA::Init

result = SPD_UI_DATA::Init(name, id, timeName=timeName, dataPtr=dataPtr, yaxisName=yaxisName, indepName=indepName, limitPtr=limitPtr, dlimitPtr=dlimitPtr, GroupName=GroupName, FileName=FileName, isTime=isTime, isYaxis=isYaxis, isSpect=isSpect, mission=mission, observatory=observatory, coordSys=coordSys, instrument=instrument, timerange=timerange, units=units, st_type=st_type, yaxisunits=yaxisunits, suffix=suffix, settings=settings)

Parameters

name
id

Keywords

timeName
dataPtr
yaxisName
indepName
limitPtr
dlimitPtr
GroupName
FileName
isTime
isYaxis
isSpect
mission
observatory
coordSys
instrument
timerange
units
st_type
yaxisunits
suffix
settings

top source SPD_UI_DATA__DEFINE

SPD_UI_DATA__DEFINE

File attributes

Modification date: Thu Mar 13 16:35:30 2014
Lines: 181