Official websites use .gov
A
.gov website belongs to an official government
organization in the United States.
Secure .gov websites use HTTPS
A
lock (
) or https:// means you’ve safely connected to
the .gov website. Share sensitive information only on official,
secure websites.
::: content
[;{.source}]{.comments} {.source}[; NOSA HEADER START{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; The contents of this file are subject to the terms of the NASA Open {.source}]{.comments} {.source}[; Source Agreement (NOSA), Version 1.3 only (the "Agreement"). You may {.source}]{.comments} {.source}[; not use this file except in compliance with the Agreement.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; You can obtain a copy of the agreement at{.source}]{.comments} {.source}[; docs/NASA_Open_Source_Agreement_1.3.txt{.source}]{.comments} {.source}[; or {.source}]{.comments} {.source}[; http://sscweb.gsfc.nasa.gov/WebServices/NASA_Open_Source_Agreement_1.3.txt.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; See the Agreement for the specific language governing permissions{.source}]{.comments} {.source}[; and limitations under the Agreement.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; When distributing Covered Code, include this NOSA HEADER in each{.source}]{.comments} {.source}[; file and include the Agreement file at {.source}]{.comments} {.source}[; docs/NASA_Open_Source_Agreement_1.3.txt. If applicable, add the {.source}]{.comments} {.source}[; following below this NOSA HEADER, with the fields enclosed by {.source}]{.comments} {.source}[; brackets "[]" replaced with your own identifying information: {.source}]{.comments} {.source}[; Portions Copyright [yyyy] [name of copyright owner]{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; NOSA HEADER END{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; Copyright (c) 2013-2016 United States Government as represented by {.source}]{.comments} {.source}[; the National Aeronautics and Space Administration. No copyright is {.source}]{.comments} {.source}[; claimed in the United States under Title 17, U.S.Code. All Other {.source}]{.comments} {.source}[; Rights Reserved.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[;+{.source}]{.comments} {.source}[; This class is an IDL representation of the DataRequest element {.source}]{.comments} {.source}[; from the{.source}]{.comments} {.source}[; <a href="http://sscweb.gsfc.nasa.gov/">Satellite Situation Center</a>{.source}]{.comments} {.source}[; (SSC) XML schema.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @copyright Copyright (c) 2013-2016 United States Government as {.source}]{.comments} {.source}[; represented by the National Aeronautics and Space Administration.{.source}]{.comments} {.source}[; No copyright is claimed in the United States under Title 17,{.source}]{.comments} {.source}[; U.S.Code. All Other Rights Reserved.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @author B. Harris{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[;+{.source}]{.comments} {.source}[; Creates an SpdfSscDataRequest object.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @param timeInterval {in} {type=SpdfTimeInterval}{.source}]{.comments} {.source}[; time interval of this request.{.source}]{.comments} {.source}[; @param satellites {in} {type=SpdfSatelliteSpecification objarr}{.source}]{.comments} {.source}[; requested satellites.{.source}]{.comments} {.source}[; @param outputOptions {in} {type=SpdfOutputOptions}{.source}]{.comments} {.source}[; requested output options.{.source}]{.comments} {.source}[; @keyword description {in} {optional} {type=string}{.source}]{.comments} {.source}[; a textual description of this request.{.source}]{.comments} {.source}[; @keyword bFieldModel {in} {optional} {type=SpdfBFieldModel}{.source}]{.comments} {.source}[; magnetic field model to use. If not given, a default {.source}]{.comments} {.source}[; model of IGRF and Tsyganenko 89c with KP values of {.source}]{.comments} {.source}[; 3-,3,3+ is used. {.source}]{.comments} {.source}[; @keyword regionOptions {in} {optional} {type=SpdfRegionOptions}{.source}]{.comments} {.source}[; requested region options.{.source}]{.comments} {.source}[; @keyword locationFilterOptions {in} {optional} {.source}]{.comments} {.source}[; {type=SpdfLocationFilterOptions}{.source}]{.comments} {.source}[; requested location filter options.{.source}]{.comments} {.source}[; @keyword formatOptions {in} {optional} {type=SpdfFormatOptions}{.source}]{.comments} {.source}[; requested format options.{.source}]{.comments} {.source}[; @returns reference to an SpdfSscDataRequest object.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfSscDataRequest::init:source}function SpdfSscDataRequest::init, $ timeInterval, $ satellites, $ outputOptions, $ description = description, $ bFieldModel = bFieldModel, $ regionOptions = regionOptions, $ locationFilterOptions = locationFilterOptions, $ formatOptions = formatOptions compile_opt idl2 if ~(self->SpdfLocationRequest::init( $ timeInterval, satellites, $ description = description, $ bFieldModel = bFieldModel)) then begin return, 0 endif self.outputOptions = outputOptions if keyword_set(regionOptions) then begin self.regionOptions = ptr_new(regionOptions) endif if keyword_set(locationFilterOptions) then begin self.locationFilterOptions = ptr_new(locationFilterOptions) endif if keyword_set(formatOptions) then begin self.formatOptions = ptr_new(formatOptions) endif return, self end {.source}[;+{.source}]{.comments} {.source}[; Performs cleanup operations when this object is destroyed.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfSscDataRequest::cleanup:source}pro SpdfSscDataRequest::cleanup compile_opt idl2 if ptr_valid(self.satellites) then ptr_free, self.satellites if obj_valid(self.outputOptions) then begin obj_destroy, self.outputOptions endif if ptr_valid(self.regionFilterOptions) then begin ptr_free, self.regionFilterOptions endif if ptr_valid(self.locationFilterOptions) then begin ptr_free, self.locationFilterOptions endif if ptr_valid(self.formatOptions) then begin ptr_free, self.formatOptions endif end {.source}[;+{.source}]{.comments} {.source}[; Gets the output options.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns reference to output options.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfSscDataRequest::getOutputOptions:source}function SpdfSscDataRequest::getOutputOptions compile_opt idl2 return, self.outputOptions end {.source}[;+{.source}]{.comments} {.source}[; Creates a DataRequest element using the given XML DOM document {.source}]{.comments} {.source}[; with the values of this object.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @param doc {in} {type=IDLffXMLDOMDocument}{.source}]{.comments} {.source}[; document in which to create the DataRequest element.{.source}]{.comments} {.source}[; @returns a reference to a new IDLffXMLDOMElement representation of{.source}]{.comments} {.source}[; this object.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfSscDataRequest::createDomElement:source}function SpdfSscDataRequest::createDomElement, $ doc compile_opt idl2 dataRequestElement = $ self->SpdfLocationRequest::createDomElement(doc, 'DataRequest') if obj_valid(self.outputOptions) then begin outputOptionsElement = $ self.outputOptions->createDomElement(doc) ovoid = dataRequestElement->appendChild(outputOptionsElement) endif if ptr_valid(self.regionFilterOptions) then begin regionFilterOptionsElement = $ (*self.regionFilterOptions)->createDomElement(doc) ovoid = dataRequestElement->appendChild( $ regionFilterOptionsElement) endif if ptr_valid(self.locationFilterOptions) then begin locationFilterOptionsElement = $ (*self.locationFilterOptions)->createDomElement(doc) ovoid = dataRequestElement->appendChild( $ locationFilterOptionsElement) endif if ptr_valid(self.formatOptions) then begin formatOptionsElement = $ (*self.formatOptions)->createDomElement(doc) ovoid = dataRequestElement->appendChild(formatOptionsElement) endif return, dataRequestElement end {.source}[;+{.source}]{.comments} {.source}[; Defines the SpdfSscDataRequest class.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @field outputOptions request's output options.{.source}]{.comments} {.source}[; @field regionFilterOptions request's region filter options.{.source}]{.comments} {.source}[; @field locationFilterOptions request's location filter options.{.source}]{.comments} {.source}[; @field formatOptions request's format options.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfSscDataRequest__define:source}pro SpdfSscDataRequest__define compile_opt idl2 struct = { SpdfSscDataRequest, $ inherits SpdfLocationRequest, $ outputOptions:obj_new(), $ regionFilterOptions:ptr_new(), $ locationFilterOptions:ptr_new(), $ formatOptions:ptr_new() $ } end {.source}
:::
