SSC R2.3.15 Web Services API

Generated by IDLdoc

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

./

spdflocationrequest__define.pro


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

Inheritance

Subclasses: SpdfSscDataRequest

Properties

Properties in SpdfLocationRequest

bFieldModel init
description init

Routines

Methods inherited from SpdfRequest

Routines from spdflocationrequest__define.pro

result = SpdfLocationRequest::init(timeInterval, satellites [, description=string] [, bFieldModel=SpdfBFieldModel])

Creates an SpdfLocationRequest object.

SpdfLocationRequest::cleanup

Performs cleanup operations when this object is destroyed.

result = SpdfLocationRequest::getSatellites()

Gets the satellites.

result = SpdfLocationRequest::createDomElement(doc, subClassName)

Creates a LocationRequest element using the given XML DOM document with the values of this object.

SpdfLocationRequest__define

Defines the SpdfLocationRequest class.

Routine details

top source SpdfLocationRequest::init

result = SpdfLocationRequest::init(timeInterval, satellites [, description=string] [, bFieldModel=SpdfBFieldModel])

Creates an SpdfLocationRequest object.

Return value

reference to an SpdfLocationRequest object.

Parameters

timeInterval in type=SpdfTimeInterval

time interval of this request.

satellites in type=objarr of SpdfSatelliteSpecification

requested satellites.

Keywords

description in optional type=string

a textual description of this request.

bFieldModel in optional type=SpdfBFieldModel

magnetic field model to use. If not given, the Tsyganenko 89c model is used.

top source SpdfLocationRequest::cleanup

SpdfLocationRequest::cleanup

Performs cleanup operations when this object is destroyed.

top source SpdfLocationRequest::getSatellites

result = SpdfLocationRequest::getSatellites()

Gets the satellites.

Return value

objarr containing satellites or objarr(1) whose first element is !obj_valid().

top source SpdfLocationRequest::createDomElement

result = SpdfLocationRequest::createDomElement(doc, subClassName)

Creates a LocationRequest 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 LocationRequest element.

subClassName in

{type=string] sub-class name.

top source SpdfLocationRequest__define

SpdfLocationRequest__define

Defines the SpdfLocationRequest class.

File attributes

Modification date: Fri May 13 08:54:13 2022
Lines: 44


SSC Feedback.