/* * 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_open.c 1.38 05/08/19 SwRI" #include "gen_defs.h" #include "libbase_idfs.h" #include "ret_codes.h" #include "libdb.h" /******************************************************************************* * * * FILE_OPEN SUBROUTINE * * * * DESCRIPTION * * This routine retrieves and opens the necessary header, data, and VIDF * * files for the time period and data set requested. For the playback * * scenario, if a filename extension is not given, the default data files * * will be retrieved and opened; otherwise, the data files for the time period* * and filename extension requested will be retrieved and opened. In * * addition, information that is needed from the VIDF file is retrieved, if * * necessary. In addition, the user must specify if mode processing is to be * * done for the data set in question since modes are NOT tied to * * sensor-specific data and need their own ex structure. * * * * 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_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 mode_data flag indicating that mode data is to be * * processed * * * * USAGE * * x = file_open (data_key, exten, vnum, btime_yr, btime_day, btime_sec, * * btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec, * * mode_data) * * * * 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_file_setup() opens the data, header and vidf file and * * retrieves information from the VIDF file * * get_version_number () returns the next available version number * * * * EXTERNAL VARIABLES * * struct general_info structure that holds information concerning * * ginfo the experiment that is being processed * * SDDAS_CHAR ir_inside_reset_exp flag indicating in RESET_EXPERIMENT_INFO * * module (needed for FILE_OPEN logic) * * * * INTERNAL VARIABLES * * reg struct experiment_info a pointer to the structure that holds * * *ex specific 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 ret_val the value returned by the called routine * * SDDAS_USHORT mode_vnum version number for mode ex structure * * SDDAS_CHAR no_data_status flag indicating if main source encountered * * a NO_DATA condition (not mode or pa source) * * SDDAS_BOOL update_times flag indicating closest times are desired * * * * SUBSYSTEM * * Display Level * * * ******************************************************************************/ SDDAS_SHORT file_open (SDDAS_ULONG data_key, SDDAS_CHAR *exten, SDDAS_USHORT vnum, 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 mode_data) { extern struct general_info ginfo; extern SDDAS_CHAR ir_inside_reset_exp; register struct experiment_info *ex; SDDAS_LONG closest_btime_sec, closest_btime_nsec; SDDAS_SHORT closest_btime_yr, closest_btime_day; SDDAS_SHORT ret_val; SDDAS_USHORT mode_vnum; SDDAS_CHAR no_data_status; SDDAS_BOOL update_times = sTrue; /********************************************************************/ /* Open the data, header and vidf files and retrieve information */ /* from the VIDF file. Allow the processing of mode data and / or */ /* ancillary data if NO_DATA is encountered (some applications */ /* utilize the ex structures and key off values in the structures).*/ /********************************************************************/ no_data_status = 0; ret_val = ir_file_setup (data_key, exten, vnum, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec, &closest_btime_yr, &closest_btime_day, &closest_btime_sec, &closest_btime_nsec, update_times); if (ret_val != ALL_OKAY && ret_val != NO_DATA) return (ret_val); else if (ret_val == NO_DATA) no_data_status = 1; /**************************************************************************/ /* If the user specified that mode data is to be processed, a copy of */ /* the ex structure is needed so call file_open with same parameters, */ /* except for a new version number, to get another ex structure. */ /* After this is done, call LOCATE_EX to point back to original ex */ /* structure requested by user. If version number matches mode version */ /* number, it is implied that no mode data is to be processed. */ /**************************************************************************/ ex = ginfo.expt; ex->closest_time.btime_year = closest_btime_yr; ex->closest_time.btime_day = closest_btime_day; ex->closest_time.btime_sec = closest_btime_sec; ex->closest_time.btime_nsec = closest_btime_nsec; ex->closest_time.etime_year = etime_yr; ex->closest_time.etime_day = etime_day; ex->closest_time.etime_sec = etime_sec; ex->closest_time.etime_nsec = etime_nsec; if (mode_data == 0 && !ex->mode_done) ex->mode_version = ex->version; else if (mode_data == 2) { ex->mode_version = ex->version; ex->mode_done = MODE_FLAG; } else if (mode_data == 1 && !ex->mode_done) { /********************************************************************/ /* If reset_experiment_info called this routine, the mode ex */ /* structure has been allocated so point back to this structure. */ /********************************************************************/ if (!ir_inside_reset_exp) get_version_number (&mode_vnum); else mode_vnum = ex->mode_version; ex->mode_done = 1; /********************************************************************/ /* For mode, use same time as parent source. */ /********************************************************************/ ex->mode_version = mode_vnum; ret_val = file_open (data_key, exten, mode_vnum, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec, 2); if (ret_val != ALL_OKAY) return (ret_val); ret_val = ir_locate_ex (data_key, exten, vnum, 0); ex = ginfo.expt; } /**********************************************************************/ /* If main source encountered a NO_DATA scenario, return this status */ /* code. */ /**********************************************************************/ if (no_data_status) return (NO_DATA); else return (ALL_OKAY); }