Documentation for /home/davin/idl/socware/

Generated by IDLdoc

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

external/spdfcdas/

spdfcdasdataresult__define.pro


This class is an IDL representation of the DataResult element from the Coordinated Data Analysis System (CDAS) XML schema.

Author information

Author

B. Harris

Copyright

Copyright (c) 2010-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 SpdfCdasDataResult

Properties

Properties in SpdfCdasDataResult

errors init
messages init
statuses init
warnings init

Fields

Fields in SpdfCdasDataResult

errors ptr_new()

errors related to this result.

fileDescriptions ptr_new()

descriptions of the files comprising this result.

messages ptr_new()

messages related to this result.

statuses ptr_new()

statuses related to this result.

warnings ptr_new()

warnings related to this result.

Routines

Routines from spdfcdasdataresult__define.pro

result = SpdfCdasDataResult::init(fileDescriptions [, messages=strarr] [, warnings=strarr] [, statuses=strarr] [, errors=strarr])

Creates an SpdfCdasDataResult object.

SpdfCdasDataResult::cleanup

Performs cleanup operations when this object is destroyed.

result = SpdfCdasDataResult::getFileDescriptions()

Gets the SpdfFileDescriptions.

result = SpdfCdasDataResult::getMessages()

Gets the messages.

result = SpdfCdasDataResult::getWarnings()

Gets the warnings.

result = SpdfCdasDataResult::getStatuses()

Gets the statuses.

result = SpdfCdasDataResult::getErrors()

Gets the errors.

SpdfCdasDataResult::print

Prints a textual representation of this object.

SpdfCdasDataResult__define

Defines the SpdfCdasDataResult class.

Routine details

top source SpdfCdasDataResult::init

result = SpdfCdasDataResult::init(fileDescriptions [, messages=strarr] [, warnings=strarr] [, statuses=strarr] [, errors=strarr])

Creates an SpdfCdasDataResult object.

Return value

reference to an SpdfCdasDataResult object.

Parameters

fileDescriptions in type=objarr of SpdfFileDescription

descriptions of the files comprising this result.

Keywords

messages in optional type=strarr

messages related to this result.

warnings in optional type=strarr

warnings related to this result.

statuses in optional type=strarr

statuses related to this result.

errors in optional type=strarr

errors related to this result.

top source SpdfCdasDataResult::cleanup

SpdfCdasDataResult::cleanup

Performs cleanup operations when this object is destroyed.

top source SpdfCdasDataResult::getFileDescriptions

result = SpdfCdasDataResult::getFileDescriptions()

Gets the SpdfFileDescriptions.

Return value

a reference to objarr of SpdfFileDescriptions.

top source SpdfCdasDataResult::getMessages

result = SpdfCdasDataResult::getMessages()

Gets the messages.

Return value

a reference to strarr of messages.

top source SpdfCdasDataResult::getWarnings

result = SpdfCdasDataResult::getWarnings()

Gets the warnings.

Return value

a reference to strarr of warnings.

top source SpdfCdasDataResult::getStatuses

result = SpdfCdasDataResult::getStatuses()

Gets the statuses.

Return value

a reference to strarr of statuses.

top source SpdfCdasDataResult::getErrors

result = SpdfCdasDataResult::getErrors()

Gets the errors.

Return value

a reference to strarr of errors.

top source SpdfCdasDataResult::print

SpdfCdasDataResult::print

Prints a textual representation of this object.

top source SpdfCdasDataResult__define

SpdfCdasDataResult__define

Defines the SpdfCdasDataResult class.

File attributes

Modification date: Thu Feb 13 16:41:59 2014
Lines: 100