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

./

spdfbfieldmodel__define.pro[]{.file-attributes}

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

Author information

Author

: B. Harris

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

Properties

Properties in SpdfBFieldModel

::: details

externalBFieldModel [init ]{.smaller}

internalBFieldModel [init ]{.smaller}

traceStopAltitude [init ]{.smaller}

:
::: :::

Routines

Routines from spdfbfieldmodel__define.pro

[result]{.var} = SpdfBFieldModel::init([internalBFieldModel=[string]{.var}]{.argument}[, externalBFieldModel=[SpdfExternalBFieldModel]{.var}]{.argument}[ [, traceStopAltitude=[int]{.var}]]{.argument})

: Creates an SpdfBFieldModel object.

SpdfBFieldModel::cleanup

: Performs cleanup operations when this object is destroyed.

[result]{.var} = SpdfBFieldModel::getInternalBFieldModel()

: Gets the internal B field model value.

[result]{.var} = SpdfBFieldModel::getExternalBFieldModel()

: Gets the external B field model.

[result]{.var} = SpdfBFieldModel::getTraceStopAltitude()

: Gets the trace stop altitude value.

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

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

SpdfBFieldModel__define

: Defines the SpdfBFieldModel class.

::: {#routine-details}

Routine details

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

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

[result]{.var} = SpdfBFieldModel::init([internalBFieldModel=[string]{.var}]{.argument}[, externalBFieldModel=[SpdfExternalBFieldModel]{.var}]{.argument}[[,traceStopAltitude=[int]{.var}]]{.argument})

Creates an SpdfBFieldModel object.

Return value

::: small reference to an SpdfBFieldModel object. :::

Keywords

internalBFieldModel [in type=string default=“IGRF”]{.smaller}

: internal magnetic field model (valid values: “IGRF”, “SimpleDipole”).

externalBFieldModel [in type=SpdfExternalBFieldModel default=SpdfTsyganenko89c]{.smaller}

: external magnetic field model.

traceStopAltitude [in optional type=int default=100]{.smaller}

: stop altitude for downward tracing of field. :::

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

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

SpdfBFieldModel::cleanup

Performs cleanup operations when this object is destroyed.

:::

::: {#SpdfBFieldModel::getInternalBFieldModel .routine-details .details}

top{.top} source{.top} SpdfBFieldModel::getInternalBFieldModel[]{.routine-attributes}

[result]{.var} = SpdfBFieldModel::getInternalBFieldModel()

Gets the internal B field model value.

Return value

::: small internal B field model value. ::: :::

::: {#SpdfBFieldModel::getExternalBFieldModel .routine-details .details}

top{.top} source{.top} SpdfBFieldModel::getExternalBFieldModel[]{.routine-attributes}

[result]{.var} = SpdfBFieldModel::getExternalBFieldModel()

Gets the external B field model.

Return value

::: small a reference to the external B field model. ::: :::

::: {#SpdfBFieldModel::getTraceStopAltitude .routine-details .details}

top{.top} source{.top} SpdfBFieldModel::getTraceStopAltitude[]{.routine-attributes}

[result]{.var} = SpdfBFieldModel::getTraceStopAltitude()

Gets the trace stop altitude value.

Return value

::: small trace stop altitude value. ::: :::

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

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

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

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

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

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

SpdfBFieldModel__define

Defines the SpdfBFieldModel class.

::: :::

::: {#attributes}

File attributes

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

:::

SSC Feedback. :::

::: footer

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

:::