![[attach.png]](idldoc-resources/attach.png)
./
spdfformatoptions__define.pro
This class is an IDL representation of the FormatOptions element from the Satellite Situation Center (SSC) XML schema.
Author information
- Author
B. Harris
- Copyright
Copyright (c) 2014 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 SpdfFormatOptions
Properties
Properties in SpdfFormatOptions
- cdf init
- dateFormat init
- degreeDigits init
- degreeFormat init
- distanceDigits init
- distanceFormat init
- latLonFormat init
- linesPerPage init
- timeFormat init
Routines
Routines from spdfformatoptions__define.pro
result = SpdfFormatOptions::init( [dateFormat=string] [, timeFormat=string] [, distanceFormat=string] [, distanceDigits=int] [, degreeFormat=string] [, degreeDigits=int] [, latLonFormat=string] [, /cdf] [, linesPerPage=int])Creates an SpdfFormatOptions object.
SpdfFormatOptions::cleanupPerforms cleanup operations when this object is destroyed.
result = SpdfFormatOptions::getDateFormat()Gets the dateFormat value.
result = SpdfFormatOptions::getTimeFormat()Gets the timeFormat value.
result = SpdfFormatOptions::getDistanceFormat()Gets the distanceFormat value.
result = SpdfFormatOptions::getDistanceDigits()Gets the distanceDigits value.
result = SpdfFormatOptions::getDegreeFormat()Gets the degreeFormat value.
result = SpdfFormatOptions::getDegreeDigits()Gets the degreeDigits value.
result = SpdfFormatOptions::getLatLonFormat()Gets the latLonFormat value.
result = SpdfFormatOptions::getCdf()Gets the cdf value.
result = SpdfFormatOptions::getLinesPerPage()Gets the linesPerPage value.
result = SpdfFormatOptions::createDomElement(doc)Creates an FormatOptions element using the given XML DOM document with the values of this object.
SpdfFormatOptions__defineDefines the SpdfFormatOptions class.
Routine details
top source SpdfFormatOptions::init
result = SpdfFormatOptions::init( [dateFormat=string] [, timeFormat=string] [, distanceFormat=string] [, distanceDigits=int] [, degreeFormat=string] [, degreeDigits=int] [, latLonFormat=string] [, /cdf] [, linesPerPage=int])
Creates an SpdfFormatOptions object.
Return value
reference to an SpdfFormatOptions object.
Keywords
- dateFormat in optional type=string default='yyyy_ddd'
specifies the format for date values ('yyyy_ddd', 'yy_mm_dd', 'yy_Mmm_dd', 'yy_CMMM_dd')
- timeFormat in optional type=string default='hh_hhhh'
specifies the format for time values ('hh_hhhh', 'hh_mm_ss', 'hh_mm')
- distanceFormat in optional type=string default='Km'
specifies the units for distance values ('Re', 'Km', 'IntegerKm', 'ScientificNotationKm')
- distanceDigits in optional type=int default=2
specifies the number of decimal places to include when displaying distance values in scientific notation.
- degreeFormat in optional type=string default='Decimal'
specifies the format for degree values ('Decimal', 'Minutes', 'MinutesSeconds')
- degreeDigits in optional type=int default=2
specifies the number of decimal places to include when displaying degree values.
- latLonFormat in optional type=string default='Lat90Lon360'
specifies the format for direction/range values ('Lat90Lon360', 'Lat90Lon180', 'Lat90SnLon180We')
- cdf in optional type=boolean default=false
boolean value indicating whether the output should be a CDF file.
- linesPerPage in optional type=int default=55
specifies the number of lines per page for text output.
top source SpdfFormatOptions::cleanup
SpdfFormatOptions::cleanup
Performs cleanup operations when this object is destroyed.
top source SpdfFormatOptions::getDateFormat
result = SpdfFormatOptions::getDateFormat()
Gets the dateFormat value.
Return value
dateFormat value.
top source SpdfFormatOptions::getTimeFormat
result = SpdfFormatOptions::getTimeFormat()
Gets the timeFormat value.
Return value
timeFormat value.
top source SpdfFormatOptions::getDistanceFormat
result = SpdfFormatOptions::getDistanceFormat()
Gets the distanceFormat value.
Return value
distanceFormat value.
top source SpdfFormatOptions::getDistanceDigits
result = SpdfFormatOptions::getDistanceDigits()
Gets the distanceDigits value.
Return value
distanceDigits value.
top source SpdfFormatOptions::getDegreeFormat
result = SpdfFormatOptions::getDegreeFormat()
Gets the degreeFormat value.
Return value
degreeFormat value.
top source SpdfFormatOptions::getDegreeDigits
result = SpdfFormatOptions::getDegreeDigits()
Gets the degreeDigits value.
Return value
degreeDigits value.
top source SpdfFormatOptions::getLatLonFormat
result = SpdfFormatOptions::getLatLonFormat()
Gets the latLonFormat value.
Return value
latLonFormat value.
top source SpdfFormatOptions::getCdf
result = SpdfFormatOptions::getCdf()
Gets the cdf value.
Return value
cdf value.
top source SpdfFormatOptions::getLinesPerPage
result = SpdfFormatOptions::getLinesPerPage()
Gets the linesPerPage value.
Return value
linesPerPage value.
top source SpdfFormatOptions::createDomElement
result = SpdfFormatOptions::createDomElement(doc)
Creates an FormatOptions element using the given XML DOM document with the values of this object.
Return value
a reference to a new IDLffXMLDOMElement representation of this object.
Parameters
- doc in type=IDLffXMLDOMDocument
document in which to create the DataRequest element.
File attributes
| Modification date: | Fri May 13 08:54:13 2022 |
| Lines: | 164 |
SSC Feedback.