SSC R2.3.15 Web Services API

Generated by IDLdoc

single page | use frames     summary     class     fields     routine details     file attributes

./

spdftsyganenko96bfieldmodel__define.pro


This class is an IDL representation of the Tsyganenko96BFieldModel element from the Satellite Situation Center (SSC) XML schema.

Author information

Author

B. Harris

Copyright

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 for SpdfTsyganenko96BFieldModel

Inheritance

Properties

Properties in SpdfTsyganenko96BFieldModel

byImf init
bzImf init
dstIndex init
solarWindPressure init

Routines

Methods inherited from SpdfExternalBFieldModel

Routines from spdftsyganenko96bfieldmodel__define.pro

result = SpdfTsyganenko96BFieldModel::init( [solarWindPressure=double] [, dstIndex=int] [, byImf=double] [, bzImf=double])

Creates an SpdfTsyganenko96BFieldModel object.

SpdfTsyganenko96BFieldModel::cleanup

Performs cleanup operations when this object is destroyed.

result = SpdfTsyganenko96BFieldModel::getSolarWindPressure()

Get the solar wind pressure value.

result = SpdfTsyganenko96BFieldModel::createDomElement(doc)

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

SpdfTsyganenko96BFieldModel__define

Defines the SpdfTsyganenko96BFieldModel class.

Routine details

top source SpdfTsyganenko96BFieldModel::init

result = SpdfTsyganenko96BFieldModel::init( [solarWindPressure=double] [, dstIndex=int] [, byImf=double] [, bzImf=double])

Creates an SpdfTsyganenko96BFieldModel object.

Return value

reference to an SpdfTsyganenko96BFieldModel object.

Keywords

solarWindPressure in optional type=double

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

dstIndex in optional type=int

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

byImf in optional type=double

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

bzImf in optional type=double

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

top source SpdfTsyganenko96BFieldModel::cleanup

SpdfTsyganenko96BFieldModel::cleanup

Performs cleanup operations when this object is destroyed.

top source SpdfTsyganenko96BFieldModel::getSolarWindPressure

result = SpdfTsyganenko96BFieldModel::getSolarWindPressure()

Get the solar wind pressure value.

Return value

the solar wind pressure value.

top source SpdfTsyganenko96BFieldModel::createDomElement

result = SpdfTsyganenko96BFieldModel::createDomElement(doc)

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

Return value

a reference to a new IDLffXMLDOMElement representation of this object.

Parameters

doc in type=IDLffXMLDOMDocument

document in which to create the DataRequest element.

top source SpdfTsyganenko96BFieldModel__define

SpdfTsyganenko96BFieldModel__define

Defines the SpdfTsyganenko96BFieldModel class.

File attributes

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


SSC Feedback.