SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API
Types
SE_Search_Dimensionality
/*
 * ENUM: SE_Search_Dimensionality
 *
 *   Used to specify
 *   (1) whether a search will return 2D objects, if they are present.
 *
 *       To ignore <Location 2Ds>, specify SE_SEARCH_DIM_THREE_D_ONLY. (Review
 *       the comments for SE_SEARCH_DIM_THREE_D_ONLY for details on how such
 *       a search will evaluate mixed-dimension objects.)
 *
 *       All other searches will consider <Location 2Ds> in evaluating
 *       objects.
 *
 *   (2) whether a search will consider the "height" components of
 *       <Location 3Ds>.
 *
 *       To ignore the "height" component, specify SE_SEARCH_DIM_TWO_D.
 *       All other searches will consider the "height" components
 *       of <Location 3Ds> when evaluating them. (See comments
 *       for specific options for details on how other searches
 *       will treat 2D objects and mixed-dimension objects).
 */
typedef enum
{
SE_SEARCH_DIM_TWO_DIMENSIONAL_OR_SURFACE, (notes)
SE_SEARCH_DIM_THREE_DIMENSIONAL, (notes)
SE_SEARCH_DIM_ALL_DIMENSIONS (notes)
} SE_Search_Dimensionality;


Enumerant Notes


SE_SEARCH_DIM_TWO_DIMENSIONAL_OR_SURFACE

 Can be used only for a search boundary that is defined for either
 (1) a 2D spatial reference frame, or
 (2) a 3D spatial reference frame that has a 2D counterpart
     (for example, geodetic).

 If the SE_Search_Bounds are defined in 3D, their "height" components
 are ignored.

 If a <Location 3D> is encountered by the search mechanism, its
 "height" component is ignored, and it is treated as though it
 were its 2D counterpart.

SE_SEARCH_DIM_THREE_DIMENSIONAL

 Can be used only for a search boundary that is defined for a
 3D spatial reference frame. The SE_Search_Bounds specified
 must be defined in a 3D spatial reference frame.

 For SE_SEARCH_DIM_THREE_D_ONLY_SEARCH, the search mechanism will
 ignore all <Location 2D> objects. Consequently,
 (1) no purely 2D object will be returned by this search, since
     all its <Locations> would be ignored by the search mechanism,
 and
 (2) 2D components of a mixed-dimension object will be ignored
     in determining the status of the mixed-dimension object.

SE_SEARCH_DIM_ALL_DIMENSIONS

 Can be used for a search boundary that is defined in either a
 2D or a 3D spatial reference frame.

 If a <Location 2D> is encountered by the search mechanism, the
 SE_Search_Bounds' height range (if there is one) is ignored,
 and just the other two dimensions are considered.

 If a <Location 3D> is encountered by the search mechanism,
 however, its "height" component is evaluated against the
 SE_Search_Bounds' height range.



Prev: SE_Search_Bounds_Closure. Next: SE_Search_Filter.


Return to: Top of this Page, Type Index

Last updated: July 16, 2004 Copyright © 2004 SEDRIS