/* * 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 "@(#) read_idf_update.c 1.8 05/08/19 SwRI" #if defined (__MINGW32__) || defined (__MSVCRT__) #include #else #include #endif #include #include "ret_codes.h" #include "gen_defs.h" #include "libbase_idfs.h" #include "libVIDF.h" /****************************************************************************** * * * IR_READ_IDF_UPDATE SUBROUTINE * * * * DESCRIPTION * * This routine is called to retrieve information from the VIDF file that * * will be utilized by various subroutines. The pertinent information is * * stored in the appropriate experiment_info structure. This information is * * flagged as "changeable" data when multiple VIDF files are involved; * * therefore, this information can change at a file boundary OR within a * * sensor set within a data record. * * * * INPUT VARIABLES * * 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 = ir_read_idf_update (btime_yr, btime_day, btime_sec, btime_nsec, * * etime_yr, etime_day, etime_sec, etime_nsec) * * * * NECESSARY SUBPROGRAMS * * ReadVIDF() reads information from the VIDF file * * ir_get_constants() retrieves all constants from the VIDF file * * ir_update_rval () returns an error code unique to this module * * for each possible ReadVIDF() error code * * * * 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 specific * * *ex experiment information * * struct inst_tbl_info a pointer to the structure which holds * * *tbl_info_ptr non-array table definition information * * for each table defined for data source * * register SDDAS_SHORT i looping variable * * SDDAS_ULONG data_key key which uniquely identifies the data set * * being processed * * SDDAS_LONG start_at_zero param. passed to ReadVIDF to avoid casting * * SDDAS_SHORT rval holds the value returned by the called routine * * SDDAS_CHAR num_sen_tbls no. of tables associated with sensor-specific * * data (excluding ASCII tables) * * SDDAS_CHAR last_sen_tbl the last sensor-specific table defined * * int ret_val holds the value returned by the called routine * * * * SUBSYSTEM * * Display Level * * * ******************************************************************************/ SDDAS_SHORT ir_read_idf_update (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; struct experiment_info *ex; struct inst_tbl_info *tbl_info_ptr; register SDDAS_SHORT i; SDDAS_ULONG data_key; SDDAS_LONG start_at_zero; SDDAS_SHORT rval; SDDAS_CHAR num_sen_tbls, last_sen_tbl; /* Leave variable as is, no typedefs. */ int ret_val; /**************************************************************************/ /* Retrieve pertinent information from the VIDF file that needs to be */ /* stored in the experiment_info structure. This code was broken out */ /* of the ir_read_idf_once() module to address the issue of multiple */ /* VIDF files. These items are to be "re-read" assuming that the items */ /* left in ir_read_idf_once() are to be left alone (documentation states */ /* those values CANNOT change if VIDF change does not occur at a file */ /* boundary). */ /**************************************************************************/ start_at_zero = 0; ex = ginfo.expt; data_key = ex->data_key; ret_val = ReadVIDF (data_key, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec, (SDDAS_CHAR *) &ex->de_year, _DE_YEAR, 0, start_at_zero, 1); if (ret_val < 0) return (ir_update_rval (ret_val)); ret_val = ReadVIDF (data_key, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec, (SDDAS_CHAR *) &ex->de_day, _DE_DAY, 0, start_at_zero, 1); if (ret_val < 0) return (ir_update_rval (ret_val)); ret_val = ReadVIDF (data_key, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec, (SDDAS_CHAR *) &ex->de_msec, _DE_MSEC, 0, start_at_zero, 1); if (ret_val < 0) return (ir_update_rval (ret_val)); ret_val = ReadVIDF (data_key, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec, (SDDAS_CHAR *) &ex->de_usec, _DE_USEC, 0, start_at_zero, 1); if (ret_val < 0) return (ir_update_rval (ret_val)); ret_val = ReadVIDF (data_key, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec, (SDDAS_CHAR *) &ex->fill_flag, _FILL_FLG, 0, start_at_zero, 1); if (ret_val < 0) return (ir_update_rval (ret_val)); if (ex->fill_flag == 1) { ret_val = ReadVIDF (data_key, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec, (SDDAS_CHAR *) &ex->fill_value, _FILL, 0, start_at_zero, 1); if (ret_val < 0) return (ir_update_rval (ret_val)); } /***************************************************************************/ /* Definition for tensor data must include a fill value that will be */ /* used to initialize the tensor data array. */ /***************************************************************************/ else if (ex->header_format == TENSOR_SINGLE_HEADER) return (UPDATE_IDF_NO_FILL); ret_val = ReadVIDF (data_key, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec, (SDDAS_CHAR *) &ex->pa_def, _PA_DEFINED, 0, start_at_zero, 1); if (ret_val < 0) return (ir_update_rval (ret_val)); /***************************************************************************/ /* Current restrictions on various fields for tensor processing. */ /***************************************************************************/ if (ex->header_format == TENSOR_SINGLE_HEADER) { if (ex->pa_def) return (UPDATE_IDF_BAD_PA_DEF); } ret_val = ReadVIDF (data_key, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec, (SDDAS_CHAR *) &ex->spin_src_def, _START_SPIN_DEFINED, 0, start_at_zero, -1); if (ret_val < 0) return (ir_update_rval (ret_val)); /***************************************************************************/ /* Current restrictions on various fields for tensor processing. */ /***************************************************************************/ if (ex->header_format == TENSOR_SINGLE_HEADER) { if (ex->spin_src_def) return (UPDATE_IDF_BAD_SPIN_DEF); } ret_val = ReadVIDF (data_key, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec, (SDDAS_CHAR *) &ex->potential_def, _POT_SRC_DEFINED, 0, start_at_zero, -1); if (ret_val < 0) return (ir_update_rval (ret_val)); /***************************************************************************/ /* Current restrictions on various fields for tensor processing. */ /***************************************************************************/ if (ex->header_format == TENSOR_SINGLE_HEADER) { if (ex->potential_def) return (UPDATE_IDF_BAD_POT_DEF); } ret_val = ReadVIDF (data_key, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec, (SDDAS_CHAR *) &ex->euler_def, _PMI_DEFINED, 0, start_at_zero, -1); if (ret_val < 0) return (ir_update_rval (ret_val)); /***************************************************************************/ /* Current restrictions on various fields for tensor processing. */ /***************************************************************************/ if (ex->header_format == TENSOR_SINGLE_HEADER) { if (ex->euler_def) return (UPDATE_IDF_BAD_PMI_DEF); } ret_val = ReadVIDF (data_key, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec, (SDDAS_CHAR *) &ex->celestial_def, _CP_DEFINED, 0, start_at_zero, -1); if (ret_val < 0) return (ir_update_rval (ret_val)); /***************************************************************************/ /* Current restrictions on various fields for tensor processing. */ /***************************************************************************/ if (ex->header_format == TENSOR_SINGLE_HEADER) { if (ex->celestial_def) return (UPDATE_IDF_BAD_CP_DEF); } ret_val = ReadVIDF (data_key, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec, (SDDAS_CHAR *) &ex->background_def, _BKGD_DEFINED, 0, start_at_zero, -1); if (ret_val < 0) return (ir_update_rval (ret_val)); /***************************************************************************/ /* Current restrictions on various fields for tensor processing. */ /***************************************************************************/ if (ex->header_format == TENSOR_SINGLE_HEADER) { if (ex->background_def) return (UPDATE_IDF_BAD_BKGD_DEF); } ret_val = ReadVIDF (data_key, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec, (SDDAS_CHAR *) ex->sen_status, _SEN_STATUS, 0, start_at_zero, -1); if (ret_val < 0) return (ir_update_rval (ret_val)); /**************************************************************************/ /* Although the NUMBER of tables cannot change due to PIDF restriction, */ /* the CONTENTS of the tables can change. */ /**************************************************************************/ if (ex->num_tbls != 0) { for (i = 0; i < ex->num_tbls; ++i) { tbl_info_ptr = ex->tbl_info_ptr + i; ret_val = ReadVIDF (data_key, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec, (SDDAS_CHAR *) &tbl_info_ptr->tbl_sca_sz, _TBL_SCA_SZ, i, start_at_zero, 1); if (ret_val < 0) return (ir_update_rval (ret_val)); ret_val = ReadVIDF (data_key, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec, (SDDAS_CHAR *) &tbl_info_ptr->crit_act_sz, _CRIT_ACT_SZ, i, start_at_zero, 1); if (ret_val < 0) return (ir_update_rval (ret_val)); ret_val = ReadVIDF (data_key, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec, (SDDAS_CHAR *) &tbl_info_ptr->tbl_type, _TBL_TYPE, i, start_at_zero, 1); if (ret_val < 0) return (ir_update_rval (ret_val)); ret_val = ReadVIDF (data_key, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec, (SDDAS_CHAR *) &tbl_info_ptr->tbl_var, _TBL_VAR, i, start_at_zero, 1); if (ret_val < 0) return (ir_update_rval (ret_val)); /*********************************************************************/ /* For speed issues, set these flags ONCE whenever tbl_var changes */ /* instead of within the modules called by convert_to_units(), which*/ /* determine this flag EVERYTIME it is called. These flags tell if */ /* the table is a function of raw data or processed data. */ /*********************************************************************/ if (tbl_info_ptr->tbl_var == FN_PROCESSED_DATA || tbl_info_ptr->tbl_var == FN_SC_POTENTIAL || tbl_info_ptr->tbl_var == FN_BACKGROUND) { tbl_info_ptr->sen_fn_of_raw = 0; tbl_info_ptr->swp_fn_of_raw = 0; tbl_info_ptr->cal_fn_of_raw = 0; tbl_info_ptr->scpot_fn_of_raw = 0; tbl_info_ptr->bkgd_fn_of_raw = 0; } else { tbl_info_ptr->sen_fn_of_raw = 1; tbl_info_ptr->swp_fn_of_raw = 1; tbl_info_ptr->cal_fn_of_raw = 1; tbl_info_ptr->scpot_fn_of_raw = 1; tbl_info_ptr->bkgd_fn_of_raw = 1; } tbl_info_ptr->mode_fn_of_raw = (tbl_info_ptr->tbl_var == FN_RAW_MODE) ? 1 : 0; ret_val = ReadVIDF (data_key, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec, (SDDAS_CHAR *) &tbl_info_ptr->tbl_expand, _TBL_EXPAND, i, start_at_zero, 1); if (ret_val < 0) return (ir_update_rval (ret_val)); /*********************************************************************/ /* Added by ChrisG - 1/24/97: This is a sanity check - table cannot*/ /* be expanded if the target variable is processed data. */ /*********************************************************************/ if (tbl_info_ptr->tbl_var == FN_PROCESSED_DATA || tbl_info_ptr->tbl_var == FN_PROCESSED_MODE || tbl_info_ptr->tbl_var == FN_SC_POTENTIAL || tbl_info_ptr->tbl_var == FN_BACKGROUND) { if (tbl_info_ptr->tbl_expand != 0) { printf ("\nTBL_EXPAND flag for table %d has been changed to 0.", i); printf ("\nVIDF file should be corrected.\n"); tbl_info_ptr->tbl_expand = 0; } } } /************************************************************************/ /* Make sure that all ascii and mode-dependent tables appear AFTER all */ /* other tables (use this scheme for efficiency reasons). */ /************************************************************************/ num_sen_tbls = 0; last_sen_tbl = -1; for (i = 0; i < ex->num_tbls; ++i) { tbl_info_ptr = ex->tbl_info_ptr + i; if (tbl_info_ptr->tbl_type == ASCII_TBL) continue; if (tbl_info_ptr->tbl_var == FN_RAW_MODE || tbl_info_ptr->tbl_var == FN_PROCESSED_MODE) continue; ++num_sen_tbls; last_sen_tbl = (SDDAS_CHAR) i; } if (num_sen_tbls != 0) { for (i = 0; i < ex->num_tbls; ++i) { tbl_info_ptr = ex->tbl_info_ptr + i; if (tbl_info_ptr->tbl_type == ASCII_TBL && i < last_sen_tbl) return (ASCII_AFTER_SENSOR); if ((tbl_info_ptr->tbl_var == FN_RAW_MODE || tbl_info_ptr->tbl_var == FN_PROCESSED_MODE) && i < last_sen_tbl) return (ASCII_AFTER_SENSOR); } } } ret_val = ReadVIDF (data_key, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec, (SDDAS_CHAR *) &ex->num_consts, _NUM_CONSTS, 0, start_at_zero, 1); if (ret_val < 0) return (ir_update_rval (ret_val)); ret_val = ReadVIDF (data_key, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec, (SDDAS_CHAR *) &ex->phi_method, _PHI_METHOD, 0, start_at_zero, 1); if (ret_val < 0) { if (ret_val == VIDF_ELEMENT_NOT_FOUND) ex->phi_method = 0; else return (ir_update_rval (ret_val)); } ret_val = ReadVIDF (data_key, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec, (SDDAS_CHAR *) &ex->data_lat_units, _DATA_LAT_UNITS, 0, start_at_zero, 1); if (ret_val < 0) return (ir_update_rval (ret_val)); ret_val = ReadVIDF (data_key, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec, (SDDAS_CHAR *) &ex->swp_reset_units, _SWP_RESET_UNITS, 0, start_at_zero, 1); if (ret_val < 0) return (ir_update_rval (ret_val)); ret_val = ReadVIDF (data_key, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec, (SDDAS_CHAR *) &ex->sen_reset_units, _SEN_RESET_UNITS, 0, start_at_zero, 1); if (ret_val < 0) return (ir_update_rval (ret_val)); rval = ir_get_constants (btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec); if (rval != ALL_OKAY) return (rval); return (ALL_OKAY); } /******************************************************************************* * * * IR_UPDATE_RVAL SUBROUTINE * * * * DESCRIPTION * * This routine returns an error code unique to IR_READ_IDF_UPDATE() based * * upon the error code returned by the call to ReadVIDF(). * * * * INPUT VARIABLES * * int ret_val the error code returned by ReadVIDF() * * * * USAGE * * x = ir_update_rval (ret_val) * * * * NECESSARY SUBPROGRAMS * * None * * * * EXTERNAL VARIABLES * * None * * * * INTERNAL VARIABLES * * None * * * * SUBSYSTEM * * Display Level * * * ******************************************************************************/ SDDAS_SHORT ir_update_rval (int ret_val) { switch (ret_val) { case IDF_MANY_BYTES: return (UPDATE_IDF_MANY_BYTES); case IDF_TBL_NUM: return (UPDATE_IDF_TBL_NUM); case IDF_CON_NUM: return (UPDATE_IDF_CON_NUM); case IDF_NO_ENTRY: return (UPDATE_IDF_NO_ENTRY); case VIDF_ELEMENT_NOT_FOUND: return (UPDATE_IDF_ELE_NOT_FOUND); default: return ((SDDAS_SHORT) ret_val); } }