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 United States Government as represented by the {.source}]{.comments} {.source}[; National Aeronautics and Space Administration. No copyright is claimed {.source}]{.comments} {.source}[; in the United States under Title 17, U.S.Code. All Other Rights Reserved.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[;+{.source}]{.comments} {.source}[; This class is an IDL representation of the Request element 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 United States Government as represented{.source}]{.comments} {.source}[; by the National Aeronautics and Space Administration. No{.source}]{.comments} {.source}[; 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 SpdfRequest object.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @param timeInterval {in} {type=SpdfTimeInterval}{.source}]{.comments} {.source}[; time interval of this request.{.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, the {.source}]{.comments} {.source}[; Tsyganenko 89c model is used.{.source}]{.comments} {.source}[; @returns reference to an SpdfRequest object.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfRequest::init:source}function SpdfRequest::init, $ timeInterval, $ description = description, $ bFieldModel = bFieldModel compile_opt idl2 if obj_valid(timeInterval) then begin self.timeInterval = timeInterval endif else begin return, 0 endelse if keyword_set(description) then self.description = description if keyword_set(bFieldModel) then begin self.bFieldModel = bFieldModel endif return, self end {.source}[;+{.source}]{.comments} {.source}[; Performs cleanup operations when this object is destroyed.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfRequest::cleanup:source}pro SpdfRequest::cleanup compile_opt idl2 if obj_valid(self.timeInterval) then obj_destroy, self.timeInterval if obj_valid(self.bFieldModel) then obj_destroy, self.bFieldModel end {.source}[;+{.source}]{.comments} {.source}[; Gets the description value.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns description value.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfRequest::getDescription:source}function SpdfRequest::getDescription compile_opt idl2 return, self.description end {.source}[;+{.source}]{.comments} {.source}[; Gets the timeInterval value.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns reference to timeInterval{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfRequest::getTimeInterval:source}function SpdfRequest::getTimeInterval compile_opt idl2 return, self.timeInterval end {.source}[;+{.source}]{.comments} {.source}[; Gets the bFieldModel value.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns reference to bFieldModel{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfRequest::getBFieldModel:source}function SpdfRequest::getBFieldModel compile_opt idl2 return, self.bFieldModel end {.source}[;+{.source}]{.comments} {.source}[; Creates a Request element using the given XML DOM document with the{.source}]{.comments} {.source}[; values of this object.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @param doc {in} {type=IDLffXMLDOMDocument}{.source}]{.comments} {.source}[; document in which to create the Request element.{.source}]{.comments} {.source}[; @param subClassName {in} {type=string}{.source}]{.comments} {.source}[; name of sub-class.{.source}]{.comments} {.source}[; @returns a reference to a new IDLffXMLDOMElement representation of{.source}]{.comments} {.source}[; this object.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfRequest::createDomElement:source}function SpdfRequest::createDomElement, $ doc, $ subClassName compile_opt idl2 requestElement = doc->createElement(subClassName) requestElement->setAttribute, 'xmlns', $ 'http://sscweb.gsfc.nasa.gov/schema' if self.description ne '' then begin descriptionElement = doc->createElement('Description') ovoid = requestElement->appendChild(descriptionElement) descriptionText = doc->createTextNode(self.description) descriptionText = $ descriptionElement->appendChild(descriptionText) endif timeIntervalElement = self.timeInterval->createDomElement(doc) ovoid = requestElement->appendChild(timeIntervalElement) if obj_valid(self.bFieldModel) then begin bFieldModelElement = self.bFieldModel->createDomElement(doc) ovoid = requestElement->appendChild(bFieldModelElement) endif return, requestElement end {.source}[;+{.source}]{.comments} {.source}[; Defines the SpdfRequest class.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @field description a textual description of this request.{.source}]{.comments} {.source}[; @field timeInterval time interval of query.{.source}]{.comments} {.source}[; @field bFieldModel magnetic field model to use.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfRequest__define:source}pro SpdfRequest__define compile_opt idl2 struct = { SpdfRequest, $ description:'', $ timeInterval:obj_new(), $ bFieldModel:obj_new() $ } end {.source}
:::
