![[attach.png]](idldoc-resources/attach.png)
./
spdfssc__define.pro
This class represents the remotely callable interface to NASA's Space Physics Data Facility (SPDF) Satellite Situation Center (SSC). The current implementation only support the "data locations" functionality. Supporting the "text (listing) locations", "conjunctions" and/or "graphs" functionality is a future possibility if there were sufficient interest.
Author information
- Author
B. Harris
- Copyright
Copyright (c) 2013-2017 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.
Routines
Routines from spdfssc__define.pro
result = SpdfSsc::init( [endpoint=string] [, userAgent=string] [, sslVerifyPeer=int])Creates an object representing SSC.
SpdfSsc::cleanupPerforms cleanup operations when this object is destroyed.
result = SpdfSsc::getDefaultEndpoint()Gets the default endpoint value.
result = SpdfSsc::getObservatories( [httpErrorReporter=SpdfHttpErrorReporter])Gets a description of all the observatories that are available.
result = SpdfSsc::getGroundStations( [httpErrorReporter=SpdfHttpErrorReporter])Gets a description of all the ground stations that are available.
result = SpdfSsc::getLocations(locationRequest [, httpErrorReporter=SpdfHttpErrorReporter])Request the specified satellite location information from SSC.
result = SpdfSsc::getTime(domElement [, name=string])Gets the node's time values from the given DOM element.
result = SpdfSsc::getDataResultText(resultDoc, type)Gets the specified node values from the given ssc:DataResult XML document.
result = SpdfSsc::getFileResult(doc)Creates an SpdfSscFileResult object from the given ssc:DataResult XML document.
result = SpdfSsc::getFiles(doc)Creates an array of SpdfSscFileDescription objects from the given ssc:Files XML document.
result = SpdfSsc::getDataResult(doc)Creates an SpdfSscDataResult object from the given ssc:DataResult XML document.
result = SpdfSsc::getSatelliteData(doc)Creates an SpdfSatelliteData object from the given ssc:SatelliteData XML document.
result = SpdfSsc::getCoordinateData(satDataElement)Creates an SpdfCoordinateData object from the given ssc:SatelliteData XML element.
result = SpdfSsc::getBTraceData(satDataElement)Creates an SpdfBTraceData object from the given ssc:BTraceData XML element.
result = SpdfSsc::getDoubleSatelliteData(satDataElement, name)Gets the specified double data values from the given satellite data.
result = SpdfSsc::getFloatSatelliteData(satDataElement, name)Gets the specified float data values from the given satellite data.
result = SpdfSsc::getSatelliteRegionData(satDataElement, name)Gets the specified region data values from the given satellite data.
SpdfSsc__defineDefines the SpdfSsc class.
Routine details
top source SpdfSsc::init
result = SpdfSsc::init( [endpoint=string] [, userAgent=string] [, sslVerifyPeer=int])
Creates an object representing SSC.
Return value
a reference to a SSC object.
Keywords
- endpoint in optional type=string default=self->getDefaultEndpoint()
URL of SSC web service .
- userAgent in optional type=string default=SscWs
HTTP user-agent value used in communications with SSC.
- sslVerifyPeer in optional type=int default=1
Specifies whether the authenticity of the peer's SSL certificate should be verified. When 0, the connection succeeds regardless of what the peer SSL certificate contains.
top source SpdfSsc::cleanup
SpdfSsc::cleanup
Performs cleanup operations when this object is destroyed.
top source SpdfSsc::getDefaultEndpoint
result = SpdfSsc::getDefaultEndpoint()
Gets the default endpoint value.
Return value
default endpoint string value.
top source SpdfSsc::getObservatories
result = SpdfSsc::getObservatories( [httpErrorReporter=SpdfHttpErrorReporter])
Gets a description of all the observatories that are available.
Return value
array of SpdfObservatoryDescription objects.
Keywords
- httpErrorReporter in optional type=SpdfHttpErrorReporter
used to report an HTTP error.
top source SpdfSsc::getGroundStations
result = SpdfSsc::getGroundStations( [httpErrorReporter=SpdfHttpErrorReporter])
Gets a description of all the ground stations that are available.
Return value
array of SpdfGroundStation objects.
Keywords
- httpErrorReporter in optional type=SpdfHttpErrorReporter
used to report an HTTP error.
top source SpdfSsc::getLocationsprivate
result = SpdfSsc::getLocations(locationRequest [, httpErrorReporter=SpdfHttpErrorReporter])
Request the specified satellite location information from SSC.
Return value
an SpdfSscDataResult or SpdfSscFileResult object.
Parameters
- locationRequest in type=SpdfLocationRequest
specifies the information to get.
Keywords
- httpErrorReporter in optional type=SpdfHttpErrorReporter
used to report an HTTP error.
top source SpdfSsc::getTimeprivate
result = SpdfSsc::getTime(domElement [, name=string])
Gets the node's time values from the given DOM element.
Return value
node's julday time value(s) from the given DOM element. A scalar value of !values.d_NaN is returned if no value is found.
Parameters
- domElement in required type=IDLffXMLDOMElement
DOM element to search.
Keywords
- name in optional type=string default='Time'
name of time tag.
top source SpdfSsc::getDataResultTextprivate
result = SpdfSsc::getDataResultText(resultDoc, type)
Gets the specified node values from the given ssc:DataResult XML document.
Return value
strarr of the specified node values from the given document.
Parameters
- resultDoc in type=IDLffXMLDOMDocument
SpdfSscDataResult XML document.
- type in type=string
name of elements whose value is to be gotten.
top source SpdfSsc::getFileResultprivate
result = SpdfSsc::getFileResult(doc)
Creates an SpdfSscFileResult object from the given ssc:DataResult XML document.
Return value
SpdfSscFileResult object.
Parameters
- doc in type=IDLffXMLDOMDocument
SpdfSscDataResult XML document.
top source SpdfSsc::getFilesprivate
result = SpdfSsc::getFiles(doc)
Creates an array of SpdfSscFileDescription objects from the given ssc:Files XML document.
Return value
objarr containing SpdfSscFileDescriptions or an objarr(1) whose first element is ~obj_valid().
Parameters
- doc in type=IDLffXMLDOMDocument
SpdfFileResult XML document.
top source SpdfSsc::getDataResultprivate
result = SpdfSsc::getDataResult(doc)
Creates an SpdfSscDataResult object from the given ssc:DataResult XML document.
Return value
SpdfSscDataResult object.
Parameters
- doc in type=IDLffXMLDOMDocument
SpdfSscDataResult XML document.
top source SpdfSsc::getSatelliteDataprivate
result = SpdfSsc::getSatelliteData(doc)
Creates an SpdfSatelliteData object from the given ssc:SatelliteData XML document.
Return value
objarr containing SpdfSatelliteData or an objarr(1) whose first element is ~obj_valid().
Parameters
- doc in type=IDLffXMLDOMDocument
SpdfSatelliteData XML document.
top source SpdfSsc::getCoordinateDataprivate
result = SpdfSsc::getCoordinateData(satDataElement)
Creates an SpdfCoordinateData object from the given ssc:SatelliteData XML element.
Return value
SpdfCoordinateData object.
Parameters
- satDataElement in type=IDLffXMLDOMElement
SpdfSatelliteData XML element.
top source SpdfSsc::getBTraceDataprivate
result = SpdfSsc::getBTraceData(satDataElement)
Creates an SpdfBTraceData object from the given ssc:BTraceData XML element.
Return value
SpdfCoordinateData object.
Parameters
- satDataElement in type=IDLffXMLDOMElement
SpdfSatelliteData XML element.
top source SpdfSsc::getDoubleSatelliteDataprivate
result = SpdfSsc::getDoubleSatelliteData(satDataElement, name)
Gets the specified double data values from the given satellite data.
Return value
array of double values.
Parameters
- satDataElement in type=IDLffXMLDOMElement
Satellite XML element.
- name in type=string
name of satellite data to get.
top source SpdfSsc::getFloatSatelliteDataprivate
result = SpdfSsc::getFloatSatelliteData(satDataElement, name)
Gets the specified float data values from the given satellite data.
Return value
array of float values.
Parameters
- satDataElement in type=IDLffXMLDOMElement
Satellite XML element.
- name in type=string
name of satellite data to get.
top source SpdfSsc::getSatelliteRegionDataprivate
result = SpdfSsc::getSatelliteRegionData(satDataElement, name)
Gets the specified region data values from the given satellite data.
Return value
strarr of region values. An empty string is returned if the value cannot be found.
Parameters
- satDataElement in type=IDLffXMLDOMElement
Satellite XML element.
- name in type=string
name of region data to get.
File attributes
| Modification date: | Tue May 21 09:17:13 2024 |
| Lines: | 398 |
SSC Feedback.