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

./

spdfregionoptions__define.pro[]{.file-attributes}

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

Properties

Properties in SpdfRegionOptions

::: details

northBTracedFootpoint [init ]{.smaller}

radialTracedFootpoint [init ]{.smaller}

southBTracedFootpoint [init ]{.smaller}

spacecraft [init ]{.smaller}

:
::: :::

Routines

Routines from spdfregionoptions__define.pro

[result]{.var} = SpdfRegionOptions::init([ [/spacecraft]]{.argument}[ [, /radialTracedFootpoint]]{.argument}[ [, /northBTracedFootpoint]]{.argument}[ [, /southBTracedFootpoint]]{.argument})

: Creates an SpdfRegionOptions object.

SpdfRegionOptions::cleanup

: Performs cleanup operations when this object is destroyed.

[result]{.var} = SpdfRegionOptions::getSpacecraft()

: Gets the spacecraft value.

[result]{.var} = SpdfRegionOptions::getRadialTracedFootpoint()

: Gets the radial traced footpoint value.

[result]{.var} = SpdfRegionOptions::getNorthBTracedFootpoint()

: Gets the north B traced footpoint value.

[result]{.var} = SpdfRegionOptions::getSouthBTracedFootpoint()

: Gets the south B traced footpoint value.

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

: Creates an RegionOptions element using the given XML DOM document with the values of this object.

SpdfRegionOptions__define

: Defines the SpdfRegionOptions class.

::: {#routine-details}

Routine details

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

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

Creates an SpdfRegionOptions object.

Return value

::: small reference to an SpdfRegionOptions object. :::

Keywords

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

: specifies whether the spacecraft regions are to be included in the output.

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

: specifies whether the radial traced footpoint regions are to be included in the output.

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

: specifies whether the north B traced footpoint regions are to be included in the output.

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

: specifies whether the south B traced footpoint regions are to be included in the output. :::

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

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

SpdfRegionOptions::cleanup

Performs cleanup operations when this object is destroyed.

:::

::: {#SpdfRegionOptions::getSpacecraft .routine-details .details}

top{.top} source{.top} SpdfRegionOptions::getSpacecraft[]{.routine-attributes}

[result]{.var} = SpdfRegionOptions::getSpacecraft()

Gets the spacecraft value.

Return value

::: small spacecraft value. ::: :::

::: {#SpdfRegionOptions::getRadialTracedFootpoint .routine-details .details}

top{.top} source{.top} SpdfRegionOptions::getRadialTracedFootpoint[]{.routine-attributes}

[result]{.var} = SpdfRegionOptions::getRadialTracedFootpoint()

Gets the radial traced footpoint value.

Return value

::: small radial traced footpoint value. ::: :::

::: {#SpdfRegionOptions::getNorthBTracedFootpoint .routine-details .details}

top{.top} source{.top} SpdfRegionOptions::getNorthBTracedFootpoint[]{.routine-attributes}

[result]{.var} = SpdfRegionOptions::getNorthBTracedFootpoint()

Gets the north B traced footpoint value.

Return value

::: small north B traced footpoint value. ::: :::

::: {#SpdfRegionOptions::getSouthBTracedFootpoint .routine-details .details}

top{.top} source{.top} SpdfRegionOptions::getSouthBTracedFootpoint[]{.routine-attributes}

[result]{.var} = SpdfRegionOptions::getSouthBTracedFootpoint()

Gets the south B traced footpoint value.

Return value

::: small south B traced footpoint value. ::: :::

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

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

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

Creates an RegionOptions 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. :::

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

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

SpdfRegionOptions__define

Defines the SpdfRegionOptions class.

::: :::

::: {#attributes}

File attributes

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

:::

SSC Feedback. :::

::: footer

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

:::