# SSC R2.4.17 Web Services API

## Generated by IDLdoc

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

## ./

# spdfoutputoptions__define.pro

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

## Author information

Author

  B. Harris

Copyright

  Copyright (c) 2013-2014 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 SpdfOutputOptions

### Properties

#### Properties in SpdfOutputOptions

allLocationFilters init
bFieldTraceOptions init
distanceFromOptions init
minMaxPoints init
regionOptions init
valueOptions init

## Routines

### Routines from spdfoutputoptions__define.pro

`result = SpdfOutputOptions::init(coordinateOptions [, /allLocationFilters] [, regionOptions=SpdfRegionOptions] [, valueOptions=SpdfValueOptions] [, distanceFromOptions=distanceFromOptions] [, minMaxPoints=int] [, bFieldTraceOptions=objarr of SpdfBFieldTraceOptions])`

  Creates an SpdfOutputOptions object.

`SpdfOutputOptions::cleanup`

  Performs cleanup operations when this object is destroyed.

`result = SpdfOutputOptions::getAllLocationFilters()`

  Gets the all-location-filters value.

`result = SpdfOutputOptions::getCoordinateOptions()`

  Gets the coordinate options value.

`result = SpdfOutputOptions::getRegionOptions()`

  Gets the region options value.

`result = SpdfOutputOptions::getValueOptions()`

  Gets the ValueOptions value.

`result = SpdfOutputOptions::getDistanceFromOptions()`

  Gets the DistanceFromOptions value.

`result = SpdfOutputOptions::getMinMaxPoints()`

  Gets the minMaxPoints value.

`result = SpdfOutputOptions::getBFieldTraceOptions()`

  Gets the BFieldTraceOptions value.

`result = SpdfOutputOptions::createDomElement(doc)`

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

`SpdfOutputOptions__define`

  Defines the SpdfOutputOptions class.

## Routine details

## top source SpdfOutputOptions::init

`result = SpdfOutputOptions::init(coordinateOptions [, /allLocationFilters] [, regionOptions=SpdfRegionOptions] [, valueOptions=SpdfValueOptions] [, distanceFromOptions=distanceFromOptions] [, minMaxPoints=int] [, bFieldTraceOptions=objarr of SpdfBFieldTraceOptions])`

Creates an SpdfOutputOptions object.

### Return value

reference to an SpdfOutputOptions object.

### Parameters

coordinateOptions in type=objarr of SpdfCoordinateOptions

  specifies the coordinate options.

### Keywords

allLocationFilters in optional type=boolean default=true

  specifies whether all or just one or more of the specified location filters must be satisfied.

regionOptions in optional type=SpdfRegionOptions

  specifies the region options.

valueOptions in optional type=SpdfValueOptions

  specifies the value options.

distanceFromOptions in optional

  {type=SpdfDistanceFromOptions) specifies distance-from options.

minMaxPoints in optional type=int default=2

  number of points used to determine minima or maxima values.

bFieldTraceOptions in optional type=objarr of SpdfBFieldTraceOptions

  magnetic field trace options

## top source SpdfOutputOptions::cleanup

`SpdfOutputOptions::cleanup`

Performs cleanup operations when this object is destroyed.

## top source SpdfOutputOptions::getAllLocationFilters

`result = SpdfOutputOptions::getAllLocationFilters()`

Gets the all-location-filters value.

### Return value

all-location-filters value.

## top source SpdfOutputOptions::getCoordinateOptions

`result = SpdfOutputOptions::getCoordinateOptions()`

Gets the coordinate options value.

### Return value

objarr of CoordinateOptions or an objarr(1) whose first element is ~obj_valid().

## top source SpdfOutputOptions::getRegionOptions

`result = SpdfOutputOptions::getRegionOptions()`

Gets the region options value.

### Return value

RegionOptions or a null object reference.

## top source SpdfOutputOptions::getValueOptions

`result = SpdfOutputOptions::getValueOptions()`

Gets the ValueOptions value.

### Return value

ValueOptions or a null object reference.

## top source SpdfOutputOptions::getDistanceFromOptions

`result = SpdfOutputOptions::getDistanceFromOptions()`

Gets the DistanceFromOptions value.

### Return value

DistanceFromOptions value or a null object reference.

## top source SpdfOutputOptions::getMinMaxPoints

`result = SpdfOutputOptions::getMinMaxPoints()`

Gets the minMaxPoints value.

### Return value

minMaxPoints value or a null object reference.

## top source SpdfOutputOptions::getBFieldTraceOptions

`result = SpdfOutputOptions::getBFieldTraceOptions()`

Gets the BFieldTraceOptions value.

### Return value

objarr containing BFieldTraceOptions or objarr(1) whose first element is ~obj_valid.

## top source SpdfOutputOptions::createDomElement

`result = SpdfOutputOptions::createDomElement(doc)`

Creates an OutputOptions 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 SpdfOutputOptions__define

`SpdfOutputOptions__define`

Defines the SpdfOutputOptions class.

## File attributes

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

SSC Feedback.