# SSC R2.4.17 Web Services API

## Generated by IDLdoc

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

## ./

# spdfvalueoptions__define.pro

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

### Properties

#### Properties in SpdfValueOptions

bFieldStrength init
dipoleInvLat init
dipoleLValue init
radialDistance init

## Routines

### Routines from spdfvalueoptions__define.pro

`result = SpdfValueOptions::init( [/radialDistance] [, /bFieldStrength] [, /dipoleLValue] [, /dipoleInvLat])`

  Creates an SpdfValueOptions object.

`SpdfValueOptions::cleanup`

  Performs cleanup operations when this object is destroyed.

`result = SpdfValueOptions::getRadialDistance()`

  Gets the radialDistance value.

`result = SpdfValueOptions::getBFieldStrength()`

  Gets the magnetic field strength value.

`result = SpdfValueOptions::getDipoleLValue()`

  Gets the dipole L value.

`result = SpdfValueOptions::getDipoleInvLat()`

  Gets the dipole invariant latitude value.

`result = SpdfValueOptions::createDomElement(doc)`

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

`SpdfValueOptions__define`

  Defines the SpdfValueOptions class.

## Routine details

## top source SpdfValueOptions::init

`result = SpdfValueOptions::init( [/radialDistance] [, /bFieldStrength] [, /dipoleLValue] [, /dipoleInvLat])`

Creates an SpdfValueOptions object.

### Return value

reference to an SpdfValueOptions object.

### Keywords

radialDistance in optional type=boolean default=false

  specifies whether the radial distance is to be included in the output.

bFieldStrength in optional type=boolean default=false

  specifies whether the magnetic field strength is to be included in the output.

dipoleLValue in optional type=boolean default=false

  specifies whether the dipole L value is to be included in the output.

dipoleInvLat in optional type=boolean default=false

  specifies whether the dipole invariant latitude is to be included in the output.

## top source SpdfValueOptions::cleanup

`SpdfValueOptions::cleanup`

Performs cleanup operations when this object is destroyed.

## top source SpdfValueOptions::getRadialDistance

`result = SpdfValueOptions::getRadialDistance()`

Gets the radialDistance value.

### Return value

radialDistance value.

## top source SpdfValueOptions::getBFieldStrength

`result = SpdfValueOptions::getBFieldStrength()`

Gets the magnetic field strength value.

### Return value

magnetic field strength value.

## top source SpdfValueOptions::getDipoleLValue

`result = SpdfValueOptions::getDipoleLValue()`

Gets the dipole L value.

### Return value

dipole L value.

## top source SpdfValueOptions::getDipoleInvLat

`result = SpdfValueOptions::getDipoleInvLat()`

Gets the dipole invariant latitude value.

### Return value

dipole invariant latitude value.

## top source SpdfValueOptions::createDomElement

`result = SpdfValueOptions::createDomElement(doc)`

Creates an ValueOptions 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 SpdfValueOptions__define

`SpdfValueOptions__define`

Defines the SpdfValueOptions class.

## File attributes

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

SSC Feedback.