![[attach.png]](idldoc-resources/attach.png)
./
spdfvariabledescription__define.pro
This class is an IDL representation of the VariableDescription element from the Coordinated Data Analysis System (CDAS) XML schema.
Author information
- Author
B. Harris
- Copyright
Copyright (c) 2010-2017 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 SpdfVariableDescription
Properties
Properties in SpdfVariableDescription
- children init
- parent init
Fields
Fields in SpdfVariableDescription
- children ptr_new()
names of child variables.
- longDescription ''
long description of variable.
- name ''
varable's name.
- parent ''
name of parent variable.
- shortDescription ''
short description of variable.
Routines
Routines from spdfvariabledescription__define.pro
result = SpdfVariableDescription::init(name, shortDescription, longDescription [, parent=string] [, children=strarr])Creates an SpdfVariableDescription object.
SpdfVariableDescription::cleanupPerforms cleanup operations when this object is destroyed.
result = SpdfVariableDescription::getName()Gets the name of this variable.
result = SpdfVariableDescription::getShortDescription()Gets the short description of this variable.
result = SpdfVariableDescription::getLongDescription()Gets the long description of this variable.
SpdfVariableDescription::printPrints a textual representation of this object.
SpdfVariableDescription__defineDefines the SpdfVariableDescription class.
Routine details
top source SpdfVariableDescription::init
result = SpdfVariableDescription::init(name, shortDescription, longDescription [, parent=string] [, children=strarr])
Creates an SpdfVariableDescription object.
Return value
reference to an SpdfVariableDescription object.
Parameters
- name in type=string
name of variable.
- shortDescription in type=string
short description of varaible.
- longDescription in type=string
long description of varaible.
Keywords
- parent in optional type=string
name of parent variable.
- children in optional type=strarr
names of child variables
top source SpdfVariableDescription::cleanup
SpdfVariableDescription::cleanup
Performs cleanup operations when this object is destroyed.
top source SpdfVariableDescription::getName
result = SpdfVariableDescription::getName()
Gets the name of this variable.
Return value
name of this variable.
top source SpdfVariableDescription::getShortDescription
result = SpdfVariableDescription::getShortDescription()
Gets the short description of this variable.
Return value
short description of this variable.
top source SpdfVariableDescription::getLongDescription
result = SpdfVariableDescription::getLongDescription()
Gets the long description of this variable.
Return value
long description of this variable.
File attributes
| Modification date: | Wed May 9 06:58:57 2018 |
| Lines: | 41 |
CDAS Feedback.