./
spdfthumbnaildescription__define.pro
This class is an IDL representation of the ThumbnailDescription 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 SpdfThumbnailDescription
Fields
Fields in SpdfThumbnailDescription
- dataset ''
dataset identifier.
- myScale 0.0000000D
- name ''
- numCols 0L
number of columns of thumbnail images.
- numFrames 0L
number of thumbnail images.
- numRows 0L
number of rows of thumbnail images.
- options 0LL
- startRecord 0L
- thumbnailHeight 0L
height of thumbnail image in pixels.
- thumbnailWidth 0L
width of thumbnail image in pixels.
- timeInterval ptr_new()
- titleHeight 0L
height of title in pixels.
- type ''
- varName ''
- xyStep 0.0000000D
Routines
Routines from spdfthumbnaildescription__define.pro
result = SpdfThumbnailDescription::init(type, name, dataset, timeInterval, varName, options, numFrames, numRows, numCols, titleHeight, thumbnailHeight, thumbnailWidth, startRecord, myScale, xyStep)
Creates an SpdfThumbnailDescription object.
SpdfThumbnailDescription::cleanup
Performs cleanup operations when this object is destroyed.
result = SpdfThumbnailDescription::getDataset()
Gets the dataset value.
result = SpdfThumbnailDescription::getNumFrames()
Gets the number of frames.
result = SpdfThumbnailDescription::getNumRows()
Gets the number of rows of thumbnail images.
result = SpdfThumbnailDescription::getNumCols()
Gets the number of columns of thumbnail images.
result = SpdfThumbnailDescription::getTitleHeight()
Gets the height of the title.
result = SpdfThumbnailDescription::getThumbnailHeight()
Gets the height of each thumbnail image.
result = SpdfThumbnailDescription::getThumbnailWidth()
Gets the width of each thumbnail image.
SpdfThumbnailDescription__define
Defines the SpdfThumbnailDescription class.
Routine details
top source SpdfThumbnailDescription::init
result = SpdfThumbnailDescription::init(type, name, dataset, timeInterval, varName, options, numFrames, numRows, numCols, titleHeight, thumbnailHeight, thumbnailWidth, startRecord, myScale, xyStep)
Creates an SpdfThumbnailDescription object.
Return value
reference to an SpdfThumbnailDescription object.
Parameters
- type in type=string
- name in type=string
- dataset in type=string
- timeInterval in type=SpdfTimeIntervals
time interval covered by the thumbnail images.
- varName in type=string
- options in type=long64
- numFrames in type=long
number of thumbnail images.
- numRows in type=long
number of rows of thumbnail images.
- numCols in type=long
number of columns of thumbnail images.
- titleHeight in type=long
height of title in pixels.
- thumbnailHeight in type=long
height of thumbnail image in pixels.
- thumbnailWidth in type=long
width of thumbnail image in pixels.
- startRecord in type=long
- myScale in type=double
- xyStep in type=double
top source SpdfThumbnailDescription::cleanup
SpdfThumbnailDescription::cleanup
Performs cleanup operations when this object is destroyed.
top source SpdfThumbnailDescription::getDataset
result = SpdfThumbnailDescription::getDataset()
Gets the dataset value.
Return value
dataset value.
top source SpdfThumbnailDescription::getNumFrames
result = SpdfThumbnailDescription::getNumFrames()
Gets the number of frames.
Return value
number of frames.
top source SpdfThumbnailDescription::getNumRows
result = SpdfThumbnailDescription::getNumRows()
Gets the number of rows of thumbnail images.
Return value
number of rows of thumbnail images.
top source SpdfThumbnailDescription::getNumCols
result = SpdfThumbnailDescription::getNumCols()
Gets the number of columns of thumbnail images.
Return value
number of columns of thumbnail images.
top source SpdfThumbnailDescription::getTitleHeight
result = SpdfThumbnailDescription::getTitleHeight()
Gets the height of the title.
Return value
height of title in pixels.
top source SpdfThumbnailDescription::getThumbnailHeight
result = SpdfThumbnailDescription::getThumbnailHeight()
Gets the height of each thumbnail image.
Return value
height of each thumbnail image in pixels.
File attributes
Modification date: | Wed May 9 06:58:57 2018 |
Lines: | 74 |
CDAS Feedback.