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

./

spdfbtracedata__define.pro[]{.file-attributes}

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

Properties

Properties in SpdfBTraceData

::: details

arcLength [init ]{.smaller}

latitude [init ]{.smaller}

longitude [init ]{.smaller}

:
::: :::

Routines

Routines from spdfbtracedata__define.pro

[result]{.var} = SpdfBTraceData::init([coordinateSystem]{.argument}[, hemisphere]{.argument}[, latitude=[fltarr]{.var}]{.argument}[, longitude=[fltarr]{.var}]{.argument}[, arcLength=[dblarr]{.var}]{.argument})

: Creates an SpdfBTraceData object.

SpdfBTraceData::cleanup

: Performs cleanup operations when this object is destroyed.

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

: Gets the coordinate system value.

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

: Gets the hemisphere value.

[result]{.var} = SpdfBTraceData::getLatitude()

: Gets the latitude values.

[result]{.var} = SpdfBTraceData::getLongitude()

: Gets the longitude values.

[result]{.var} = SpdfBTraceData::getArcLength()

: Gets the ArcLength values.

SpdfBTraceData__define

: Defines the SpdfBTraceData class.

::: {#routine-details}

Routine details

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

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

[result]{.var} = SpdfBTraceData::init([coordinateSystem]{.argument}[, hemisphere]{.argument}[, latitude=[fltarr]{.var}]{.argument}[, longitude=[fltarr]{.var}]{.argument}[, arcLength=[dblarr]{.var}]{.argument})

Creates an SpdfBTraceData object.

Return value

::: small reference to an SpdfBTraceData object. :::

Parameters

coordinateSystem [in type=string ]{.smaller}

: coordinate system.

hemisphere [in type=string ]{.smaller}

: hemisphere.

Keywords

latitude [in type=fltarr ]{.smaller}

: latitude values.

longitude [in type=fltarr ]{.smaller}

: longitude values.

arcLength [in type=dblarr ]{.smaller}

: arc length values. :::

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

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

SpdfBTraceData::cleanup

Performs cleanup operations when this object is destroyed.

:::

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

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

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

Gets the coordinate system value.

Return value

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

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

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

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

Gets the hemisphere value.

Return value

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

::: {#SpdfBTraceData::getLatitude .routine-details .details}

top{.top} source{.top} SpdfBTraceData::getLatitude[]{.routine-attributes}

[result]{.var} = SpdfBTraceData::getLatitude()

Gets the latitude values.

Return value

::: small a fltarr contain latitude values or the scalar constant !values.d_NaN if there are no values. ::: :::

::: {#SpdfBTraceData::getLongitude .routine-details .details}

top{.top} source{.top} SpdfBTraceData::getLongitude[]{.routine-attributes}

[result]{.var} = SpdfBTraceData::getLongitude()

Gets the longitude values.

Return value

::: small a fltarr contain longitude values or the scalar constant !values.d_NaN if there are no values. ::: :::

::: {#SpdfBTraceData::getArcLength .routine-details .details}

top{.top} source{.top} SpdfBTraceData::getArcLength[]{.routine-attributes}

[result]{.var} = SpdfBTraceData::getArcLength()

Gets the ArcLength values.

Return value

::: small a dblarr contain ArcLength values or the scalar constant !values.d_NaN if there are no values. ::: :::

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

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

SpdfBTraceData__define

Defines the SpdfBTraceData class.

::: :::

::: {#attributes}

File attributes

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

:::

SSC Feedback. :::

::: footer

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

:::