/* * 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 "@(#) reset_exp.c 1.39 05/08/19 SwRI" #include #include #include "ret_codes.h" #include "gen_defs.h" #include "libbase_idfs.h" /******************************************************************************* * * * RESET_EXPERIMENT_INFO SUBROUTINE * * * * DESCRIPTION * * This routine is called whenever the end of the current data file has * * been reached and the status flag indicates that more data is forthcoming. * * The current files must be closed and certain flags must be reset to * * simulate a fresh start. Some memory arrays must be freed in anticipation * * of new allocated space for these arrays and the new data files must be * * opened. * * * * 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) * * 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 = reset_experiment_info (data_key, exten, vnum, 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_free_sensor_tables () frees the array of sensor_tables structures * * ir_free_mode_tables () frees the array of mode_tables structures * * file_open() opens the necessary header, data, and VIDF files* * for the requested data set * * free () frees previously allocated memory * * close() closes the file associated with the file * * descriptor specified * * * * 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 * * struct experiment_info a pointer to the structure that holds specific * * *ex experiment information * * SDDAS_USHORT mode_vnum version number for mode data associated with * * this combination * * SDDAS_SHORT rval holds the value returned by the called routine * * SDDAS_CHAR process_mode_data flag indicating if mode data is being * * processed for the data set in question * * * * SUBSYSTEM * * Display Level * * * ******************************************************************************/ SDDAS_SHORT reset_experiment_info (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) { extern struct general_info ginfo; extern SDDAS_CHAR ir_inside_reset_exp; struct experiment_info *ex; SDDAS_USHORT mode_vnum; SDDAS_SHORT rval; SDDAS_CHAR process_mode_data; /***************************************************************************/ /* Check to see if the combination being processed has been processed */ /* before. 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 we pass a 0 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 (RESET_NOT_FOUND); /***************************************************************************/ /* Close the header, data, and VIDF file currently opened and reset the */ /* file descriptors to indicate that no file has been opened. */ /***************************************************************************/ ex = ginfo.expt; if (ex->fdh != -1) close (ex->fdh); if (ex->fdd != -1) close (ex->fdd); ex->fdh = -1; ex->fdd = -1; /***************************************************************************/ /* Reset the following variables to indicate a fresh start to the system. */ /***************************************************************************/ ex->tdw_len = -1; ex->info_ptr->h_size = -1; ex->fnext = 0; /**************************************************************************/ /* If the user specified that mode data is to be processed, call this */ /* routine again with the same parameters, except for the mode version */ /* number, to reset 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. */ /**************************************************************************/ if (ex->mode_version != ex->version) { mode_vnum = ex->mode_version; rval = reset_experiment_info (data_key, exten, mode_vnum, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec); if (rval != ALL_OKAY) return (rval); rval = ir_locate_ex (data_key, exten, vnum, 0); } /************************************************************************/ /* Open the new set of data files for the combination being processed */ /* for the master ex structure only, not the mode ex structure since */ /* file_open is recursive and will open the mode ex files also. */ /************************************************************************/ if (ex->mode_done == MODE_FLAG) ex->mode_done = 0; else { process_mode_data = (ex->mode_version != ex->version) ? 1 : 0; ex->mode_done = 0; ir_inside_reset_exp = 1; rval = file_open (data_key, exten, vnum, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec, process_mode_data); ir_inside_reset_exp = 0; if (rval != ALL_OKAY) return (rval); } /**************************************************************************/ /* Free the tables for each sensor table combination and mode processed. */ /* This was moved to the end after a successful completion due to new */ /* data buffer manipulation library (libdatabuffer) in which all the */ /* sweeps are kept up to this file crossing situation and the information*/ /* concerning the tables may be needed, so don't wipe out if no data */ /* situation was encountered. */ /**************************************************************************/ ir_free_sensor_tables (ex); ir_free_mode_tables (ex); return (ALL_OKAY); }