::: header

SSC R2.4 Web Services API

Generated by IDLdoc

:::

Overview Directory File Source [attach.png] {align=“top”} Etc Categories Search Index Help User documentation

single page{target=“_top”} | use frames{target=“_top”} summary class fields routine details file attributes

::: content

./

spdfresult__define.pro[]{.file-attributes}

::: {#file_comments} ::: small This class is an IDL representation of the Result element from the Satellite Situation Center (SSC) XML schema. ::: :::

Author information

Author

: B. Harris

: 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

Class description for SpdfResult

Subclasses: SpdfSscDataResult SpdfSscFileResult

Properties

Properties in SpdfResult

::: details

statusCode [init ]{.smaller}

statusSubCode [init ]{.smaller}

statusText [init ]{.smaller}

:
::: :::

Routines

Routines from spdfresult__define.pro

[result]{.var} = SpdfResult::init([statusCode=[string]{.var}]{.argument}[, statusSubCode=[string]{.var}]{.argument}[, statusText=[strarr]{.var}]{.argument})

: Creates an SpdfResult object.

SpdfResult::cleanup

: Performs cleanup operations when this object is destroyed.

[result]{.var} = SpdfResult::getStatusCode()

: Gets the status code value.

[result]{.var} = SpdfResult::getStatusSubCode()

: Gets the status sub-code value.

[result]{.var} = SpdfResult::getStatusText()

: Gets the status text.

SpdfResult::print

: Prints a textual representation of this object.

SpdfResult__define

: Defines the SpdfResult class.

::: {#routine-details}

Routine details

::: {#SpdfResult::init .routine-details .details}

top{.top} source{.top} SpdfResult::init[]{.routine-attributes}

[result]{.var} = SpdfResult::init([statusCode=[string]{.var}]{.argument}[, statusSubCode=[string]{.var}]{.argument}[, statusText=[strarr]{.var}]{.argument})

Creates an SpdfResult object.

Return value

::: small reference to an SpdfResult object. :::

Keywords

statusCode [in type=string ]{.smaller}

: result status code.

statusSubCode [in type=string ]{.smaller}

: result status sub-code.

statusText [in type=strarr ]{.smaller}

: result status text. :::

::: {#SpdfResult::cleanup .routine-details .details}

top{.top} source{.top} SpdfResult::cleanup[]{.routine-attributes}

SpdfResult::cleanup

Performs cleanup operations when this object is destroyed.

:::

::: {#SpdfResult::getStatusCode .routine-details .details}

top{.top} source{.top} SpdfResult::getStatusCode[]{.routine-attributes}

[result]{.var} = SpdfResult::getStatusCode()

Gets the status code value.

Return value

::: small status code value. ::: :::

::: {#SpdfResult::getStatusSubCode .routine-details .details}

top{.top} source{.top} SpdfResult::getStatusSubCode[]{.routine-attributes}

[result]{.var} = SpdfResult::getStatusSubCode()

Gets the status sub-code value.

Return value

::: small status sub-code value. ::: :::

::: {#SpdfResult::getStatusText .routine-details .details}

top{.top} source{.top} SpdfResult::getStatusText[]{.routine-attributes}

[result]{.var} = SpdfResult::getStatusText()

Gets the status text.

Return value

::: small a reference to strarr of status text. ::: :::

::: {#SpdfResult::print .routine-details .details}

top{.top} source{.top} SpdfResult::print[]{.routine-attributes}

SpdfResult::print

Prints a textual representation of this object.

:::

::: {#SpdfResult__define .routine-details .details}

top{.top} source{.top} SpdfResult__define[]{.routine-attributes}

SpdfResult__define

Defines the SpdfResult class.

::: :::

::: {#attributes}

File attributes

Modification date: Fri May 13 08:54:13 2022 Lines: 38

:::

SSC Feedback. :::

::: footer

Produced by IDLdoc 3.6.4 on Mon Apr 8 09:51:01 2024 IDLdoc project information{target=“_top”}

:::