SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API
Types
SE_Time_Select_Parameters
/*
 * STRUCT: SE_Time_Select_Parameters
 *
 *   Used to build up the SE_Hierarchy_Select_Parameters data structure.
 *
 *   Used to select which branches to traverse from a <Time Related Features>
 *   or <Time Related Geometry> object when encountered by a Component
 *   Iterator.  All branches with a <Geometry Time Constraints Data> or
 *   <Feature Time Constraints Data> link object having <Time Data> with
 *   values "matching" the ranges specified in the time_entry_array will be
 *   traversed.
 *
 *   If no rules are provided for the "type" of time data of the branch
 *   in question, then the branch will be traversed.  For example, if a branch
 *   is marked with season data, but only time_of_day search ranges are
 *   provided, then the season branch will be taken.  When no search rules for
 *   a certain "type" of time are defined, then all values for that "type"
 *   of time are considered valid.  For another example, if time_interval
 *   search ranges are given, but only for SE_TIME_MEAS_TYP_GMT times and not
 *   any SE_TIME_MEAS_TYP_RELATIVE_TO_EXERCISE_START times, then any branch
 *   with an SE_TIME_MEAS_TYP_RELATIVE_TO_EXERCISE_START time value will be
 *   traversed, but branches with SE_TIME_MEAS_TYP_GMT time values will only
 *   be traversed if they "match" the given SE_TIME_MEAS_TYP_GMT search ranges.
 *
 *   See the definitions of the <Time Related Features>,
 *   <Time Related Geometry>, <Time Constraints Data>, <Time Data>,
 *   <Time Interval>, <Time Point>, <Season>, and <Time Of Day>
 *   classes for more details.
 */
typedef struct
{
SE_Branch_Range_Matching matching_rules; (notes)
SE_Integer_Unsigned time_entry_count; (notes)
SE_Time_Entry *time_entry_array; (notes)
} SE_Time_Select_Parameters;


Field Notes


matching_rules

 Specifies how the ranges should be "matched" against the
 field values of the branches (exact match, any overlap, etc.).

time_entry_count

 Specifies the number of entries in the following array.

time_entry_array

 An array of time values to search against.



Prev: SE_Time_Point_Entry. Next: SE_Transmittal.


Return to: Top of this Page, Type Index

Last updated: July 16, 2004 Copyright © 2004 SEDRIS