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

./

spdftsyganenko96bfieldmodel__define.pro[]{.file-attributes}

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

Inheritance

SpdfExternalBFieldModel

Properties

Properties in SpdfTsyganenko96BFieldModel

::: details

byImf [init ]{.smaller}

bzImf [init ]{.smaller}

dstIndex [init ]{.smaller}

solarWindPressure [init ]{.smaller}

:
::: :::

Routines

Methods inherited from SpdfExternalBFieldModel

Routines from spdftsyganenko96bfieldmodel__define.pro

[result]{.var} = SpdfTsyganenko96BFieldModel::init([ [solarWindPressure=[double]{.var}]]{.argument}[ [, dstIndex=[int]{.var}]]{.argument}[ [, byImf=[double]{.var}]]{.argument}[ [, bzImf=[double]{.var}]]{.argument})

: Creates an SpdfTsyganenko96BFieldModel object.

SpdfTsyganenko96BFieldModel::cleanup

: Performs cleanup operations when this object is destroyed.

[result]{.var} = SpdfTsyganenko96BFieldModel::getSolarWindPressure()

: Get the solar wind pressure value.

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

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

SpdfTsyganenko96BFieldModel__define

: Defines the SpdfTsyganenko96BFieldModel class.

::: {#routine-details}

Routine details

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

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

[result]{.var} = SpdfTsyganenko96BFieldModel::init([ [solarWindPressure=[double]{.var}]]{.argument}[[,dstIndex=[int]{.var}]]{.argument}[[,byImf=[double]{.var}]]{.argument}[[,bzImf=[double]{.var}]]{.argument})

Creates an SpdfTsyganenko96BFieldModel object.

Return value

::: small reference to an SpdfTsyganenko96BFieldModel object. :::

Keywords

solarWindPressure [in optional type=double ]{.smaller}

: solar wind pressure (range: 0 - 30 nP, default=2.1).

dstIndex [in optional type=int ]{.smaller}

: Disturbance Storm Time (DST) index (range: -400 - 200 nT, default=-20).

byImf [in optional type=double ]{.smaller}

: BY Interplanetary Magnetic Field (IMF) (range: -100 - 100 nT, default=0.0).

bzImf [in optional type=double ]{.smaller}

: BZ Interplanetary Magnetic Field (IMF) (range: -100 - 100 nT, default=0.0). :::

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

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

SpdfTsyganenko96BFieldModel::cleanup

Performs cleanup operations when this object is destroyed.

:::

::: {#SpdfTsyganenko96BFieldModel::getSolarWindPressure .routine-details .details}

top{.top} source{.top} SpdfTsyganenko96BFieldModel::getSolarWindPressure[]{.routine-attributes}

[result]{.var} = SpdfTsyganenko96BFieldModel::getSolarWindPressure()

Get the solar wind pressure value.

Return value

::: small the solar wind pressure value. ::: :::

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

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

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

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

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

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

SpdfTsyganenko96BFieldModel__define

Defines the SpdfTsyganenko96BFieldModel class.

::: :::

::: {#attributes}

File attributes

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

:::

SSC Feedback. :::

::: footer

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

:::