/* * 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 "@(#) file_pos.c 1.40 05/08/19 SwRI" #include "gen_defs.h" #include "ret_codes.h" #include "libbase_idfs.h" #include "libVIDF.h" /****************************************************************************** * * * FILE_POS SUBROUTINE * * * * DESCRIPTION * * This module walks thru the data file to the correct starting position * * corresponding to the start time selected by the user. If the user * * entered a -1 for the start time, the file descriptor for the data file is * * positioned at the beginning of the data file. If the user entered a -2 * * for the start time, the file descriptor for the data file is positioned * * at the end of the data file. In either case, one data record and the * * corresponding header record is read so that information is ready to be * * processed when the user calls READ_DREC(). If the user requested a play- * * back scenario, a binary search is performed as a coarse search for the * * requested start time. A fine search is then performed in order to get as * * close to the requested start time as possible. * * * * 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 *data_ptr ptr to the memory location for the structure * * that holds returned data values (either * * idf_data or tensor_data) * * 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_SHORT etime_yr the stop time requested (year component) * * SDDAS_SHORT etime_day the stop time requested (day component) * * SDDAS_LONG etime_sec the stop time requested (seconds component) * * SDDAS_LONG etime_nsec the stop time requested (nanoseconds) * * * * USAGE * * x = file_pos (data_key, exten, vnum, data_ptr, btime_yr, btime_day, * * btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, * * etime_nsec) * * * * NECESSARY SUBPROGRAMS * * ir_locate_ex() determines if the requested combination has * * already been processed and points to the * * correct structure allocated for the combo * * ir_position_real_time() positions the file pointer for a real-time * * scenario * * ir_position_playback() positions the file pointer for a playback * * scenario * * select_sensor() specifies which sensors are to be processed * * ir_position_ancillary () positions the ancillary data sources needed * * by the parent * * valid_idf_data_structure() returns status flag indicating whether * * address of idf_data structure is valid * * (structure may have been freed) * * valid_tensor_data_structure() returns status flag indicating whether * * address of tensor_data structure is valid * * (structure may have been freed) * * * * EXTERNAL VARIABLES * * struct general_info structure that holds information concerning * * ginfo the experiment that is being processed * * * * INTERNAL VARIABLES * * struct experiment_info a pointer to the structure that holds specific * * *ex experiment information * * SDDAS_LONG closest_btime_sec the start time closest to user-requested * * SDDAS_LONG closest_btime_nsec the start time closest to user-requested * * SDDAS_SHORT closest_btime_yr the start time closest to user-requested * * SDDAS_SHORT closest_btime_day the start time closest to user-requested * * SDDAS_SHORT rval holds the value returned by the called routine * * SDDAS_USHORT mode_vnum version number for any mode data that is * * associated with this combination * * SDDAS_BOOL valid_address flag indicating if address for data structure * * is valid (has not been freed) * * * * SUBSYSTEM * * Display Level * * * ******************************************************************************/ SDDAS_SHORT file_pos (SDDAS_ULONG data_key, SDDAS_CHAR *exten, SDDAS_USHORT vnum, void *data_ptr, SDDAS_SHORT btime_yr, SDDAS_SHORT btime_day, SDDAS_LONG btime_sec, SDDAS_LONG btime_nsec, SDDAS_SHORT etime_yr, SDDAS_SHORT etime_day, SDDAS_LONG etime_sec, SDDAS_LONG etime_nsec) { extern struct general_info ginfo; struct idf_data *EXP_DATA; struct experiment_info *ex; SDDAS_LONG closest_btime_sec, closest_btime_nsec; SDDAS_SHORT closest_btime_yr, closest_btime_day; SDDAS_SHORT rval; SDDAS_USHORT mode_vnum; SDDAS_BOOL valid_address; /**************************************************************************/ /* Check to see if the combination being processed has been processed */ /* before. If not, an error condition - probably didn't call FILE_OPEN. */ /* Since ir_locate_ex() is called by more than one routine, return an */ /* error code that indicates which calling routine resulted in the error.*/ /* Since a 0 is passed for the last parameter, the only possible error is*/ /* that the requested combination was not found among processed combos. */ /**************************************************************************/ rval = ir_locate_ex (data_key, exten, vnum, 0); if (rval != ALL_OKAY) return (POS_NOT_FOUND); /***************************************************************************/ /* If the file pointers have already been set, just return to the calling */ /* routine. */ /***************************************************************************/ ex = ginfo.expt; if (ex->fnext) return (ALL_OKAY); /***************************************************************************/ /* New check added since added destroy_last_idf_data_structure() and */ /* destroy_last_tensor_data_structure() for user to make use of as needed.*/ /***************************************************************************/ if (ex->header_format == ORIGINAL_HEADER) valid_address = valid_idf_data_structure (data_ptr); else if (ex->header_format == TENSOR_SINGLE_HEADER) valid_address = valid_tensor_data_structure (data_ptr); else valid_address = sFalse; if (!valid_address) return (FILE_POS_INVALID_DATA); /**************************************************************************/ /* Set the pointer at the correct location in the data and header file */ /* for the real-time scenarion. */ /**************************************************************************/ ex->hrec_eof = 0; ex->drec_eof = 0; if (btime_sec == -1 || btime_sec == -2) { rval = ir_position_real_time (btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec, data_ptr); if (rval != ALL_OKAY) return (rval); } else { rval = ir_position_playback (data_key, exten, vnum, data_ptr, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec); if (rval != ALL_OKAY) return (rval); ex = ginfo.expt; /* reset since read_drec() is called from within */ } /**************************************************************************/ /* If the user specified that mode data is to be processed, call FILE_POS*/ /* with the same parameters, except for the mode version number, to */ /* fill in the ex structure for the mode data. After this is done, call */ /* LOCATE_EX to point back to original ex structure requested by user */ /* with their call. If version number matches mode version number, it */ /* is implied that no mode data is to be processed. To conserve space, */ /* turn on only one sensor (0) for the mode structure. */ /**************************************************************************/ if (ex->mode_version != ex->version) { mode_vnum = ex->mode_version; rval = select_sensor (data_key, exten, mode_vnum, 0); if (rval != ALL_OKAY) return (FILE_POS_MODE); rval = file_pos (data_key, exten, mode_vnum, data_ptr, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec); if (rval != ALL_OKAY) return (FILE_POS_MODE); rval = ir_locate_ex (data_key, exten, vnum, 0); ex = ginfo.expt; } /**************************************************************************/ /* Now, we wait until the parent has been positioned so that the correct */ /* ancillary file is opened and then positioned. */ /**************************************************************************/ if (ex->ancillary_opened == sFalse) { ex->ancillary_opened = sTrue; EXP_DATA = (struct idf_data *) data_ptr; closest_btime_yr = EXP_DATA->byear; closest_btime_day = EXP_DATA->bday; closest_btime_sec = EXP_DATA->bsec; closest_btime_nsec = EXP_DATA->bnsec; rval = ir_open_ancillary (data_key, exten, vnum, closest_btime_yr, closest_btime_day, closest_btime_sec, closest_btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec); if (rval != ALL_OKAY) return (rval); rval = ir_position_ancillary (data_key, exten, vnum, closest_btime_yr, closest_btime_day, closest_btime_sec, closest_btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec); if (rval != ALL_OKAY) return (rval); } return (ALL_OKAY); }