/* * 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 "@(#) tbl_size.c 1.16 05/08/19 SwRI" #include #include "gen_defs.h" #include "libbase_idfs.h" /******************************************************************************* * * * IR_TBL_SIZE SUBROUTINE * * * * DESCRIPTION * * This routine is called in order to determine the total number of bytes * * that are needed to hold all integer table values for all tables for the * * sensor in question. No bytes are included for ascii tables since these * * tables are kept in a different structure from the integer table values. * * In the sizeof function, use float instead of long since, in the calling * * module, the malloced space is set to a floating point pointer. * * * * INPUT VARIABLES * * SDDAS_SHORT sensor_index index into the SPTR structure to point to * * the correct sensor combination structure * * SDDAS_UINT *bytes the number of bytes to allocate * * * * USAGE * * ir_tbl_size (sensor_index, &bytes) * * * * NECESSARY SUBPROGRAMS * * sizeof () the size of the specified object in bytes * * abs() returns the absolute value of a number * * * * EXTERNAL VARIABLES * * struct general_info ginfo structure that holds information concerning * * the experiment that is being processed * * * * INTERNAL VARIABLES * * struct experiment_info *ex a pointer to the structure that holds * * specific experiment information * * struct sensor_tables *sptr a pointer to the structure which holds the * * various information for the tables utilized * * by sensor-table combination being processed * * 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 expand_tlen the maximum number of elements that can be * * associated with a given data word length * * SDDAS_ULONG expand_clen the maximum number of elements that can be * * associated with a given cal. word length * * SDDAS_CHAR tdw_len the data word length in bits * * SDDAS_CHAR cal_len the word length in bits of the cal. data * * SDDAS_CHAR which_cal the calibration set being processed * * SDDAS_CHAR tbl_var the functional dependence of the table * * SDDAS_CHAR tbl_fmt table format * * size_t num_bytes_sfloat the number of bytes needed for a SDDAS_FLOAT* * * * SUBSYSTEM * * Display Level * * * ******************************************************************************/ void ir_tbl_size (SDDAS_SHORT sensor_index, SDDAS_UINT *bytes) { extern struct general_info ginfo; struct experiment_info *ex; struct sensor_tables *sptr; struct inst_tbl_info *tbl_info_ptr; register SDDAS_SHORT i; SDDAS_ULONG expand_tlen = 1, expand_clen = 1; SDDAS_CHAR tdw_len, cal_len, which_cal, tbl_var, tbl_fmt; size_t num_bytes_sfloat; /*************************************************************************/ /* Point to the correct sensor_tables structure. */ /*************************************************************************/ ex = ginfo.expt; sptr = ex->sen_tbl_ptr + sensor_index; num_bytes_sfloat = sizeof (SDDAS_FLOAT); /*********************************************************************/ /* The data word length is used to determine how many elements are */ /* in an expanded table.(ex. 8 bits means 256 possible values) */ /*********************************************************************/ tdw_len = sptr->max_tdw_len; while (tdw_len-- > 0) expand_tlen *= 2; /**********************************************************************/ /* Loop over all defined tables for this virtual instrument in order */ /* to determine how much space to allocate for INTEGER table values. */ /* Ascii strings are saved in a different structure. */ /**********************************************************************/ *bytes = 0; tbl_info_ptr = ex->tbl_info_ptr; for (i = 0; i < ex->num_tbls; ++i, ++tbl_info_ptr) { /********************************************************************/ /* Exclude mode-dependent tables. */ /********************************************************************/ tbl_var = tbl_info_ptr->tbl_var; if (tbl_var == FN_RAW_MODE || tbl_var == FN_PROCESSED_MODE) continue; /********************************************************************/ /* Integer information is processed, not ASCII information. We can*/ /* directly use index i even though only sptr->num_tbls is used to */ /* allocate space since we added the restiction that all ASCII/MODE*/ /* tables be defined AFTER all other tables. */ /********************************************************************/ if (tbl_info_ptr->tbl_type != ASCII_TBL) { /*********************************************************************/ /* The table is an expanded look up table (no coefficients). */ /*********************************************************************/ tbl_fmt = *(sptr->tbl_fmt + i); if (tbl_fmt == 0) { /****************************************************************/ /* The table is a function of raw sensor data. */ /****************************************************************/ if (tbl_var == FN_RAW_SENSOR) { *(sptr->tbl_size + i) = expand_tlen; *bytes += num_bytes_sfloat * expand_tlen; } /*****************************************************************/ /* This table is a function of a calibration set. */ /*****************************************************************/ else if (tbl_var < 0) { /**************************************************************/ /* The word length for the cal. set is used to determine how */ /* many elements are in an expanded table. */ /**************************************************************/ which_cal = abs (tbl_var) - 1; cal_len = *(ex->cal_wlen + which_cal); expand_clen = 1; while (cal_len-- > 0) expand_clen *= 2; if (tbl_info_ptr->tbl_type == INTEGER_TBL) { *(sptr->tbl_size + i) = expand_clen; *bytes += num_bytes_sfloat * expand_clen; } else { *(sptr->tbl_size + i) = expand_clen * ex->swp_len; *bytes += num_bytes_sfloat * expand_clen * ex->swp_len; } } /****************************************************************/ /* The table is a function of raw sweep step data. */ /****************************************************************/ else if (tbl_var == FN_RAW_SCAN) { *(sptr->tbl_size + i) = ex->swp_len; *bytes += num_bytes_sfloat * ex->swp_len; } /******************************************************************/ /* The table is a function of spacecraft potential or back- */ /* ground data. The most items returned would be swp_len values.*/ /******************************************************************/ else if (tbl_var == FN_SC_POTENTIAL || tbl_var == FN_BACKGROUND) { *(sptr->tbl_size + i) = ex->swp_len; *bytes += num_bytes_sfloat * ex->swp_len; } } /********************************************************************/ /* The table holds coefficients (table is not in expanded form). */ /********************************************************************/ else if (tbl_fmt > 0) { /****************************************************************/ /* The table is a function of raw sensor data. */ /****************************************************************/ if (tbl_var == FN_RAW_SENSOR) { /*************************************************************/ /* The table is to be expanded using the coefficients. */ /*************************************************************/ if (*(sptr->tbl_expand + i) == 1) { *(sptr->tbl_size + i) = expand_tlen; *bytes += num_bytes_sfloat * expand_tlen; } /****************************************************************/ /* The table is NOT to be expanded; therefore, the number of */ /* bytes needed is based upon the number of coefficients. The */ /* TBL_EXPAND flag is hard-set to 0 for tbl_type 2 */ /* (INTEGER_SCAN_TBL) tables. */ /****************************************************************/ else { if (tbl_info_ptr->tbl_type == INTEGER_TBL) { *(sptr->tbl_size + i) = tbl_fmt; *bytes += num_bytes_sfloat * tbl_fmt; } else { *(sptr->tbl_size + i) = tbl_fmt * ex->swp_len; *bytes += num_bytes_sfloat * tbl_fmt * ex->swp_len; } } } /*****************************************************************/ /* This table is a function of a calibration set. */ /*****************************************************************/ else if (tbl_var < 0) { /**************************************************************/ /* The table is to be expanded using the coefficients. */ /**************************************************************/ if (*(sptr->tbl_expand + i) == 1) { /**********************************************************/ /* The word length for the cal. set is used to determine */ /* how many elements are in an expanded table. */ /**********************************************************/ which_cal = abs (tbl_var) - 1; cal_len = *(ex->cal_wlen + which_cal); expand_clen = 1; while (cal_len-- > 0) expand_clen *= 2; *(sptr->tbl_size + i) = expand_clen; *bytes += num_bytes_sfloat * expand_clen; } /****************************************************************/ /* The table is NOT to be expanded; therefore, the number of */ /* bytes needed is based upon the number of coefficients. The */ /* TBL_EXPAND flag is hard-set to 0 for tbl_type 2 */ /* (INTEGER_SCAN_TBL) tables. */ /****************************************************************/ else { if (tbl_info_ptr->tbl_type == INTEGER_TBL) { *(sptr->tbl_size + i) = tbl_fmt; *bytes += num_bytes_sfloat * tbl_fmt; } else { *(sptr->tbl_size + i) = tbl_fmt * ex->swp_len; *bytes += num_bytes_sfloat * tbl_fmt * ex->swp_len; } } } /*****************************************************************/ /* The table is a function of raw sweep step data. */ /*****************************************************************/ else if (tbl_var == FN_RAW_SCAN) { /***************************************************************/ /* The table is to be expanded using the coefficients. */ /***************************************************************/ if (*(sptr->tbl_expand + i) == 1) { *(sptr->tbl_size + i) = ex->swp_len; *bytes += num_bytes_sfloat * ex->swp_len; } /*****************************************************************/ /* The table is NOT to be expanded; therefore, the number of */ /* bytes needed is based upon the number of coefficients. The */ /* TBL_EXPAND flag is hard-coded to 0 for tbl_type 2 */ /* (INTEGER_SCAN_TBL) tables. */ /*****************************************************************/ else { if (tbl_info_ptr->tbl_type == INTEGER_TBL) { *(sptr->tbl_size + i) = tbl_fmt; *bytes += num_bytes_sfloat * tbl_fmt; } else { *(sptr->tbl_size + i) = tbl_fmt * ex->swp_len; *bytes += num_bytes_sfloat * tbl_fmt * ex->swp_len; } } } /****************************************************************/ /* The table is a function of a processed data and the no. of */ /* bytes needed is based upon the no. of coefficients. */ /****************************************************************/ else { if (tbl_info_ptr->tbl_type == INTEGER_TBL) { *(sptr->tbl_size + i) = tbl_fmt; *bytes += num_bytes_sfloat * tbl_fmt; } else { *(sptr->tbl_size + i) = tbl_fmt * ex->swp_len; *bytes += num_bytes_sfloat * tbl_fmt * ex->swp_len; } } } /****************************************************************/ /* There is no table defined. Tbl_size will be zero. */ /****************************************************************/ else { *(sptr->tbl_size + i) = 0; *(sptr->tbl_ptr + i) = NO_MEMORY; *bytes += 0; } } /************************************************************************/ /* The table is an ASCII table. No bytes are added since only integer */ /* table sizes are being determined. */ /************************************************************************/ else *bytes += 0; } }