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

./

spdflocationrequest__define.pro[]{.file-attributes}

::: {#file_comments} ::: small This class is an IDL representation of the LocationRequest 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 SpdfLocationRequest

Inheritance

SpdfRequest

Subclasses: SpdfSscDataRequest

Properties

Properties in SpdfLocationRequest

::: details

bFieldModel [init ]{.smaller}

description [init ]{.smaller}

:
::: :::

Routines

Methods inherited from SpdfRequest

Routines from spdflocationrequest__define.pro

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

: Creates an SpdfLocationRequest object.

SpdfLocationRequest::cleanup

: Performs cleanup operations when this object is destroyed.

[result]{.var} = SpdfLocationRequest::getSatellites()

: Gets the satellites.

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

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

SpdfLocationRequest__define

: Defines the SpdfLocationRequest class.

::: {#routine-details}

Routine details

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

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

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

Creates an SpdfLocationRequest object.

Return value

::: small reference to an SpdfLocationRequest object. :::

Parameters

timeInterval [in type=SpdfTimeInterval ]{.smaller}

: time interval of this request.

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

: requested satellites.

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

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

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

SpdfLocationRequest::cleanup

Performs cleanup operations when this object is destroyed.

:::

::: {#SpdfLocationRequest::getSatellites .routine-details .details}

top{.top} source{.top} SpdfLocationRequest::getSatellites[]{.routine-attributes}

[result]{.var} = SpdfLocationRequest::getSatellites()

Gets the satellites.

Return value

::: small objarr containing satellites or objarr(1) whose first element is !obj_valid(). ::: :::

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

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

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

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

subClassName [in ]{.smaller}

: {type=string] sub-class name. :::

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

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

SpdfLocationRequest__define

Defines the SpdfLocationRequest class.

::: :::

::: {#attributes}

File attributes

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

:::

SSC Feedback. :::

::: footer

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

:::