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


NAME: spd_ui_variable__define PURPOSE: Variable object, displayed at bottom of window CALLING SEQUENCE: variable = Obj_New("SPD_UI_VARIABLE") INPUT: none ATTRIBUTES: fieldName name of variable to be displayed controlName name of variable to be used for control text text object for this variable symbol numeric symbols 0=none, 1=degrees, 2=seconds, 3=minutes format numeric formatting style (e.g. 12.34, 1.23e4) minRange the minimum range for the variable maxRange the maximum range for the variable scaling the type of scaling used with the variable 0:Linear,1 Log10, 2:LogN useRange 0 = auto,1= user defined,2 = xrange from panel OUTPUT: variable object reference METHODS: SetProperty procedure to set keywords GetProperty procedure to get keywords GetAll returns the entire structure GetSymbols returns array symbol names GetSymbol returns a symbol name given an index Copy clone the object HISTORY: 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_variable, and call them in the same way as before $LastChangedBy: jimm $ $LastChangedDate: 2014-02-11 10:54:32 -0800 (Tue, 11 Feb 2014) $ $LastChangedRevision: 14326 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/spedas/gui/objects/spd_ui_variable__define.pro $

Class description for SPD_UI_VARIABLE

Inheritance

Properties

Properties in spd_ui_getset

Properties in SPD_UI_VARIABLE

ControlName init
Debug init
FieldName init
Format init
Symbol init
Text init
annotateExponent init
includeUnits init
isTime init
maxRange init
minRange init
nosave init
scaling init
useRange init

Fields

Fields in SPD_UI_READWRITE

Fields in spd_ui_getset

Fields in SPD_UI_VARIABLE

ANNOTATEEXPONENT 0S
CONTROLNAME ''
FIELDNAME ''
FORMAT 0S
INCLUDEUNITS 0S
ISTIME 0B
MAXRANGE 0.0000000D
MINRANGE 0.0000000D
ORIGSETTINGS ptr_new()
SCALING 0B
SYMBOL 0S
TEXT obj_new()
USERANGE 0B

Routines

Methods inherited from spd_ui_getset

Methods inherited from SPD_UI_READWRITE

Routines from spd_ui_variable__define.pro

result = SPD_UI_VARIABLE::Copy()
result = SPD_UI_VARIABLE::GetSymbols()
spd_ui_variable::updatedatareference, oldnames, newnames, changed=changed
result = SPD_UI_VARIABLE::GetFormats(istime=istime)
result = SPD_UI_VARIABLE::GetFormat(index)
result = SPD_UI_VARIABLE::GetSymbol(index)
SPD_UI_VARIABLE::Save
SPD_UI_VARIABLE::Reset
SPD_UI_VARIABLE::Cleanup
result = SPD_UI_VARIABLE::Init(FieldName=FieldName, ControlName=ControlName, includeUnits=includeUnits, Text=Text, Symbol=Symbol, Format=Format, isTime=isTime, minRange=minRange, maxRange=maxRange, scaling=scaling, useRange=useRange, annotateExponent=annotateExponent, Debug=Debug, nosave=nosave)
SPD_UI_VARIABLE__DEFINE

Routine details

top source SPD_UI_VARIABLE::Copy

result = SPD_UI_VARIABLE::Copy()

top source SPD_UI_VARIABLE::GetSymbols

result = SPD_UI_VARIABLE::GetSymbols()

top source spd_ui_variable::updatedatareference

spd_ui_variable::updatedatareference, oldnames, newnames, changed=changed

Parameters

oldnames
newnames

Keywords

changed

top source SPD_UI_VARIABLE::GetFormats

result = SPD_UI_VARIABLE::GetFormats(istime=istime)

Keywords

istime

top source SPD_UI_VARIABLE::GetFormat

result = SPD_UI_VARIABLE::GetFormat(index)

Parameters

index

top source SPD_UI_VARIABLE::GetSymbol

result = SPD_UI_VARIABLE::GetSymbol(index)

Parameters

index

top source SPD_UI_VARIABLE::Save

SPD_UI_VARIABLE::Save

top source SPD_UI_VARIABLE::Reset

SPD_UI_VARIABLE::Reset

top source SPD_UI_VARIABLE::Cleanup

SPD_UI_VARIABLE::Cleanup

top source SPD_UI_VARIABLE::Init

result = SPD_UI_VARIABLE::Init(FieldName=FieldName, ControlName=ControlName, includeUnits=includeUnits, Text=Text, Symbol=Symbol, Format=Format, isTime=isTime, minRange=minRange, maxRange=maxRange, scaling=scaling, useRange=useRange, annotateExponent=annotateExponent, Debug=Debug, nosave=nosave)

Keywords

FieldName
ControlName
includeUnits
Text
Symbol
Format
isTime
minRange
maxRange
scaling
useRange
annotateExponent
Debug
nosave

top source SPD_UI_VARIABLE__DEFINE

SPD_UI_VARIABLE__DEFINE

File attributes

Modification date: Thu Feb 13 16:41:39 2014
Lines: 149