/* * 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 "@(#) new_idf.c 1.11 05/08/19 SwRI" #include "gen_defs.h" #include "ret_codes.h" #include "libbase_idfs.h" /******************************************************************************* * * * IR_NEW_IDF_FILE SUBROUTINE * * * * DESCRIPTION * * This module is called when a new VIDF file is to be retrieved. This * * module should only be called if a VIDF file change is needed from within a * * sensor set, not at a file boundary, where all three files (data, header * * VIDF) are needed. Therefore, certain guidelines were written up in the * * VIDF documentation and are followed by this code. No need to call this * * routine recursively for mode ex structures; the call to read_drec() with * * the version number for the mode ex structure will call this module. * * * * INPUT VARIABLES * * SDDAS_SHORT btime_yr, start time for VIDF file to be retrieved * * btime_day * * SDDAS_LONG btime_sec, start time for VIDF file to be retrieved * * btime_nsec * * * * USAGE * * x = ir_new_idf_file (btime_yr, btime_day, btime_sec, btime_nsec) * * * * NECESSARY SUBPROGRAMS * * ir_free_sensor_tables () frees the array of sensor_tables structures * * ir_free_mode_tables () frees the array of mode_tables structures * * ir_free_pa_information () frees pitch angle information, if applicable* * ir_free_euler_information () frees euler angle information, if applicable* * ir_free_celestial_position_information () frees celestial position info.,* * if applicable * * ir_free_spin_src_information() frees start of spin data source info., * * if applicable * * ir_free_potential_information () frees spacecraft potential information,* * if applicable * * ir_free_background_information () frees background info, if applicable * * ir_read_idf_update () reads information from the VIDF file (this * * information is flagged as "changeable" when * * multiple VIDF files are involved) * * ir_sensor_combo() determines how many unique combinations * * exist among the tables used by all sensors * * ir_get_mode_info() retrieves any mode-dependent tables * * ir_new_idf_file_pa () updates pitch angle information for new VIDF* * ir_new_idf_file_euler () updates euler angle information for new VIDF* * ir_new_idf_file_celestial_position () updates celestial position info. * * for new VIDF * * ir_new_idf_file_spin_src () updates start of spin data source info. * * for new VIDF * * ir_new_idf_file_potential () updates spacecraft potential information * * for new VIDF * * ir_new_idf_file_background() updates background information for new VIDF * * ir_check_critical_status() checks each sensor's critical status byte * * value and takes appropriate action * * * * EXTERNAL VARIABLES * * struct general_info structure that holds information concerning * * ginfo the experiment that is being processed * * * * INTERNAL VARIABLES * * struct experiment_info ptr to the structure that holds info. * * *ex pertinent to the current IDFS data source * * being processed * * SDDAS_LONG etime_sec, user-requested end time * * etime_nsec * * SDDAS_SHORT rval the value returned by the called routine * * SDDAS_SHORT etime_yr, user-requested end time * * etime_day * * SDDAS_CHAR reset_called flag used to determine if element within * * ginfo structure was reset * * * * SUBSYSTEM * * Display Level * * * ******************************************************************************/ SDDAS_SHORT ir_new_idf_file (SDDAS_SHORT btime_yr, SDDAS_SHORT btime_day, SDDAS_LONG btime_sec, SDDAS_LONG btime_nsec) { extern struct general_info ginfo; struct experiment_info *ex; SDDAS_LONG etime_sec, etime_nsec; SDDAS_SHORT rval, etime_yr, etime_day; SDDAS_CHAR reset_called; /***************************************************************************/ /* Read_drec() may have set this flag; reset so calls to locate_ex() can */ /* be made as needed by subsequent routines. */ /***************************************************************************/ if (ginfo.called_locate) { ginfo.called_locate = 0; reset_called = 1; } else reset_called = 0; /***************************************************************************/ /* Since this module is called indirectly by read_drec(), already at the */ /* ex structure of interest. */ /***************************************************************************/ ex = ginfo.expt; etime_yr = ex->requested_time.etime_year; etime_day = ex->requested_time.etime_day; etime_sec = ex->requested_time.etime_sec; etime_nsec = ex->requested_time.etime_nsec; /***************************************************************************/ /* Free the tables for each sensor table combination and mode processed. */ /***************************************************************************/ ir_free_sensor_tables (ex); ir_free_mode_tables (ex); ir_free_pa_information (ex); ir_free_spin_src_information (ex); ir_free_potential_information (ex); ir_free_background_information (ex); ir_free_euler_information (ex); ir_free_celestial_position_information (ex); /*********************************************************************/ /* Retrieve the information that is flagged as "changeable" when */ /* multiple VIDF files are involved. */ /*********************************************************************/ rval = ir_read_idf_update (btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec); if (rval != ALL_OKAY) { if (reset_called) ginfo.called_locate = 1; return (rval); } /************************************************************************/ /* Re-determine the different table combinations used by the various */ /* sensors. */ /************************************************************************/ rval = ir_sensor_combo (btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec); if (rval != ALL_OKAY) { if (reset_called) ginfo.called_locate = 1; return (rval); } /************************************************************************/ /* Re-determine the table(s) for the modes. */ /************************************************************************/ rval = ir_get_mode_info (btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec); if (rval != ALL_OKAY) { if (reset_called) ginfo.called_locate = 1; return (rval); } /*********************************************************************/ /* Retrieve pitch angle information if still pertinent. Be sure to */ /* reset ex structure since the called module may change the ex */ /* structure being referenced and will point back to parent */ /* (do this regardless of error code). */ /*********************************************************************/ if (ex->pa_def && ex->bmem.base_pitch_info == NO_MEMORY) { rval = ir_new_idf_file_pa (btime_yr, btime_day, btime_sec, btime_nsec); ex = ginfo.expt; if (rval != ALL_OKAY) { if (reset_called) ginfo.called_locate = 1; return (rval); } } /**********************************************************************/ /* Retrieve start of spin data source information if still pertinent.*/ /* Be sure to reset ex structure since the called module may change */ /* the ex structure being referenced and will point back to parent */ /* (do this regardless of error code). */ /**********************************************************************/ if (ex->spin_src_def && ex->bmem.base_spin_src == NO_MEMORY) { rval = ir_new_idf_file_spin_src (btime_yr, btime_day, btime_sec, btime_nsec); ex = ginfo.expt; if (rval != ALL_OKAY) { if (reset_called) ginfo.called_locate = 1; return (rval); } } /*********************************************************************/ /* Retrieve spacecraft potential information if still pertinent. */ /* Be sure to reset ex structure since the called module may change */ /* the ex structure being referenced and will point back to parent */ /* (do this regardless of error code). */ /*********************************************************************/ if (ex->potential_def && ex->bmem.base_potential_info == NO_MEMORY) { rval = ir_new_idf_file_potential (btime_yr, btime_day, btime_sec, btime_nsec); ex = ginfo.expt; if (rval != ALL_OKAY) { if (reset_called) ginfo.called_locate = 1; return (rval); } } /*********************************************************************/ /* Retrieve euler angle information if still pertinent. Be sure to */ /* reset ex structure since the called module may change the ex */ /* structure being referenced and will point back to parent */ /* (do this regardless of error code). */ /*********************************************************************/ if (ex->euler_def && ex->bmem.base_euler_info == NO_MEMORY) { rval = ir_new_idf_file_euler (btime_yr, btime_day, btime_sec, btime_nsec); ex = ginfo.expt; if (rval != ALL_OKAY) { if (reset_called) ginfo.called_locate = 1; return (rval); } } /*********************************************************************/ /* Retrieve celestial position information if still pertinent. Be */ /* sure to reset ex structure since the called module may change */ /* the ex structure being referenced and will point back to parent */ /* (do this regardless of error code). */ /*********************************************************************/ if (ex->celestial_def && ex->bmem.base_celestial_info == NO_MEMORY) { rval = ir_new_idf_file_celestial_position (btime_yr, btime_day, btime_sec, btime_nsec); ex = ginfo.expt; if (rval != ALL_OKAY) { if (reset_called) ginfo.called_locate = 1; return (rval); } } /*********************************************************************/ /* Retrieve background information if still pertinent. Be sure to */ /* reset ex structure since the called module may change the ex */ /* structure being referenced and will point back to parent (do */ /* this regardless of error code). */ /*********************************************************************/ if (ex->background_def && ex->bmem.base_background_info == NO_MEMORY) { rval = ir_new_idf_file_background (btime_yr, btime_day, btime_sec, btime_nsec); ex = ginfo.expt; if (rval != ALL_OKAY) { if (reset_called) ginfo.called_locate = 1; return (rval); } } /***********************************************************************/ /* Check the critical status byte for any change. Needed to add this */ /* here since tables are re-loaded and for those tables that use a */ /* critical action, the tables were loaded based upon sensor NOT */ /* upon the mode the sensor was in, so need to adjust what part of */ /* the table was loaded. */ /***********************************************************************/ rval = ir_check_critical_status (btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec); if (rval != ALL_OKAY) return (rval); if (reset_called) ginfo.called_locate = 1; return (ALL_OKAY); }