SE ConvertSearchBoundsDimensionality

SEDRIS Reference Manual APPENDIX C - LEVEL 0 READ and WRITE API AUXILIARY FUNCTIONS Functions SE ConvertSearchBoundsDimensionality

extern SE_Status_Code
SE_ConvertSearchBoundsDimensionality
(
const	SE_Search_Bounds	*	src_ptr,	(notes)
	SE_Search_Dimensionality		dimension,	(notes)
	SE_Search_Bounds	*	dest_ptr	(notes)
);

Given a set of search bounds and a search dimensionality, convert the search bounds to the simplest form required to support that dimensionality.

If dimension is SE_SEARCH_DIM_TWO_D, and 3D search bounds are provided,
1. the search bounds must be provided in an SRF with a 2D counterpart, and
2. the z / elevation information of the search bounds will be ignored by the search mechanism of the Level 0 API.
  This being the case, if 3D search bounds are provided, it's more efficient to convert them to 2D before using them.
If dimension is SE_SEARCH_DIM_THREE_D_ONLY, and 2D search bounds are provided, then the search mechanism of the Level 0 API will treat them as though infinity values had been provided for the z / elevation portion of the bounds. This being the case, if 2D bounds are provided, it's more efficient to convert them to 3D with infinity z / elevation values before using them.
Otherwise, *src_ptr is copied into *dest_ptr.

SE_STAT_CODE_SUCCESS if valid parameters were passed in and all operations succeeded.

SE_STAT_CODE_NULL_REQUIRED_PARAMETER and no changes are made, if src_ptr or dest_ptr was NULL.

SE_STAT_CODE_FAILURE and *dest_ptr is left unchanged, if

*src_ptr does not form a valid set of search bounds,

dimension is not valid,

dimension is SE_SEARCH_DIM_TWO_D, but *src_ptr is specified in a 3D SRF without a 2D counterpart, or

dimension is SE_SEARCH_DIM_THREE_D_ONLY, but *src_ptr is specified in a 2D SRF from which a 3D counterpart cannot be derived.

Parameters Notes

 pointer to source search bounds to be converted, depending on
    the specified dimensionality of the search for which they are to be
    used.

 dimensionality of the search to be performed; see
    SE_Search_Dimensionality for details on the interpretation
    of this parameter.

 pointer to an SE_Search_Bounds variable into which the result
    will be copied.

SE_STAT_CODE_SUCCESS	if valid parameters were passed in and all operations succeeded.
SE_STAT_CODE_NULL_REQUIRED_PARAMETER	and no changes are made, if src_ptr or dest_ptr was NULL.
SE_STAT_CODE_FAILURE	and dest_ptr is left unchanged, if src_ptr does not form a valid set of search bounds, dimension is not valid, dimension is SE_SEARCH_DIM_TWO_D, but src_ptr is specified in a 3D SRF without a 2D counterpart, or dimension is SE_SEARCH_DIM_THREE_D_ONLY, but src_ptr is specified in a 2D SRF from which a 3D counterpart cannot be derived.