/* * 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 "@(#) mode_ind.c 1.11 05/08/19 SwRI" #include "ret_codes.h" #include "gen_defs.h" #include "user_defs.h" #include "libtrec_idfs.h" /******************************************************************************* * * * MODE_UNITS_INDEX SUBROUTINE * * * * DESCRIPTION * * This routine is called in order to help the user index into the data * * returned by the FILL_MODE_DATA and SWEEP_MODE_DATA routine correctly. * * With FILL_MODE_DATA, for each mode, there are 5 (NUM_BUFFERS) working * * buffers, with N many sub-buffers, where N reflects the number of data * * levels being returned for each mode values (no. of unique table * * application/table oper/min & max combinations). With SWEEP_MODE_DATA, for * * each mode, there N many sub-buffers, where N reflects the number of data * * levels being returned for each mode values (no. of unique table * * application/table oper/min & max combinations). In both cases, the value * * for N may vary from mode to mode. This module will return the index to * * get to the correct sub-buffer for the mode and data level requested and * * will also return the number of sub-buffers defined for the mode in order * * to help the user get to the start of any BUFFER (0-4) for FILL_MODE_DATA. * * * * INPUT VARIABLES * * SDDAS_ULONG data_key key which uniquely identifies the data set * * being processed * * SDDAS_CHAR *exten 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 mode_val the mode being processed * * SDDAS_FLOAT min the lower cutoff data value * * SDDAS_FLOAT max the upper cutoff data value * * SDDAS_CHAR num_tbls the number of tables defined * * SDDAS_CHAR *tbls_to_apply array of tables to be applied * * SDDAS_LONG *tbl_oper array of operations to be applied to tables * * SDDAS_SHORT *units_ind index value returned to access the correct * * sub-buffer for the data level requested * * SDDAS_SHORT *num_units number of units or data levels sub-buffers * * defined for the mode in question * * * * USAGE * * x = mode_units_index (data_key, exten, vnum, mode_val, min, max, * * num_tbls, tbls_to_apply, tbl_oper, &units_ind, &num_units) * * * * NECESSARY SUBPROGRAMS * * ir_locate_ex() determines if the requested combination has * * already been processed and points to the * * correct structure allocated for the combo * * * * EXTERNAL VARIABLES * * struct general_info ginfo structure that holds information concern- * * ing the experiment that is being processed * * * * INTERNAL VARIABLES * * struct experiment_info a pointer to the structure that holds * * *ex specific experiment information * * struct fill_sensor *minfo pointer to the structure being processed for* * the mode in question * * struct in_fill *mptr pointer to the data level combination being * * processed * * register SDDAS_SHORT i, j looping varibles * * SDDAS_USHORT mode_vnum version number for mode data associated * * with this combination * * SDDAS_FLOAT tol tolerance factor * * SDDAS_FLOAT upper_cut upper tolerance threshold * * SDDAS_FLOAT lower_cut lower tolerance threshold * * SDDAS_SHORT ret_val the value returned by the called routine * * char found_mode flag indicating if information for the * * requested mode is available * * char match flag indicating if the requested data level * * was found for the mode in question * * * * SUBSYSTEM * * Display Level * * * ******************************************************************************/ SDDAS_SHORT mode_units_index (SDDAS_ULONG data_key, SDDAS_CHAR *exten, SDDAS_USHORT vnum, SDDAS_SHORT mode_val, SDDAS_FLOAT min, SDDAS_FLOAT max, SDDAS_CHAR num_tbls, SDDAS_CHAR *tbls_to_apply, SDDAS_LONG *tbl_oper, SDDAS_SHORT *units_ind, SDDAS_SHORT *num_units) { extern struct general_info ginfo; struct experiment_info *ex; struct fill_sensor *minfo; struct in_fill *mptr; register SDDAS_SHORT i, j; SDDAS_USHORT mode_vnum; SDDAS_FLOAT tol, upper_cut, lower_cut; SDDAS_SHORT ret_val; char found_mode, match; /***********************************************************************/ /* Retrieve the ex structure requested by the user and then point to */ /* the ex structure which holds mode-relevant information. */ /***********************************************************************/ ret_val = ir_locate_ex (data_key, exten, vnum, 0); if (ret_val != ALL_OKAY) return (MODE_UNITS_IND_NOT_FOUND); /***************************************************************************/ /* User did not call file_open requesting mode data? */ /***************************************************************************/ ex = ginfo.expt; if (ex->mode_version == ex->version) return (MODE_UNITS_FILE_OPEN); mode_vnum = ex->mode_version; ret_val = ir_locate_ex (data_key, exten, mode_vnum, 0); if (ret_val != ALL_OKAY) return (MODE_UNITS_INFO_DUP); /***************************************************************************/ /* Loop over all structures, looking for the mode in question. */ /***************************************************************************/ ex = ginfo.expt; for (i = 0, found_mode = 0; i < ex->num_mode_info; ++i) { minfo = ex->mode_info_ptr + i; if (minfo->sensor_num == mode_val) { found_mode = 1; break; } } /***************************************************************************/ /* The mode requested was not found amongst the modes that have been */ /* processed up to date. */ /***************************************************************************/ if (!found_mode) return (MODE_UNITS_NO_MODE); else { /************************************************************************/ /* Loop over all the data levels defined (unique table application / */ /* table operation / min / max combinations). */ /************************************************************************/ for (i = 0, match = 0; i < minfo->num_units; ++i) { mptr = minfo->min_max_app + i; /*********************************************************************/ /* If the number of tables don't match, obviously different units. */ /*********************************************************************/ if (mptr->num_tbls != num_tbls) continue; /*********************************************************************/ /* If the lower & upper cutoff values do not match, check the next */ /* combo. The user can select the same units but with different */ /* upper and lower cutoff values. A tolerance is used due to */ /* floating point comparisons. */ /*********************************************************************/ tol = mptr->sen_min * 0.00001; lower_cut = (mptr->sen_min < 0.0) ? mptr->sen_min + tol : mptr->sen_min - tol; upper_cut = (mptr->sen_min < 0.0) ? mptr->sen_min - tol : mptr->sen_min + tol; if (!(min >= lower_cut && min <= upper_cut)) continue; tol = mptr->sen_max * 0.00001; lower_cut = (mptr->sen_max < 0.0) ? mptr->sen_max + tol : mptr->sen_max - tol; upper_cut = (mptr->sen_max < 0.0) ? mptr->sen_max - tol : mptr->sen_max + tol; if (!(max >= lower_cut && max <= upper_cut)) continue; /*********************************************************************/ /* If there are no tables, no need to check table application / */ /* table operation values. */ /*********************************************************************/ if (num_tbls == 0 && mptr->tbl_info == NO_MEMORY) match = 1; /*********************************************************************/ /* Compare the table information. */ /*********************************************************************/ else for (j = 0; j < mptr->num_tbls; ++j) { /***************************************************************/ /* The table application values differ, no need to continue */ /* the comparison. */ /***************************************************************/ if (*(mptr->tbl_apply + j) != *(tbls_to_apply + j)) break; /***************************************************************/ /* The table operation values differ, no need to continue */ /* the comparison. */ /***************************************************************/ else if (*(mptr->tbl_oper + j) != *(tbl_oper + j)) break; if (j == mptr->num_tbls - 1) match = 1; } /***************************************************************/ /* The requested data level was found. */ /***************************************************************/ if (match) { *units_ind = i; *num_units = minfo->num_units; break; } } /***************************************************************/ /* The requested data level was not found. */ /***************************************************************/ if (!match) return (MODE_UNITS_NO_MATCH); } return (ALL_OKAY); }