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 LocationRequest 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 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 SpdfLocationRequest 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=objarr of SpdfSatelliteSpecification}{.source}]{.comments} {.source}[; requested satellites.{.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 SpdfLocationRequest object.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfLocationRequest::init:source}function SpdfLocationRequest::init, $ timeInterval, $ satellites, $ description = description, $ bFieldModel = bFieldModel compile_opt idl2 if ~(self->SpdfRequest::init( $ timeInterval, description = description, $ bFieldModel = bFieldModel)) then begin return, 0 endif self.satellites = ptr_new(satellites) return, self end {.source}[;+{.source}]{.comments} {.source}[; Performs cleanup operations when this object is destroyed.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfLocationRequest::cleanup:source}pro SpdfLocationRequest::cleanup compile_opt idl2 if ptr_valid(self.satellites) then ptr_free, self.satellites end {.source}[;+{.source}]{.comments} {.source}[; Gets the satellites.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns objarr containing satellites or objarr(1) whose first {.source}]{.comments} {.source}[; element is !obj_valid().{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfLocationRequest::getSatellites:source}function SpdfLocationRequest::getSatellites compile_opt idl2 if ptr_valid(self.satellites) then begin return, *self.satellites endif else begin return, objarr(1) endelse end {.source}[;+{.source}]{.comments} {.source}[; Creates a LocationRequest 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 LocationRequest element.{.source}]{.comments} {.source}[; @param subClassName {in} {type=string]{.source}]{.comments} {.source}[; sub-class name.{.source}]{.comments} {.source}[; @returns a reference to a new IDLffXMLDOMElement representation of{.source}]{.comments} {.source}[; this object.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfLocationRequest::createDomElement:source}function SpdfLocationRequest::createDomElement, $ doc, $ subClassName compile_opt idl2 requestElement = self->SpdfRequest::createDomElement(doc, subClassName) for i = 0, n_elements(*self.satellites) - 1 do begin satelliteElement = (*self.satellites)[i]->createDomElement(doc) ovoid = requestElement->appendChild(satelliteElement) endfor return, requestElement end {.source}[;+{.source}]{.comments} {.source}[; Defines the SpdfLocationRequest class.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @field satellites requested satellites.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfLocationRequest__define:source}pro SpdfLocationRequest__define compile_opt idl2 struct = { SpdfLocationRequest, $ inherits SpdfRequest, $ satellites:ptr_new() $ } end {.source}
:::
