::: header

SSC R2.4 Web Services API

Generated by IDLdoc

:::

Overview Directory File Source [attach.png] {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

./

spdfsscdatarequest__define.pro[]{.file-attributes}

::: {#file_comments} ::: small This class is an IDL representation of the DataRequest element from the Satellite Situation Center (SSC) XML schema. ::: :::

Author information

Author

: B. Harris

: Copyright (c) 2013-2016 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 SpdfSscDataRequest

Inheritance

SpdfLocationRequest

All ancestor classes: SpdfLocationRequest SpdfRequest

Properties

Properties in SpdfSscDataRequest

::: details

bFieldModel [init ]{.smaller}

description [init ]{.smaller}

formatOptions [init ]{.smaller}

locationFilterOptions [init ]{.smaller}

regionOptions [init ]{.smaller}

:
::: :::

Routines

Methods inherited from SpdfRequest

Methods inherited from SpdfLocationRequest

Routines from spdfsscdatarequest__define.pro

[result]{.var} = SpdfSscDataRequest::init([timeInterval]{.argument}[, satellites]{.argument}[, outputOptions]{.argument}[ [, description=[string]{.var}]]{.argument}[ [, bFieldModel=[SpdfBFieldModel]{.var}]]{.argument}[ [, regionOptions=[SpdfRegionOptions]{.var}]]{.argument}[ [, locationFilterOptions=[SpdfLocationFilterOptions]{.var}]]{.argument}[ [, formatOptions=[SpdfFormatOptions]{.var}]]{.argument})

: Creates an SpdfSscDataRequest object.

SpdfSscDataRequest::cleanup

: Performs cleanup operations when this object is destroyed.

[result]{.var} = SpdfSscDataRequest::getOutputOptions()

: Gets the output options.

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

: Creates a DataRequest element using the given XML DOM document with the values of this object.

SpdfSscDataRequest__define

: Defines the SpdfSscDataRequest class.

::: {#routine-details}

Routine details

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

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

[result]{.var} = SpdfSscDataRequest::init([timeInterval]{.argument}[, satellites]{.argument}[, outputOptions]{.argument}[[,description=[string]{.var}]]{.argument}[[,bFieldModel=[SpdfBFieldModel]{.var}]]{.argument}[[,regionOptions=[SpdfRegionOptions]{.var}]]{.argument}[[,locationFilterOptions=[SpdfLocationFilterOptions]{.var}]]{.argument}[[,formatOptions=[SpdfFormatOptions]{.var}]]{.argument})

Creates an SpdfSscDataRequest object.

Return value

::: small reference to an SpdfSscDataRequest object. :::

Parameters

timeInterval [in type=SpdfTimeInterval ]{.smaller}

: time interval of this request.

satellites [in type=SpdfSatelliteSpecification objarr ]{.smaller}

: requested satellites.

outputOptions [in type=SpdfOutputOptions ]{.smaller}

: requested output options.

Keywords

description [in optional type=string ]{.smaller}

: a textual description of this request.

bFieldModel [in optional type=SpdfBFieldModel ]{.smaller}

: magnetic field model to use. If not given, a default model of IGRF and Tsyganenko 89c with KP values of 3-,3,3+ is used.

regionOptions [in optional type=SpdfRegionOptions ]{.smaller}

: requested region options.

locationFilterOptions [in optional type=SpdfLocationFilterOptions ]{.smaller}

: requested location filter options.

formatOptions [in optional type=SpdfFormatOptions ]{.smaller}

: requested format options. :::

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

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

SpdfSscDataRequest::cleanup

Performs cleanup operations when this object is destroyed.

:::

::: {#SpdfSscDataRequest::getOutputOptions .routine-details .details}

top{.top} source{.top} SpdfSscDataRequest::getOutputOptions[]{.routine-attributes}

[result]{.var} = SpdfSscDataRequest::getOutputOptions()

Gets the output options.

Return value

::: small reference to output options. ::: :::

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

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

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

Creates a DataRequest element using the given XML DOM document with the values of this object.

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. :::

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

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

SpdfSscDataRequest__define

Defines the SpdfSscDataRequest class.

::: :::

::: {#attributes}

File attributes

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

:::

SSC Feedback. :::

::: footer

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

:::