# SSC R2.4.17 Web Services API

## Generated by IDLdoc

## Index

. A B C D E F G H I K L M N O P Q R S T U V X Y Z

### .

./ directory

### A

ABSTRACT field in class SpdfCoordinates
ABSTRACT field in class SpdfExternalBFieldModel
allFilters field in class SpdfLocationFilterOptions

  boolean flag indicating whether all specified location filters must be true.

allFilters keyword in routine SpdfLocationFilterOptions::init in file spdflocationfilteroptions__define.pro

  specifies whether all or just one or more of the specified location filters must be satisfied.

allFilters property in class SpdfLocationFilterOptions
allLocationFilters field in class SpdfOutputOptions

  boolean flag indicating whether all specified location filters must be true.

allLocationFilters keyword in routine SpdfOutputOptions::init in file spdfoutputoptions__define.pro

  specifies whether all or just one or more of the specified location filters must be satisfied.

allLocationFilters property in class SpdfOutputOptions
arcLength field in class SpdfBTraceData

  arc length values.

arcLength keyword in routine SpdfBTraceData::init in file spdfbtracedata__define.pro

  arc length values.

arcLength property in class SpdfBTraceData

### B

basicFormat keyword in routine SpdfTimeInterval::getIso8601FromJulDay in file spdftimeinterval__define.pro

  Indicates whether the "basic" (minimal field separators) ISO 8601 format is to be returned.

basicFormat keyword in routine SpdfTimeInterval::getIso8601Start in file spdftimeinterval__define.pro

  Indicates whether the "basic" (minimal field separators) ISO 8601 format is to be returned.

basicFormat keyword in routine SpdfTimeInterval::getIso8601Stop in file spdftimeinterval__define.pro

  Indicates whether the "basic" (minimal field separators) ISO 8601 format is to be returned.

basicIso8601Format field in class SpdfTimeInterval

  constant format string for a "basic" (minimal field separators) ISO 8601 value.

bFieldModel field in class SpdfRequest

  magnetic field model to use.

bFieldModel keyword in routine SpdfLocationRequest::init in file spdflocationrequest__define.pro

  magnetic field model to use.

bFieldModel property in class SpdfLocationRequest
bFieldModel keyword in routine SpdfRequest::init in file spdfrequest__define.pro

  magnetic field model to use.

bFieldModel property in class SpdfRequest
bFieldModel keyword in routine SpdfSscDataRequest::init in file spdfsscdatarequest__define.pro

  magnetic field model to use.

bFieldModel property in class SpdfSscDataRequest
bFieldStrength field in class SpdfValueOptions

  specifies whether the magnetic field strength is to be included in the output.

bFieldStrength keyword in routine SpdfValueOptions::init in file spdfvalueoptions__define.pro

  specifies whether the magnetic field strength is to be included in the output.

bFieldStrength property in class SpdfValueOptions
bFieldTraceOptions field in class SpdfOutputOptions

  magnetic field trace options.

bFieldTraceOptions keyword in routine SpdfOutputOptions::init in file spdfoutputoptions__define.pro

  magnetic field trace options

bFieldTraceOptions property in class SpdfOutputOptions
bGseX field in class SpdfSatelliteData

  B GSE X values.

bGseX keyword in routine SpdfSatelliteData::init in file spdfsatellitedata__define.pro

  B GSE X values.

bGseX property in class SpdfSatelliteData
bGseXYZ field in class SpdfDistanceFromOptions

  specifies whether the B GSE X, Y, Z values are to be included in the output.

bGseXYZ keyword in routine SpdfDistanceFromOptions::init in file spdfdistancefromoptions__define.pro

  specifies whether the B GSE X, Y, Z values is to be included in the output.

bGseXYZ property in class SpdfDistanceFromOptions
bGseY field in class SpdfSatelliteData

  B GSE Y values.

bGseY keyword in routine SpdfSatelliteData::init in file spdfsatellitedata__define.pro

  B GSE Y values.

bGseY property in class SpdfSatelliteData
bGseZ field in class SpdfSatelliteData

  B GSE Z values.

bGseZ keyword in routine SpdfSatelliteData::init in file spdfsatellitedata__define.pro

  B GSE Z values.

bGseZ property in class SpdfSatelliteData
bowShock field in class SpdfDistanceFromOptions

  specifies whether the distance from the bow shock is to be included in the output.

bowShock keyword in routine SpdfDistanceFromOptions::init in file spdfdistancefromoptions__define.pro

  specifies whether the distance from the bow shock is to be included in the output.

bowShock property in class SpdfDistanceFromOptions
bowShockDistance field in class SpdfSatelliteData

  distance from bow shock.

bowShockDistance keyword in routine SpdfSatelliteData::init in file spdfsatellitedata__define.pro

  distance from bow shock.

bowShockDistance property in class SpdfSatelliteData
bTraceData field in class SpdfSatelliteData

  magnetic field trace data.

bTraceData keyword in routine SpdfSatelliteData::init in file spdfsatellitedata__define.pro

  magnetic field trace data.

bTraceData property in class SpdfSatelliteData
buffer keyword in routine SpdfSscFileDescription::getFile in file spdfsscfiledescription__define.pro

  if this keyword is set, the return value is a buffer and the FILENAME keyword is ignored.

byImf field in class SpdfTsyganenko96BFieldModel

  BY Interplanetary Magnetic Field (IMF) (range: -100 - 100 nT, default=0.0).

byImf keyword in routine SpdfTsyganenko96BFieldModel::init in file spdftsyganenko96bfieldmodel__define.pro

  BY Interplanetary Magnetic Field (IMF) (range: -100 - 100 nT, default=0.0).

byImf property in class SpdfTsyganenko96BFieldModel
bzImf field in class SpdfTsyganenko96BFieldModel

  BZ Interplanetary Magnetic Field (IMF) (range: -100 - 100 nT, default=0.0).

bzImf keyword in routine SpdfTsyganenko96BFieldModel::init in file spdftsyganenko96bfieldmodel__define.pro

  BZ Interplanetary Magnetic Field (IMF) (range: -100 - 100 nT, default=0.0).

bzImf property in class SpdfTsyganenko96BFieldModel

### C

callback_data keyword in routine SpdfSscFileDescription::getFile in file spdfsscfiledescription__define.pro

  this keyword value contains data that is passed to the caller when a callback is made.

callback_function keyword in routine SpdfSscFileDescription::getFile in file spdfsscfiledescription__define.pro

  this keyword value is the name of the IDL function that is to be called during this retrieval operation.

cdawebFormat field in class SpdfTimeInterval

  constant format string for a "cdaweb" time format.

cdf field in class SpdfFormatOptions

  boolean value indicating whether the output should be a CDF file.

cdf keyword in routine SpdfFormatOptions::init in file spdfformatoptions__define.pro

  boolean value indicating whether the output should be a CDF file.

cdf property in class SpdfFormatOptions
component field in class SpdfCoordinateOptions

  specifies the coordinate component.

component parameter in routine SpdfCoordinateOptions::init in file spdfcoordinateoptions__define.pro

  specifies the coordinate component.

component parameter in routine SpdfFilteredCoordinateOptions::init in file spdffilteredcoordinateoptions__define.pro

  specifies the coordinate component.

coordinateData field in class SpdfSatelliteData

  satellite coordinate data.

coordinateData parameter in routine SpdfSatelliteData::init in file spdfsatellitedata__define.pro

  satellite coordinate data.

coordinateOptions field in class SpdfOutputOptions

  coordinate options.

coordinateOptions parameter in routine SpdfOutputOptions::init in file spdfoutputoptions__define.pro

  specifies the coordinate options.

coordinateSystem field in class SpdfBFieldTraceOptions

  specifies whether the coordinate system is to be included in the output.

coordinateSystem keyword in routine SpdfBFieldTraceOptions::init in file spdfbfieldtraceoptions__define.pro

  specifies the coordinate system is to be included in the output.

coordinateSystem property in class SpdfBFieldTraceOptions
coordinateSystem field in class SpdfBTraceData

  coordinate system.

coordinateSystem parameter in routine SpdfBTraceData::init in file spdfbtracedata__define.pro

  coordinate system.

coordinateSystem field in class SpdfCoordinateData

  coordinate system identifier.

coordinateSystem parameter in routine SpdfCoordinateData::init in file spdfcoordinatedata__define.pro

  coordinate system (valid values: "Geo", "Gm", "Gse", "Gsm", "Sm", "GeiTod", "GeiJ2000").

coordinateSystem field in class SpdfCoordinateOptions

  specifies the coordinate system.

coordinateSystem parameter in routine SpdfCoordinateOptions::init in file spdfcoordinateoptions__define.pro

  specifies the coordinateSystem.

coordinateSystem parameter in routine SpdfFilteredCoordinateOptions::init in file spdffilteredcoordinateoptions__define.pro

  specifies the coordinateSystem.

coordinateSystem keyword in routine SpdfGetLocations in file spdfgetlocations.pro

  specifies the coordinate system.

coordinateSystem parameter in routine SpdfLocations::init in file spdflocations__define.pro

  coordinate system (valid values: "Geo", "Gm", "Gse", "Gsm", "Sm", "GeiTod", "GeiJ2000").

currentVersionUrl field in class SpdfRest

  URL to the file identifying the most up to date version of this class.

currentVersionUrl parameter in routine SpdfRest::init in file spdfrest__define.pro

  URL to the file identifying the most up to date version of this class.

### D

data field in class SpdfSscDataResult

  result data.

data parameter in routine SpdfSscDataResult::init in file spdfsscdataresult__define.pro

  result data.

dateFormat field in class SpdfFormatOptions

  value indicating the format for date values ('yyyy_ddd', 'yy_mm_dd', 'yy_Mmm_dd', 'yy_CMMM_dd')

dateFormat keyword in routine SpdfFormatOptions::init in file spdfformatoptions__define.pro

  specifies the format for date values ('yyyy_ddd', 'yy_mm_dd', 'yy_Mmm_dd', 'yy_CMMM_dd')

dateFormat property in class SpdfFormatOptions
degreeDigits field in class SpdfFormatOptions

  integer value specifying the number of decimal places to include when displaying degree values.

degreeDigits keyword in routine SpdfFormatOptions::init in file spdfformatoptions__define.pro

  specifies the number of decimal places to include when displaying degree values.

degreeDigits property in class SpdfFormatOptions
degreeFormat field in class SpdfFormatOptions

  value indicating the format for degree values ('Decimal', 'Minutes', 'MinutesSeconds')

degreeFormat keyword in routine SpdfFormatOptions::init in file spdfformatoptions__define.pro

  specifies the format for degree values ('Decimal', 'Minutes', 'MinutesSeconds')

degreeFormat property in class SpdfFormatOptions
description field in class SpdfRequest

  a textual description of this request.

description keyword in routine SpdfLocationRequest::init in file spdflocationrequest__define.pro

  a textual description of this request.

description property in class SpdfLocationRequest
description keyword in routine SpdfRequest::init in file spdfrequest__define.pro

  a textual description of this request.

description property in class SpdfRequest
description keyword in routine SpdfSscDataRequest::init in file spdfsscdatarequest__define.pro

  a textual description of this request.

description property in class SpdfSscDataRequest
dipoleInvariantLatitude field in class SpdfLocationFilterOptions

  dipole invariant latitude filter.

dipoleInvariantLatitude keyword in routine SpdfLocationFilterOptions::init in file spdflocationfilteroptions__define.pro
dipoleInvariantLatitude property in class SpdfLocationFilterOptions
dipoleInvariantLatitude field in class SpdfSatelliteData

  dipole invariant latitude values.

dipoleInvariantLatitude keyword in routine SpdfSatelliteData::init in file spdfsatellitedata__define.pro

  dipole invariant latitude values.

dipoleInvariantLatitude property in class SpdfSatelliteData
dipoleInvLat field in class SpdfValueOptions

  specifies whether the dipole invariant latitude is to be included in the output.

dipoleInvLat keyword in routine SpdfValueOptions::init in file spdfvalueoptions__define.pro

  specifies whether the dipole invariant latitude is to be included in the output.

dipoleInvLat property in class SpdfValueOptions
dipoleLValue field in class SpdfLocationFilterOptions

  dipole L value filter.

dipoleLValue keyword in routine SpdfLocationFilterOptions::init in file spdflocationfilteroptions__define.pro
dipoleLValue property in class SpdfLocationFilterOptions
dipoleLValue field in class SpdfSatelliteData

  dipole L values.

dipoleLValue keyword in routine SpdfSatelliteData::init in file spdfsatellitedata__define.pro

  dipole L values.

dipoleLValue property in class SpdfSatelliteData
dipoleLValue field in class SpdfValueOptions

  specifies whether the dipole L value is to be included in the output.

dipoleLValue keyword in routine SpdfValueOptions::init in file spdfvalueoptions__define.pro

  specifies whether the dipole L value is to be included in the output.

dipoleLValue property in class SpdfValueOptions
distanceDigits field in class SpdfFormatOptions

  integer value specifying the number of decimal digits to include when displaying distance values in scientific notation.

distanceDigits keyword in routine SpdfFormatOptions::init in file spdfformatoptions__define.pro

  specifies the number of decimal places to include when displaying distance values in scientific notation.

distanceDigits property in class SpdfFormatOptions
distanceFormat field in class SpdfFormatOptions

  value indicating the format for distance values ('Re', 'Km', 'IntegerKm', 'ScientificNotationKm')

distanceFormat keyword in routine SpdfFormatOptions::init in file spdfformatoptions__define.pro

  specifies the units for distance values ('Re', 'Km', 'IntegerKm', 'ScientificNotationKm')

distanceFormat property in class SpdfFormatOptions
distanceFromBowShock field in class SpdfLocationFilterOptions

  distance from bowshock filter.

distanceFromBowShock keyword in routine SpdfLocationFilterOptions::init in file spdflocationfilteroptions__define.pro
distanceFromBowShock property in class SpdfLocationFilterOptions
distanceFromCenterOfEarth field in class SpdfLocationFilterOptions

  distance from center of Earth filter.

distanceFromCenterOfEarth keyword in routine SpdfLocationFilterOptions::init in file spdflocationfilteroptions__define.pro

  distance from the center of the Earth filter.

distanceFromCenterOfEarth property in class SpdfLocationFilterOptions
distanceFromMagnetopause field in class SpdfLocationFilterOptions

  distance from magnetopause filter.

distanceFromMagnetopause keyword in routine SpdfLocationFilterOptions::init in file spdflocationfilteroptions__define.pro
distanceFromMagnetopause property in class SpdfLocationFilterOptions
distanceFromNeutralSheet field in class SpdfLocationFilterOptions

  distance from neutral sheet filter.

distanceFromNeutralSheet keyword in routine SpdfLocationFilterOptions::init in file spdflocationfilteroptions__define.pro
distanceFromNeutralSheet property in class SpdfLocationFilterOptions
distanceFromOptions field in class SpdfOutputOptions

  distance from options.

distanceFromOptions keyword in routine SpdfOutputOptions::init in file spdfoutputoptions__define.pro

  {type=SpdfDistanceFromOptions) specifies distance-from options.

distanceFromOptions property in class SpdfOutputOptions
doc parameter in routine SpdfBFieldModel::createDomElement in file spdfbfieldmodel__define.pro

  document in which to create the DataRequest element.

doc parameter in routine SpdfBFieldTraceOptions::createDomElement in file spdfbfieldtraceoptions__define.pro

  document in which to create the DataRequest element.

doc parameter in routine SpdfCoordinateOptions::createDomElement in file spdfcoordinateoptions__define.pro

  document in which to create the DataRequest element.

doc parameter in routine SpdfDistanceFromOptions::createDomElement in file spdfdistancefromoptions__define.pro

  document in which to create the DataRequest element.

doc parameter in routine SpdfFilteredCoordinateOptions::createDomElement in file spdffilteredcoordinateoptions__define.pro

  document in which to create the DataRequest element.

doc parameter in routine SpdfFormatOptions::createDomElement in file spdfformatoptions__define.pro

  document in which to create the DataRequest element.

doc parameter in routine SpdfLocationFilter::createDomElement in file spdflocationfilter__define.pro

  document in which to create the DataRequest element.

doc parameter in routine SpdfLocationFilterOptions::createDomElement in file spdflocationfilteroptions__define.pro

  document in which to create the DataRequest element.

doc parameter in routine SpdfLocationRequest::createDomElement in file spdflocationrequest__define.pro

  document in which to create the LocationRequest element.

doc parameter in routine SpdfOutputOptions::createDomElement in file spdfoutputoptions__define.pro

  document in which to create the DataRequest element.

doc parameter in routine SpdfRegionOptions::createDomElement in file spdfregionoptions__define.pro

  document in which to create the DataRequest element.

doc parameter in routine SpdfRequest::createDomElement in file spdfrequest__define.pro

  document in which to create the Request element.

doc parameter in routine SpdfSatelliteSpecification::createDomElement in file spdfsatellitespecification__define.pro

  document in which to create the SatelliteSpecification element.

doc parameter in routine SpdfSscDataRequest::createDomElement in file spdfsscdatarequest__define.pro

  document in which to create the DataRequest element.

doc parameter in routine SpdfTimeInterval::createDomElement in file spdftimeinterval__define.pro

  document in which to create the TimeInterval element.

doc parameter in routine SpdfTsyganenko87BFieldModel::createDomElement in file spdftsyganenko87bfieldmodel__define.pro

  document in which to create the DataRequest element.

doc parameter in routine SpdfTsyganenko89cBFieldModel::createDomElement in file spdftsyganenko89cbfieldmodel__define.pro

  document in which to create the DataRequest element.

doc parameter in routine SpdfTsyganenko96BFieldModel::createDomElement in file spdftsyganenko96bfieldmodel__define.pro

  document in which to create the DataRequest element.

doc parameter in routine SpdfValueOptions::createDomElement in file spdfvalueoptions__define.pro

  document in which to create the DataRequest element.

dstIndex field in class SpdfTsyganenko96BFieldModel

  Disturbance Storm Time (DST) index (range: -400 - 200 nT, default=-20).

dstIndex keyword in routine SpdfTsyganenko96BFieldModel::init in file spdftsyganenko96bfieldmodel__define.pro

  Disturbance Storm Time (DST) index (range: -400 - 200 nT, default=-20).

dstIndex property in class SpdfTsyganenko96BFieldModel

### E

endpoint keyword in routine SpdfGetLocations in file spdfgetlocations.pro

  URL of SSC web service.

endpoint field in class SpdfRest

  URL of SSC web service.

endpoint parameter in routine SpdfRest::init in file spdfrest__define.pro

  URL of SPDF web service.

endpoint keyword in routine SpdfSsc::init in file spdfssc__define.pro

  URL of SSC web service .

endpoint keyword in routine SpdfSscWsExample in file spdfsscwsexample.pro

  URL of CDAS web service.

endTime field in class SpdfSatelliteDescription

  julday end time value.

endTime parameter in routine SpdfObservatoryDescription::init in file spdfobservatorydescription__define.pro

  end time of available information.

endTime parameter in routine SpdfSatelliteDescription::init in file spdfsatellitedescription__define.pro

  end time of available information.

externalBFieldModel field in class SpdfBFieldModel

  external B-Field model.

externalBFieldModel keyword in routine SpdfBFieldModel::init in file spdfbfieldmodel__define.pro

  external magnetic field model.

externalBFieldModel property in class SpdfBFieldModel

### F

fieldLineLength field in class SpdfBFieldTraceOptions

  specifies whether the field line length value is to be included in the output.

fieldLineLength keyword in routine SpdfBFieldTraceOptions::init in file spdfbfieldtraceoptions__define.pro

  specifies whether the field line length value is to be included in the output.

fieldLineLength property in class SpdfBFieldTraceOptions
filename keyword in routine SpdfSscFileDescription::getFile in file spdfsscfiledescription__define.pro

  set this keyword equal to a string that holds the file name and path where the retrieved file is locally stored.

files field in class SpdfSscFileResult

  result files.

files parameter in routine SpdfSscFileResult::init in file spdfsscfileresult__define.pro

  result files.

filter field in class SpdfFilteredCoordinateOptions

  specifies filter criteria.

filter parameter in routine SpdfFilteredCoordinateOptions::init in file spdffilteredcoordinateoptions__define.pro

  coordinate value filter.

footpointLatitude field in class SpdfBFieldTraceOptions

  specifies whether the footpoint latitude value is to be included in the output.

footpointLatitude keyword in routine SpdfBFieldTraceOptions::init in file spdfbfieldtraceoptions__define.pro

  specifies whether the footpoint latitude value is to be included in the output.

footpointLatitude property in class SpdfBFieldTraceOptions
footpointLongitude field in class SpdfBFieldTraceOptions

  specifies whether the footpoint longitude value is to be included in the output.

footpointLongitude keyword in routine SpdfBFieldTraceOptions::init in file spdfbfieldtraceoptions__define.pro

  specifies whether the footpoint longitude value is to be included in the output.

footpointLongitude property in class SpdfBFieldTraceOptions
formatOptions field in class SpdfSscDataRequest

  request's format options.

formatOptions keyword in routine SpdfSscDataRequest::init in file spdfsscdatarequest__define.pro

  requested format options.

formatOptions property in class SpdfSscDataRequest

### G

geometry field in class SpdfSatelliteDescription

  satellite geometry.

geometry parameter in routine SpdfObservatoryDescription::init in file spdfobservatorydescription__define.pro

  URL of the file containing the recommended X3D geometry description for rendering the satellite.

geometry parameter in routine SpdfSatelliteDescription::init in file spdfsatellitedescription__define.pro

  URL of the file containing the recommended X3D geometry description for rendering the satellite.

GROUPIDS field in class SpdfObservatoryDescription
groupIds parameter in routine SpdfObservatoryDescription::init in file spdfobservatorydescription__define.pro

  /Spase/ObservatoryGroupID values.

### H

hemisphere field in class SpdfBFieldTraceOptions

  specifies whether the hemisphere to be included in the output.

hemisphere keyword in routine SpdfBFieldTraceOptions::init in file spdfbfieldtraceoptions__define.pro

  specifies the hemisphere to be included in the output.

hemisphere property in class SpdfBFieldTraceOptions
hemisphere field in class SpdfBTraceData

  hemisphere.

hemisphere parameter in routine SpdfBTraceData::init in file spdfbtracedata__define.pro

  hemisphere.

httpErrorReporter keyword in routine SpdfGetLocations in file spdfgetlocations.pro

  used to report an HTTP error.

httpErrorReporter keyword in routine SpdfSsc::getObservatories in file spdfssc__define.pro

  used to report an HTTP error.

httpErrorReporter keyword in routine SpdfSsc::getGroundStations in file spdfssc__define.pro

  used to report an HTTP error.

### I

id field in class SpdfGroundStation

  ground station identifier.

id parameter in routine SpdfGroundStation::init in file spdfgroundstation__define.pro

  ground station identifier.

id field in class SpdfLocations

  satellite identifier.

id parameter in routine SpdfLocations::init in file spdflocations__define.pro

  satellite identifier.

id field in class SpdfSatelliteDescription

  ground station identifier.

id parameter in routine SpdfObservatoryDescription::init in file spdfobservatorydescription__define.pro

  observatory identifier.

id field in class SpdfSatelliteData

  satellite identifier.

id parameter in routine SpdfSatelliteData::init in file spdfsatellitedata__define.pro

  satellite identifier.

id parameter in routine SpdfSatelliteDescription::init in file spdfsatellitedescription__define.pro

  satellite identifier.

id field in class SpdfSatelliteSpecification

  satellite identifier.

id parameter in routine SpdfSatelliteSpecification::init in file spdfsatellitespecification__define.pro

  satellite identifier.

internalBFieldModel field in class SpdfBFieldModel

  internal B-Field model.

internalBFieldModel keyword in routine SpdfBFieldModel::init in file spdfbfieldmodel__define.pro

  internal magnetic field model (valid values: "IGRF", "SimpleDipole").

internalBFieldModel property in class SpdfBFieldModel
iso8601Format field in class SpdfTimeInterval

  constant format string for an ISO 8601 value.

### K

keyParameterValues field in class SpdfTsyganenko87BFieldModel

  model's key parameter values.

keyParameterValues keyword in routine SpdfTsyganenko87BFieldModel::init in file spdftsyganenko87bfieldmodel__define.pro

  Model's key parameter values.

keyParameterValues property in class SpdfTsyganenko87BFieldModel
keyParameterValues field in class SpdfTsyganenko89cBFieldModel

  model's key parameter values.

keyParameterValues keyword in routine SpdfTsyganenko89cBFieldModel::init in file spdftsyganenko89cbfieldmodel__define.pro

  Model's key parameter values.

keyParameterValues property in class SpdfTsyganenko89cBFieldModel

### L

lastModified field in class SpdfSscFileDescription

  julday of the last time the file was modified.

lastModified parameter in routine SpdfSscFileDescription::init in file spdfsscfiledescription__define.pro

  time of last modification to file.

latitude field in class SpdfBTraceData

  latitude values.

latitude keyword in routine SpdfBTraceData::init in file spdfbtracedata__define.pro

  latitude values.

latitude property in class SpdfBTraceData
latitude field in class SpdfCoordinateData

  latitude values.

latitude keyword in routine SpdfCoordinateData::init in file spdfcoordinatedata__define.pro

  latitude values.

latitude property in class SpdfCoordinateData
latitude keyword in routine SpdfLocations::init in file spdflocations__define.pro

  latitude values.

latitude property in class SpdfLocations
latitude field in class SpdfSurfaceGeographicCoordinates

  latitude value.

latitude parameter in routine SpdfSurfaceGeographicCoordinates::init in file spdfsurfacegeographiccoordinates__define.pro

  latitude value.

latLonFormat field in class SpdfFormatOptions

  value indicating the format for direction/range values ('Lat90Lon360', 'Lat90Lon180', 'Lat90SnLon180We')

latLonFormat keyword in routine SpdfFormatOptions::init in file spdfformatoptions__define.pro

  specifies the format for direction/range values ('Lat90Lon360', 'Lat90Lon180', 'Lat90SnLon180We')

latLonFormat property in class SpdfFormatOptions
length field in class SpdfSscFileDescription

  file size in bytes.

length parameter in routine SpdfSscFileDescription::init in file spdfsscfiledescription__define.pro

  file's size in bytes.

linesPerPage field in class SpdfFormatOptions

  integer value indicating the number of lines per page for text output.

linesPerPage keyword in routine SpdfFormatOptions::init in file spdfformatoptions__define.pro

  specifies the number of lines per page for text output.

linesPerPage property in class SpdfFormatOptions
localTime field in class SpdfCoordinateData

  localTime values.

localTime keyword in routine SpdfCoordinateData::init in file spdfcoordinatedata__define.pro

  local time values.

localTime property in class SpdfCoordinateData
localTime keyword in routine SpdfLocations::init in file spdflocations__define.pro

  local time values.

localTime property in class SpdfLocations
location field in class SpdfGroundStation

  ground station's location.

location parameter in routine SpdfGroundStation::init in file spdfgroundstation__define.pro

  ground station location.

locationFilterOptions field in class SpdfSscDataRequest

  request's location filter options.

locationFilterOptions keyword in routine SpdfSscDataRequest::init in file spdfsscdatarequest__define.pro

  requested location filter options.

locationFilterOptions property in class SpdfSscDataRequest
longitude field in class SpdfBTraceData

  longitude values.

longitude keyword in routine SpdfBTraceData::init in file spdfbtracedata__define.pro

  longitude values.

longitude property in class SpdfBTraceData
longitude field in class SpdfCoordinateData

  longitude values.

longitude keyword in routine SpdfCoordinateData::init in file spdfcoordinatedata__define.pro

  longitude values.

longitude property in class SpdfCoordinateData
longitude keyword in routine SpdfLocations::init in file spdflocations__define.pro

  longitude values.

longitude property in class SpdfLocations
longitude field in class SpdfSurfaceGeographicCoordinates

  longitude value.

longitude parameter in routine SpdfSurfaceGeographicCoordinates::init in file spdfsurfacegeographiccoordinates__define.pro

  longitude value.

lowerLimit field in class SpdfLocationFilter

  specifies that the lower limit of values that should be included in the results.

lowerLimit keyword in routine SpdfLocationFilter::init in file spdflocationfilter__define.pro

  specifies that the lower limit of values that should be included in the results.

lowerLimit property in class SpdfLocationFilter

### M

magneticFieldStrength field in class SpdfLocationFilterOptions

  magnetic field strength filter.

magneticFieldStrength keyword in routine SpdfLocationFilterOptions::init in file spdflocationfilteroptions__define.pro
magneticFieldStrength property in class SpdfLocationFilterOptions
magneticStrength field in class SpdfSatelliteData

  magnetic field strength.

magneticStrength keyword in routine SpdfSatelliteData::init in file spdfsatellitedata__define.pro

  magnetic field strength.

magneticStrength property in class SpdfSatelliteData
magnetoPauseDistance field in class SpdfSatelliteData

  distance from magneto pause.

magnetoPauseDistance keyword in routine SpdfSatelliteData::init in file spdfsatellitedata__define.pro

  distance from magneto pause.

magnetoPauseDistance property in class SpdfSatelliteData
maximum field in class SpdfLocationFilter

  specifies that the maximum value should be included in the results.

maximum keyword in routine SpdfLocationFilter::init in file spdflocationfilter__define.pro

  specifies that the maximum value that should be included in the results.

maximum property in class SpdfLocationFilter
mimeType field in class SpdfSscFileDescription

  file's MIME type.

mimeType parameter in routine SpdfSscFileDescription::init in file spdfsscfiledescription__define.pro

  file's MIME type.

minimum field in class SpdfLocationFilter

  specifies that the minimum value should be included in the results.

minimum keyword in routine SpdfLocationFilter::init in file spdflocationfilter__define.pro

  specifies that the minimum value that should be included in the results.

minimum property in class SpdfLocationFilter
minMaxPoints field in class SpdfOutputOptions

  number of point to define minimum/maximum.

minMaxPoints keyword in routine SpdfOutputOptions::init in file spdfoutputoptions__define.pro

  number of points used to determine minima or maxima values.

minMaxPoints property in class SpdfOutputOptions
mPause field in class SpdfDistanceFromOptions

  specifies whether the distance from the magneto pause is to be included in the output.

mPause keyword in routine SpdfDistanceFromOptions::init in file spdfdistancefromoptions__define.pro

  specifies whether the distance from the magneto pause is to be included in the output.

mPause property in class SpdfDistanceFromOptions

### N

name field in class SpdfGroundStation

  ground station's name.

name parameter in routine SpdfGroundStation::init in file spdfgroundstation__define.pro

  ground station name.

name field in class SpdfSatelliteDescription

  ground station's name.

name parameter in routine SpdfObservatoryDescription::init in file spdfobservatorydescription__define.pro

  observatory name.

name parameter in routine SpdfSatelliteDescription::init in file spdfsatellitedescription__define.pro

  satellite name.

name field in class SpdfSscFileDescription

  file name.

name parameter in routine SpdfSscFileDescription::init in file spdfsscfiledescription__define.pro

  file name.

neutralSheet field in class SpdfDistanceFromOptions

  specifies whether the distance from the neutral sheet is to be included in the output.

neutralSheet keyword in routine SpdfDistanceFromOptions::init in file spdfdistancefromoptions__define.pro

  specifies whether the distance from the neutral sheet is to be included in the output.

neutralSheet property in class SpdfDistanceFromOptions
neutralSheetDistance field in class SpdfSatelliteData

  distance from neutral sheet.

neutralSheetDistance keyword in routine SpdfSatelliteData::init in file spdfsatellitedata__define.pro

  distance from neutral sheet.

neutralSheetDistance property in class SpdfSatelliteData
northBTracedFootpoint field in class SpdfRegionOptions

  specifies whether the north B traced footpoint regions are to be included in the output.

northBTracedFootpoint keyword in routine SpdfRegionOptions::init in file spdfregionoptions__define.pro

  specifies whether the north B traced footpoint regions are to be included in the output.

northBTracedFootpoint property in class SpdfRegionOptions
northBTracedFootpointRegions field in class SpdfSatelliteData

  north B traced regions.

northBTracedFootpointRegions keyword in routine SpdfSatelliteData::init in file spdfsatellitedata__define.pro

  north B traced regions.

northBTracedFootpointRegions property in class SpdfSatelliteData

### O

outputOptions field in class SpdfSscDataRequest

  request's output options.

outputOptions parameter in routine SpdfSscDataRequest::init in file spdfsscdatarequest__define.pro

  requested output options.

### P

proxy_authentication field in class SpdfRest

  IDLnetURL PROXY_AUTHENTICATION property value.

proxy_authentication field in class SpdfSscFileDescription

  IDLnetURL PROXY_AUTHENTICATION property value.

proxy_hostname field in class SpdfRest

  IDLnetURL PROXY_HOSTNAME property value.

proxy_hostname field in class SpdfSscFileDescription

  IDLnetURL PROXY_HOSTNAME property value.

proxy_password field in class SpdfRest

  IDLnetURL PROXY_PASSWORD property value.

proxy_password field in class SpdfSscFileDescription

  IDLnetURL PROXY_PASSWORD property value.

proxy_port field in class SpdfRest

  IDLnetURL PROXY_PORT property value.

proxy_port field in class SpdfSscFileDescription

  IDLnetURL PROXY_PORT property value.

proxy_username field in class SpdfRest

  IDLnetURL PROXY_USERNAME property value.

proxy_username field in class SpdfSscFileDescription

  IDLnetURL PROXY_USERNAME property value.

### Q

quiet keyword in routine SpdfGetLocations in file spdfgetlocations.pro

  SpdfGetLocations normally prints an error message if no data is found.

### R

radialDistance field in class SpdfValueOptions

  specifies whether the radial distance is to be included in the output.

radialDistance keyword in routine SpdfValueOptions::init in file spdfvalueoptions__define.pro

  specifies whether the radial distance is to be included in the output.

radialDistance property in class SpdfValueOptions
radialLength field in class SpdfSatelliteData

  distance from center of Earth.

radialLength keyword in routine SpdfSatelliteData::init in file spdfsatellitedata__define.pro

  distance from center of Earth.

radialLength property in class SpdfSatelliteData
radialTracedFootpoint field in class SpdfRegionOptions

  specifies whether the radial traced footpoint regions are to be included in the output.

radialTracedFootpoint keyword in routine SpdfRegionOptions::init in file spdfregionoptions__define.pro

  specifies whether the radial traced footpoint regions are to be included in the output.

radialTracedFootpoint property in class SpdfRegionOptions
radialTracedFootpointRegions field in class SpdfSatelliteData

  radial trace footpoint region.

radialTracedFootpointRegions keyword in routine SpdfSatelliteData::init in file spdfsatellitedata__define.pro

  radial traced footpoint region.

radialTracedFootpointRegions property in class SpdfSatelliteData
regionFilterOptions field in class SpdfSscDataRequest

  request's region filter options.

regionOptions field in class SpdfOutputOptions

  region options.

regionOptions keyword in routine SpdfOutputOptions::init in file spdfoutputoptions__define.pro

  specifies the region options.

regionOptions property in class SpdfOutputOptions
regionOptions keyword in routine SpdfSscDataRequest::init in file spdfsscdatarequest__define.pro

  requested region options.

regionOptions property in class SpdfSscDataRequest
resolution field in class SpdfSatelliteDescription

  trajectory resolution.

resolution parameter in routine SpdfObservatoryDescription::init in file spdfobservatorydescription__define.pro

  resolution of trajectory information.

resolution parameter in routine SpdfSatelliteDescription::init in file spdfsatellitedescription__define.pro

  resolution of trajectory information.

resolutionFactor keyword in routine SpdfGetLocations in file spdfgetlocations.pro

  resolution factor.

resolutionFactor field in class SpdfSatelliteSpecification

  resolution factor.

resolutionFactor parameter in routine SpdfSatelliteSpecification::init in file spdfsatellitespecification__define.pro

  resolution factor.

resourceId field in class SpdfObservatoryDescription

  observatory resource identifier.

resourceId parameter in routine SpdfObservatoryDescription::init in file spdfobservatorydescription__define.pro

  observatory resource identifier.

responseCode parameter in routine SpdfHttpErrorReporter::reportError in file spdfhttperrorreporter__define.pro

  the HTTP response code of the request causing the error.

responseFilename parameter in routine SpdfHttpErrorReporter::reportError in file spdfhttperrorreporter__define.pro

  the name of an error response file sent when the error occurred.

responseFilename parameter in routine SpdfHttpErrorReporter::printResponse in file spdfhttperrorreporter__define.pro

  the name of an error response file sent when the error occurred.

responseHeader parameter in routine SpdfHttpErrorReporter::reportError in file spdfhttperrorreporter__define.pro

  the HTTP response header of the request causing the error.

result parameter in routine SpdfPrintConjunctionResult in file spdfsscwsconjunctionexample.pro

  QueryResult to print.

retryAfterTime field in class SpdfHttpErrorReporter

  number of seconds elapsed since 1970-01-01 when we can retry a request following an HTTP response with status 429/503 and an HTTP Retry-After header value.

retryLimit field in class SpdfRest

  retry limit for requests that fail with an http status of 429 or 503 with a Retry-After header.

### S

satellite parameter in routine SpdfGetLocations in file spdfgetlocations.pro

  identifies the satellite whose location is to be gotten.

satellites field in class SpdfLocationRequest

  requested satellites.

satellites parameter in routine SpdfLocationRequest::init in file spdflocationrequest__define.pro

  requested satellites.

satellites parameter in routine SpdfSscDataRequest::init in file spdfsscdatarequest__define.pro

  requested satellites.

shortIso8601Format field in class SpdfTimeInterval

  short version of a constant format string for an ISO 8601 value.

solarWindPressure field in class SpdfTsyganenko96BFieldModel

  solar wind pressure (range: 0 - 30 nP, default=2.1).

solarWindPressure keyword in routine SpdfTsyganenko96BFieldModel::init in file spdftsyganenko96bfieldmodel__define.pro

  solar wind pressure (range: 0 - 30 nP, default=2.1).

solarWindPressure property in class SpdfTsyganenko96BFieldModel
southBTracedFootpoint field in class SpdfRegionOptions

  specifies whether the south B traced footpoint regions are to be included in the output.

southBTracedFootpoint keyword in routine SpdfRegionOptions::init in file spdfregionoptions__define.pro

  specifies whether the south B traced footpoint regions are to be included in the output.

southBTracedFootpoint property in class SpdfRegionOptions
southBTracedFootpointRegions field in class SpdfSatelliteData

  south B traced regions.

southBTracedFootpointRegions keyword in routine SpdfSatelliteData::init in file spdfsatellitedata__define.pro

  south B traced regions.

southBTracedFootpointRegions property in class SpdfSatelliteData
spacecraft field in class SpdfRegionOptions

  specifies whether the spacecraft regions are to be included in the output.

spacecraft keyword in routine SpdfRegionOptions::init in file spdfregionoptions__define.pro

  specifies whether the spacecraft regions are to be included in the output.

spacecraft property in class SpdfRegionOptions
spacecraftRegion field in class SpdfSatelliteData

  spacecraft region.

spacecraftRegion keyword in routine SpdfSatelliteData::init in file spdfsatellitedata__define.pro

  spacecraft region.

spacecraftRegion property in class SpdfSatelliteData
SpdfBFieldModel class
SpdfBFieldModel::cleanup routine in spdfbfieldmodel__define.pro

  Performs cleanup operations when this object is destroyed.

SpdfBFieldModel::createDomElement routine in spdfbfieldmodel__define.pro

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

SpdfBFieldModel::getExternalBFieldModel routine in spdfbfieldmodel__define.pro

  Gets the external B field model.

SpdfBFieldModel::getInternalBFieldModel routine in spdfbfieldmodel__define.pro

  Gets the internal B field model value.

SpdfBFieldModel::getTraceStopAltitude routine in spdfbfieldmodel__define.pro

  Gets the trace stop altitude value.

SpdfBFieldModel::init routine in spdfbfieldmodel__define.pro

  Creates an SpdfBFieldModel object.

SpdfBFieldModel__define routine in spdfbfieldmodel__define.pro

  Defines the SpdfBFieldModel class.

spdfbfieldmodel__define.pro .pro file in ./ directory

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

SpdfBFieldTraceOptions class
SpdfBFieldTraceOptions::cleanup routine in spdfbfieldtraceoptions__define.pro

  Performs cleanup operations when this object is destroyed.

SpdfBFieldTraceOptions::createDomElement routine in spdfbfieldtraceoptions__define.pro

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

SpdfBFieldTraceOptions::getCoordinateSystem routine in spdfbfieldtraceoptions__define.pro

  Gets the coordinate system value.

SpdfBFieldTraceOptions::getFieldLineLength routine in spdfbfieldtraceoptions__define.pro

  Gets the field-line length value.

SpdfBFieldTraceOptions::getFootpointLatitude routine in spdfbfieldtraceoptions__define.pro

  Gets the footpoint latitude value.

SpdfBFieldTraceOptions::getFootpointLongitude routine in spdfbfieldtraceoptions__define.pro

  Gets the footpoint longitude value.

SpdfBFieldTraceOptions::getHemisphere routine in spdfbfieldtraceoptions__define.pro

  Gets the hemisphere value.

SpdfBFieldTraceOptions::init routine in spdfbfieldtraceoptions__define.pro

  Creates an SpdfBFieldTraceOptions object.

SpdfBFieldTraceOptions__define routine in spdfbfieldtraceoptions__define.pro

  Defines the SpdfBFieldTraceOptions class.

spdfbfieldtraceoptions__define.pro .pro file in ./ directory

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

SpdfBTraceData class
SpdfBTraceData::cleanup routine in spdfbtracedata__define.pro

  Performs cleanup operations when this object is destroyed.

SpdfBTraceData::getArcLength routine in spdfbtracedata__define.pro

  Gets the ArcLength values.

SpdfBTraceData::getCoordinateSystem routine in spdfbtracedata__define.pro

  Gets the coordinate system value.

SpdfBTraceData::getHemisphere routine in spdfbtracedata__define.pro

  Gets the hemisphere value.

SpdfBTraceData::getLatitude routine in spdfbtracedata__define.pro

  Gets the latitude values.

SpdfBTraceData::getLongitude routine in spdfbtracedata__define.pro

  Gets the longitude values.

SpdfBTraceData::init routine in spdfbtracedata__define.pro

  Creates an SpdfBTraceData object.

SpdfBTraceData__define routine in spdfbtracedata__define.pro

  Defines the SpdfBTraceData class.

spdfbtracedata__define.pro .pro file in ./ directory

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

SpdfCoordinateData class
SpdfCoordinateData::cleanup routine in spdfcoordinatedata__define.pro

  Performs cleanup operations when this object is destroyed.

SpdfCoordinateData::getCoordinateSystem routine in spdfcoordinatedata__define.pro

  Gets the coordinate system value.

SpdfCoordinateData::getLatitude routine in spdfcoordinatedata__define.pro

  Gets the latitude values.

SpdfCoordinateData::getLocalTime routine in spdfcoordinatedata__define.pro

  Gets the local time values.

SpdfCoordinateData::getLongitude routine in spdfcoordinatedata__define.pro

  Gets the longitude values.

SpdfCoordinateData::getX routine in spdfcoordinatedata__define.pro

  Gets the X values.

SpdfCoordinateData::getY routine in spdfcoordinatedata__define.pro

  Gets the Y values.

SpdfCoordinateData::getZ routine in spdfcoordinatedata__define.pro

  Gets the Z values.

SpdfCoordinateData::init routine in spdfcoordinatedata__define.pro

  Creates an SpdfCoordinateData object.

SpdfCoordinateData__define routine in spdfcoordinatedata__define.pro

  Defines the SpdfCoordinateData class.

spdfcoordinatedata__define.pro .pro file in ./ directory

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

SpdfCoordinateOptions class
SpdfCoordinateOptions::cleanup routine in spdfcoordinateoptions__define.pro

  Performs cleanup operations when this object is destroyed.

SpdfCoordinateOptions::createDomElement routine in spdfcoordinateoptions__define.pro

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

SpdfCoordinateOptions::getComponent routine in spdfcoordinateoptions__define.pro

  Gets the coordinate component value.

SpdfCoordinateOptions::getCoordinateSystem routine in spdfcoordinateoptions__define.pro

  Gets the coordinate system value.

SpdfCoordinateOptions::init routine in spdfcoordinateoptions__define.pro

  Creates an SpdfCoordinateOptions object.

SpdfCoordinateOptions__define routine in spdfcoordinateoptions__define.pro

  Defines the SpdfCoordinateOptions class.

spdfcoordinateoptions__define.pro .pro file in ./ directory

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

SpdfCoordinates class
SpdfCoordinates::cleanup routine in spdfcoordinates__define.pro

  Performs cleanup operations when this object is destroyed.

SpdfCoordinates::init routine in spdfcoordinates__define.pro

  Creates an SpdfCoordinates object.

SpdfCoordinates__define routine in spdfcoordinates__define.pro

  Defines the (abstract) SpdfCoordinates class.

spdfcoordinates__define.pro .pro file in ./ directory

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

SpdfDistanceFromOptions class
SpdfDistanceFromOptions::cleanup routine in spdfdistancefromoptions__define.pro

  Performs cleanup operations when this object is destroyed.

SpdfDistanceFromOptions::createDomElement routine in spdfdistancefromoptions__define.pro

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

SpdfDistanceFromOptions::getBGseXYZ routine in spdfdistancefromoptions__define.pro

  Gets the bGseXYZ value.

SpdfDistanceFromOptions::getBowShock routine in spdfdistancefromoptions__define.pro

  Gets the distance from the bow shock value.

SpdfDistanceFromOptions::getMPause routine in spdfdistancefromoptions__define.pro

  Gets the distance from the magneto pause value.

SpdfDistanceFromOptions::getNeutralSheet routine in spdfdistancefromoptions__define.pro

  Gets the distance from the neutral sheet value.

SpdfDistanceFromOptions::init routine in spdfdistancefromoptions__define.pro

  Creates an SpdfDistanceFromOptions object.

SpdfDistanceFromOptions__define routine in spdfdistancefromoptions__define.pro

  Defines the SpdfDistanceFromOptions class.

spdfdistancefromoptions__define.pro .pro file in ./ directory

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

SpdfExternalBFieldModel class
SpdfExternalBFieldModel::cleanup routine in spdfexternalbfieldmodel__define.pro

  Performs cleanup operations when this object is destroyed.

SpdfExternalBFieldModel::init routine in spdfexternalbfieldmodel__define.pro

  Creates an SpdfExternalBFieldModel object.

SpdfExternalBFieldModel__define routine in spdfexternalbfieldmodel__define.pro

  Defines the (abstract) SpdfExternalBFieldModel class.

spdfexternalbfieldmodel__define.pro .pro file in ./ directory

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

SpdfFilteredCoordinateOptions class
SpdfFilteredCoordinateOptions::cleanup routine in spdffilteredcoordinateoptions__define.pro

  Performs cleanup operations when this object is destroyed.

SpdfFilteredCoordinateOptions::createDomElement routine in spdffilteredcoordinateoptions__define.pro

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

SpdfFilteredCoordinateOptions::getFilter routine in spdffilteredcoordinateoptions__define.pro

  Gets the filter value.

SpdfFilteredCoordinateOptions::init routine in spdffilteredcoordinateoptions__define.pro

  Creates an SpdfFilteredCoordinateOptions object.

SpdfFilteredCoordinateOptions__define routine in spdffilteredcoordinateoptions__define.pro

  Defines the SpdfFilteredCoordinateOptions class.

spdffilteredcoordinateoptions__define.pro .pro file in ./ directory

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

SpdfFormatOptions class
SpdfFormatOptions::cleanup routine in spdfformatoptions__define.pro

  Performs cleanup operations when this object is destroyed.

SpdfFormatOptions::createDomElement routine in spdfformatoptions__define.pro

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

SpdfFormatOptions::getCdf routine in spdfformatoptions__define.pro

  Gets the cdf value.

SpdfFormatOptions::getDateFormat routine in spdfformatoptions__define.pro

  Gets the dateFormat value.

SpdfFormatOptions::getDegreeDigits routine in spdfformatoptions__define.pro

  Gets the degreeDigits value.

SpdfFormatOptions::getDegreeFormat routine in spdfformatoptions__define.pro

  Gets the degreeFormat value.

SpdfFormatOptions::getDistanceDigits routine in spdfformatoptions__define.pro

  Gets the distanceDigits value.

SpdfFormatOptions::getDistanceFormat routine in spdfformatoptions__define.pro

  Gets the distanceFormat value.

SpdfFormatOptions::getLatLonFormat routine in spdfformatoptions__define.pro

  Gets the latLonFormat value.

SpdfFormatOptions::getLinesPerPage routine in spdfformatoptions__define.pro

  Gets the linesPerPage value.

SpdfFormatOptions::getTimeFormat routine in spdfformatoptions__define.pro

  Gets the timeFormat value.

SpdfFormatOptions::init routine in spdfformatoptions__define.pro

  Creates an SpdfFormatOptions object.

SpdfFormatOptions__define routine in spdfformatoptions__define.pro

  Defines the SpdfFormatOptions class.

spdfformatoptions__define.pro .pro file in ./ directory

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

SpdfGetExampleConjunctionRequest routine in spdfsscwsconjunctionexample.pro

  Creates an example conjunction query request.

SpdfGetLocations routine in spdfgetlocations.pro

  This function gets basic location information for a single satellite from NASA's Space Physics Data Facility Satellite Situation Center.

spdfgetlocations.pro .pro file in ./ directory

  This file contains a procedure-oriented wrapper to a subset of functionality from the SpdfSsc class (IDL client interface to Satellite Situation Center Web Services (SSC WSs)) library.

SpdfGroundStation class
SpdfGroundStation::cleanup routine in spdfgroundstation__define.pro

  Performs cleanup operations when this object is destroyed.

SpdfGroundStation::getId routine in spdfgroundstation__define.pro

  Gets the id of this ground station.

SpdfGroundStation::getLocation routine in spdfgroundstation__define.pro

  Gets the location of this ground station.

SpdfGroundStation::getName routine in spdfgroundstation__define.pro

  Gets the name of this ground station.

SpdfGroundStation::init routine in spdfgroundstation__define.pro

  Creates an SpdfGroundStation object.

SpdfGroundStation::print routine in spdfgroundstation__define.pro

  Prints a textual representation of this object.

SpdfGroundStation__define routine in spdfgroundstation__define.pro

  Defines the SpdfGroundStation class.

spdfgroundstation__define.pro .pro file in ./ directory

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

SpdfHttpErrorReporter class
SpdfHttpErrorReporter::cleanup routine in spdfhttperrorreporter__define.pro

  Performs cleanup operations when this object is destroyed.

SpdfHttpErrorReporter::getRetryAfterTime routine in spdfhttperrorreporter__define.pro

  Gets the retryAfterTime value.

SpdfHttpErrorReporter::init routine in spdfhttperrorreporter__define.pro

  Creates an SpdfHttpErrorReporter object.

SpdfHttpErrorReporter::printResponse routine in spdfhttperrorreporter__define.pro

  This procedure prints some diagnostic information from the given HTTP error response file.

SpdfHttpErrorReporter::reportError routine in spdfhttperrorreporter__define.pro

  This procedure is called when an HTTP error occurs.

SpdfHttpErrorReporter::waitUntilRetryAfterTime routine in spdfhttperrorreporter__define.pro

  Suspends execution until after any retryAfterTime.

SpdfHttpErrorReporter__define routine in spdfhttperrorreporter__define.pro

  Defines the SpdfHttpErrorReporter class.

spdfhttperrorreporter__define.pro .pro file in ./ directory

  This class represents an object that is used to report HTTP errors.
  Notes:

  1. This class exists in both the CDAS and SSC web service IDL libraries.
SpdfLocationFilter class
SpdfLocationFilter::cleanup routine in spdflocationfilter__define.pro

  Performs cleanup operations when this object is destroyed.

SpdfLocationFilter::createDomElement routine in spdflocationfilter__define.pro

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

SpdfLocationFilter::getLowerLimit routine in spdflocationfilter__define.pro

  Gets the LowerLimit value.

SpdfLocationFilter::getMaximum routine in spdflocationfilter__define.pro

  Gets the Maximum value.

SpdfLocationFilter::getMinimum routine in spdflocationfilter__define.pro

  Gets the Minimum value.

SpdfLocationFilter::getUpperLimit routine in spdflocationfilter__define.pro

  Gets the UpperLimit value.

SpdfLocationFilter::init routine in spdflocationfilter__define.pro

  Creates an SpdfLocationFilter object.

SpdfLocationFilter__define routine in spdflocationfilter__define.pro

  Defines the SpdfLocationFilter class.

spdflocationfilter__define.pro .pro file in ./ directory

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

SpdfLocationFilterOptions class
SpdfLocationFilterOptions::cleanup routine in spdflocationfilteroptions__define.pro

  Performs cleanup operations when this object is destroyed.

SpdfLocationFilterOptions::createDomElement routine in spdflocationfilteroptions__define.pro

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

SpdfLocationFilterOptions::getAllFilters routine in spdflocationfilteroptions__define.pro

  Gets the all-filters value.

SpdfLocationFilterOptions::getDipoleInvariantLatitude routine in spdflocationfilteroptions__define.pro

  Gets the dipole invariant latitude value filter value.

SpdfLocationFilterOptions::getDipoleLValue routine in spdflocationfilteroptions__define.pro

  Gets the dipole L value filter value.

SpdfLocationFilterOptions::getDistanceFromBowShock routine in spdflocationfilteroptions__define.pro

  Gets the distance from bowshock filter value.

SpdfLocationFilterOptions::getDistanceFromCenterOfEarth routine in spdflocationfilteroptions__define.pro

  Gets the distance from center of Earth filter value.

SpdfLocationFilterOptions::getDistanceFromMagnetopause routine in spdflocationfilteroptions__define.pro

  Gets the distance from magnetopause filter value.

SpdfLocationFilterOptions::getDistanceFromNeutralSheet routine in spdflocationfilteroptions__define.pro

  Gets the distance from neutral sheet filter value.

SpdfLocationFilterOptions::getMagneticFieldStrength routine in spdflocationfilteroptions__define.pro

  Gets the magnetic field strength filter value.

SpdfLocationFilterOptions::init routine in spdflocationfilteroptions__define.pro

  Creates an SpdfLocationFilterOptions object.

SpdfLocationFilterOptions__define routine in spdflocationfilteroptions__define.pro

  Defines the SpdfLocationFilterOptions class.

spdflocationfilteroptions__define.pro .pro file in ./ directory

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

SpdfLocationRequest class
SpdfLocationRequest::cleanup routine in spdflocationrequest__define.pro

  Performs cleanup operations when this object is destroyed.

SpdfLocationRequest::createDomElement routine in spdflocationrequest__define.pro

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

SpdfLocationRequest::getSatellites routine in spdflocationrequest__define.pro

  Gets the satellites.

SpdfLocationRequest::init routine in spdflocationrequest__define.pro

  Creates an SpdfLocationRequest object.

SpdfLocationRequest__define routine in spdflocationrequest__define.pro

  Defines the SpdfLocationRequest class.

spdflocationrequest__define.pro .pro file in ./ directory

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

SpdfLocations class
SpdfLocations::cleanup routine in spdflocations__define.pro

  Performs cleanup operations when this object is destroyed.

SpdfLocations::getId routine in spdflocations__define.pro

  Gets the id value.

SpdfLocations::getTime routine in spdflocations__define.pro

  Gets the time values.

SpdfLocations::init routine in spdflocations__define.pro

  Creates an SpdfLocations object.

SpdfLocations__define routine in spdflocations__define.pro

  Defines the SpdfLocations class.

spdflocations__define.pro .pro file in ./ directory

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

SpdfObservatoryDescription class
SpdfObservatoryDescription::cleanup routine in spdfobservatorydescription__define.pro

  Performs cleanup operations when this object is destroyed.

SpdfObservatoryDescription::getGroupIds routine in spdfobservatorydescription__define.pro

  Gets the groupIds of this satellite.

SpdfObservatoryDescription::getResourceId routine in spdfobservatorydescription__define.pro

  Gets the resourceId of this satellite.

SpdfObservatoryDescription::init routine in spdfobservatorydescription__define.pro

  Creates an SpdfObservatoryDescription object.

SpdfObservatoryDescription::print routine in spdfobservatorydescription__define.pro

  Prints a textual representation of this object.

SpdfObservatoryDescription__define routine in spdfobservatorydescription__define.pro

  Defines the SpdfObservatoryDescription class.

spdfobservatorydescription__define.pro .pro file in ./ directory

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

SpdfOutputOptions class
SpdfOutputOptions::cleanup routine in spdfoutputoptions__define.pro

  Performs cleanup operations when this object is destroyed.

SpdfOutputOptions::createDomElement routine in spdfoutputoptions__define.pro

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

SpdfOutputOptions::getAllLocationFilters routine in spdfoutputoptions__define.pro

  Gets the all-location-filters value.

SpdfOutputOptions::getBFieldTraceOptions routine in spdfoutputoptions__define.pro

  Gets the BFieldTraceOptions value.

SpdfOutputOptions::getCoordinateOptions routine in spdfoutputoptions__define.pro

  Gets the coordinate options value.

SpdfOutputOptions::getDistanceFromOptions routine in spdfoutputoptions__define.pro

  Gets the DistanceFromOptions value.

SpdfOutputOptions::getMinMaxPoints routine in spdfoutputoptions__define.pro

  Gets the minMaxPoints value.

SpdfOutputOptions::getRegionOptions routine in spdfoutputoptions__define.pro

  Gets the region options value.

SpdfOutputOptions::getValueOptions routine in spdfoutputoptions__define.pro

  Gets the ValueOptions value.

SpdfOutputOptions::init routine in spdfoutputoptions__define.pro

  Creates an SpdfOutputOptions object.

SpdfOutputOptions__define routine in spdfoutputoptions__define.pro

  Defines the SpdfOutputOptions class.

spdfoutputoptions__define.pro .pro file in ./ directory

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

SpdfPrintConjunctionResult routine in spdfsscwsconjunctionexample.pro

  Prints a Python Dict representation of a QueryResult as defined in SSC.xsd.

SpdfRegionOptions class
SpdfRegionOptions::cleanup routine in spdfregionoptions__define.pro

  Performs cleanup operations when this object is destroyed.

SpdfRegionOptions::createDomElement routine in spdfregionoptions__define.pro

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

SpdfRegionOptions::getNorthBTracedFootpoint routine in spdfregionoptions__define.pro

  Gets the north B traced footpoint value.

SpdfRegionOptions::getRadialTracedFootpoint routine in spdfregionoptions__define.pro

  Gets the radial traced footpoint value.

SpdfRegionOptions::getSouthBTracedFootpoint routine in spdfregionoptions__define.pro

  Gets the south B traced footpoint value.

SpdfRegionOptions::getSpacecraft routine in spdfregionoptions__define.pro

  Gets the spacecraft value.

SpdfRegionOptions::init routine in spdfregionoptions__define.pro

  Creates an SpdfRegionOptions object.

SpdfRegionOptions__define routine in spdfregionoptions__define.pro

  Defines the SpdfRegionOptions class.

spdfregionoptions__define.pro .pro file in ./ directory

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

SpdfRequest::cleanup routine in spdfrequest__define.pro

  Performs cleanup operations when this object is destroyed.

SpdfRequest::createDomElement routine in spdfrequest__define.pro

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

SpdfRequest::getBFieldModel routine in spdfrequest__define.pro

  Gets the bFieldModel value.

SpdfRequest::getDescription routine in spdfrequest__define.pro

  Gets the description value.

SpdfRequest::getTimeInterval routine in spdfrequest__define.pro

  Gets the timeInterval value.

SpdfRequest::init routine in spdfrequest__define.pro

  Creates an SpdfRequest object.

SpdfRequest__define routine in spdfrequest__define.pro

  Defines the SpdfRequest class.

spdfrequest__define.pro .pro file in ./ directory

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

SpdfRest class
SpdfRest::cleanup routine in spdfrest__define.pro

  Performs cleanup operations when this object is destroyed.

SpdfRest::getDefaultSslVerifyPeer routine in spdfrest__define.pro

  Gets the default value for the IDLnetURL SSL_VERIFY_PEER property based upon the runtime version of IDL.

SpdfRest::getEndpoint routine in spdfrest__define.pro

  Gets the current endpoint value.

SpdfRest::getUserAgent routine in spdfrest__define.pro

  Gets the current userAgent value.

SpdfRest::init routine in spdfrest__define.pro

  Creates an object representing the SPDF Web service.

SpdfRest__define routine in spdfrest__define.pro

  Defines the SpdfRest class.

spdfrest__define.pro .pro file in ./ directory

  This class represents the remotely callable interface to NASA's Space Physics Data Facility (SPDF) RESTful Web services.

SpdfResult class
SpdfResult::cleanup routine in spdfresult__define.pro

  Performs cleanup operations when this object is destroyed.

SpdfResult::getStatusCode routine in spdfresult__define.pro

  Gets the status code value.

SpdfResult::getStatusSubCode routine in spdfresult__define.pro

  Gets the status sub-code value.

SpdfResult::getStatusText routine in spdfresult__define.pro

  Gets the status text.

SpdfResult::init routine in spdfresult__define.pro

  Creates an SpdfResult object.

SpdfResult::print routine in spdfresult__define.pro

  Prints a textual representation of this object.

SpdfResult__define routine in spdfresult__define.pro

  Defines the SpdfResult class.

spdfresult__define.pro .pro file in ./ directory

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

SpdfSatelliteData class
SpdfSatelliteData::cleanup routine in spdfsatellitedata__define.pro

  Performs cleanup operations when this object is destroyed.

SpdfSatelliteData::getBGseX routine in spdfsatellitedata__define.pro

  Gets the B GSE X values.

SpdfSatelliteData::getBGseY routine in spdfsatellitedata__define.pro

  Gets the B GSE Y values.

SpdfSatelliteData::getBGseZ routine in spdfsatellitedata__define.pro

  Gets the B GSE Z values.

SpdfSatelliteData::getBowShockDistance routine in spdfsatellitedata__define.pro

  Gets the bow shock distance values.

SpdfSatelliteData::getBTraceData routine in spdfsatellitedata__define.pro

  Gets the B field trace data.

SpdfSatelliteData::getCoordinateData routine in spdfsatellitedata__define.pro

  Gets the coordinate data.

SpdfSatelliteData::getDipoleInvariantLatitude routine in spdfsatellitedata__define.pro

  Gets the dipole invariant latitude values.

SpdfSatelliteData::getDipoleLValue routine in spdfsatellitedata__define.pro

  Gets the dipole L values.

SpdfSatelliteData::getId routine in spdfsatellitedata__define.pro

  Gets the id value.

SpdfSatelliteData::getMagneticStrength routine in spdfsatellitedata__define.pro

  Gets the magnetic strength values.

SpdfSatelliteData::getMagnetoPauseDistance routine in spdfsatellitedata__define.pro

  Gets the magneto pause distance values.

SpdfSatelliteData::getNeutralSheetDistance routine in spdfsatellitedata__define.pro

  Gets the neutral sheet distance values.

SpdfSatelliteData::getNorthBTracedFootpointRegions routine in spdfsatellitedata__define.pro

  Gets the north B traced regions values.

SpdfSatelliteData::getRadialLength routine in spdfsatellitedata__define.pro

  Gets the radial length values.

SpdfSatelliteData::getRadialTracedFootpointRegions routine in spdfsatellitedata__define.pro

  Gets the radial trace footpoint region values.

SpdfSatelliteData::getSouthBTracedFootpointRegions routine in spdfsatellitedata__define.pro

  Gets the south B traced regions values.

SpdfSatelliteData::getSpacecraftRegion routine in spdfsatellitedata__define.pro

  Gets the spacecraft region values.

SpdfSatelliteData::getTime routine in spdfsatellitedata__define.pro

  Gets the time values.

SpdfSatelliteData::init routine in spdfsatellitedata__define.pro

  Creates an SpdfSatelliteData object.

SpdfSatelliteData__define routine in spdfsatellitedata__define.pro

  Defines the SpdfSatelliteData class.

spdfsatellitedata__define.pro .pro file in ./ directory

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

SpdfSatelliteDescription::cleanup routine in spdfsatellitedescription__define.pro

  Performs cleanup operations when this object is destroyed.

SpdfSatelliteDescription::getEndTime routine in spdfsatellitedescription__define.pro

  Gets the end time of this satellite.

SpdfSatelliteDescription::getGeometry routine in spdfsatellitedescription__define.pro

  Gets the geometry of this satellite.

SpdfSatelliteDescription::getId routine in spdfsatellitedescription__define.pro

  Gets the id of this satellite.

SpdfSatelliteDescription::getName routine in spdfsatellitedescription__define.pro

  Gets the name of this satellite.

SpdfSatelliteDescription::getResolution routine in spdfsatellitedescription__define.pro

  Gets the resolution of this satellite.

SpdfSatelliteDescription::getStartTime routine in spdfsatellitedescription__define.pro

  Gets the start time of this satellite.

SpdfSatelliteDescription::getTrajectoryGeometry routine in spdfsatellitedescription__define.pro

  Gets the trajectory geometry of this satellite.

SpdfSatelliteDescription::init routine in spdfsatellitedescription__define.pro

  Creates an SpdfSatelliteDescription object.

SpdfSatelliteDescription::print routine in spdfsatellitedescription__define.pro

  Prints a textual representation of this object.

SpdfSatelliteDescription__define routine in spdfsatellitedescription__define.pro

  Defines the SpdfSatelliteDescription class.

spdfsatellitedescription__define.pro .pro file in ./ directory

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

SpdfSatelliteSpecification class
SpdfSatelliteSpecification::cleanup routine in spdfsatellitespecification__define.pro

  Performs cleanup operations when this object is destroyed.

SpdfSatelliteSpecification::createDomElement routine in spdfsatellitespecification__define.pro

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

SpdfSatelliteSpecification::getId routine in spdfsatellitespecification__define.pro

  Gets the id value.

SpdfSatelliteSpecification::getResolutionFactor routine in spdfsatellitespecification__define.pro

  Gets the resolutionFactor value.

SpdfSatelliteSpecification::init routine in spdfsatellitespecification__define.pro

  Creates an SpdfSatelliteSpecification object.

SpdfSatelliteSpecification__define routine in spdfsatellitespecification__define.pro

  Defines the SpdfSatelliteSpecification class.

spdfsatellitespecification__define.pro .pro file in ./ directory

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

SpdfSsc class
SpdfSsc::cleanup routine in spdfssc__define.pro

  Performs cleanup operations when this object is destroyed.

SpdfSsc::getCurrentVersion routine in spdfrest__define.pro

  Gets the most up to date version of this class.

SpdfSsc::getDefaultDataview routine in spdfrest__define.pro

  Gets the current defaultDataview value.

SpdfSsc::getDefaultEndpoint routine in spdfssc__define.pro

  Gets the default endpoint value.

SpdfSsc::getGroundStations routine in spdfssc__define.pro

  Gets a description of all the ground stations that are available.

SpdfSsc::getObservatories routine in spdfssc__define.pro

  Gets a description of all the observatories that are available.

SpdfSsc::getVersion routine in spdfrest__define.pro

  Gets the version of this class.

SpdfSsc::init routine in spdfssc__define.pro

  Creates an object representing SSC.

SpdfSsc::isUpToDate routine in spdfrest__define.pro

  Compares getVersion() and getCurrentVersion() to determine if this class is up to date.

SpdfSsc__define routine in spdfssc__define.pro

  Defines the SpdfSsc class.

spdfssc__define.pro .pro file in ./ directory

  This class represents the remotely callable interface to NASA's Space Physics Data Facility (SPDF) Satellite Situation Center (SSC).

SpdfSscDataRequest class
SpdfSscDataRequest::cleanup routine in spdfsscdatarequest__define.pro

  Performs cleanup operations when this object is destroyed.

SpdfSscDataRequest::createDomElement routine in spdfsscdatarequest__define.pro

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

SpdfSscDataRequest::getOutputOptions routine in spdfsscdatarequest__define.pro

  Gets the output options.

SpdfSscDataRequest::init routine in spdfsscdatarequest__define.pro

  Creates an SpdfSscDataRequest object.

SpdfSscDataRequest__define routine in spdfsscdatarequest__define.pro

  Defines the SpdfSscDataRequest class.

spdfsscdatarequest__define.pro .pro file in ./ directory

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

SpdfSscDataResult class
SpdfSscDataResult::cleanup routine in spdfsscdataresult__define.pro

  Performs cleanup operations when this object is destroyed.

SpdfSscDataResult::getData routine in spdfsscdataresult__define.pro

  Gets the data.

SpdfSscDataResult::init routine in spdfsscdataresult__define.pro

  Creates an SpdfSscDataResult object.

SpdfSscDataResult__define routine in spdfsscdataresult__define.pro

  Defines the SpdfSscDataResult class.

spdfsscdataresult__define.pro .pro file in ./ directory

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

SpdfSscFileDescription class
SpdfSscFileDescription::cleanup routine in spdfsscfiledescription__define.pro

  Performs cleanup operations when this object is destroyed.

SpdfSscFileDescription::getFile routine in spdfsscfiledescription__define.pro

  Retrieves this file from a remote HTTP or FTP server and writes it to disk, a memory buffer, or an array of strings.

SpdfSscFileDescription::getLastModified routine in spdfsscfiledescription__define.pro

  Gets the last modified time.

SpdfSscFileDescription::getLength routine in spdfsscfiledescription__define.pro

  Gets the length of the file.

SpdfSscFileDescription::getMimeType routine in spdfsscfiledescription__define.pro

  Gets the MIME type of the file.

SpdfSscFileDescription::getName routine in spdfsscfiledescription__define.pro

  Gets the name of the file.

SpdfSscFileDescription::init routine in spdfsscfiledescription__define.pro

  Creates an SpdfSscFileDescription object.

SpdfSscFileDescription::print routine in spdfsscfiledescription__define.pro

  Prints a textual representation of this object.

SpdfSscFileDescription__define routine in spdfsscfiledescription__define.pro

  Defines the SpdfSscFileDescription class.

spdfsscfiledescription__define.pro .pro file in ./ directory

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

SpdfSscFileResult class
SpdfSscFileResult::cleanup routine in spdfsscfileresult__define.pro

  Performs cleanup operations when this object is destroyed.

SpdfSscFileResult::getFiles routine in spdfsscfileresult__define.pro

  Gets the files.

SpdfSscFileResult::init routine in spdfsscfileresult__define.pro

  Creates an SpdfSscFileResult object.

SpdfSscFileResult__define routine in spdfsscfileresult__define.pro

  Defines the SpdfSscFileResult class.

spdfsscfileresult__define.pro .pro file in ./ directory

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

SpdfSscWsConjunctionExample routine in spdfsscwsconjunctionexample.pro

  This procedure is an example to demonstrate calling the SSC REST Web Services from an IDL program.

spdfsscwsconjunctionexample.pro .pro file in ./ directory

  This program is an example to demonstrate calling the Satellite Situation Center's REST Web Services from an L3Harris Interactive Data Language (IDL) program.

SpdfSscWsExample routine in spdfsscwsexample.pro

  This procedure is an example to demonstrate calling the SSC REST Web Services from an IDL program.

spdfsscwsexample.pro .pro file in ./ directory

  This program is an example to demonstrate calling the Satellite Situation Center's REST Web Services from an Exelis Visual Information Solutions (VIS) Interactive Data Language (IDL) program.

SpdfSscWsExample2 routine in spdfsscwsexample2.pro

  This procedure is an example to demonstrate calling the SSC REST Web Services from an IDL program.

spdfsscwsexample2.pro .pro file in ./ directory

  This program is an example to demonstrate calling the Satellite Situation Center's REST Web Services from an Exelis Visual Information Solutions (VIS) Interactive Data Language (IDL) program.

SpdfSurfaceGeographicCoordinates class
SpdfSurfaceGeographicCoordinates::cleanup routine in spdfsurfacegeographiccoordinates__define.pro

  Performs cleanup operations when this object is destroyed.

SpdfSurfaceGeographicCoordinates::getLatitude routine in spdfsurfacegeographiccoordinates__define.pro

  Gets the latitude value.

SpdfSurfaceGeographicCoordinates::getLongitude routine in spdfsurfacegeographiccoordinates__define.pro

  Gets the longitude value.

SpdfSurfaceGeographicCoordinates::init routine in spdfsurfacegeographiccoordinates__define.pro

  Creates an SpdfSurfaceGeographicCoordinates object.

SpdfSurfaceGeographicCoordinates::print routine in spdfsurfacegeographiccoordinates__define.pro

  Prints a textual representation of this object.

SpdfSurfaceGeographicCoordinates__define routine in spdfsurfacegeographiccoordinates__define.pro

  Defines the SpdfSurfaceGeographicCoordinates class.

spdfsurfacegeographiccoordinates__define.pro .pro file in ./ directory

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

spdfTime field in class SpdfLocationFilter

  constant object used to call "static" methods of SpdfTimeInterval class.

SpdfTimeInterval class
SpdfTimeInterval::cleanup routine in spdftimeinterval__define.pro

  Performs cleanup operations when this object is destroyed.

SpdfTimeInterval::createDomElement routine in spdftimeinterval__define.pro

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

SpdfTimeInterval::getCdawebStart routine in spdftimeinterval__define.pro

  Get the start value.

SpdfTimeInterval::getCdawebStop routine in spdftimeinterval__define.pro

  Get the stop value.

SpdfTimeInterval::getIso8601FromJulDay routine in spdftimeinterval__define.pro

  Converts the given julday value into the corresponding ISO 8601 time value string.

SpdfTimeInterval::getIso8601Start routine in spdftimeinterval__define.pro

  Get the start value.

SpdfTimeInterval::getIso8601Stop routine in spdftimeinterval__define.pro

  Get the stop value.

SpdfTimeInterval::getJulDayFromIso8601 routine in spdftimeinterval__define.pro

  Converts the given ISO 8601 time value string into the corresponding julday value.

SpdfTimeInterval::getStart routine in spdftimeinterval__define.pro

  Get the start value.

SpdfTimeInterval::getStop routine in spdftimeinterval__define.pro

  Get the stop value.

SpdfTimeInterval::init routine in spdftimeinterval__define.pro

  Creates an SpdfTimeInterval object.

SpdfTimeInterval::isGreaterThan1Day routine in spdftimeinterval__define.pro

  Determines if this interval is larger than one day.

SpdfTimeInterval::isStartLessThanStop routine in spdftimeinterval__define.pro

  Determines if the start time is less than the stop time.

SpdfTimeInterval::print routine in spdftimeinterval__define.pro

  Prints a textual representation of this object.

SpdfTimeInterval::setStart routine in spdftimeinterval__define.pro

  Sets the start value.

SpdfTimeInterval::setStop routine in spdftimeinterval__define.pro

  Sets the stop value.

SpdfTimeInterval__define routine in spdftimeinterval__define.pro

  Defines the SpdfTimeInterval class.

spdftimeinterval__define.pro .pro file in ./ directory

  This class is an IDL representation of the TimeInterval element from the Coordinated Data Analysis System (CDAS) and Satellite Situation Center (SSC) XML schemas.

SpdfTsyganenko87BFieldModel class
SpdfTsyganenko87BFieldModel::cleanup routine in spdftsyganenko87bfieldmodel__define.pro

  Performs cleanup operations when this object is destroyed.

SpdfTsyganenko87BFieldModel::createDomElement routine in spdftsyganenko87bfieldmodel__define.pro

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

SpdfTsyganenko87BFieldModel::init routine in spdftsyganenko87bfieldmodel__define.pro

  Creates an SpdfTsyganenko87BFieldModel object.

SpdfTsyganenko87BFieldModel__define routine in spdftsyganenko87bfieldmodel__define.pro

  Defines the SpdfTsyganenko87BFieldModel class.

spdftsyganenko87bfieldmodel__define.pro .pro file in ./ directory

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

SpdfTsyganenko89cBFieldModel class
SpdfTsyganenko89cBFieldModel::cleanup routine in spdftsyganenko89cbfieldmodel__define.pro

  Performs cleanup operations when this object is destroyed.

SpdfTsyganenko89cBFieldModel::createDomElement routine in spdftsyganenko89cbfieldmodel__define.pro

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

SpdfTsyganenko89cBFieldModel::init routine in spdftsyganenko89cbfieldmodel__define.pro

  Creates an SpdfTsyganenko89cBFieldModel object.

SpdfTsyganenko89cBFieldModel__define routine in spdftsyganenko89cbfieldmodel__define.pro

  Defines the SpdfTsyganenko89cBFieldModel class.

spdftsyganenko89cbfieldmodel__define.pro .pro file in ./ directory

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

SpdfTsyganenko96BFieldModel class
SpdfTsyganenko96BFieldModel::cleanup routine in spdftsyganenko96bfieldmodel__define.pro

  Performs cleanup operations when this object is destroyed.

SpdfTsyganenko96BFieldModel::createDomElement routine in spdftsyganenko96bfieldmodel__define.pro

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

SpdfTsyganenko96BFieldModel::getSolarWindPressure routine in spdftsyganenko96bfieldmodel__define.pro

  Get the solar wind pressure value.

SpdfTsyganenko96BFieldModel::init routine in spdftsyganenko96bfieldmodel__define.pro

  Creates an SpdfTsyganenko96BFieldModel object.

SpdfTsyganenko96BFieldModel__define routine in spdftsyganenko96bfieldmodel__define.pro

  Defines the SpdfTsyganenko96BFieldModel class.

spdftsyganenko96bfieldmodel__define.pro .pro file in ./ directory

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

SpdfValueOptions class
SpdfValueOptions::cleanup routine in spdfvalueoptions__define.pro

  Performs cleanup operations when this object is destroyed.

SpdfValueOptions::createDomElement routine in spdfvalueoptions__define.pro

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

SpdfValueOptions::getBFieldStrength routine in spdfvalueoptions__define.pro

  Gets the magnetic field strength value.

SpdfValueOptions::getDipoleInvLat routine in spdfvalueoptions__define.pro

  Gets the dipole invariant latitude value.

SpdfValueOptions::getDipoleLValue routine in spdfvalueoptions__define.pro

  Gets the dipole L value.

SpdfValueOptions::getRadialDistance routine in spdfvalueoptions__define.pro

  Gets the radialDistance value.

SpdfValueOptions::init routine in spdfvalueoptions__define.pro

  Creates an SpdfValueOptions object.

SpdfValueOptions__define routine in spdfvalueoptions__define.pro

  Defines the SpdfValueOptions class.

spdfvalueoptions__define.pro .pro file in ./ directory

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

ssl_verify_peer field in class SpdfRest

  IDLnetURL SSL_VERIFY_PEER property value.

sslVerifyPeer keyword in routine SpdfGetLocations in file spdfgetlocations.pro

  Specifies whether the authenticity of the peer's SSL certificate should be verified.

sslVerifyPeer keyword in routine SpdfRest::init in file spdfrest__define.pro

  Specifies whether the authenticity of the peer's SSL certificate should be verified.

sslVerifyPeer property in class SpdfRest
sslVerifyPeer keyword in routine SpdfSsc::init in file spdfssc__define.pro

  Specifies whether the authenticity of the peer's SSL certificate should be verified.

sslVerifyPeer keyword in routine SpdfSscFileDescription::getFile in file spdfsscfiledescription__define.pro

  Specifies whether the authenticity of the peer's SSL certificate should be verified.

sslVerifyPeer keyword in routine SpdfSscWsExample in file spdfsscwsexample.pro

  Specifies whether the authenticity of the peer's SSL certificate should be verified.

start field in class SpdfTimeInterval

  julday start value of interval.

start parameter in routine SpdfTimeInterval::init in file spdftimeinterval__define.pro

  start time of interval.

startTime field in class SpdfSatelliteDescription

  julday start time value.

startTime parameter in routine SpdfObservatoryDescription::init in file spdfobservatorydescription__define.pro

  start time of available information.

startTime parameter in routine SpdfSatelliteDescription::init in file spdfsatellitedescription__define.pro

  start time of available information.

statusCode field in class SpdfResult

  result status code.

statusCode keyword in routine SpdfResult::init in file spdfresult__define.pro

  result status code.

statusCode property in class SpdfResult
statusCode keyword in routine SpdfSscDataResult::init in file spdfsscdataresult__define.pro

  result status code.

statusCode property in class SpdfSscDataResult
statusCode keyword in routine SpdfSscFileResult::init in file spdfsscfileresult__define.pro

  result status code.

statusCode property in class SpdfSscFileResult
statusSubCode field in class SpdfResult

  result status sub-code.

statusSubCode keyword in routine SpdfResult::init in file spdfresult__define.pro

  result status sub-code.

statusSubCode property in class SpdfResult
statusSubCode keyword in routine SpdfSscDataResult::init in file spdfsscdataresult__define.pro

  result status sub-code.

statusSubCode property in class SpdfSscDataResult
statusSubCode keyword in routine SpdfSscFileResult::init in file spdfsscfileresult__define.pro

  result status sub-code.

statusSubCode property in class SpdfSscFileResult
statusText field in class SpdfResult

  result status text.

statusText keyword in routine SpdfResult::init in file spdfresult__define.pro

  result status text.

statusText property in class SpdfResult
statusText keyword in routine SpdfSscDataResult::init in file spdfsscdataresult__define.pro

  result status text.

statusText property in class SpdfSscDataResult
statusText keyword in routine SpdfSscFileResult::init in file spdfsscfileresult__define.pro

  result status text.

statusText property in class SpdfSscFileResult
stop field in class SpdfTimeInterval

  julday stop value of interval.

stop parameter in routine SpdfTimeInterval::init in file spdftimeinterval__define.pro

  stop time of interval.

string_array keyword in routine SpdfSscFileDescription::getFile in file spdfsscfiledescription__define.pro

  set this keyword to treat the return value as an array of strings.

subClassName parameter in routine SpdfLocationFilter::createDomElement in file spdflocationfilter__define.pro

  name of sub-class.

subClassName parameter in routine SpdfLocationRequest::createDomElement in file spdflocationrequest__define.pro

  {type=string] sub-class name.

subClassName parameter in routine SpdfRequest::createDomElement in file spdfrequest__define.pro

  name of sub-class.

### T

time field in class SpdfLocations

  juldate of locations.

time parameter in routine SpdfLocations::init in file spdflocations__define.pro

  juldate time of location.

time field in class SpdfSatelliteData

  time associated with each data point.

time parameter in routine SpdfSatelliteData::init in file spdfsatellitedata__define.pro

  julday time associated with each data point.

timeFormat field in class SpdfFormatOptions

  value indicating the format for time values ('hh_hhhh', 'hh_mm_ss', 'hh_mm')

timeFormat keyword in routine SpdfFormatOptions::init in file spdfformatoptions__define.pro

  specifies the format for time values ('hh_hhhh', 'hh_mm_ss', 'hh_mm')

timeFormat property in class SpdfFormatOptions
timeInterval field in class SpdfRequest

  time interval of query.

timeInterval parameter in routine SpdfLocationRequest::init in file spdflocationrequest__define.pro

  time interval of this request.

timeInterval parameter in routine SpdfRequest::init in file spdfrequest__define.pro

  time interval of this request.

timeInterval parameter in routine SpdfSscDataRequest::init in file spdfsscdatarequest__define.pro

  time interval of this request.

timeSpan parameter in routine SpdfGetLocations in file spdfgetlocations.pro

  ISO 8601 format strings of the start and stop times of the data to get.

traceStopAltitude field in class SpdfBFieldModel

  stop altitude for downward tracing of field lines.

traceStopAltitude keyword in routine SpdfBFieldModel::init in file spdfbfieldmodel__define.pro

  stop altitude for downward tracing of field.

traceStopAltitude property in class SpdfBFieldModel
trajectoryGeometry field in class SpdfSatelliteDescription

  trajectory geometry.

trajectoryGeometry parameter in routine SpdfObservatoryDescription::init in file spdfobservatorydescription__define.pro

  URL of the file containing the recommended X3D geometry description for rendering the satellite's trajectory.

trajectoryGeometry parameter in routine SpdfSatelliteDescription::init in file spdfsatellitedescription__define.pro

  URL of the file containing the recommended X3D geometry description for rendering the satellite's trajectory.

### U

upperLimit field in class SpdfLocationFilter

  specifies that the upper limit of values that should be included in the results.

upperLimit keyword in routine SpdfLocationFilter::init in file spdflocationfilter__define.pro

  specifies that the upper limit of values that should be included in the results.

upperLimit property in class SpdfLocationFilter
userAgent field in class SpdfRest

  HTTP user-agent value to use in communications with SSC.

userAgent keyword in routine SpdfRest::init in file spdfrest__define.pro

  HTTP user-agent value used in communications with SPDF.

userAgent property in class SpdfRest
userAgent keyword in routine SpdfSsc::init in file spdfssc__define.pro

  HTTP user-agent value used in communications with SSC.

### V

value parameter in routine SpdfTimeInterval::setStart in file spdftimeinterval__define.pro

  new value

value parameter in routine SpdfTimeInterval::setStop in file spdftimeinterval__define.pro

  new value

value parameter in routine SpdfTimeInterval::getJulDayFromIso8601 in file spdftimeinterval__define.pro

  ISO 8601 date/time value

value parameter in routine SpdfTimeInterval::getIso8601FromJulDay in file spdftimeinterval__define.pro

  julday value.

valueOptions field in class SpdfOutputOptions

  value options.

valueOptions keyword in routine SpdfOutputOptions::init in file spdfoutputoptions__define.pro

  specifies the value options.

valueOptions property in class SpdfOutputOptions
version field in class SpdfRest

  identifies the version of this class.

version parameter in routine SpdfRest::init in file spdfrest__define.pro

  class version.

### X

x field in class SpdfCoordinateData

  X coordinate values.

x keyword in routine SpdfCoordinateData::init in file spdfcoordinatedata__define.pro

  X values.

x property in class SpdfCoordinateData
x keyword in routine SpdfLocations::init in file spdflocations__define.pro

  X values.

x property in class SpdfLocations

### Y

y field in class SpdfCoordinateData

  Y coordinate values.

y keyword in routine SpdfCoordinateData::init in file spdfcoordinatedata__define.pro

  Y values.

y property in class SpdfCoordinateData
y keyword in routine SpdfLocations::init in file spdflocations__define.pro

  Y values.

y property in class SpdfLocations

### Z

z field in class SpdfCoordinateData

  Z coordinate values.

z keyword in routine SpdfCoordinateData::init in file spdfcoordinatedata__define.pro

  Z values.

z property in class SpdfCoordinateData
z keyword in routine SpdfLocations::init in file spdflocations__define.pro

  Z values.

z property in class SpdfLocations

SSC Feedback.