/* * 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 "@(#) pback_dfiles.c 1.31 05/08/19 SwRI" #include #include #include #include "ret_codes.h" #include "libbase_idfs.h" #include "libdb.h" /******************************************************************************* * * * IR_PLAYBACK_DATA_FILES SUBROUTINE * * * * DESCRIPTION * * This module is called to determine if the playback data files for the * * requested time period and data set are available for usage. * * * * INPUT VARIABLES * * SDDAS_ULONG data_key key which uniquely identifies the data set * * being processed * * 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) * * SDDAS_CHAR *exten filename extension for the data to be used * * 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_LONG *closest_btime_sec the start time closest to user-requested * * SDDAS_LONG *closest_btime_nsec the start time closest to user-requested * * SDDAS_BOOL update_times flag indicating closest times are desired * * * * USAGE * * x = ir_playback_data_files (data_key, btime_yr, btime_day, btime_sec, * * btime_nsec, etime_yr, etime_day, etime_sec * * etime_nsec, exten, &closest_btime_yr, * * &closest_btime_day, &closest_btime_sec, * * &closest_btime_nsec, update_times) * * * * NECESSARY SUBPROGRAMS * * strcpy() copies a string to another string variable * * open() opens the file requested * * memset () memory initialization routine * * dbIDFSGetFile() returns the name of the data file(s) to open* * * * EXTERNAL VARIABLES * * struct general_info structure that holds information concerning * * ginfo the experiment that is being processed * * * * INTERNAL VARIABLES * * struct experiment_info *ex a pointer to the structure that holds * * specific experiment information * * int rval1 holds value returned by the database request* * SDDAS_SHORT new_btime_yr the start time closest to user-requested as * * determined by the database * * SDDAS_SHORT new_btime_day the start time closest to user-requested as * * determined by the database * * SDDAS_LONG new_btime_msec the start time closest to user-requested as * * determined by the database * * SDDAS_CHAR hname[] the full path name of the header file * * SDDAS_CHAR dname[] the full path name of the data file * * * * SUBSYSTEM * * Display Level * * * ******************************************************************************/ SDDAS_SHORT ir_playback_data_files (SDDAS_ULONG data_key, 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, SDDAS_CHAR *exten, SDDAS_SHORT *closest_btime_yr, SDDAS_SHORT *closest_btime_day, SDDAS_LONG *closest_btime_sec, SDDAS_LONG *closest_btime_nsec, SDDAS_BOOL update_times) { extern struct general_info ginfo; struct experiment_info *ex; int rval1; SDDAS_ULONG bmsec, emsec; SDDAS_LONG new_btime_msec; SDDAS_SHORT new_btime_yr, new_btime_day; SDDAS_CHAR hname[MAXPATHLEN], dname[MAXPATHLEN]; /***************************************************************************/ /* If the data files have already been opened, no need to open them again.*/ /***************************************************************************/ ex = ginfo.expt; if (ex->fdh != -1) return (ALL_OKAY); /**************************************************************************/ /* When plotting the data, both files must be online and ready to */ /* go. For now, the database only works in terms of seconds, so the */ /* nanoseconds parameter is ignored. This may change later. */ /**************************************************************************/ memset (hname, '0', MAXPATHLEN); memset (dname, '0', MAXPATHLEN); bmsec = (btime_sec * 1000) + (btime_nsec / 1000000); emsec = (etime_sec * 1000) + (etime_nsec / 1000000); /**************************************************************************/ /* Set these parameters so that if the request was NOT to return the */ /* updated times from the database, the values will stay the same upon */ /* return. */ /**************************************************************************/ new_btime_yr = btime_yr; new_btime_day = btime_day; new_btime_msec = bmsec; if (update_times == sTrue) rval1 = dbIDFSGetFileAndTimes (data_key, &new_btime_yr, &new_btime_day, &new_btime_msec, etime_yr, etime_day, emsec, _H_AND_D_, exten, hname, dname); else rval1 = dbIDFSGetFile (data_key, new_btime_yr, new_btime_day, new_btime_msec, etime_yr, etime_day, emsec, _H_AND_D_, exten, hname, dname); if (rval1 < 0) return ((SDDAS_SHORT) rval1); /**************************************************************************/ /* Return time closest to user-requested times. */ /**************************************************************************/ *closest_btime_yr = new_btime_yr; *closest_btime_day = new_btime_day; *closest_btime_sec = new_btime_msec / 1000; *closest_btime_nsec = (new_btime_msec % 1000) * 1000000; /***********************************************************************/ /* If any of the requests result in no data for the time frame */ /* specified, return this status. */ /***********************************************************************/ if (rval1 == NO_DATA) return (NO_DATA); /**************************************************************************/ /* Save the names of the opened files and check to make sure that all */ /* applicable files can be opened. */ /**************************************************************************/ strcpy (ex->header_name, hname); if ((ex->fdh = open (hname, O_RDONLY | O_BINARY)) < 0) return (PBACK_NO_HEADER); strcpy (ex->data_name, dname); if ((ex->fdd = open (dname, O_RDONLY | O_BINARY)) < 0) return (PBACK_NO_DATA); return (ALL_OKAY); }