SSC R2.3.11 Web Services API

Generated by IDLdoc

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

./

spdfcoordinateoptions__define.pro


This class is an IDL representation of the CoordinateOptions element from the Satellite Situation Center (SSC) XML schema.

Author information

Author

B. Harris

Copyright

Copyright (c) 2013-2014 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 SpdfCoordinateOptions

Subclasses: SpdfFilteredCoordinateOptions

Routines

Routines from spdfcoordinateoptions__define.pro

result = SpdfCoordinateOptions::init(coordinateSystem, component)

Creates an SpdfCoordinateOptions object.

SpdfCoordinateOptions::cleanup

Performs cleanup operations when this object is destroyed.

result = SpdfCoordinateOptions::getCoordinateSystem()

Gets the coordinate system value.

result = SpdfCoordinateOptions::getComponent()

Gets the coordinate component value.

result = SpdfCoordinateOptions::createDomElement(doc)

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

SpdfCoordinateOptions__define

Defines the SpdfCoordinateOptions class.

Routine details

top source SpdfCoordinateOptions::init

result = SpdfCoordinateOptions::init(coordinateSystem, component)

Creates an SpdfCoordinateOptions object.

Return value

reference to an SpdfCoordinateOptions object.

Parameters

coordinateSystem in type=string

specifies the coordinateSystem. Must be one of the following values: Geo, Gm, Gse, Gsm, Sm, GeiTod, or GeiJ2000.

component in type=string

specifies the coordinate component. Must be one of the following values: X, Y, Z, Lat, Lon, or Local_Time.

top source SpdfCoordinateOptions::cleanup

SpdfCoordinateOptions::cleanup

Performs cleanup operations when this object is destroyed.

top source SpdfCoordinateOptions::getCoordinateSystem

result = SpdfCoordinateOptions::getCoordinateSystem()

Gets the coordinate system value.

Return value

coordinate system value.

top source SpdfCoordinateOptions::getComponent

result = SpdfCoordinateOptions::getComponent()

Gets the coordinate component value.

Return value

coordinate component value.

top source SpdfCoordinateOptions::createDomElement

result = SpdfCoordinateOptions::createDomElement(doc)

Creates an CoordinateOptions 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 SpdfCoordinateOptions__define

SpdfCoordinateOptions__define

Defines the SpdfCoordinateOptions class.

File attributes

Modification date: Tue Aug 8 09:56:26 2017
Lines: 58


SSC Feedback.