![[attach.png]](../../../idldoc-resources/attach.png)
spedas/gui/objects/
spd_ui_data_group__define.pro
NAME: spd_ui_data_group Purpose: This object represents a group of data objects, as a means of simplifying the logic of the loaded data object METHODS: addDataObject: This method takes a dataObject, extracts the name & active flag Then passes those into the add method add: This is the generic add method, takes a name, an object, and an optional active flag remove: This method removes an object with a particular name from the data structure It returns 1 on success and 0 upon failure. Optional keyword nodelete, stops data from being deleted when data Object removed. removeall: this method removes all objects from the group. It returns 1 on success and 0 upon failure. Optional keyword nodelete, stops data from being deleted when data Object removed. hasChild: this method determines if the group has a child with a particular name returns 1 for yes and 0 for no hasActive: this method returns 1 if the group has an active object with a particular name and 0 otherwise setActive: this method sets an object with a particular name to active If the name provided is the groupname, the whole group will become active clearActive: this method will deactivate the object with the provided name If the name provided is the groupname, the whole group will become inactive clearAllActive: this method will deactive the group and all its members getActiveChildren: this method returns the names of all active members or 0 if there are no active members(or no members at all) getChildren: this method returns the names of all members getTimeObject: this method returns the timeobject in the group getDataObjects: this method returns the dataobjects in the group getObject: this method returns an object with a particular name or 0 if it is not stored in this object getObjects: this method returns all objects stored in the group or 0 if it contains no objects getActive: this method returns the active flag for the group getName: this method returns the group name setName: this method sets the group name getDataNames: returns the names of children BUT time setTimeName: set the name of the time object in this group getTimeName: get the name of the time object in this group setYaxisName: set the name of the yaxis group for this group getYaxisName: get the name of the yaxis group for this group setIndepName:set the name of the independent variable data name for this group getIndepName: get the name of the independent variable data name for this group getSize: this method returns the number of objects stored in the group getTimeRange: this method returns the start and stop time strings the time object of this group init: has two optional keywords. name,active NOTES: As the data_group object is part of loaded data and data management, destroying this object or removing from this object will result in the contained objects being destroyed and their memory being freed $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_data_group__define.pro $
Class description for spd_ui_data_group
Properties
Properties in spd_ui_data_group
- active init
- name init
Fields
Fields in spd_ui_data_group
- ACTIVE 0S
- CADENCE 0.00000
- DATAACTIVE ptr_new()
- DATANAMES ptr_new()
- DATAOBJS ptr_new()
- INDEPNAME ''
- ISYAXIS 0S
- NAME ''
- NDIMS 0S
- SIZE 0S
- TIMENAME ''
- YAXISNAME ''
- YAXISPARENT ''
Routines
Routines from spd_ui_data_group__define.pro
spd_ui_data_group::addDataObject, objectspd_ui_data_group::add, name, object, active=activeresult = spd_ui_data_group::remove(name, nodelete=nodelete)result = spd_ui_data_group::removeAll(nodelete=nodelete)result = spd_ui_data_group::hasChild(name)result = spd_ui_data_group::hasActive(name)spd_ui_data_group::setActive, name, clear=clearspd_ui_data_group::clearActive, namespd_ui_data_group::clearAllActiveresult = spd_ui_data_group::getActiveChildren()result = spd_ui_data_group::getChildren()result = spd_ui_data_group::getTimeObject()result = spd_ui_data_group::getDataObjects()result = spd_ui_data_group::getObject(name)result = spd_ui_data_group::getAllObjects()result = spd_ui_data_group::getActive()result = spd_ui_data_group::getName()spd_ui_data_group::setName, nameresult = spd_ui_data_group::getDataNames()spd_ui_data_group::setDataNames, namesspd_ui_data_group::setTimeName, nameresult = spd_ui_data_Group::getTimeName()spd_ui_data_Group::setCadence, cadenceresult = spd_ui_data_Group::getCadence()result = spd_ui_data_group::getYAxisParent()spd_ui_data_group::setYAxisParent, nameresult = spd_ui_data_group::getYaxisName()spd_ui_data_group::setYAxisName, namespd_ui_data_group::setisYaxisspd_ui_data_group::setnotYaxisresult = spd_ui_data_group::getIsYaxis()result = spd_ui_data_group::getIndepName()spd_ui_data_group::setIndepName, nameresult = spd_ui_data_group::getSize()result = spd_ui_data_group::getNdims()result = spd_ui_data_group::getDim1()result = spd_ui_data_group::getTimeRange()result = spd_ui_data_group::init(name=name, active=active)spd_ui_data_Group::cleanupspd_ui_data_group__define
Routine details
top source spd_ui_data_group::addDataObject
spd_ui_data_group::addDataObject, object
Parameters
- object
top source spd_ui_data_group::add
spd_ui_data_group::add, name, object, active=active
Parameters
- name
- object
Keywords
- active
top source spd_ui_data_group::remove
result = spd_ui_data_group::remove(name, nodelete=nodelete)
Parameters
- name
Keywords
- nodelete
top source spd_ui_data_group::removeAll
result = spd_ui_data_group::removeAll(nodelete=nodelete)
Keywords
- nodelete
top source spd_ui_data_group::setActive
spd_ui_data_group::setActive, name, clear=clear
Parameters
- name
Keywords
- clear
top source spd_ui_data_group::setYAxisParent
spd_ui_data_group::setYAxisParent, name
Parameters
- name
File attributes
| Modification date: | Thu Feb 13 16:41:39 2014 |
| Lines: | 311 |