/* * 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 "@(#) init_sen_ptr.c 1.18 05/08/19 SwRI" #include #include "ret_codes.h" #include "gen_defs.h" #include "libbase_idfs.h" /******************************************************************************* * * * IR_INIT_SENSOR_PTR SUBROUTINE * * * * DESCRIPTION * * This routine is called to initialize the array of sensor_tables * * structures which hold the information pertinent to the sensor combinations * * found. The table information, critical status byte, critical status * * operation, and array of critical actions are retrieved for each unique * * sensor combination found. * * * * INPUT VARIABLES * * SDDAS_SHORT num_combo the number of unique table combinations needed * * for all sensors for the virtual instrument being* * processed * * SDDAS_CHAR **crit_stat_ptrs array of ptrs to memory that holds the * * crit_status values * * SDDAS_CHAR first_time flag indicating the first time this module is * * called for the combination being processed * * SDDAS_CHAR crit_tbl the table flagged as the critical status table * * SDDAS_CHAR *chk_crit an array of flags which indicates if the * * crit_status values need to be checked in the * * combo comparison * * 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_init_sensor_ptr (num_combo, crit_stat_ptrs, first_time, crit_tbl, * * &chk_crit, btime_yr, btime_day, btime_sec, * * btime_nsec, etime_yr, etime_day, etime_sec, * * etime_nsec) * * * * NECESSARY SUBPROGRAMS * * ir_get_tbl_info () retrieves the various table(s) information for * * the sensor being processed * * ir_get_critical_info() retrieves the critical status operation and * * critical action array for applicable sensors * * sizeof () the size of the specified object in bytes * * malloc() allocates memory * * * * 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) * * reg SDDAS_SHORT i, sen looping variables * * reg SDDAS_SHORT tbl_num looping variable for table information * * reg SDDAS_SHORT act_index index into array of structures that hold * * critical action information * * size_t bytes the number of bytes to allocate * * SDDAS_SHORT ret_val holds the value returned by the called routine * * SDDAS_SHORT cstat the critical status byte of interest * * SDDAS_CHAR tdw_len the largest data word length (in bits) for all * * sensors that use the same table combo. info. * * SDDAS_CHAR *cur_crit pointer to the critical status values for the * * table flagged as the critical status table * * void *tmp_ptr pointer which holds address passed back by * * the call to the MALLOC routine * * * * SUBSYSTEM * * Display Level * * * ******************************************************************************/ SDDAS_SHORT ir_init_sensor_ptr (SDDAS_SHORT num_combo, SDDAS_CHAR **crit_stat_ptrs, SDDAS_CHAR first_time, SDDAS_CHAR crit_tbl, SDDAS_CHAR *chk_crit, 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; register SDDAS_SHORT i, sen, tbl_num, act_index; size_t bytes; SDDAS_SHORT ret_val, cstat; SDDAS_CHAR tdw_len, *cur_crit; void *tmp_ptr; /***************************************************************************/ /* Initialize the structure(s) which hold the unique combination offsets. */ /* Find the largest TDW_LEN for each combination being processed. */ /***************************************************************************/ ex = ginfo.expt; for (i = 0; i < num_combo; ++i) { sptr = ex->sen_tbl_ptr + i; sptr->max_tdw_len = 0; /************************************************************************/ /* Loop over all sensors for this virtual instrument. */ /************************************************************************/ for (sen = 0; sen < ex->num_sensor; ++sen) { if (*(ex->index_sen_tbl + sen) == i) { tdw_len = *(ex->sen_tdw_len + sen); if (tdw_len > sptr->max_tdw_len) sptr->max_tdw_len = tdw_len; } } } /************************************************************************/ /* Loop over each combination being processed. */ /************************************************************************/ for (i = 0; i < num_combo; ++i) { sptr = ex->sen_tbl_ptr + i; /*********************************************************************/ /* There are no critical status bytes defined for this virtual inst?*/ /*********************************************************************/ bytes = ex->crit_action * sizeof (struct crit_action_info); if (bytes == 0) { sptr->base_crit_action = NO_MEMORY; sptr->act_ptr = NO_MEMORY; } /********************************************************************/ /* Allocate structures that hold critical action info per table */ /* that UTILIZES critical action. Allocate each time called since */ /* memory may have been freed. */ /********************************************************************/ else { if ((tmp_ptr = malloc (bytes)) == NO_MEMORY) return (CRIT_ACT_MALLOC); sptr->base_crit_action = tmp_ptr; sptr->act_ptr = (struct crit_action_info *) sptr->base_crit_action; crit_act_ptr = sptr->act_ptr; for (tbl_num = 0; tbl_num < ex->num_tbls; ++tbl_num) { /* Critical action table? */ if (*(chk_crit + tbl_num) != 0) { crit_act_ptr->crit_tbl = tbl_num; if (first_time) { crit_act_ptr->base_action = NO_MEMORY; crit_act_ptr->crit_action = NO_MEMORY; } ++crit_act_ptr; } } } /************************************************************************/ /* Find the first sensor that utilizes this combination. */ /************************************************************************/ for (sen = 0; sen < ex->num_sensor; ++sen) { if (*(ex->index_sen_tbl + sen) == i) break; } /************************************************************************/ /* Get the various table(s) information for this sensor. */ /************************************************************************/ ret_val = ir_get_tbl_info (sen, i, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec); if (ret_val != ALL_OKAY) return (ret_val); /************************************************************************/ /* Get the critical status operation and actions if there are any */ /* critical status bytes defined. The crit_flag is set to -1 so that */ /* the first time a header record is read, the correct tables will be */ /* read, based on the mode of the instrument. */ /************************************************************************/ if (sptr->act_ptr != NO_MEMORY) { crit_act_ptr = sptr->act_ptr; act_index = 0; for (tbl_num = 0; tbl_num < ex->num_tbls; ++tbl_num) { /* Critical action table? */ if (*(chk_crit + tbl_num) != 0) { crit_act_ptr->crit_flag = -1; crit_act_ptr->crit_offset = -1; /**************************************************************/ /* Crit_tbl will be set by tables associated with sensors, */ /* not modes. */ /**************************************************************/ if (crit_tbl != -1) { cur_crit = *(crit_stat_ptrs + tbl_num); crit_act_ptr->crit_status = *(cur_crit + sen); cstat = *(cur_crit + sen); } else { crit_act_ptr->crit_status = -1; cstat = -1; } if (cstat != -1) { ret_val = ir_get_critical_info (cstat, i, sen, tbl_num, act_index, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec); if (ret_val != ALL_OKAY) return (ret_val); } /***************************************************************/ /* The critical status value for this sensor is -1, which */ /* means no action is necessary for this status byte. */ /***************************************************************/ else { crit_act_ptr->base_action = NO_MEMORY; crit_act_ptr->crit_action = NO_MEMORY; } ++crit_act_ptr; ++act_index; } } } } return (ALL_OKAY); }