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

./

spdfbfieldtraceoptions__define.pro[]{.file-attributes}

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

Properties

Properties in SpdfBFieldTraceOptions

::: details

coordinateSystem [init ]{.smaller}

fieldLineLength [init ]{.smaller}

footpointLatitude [init ]{.smaller}

footpointLongitude [init ]{.smaller}

hemisphere [init ]{.smaller}

:
::: :::

Routines

Routines from spdfbfieldtraceoptions__define.pro

[result]{.var} = SpdfBFieldTraceOptions::init([ [coordinateSystem=[string]{.var}]]{.argument}[ [, hemisphere=[string]{.var}]]{.argument}[ [, /footpointLatitude]]{.argument}[ [, /footpointLongitude]]{.argument}[ [, /fieldLineLength]]{.argument})

: Creates an SpdfBFieldTraceOptions object.

SpdfBFieldTraceOptions::cleanup

: Performs cleanup operations when this object is destroyed.

[result]{.var} = SpdfBFieldTraceOptions::getCoordinateSystem()

: Gets the coordinate system value.

[result]{.var} = SpdfBFieldTraceOptions::getHemisphere()

: Gets the hemisphere value.

[result]{.var} = SpdfBFieldTraceOptions::getFootpointLatitude()

: Gets the footpoint latitude value.

[result]{.var} = SpdfBFieldTraceOptions::getFootpointLongitude()

: Gets the footpoint longitude value.

[result]{.var} = SpdfBFieldTraceOptions::getFieldLineLength()

: Gets the field-line length value.

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

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

SpdfBFieldTraceOptions__define

: Defines the SpdfBFieldTraceOptions class.

::: {#routine-details}

Routine details

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

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

[result]{.var} = SpdfBFieldTraceOptions::init([ [coordinateSystem=[string]{.var}]]{.argument}[[,hemisphere=[string]{.var}]]{.argument}[ [, /footpointLatitude]]{.argument}[ [, /footpointLongitude]]{.argument}[ [, /fieldLineLength]]{.argument})

Creates an SpdfBFieldTraceOptions object.

Return value

::: small reference to an SpdfBFieldTraceOptions object. :::

Keywords

coordinateSystem [in optional type=string default=‘Gse’]{.smaller}

: specifies the coordinate system is to be included in the output.

hemisphere [in optional type=string default=‘North’]{.smaller}

: specifies the hemisphere to be included in the output.

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

: specifies whether the footpoint latitude value is to be included in the output.

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

: specifies whether the footpoint longitude value is to be included in the output.

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

: specifies whether the field line length value is to be included in the output. :::

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

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

SpdfBFieldTraceOptions::cleanup

Performs cleanup operations when this object is destroyed.

:::

::: {#SpdfBFieldTraceOptions::getCoordinateSystem .routine-details .details}

top{.top} source{.top} SpdfBFieldTraceOptions::getCoordinateSystem[]{.routine-attributes}

[result]{.var} = SpdfBFieldTraceOptions::getCoordinateSystem()

Gets the coordinate system value.

Return value

::: small coordinate system value. ::: :::

::: {#SpdfBFieldTraceOptions::getHemisphere .routine-details .details}

top{.top} source{.top} SpdfBFieldTraceOptions::getHemisphere[]{.routine-attributes}

[result]{.var} = SpdfBFieldTraceOptions::getHemisphere()

Gets the hemisphere value.

Return value

::: small hemisphere value. ::: :::

::: {#SpdfBFieldTraceOptions::getFootpointLatitude .routine-details .details}

top{.top} source{.top} SpdfBFieldTraceOptions::getFootpointLatitude[]{.routine-attributes}

[result]{.var} = SpdfBFieldTraceOptions::getFootpointLatitude()

Gets the footpoint latitude value.

Return value

::: small footpoint latitude value. ::: :::

::: {#SpdfBFieldTraceOptions::getFootpointLongitude .routine-details .details}

top{.top} source{.top} SpdfBFieldTraceOptions::getFootpointLongitude[]{.routine-attributes}

[result]{.var} = SpdfBFieldTraceOptions::getFootpointLongitude()

Gets the footpoint longitude value.

Return value

::: small footpoint longitude value. ::: :::

::: {#SpdfBFieldTraceOptions::getFieldLineLength .routine-details .details}

top{.top} source{.top} SpdfBFieldTraceOptions::getFieldLineLength[]{.routine-attributes}

[result]{.var} = SpdfBFieldTraceOptions::getFieldLineLength()

Gets the field-line length value.

Return value

::: small field-line length value. ::: :::

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

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

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

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

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

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

SpdfBFieldTraceOptions__define

Defines the SpdfBFieldTraceOptions class.

::: :::

::: {#attributes}

File attributes

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

:::

SSC Feedback. :::

::: footer

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

:::