# Complete SSC R2.4.17 Web Services API

## Generated by IDLdoc

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

## ./

# spdfregionoptions__define.pro

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

### Properties

#### Properties in SpdfRegionOptions

northBTracedFootpoint init
radialTracedFootpoint init
southBTracedFootpoint init
spacecraft init

### Fields

#### Fields in SpdfRegionOptions

northBTracedFootpoint 0B

  specifies whether the north B traced footpoint regions are to be included in the output.

radialTracedFootpoint 0B

  specifies whether the radial traced footpoint regions are to be included in the output.

southBTracedFootpoint 0B

  specifies whether the south B traced footpoint regions are to be included in the output.

spacecraft 0B

  specifies whether the spacecraft regions are to be included in the output.

## Routines

### Routines from spdfregionoptions__define.pro

`result = SpdfRegionOptions::init( [/spacecraft] [, /radialTracedFootpoint] [, /northBTracedFootpoint] [, /southBTracedFootpoint])`

  Creates an SpdfRegionOptions object.

`SpdfRegionOptions::cleanup`

  Performs cleanup operations when this object is destroyed.

`result = SpdfRegionOptions::getSpacecraft()`

  Gets the spacecraft value.

`result = SpdfRegionOptions::getRadialTracedFootpoint()`

  Gets the radial traced footpoint value.

`result = SpdfRegionOptions::getNorthBTracedFootpoint()`

  Gets the north B traced footpoint value.

`result = SpdfRegionOptions::getSouthBTracedFootpoint()`

  Gets the south B traced footpoint value.

`result = SpdfRegionOptions::createDomElement(doc)`

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

`SpdfRegionOptions__define`

  Defines the SpdfRegionOptions class.

## Routine details

## top source SpdfRegionOptions::init

`result = SpdfRegionOptions::init( [/spacecraft] [, /radialTracedFootpoint] [, /northBTracedFootpoint] [, /southBTracedFootpoint])`

Creates an SpdfRegionOptions object.

### Return value

reference to an SpdfRegionOptions object.

### Keywords

spacecraft in optional type=boolean default=false

  specifies whether the spacecraft regions are to be included in the output.

radialTracedFootpoint in optional type=boolean default=false

  specifies whether the radial traced footpoint regions are to be included in the output.

northBTracedFootpoint in optional type=boolean default=false

  specifies whether the north B traced footpoint regions are to be included in the output.

southBTracedFootpoint in optional type=boolean default=false

  specifies whether the south B traced footpoint regions are to be included in the output.

## top source SpdfRegionOptions::cleanup

`SpdfRegionOptions::cleanup`

Performs cleanup operations when this object is destroyed.

## top source SpdfRegionOptions::getSpacecraft

`result = SpdfRegionOptions::getSpacecraft()`

Gets the spacecraft value.

### Return value

spacecraft value.

## top source SpdfRegionOptions::getRadialTracedFootpoint

`result = SpdfRegionOptions::getRadialTracedFootpoint()`

Gets the radial traced footpoint value.

### Return value

radial traced footpoint value.

## top source SpdfRegionOptions::getNorthBTracedFootpoint

`result = SpdfRegionOptions::getNorthBTracedFootpoint()`

Gets the north B traced footpoint value.

### Return value

north B traced footpoint value.

## top source SpdfRegionOptions::getSouthBTracedFootpoint

`result = SpdfRegionOptions::getSouthBTracedFootpoint()`

Gets the south B traced footpoint value.

### Return value

south B traced footpoint value.

## top source SpdfRegionOptions::createDomElement

`result = SpdfRegionOptions::createDomElement(doc)`

Creates an RegionOptions 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 SpdfRegionOptions__define

`SpdfRegionOptions__define`

Defines the SpdfRegionOptions class.

## File attributes

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

SSC Feedback.