/* * 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_crit_info.c 1.27 05/08/19 SwRI" #include #include "ret_codes.h" #include "gen_defs.h" #include "libbase_idfs.h" #include "libVIDF.h" /******************************************************************************* * * * IR_GET_CRITICAL_INFO SUBROUTINE * * * * DESCRIPTION * * This routine is called to retrieve the number of the lookup table that * * is to be reloaded and the array of critical actions for each unique sensor * * combination that utilizes a critical status byte. * * * * INPUT VARIABLES * * SDDAS_SHORT cstat the critical status byte of interest * * SDDAS_SHORT sen_combo index into the array of sensor_table structures * * SDDAS_SHORT sen the sensor being processed * * SDDAS_CHAR crit_tbl the table flagged as the critical status table * * SDDAS_SHORT act_index index into the array of structures that hold * * critical action information * * 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_critical_info (cstat, sen_combo, sen, crit_tbl, act_index, * * 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 * * free () frees allocated memory * * ReadVIDF() reads information from the VIDF file * * malloc() allocates memory * * ir_get_crit_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 sensor_tables a pointer to the structure which holds the * * *sptr 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) * * size_t bytes the number of bytes to allocate * * SDDAS_ULONG data_key key which uniquely identifies the data set * * being processed * * SDDAS_SHORT offset offset into the CRIT_ACTION array * * SDDAS_SHORT num_states the number of states defined for the critical * * status byte * * SDDAS_CHAR t_crst the critical status byte for the table/sensor * * in question * * int ret_val holds the value returned by the 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_critical_info (SDDAS_SHORT cstat, SDDAS_SHORT sen_combo, SDDAS_SHORT sen, SDDAS_CHAR crit_tbl, SDDAS_SHORT act_index, 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 sensor_tables *sptr; struct crit_action_info *crit_act_ptr; SDDAS_ULONG data_key; SDDAS_SHORT offset, num_states; SDDAS_CHAR t_crst; /* Leave variables as is, no typedefs. */ int ret_val; size_t bytes; void *tmp_ptr; /***************************************************************************/ /* Point to the correct sensor_tables structure. */ /***************************************************************************/ ex = ginfo.expt; data_key = ex->data_key; sptr = ex->sen_tbl_ptr + sen_combo; crit_act_ptr = sptr->act_ptr + act_index; /*********************************************************************/ /* Determine the number of states associated with this status. */ /* */ /* Changed how this is done since now each status has its length */ /* defined and critical length field is no more so get the critical */ /* status byte for this table and sensor (which may exist somewhere */ /* already) then get its length */ /*********************************************************************/ ret_val = ReadVIDF (data_key, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec, (SDDAS_CHAR *) &t_crst, _CRIT_STATUS, crit_tbl, (SDDAS_LONG) sen, 1); ret_val = ReadVIDF (data_key, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec, (SDDAS_CHAR *) &num_states, _STATES, 0, (SDDAS_LONG) t_crst, 1); if (ret_val < 0) return (ir_get_crit_rval (ret_val)); /*******************************************************************/ /* Malloc the space to hold the actions for this critical status. */ /*******************************************************************/ if (crit_act_ptr->base_action != NO_MEMORY) { free (crit_act_ptr->base_action); crit_act_ptr->base_action = NO_MEMORY; } bytes = sizeof (SDDAS_LONG) * num_states; if ((tmp_ptr = malloc (bytes)) == NO_MEMORY) return (GET_ACTION_MALLOC); crit_act_ptr->base_action = tmp_ptr; crit_act_ptr->crit_action = (SDDAS_LONG *) crit_act_ptr->base_action; /*******************************************************************/ /* Retrieve the critical offset and critical action table values. */ /*******************************************************************/ ret_val = ReadVIDF (data_key, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec, (SDDAS_CHAR *) &offset, _CRIT_OFF, crit_tbl, (SDDAS_LONG) sen, 1); if (ret_val < 0) return (ir_get_crit_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 *) crit_act_ptr->crit_action, _CRIT_ACTION, crit_tbl, (SDDAS_LONG) offset, num_states); if (ret_val < 0) return (ir_get_crit_rval (ret_val)); return (ALL_OKAY); } /******************************************************************************* * * * IR_GET_CRIT_RVAL SUBROUTINE * * * * DESCRIPTION * * This routine returns an error code unique to the IR_GET_CRITICAL_INFO() * * module 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_crit_rval (ret_val) * * * * NECESSARY SUBPROGRAMS * * None * * * * EXTERNAL VARIABLES * * None * * * * INTERNAL VARIABLES * * None * * * * SUBSYSTEM * * Display Level * * * ******************************************************************************/ SDDAS_SHORT ir_get_crit_rval (int ret_val) { switch (ret_val) { case IDF_MANY_BYTES: return (CRIT_IDF_MANY_BYTES); case IDF_TBL_NUM: return (CRIT_IDF_TBL_NUM); case IDF_CON_NUM: return (CRIT_IDF_CON_NUM); case IDF_NO_ENTRY: return (CRIT_IDF_NO_ENTRY); case VIDF_ELEMENT_NOT_FOUND: return (CRIT_IDF_ELE_NOT_FOUND); default: return ((SDDAS_SHORT) ret_val); } }