# Complete SSC R2.4.17 Web Services API

## Generated by IDLdoc

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

## ./

# spdfbtracedata__define.pro

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

## Author information

Author

  B. Harris

Copyright

  Copyright (c) 2013 United States Government as represented by the National Aeronautics and Space Administration. No copyright is claimed in the United States under Title 17, U.S.Code. All Other Rights Reserved.

## Class description for SpdfBTraceData

### Properties

#### Properties in SpdfBTraceData

arcLength init
latitude init
longitude init

### Fields

#### Fields in SpdfBTraceData

arcLength ptr_new()

  arc length values.

coordinateSystem ''

  coordinate system.

hemisphere ''

  hemisphere.

latitude ptr_new()

  latitude values.

longitude ptr_new()

  longitude values.

## Routines

### Routines from spdfbtracedata__define.pro

`result = SpdfBTraceData::init(coordinateSystem, hemisphere, latitude=fltarr, longitude=fltarr, arcLength=dblarr)`

  Creates an SpdfBTraceData object.

`SpdfBTraceData::cleanup`

  Performs cleanup operations when this object is destroyed.

`result = SpdfBTraceData::getCoordinateSystem()`

  Gets the coordinate system value.

`result = SpdfBTraceData::getHemisphere()`

  Gets the hemisphere value.

`result = SpdfBTraceData::getLatitude()`

  Gets the latitude values.

`result = SpdfBTraceData::getLongitude()`

  Gets the longitude values.

`result = SpdfBTraceData::getArcLength()`

  Gets the ArcLength values.

`SpdfBTraceData__define`

  Defines the SpdfBTraceData class.

## Routine details

## top source SpdfBTraceData::init

`result = SpdfBTraceData::init(coordinateSystem, hemisphere, latitude=fltarr, longitude=fltarr, arcLength=dblarr)`

Creates an SpdfBTraceData object.

### Return value

reference to an SpdfBTraceData object.

### Parameters

coordinateSystem in type=string

  coordinate system.

hemisphere in type=string

  hemisphere.

### Keywords

latitude in type=fltarr

  latitude values.

longitude in type=fltarr

  longitude values.

arcLength in type=dblarr

  arc length values.

## top source SpdfBTraceData::cleanup

`SpdfBTraceData::cleanup`

Performs cleanup operations when this object is destroyed.

## top source SpdfBTraceData::getCoordinateSystem

`result = SpdfBTraceData::getCoordinateSystem()`

Gets the coordinate system value.

### Return value

coordinate system value.

## top source SpdfBTraceData::getHemisphere

`result = SpdfBTraceData::getHemisphere()`

Gets the hemisphere value.

### Return value

hemisphere value.

## top source SpdfBTraceData::getLatitude

`result = SpdfBTraceData::getLatitude()`

Gets the latitude values.

### Return value

a fltarr contain latitude values or the scalar constant !values.d_NaN if there are no values.

## top source SpdfBTraceData::getLongitude

`result = SpdfBTraceData::getLongitude()`

Gets the longitude values.

### Return value

a fltarr contain longitude values or the scalar constant !values.d_NaN if there are no values.

## top source SpdfBTraceData::getArcLength

`result = SpdfBTraceData::getArcLength()`

Gets the ArcLength values.

### Return value

a dblarr contain ArcLength values or the scalar constant !values.d_NaN if there are no values.

## top source SpdfBTraceData__define

`SpdfBTraceData__define`

Defines the SpdfBTraceData class.

## File attributes

Modification date: | Fri May 13 08:54:13 2022
Lines: | 62

SSC Feedback.