![[attach.png]](idldoc-resources/attach.png)
./
spdftimeinterval__define.pro
This class is an IDL representation of the TimeInterval element from the Coordinated Data Analysis System (CDAS) and Satellite Situation Center (SSC) XML schemas. Notes:
- This class exists in both the CDAS and SSC web service IDL libraries. They should be kept identical to void incompatiblities for clients that use both libraries simultaneously.
Author information
- Author
B. Harris
- Copyright
Copyright (c) 2010-2024 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 SpdfTimeInterval
Fields
Fields in SpdfTimeInterval
- basicIso8601Format ''
constant format string for a "basic" (minimal field separators) ISO 8601 value.
- cdawebFormat ''
constant format string for a "cdaweb" time format.
- iso8601Format ''
constant format string for an ISO 8601 value.
- shortIso8601Format ''
short version of a constant format string for an ISO 8601 value.
- start 0.0000000D
julday start value of interval.
- stop 0.0000000D
julday stop value of interval.
Routines
Routines from spdftimeinterval__define.pro
result = SpdfTimeInterval::init(start, stop)Creates an SpdfTimeInterval object.
SpdfTimeInterval::cleanupPerforms cleanup operations when this object is destroyed.
result = SpdfTimeInterval::getStart()Get the start value.
SpdfTimeInterval::setStart, valueSets the start value.
result = SpdfTimeInterval::getStop()Get the stop value.
SpdfTimeInterval::setStop, valueSets the stop value.
result = SpdfTimeInterval::getJulDayFromIso8601(value)Converts the given ISO 8601 time value string into the corresponding julday value.
result = SpdfTimeInterval::getIso8601FromJulDay(value [, /basicFormat])Converts the given julday value into the corresponding ISO 8601 time value string.
result = SpdfTimeInterval::getIso8601Start( [/basicFormat])Get the start value.
result = SpdfTimeInterval::getIso8601Stop( [/basicFormat])Get the stop value.
result = SpdfTimeInterval::getCdawebStart()Get the start value.
result = SpdfTimeInterval::getCdawebStop()Get the stop value.
result = SpdfTimeInterval::isStartLessThanStop()Determines if the start time is less than the stop time.
result = SpdfTimeInterval::isGreaterThan1Day()Determines if this interval is larger than one day.
SpdfTimeInterval::printPrints a textual representation of this object.
result = SpdfTimeInterval::createDomElement(doc)Creates a TimeInterval element using the given XML DOM document with the values of this object.
SpdfTimeInterval__defineDefines the SpdfTimeInterval class.
Routine details
top source SpdfTimeInterval::init
result = SpdfTimeInterval::init(start, stop)
Creates an SpdfTimeInterval object.
Return value
reference to an SpdfTimeInterval object.
Parameters
top source SpdfTimeInterval::cleanup
SpdfTimeInterval::cleanup
Performs cleanup operations when this object is destroyed.
top source SpdfTimeInterval::getStart
result = SpdfTimeInterval::getStart()
Get the start value.
Return value
julday start value.
top source SpdfTimeInterval::setStart
SpdfTimeInterval::setStart, value
Sets the start value.
Parameters
- value in type=julday
new value
top source SpdfTimeInterval::getStop
result = SpdfTimeInterval::getStop()
Get the stop value.
Return value
julday stop value.
top source SpdfTimeInterval::setStop
SpdfTimeInterval::setStop, value
Sets the stop value.
Parameters
- value in type=julday
new value
top source SpdfTimeInterval::getJulDayFromIso8601
result = SpdfTimeInterval::getJulDayFromIso8601(value)
Converts the given ISO 8601 time value string into the corresponding julday value.
Return value
julday value corresponding to the given iso8601 value.
Parameters
- value in type=string
ISO 8601 date/time value
top source SpdfTimeInterval::getIso8601FromJulDay
result = SpdfTimeInterval::getIso8601FromJulDay(value [, /basicFormat])
Converts the given julday value into the corresponding ISO 8601 time value string.
Return value
ISO 8601 date/time value corresponding to the given julday value.
Parameters
- value in type=string
julday value.
Keywords
- basicFormat in optional type=boolean default=false
Indicates whether the "basic" (minimal field separators) ISO 8601 format is to be returned.
top source SpdfTimeInterval::getIso8601Start
result = SpdfTimeInterval::getIso8601Start( [/basicFormat])
Get the start value.
Return value
start value as an ISO 8601 string.
Keywords
- basicFormat in optional type=boolean default=false
Indicates whether the "basic" (minimal field separators) ISO 8601 format is to be returned.
top source SpdfTimeInterval::getIso8601Stop
result = SpdfTimeInterval::getIso8601Stop( [/basicFormat])
Get the stop value.
Return value
stop value as an ISO 8601 string.
Keywords
- basicFormat in optional type=boolean default=false
Indicates whether the "basic" (minimal field separators) ISO 8601 format is to be returned.
top source SpdfTimeInterval::getCdawebStart
result = SpdfTimeInterval::getCdawebStart()
Get the start value.
Return value
start value as an cdaweb format string.
top source SpdfTimeInterval::getCdawebStop
result = SpdfTimeInterval::getCdawebStop()
Get the stop value.
Return value
stop value as an cdaweb format string.
top source SpdfTimeInterval::isStartLessThanStop
result = SpdfTimeInterval::isStartLessThanStop()
Determines if the start time is less than the stop time.
Return value
true if the start time is less than the stop time. Otherwise false.
top source SpdfTimeInterval::isGreaterThan1Day
result = SpdfTimeInterval::isGreaterThan1Day()
Determines if this interval is larger than one day.
Return value
true if this interval is larger than one day. Otherwise false.
top source SpdfTimeInterval::print
SpdfTimeInterval::print
Prints a textual representation of this object.
top source SpdfTimeInterval::createDomElement
result = SpdfTimeInterval::createDomElement(doc)
Creates a TimeInterval 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 TimeInterval element.
File attributes
| Modification date: | Tue May 21 09:17:13 2024 |
| Lines: | 127 |
SSC Feedback.