# SSC R2.4.17 Web Services API

## Generated by IDLdoc

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

## ./

# spdfdistancefromoptions__define.pro

This class is an IDL representation of the DistanceFromOptions 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 SpdfDistanceFromOptions

### Properties

#### Properties in SpdfDistanceFromOptions

bGseXYZ init
bowShock init
mPause init
neutralSheet init

## Routines

### Routines from spdfdistancefromoptions__define.pro

`result = SpdfDistanceFromOptions::init( [/neutralSheet] [, /bowShock] [, /mPause] [, /bGseXYZ])`

  Creates an SpdfDistanceFromOptions object.

`SpdfDistanceFromOptions::cleanup`

  Performs cleanup operations when this object is destroyed.

`result = SpdfDistanceFromOptions::getNeutralSheet()`

  Gets the distance from the neutral sheet value.

`result = SpdfDistanceFromOptions::getBowShock()`

  Gets the distance from the bow shock value.

`result = SpdfDistanceFromOptions::getMPause()`

  Gets the distance from the magneto pause value.

`result = SpdfDistanceFromOptions::getBGseXYZ()`

  Gets the bGseXYZ value.

`result = SpdfDistanceFromOptions::createDomElement(doc)`

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

`SpdfDistanceFromOptions__define`

  Defines the SpdfDistanceFromOptions class.

## Routine details

## top source SpdfDistanceFromOptions::init

`result = SpdfDistanceFromOptions::init( [/neutralSheet] [, /bowShock] [, /mPause] [, /bGseXYZ])`

Creates an SpdfDistanceFromOptions object.

### Return value

reference to an SpdfDistanceFromOptions object.

### Keywords

neutralSheet in optional type=boolean default=false

  specifies whether the distance from the neutral sheet is to be included in the output.

bowShock in optional type=boolean default=false

  specifies whether the distance from the bow shock is to be included in the output.

mPause in optional type=boolean default=false

  specifies whether the distance from the magneto pause is to be included in the output.

bGseXYZ in optional type=boolean default=false

  specifies whether the B GSE X, Y, Z values is to be included in the output.

## top source SpdfDistanceFromOptions::cleanup

`SpdfDistanceFromOptions::cleanup`

Performs cleanup operations when this object is destroyed.

## top source SpdfDistanceFromOptions::getNeutralSheet

`result = SpdfDistanceFromOptions::getNeutralSheet()`

Gets the distance from the neutral sheet value.

### Return value

distance from the neutral sheet value.

## top source SpdfDistanceFromOptions::getBowShock

`result = SpdfDistanceFromOptions::getBowShock()`

Gets the distance from the bow shock value.

### Return value

distance from the bow shock value.

## top source SpdfDistanceFromOptions::getMPause

`result = SpdfDistanceFromOptions::getMPause()`

Gets the distance from the magneto pause value.

### Return value

distance from the magneto pause value.

## top source SpdfDistanceFromOptions::getBGseXYZ

`result = SpdfDistanceFromOptions::getBGseXYZ()`

Gets the bGseXYZ value.

### Return value

bGseXYZ value.

## top source SpdfDistanceFromOptions::createDomElement

`result = SpdfDistanceFromOptions::createDomElement(doc)`

Creates an DistanceFromOptions 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 SpdfDistanceFromOptions__define

`SpdfDistanceFromOptions__define`

Defines the SpdfDistanceFromOptions class.

## File attributes

Modification date: | Fri May 13 08:54:13 2022
Lines: | 99

SSC Feedback.