/* * Copyright (C) 1998 by Southwest Research Institute (SwRI) * * All rights reserved under U.S. Copyright Law and International Conventions. * * The development of this Software was supported by contracts NAG5-3148, * NAG5-6855, NAS8-36840, NAG5-2323, and NAG5-7043 issued on behalf of * the United States Government by its National Aeronautics and Space * Administration. Southwest Research Institute grants to the Government, * and others acting on its behalf, a paid-up nonexclusive, irrevocable, * worldwide license to reproduce, prepare derivative works, and perform * publicly and display publicly, by or on behalf of the Government. * Other than those rights granted to the United States Government, no part * of this Software may be reproduced in any form or by any means, electronic * or mechanical, including photocopying, without permission in writing from * Southwest Research Institute. All inquiries should be addressed to: * * Director of Contracts * Southwest Research Institute * P. O. Drawer 28510 * San Antonio, Texas 78228-0510 * * * Use of this Software is governed by the terms of the end user license * agreement, if any, which accompanies or is included with the Software * (the "License Agreement"). An end user will be unable to install any * Software that is accompanied by or includes a License Agreement, unless * the end user first agrees to the terms of the License Agreement. Except * as set forth in the applicable License Agreement, any further copying, * reproduction or distribution of this Software is expressly prohibited. * Installation assistance, product support and maintenance, if any, of the * Software is available from SwRI and/or the Third Party Providers, as the * case may be. * * Disclaimer of Warranty * * SOFTWARE IS WARRANTED, IF AT ALL, IN ACCORDANCE WITH THESE TERMS OF THE * LICENSE AGREEMENT. UNLESS OTHERWISE EXPLICITLY STATED, THIS SOFTWARE IS * PROVIDED "AS IS", IS EXPERIMENTAL, AND IS FOR NON-COMMERCIAL USE ONLY, * AND ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, * INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR * PURPOSE, OR NON-INFRINGEMENT, ARE DISCLAIMED, EXCEPT TO THE EXTENT THAT * SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID. * * Limitation of Liability * * SwRI SHALL NOT BE LIABLE FOR ANY DAMAGES SUFFERED AS A RESULT OF USING, * MODIFYING, CONTRIBUTING, COPYING, DISTRIBUTING, OR DOWNLOADING THIS * SOFTWARE. IN NO EVENT SHALL SwRI BE LIABLE FOR ANY INDIRECT, PUNITIVE, * SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGE (INCLUDING LOSS OF BUSINESS, * REVENUE, PROFITS, USE, DATA OR OTHER ECONOMIC ADVANTAGE) HOWEVER IT ARISES, * WHETHER FOR BREACH OF IN TORT, EVEN IF SwRI HAS BEEN PREVIOUSLY ADVISED OF * THE POSSIBILITY OF SUCH DAMAGE. YOU HAVE SOLE RESPONSIBILITY FOR ADEQUATE * PROTECTION AND BACKUP OF DATA AND/OR EQUIPMENT USED IN CONNECTION WITH THE * SOFTWARE AND WILL NOT MAKE A CLAIM AGAINST SwRI FOR LOST DATA, RE-RUN TIME, * INACCURATE OUTPUT, WORK DELAYS OR LOST PROFITS RESULTING FROM THE USE OF * THIS SOFTWARE. YOU AGREE TO HOLD SwRI HARMLESS FROM, AND YOU COVENANT NOT * TO SUE SwRI FOR, ANY CLAIMS BASED ON USING THE SOFTWARE. * * Local Laws: Export Control * * You acknowledge and agree this Software is subject to the U.S. Export * Administration Laws and Regulations. Diversion of such Software contrary * to U.S. law is prohibited. You agree that none of the Software, nor any * direct product therefrom, is being or will be acquired for, shipped, * transferred, or reexported, directly or indirectly, to proscribed or * embargoed countries or their nationals, nor be used for nuclear activities, * chemical biological weapons, or missile projects unless authorized by U.S. * Government. Proscribed countries are set forth in the U.S. Export * Administration Regulations. Countries subject to U.S embargo are: Cuba, * Iran, Iraq, Libya, North Korea, Syria, and the Sudan. This list is subject * to change without further notice from SwRI, and you must comply with the * list as it exists in fact. You certify that you are not on the U.S. * Department of Commerce's Denied Persons List or affiliated lists or on the * U.S. Department of Treasury's Specially Designated Nationals List. You agree * to comply strictly with all U.S. export laws and assume sole responsibilities * for obtaining licenses to export or reexport as may be required. * * General * * These Terms represent the entire understanding relating to the use of the * Software and prevail over any prior or contemporaneous, conflicting or * additional, communications. SwRI can revise these Terms at any time * without notice by updating this posting. * * Trademarks * * The SwRI logo is a trademark of SwRI in the United States and other countries. * */ #ident "@(#) fine_search.c 1.32 05/08/19 SwRI" #include "ret_codes.h" #include "libbase_idfs.h" #define TRUE 1 /****************************************************************************** * * * IR_FINE_SEARCH SUBROUTINE * * * * DESCRIPTION * * This module walks thru the data file to the correct starting position * * corresponding to the playback start time selected by the user once the * * coarse search has been performed. A fine search is performed by calling * * READ_DREC() to return the next time sample. One sample is picked up with * * each call for scalar instruments. This call to READ_DREC() is continued * * until the sample closest to the requested start time has been found. * * * * INPUT VARIABLES * * SDDAS_ULONG data_key key which uniquely identifies the data set * * being processed * * SDDAS_CHAR *exten the filename extension for the data to be used * * SDDAS_USHORT vnum version number to be associated with this * * combination (allows for multiple opens) * * void *idf_data_ptr ptr to the memory location for the structure * * that holds returned data values (read_drec) * * SDDAS_SHORT btime_yr the start time requested (year component) * * SDDAS_SHORT btime_day the start time requested (day component) * * SDDAS_LONG btime_sec the start time requested (seconds component) * * SDDAS_LONG btime_nsec the start time requested (nanoseconds) * * SDDAS_BOOL *data_gap flag indicating scenario when requested start * * time is in a gap between the end of a record * * and the start of the next * * * * USAGE * * x = ir_fine_search (data_key, exten, vnum, idf_data_ptr, btime_yr, * * btime_day, btime_sec, btime_nsec, &data_gap) * * * * NECESSARY SUBPROGRAMS * * read_drec() the universal read routine that retrieves the * * data for the time sample being processed * * * * EXTERNAL VARIABLES * * struct general_info structure that holds information concerning * * ginfo the experiment that is being processed * * * * INTERNAL VARIABLES * * struct idf_data structure that holds all of the currently * * *EXP_DATA returned data values to be processed * * struct experiment_info a pointer to the structure that holds specific * * *ex experiment information * * struct ptr_rec *ptr a pointer to the structure which holds all * * pointers to the header and data for the * * experiment of interest * * SDDAS_LONG rec_bgn_sec the starting time of the sweep being processed * * SDDAS_LONG rec_bgn_nsec the starting time of the sweep (nanoseconds) * * SDDAS_LONG rec_end_sec the ending time of the sweep being processed * * SDDAS_LONG rec_end_nsec the ending time of the sweep (nanoseconds) * * SDDAS_SHORT rval holds the value returned by the called routine * * SDDAS_SHORT byr, bday start year/day value for record being checked * * SDDAS_SHORT eyr, eday end year/day value for record being checked * * SDDAS_SHORT i looping variable * * SDDAS_CHAR full_swp flag that indicates if 1 value is being * * requested or all values for the record (for * * a scalar parameter only) * * char diff_day flag indicating if sample crosses to next day * * * * SUBSYSTEM * * Display Level * * * ******************************************************************************/ SDDAS_SHORT ir_fine_search (SDDAS_ULONG data_key, SDDAS_CHAR *exten, SDDAS_USHORT vnum, void *idf_data_ptr, SDDAS_SHORT btime_yr, SDDAS_SHORT btime_day, SDDAS_LONG btime_sec, SDDAS_LONG btime_nsec, SDDAS_BOOL *data_gap) { extern struct general_info ginfo; struct idf_data *EXP_DATA; struct experiment_info *ex; struct ptr_rec *ptr; SDDAS_LONG rec_bgn_sec, rec_bgn_nsec, rec_end_sec, rec_end_nsec; SDDAS_SHORT rval, byr, bday, eyr, eday; SDDAS_CHAR full_swp = 0; /* Leave variable as is, no typedefs. */ char diff_day; /***************************************************************************/ /* Set a pointer to the structure which holds all pointers for header and */ /* data information for the experiment currently being processed. */ /***************************************************************************/ ex = ginfo.expt; ptr = ex->info_ptr; EXP_DATA = (struct idf_data *) idf_data_ptr; /**************************************************************************/ /* Begin the fine search -- first read the data record which contains */ /* the user requested time (use no advance to test time value). All we */ /* are interested in is the time. */ /**************************************************************************/ *data_gap = sFalse; rval = read_drec (data_key, exten, vnum, idf_data_ptr, *ptr->SENSOR_INDEX, 0, full_swp); if (rval < 0 || rval % 3 == 0) { if (rval == LOS_STATUS) return (PBACK_LOS); else if (rval == NEXT_FILE_STATUS) return (PBACK_NEXT_FILE); else return (rval); } /**************************************************************************/ /* Read the data record sweep by sweep and find the sweep which contains */ /* the user requested time. */ /**************************************************************************/ do { /*********************************************************************/ /* Compute the time of the data at this time period. */ /*********************************************************************/ byr = EXP_DATA->byear; bday = EXP_DATA->bday; rec_bgn_sec = EXP_DATA->bsec; rec_bgn_nsec = EXP_DATA->bnsec; eyr = EXP_DATA->eyear; eday = EXP_DATA->eday; rec_end_sec = EXP_DATA->esec; rec_end_nsec = EXP_DATA->ensec; diff_day = (bday == eday) ? 0 : 1; /***********************************************************************/ /* If the time asked for results in a gap between the end of a record */ /* and the start of the next, terminate the search. Had to modify the */ /* code to take into account the situation where the gap includes a */ /* day boundary change. */ /***********************************************************************/ if ((btime_yr == byr && btime_day == bday && rec_bgn_sec > btime_sec) || (btime_yr == byr && btime_day == bday && rec_bgn_sec == btime_sec && rec_bgn_nsec > btime_nsec) || (btime_yr == byr && btime_day < bday)) { *data_gap = sTrue; ex->next_offset = ptr->cur_sen_set; break; } /***********************************************************************/ /* The sweep which holds the start time is found (the time is */ /* contained within the data sample). This code segment assumes the */ /* same year/day so compare only against the start of the record. */ /***********************************************************************/ else if (btime_yr == byr && btime_day == bday && rec_bgn_sec <= btime_sec && (btime_yr < eyr || btime_day < eday || btime_sec < rec_end_sec || (btime_sec == rec_end_sec && btime_nsec < rec_end_nsec))) { ex->next_offset = ptr->cur_sen_set; break; } /***********************************************************************/ /* Day cross-over so compare against end time to make sure this is */ /* NOT the record to select. Use <= for nsec since comparison is */ /* for a day crossing. */ /***********************************************************************/ else if (diff_day && btime_yr == eyr && btime_day == eday && (btime_sec < rec_end_sec || (btime_sec == rec_end_sec && btime_nsec <= rec_end_nsec))) { ex->next_offset = ptr->cur_sen_set; break; } else { /********************************************************************/ /* Advance to the next sweep since the current sweep does not hold */ /* the requested start time. */ /********************************************************************/ rval = read_drec (data_key, exten, vnum, idf_data_ptr, *ptr->SENSOR_INDEX, 1, full_swp); if (rval < 0 || rval % 3 == 0) { if (rval == LOS_STATUS) return (PBACK_LOS); else if (rval == NEXT_FILE_STATUS) return (PBACK_NEXT_FILE); else return (rval); } /*********************************************************************/ /* Read the sweep. (use no advance to test time value). */ /* Be sure to reset ex structure after calling read_drec() since */ /* multiple VIDF file crossing may cause a reallocation of the */ /* existing ex structures so address may change. */ /*********************************************************************/ rval = read_drec (data_key, exten, vnum, idf_data_ptr, *ptr->SENSOR_INDEX, 0, full_swp); if (rval < 0 || rval % 3 == 0) { if (rval == LOS_STATUS) return (PBACK_LOS); else if (rval == NEXT_FILE_STATUS) return (PBACK_NEXT_FILE); else return (rval); } ex = ginfo.expt; ptr = ex->info_ptr; } } while (TRUE); return (ALL_OKAY); }