SSC R2.3.15 Web Services API

Generated by IDLdoc

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

./

spdfsatellitedescription__define.pro


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

Subclasses: SpdfObservatoryDescription

Routines

Routines from spdfsatellitedescription__define.pro

result = SpdfSatelliteDescription::init(id, name, resolution, startTime, endTime, geometry, trajectoryGeometry)

Creates an SpdfSatelliteDescription object.

SpdfSatelliteDescription::cleanup

Performs cleanup operations when this object is destroyed.

result = SpdfSatelliteDescription::getId()

Gets the id of this satellite.

result = SpdfSatelliteDescription::getName()

Gets the name of this satellite.

result = SpdfSatelliteDescription::getResolution()

Gets the resolution of this satellite.

result = SpdfSatelliteDescription::getStartTime()

Gets the start time of this satellite.

result = SpdfSatelliteDescription::getEndTime()

Gets the end time of this satellite.

result = SpdfSatelliteDescription::getGeometry()

Gets the geometry of this satellite.

result = SpdfSatelliteDescription::getTrajectoryGeometry()

Gets the trajectory geometry of this satellite.

SpdfSatelliteDescription::print

Prints a textual representation of this object.

SpdfSatelliteDescription__define

Defines the SpdfSatelliteDescription class.

Routine details

top source SpdfSatelliteDescription::init

result = SpdfSatelliteDescription::init(id, name, resolution, startTime, endTime, geometry, trajectoryGeometry)

Creates an SpdfSatelliteDescription object.

Return value

reference to an SpdfSatelliteDescription object.

Parameters

id in type=string

satellite identifier.

name in type=string

satellite name.

resolution in type=int

resolution of trajectory information.

startTime in type=julday

start time of available information.

endTime in type=julday

end time of available information.

geometry in type=string

URL of the file containing the recommended X3D geometry description for rendering the satellite.

trajectoryGeometry in type=string

URL of the file containing the recommended X3D geometry description for rendering the satellite's trajectory.

top source SpdfSatelliteDescription::cleanup

SpdfSatelliteDescription::cleanup

Performs cleanup operations when this object is destroyed.

top source SpdfSatelliteDescription::getId

result = SpdfSatelliteDescription::getId()

Gets the id of this satellite.

Return value

id of this satellite.

top source SpdfSatelliteDescription::getName

result = SpdfSatelliteDescription::getName()

Gets the name of this satellite.

Return value

name of this satellite.

top source SpdfSatelliteDescription::getResolution

result = SpdfSatelliteDescription::getResolution()

Gets the resolution of this satellite.

Return value

resolution of this satellite.

top source SpdfSatelliteDescription::getStartTime

result = SpdfSatelliteDescription::getStartTime()

Gets the start time of this satellite.

Return value

start time of this satellite.

top source SpdfSatelliteDescription::getEndTime

result = SpdfSatelliteDescription::getEndTime()

Gets the end time of this satellite.

Return value

end time of this satellite.

top source SpdfSatelliteDescription::getGeometry

result = SpdfSatelliteDescription::getGeometry()

Gets the geometry of this satellite.

Return value

geometry of this satellite.

top source SpdfSatelliteDescription::getTrajectoryGeometry

result = SpdfSatelliteDescription::getTrajectoryGeometry()

Gets the trajectory geometry of this satellite.

Return value

trajectory geometry of this satellite.

top source SpdfSatelliteDescription::print

SpdfSatelliteDescription::print

Prints a textual representation of this object.

top source SpdfSatelliteDescription__define

SpdfSatelliteDescription__define

Defines the SpdfSatelliteDescription class.

File attributes

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


SSC Feedback.