# SSC R2.4.17 Web Services API

## Generated by IDLdoc

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

## ./

# spdftsyganenko89cbfieldmodel__define.pro

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

### Inheritance

- SpdfExternalBFieldModel

### Properties

#### Properties in SpdfTsyganenko89cBFieldModel

keyParameterValues init

## Routines

### Methods inherited from SpdfExternalBFieldModel

- `SpdfExternalBFieldModel::cleanup`
- `result = SpdfExternalBFieldModel::init()`

### Routines from spdftsyganenko89cbfieldmodel__define.pro

`result = SpdfTsyganenko89cBFieldModel::init( [keyParameterValues=string])`

  Creates an SpdfTsyganenko89cBFieldModel object.

`SpdfTsyganenko89cBFieldModel::cleanup`

  Performs cleanup operations when this object is destroyed.

`result = SpdfTsyganenko89cBFieldModel::createDomElement(doc)`

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

`SpdfTsyganenko89cBFieldModel__define`

  Defines the SpdfTsyganenko89cBFieldModel class.

## Routine details

## top source SpdfTsyganenko89cBFieldModel::init

`result = SpdfTsyganenko89cBFieldModel::init( [keyParameterValues=string])`

Creates an SpdfTsyganenko89cBFieldModel object.

### Return value

reference to an SpdfTsyganenko89cBFieldModel object.

### Keywords

keyParameterValues in optional type=string default='KP3_3_3'

  Model's key parameter values. Must be one of the following: KP0_0, KP1_1_1, KP2_2_2, KP3_3_3, KP4_4_4, KP5_5_5, or KP6.

## top source SpdfTsyganenko89cBFieldModel::cleanup

`SpdfTsyganenko89cBFieldModel::cleanup`

Performs cleanup operations when this object is destroyed.

## top source SpdfTsyganenko89cBFieldModel::createDomElement

`result = SpdfTsyganenko89cBFieldModel::createDomElement(doc)`

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

### Return value

a reference to a new IDLffXMLDOMElement representation of this object.

### Parameters

doc in type=IDLffXMLDOMDocument

  document in which to create the DataRequest element.

## top source SpdfTsyganenko89cBFieldModel__define

`SpdfTsyganenko89cBFieldModel__define`

Defines the SpdfTsyganenko89cBFieldModel class.

## File attributes

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

SSC Feedback.