Complete CDAS R1.8.6 Web Services API

Generated by IDLdoc

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

./

spdfbindata__define.pro


This class is an IDL representation of the BinData element from the Coordinated Data Analysis System (CDAS) XML schema. See CDAWeb data binning for more details.

Author information

Author

B. Harris

Copyright

Copyright (c) 2018-2020 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 SpdfBinData

Fields

Fields in SpdfBinData

INTERPOLATEMISSINGVALUES 0B
INTERVAL 0.0000000D
OVERRIDEDEFAULTBINNING 0B
SIGMAMULTIPLIER 0L

Routines

Routines from spdfbindata__define.pro

result = SpdfBinData::init(interval, interpolateMissingValues, sigmaMultiplier, overrideDefaultBinning)

Creates an SpdfBinData object.

SpdfBinData::cleanup

Performs cleanup operations when this object is destroyed.

result = SpdfBinData::getInterval()

Gets the interval value.

result = SpdfBinData::getInterpolateMissingValues()

Gets the interpolateMissingValues value.

result = SpdfBinData::getSigmaMultiplier()

Gets the sigmaMultiplier value.

result = SpdfBinData::getOverrideDefaultBinning()

Gets the overrideDefaultBinning value.

result = SpdfBinData::createDomElement(doc)

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

SpdfBinData__define

Routine details

top source SpdfBinData::init

result = SpdfBinData::init(interval, interpolateMissingValues, sigmaMultiplier, overrideDefaultBinning)

Creates an SpdfBinData object.

Return value

reference to an SpdfBinData object.

Parameters

interval in type=double

binning interval (seconds).

interpolateMissingValues in type=byte

flag indicating whether to interpolate missing values.

sigmaMultiplier in type=int

standard deviation multiplier used for rejecting data.

overrideDefaultBinning in type=byte default=0B

flag indicating whether to override the default selection of variables to bin. 0 = use default selection (only variables with the ALLOW_BIN attribute set). 1 = bin additional variables beyond just those with the ALLOW_BIN attribute set.

top source SpdfBinData::cleanup

SpdfBinData::cleanup

Performs cleanup operations when this object is destroyed.

top source SpdfBinData::getInterval

result = SpdfBinData::getInterval()

Gets the interval value.

Return value

interval value

top source SpdfBinData::getInterpolateMissingValues

result = SpdfBinData::getInterpolateMissingValues()

Gets the interpolateMissingValues value.

Return value

interpolateMissingValues value.

top source SpdfBinData::getSigmaMultiplier

result = SpdfBinData::getSigmaMultiplier()

Gets the sigmaMultiplier value.

Return value

sigmaMultiplier value.

top source SpdfBinData::getOverrideDefaultBinning

result = SpdfBinData::getOverrideDefaultBinning()

Gets the overrideDefaultBinning value.

Return value

overrideDefaultBinning value.

top source SpdfBinData::createDomElement

result = SpdfBinData::createDomElement(doc)

Creates a BinData 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 BinData element.

top source SpdfBinData__define

SpdfBinData__define

File attributes

Modification date: Thu Feb 6 12:23:51 2020
Lines: 78


CDAS Feedback.