::: header

SSC R2.4 Web Services API

Generated by IDLdoc

:::

---

Overview Directory File Source {align=“top”} Etc Categories Search Index Help User documentation

---

single page{target=“_top”} | use frames{target=“_top”}     summary     class     fields     routine details     file attributes

::: content

./

spdfformatoptions__define.pro[]{.file-attributes}

\

::: {#file_comments} ::: small 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

Class description for SpdfFormatOptions

Properties

Properties in SpdfFormatOptions

::: details

cdf [init ]{.smaller}

:

dateFormat [init ]{.smaller}

:

degreeDigits [init ]{.smaller}

:

degreeFormat [init ]{.smaller}

:

distanceDigits [init ]{.smaller}

:

distanceFormat [init ]{.smaller}

:

latLonFormat [init ]{.smaller}

:

linesPerPage [init ]{.smaller}

:

timeFormat [init ]{.smaller}

:
::: :::

::: {#routine-details}

Routine details

::: {#SpdfFormatOptions::init .routine-details .details}

top{.top} source{.top} SpdfFormatOptions::init[]{.routine-attributes}

[result]{.var} = SpdfFormatOptions::init([ [dateFormat=[string]{.var}]]{.argument}[[,timeFormat=[string]{.var}]]{.argument}[[,distanceFormat=[string]{.var}]]{.argument}[[,distanceDigits=[int]{.var}]]{.argument}[[,degreeFormat=[string]{.var}]]{.argument}[[,degreeDigits=[int]{.var}]]{.argument}[[,latLonFormat=[string]{.var}]]{.argument}[ [, /cdf]]{.argument}[[,linesPerPage=[int]{.var}]]{.argument})

Return value

::: small reference to an SpdfFormatOptions object. :::

Keywords

dateFormat [in optional type=string default=‘yyyy_ddd’]{.smaller}

: 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’]{.smaller}

: specifies the format for time values (‘hh_hhhh’, ‘hh_mm_ss’, ‘hh_mm’)

distanceFormat [in optional type=string default=‘Km’]{.smaller}

: specifies the units for distance values (‘Re’, ‘Km’, ‘IntegerKm’, ‘ScientificNotationKm’)

distanceDigits [in optional type=int default=2]{.smaller}

: specifies the number of decimal places to include when displaying distance values in scientific notation.

degreeFormat [in optional type=string default=‘Decimal’]{.smaller}

: specifies the format for degree values (‘Decimal’, ‘Minutes’, ‘MinutesSeconds’)

degreeDigits [in optional type=int default=2]{.smaller}

: specifies the number of decimal places to include when displaying degree values.

latLonFormat [in optional type=string default=‘Lat90Lon360’]{.smaller}

: specifies the format for direction/range values (‘Lat90Lon360’, ‘Lat90Lon180’, ‘Lat90SnLon180We’)

cdf [in optional type=boolean default=false]{.smaller}

: boolean value indicating whether the output should be a CDF file.

linesPerPage [in optional type=int default=55]{.smaller}

: specifies the number of lines per page for text output. :::

::: {#SpdfFormatOptions::cleanup .routine-details .details}

top{.top} source{.top} SpdfFormatOptions::cleanup[]{.routine-attributes}

SpdfFormatOptions::cleanup

:::

::: {#SpdfFormatOptions::getDateFormat .routine-details .details}

top{.top} source{.top} SpdfFormatOptions::getDateFormat[]{.routine-attributes}

[result]{.var} = SpdfFormatOptions::getDateFormat()

Return value

::: small dateFormat value. ::: :::

::: {#SpdfFormatOptions::getTimeFormat .routine-details .details}

top{.top} source{.top} SpdfFormatOptions::getTimeFormat[]{.routine-attributes}

[result]{.var} = SpdfFormatOptions::getTimeFormat()

Return value

::: small timeFormat value. ::: :::

::: {#SpdfFormatOptions::getDistanceFormat .routine-details .details}

top{.top} source{.top} SpdfFormatOptions::getDistanceFormat[]{.routine-attributes}

[result]{.var} = SpdfFormatOptions::getDistanceFormat()

Return value

::: small distanceFormat value. ::: :::

::: {#SpdfFormatOptions::getDistanceDigits .routine-details .details}

top{.top} source{.top} SpdfFormatOptions::getDistanceDigits[]{.routine-attributes}

[result]{.var} = SpdfFormatOptions::getDistanceDigits()

Return value

::: small distanceDigits value. ::: :::

::: {#SpdfFormatOptions::getDegreeFormat .routine-details .details}

top{.top} source{.top} SpdfFormatOptions::getDegreeFormat[]{.routine-attributes}

[result]{.var} = SpdfFormatOptions::getDegreeFormat()

Return value

::: small degreeFormat value. ::: :::

::: {#SpdfFormatOptions::getDegreeDigits .routine-details .details}

top{.top} source{.top} SpdfFormatOptions::getDegreeDigits[]{.routine-attributes}

[result]{.var} = SpdfFormatOptions::getDegreeDigits()

Return value

::: small degreeDigits value. ::: :::

::: {#SpdfFormatOptions::getLatLonFormat .routine-details .details}

top{.top} source{.top} SpdfFormatOptions::getLatLonFormat[]{.routine-attributes}

[result]{.var} = SpdfFormatOptions::getLatLonFormat()

Return value

::: small latLonFormat value. ::: :::

::: {#SpdfFormatOptions::getCdf .routine-details .details}

top{.top} source{.top} SpdfFormatOptions::getCdf[]{.routine-attributes}

[result]{.var} = SpdfFormatOptions::getCdf()

Return value

::: small cdf value. ::: :::

::: {#SpdfFormatOptions::getLinesPerPage .routine-details .details}

top{.top} source{.top} SpdfFormatOptions::getLinesPerPage[]{.routine-attributes}

[result]{.var} = SpdfFormatOptions::getLinesPerPage()

Return value

::: small linesPerPage value. ::: :::

::: {#SpdfFormatOptions::createDomElement .routine-details .details}

top{.top} source{.top} SpdfFormatOptions::createDomElement[]{.routine-attributes}

[result]{.var} = SpdfFormatOptions::createDomElement([doc]{.argument})

Return value

::: small a reference to a new IDLffXMLDOMElement representation of this object. :::

Parameters

doc [in type=IDLffXMLDOMDocument ]{.smaller}

: document in which to create the DataRequest element. :::

::: {#SpdfFormatOptions__define .routine-details .details}

top{.top} source{.top} SpdfFormatOptions__define[]{.routine-attributes}

SpdfFormatOptions__define

::: :::

::: {#attributes}

File attributes

---

Modification date: Fri May 13 08:54:13 2022 Lines: 164

---

:::

SSC Feedback. :::

::: footer

---

Produced by IDLdoc 3.6.4 on Mon Apr 8 09:50:59 2024 IDLdoc project information{target=“_top”}

---

:::