CDAS R1.8.20 Web Services API

Generated by IDLdoc

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

./

spdfobservatorygroupdescription__define.pro


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

Author information

Author

B. Harris

Copyright

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

Routines

Routines from spdfobservatorygroupdescription__define.pro

result = SpdfObservatoryGroupDescription::init(name, observatoryIds)

Creates an SpdfObservatoryGroupDescription object.

SpdfObservatoryGroupDescription::cleanup

Performs cleanup operations when this object is destroyed.

result = SpdfObservatoryGroupDescription::getName()

Gets the name of this group.

result = SpdfObservatoryGroupDescription::getObservatoryIds()

Gets the IDs of observatories belonging to this group

SpdfObservatoryGroupDescription::print

Prints a textual representation of this object.

SpdfObservatoryGroupDescription__define

Defines the SpdfObservatoryGroupDescription class.

Routine details

top source SpdfObservatoryGroupDescription::init

result = SpdfObservatoryGroupDescription::init(name, observatoryIds)

Creates an SpdfObservatoryGroupDescription object.

Return value

reference to an SpdfObservatoryGroupDescription object.

Parameters

name in type=string

name of observatory-group.

observatoryIds in type=strarr

identifiers of the observatories in this group.

top source SpdfObservatoryGroupDescription::cleanup

SpdfObservatoryGroupDescription::cleanup

Performs cleanup operations when this object is destroyed.

top source SpdfObservatoryGroupDescription::getName

result = SpdfObservatoryGroupDescription::getName()

Gets the name of this group.

Return value

name of this group.

top source SpdfObservatoryGroupDescription::getObservatoryIds

result = SpdfObservatoryGroupDescription::getObservatoryIds()

Gets the IDs of observatories belonging to this group

Return value

strarr containing the IDs of observatories belonging to this group.

top source SpdfObservatoryGroupDescription::print

SpdfObservatoryGroupDescription::print

Prints a textual representation of this object.

top source SpdfObservatoryGroupDescription__define

SpdfObservatoryGroupDescription__define

Defines the SpdfObservatoryGroupDescription class.

File attributes

Modification date: Wed May 9 06:58:57 2018
Lines: 31


CDAS Feedback.