/* * 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 "@(#) next_file_tm.c 1.9 05/08/19 SwRI" #include #include "ret_codes.h" #include "libbase_idfs.h" /******************************************************************************* * * * NEXT_FILE_START_TIME SUBROUTINE * * * * DESCRIPTION * * This routine is called to return the time to be used to retrieve the * * next data file once the LOS_STATUS or NEXT_FILE_STATUS has been returned * * by the data acquisition routines for the current data file. * * * * INPUT VARIABLES * * SDDAS_ULONG data_key key which uniquely identifies the data set * * being processed * * SDDAS_CHAR *exten filename extension for the data to be used * * SDDAS_USHORT vnum version number to be associated with this * * combination (allows for multiple opens) * * SDDAS_CHAR mode_data flag indicating if mode times being requested * * SDDAS_SHORT *start_yr the year for next data file retrieval * * SDDAS_SHORT *start_day the day of year for next data file retrieval * * SDDAS_LONG *start_sec the time of day in seconds for next data file * * retrieval * * SDDAS_LONG *start_nsec the time of day residual for next data file * * retrieval * * USAGE * * x = next_file_start_time (data_key, exten, vnum, mode_data, &start_yr, * * &start_day, &start_sec, &start_nsec) * * * * NECESSARY SUBPROGRAMS * * ir_locate_ex() determines if requested combination has * * already been pand points to the * * adjust_time () corrects time elements if too many seconds * * (day crossing) or too many days(year crossing)* * abs() returns the absolute value of a number * * * * 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 * * *ex specific 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 * * register SDDAS_LONG *toff pointer to time offset values * * reg SDDAS_LONG *stop_toff loop termination variable * * SDDAS_USHORT mode_vnum version number for mode data associated with * * this combination * * SDDAS_LONG emsec, ensec stop time of last sample processed * * SDDAS_LONG max_time_off maximum time offset value for all sensors * * SDDAS_LONG abs_toff absolute value of time offset value * * SDDAS_LONG add_msec additional millisecond value to add to end * * time to get to end of current data file * * SDDAS_SHORT rval holds called routine status flags * * char reset_called flag indicating if LOCATE_EX was called * * * * SUBSYSTEM * * Display Level * * * ******************************************************************************/ SDDAS_SHORT next_file_start_time (SDDAS_ULONG data_key, SDDAS_CHAR *exten, SDDAS_USHORT vnum, SDDAS_CHAR mode_data, SDDAS_SHORT *start_yr, SDDAS_SHORT *start_day, SDDAS_LONG *start_sec, SDDAS_LONG *start_nsec) { extern struct general_info ginfo; struct experiment_info *ex; struct ptr_rec *ptr; register SDDAS_LONG *toff, *stop_toff; SDDAS_USHORT mode_vnum; SDDAS_LONG emsec, ensec, max_time_off, add_msec, abs_toff; SDDAS_SHORT rval; char reset_called; /*************************************************************************/ /* 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. */ /*************************************************************************/ if (!ginfo.called_locate) { rval = ir_locate_ex (data_key, exten, vnum, 0); if (rval != ALL_OKAY) return (NEXT_FILE_TIME_NOT_FOUND); /***********************************************************************/ /* Retrieve the ex structure which holds mode-relevant information. */ /***********************************************************************/ if (mode_data) { /**********************************************************************/ /* User did not call file_open requesting mode data? */ /**********************************************************************/ ex = ginfo.expt; if (ex->mode_version == ex->version) return (NEXT_FILE_TIME_FILE_OPEN); mode_vnum = ex->mode_version; rval = ir_locate_ex (data_key, exten, mode_vnum, 0); if (rval != ALL_OKAY) return (NEXT_FILE_TIME_INFO_DUP); } ginfo.called_locate = 1; reset_called = 1; } else reset_called = 0; /*************************************************************************/ /* Get the ending time for the last sample. */ /*************************************************************************/ ex = ginfo.expt; ptr = ex->info_ptr; *start_yr = *ptr->YEAR; *start_day = *ptr->DAYOFYEAR; /*********************************************************************/ /* All sensors may not have the same time offset values; therefore, */ /* make sure that the time returned to get to the NEXT data/header */ /* file goes past the end of the current data/header file. */ /*********************************************************************/ if (!mode_data) { /*******************************************************************/ /* Value can be positive or negative. Just want maximum width. */ /*******************************************************************/ toff = ex->time_off; max_time_off = abs (*toff); ++toff; stop_toff = ex->time_off + ex->num_sensor; for (; toff < stop_toff; ++toff) { abs_toff = abs (*toff); if (abs_toff > max_time_off) max_time_off = abs_toff; } /*******************************************************************/ /* The time in the ex structure reflect the last sensor processed */ /* by read_drec(). If sensor does not utilize the maximum */ /* time_offset value, add the additional milliseconds needed. */ /* Also, since the time of the last sensor serves as the "base */ /* time", add back any negative time offset value since database */ /* is comparing dr_time's (base time in data record). */ /*******************************************************************/ abs_toff = abs (*(ex->time_off + ex->last_sensor)); add_msec = max_time_off - abs_toff; if (*(ex->time_off + ex->last_sensor) < 0) add_msec += abs_toff; } else add_msec = 0; /******************************************************************/ /* Add 1 millisecond to ensure that the next data file, not the */ /* current data file, will be retrieved from the database. */ /******************************************************************/ emsec = ex->etime_ms + add_msec; ensec = ex->etime_ns; ++emsec; *start_sec = (emsec + (ensec / 1000000)) / 1000; *start_nsec = (emsec % 1000) * 1000000 + ensec; adjust_time (start_yr, start_day, start_sec, 1); if (reset_called) ginfo.called_locate = 0; return (ALL_OKAY); }