/* * 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 "@(#) $Id: override_pot.c 20891 2010-09-16 18:50:19Z carrie $ SwRI" #include #include "ret_codes.h" #include "gen_defs.h" #include "libbase_idfs.h" #include "libVIDF.h" /******************************************************************************* * * * OVERRIDE_POTENTIAL_POLYNOMIAL SUBROUTINE * * * * DESCRIPTION * * This routine is called to override the slope and intercept values defined* * for the first order polynomial that is used to modify spacecraft potential * * data that is used by the data set being processed. The routine FILE_OPEN * * must be called for the data set being processed BEFORE this module can be * * called. If this routine is called multiple times for the same data set, * * the last call will be the one to be saved and used. * * * * 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_FLOAT slope new slope to use with the potential value * * SDDAS_FLOAT intercept new intercept to use with potential value * * * * USAGE * * x = override_potential_polynomial (data_key, exten, vnum, slope, * * intercept) * * * * NECESSARY SUBPROGRAMS * * ir_locate_ex() determines if the requested combination has * * already been processed and points to the * * correct structure allocated for the combo * * ReadVIDF() reads information from the VIDF file * * sizeof () the size of the specified object in bytes * * malloc() allocates memory * * free() frees allocated memory * * * * 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 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_SHORT ret_val the value returned by the called routine * * SDDAS_CHAR num_pot_tbls no. of tables associated with potential * * SDDAS_CHAR last_pot_tbl the last potential-specific table defined * * SDDAS_CHAR *tbl_fmt_values TBL_FMT values for all sensors for the * * table defined to modify the potential * * int rval the value returned by the called routine * * size_t bytes the number of bytes to allocate * * void *tmp_ptr pointer which holds address passed back by * * the call to the MALLOC routine * * * * SUBSYSTEM * * Display Level * * * ******************************************************************************/ SDDAS_SHORT override_potential_polynomial (SDDAS_ULONG data_key, SDDAS_CHAR *exten, SDDAS_USHORT vnum, SDDAS_FLOAT slope, SDDAS_FLOAT intercept) { extern struct general_info ginfo; struct experiment_info *ex; struct inst_tbl_info *tbl_info_ptr; register SDDAS_SHORT i; SDDAS_SHORT ret_val; SDDAS_CHAR num_pot_tbls, last_pot_tbl, *tbl_fmt_values; /* Leave variables as is, no typedefs. */ int rval; size_t bytes; void *tmp_ptr; /***********************************************************************/ /* Set a pointer to the structure which holds all information that is */ /* pertinent to the experiment currently being processed. Since */ /* ir_locate_ex() is called by more than one routine, return an error */ /* code that indicates which calling routine resulted in the error. */ /* Since we pass a 0 for the last parameter, the only possible error */ /* is that the requested combo was not found among processed combos. */ /***********************************************************************/ if (!ginfo.called_locate) { ret_val = ir_locate_ex (data_key, exten, vnum, 0); if (ret_val != ALL_OKAY) return (OVERRIDE_NOT_FOUND); } /***********************************************************************/ /* If spacecraft potential is not defined for the source in question, */ /* return an error code indicating this situation. */ /***********************************************************************/ ex = ginfo.expt; if (!ex->potential_def) return (OVERRIDE_NO_POT); /***********************************************************************/ /* Loop over all the tables, looking for the table that holds the */ /* polynomial coeficients that modify the spacecraft potential data. */ /***********************************************************************/ num_pot_tbls = 0; last_pot_tbl = -1; for (i = 0; i < ex->num_tbls; ++i) { tbl_info_ptr = ex->tbl_info_ptr + i; if (tbl_info_ptr->tbl_type == ASCII_TBL) continue; if (tbl_info_ptr->tbl_var == FN_SC_POTENTIAL) { ++num_pot_tbls; last_pot_tbl = (SDDAS_CHAR) i; } } if (num_pot_tbls == 0) return (OVERRIDE_NO_POT_TBLS); if (num_pot_tbls > 1) return (OVERRIDE_TOO_MANY_POT_TBLS); /**************************************************************************/ /* Make sure there are 2 polynomial coefficients defined for all sensors.*/ /* Use the requested time, saved by call to file_open(). */ /**************************************************************************/ bytes = ex->num_sensor * sizeof (SDDAS_CHAR); if ((tmp_ptr = malloc (bytes)) == NO_MEMORY) return (OVERRIDE_TBL_FMT_MALLOC); tbl_fmt_values = (SDDAS_CHAR *) tmp_ptr; rval = ReadVIDF (data_key, ex->requested_time.btime_year, ex->requested_time.btime_day, ex->requested_time.btime_sec, ex->requested_time.btime_nsec, ex->requested_time.etime_year, ex->requested_time.etime_day, ex->requested_time.etime_sec, ex->requested_time.etime_nsec, tbl_fmt_values, _TBL_FMT, last_pot_tbl, 0, -1); if (rval < 0) return ((SDDAS_SHORT) rval); for (i = 0; i < ex->num_sensor; ++i) { /***********************************************************/ /* Table not defined for this sensor? */ /***********************************************************/ if (*(tbl_fmt_values + i) == -1) continue; if (*(tbl_fmt_values + i) != 2) { free (tmp_ptr); return (OVERRIDE_BAD_TBL_FMT_VALUE); } } free (tmp_ptr); /***********************************************************************/ /* Set the appropriate flag and new coefficient values. */ /***********************************************************************/ ex->override_potential_poly = sTrue; ex->potential_slope = slope; ex->potential_intercept = intercept; return (ALL_OKAY); }