IDLnetOGCWCS::GetCoverageOffering

The IDLnetOGCWCS::GetCoverageOffering function method returns a complex structure that contains the details of a single coverage offering, one that was returned by the IDLnetOGCWCS::DescribeCoverage method request. You can return either the first coverage offering described in the XML file or a coverage identified by the INDEX keyword value.

Syntax

Return Value

Returns a structure containing the coverage offering details. The coverage offering structure contains strings, arrays of strings, structures, and arrays of structures.

Coverage Offering Structure

The coverage offering structure is complex. Some elements in the main structure return other structures as shown in the following figure. Click on the names of any of the structures in the boxes to go to the associated reference section.

Main Coverage Offering Structure

The following table contains a list of tags found in the main level structure. All items return string values unless otherwise noted.

Table 9-4: Coverage Offering Brief Structure

Table 9-4: Coverage Offering Brief Structure
Field Name	Description
INDEX	A zero-based string index value provided as a convenience. This does not come from the XML file.
VERSION	XML source: <CoverageDescription><version>
UPDATE_SEQ	XML source: <CoverageDescription><updateSequence>
CO_NAME	XML source: <CoverageOffering><name>
CO_LABEL	XML source: <CoverageOffering><label>
CO_DESC	XML source: <CoverageOffering><description>
LONLATENV	XML source: <CoverageOffering><lonLatEnvelope> Returns a structure. See LonLatEnv Structure for details.
NUM_SPAT_DOM_LLES	Provides the number of `gml:Envelop`e and `gml:EnvelopeWithTimePeriod` spatial domain elements as a convenience. This value is generated by IDL.
SPAT_DOM_LONLATENV	XML source: <CoverageOffering><domainSet><spatial Domain><gml:Envelope> and <CoverageOffering><domainSet><spatial Domain><gml:EnvelopeWithTimePeriod> Returns a structure. See Spat_Dom_LonLatEnv Structure for details.
NUM_SPAT_DOM_GRIDS	Provides the number of `gml:Grid` and `gml:RectifiedGrid` spatial domain elements as a convenience. This value is generated by IDL.
SPAT_DOM_GRID	XML source: <CoverageOffering><domainSet><spatial Domain><gml:Grid> and <CoverageOffering><domainSet><spatial Domain><gml:RectifiedGrid> Returns an array of structures. See Spat_Dom_Grid Structure for details.
NUM_TEMP_TM_POSITIONS	Provides the number of temporal domain elements as a convenience. This value is generated by IDL.
TEMP_TM_POSITIONS	XML source: <CoverageOffering><domainSet><spatial Domain><temporalDomain> <gml:timePosition> or <CoverageOffering><temporalDomain> <gml:timePosition> Returns an array of structures. See Temp_Tm_Position Structure for details.
NUM_TEMP_TM_PERIODS	Provides the number of time period elements as a convenience. This value is generated by IDL.
TEMP_TM_PERIOD	XML source: <CoverageOffering><domainSet><spatial Domain><temporalDomain><timePeriod> or <CoverageOffering><temporalDomain> <timePeriod> Returns an array of structures. See Temp_Tm_Period Structure for details.
RANGE	XML source: <CoverageOffering><rangeSet> <RangeSet> Returns a structure. See Range Structure for details.
NUM_RANGE_AXES	Provides the number of range set axis description elements as a convenience. This value is generated by IDL.
RANGE_AXIS	XML source: <CoverageOffering><rangeSet> <RangeSet><axisDescription> <AxisDescription> Returns an array of structures. See Axis_Description Structure for details.
CRS	XML source: <CoverageOffering><supportedCRSs> Returns a structure. See CRS Structure for details.
FORMATS	XML source: <CoverageOffering><supportedFormats> Returns an array of strings (0 to many).
NATIVE_FORMAT	XML source: <CoverageOffering><supportedFormats> <nativeFormat>
INTERPOLATION_METHOD	XML source: <CoverageOffering> <supportedInterpolations> Returns an array of strings (0 to many).
NATIVE_INTERPOLATION	XML source: <CoverageOffering> <supportedInterpolations><default>

LonLatEnv Structure

This structure is accessed through the LONLATENV field of the main coverage offering structure and contains the fields defined in the following table. All elements are strings unless otherwise noted.

Table 9-5: LonLatEnv Structure Fields

Table 9-5: LonLatEnv Structure Fields
Field	Description
SRS_NAME	XML source: <CoverageOffering><lonLatEnvelope><srsName>
POS1	XML source: <CoverageOffering><lonlatEnvelope><gml:pos>
DIMS1	XML source: <CoverageOffering><lonlatEnvelope><dimension>
POS2	XML source: <CoverageOffering><lonlatEnvelope><gml:pos>
DIMS2	XML source: <CoverageOffering><lonlatEnvelope><dimension>
TM_POS1	XML source: <CoverageOffering><lonlatEnvelope> <gml:timePosition>
TM_POS2	XML source: <CoverageOffering><lonlatEnvelope> <gml:timePosition>

Spat_Dom_LonLatEnv Structure

This structure is accessed through the SPAT_DOM_LONLATENV field of the main coverage offering structure and can contain gml:Envelope or gml:EnvelopeWithTimePeriod information. Both of these are children of the spatialDomain node. To determine the number of structures returned, use the main structure field, NUM_SPAT_DOM_LLES. The number of structures can be 0 to many. All elements are strings unless otherwise noted.

Table 9-6: Spat_Dom_LonLatEnv Structure Fields

Table 9-6: Spat_Dom_LonLatEnv Structure Fields
Field	Description
SRS_NAME	XML source: <CoverageOffering><domainSet><spatialDomain> <gml:Envelope><srsName> and <CoverageOffering><domainSet><spatialDomain> <gml:EnvelopeWithTimePeriod><srsName>
POS1	XML source: <CoverageOffering><domainSet><spatialDomain> <gml:Envelope><gml:pos> and <CoverageOffering><domainSet><spatialDomain> <gml:EnvelopeWithTimePeriod><gml:pos>
DIMS1	XML source: <CoverageOffering><domainSet><spatialDomain> <gml:Envelope><gml:pos><dimension> and <CoverageOffering><domainSet><spatialDomain> <gml:EnvelopeWithTimePeriod><gml:pos><dimension>
POS2	XML source: <CoverageOffering><domainSet><spatialDomain> <gml:Envelope><gml:pos> and <CoverageOffering><domainSet><spatialDomain> <gml:EnvelopeWithTimePeriod><gml:pos>
DIMS2	XML source: <CoverageOffering><domainSet><spatialDomain> <gml:Envelope><gml:pos><dimension> and <CoverageOffering><domainSet><spatialDomain> <gml:EnvelopeWithTimePeriod><gml:pos><dimension>
TM_POS1	XML source: <CoverageOffering><domainSet><spatialDomain> <gml:EnvelopeWithTimePeriod><gml:timePosition>
TM_POS2	XML source: <CoverageOffering><domainSet><spatialDomain> <gml:EnvelopeWithTimePeriod><gml:timePosition>

Spat_Dom_Grid Structure

This structure is accessed through the SPAT_DOM_GRID field of the main coverage offering structure and can contain gml:Grid or gml:GridRectified elements. Both of these are children of the spatialDomain node. To determine the number of Spat_Dom_Grid structures, access the NUM_SPAT_DOM_GRIDS field value. The number of structures can be 0 to many. All elements are strings unless otherwise noted.

Table 9-7: Spat_Dom_Grid and GridRectified Structure Fields

Table 9-7: Spat_Dom_Grid and GridRectified Structure Fields
Field	Description
RECTIFIED	Indicates whether or not the grid is rectified in a value of "Yes" or "No". This value is generated by IDL.
DIMS	XML source: <CoverageOffering><domainSet><spatialDomain> <gml:Grid><dimensions> and <CoverageOffering><domainSet><spatialDomain> <gml:GridRectified><dimensions>
SRS_NAME	XML source: <CoverageOffering><domainSet><spatialDomain> <gml:Grid><srsName> and <CoverageOffering><domainSet><spatialDomain> <gml:GridRectified><srsName>
LIMITS_ENV_LOW	XML source: <CoverageOffering><domainSet><spatialDomain> <gml:Grid><gml:limits><gml:gridEnvelope> <gml:low> and <CoverageOffering><domainSet><spatialDomain> <gml:GridRectified><gml:limits> <gml:gridEnvelope><gml:low>
LIMITS_ENV_HIGH	XML source: <CoverageOffering><domainSet><spatialDomain> <gml:Grid><gml:limits><gml:gridEnvelope> <gml:high> and <CoverageOffering><domainSet><spatialDomain> <gml:GridRectified><gml:limits> <gml:gridEnvelope><gml:high>
AXIS_NAMES	XML source: <CoverageOffering><domainSet><spatialDomain> <gml:Grid><axisName> and <CoverageOffering><domainSet><spatialDomain> <gml:GridRectified><gml:origin><gml:pos> Returns an array of strings, 0 to many.
ORIGIN_POS	XML source: <CoverageOffering><domainSet><spatialDomain> <gml:Grid><gml:origin><gml:pos> and <CoverageOffering><domainSet><spatialDomain> <gml:GridRectified><gml:origin><gml:pos>
OFFSET_VECTORS	XML source: <CoverageOffering><domainSet><spatialDomain> <gml:Grid><gml:offsetVector> and <CoverageOffering><domainSet><spatialDomain> <gml:GridRectified>< gml:offsetVector> Returns an array of strings, 0 to many.

Temp_Tm_Position Structure

This structure is accessed through the TEMP_TM_POSITIONS field of the main coverage offering structure and contains gml:timePosition elements, which are children of the temporalDomain node. To determine the number of Temp_Tm_Position structures, access the NUM_TEMP_TM_POSITIONS field value. The number of structures can be 0 to many. All elements are strings unless otherwise noted.

Table 9-8: Temp_Tm_Position Structure Fields

Table 9-8: Temp_Tm_Position Structure Fields
Field	Description
POSITION	XML source: <CoverageOffering><domainSet><spatialDomain> <gml:temporalDomain><gml:timePosition> and <CoverageOffering><gml:temporalDomain> <gml:timePosition>
FRAME	XML source: <CoverageOffering><domainSet><spatialDomain> <gml:temporalDomain><gml:timePosition><frame> and <CoverageOffering><gml:temporalDomain> <gml:timePosition><frame>
CALENDAR	XML source: <CoverageOffering><domainSet><spatialDomain> <gml:temporalDomain><gml:timePosition> <calendar> and <CoverageOffering><gml:temporalDomain> <gml:timePosition><calendar>
INDETERMINATE	XML source: <CoverageOffering><domainSet><spatialDomain> <gml:temporalDomain><gml:timePosition> <indeterminate> and <CoverageOffering><gml:temporalDomain> <gml:timePosition><indeterminate>

Temp_Tm_Period Structure

This structure is accessed through the TEMP_TM_PERIOD field of the main coverage offering structure and contains gml:timePeriod elements, which are children of the temporalDomain node. In turn, the temporalDomain node can be a child of the spatialDomain node or the CoverageOffering node. To determine the number of Temp_Tm_Period structures, access the NUM_TEMP_TM_PERIODS field value. The number of structures can be 0 to many. All elements are strings unless otherwise noted.

Table 9-9: Temp_Tm_Period Structure Fields

Table 9-9: Temp_Tm_Period Structure Fields
Field	Description
_BEGIN (underscore avoids conflict with IDL BEGIN keyword)	XML source: <CoverageOffering><domainSet><spatialDomain> <gml:temporalDomain><gml:timePeriod> <beginPosition> or <CoverageOffering><gml:temporalDomain> <gml:timePeriod><beginPosition>
_END (underscore avoids conflict with IDL END keyword)	XML source: <CoverageOffering><domainSet><spatialDomain> <gml:temporalDomain><gml:timePeriod> <endPosition> or <CoverageOffering><gml:temporalDomain> <gml:timePeriod><endPosition>
RESOLUTION	XML source: <CoverageOffering><domainSet><spatialDomain> <gml:temporalDomain><gml:timePeriod> <timeResolution> or <CoverageOffering><gml:temporalDomain> <gml:timePeriod><timeResolution>
FRAME	XML source: <CoverageOffering><domainSet><spatialDomain> <gml:temporalDomain><gml:timePeriod><frame> or <CoverageOffering><gml:temporalDomain> <gml:timePeriod><frame>
CALENDAR	XML source: <CoverageOffering><domainSet><spatialDomain> <gml:temporalDomain><gml:timePeriod><calendar> or <CoverageOffering><gml:temporalDomain> <gml: timePeriod><calendar>
INDETERMINATE	XML source: <CoverageOffering><domainSet><spatialDomain> <gml:temporalDomain><gml:timePeriod> <indeterminate> or <CoverageOffering><gml:temporalDomain> <gml:timePeriod><indeterminate>

Range Structure

This structure is accessed through the RANGE field of the main coverage offering structure. All elements are strings unless otherwise noted.

Table 9-10: Range Structure Fields

Table 9-10: Range Structure Fields
Field	Description
NAME	XML source: <CoverageOffering><rangeSet><RangeSet> <name>
LABEL	XML source: <CoverageOffering><rangeSet><RangeSet> <label>
DESC	XML source: <CoverageOffering><rangeSet><RangeSet> <description>
NULL_SINGLE_VALUES	XML source: <CoverageOffering><rangeSet><RangeSet> <nullValues><singleValue> Returns an array of strings, 0 to many.
NUM_NULL_INTERVALS	Provides the number of interval elements as a convenience. This value is generated by IDL.
NULL_INTERVAL	XML source: <CoverageOffering><rangeSet><RangeSet> <nullValues><interval> Returns an array of structures (0 to many) where each structure contains an interval definition. See Null_Interval and Interval Structures for details.

Axis_Description Structure

This structure is accessed through the RANGE_AXIS field of the main coverage offering structure. All elements are strings unless otherwise noted.

Table 9-11: Axis_Description Structure Fields

Table 9-11: Axis_Description Structure Fields
Field	Description
NAME	XML source: <CoverageOffering><rangeSet><RangeSet> <axisDescription><AxisDescription><name>
LABEL	XML source: <CoverageOffering><rangeSet><RangeSet> <axisDescription><AxisDescription><label>
DESC	XML source: <CoverageOffering><rangeSet><RangeSet> <axisDescription><AxisDescription><description>
SINGLE_VALUE	XML source: <CoverageOffering><rangeSet><RangeSet> <axisDescription><AxisDescription><values> <singleValue> Returns an array of strings, 0 to many.
NUM_INTERVALS	Provides the number of interval elements as a convenience. This value is generated by IDL.
INTERVAL	XML source: <CoverageOffering><rangeSet><RangeSet> <axisDescription><AxisDescription><values> <interval> Returns an array of structures (0 to many) where each structure contains an interval definition. See Null_Interval and Interval Structures for details.
DEFAULT	XML source: <CoverageOffering><rangeSet><RangeSet> <axisDescription><AxisDescription><default>

Null_Interval and Interval Structures

Table 9-12: Null_Interval and Interval Structure Fields

Table 9-12: Null_Interval and Interval Structure Fields
Field	Description
MIN	XML source: <CoverageOffering><rangeSet><RangeSet> <nullValues><interval><min> or <CoverageOffering><rangeSet><RangeSet> <axisDescription><AxisDescription><values> <interval><min>
MAX	XML source: <CoverageOffering><rangeSet><RangeSet> <nullValues><interval><max> or <CoverageOffering><rangeSet><RangeSet> <axisDescription><AxisDescription><values> <interval><max>
RES	XML source: <CoverageOffering><rangeSet><RangeSet> <nullValues><interval><res> or <CoverageOffering><rangeSet><RangeSet> <axisDescription><AxisDescription><values> <interval><res>

Table 9-12: Null_Interval and Interval Structure Fields

Field

Description

MIN

XML source: 
<CoverageOffering><rangeSet><RangeSet>
<nullValues><interval><min>

<CoverageOffering><rangeSet><RangeSet>
<axisDescription><AxisDescription><values>
<interval><min>

MAX

XML source: 
<CoverageOffering><rangeSet><RangeSet>
<nullValues><interval><max>

<CoverageOffering><rangeSet><RangeSet>
<axisDescription><AxisDescription><values>
<interval><max>

RES

XML source: 
<CoverageOffering><rangeSet><RangeSet>
<nullValues><interval><res>

<CoverageOffering><rangeSet><RangeSet>
<axisDescription><AxisDescription><values>
<interval><res>

CRS Structure

This structure is accessed through the CRS field of the main coverage offering structure and contains coordinate reference system fields.

Arguments

Keywords

INDEX

Table 9-13: CRS Structure Fields
Field	Description
REQUEST_RESPONSE	XML source: <CoverageOffering><supportedCRSs> <requestResponseCRSs>
REQUEST	XML source: <CoverageOffering><supportedCRSs> <requestCRSs>
RESPONSE	XML source: <CoverageOffering><supportedCRSs> <responseCRSs>
NATIVE	XML source: <CoverageOffering><supportedCRSs> <nativeCRSs>

Set this to a zero-based integer value indicating the coverage offering to retrieve. This is useful when the IDLnetOGCWCS::DescribeCoverage request returns information for more than a single coverage offering.

Examples

See the GetCoverage method Examples for sample code that extracts the elements of the GetCoverageOffering structure that are required for a successful query.