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

./

spdfrequest__define.pro[]{.file-attributes}

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

Author information

Author

: B. Harris

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

Class description for SpdfRequest

Subclasses: SpdfLocationRequest

Properties

Properties in SpdfRequest

::: details

bFieldModel [init ]{.smaller}

description [init ]{.smaller}

:
::: :::

Routines

Routines from spdfrequest__define.pro

[result]{.var} = SpdfRequest::init([timeInterval]{.argument}[ [, description=[string]{.var}]]{.argument}[ [, bFieldModel=[SpdfBFieldModel]{.var}]]{.argument})

: Creates an SpdfRequest object.

SpdfRequest::cleanup

: Performs cleanup operations when this object is destroyed.

[result]{.var} = SpdfRequest::getDescription()

: Gets the description value.

[result]{.var} = SpdfRequest::getTimeInterval()

: Gets the timeInterval value.

[result]{.var} = SpdfRequest::getBFieldModel()

: Gets the bFieldModel value.

[result]{.var} = SpdfRequest::createDomElement([doc]{.argument}[, subClassName]{.argument})

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

SpdfRequest__define

: Defines the SpdfRequest class.

::: {#routine-details}

Routine details

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

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

[result]{.var} = SpdfRequest::init([timeInterval]{.argument}[[,description=[string]{.var}]]{.argument}[[,bFieldModel=[SpdfBFieldModel]{.var}]]{.argument})

Creates an SpdfRequest object.

Return value

::: small reference to an SpdfRequest object. :::

Parameters

timeInterval [in type=SpdfTimeInterval ]{.smaller}

: time interval of this request.

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, the Tsyganenko 89c model is used. :::

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

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

SpdfRequest::cleanup

Performs cleanup operations when this object is destroyed.

:::

::: {#SpdfRequest::getDescription .routine-details .details}

top{.top} source{.top} SpdfRequest::getDescription[]{.routine-attributes}

[result]{.var} = SpdfRequest::getDescription()

Gets the description value.

Return value

::: small description value. ::: :::

::: {#SpdfRequest::getTimeInterval .routine-details .details}

top{.top} source{.top} SpdfRequest::getTimeInterval[]{.routine-attributes}

[result]{.var} = SpdfRequest::getTimeInterval()

Gets the timeInterval value.

Return value

::: small reference to timeInterval ::: :::

::: {#SpdfRequest::getBFieldModel .routine-details .details}

top{.top} source{.top} SpdfRequest::getBFieldModel[]{.routine-attributes}

[result]{.var} = SpdfRequest::getBFieldModel()

Gets the bFieldModel value.

Return value

::: small reference to bFieldModel ::: :::

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

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

[result]{.var} = SpdfRequest::createDomElement([doc]{.argument}[, subClassName]{.argument})

Creates a Request 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 Request element.

subClassName [in type=string ]{.smaller}

: name of sub-class. :::

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

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

SpdfRequest__define

Defines the SpdfRequest class.

::: :::

::: {#attributes}

File attributes

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

:::

SSC Feedback. :::

::: footer

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

:::