::: 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

./

spdftimeinterval__define.pro[]{.file-attributes}

::: {#file_comments} ::: small 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 (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

Class description for SpdfTimeInterval

:::

Routines

Routines from spdftimeinterval__define.pro

[result]{.var} = SpdfTimeInterval::init([start]{.argument}[, stop]{.argument})

: Creates an SpdfTimeInterval object.

SpdfTimeInterval::cleanup

: Performs cleanup operations when this object is destroyed.

[result]{.var} = SpdfTimeInterval::getStart()

: Get the start value.

SpdfTimeInterval::setStart[, value]{.argument}

: Sets the start value.

[result]{.var} = SpdfTimeInterval::getStop()

: Get the stop value.

SpdfTimeInterval::setStop[, value]{.argument}

: Sets the stop value.

[result]{.var} = SpdfTimeInterval::getJulDayFromIso8601([value]{.argument})

: Converts the given ISO 8601 time value string into the corresponding julday value.

[result]{.var} = SpdfTimeInterval::getIso8601FromJulDay([value]{.argument}[ [, /basicFormat]]{.argument})

: Converts the given julday value into the corresponding ISO 8601 time value string.

[result]{.var} = SpdfTimeInterval::getIso8601Start([ [/basicFormat]]{.argument})

: Get the start value.

[result]{.var} = SpdfTimeInterval::getIso8601Stop([ [/basicFormat]]{.argument})

: Get the stop value.

[result]{.var} = SpdfTimeInterval::getCdawebStart()

: Get the start value.

[result]{.var} = SpdfTimeInterval::getCdawebStop()

: Get the stop value.

[result]{.var} = SpdfTimeInterval::isStartLessThanStop()

: Determines if the start time is less than the stop time.

[result]{.var} = SpdfTimeInterval::isGreaterThan1Day()

: Determines if this interval is larger than one day.

SpdfTimeInterval::print

: Prints a textual representation of this object.

[result]{.var} = SpdfTimeInterval::createDomElement([doc]{.argument})

: Creates a TimeInterval element using the given XML DOM document with the values of this object.

SpdfTimeInterval__define

: Defines the SpdfTimeInterval class.

::: {#routine-details}

Routine details

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

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

[result]{.var} = SpdfTimeInterval::init([start]{.argument}[, stop]{.argument})

Creates an SpdfTimeInterval object.

Return value

::: small reference to an SpdfTimeInterval object. :::

Parameters

start [in type=string/julday ]{.smaller}

: start time of interval. Value may be either an ISO 8601 date/time string or a julday value.

stop [in type=string/julday ]{.smaller}

: stop time of interval. Value may be either an ISO 8601 date/time string or a julday value. :::

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

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

SpdfTimeInterval::cleanup

Performs cleanup operations when this object is destroyed.

:::

::: {#SpdfTimeInterval::getStart .routine-details .details}

top{.top} source{.top} SpdfTimeInterval::getStart[]{.routine-attributes}

[result]{.var} = SpdfTimeInterval::getStart()

Get the start value.

Return value

::: small julday start value. ::: :::

::: {#SpdfTimeInterval::setStart .routine-details .details}

top{.top} source{.top} SpdfTimeInterval::setStart[]{.routine-attributes}

SpdfTimeInterval::setStart[, value]{.argument}

Sets the start value.

Parameters

value [in type=julday ]{.smaller}

: new value :::

::: {#SpdfTimeInterval::getStop .routine-details .details}

top{.top} source{.top} SpdfTimeInterval::getStop[]{.routine-attributes}

[result]{.var} = SpdfTimeInterval::getStop()

Get the stop value.

Return value

::: small julday stop value. ::: :::

::: {#SpdfTimeInterval::setStop .routine-details .details}

top{.top} source{.top} SpdfTimeInterval::setStop[]{.routine-attributes}

SpdfTimeInterval::setStop[, value]{.argument}

Sets the stop value.

Parameters

value [in type=julday ]{.smaller}

: new value :::

::: {#SpdfTimeInterval::getJulDayFromIso8601 .routine-details .details}

top{.top} source{.top} SpdfTimeInterval::getJulDayFromIso8601[]{.routine-attributes}

[result]{.var} = SpdfTimeInterval::getJulDayFromIso8601([value]{.argument})

Converts the given ISO 8601 time value string into the corresponding julday value.

Return value

::: small julday value corresponding to the given iso8601 value. :::

Parameters

value [in type=string ]{.smaller}

: ISO 8601 date/time value :::

::: {#SpdfTimeInterval::getIso8601FromJulDay .routine-details .details}

top{.top} source{.top} SpdfTimeInterval::getIso8601FromJulDay[]{.routine-attributes}

[result]{.var} = SpdfTimeInterval::getIso8601FromJulDay([value]{.argument}[ [, /basicFormat]]{.argument})

Converts the given julday value into the corresponding ISO 8601 time value string.

Return value

::: small ISO 8601 date/time value corresponding to the given julday value. :::

Parameters

value [in type=string ]{.smaller}

: julday value.

Keywords

basicFormat [in optional type=boolean default=false]{.smaller}

: Indicates whether the “basic” (minimal field separators) ISO 8601 format is to be returned. :::

::: {#SpdfTimeInterval::getIso8601Start .routine-details .details}

top{.top} source{.top} SpdfTimeInterval::getIso8601Start[]{.routine-attributes}

[result]{.var} = SpdfTimeInterval::getIso8601Start([ [/basicFormat]]{.argument})

Get the start value.

Return value

::: small start value as an ISO 8601 string. :::

Keywords

basicFormat [in optional type=boolean default=false]{.smaller}

: Indicates whether the “basic” (minimal field separators) ISO 8601 format is to be returned. :::

::: {#SpdfTimeInterval::getIso8601Stop .routine-details .details}

top{.top} source{.top} SpdfTimeInterval::getIso8601Stop[]{.routine-attributes}

[result]{.var} = SpdfTimeInterval::getIso8601Stop([ [/basicFormat]]{.argument})

Get the stop value.

Return value

::: small stop value as an ISO 8601 string. :::

Keywords

basicFormat [in optional type=boolean default=false]{.smaller}

: Indicates whether the “basic” (minimal field separators) ISO 8601 format is to be returned. :::

::: {#SpdfTimeInterval::getCdawebStart .routine-details .details}

top{.top} source{.top} SpdfTimeInterval::getCdawebStart[]{.routine-attributes}

[result]{.var} = SpdfTimeInterval::getCdawebStart()

Get the start value.

Return value

::: small start value as an cdaweb format string. ::: :::

::: {#SpdfTimeInterval::getCdawebStop .routine-details .details}

top{.top} source{.top} SpdfTimeInterval::getCdawebStop[]{.routine-attributes}

[result]{.var} = SpdfTimeInterval::getCdawebStop()

Get the stop value.

Return value

::: small stop value as an cdaweb format string. ::: :::

::: {#SpdfTimeInterval::isStartLessThanStop .routine-details .details}

top{.top} source{.top} SpdfTimeInterval::isStartLessThanStop[]{.routine-attributes}

[result]{.var} = SpdfTimeInterval::isStartLessThanStop()

Determines if the start time is less than the stop time.

Return value

::: small true if the start time is less than the stop time. Otherwise false. ::: :::

::: {#SpdfTimeInterval::isGreaterThan1Day .routine-details .details}

top{.top} source{.top} SpdfTimeInterval::isGreaterThan1Day[]{.routine-attributes}

[result]{.var} = SpdfTimeInterval::isGreaterThan1Day()

Determines if this interval is larger than one day.

Return value

::: small true if this interval is larger than one day. Otherwise false. ::: :::

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

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

SpdfTimeInterval::print

Prints a textual representation of this object.

:::

::: {#SpdfTimeInterval::createDomElement .routine-details .details}

top{.top} source{.top} SpdfTimeInterval::createDomElement[]{.routine-attributes}

[result]{.var} = SpdfTimeInterval::createDomElement([doc]{.argument})

Creates a TimeInterval element using the given XML DOM document with the values of this object.

Return value

::: small a reference to a new IDLffXMLDOMElement representation of this object. :::

Parameters

doc [in type=IDLffXMLDOMDocument ]{.smaller}

: document in which to create the TimeInterval element. :::

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

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

SpdfTimeInterval__define

Defines the SpdfTimeInterval class.

::: :::

::: {#attributes}

File attributes

Modification date: Tue Jan 16 07:43:48 2024 Lines: 127

:::

SSC Feedback. :::

::: footer

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

:::