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

./

spdfoutputoptions__define.pro[]{.file-attributes}

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

Author information

Author

: B. Harris

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

Properties

Properties in SpdfOutputOptions

::: details

allLocationFilters [init ]{.smaller}

bFieldTraceOptions [init ]{.smaller}

distanceFromOptions [init ]{.smaller}

minMaxPoints [init ]{.smaller}

regionOptions [init ]{.smaller}

valueOptions [init ]{.smaller}

:
::: :::

Routines

Routines from spdfoutputoptions__define.pro

[result]{.var} = SpdfOutputOptions::init([coordinateOptions]{.argument}[ [, /allLocationFilters]]{.argument}[ [, regionOptions=[SpdfRegionOptions]{.var}]]{.argument}[ [, valueOptions=[SpdfValueOptions]{.var}]]{.argument}[ [, distanceFromOptions=[distanceFromOptions]{.var}]]{.argument}[ [, minMaxPoints=[int]{.var}]]{.argument}[ [, bFieldTraceOptions=[objarr of SpdfBFieldTraceOptions]{.var}]]{.argument})

: Creates an SpdfOutputOptions object.

SpdfOutputOptions::cleanup

: Performs cleanup operations when this object is destroyed.

[result]{.var} = SpdfOutputOptions::getAllLocationFilters()

: Gets the all-location-filters value.

[result]{.var} = SpdfOutputOptions::getCoordinateOptions()

: Gets the coordinate options value.

[result]{.var} = SpdfOutputOptions::getRegionOptions()

: Gets the region options value.

[result]{.var} = SpdfOutputOptions::getValueOptions()

: Gets the ValueOptions value.

[result]{.var} = SpdfOutputOptions::getDistanceFromOptions()

: Gets the DistanceFromOptions value.

[result]{.var} = SpdfOutputOptions::getMinMaxPoints()

: Gets the minMaxPoints value.

[result]{.var} = SpdfOutputOptions::getBFieldTraceOptions()

: Gets the BFieldTraceOptions value.

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

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

SpdfOutputOptions__define

: Defines the SpdfOutputOptions class.

::: {#routine-details}

Routine details

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

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

[result]{.var} = SpdfOutputOptions::init([coordinateOptions]{.argument}[ [, /allLocationFilters]]{.argument}[[,regionOptions=[SpdfRegionOptions]{.var}]]{.argument}[[,valueOptions=[SpdfValueOptions]{.var}]]{.argument}[[,distanceFromOptions=[distanceFromOptions]{.var}]]{.argument}[[,minMaxPoints=[int]{.var}]]{.argument}[[,bFieldTraceOptions=[objarr of SpdfBFieldTraceOptions]{.var}]]{.argument})

Creates an SpdfOutputOptions object.

Return value

::: small reference to an SpdfOutputOptions object. :::

Parameters

coordinateOptions [in type=objarr of SpdfCoordinateOptions ]{.smaller}

: specifies the coordinate options.

Keywords

allLocationFilters [in optional type=boolean default=true]{.smaller}

: specifies whether all or just one or more of the specified location filters must be satisfied.

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

: specifies the region options.

valueOptions [in optional type=SpdfValueOptions ]{.smaller}

: specifies the value options.

distanceFromOptions [in optional ]{.smaller}

: {type=SpdfDistanceFromOptions) specifies distance-from options.

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

: number of points used to determine minima or maxima values.

bFieldTraceOptions [in optional type=objarr of SpdfBFieldTraceOptions ]{.smaller}

: magnetic field trace options :::

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

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

SpdfOutputOptions::cleanup

Performs cleanup operations when this object is destroyed.

:::

::: {#SpdfOutputOptions::getAllLocationFilters .routine-details .details}

top{.top} source{.top} SpdfOutputOptions::getAllLocationFilters[]{.routine-attributes}

[result]{.var} = SpdfOutputOptions::getAllLocationFilters()

Gets the all-location-filters value.

Return value

::: small all-location-filters value. ::: :::

::: {#SpdfOutputOptions::getCoordinateOptions .routine-details .details}

top{.top} source{.top} SpdfOutputOptions::getCoordinateOptions[]{.routine-attributes}

[result]{.var} = SpdfOutputOptions::getCoordinateOptions()

Gets the coordinate options value.

Return value

::: small objarr of CoordinateOptions or an objarr(1) whose first element is ~obj_valid(). ::: :::

::: {#SpdfOutputOptions::getRegionOptions .routine-details .details}

top{.top} source{.top} SpdfOutputOptions::getRegionOptions[]{.routine-attributes}

[result]{.var} = SpdfOutputOptions::getRegionOptions()

Gets the region options value.

Return value

::: small RegionOptions or a null object reference. ::: :::

::: {#SpdfOutputOptions::getValueOptions .routine-details .details}

top{.top} source{.top} SpdfOutputOptions::getValueOptions[]{.routine-attributes}

[result]{.var} = SpdfOutputOptions::getValueOptions()

Gets the ValueOptions value.

Return value

::: small ValueOptions or a null object reference. ::: :::

::: {#SpdfOutputOptions::getDistanceFromOptions .routine-details .details}

top{.top} source{.top} SpdfOutputOptions::getDistanceFromOptions[]{.routine-attributes}

[result]{.var} = SpdfOutputOptions::getDistanceFromOptions()

Gets the DistanceFromOptions value.

Return value

::: small DistanceFromOptions value or a null object reference. ::: :::

::: {#SpdfOutputOptions::getMinMaxPoints .routine-details .details}

top{.top} source{.top} SpdfOutputOptions::getMinMaxPoints[]{.routine-attributes}

[result]{.var} = SpdfOutputOptions::getMinMaxPoints()

Gets the minMaxPoints value.

Return value

::: small minMaxPoints value or a null object reference. ::: :::

::: {#SpdfOutputOptions::getBFieldTraceOptions .routine-details .details}

top{.top} source{.top} SpdfOutputOptions::getBFieldTraceOptions[]{.routine-attributes}

[result]{.var} = SpdfOutputOptions::getBFieldTraceOptions()

Gets the BFieldTraceOptions value.

Return value

::: small objarr containing BFieldTraceOptions or objarr(1) whose first element is ~obj_valid. ::: :::

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

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

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

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

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

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

SpdfOutputOptions__define

Defines the SpdfOutputOptions class.

::: :::

::: {#attributes}

File attributes

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

:::

SSC Feedback. :::

::: footer

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

:::