/* * 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 "@(#) chk_crit_stat.c 1.17 05/08/19 SwRI" #include "ret_codes.h" #include "libbase_idfs.h" /******************************************************************************* * * * IR_CHECK_CRITICAL_STATUS SUBROUTINE * * * * DESCRIPTION * * This routine is called whenever a header change has occurred to check * * the critical status bytes for each utilized sensor to see if a change in * * status has occurred. If there are no critical bytes to check, the routine * * simply returns; otherwise, the array of status flags are checked to see * * which of the utilized sensors has a critical status flag. A value of -1 * * indicates that the sensor does not utilize critical status flags. Any * * other value corresponds to the status byte of interest. If the contents * * of that byte changed from the previous header, take the appropriate * * action, if any. * * * * INPUT VARIABLES * * SDDAS_SHORT btime_yr start time requested (year component) * * SDDAS_SHORT btime_day start time requested (day component) * * SDDAS_LONG btime_sec start time requested (seconds component) * * SDDAS_LONG btime_nsec start time requested (nanoseconds) * * SDDAS_SHORT etime_yr stop time requested (year component) * * SDDAS_SHORT etime_day stop time requested (day component) * * SDDAS_LONG etime_sec stop time requested (seconds component) * * SDDAS_LONG etime_nsec stop time requested (nanoseconds) * * * * USAGE * * x = ir_check_critical_status (btime_yr, btime_day, btime_sec, btime_nsec,* * etime_yr, etime_day, etime_sec, etime_nsec)* * * * NECESSARY SUBPROGRAMS * * ir_get_new_tbl() reads the requested table for the sensor * * from the VIDF file * * * * 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 crit_action_info a pointer to the structure that holds info. * * *crit_act_ptr pertinent to table(s) that are flagged as * * critical action table(s) * * register SDDAS_SHORT i looping variable * * reg SDDAS_SHORT act_index index into the array of structures that hold* * critical action information * * SDDAS_FLOAT *tbl_address pointer to the table being processed * * SDDAS_LONG offset offset into the table of interest * * SDDAS_LONG next_tbl index used to get to the table of interest * * SDDAS_SHORT rval the value returned by the called routine * * SDDAS_SHORT sen looping variable * * SDDAS_UCHAR cvalue the MODE_INDEX value for the critical status* * byte for the sensor being processed * * char found_tbl indicates if the table requested was found * * char reset_called flag indicating if LOCATE_EX was called * * * * SUBSYSTEM * * Display Level * * * ******************************************************************************/ SDDAS_SHORT ir_check_critical_status (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; register struct sensor_tables *sptr; register struct crit_action_info *crit_act_ptr; register SDDAS_SHORT i, act_index; SDDAS_FLOAT *tbl_address; SDDAS_LONG offset, next_tbl; SDDAS_SHORT rval, sen; SDDAS_UCHAR cvalue; char found_tbl, reset_called; /**********************************************************************/ /* Check for the existence of a critical status array. */ /**********************************************************************/ ex = ginfo.expt; if (ex->crit_action == 0) return (ALL_OKAY); /**************************************************************************/ /* Determine the action, if any, that needs to be taken for each sensor. */ /**************************************************************************/ else { if (!ginfo.called_locate) { ginfo.called_locate = 1; reset_called = 1; } else reset_called = 0; for (sen = 0; sen < ex->num_sensor; ++sen) { /******************************************************************/ /* A value of -1 means that this sensor is not being utilized */ /* (was not a requested sensor), so go on to the next sensor. */ /******************************************************************/ if (*(ex->index_sen_tbl + sen) == -1) continue; /******************************************************************/ /* Loop over all tables that utilize critical action. */ /******************************************************************/ sptr = ex->sen_tbl_ptr + *(ex->index_sen_tbl + sen); for (act_index = 0; act_index < ex->crit_action; ++act_index) { /*****************************************************************/ /* If crit_status for this sensor is -1, no action is necessary.*/ /*****************************************************************/ crit_act_ptr = sptr->act_ptr + act_index; if (crit_act_ptr->crit_status == -1) continue; /******************************************************************/ /* Initially, crit_flag is set to -1 so that the first time */ /* a header is read, the correct action will be taken; otherwise,*/ /* it holds the contents of the critical status byte. This field*/ /* is now a SDDAS_SHORT to keep the -1 setting but to accomodate */ /* the fact that MODE_INDEX is now SDDAS_UCHAR. */ /******************************************************************/ cvalue = *(ex->info_ptr->MODE_INDEX + crit_act_ptr->crit_status); if (cvalue != crit_act_ptr->crit_flag) { /***************************************************************/ /* CRIT_ACTION holds offsets into the appropriate table for */ /* the current instrument mode and MODE_INDEX value is the */ /* index into the CRIT_ACTION array. */ /***************************************************************/ offset = *(crit_act_ptr->crit_action + cvalue); if (offset == crit_act_ptr->crit_offset) continue; crit_act_ptr->crit_offset = offset; crit_act_ptr->crit_flag = cvalue; /***************************************************************/ /* Loop over all tables. */ /***************************************************************/ found_tbl = 0; next_tbl = 0; for (i = 0; i < sptr->num_tbls; ++i) { /***********************************************************/ /* Retrieve new table values. The address of the table */ /* is calculated based upon table sizes because pointer */ /* to the table may be altered to the midpoint of table */ /* to handle signed binary input. */ /***********************************************************/ if (i == crit_act_ptr->crit_tbl) { if (*(sptr->tbl_fmt + i) >= 0) { tbl_address = sptr->tbls + next_tbl; rval = ir_get_new_tbl (sen, crit_act_ptr->crit_tbl, *(sptr->tbl_expand + i), *(sptr->tbl_fmt + i), tbl_address, *(sptr->tbl_size + i), offset, 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 = 0; return (rval); } } found_tbl = 1; break; } next_tbl += *(sptr->tbl_size + i); } /***************************************************************/ /* The table requested was not found - error condition. */ /***************************************************************/ if (!found_tbl) { if (reset_called) ginfo.called_locate = 0; return (CRIT_TBL_NOT_FOUND); } } } } if (reset_called) ginfo.called_locate = 0; } return (ALL_OKAY); }