![[attach.png]](../../idldoc-resources/attach.png)
external/spdfcdas/
spdffiledescription__define.pro
This class is an IDL representation of the FileDescription 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 SpdfFileDescription
Properties
Properties in SpdfFileDescription
- thumbnailDescription init
- thumbnailId init
Fields
Fields in SpdfFileDescription
- lastModified 0.0000000D
data of last modification (julday).
- length 0LL
file's length (in bytes).
- mimeType ''
MIME-type of file.
- name ''
name of file.
- thumbnailDescription obj_new()
description of thumbnail images when this file contains thumbnail images. Otherwise, NULL.
- thumbnailId ''
thumbnail description identifier when this file contains thumbnail images. Otherwise, ''.
- timeInterval obj_new()
time interval of data in file.
Routines
Routines from spdffiledescription__define.pro
result = SpdfFileDescription::init(name, mimeType, timeInterval, length, lastModified [, thumbnailDescription=SpdfThumbnailDescription] [, thumbnailId=SpdfThumbnailId])Creates an SpdfFileDescription object.
SpdfFileDescription::cleanupPerforms cleanup operations when this object is destroyed.
result = SpdfFileDescription::getName()Gets the file's name.
result = SpdfFileDescription::getMimeType()Gets the MIME-type of file.
result = SpdfFileDescription::getTimeInterval()Gets time interval of data in file.
result = SpdfFileDescription::getLength()Gets the file's length (in bytes).
result = SpdfFileDescription::getLastModified()Gets date the file was last modified.
result = SpdfFileDescription::getThumbnailDescription()Gets thumbnail description.
result = SpdfFileDescription::getThumbnailId()Gets thumbnail identifier.
result = SpdfFileDescription::getFile( [/buffer] [, filename=string] [, /string_array] [, callback_function=string] [, callback_data=reference])Retrieves this file from a remote HTTP or FTP server and writes it to disk, a memory buffer, or an array of strings.
SpdfFileDescription__defineDefines the SpdfFileDescription class.
Routine details
top source SpdfFileDescription::init
result = SpdfFileDescription::init(name, mimeType, timeInterval, length, lastModified [, thumbnailDescription=SpdfThumbnailDescription] [, thumbnailId=SpdfThumbnailId])
Creates an SpdfFileDescription object.
Return value
reference to an SpdfFileDescription object.
Parameters
- name in type=string
name of file.
- mimeType in type=string
(Multipurpose Internet Mail Extensions) MIME-type of file.
- timeInterval in type=SpdfTimeInterval
time interval of the data in this file.
- length in type=long64
length (in bytes) of file.
- lastModified in type=double
date file was last modified (julday value).
Keywords
- thumbnailDescription in optional type=SpdfThumbnailDescription
if file contains thumbnail images, then this describes them.
- thumbnailId in optional type=SpdfThumbnailId
if file contains thumbnail images, then this contains an opaque value that the server needs to provide full-sized versions of the images.
top source SpdfFileDescription::cleanup
SpdfFileDescription::cleanup
Performs cleanup operations when this object is destroyed.
top source SpdfFileDescription::getName
result = SpdfFileDescription::getName()
Gets the file's name.
Return value
filename value.
top source SpdfFileDescription::getMimeType
result = SpdfFileDescription::getMimeType()
Gets the MIME-type of file.
Return value
MIME-type value.
top source SpdfFileDescription::getTimeInterval
result = SpdfFileDescription::getTimeInterval()
Gets time interval of data in file.
Return value
time interval of data.
top source SpdfFileDescription::getLength
result = SpdfFileDescription::getLength()
Gets the file's length (in bytes).
Return value
file's length (bytes).
top source SpdfFileDescription::getLastModified
result = SpdfFileDescription::getLastModified()
Gets date the file was last modified.
Return value
date of last modification (julday value).
top source SpdfFileDescription::getThumbnailDescription
result = SpdfFileDescription::getThumbnailDescription()
Gets thumbnail description.
Return value
thumbnail description or NULL object reference if this file is not thumbnail images.
top source SpdfFileDescription::getThumbnailId
result = SpdfFileDescription::getThumbnailId()
Gets thumbnail identifier.
Return value
thumbnail identifier or an empty string if this file is not thumbnail images.
top source SpdfFileDescription::getFile
result = SpdfFileDescription::getFile( [/buffer] [, filename=string] [, /string_array] [, callback_function=string] [, callback_data=reference])
Retrieves this file from a remote HTTP or FTP server and writes it to disk, a memory buffer, or an array of strings. The returned data is written to disk in the location specified by the FILENAME keyword. If the filename is not specified, the local name will be the same as this file's name in the current working directory.
Return value
one of the following: A string containing the full path of the file retrieved from the remote HTTP or FTP server, A byte vector, if the BUFFER keyword is set, An array of strings, if the STRING_ARRAY keyword is set, A null string, if no data were returned by the method.
Keywords
- buffer in optional type=boolean default=false
if this keyword is set, the return value is a buffer and the FILENAME keyword is ignored.
- filename in optional type=string
set this keyword equal to a string that holds the file name and path where the retrieved file is locally stored. If FILENAME specifies a full path, the file is stored in the specified path. If FILENAME specifies a relative path, the path is relative to IDL's current working directory. If FILENAME is not present the file is stored in the current working directory under the name the basename of filename. If FILENAME is the same between calls, the last file received is overwritten.
- string_array in optional type=boolean default=false
set this keyword to treat the return value as an array of strings. If this keyword is set, the FILENAME and BUFFER keywords are ignored.
- callback_function in optional type=string
this keyword value is the name of the IDL function that is to be called during this retrieval operation. The callbacks provide feedback to the user about the ongoing operation, as well as provide a method to cancel an ongoing operation. If this keyword is not set, no callback to the caller is made. For information on creating a callback function, see "Using Callbacks with the IDLnetURL Object" in the IDL documentation.
- callback_data in optional type=reference
this keyword value contains data that is passed to the caller when a callback is made. The data contained in this variable is defined and set by the caller. The variable is passed, unmodified, directly to the caller as a parameter in the callback function. If this keyword is not set, the corresponding callback parameter's value is undefined.
File attributes
| Modification date: | Thu Feb 13 16:42:00 2014 |
| Lines: | 86 |