![[attach.png]](../../idldoc-resources/attach.png)
external/spdfcdas/
spdfdatasetdescription__define.pro
This class is an IDL representation of the DatasetDescription element from the Coordinated Data Analysis System (CDAS) XML schema.
Author information
- Author
B. Harris
- Copyright
Copyright (c) 2010-2013 United States Government as represented by the National Aeronautics and Space Administration. No copyright is claimed in the United States under Title 17, U.S.Code. All Other Rights Reserved.
Class description for SpdfDatasetDescription
Fields
Fields in SpdfDatasetDescription
- datasetLinks ptr_new()
links to information about this dataset.
- id ''
dataset identifier.
- instrumentTypes ptr_new()
instrumentTypes that contributed data to this dataset.
- instruments ptr_new()
intruments that contributed data to this dataset.
- label ''
dataset label.
- notes ''
notes about this dataset.
- observatories ptr_new()
observatories that contributed data to this dataset.
- observatoryGroups ptr_new()
observatoryGroups that contributed data to this dataset.
- piAffiliation ''
affiliation of PI.
- piName ''
name of Principal Investigator.
- timeInterval obj_new()
time interval of this dataset.
Routines
Routines from spdfdatasetdescription__define.pro
result = SpdfDatasetDescription::init(id, observatories, instruments, observatoryGroups, instrumentTypes, label, timeInterval, piName, piAffiliation, notes, datasetLinks)Creates an SpdfDatasetDescription object.
SpdfDatasetDescription::cleanupPerforms cleanup operations when this object is destroyed.
result = SpdfDatasetDescription::getId()Gets the id value.
result = SpdfDatasetDescription::getObservatories()Gets the observatories.
result = SpdfDatasetDescription::getInstruments()Gets the instruments.
result = SpdfDatasetDescription::getObservatoryGroups()Gets the observatoryGroups.
result = SpdfDatasetDescription::getInstrumentsTypes()Gets the instrumentTypes.
result = SpdfDatasetDescription::getLabel()Gets the label value.
result = SpdfDatasetDescription::getTimeInterval()Gets the TimeInterval value.
result = SpdfDatasetDescription::getPiName()Gets the Principal Investigator value.
result = SpdfDatasetDescription::getPiAffiliation()Gets the Principal Investigator's affilation value.
result = SpdfDatasetDescription::getNotes()Gets the notes value.
result = SpdfDatasetDescription::getDatasetLinks()Gets the links.
SpdfDatasetDescription::printPrints a textual representation of this object.
SpdfDatasetDescription__defineDefines the SpdfDatasetDescription class.
Routine details
top source SpdfDatasetDescription::init
result = SpdfDatasetDescription::init(id, observatories, instruments, observatoryGroups, instrumentTypes, label, timeInterval, piName, piAffiliation, notes, datasetLinks)
Creates an SpdfDatasetDescription object.
Return value
reference to an SpdfDatasetDescription object.
Parameters
- id in type=string
dataset identifier.
- observatories in type=strarr
observatories that contributed data to this dataset.
- instruments in type=strarr
intruments that contributed data to this dataset.
- observatoryGroups in type=strarr
observatoryGroups that contributed data to this dataset.
- instrumentTypes in type=strarr
instrumentTypes that contributed data to this dataset.
- label in type=string
dataset label.
- timeInterval in type=SpdfTimeInterval
time interval of this dataset.
- piName in type=string
name of Principal Investigator.
- piAffiliation in type=string
affiliation of PI.
- notes in type=string
notes about this dataset.
- datasetLinks in type=objarr of SpdfDatasetLink
links to information about this dataset.
top source SpdfDatasetDescription::cleanup
SpdfDatasetDescription::cleanup
Performs cleanup operations when this object is destroyed.
top source SpdfDatasetDescription::getId
result = SpdfDatasetDescription::getId()
Gets the id value.
Return value
id value.
top source SpdfDatasetDescription::getObservatories
result = SpdfDatasetDescription::getObservatories()
Gets the observatories.
Return value
strarr of observatories.
top source SpdfDatasetDescription::getInstruments
result = SpdfDatasetDescription::getInstruments()
Gets the instruments.
Return value
strarr of instruments.
top source SpdfDatasetDescription::getObservatoryGroups
result = SpdfDatasetDescription::getObservatoryGroups()
Gets the observatoryGroups.
Return value
strarr of observatoryGroups.
top source SpdfDatasetDescription::getInstrumentsTypes
result = SpdfDatasetDescription::getInstrumentsTypes()
Gets the instrumentTypes.
Return value
strarr of instrumentTypes.
top source SpdfDatasetDescription::getLabel
result = SpdfDatasetDescription::getLabel()
Gets the label value.
Return value
label value.
top source SpdfDatasetDescription::getTimeInterval
result = SpdfDatasetDescription::getTimeInterval()
Gets the TimeInterval value.
Return value
TimeInterval value.
top source SpdfDatasetDescription::getPiName
result = SpdfDatasetDescription::getPiName()
Gets the Principal Investigator value.
Return value
Principal Investigator value.
top source SpdfDatasetDescription::getPiAffiliation
result = SpdfDatasetDescription::getPiAffiliation()
Gets the Principal Investigator's affilation value.
Return value
Principal Investigator's affilation value.
top source SpdfDatasetDescription::getNotes
result = SpdfDatasetDescription::getNotes()
Gets the notes value.
Return value
notes value.
top source SpdfDatasetDescription::getDatasetLinks
result = SpdfDatasetDescription::getDatasetLinks()
Gets the links.
Return value
objarr of links.
File attributes
| Modification date: | Thu Feb 13 16:42:00 2014 |
| Lines: | 92 |