/* * 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 "@(#) get_new_tbl.c 1.31 05/08/19 SwRI" #include #include "ret_codes.h" #include "gen_defs.h" #include "libbase_idfs.h" #include "libVIDF.h" /***************************************************************************** * * * IR_GET_NEW_TBL SUBROUTINE * * * * DESCRIPTION * * This routine will retrieve the table values for the specified table. * * The values will either be read in (one-to-one mapping) from the VIDF * * file, constructed from the polynomial coefficients, or the table will * * be left as coefficients, but the values will be scaled and saved. * * * * INPUT VARIABLES * * SDDAS_SHORT sen the sensor being processed * * SDDAS_SHORT which_tbl the number of the table being processed * * SDDAS_CHAR expand flag indicating if the table is to be expanded* * SDDAS_CHAR tbl_fmt table format * * SDDAS_FLOAT *tbl pointer to the table * * SDDAS_LONG tbl_size the maximum number of values associated with * * the given sensor * * SDDAS_LONG tbl_off variable which holds the offset into table * * (-1 if need to read this info. from VIDF file)* * 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_get_new_tbl (sen, which_tbl, expand, tbl_fmt, tbl, tbl_size, * * tbl_off, btime_yr, btime_day, btime_sec, * * btime_nsec, etime_yr, etime_day, etime_sec, * * etime_nsec) * * * * NECESSARY SUBPROGRAMS * * sizeof () the size of the specified object in bytes * * realloc() reallocates previously allocated memory * * ReadVIDF() reads information from the VIDF file * * ir_tento() returns the power of 10 value to multiply by * * to get values to the correct base (scaling) * * ir_get_new_rval () returns an error code unique to this module * * for each possible ReadVIDF() error code * * ir_read_in_tbl () retrieves the table values from the VIDF file * * (no need for construction) * * ir_create_tbl () constructs the table values using information * * from the VIDF file * * * * EXTERNAL VARIABLES * * struct general_info structure that holds information concerning * * ginfo the experiment that is being processed * * SDDAS_UINT ir_tmp_bytes number of bytes allocated for scratch space * * void *ir_tmp_space scratch space for various uses * * * * INTERNAL VARIABLES * * struct experiment_info a pointer to the structure that holds * * *ex specific experiment information * * struct inst_tbl_info a pointer to the structure which holds the * * *tbl_info_ptr non-array table definition information for * * each table defined for the data source * * reg SDDAS_FLOAT *f1 pointer to data values (SDDAS_FLOAT values) * * reg SDDAS_FLOAT power the scaling to be applied to the table values * * reg SDDAS_FLOAT *stop_f1 loop termination pointer * * register SDDAS_LONG *l1 pointer to the values read * * register SDDAS_CHAR *c1 pointer to the scaling values * * SDDAS_ULONG data_key key which uniquely identifies the data set * * being processed * * SDDAS_SHORT rval holds the value returned by called routine * * SDDAS_SHORT num_values number of table values to process * * SDDAS_CHAR scale scaling factor to be applied to all values * * size_t bytes the number of bytes to allocate space for * * int ret_val holds the value returned by called routine * * void *tmp_ptr pointer which holds address passed back by * * the call to the MALLOC routine * * * * SUBSYSTEM * * Display Level * * * *****************************************************************************/ SDDAS_SHORT ir_get_new_tbl (SDDAS_SHORT sen, SDDAS_SHORT which_tbl, SDDAS_CHAR expand, SDDAS_CHAR tbl_fmt, SDDAS_FLOAT *tbl, SDDAS_LONG tbl_size, SDDAS_LONG tbl_off, 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_UINT ir_tmp_bytes; extern void *ir_tmp_space; struct experiment_info *ex; struct inst_tbl_info *tbl_info_ptr; register SDDAS_FLOAT *f1, power, *stop_f1; register SDDAS_LONG *l1; register SDDAS_CHAR *c1; SDDAS_ULONG data_key; SDDAS_SHORT rval, num_values; SDDAS_CHAR scale; /* Leave variables as is, no typedefs. */ size_t bytes; int ret_val; void *tmp_ptr; /**********************************************************************/ /* The table just needs to be read in (one-to-one mapping). */ /**********************************************************************/ ex = ginfo.expt; data_key = ex->data_key; if (tbl_fmt == 0) { rval = ir_read_in_tbl (sen, tbl, tbl_off, tbl_size, which_tbl, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec); if (rval != ALL_OKAY) return (rval); } /***********************************************************************/ /* The table needs to be constructed from the polynomial coefficients.*/ /***********************************************************************/ else if (tbl_fmt > 0) { if (expand) { rval = ir_create_tbl (sen, tbl, tbl_size, tbl_fmt, which_tbl, 1, tbl_off, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec); if (rval != ALL_OKAY) return (rval); } /**************************************************************************/ /* The polynomial coefficients should be scaled and saved (no expansion).*/ /**************************************************************************/ else if (!expand) { /************************************************************************/ /* TBL_EXPAND flag is hard-coded to 0 for tbl_type 2 (INTEGER_SCAN_TBL)*/ /* tables. */ /************************************************************************/ tbl_info_ptr = ex->tbl_info_ptr + which_tbl; num_values = (tbl_info_ptr->tbl_type == INTEGER_SCAN_TBL) ? tbl_fmt * ex->swp_len : tbl_fmt; /***********************************************************************/ /* A table offset of -1 indicates that the correct value needs to be */ /* read from the VIDF file. */ /***********************************************************************/ if (tbl_off == -1) { ret_val = ReadVIDF (data_key, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec, (SDDAS_CHAR *) &tbl_off, _TBL_OFF, which_tbl, (SDDAS_LONG) sen, 1); if (ret_val < 0) return (ir_get_new_rval (ret_val)); /*******************************************************************/ /* If tbl_off is still -1, perhaps critical action table? If not, */ /* error condition; otherwise, just set to zero since "real" */ /* table values will be picked up by header change using status */ /* byte value. */ /*******************************************************************/ if (tbl_off == -1) { if (tbl_info_ptr->crit_act_sz == 0) return (NEW_BAD_TBL_OFFSET); else tbl_off = 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, _TBL, which_tbl, tbl_off, num_values); if (ret_val < 0) return (ir_get_new_rval (ret_val)); /**********************************************************************/ /* There is one scaling value per value. */ /**********************************************************************/ if (tbl_info_ptr->tbl_sca_sz > 0) { /******************************************************************/ /* Allocate space to hold the scaling values. */ /******************************************************************/ bytes = num_values * sizeof (SDDAS_CHAR); if (bytes > ir_tmp_bytes) { if ((tmp_ptr = realloc (ir_tmp_space, bytes)) == NO_MEMORY) return (NEW_SCALE_MALLOC); ir_tmp_space = tmp_ptr; ir_tmp_bytes = (SDDAS_UINT) bytes; } ret_val = ReadVIDF (data_key, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec, (SDDAS_CHAR *) ir_tmp_space, _TBL_SCA, which_tbl, tbl_off, num_values); if (ret_val < 0) return (ir_get_new_rval (ret_val)); /******************************************************************/ /* Apply the scaling factors to the table values. For */ /* optimization purposes, it's advised to use ++x instead of x++.*/ /******************************************************************/ l1 = (SDDAS_LONG *) tbl; stop_f1 = tbl + num_values; for (f1 = tbl, c1 = (SDDAS_CHAR *) ir_tmp_space; f1 < stop_f1; ++f1, ++c1, ++l1) *f1 = *l1 * ir_tento (*c1); } /**********************************************************************/ /* There is a single scaling value for each sensor. */ /**********************************************************************/ else if (tbl_info_ptr->tbl_sca_sz < 0) { ret_val = ReadVIDF (data_key, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec, (SDDAS_CHAR *) &scale, _TBL_SCA, which_tbl, (SDDAS_LONG) sen, 1); if (ret_val < 0) return (ir_get_new_rval (ret_val)); /******************************************************************/ /* Apply the scaling factor to all the table values. For */ /* optimization purposes, it's advised to use ++x instead of x++.*/ /******************************************************************/ power = ir_tento (scale); l1 = (SDDAS_LONG *) tbl; stop_f1 = tbl + num_values; for (f1 = tbl; f1 < stop_f1; ++f1, ++l1) *f1 = *l1 * power; } /**********************************************************************/ /* Once original table values have been retrieved, override the */ /* polynomial with the new slope/intercept values. The routine to */ /* override the coefficients has already checked to make sure the */ /* table is defined as a first order polynomial for all sensors. */ /**********************************************************************/ if (tbl_info_ptr->tbl_var == FN_SC_POTENTIAL && ex->override_potential_poly == sTrue) { f1 = tbl; *f1++ = ex->potential_intercept; *f1 = ex->potential_slope; } } } return (ALL_OKAY); } /******************************************************************************* * * * IR_GET_NEW_RVAL SUBROUTINE * * * * DESCRIPTION * * This routine returns an error code unique to the module IR_GET_NEW_TBL() * * 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_get_new_rval (ret_val) * * * * NECESSARY SUBPROGRAMS * * None * * * * EXTERNAL VARIABLES * * None * * * * INTERNAL VARIABLES * * None * * * * SUBSYSTEM * * Display Level * * * ******************************************************************************/ SDDAS_SHORT ir_get_new_rval (int ret_val) { switch (ret_val) { case IDF_MANY_BYTES: return (NEW_IDF_MANY_BYTES); case IDF_TBL_NUM: return (NEW_IDF_TBL_NUM); case IDF_CON_NUM: return (NEW_IDF_CON_NUM); case IDF_NO_ENTRY: return (NEW_IDF_NO_ENTRY); case VIDF_ELEMENT_NOT_FOUND: return (NEW_IDF_ELE_NOT_FOUND); default: return ((SDDAS_SHORT) ret_val); } }