/* * 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 "@(#) free_version.c 1.24 05/08/19 SwRI" #include #include #include "gen_defs.h" #include "libbase_idfs.h" #include "ret_codes.h" /******************************************************************************* * * * FREE_VERSION_INFO SUBROUTINE * * * * DESCRIPTION * * This routine is called to free all allocated memory associated with the * * experiment_info structure(s) which are associated with the specified * * version number. * * * * INPUT VARIABLES * * SDDAS_USHORT vnum version number to be associated with this * * combination (allows for multiple opens) * * * * USAGE * * free_version_info (vnum) * * * * NECESSARY SUBPROGRAMS * * ir_free_ex_structure() frees all allocated memory associated with * * the specified experiment_info structure * * ir_locate_ex() determines if the requested combination has * * already been processed and points to the * * correct structure allocated for the combo * * free () frees previously allocated memory * * strcpy() copies a string to another string variable * * * * EXTERNAL VARIABLES * * struct general_info structure that holds information concerning * * ginfo the experiment that is being processed * * * * INTERNAL VARIABLES * * reg struct experiment_info a pointer to the structure that holds * * *ex, *new_ex specific experiment information * * reg struct experiment_info *stop_ex loop termination variable * * reg SDDAS_SHORT loop_sen looping variable over sensor * * struct pitch_info a pointer to the structure that holds pitch * * *pa_ptr angle information * * struct spin_src_info a pointer to the structure that holds * * *spin_src_ptr start of spin data source information * * struct start_spin_info *sptr a pointer to the structure which holds all * * spin information for sensor being processed * * struct potential_info a pointer to the structure that holds space-* * *potential_ptr craft potential information * * struct euler_info a pointer to the structure that holds euler * * *pmi_ptr angle information * * struct celestial_info a pointer to the structure that holds * * *cp_ptr celestial position information * * struct background_info a pointer to the structure that holds back- * * *bkgd_ptr ground information * * SDDAS_ULONG data_key key which uniquely identifies the data set * * being processed * * SDDAS_USHORT mode_vnum version number for mode IDFS data * * SDDAS_SHORT rval holds returned value from module * * SDDAS_CHAR exten[] filename extension for the data to be used * * * * SUBSYSTEM * * Display Level * * * ******************************************************************************/ void free_version_info (SDDAS_USHORT vnum) { extern struct general_info ginfo; register struct experiment_info *ex, *stop_ex, *new_ex; register SDDAS_SHORT loop_sen; struct pitch_info *pa_ptr; struct spin_src_info *spin_src_ptr; struct start_spin_info *sptr; struct potential_info *potential_ptr; struct euler_info *pmi_ptr; struct celestial_info *cp_ptr; struct background_info *bkgd_ptr; SDDAS_ULONG data_key; SDDAS_USHORT mode_vnum; SDDAS_SHORT rval; SDDAS_CHAR exten[3]; /**************************************************************************/ /* Loop over all defined ex structures. */ /**************************************************************************/ stop_ex = ginfo.exbase + ginfo.nds; for (ex = ginfo.exbase; ex < stop_ex; ++ex) { /******************************************************************/ /* The data_key should never be zero unless this module has been */ /* called and the system was never re-initialized. */ /******************************************************************/ if (ex->version != vnum || ex->data_key == 0) continue; /******************************************************************/ /* Free mode data information, if applicable. Set version to */ /* match "parent source" so that the routine get_version_number */ /* will clear out and reset the mode ex structure. */ /******************************************************************/ data_key = ex->data_key; strcpy (exten, ex->exten); if (ex->version != ex->mode_version) { mode_vnum = ex->mode_version; rval = ir_locate_ex (data_key, exten, mode_vnum, 0); new_ex = ginfo.expt; ir_free_ex_structure (new_ex); new_ex->data_key = 0; new_ex->version = ex->version; } /******************************************************************/ /* Free pitch angle information IF routine ir_get_pitch_info() */ /* generated an ex structure (reflected by return value). Set */ /* the version to match "parent source" so that the routine */ /* get_version_number will clear out and reset mode ex structure.*/ /******************************************************************/ if (ex->pa_def && ex->bmem.base_pitch_info != NO_MEMORY) { pa_ptr = ex->pitch_angles; if (pa_ptr->pa_format == PA_COMPUTE) { rval = ir_locate_ex (pa_ptr->data_key, pa_ptr->exten, pa_ptr->version, 0); if (rval == ALL_OKAY) { new_ex = ginfo.expt; ir_free_ex_structure (new_ex); new_ex->data_key = 0; new_ex->version = ex->version; } } } /******************************************************************/ /* Free start of spin data source information. Set the version */ /* to match "parent source" so that routine get_version_number */ /* will clear out and reset mode ex structure. */ /******************************************************************/ if (ex->spin_src_def && ex->bmem.base_spin_src != NO_MEMORY) { spin_src_ptr = ex->spin_src; rval = ir_locate_ex (spin_src_ptr->data_key, spin_src_ptr->exten, spin_src_ptr->version, 0); if (rval == ALL_OKAY) { new_ex = ginfo.expt; ir_free_ex_structure (new_ex); new_ex->data_key = 0; new_ex->version = ex->version; } /***************************************************************/ /* Now, need to free start of spin structure allocated for */ /* each of the sensors (placed under "parent source"). */ /***************************************************************/ if (ex->bmem.base_start_spin_info != NO_MEMORY) { sptr = ex->start_sptr; for (loop_sen = 0; loop_sen < ex->num_sensor; ++loop_sen, ++sptr) if (*(ex->sensors_needed + loop_sen) != 0) free_version_info (sptr->spin_vnum); free (ex->bmem.base_start_spin_info); ex->bmem.base_start_spin_info = NO_MEMORY; ex->start_sptr = NO_MEMORY; } } /************************************************************************/ /* Free spacecraft potential data source information. Set the version */ /* to match "parent source" so that routine get_version_number will */ /* clear out and reset mode ex structure. */ /************************************************************************/ if (ex->potential_def && ex->bmem.base_potential_info != NO_MEMORY) { potential_ptr = ex->potential; if (potential_ptr->scpot_format == SCPOT_DSRC) { rval = ir_locate_ex (potential_ptr->data_key, potential_ptr->exten, potential_ptr->version, 0); if (rval == ALL_OKAY) { new_ex = ginfo.expt; ir_free_ex_structure (new_ex); new_ex->data_key = 0; new_ex->version = ex->version; } } } /******************************************************************/ /* Free euler angle information IF routine ir_get_euler_info() */ /* generated an ex structure (reflected by return value). Set */ /* the version to match "parent source" so that the routine */ /* get_version_number will clear out and reset mode ex structure.*/ /******************************************************************/ if (ex->euler_def && ex->bmem.base_euler_info != NO_MEMORY) { pmi_ptr = ex->euler_angles; if (pmi_ptr->pmi_format == EULER_DSRC) { rval = ir_locate_ex (pmi_ptr->data_key, pmi_ptr->exten, pmi_ptr->version, 0); if (rval == ALL_OKAY) { new_ex = ginfo.expt; ir_free_ex_structure (new_ex); new_ex->data_key = 0; new_ex->version = ex->version; } } } /******************************************************************/ /* Free celestial position information IF routine */ /* ir_get_celestial_info() generated an ex structure (reflected */ /* by return value). Set the version to match "parent source" */ /* so that the routine get_version_number will clear out and */ /* reset mode ex structure. */ /******************************************************************/ if (ex->celestial_def && ex->bmem.base_celestial_info != NO_MEMORY) { cp_ptr = ex->celestial_position; if (cp_ptr->cp_format == CELESTIAL_DSRC) { rval = ir_locate_ex (cp_ptr->data_key, cp_ptr->exten, cp_ptr->version, 0); if (rval == ALL_OKAY) { new_ex = ginfo.expt; ir_free_ex_structure (new_ex); new_ex->data_key = 0; new_ex->version = ex->version; } } } /************************************************************************/ /* Free background data source information. Set the version to match */ /* "parent source" so that routine get_version_number will clear out */ /* and reset mode ex structure. */ /************************************************************************/ if (ex->background_def && ex->bmem.base_background_info != NO_MEMORY) { bkgd_ptr = ex->background; if (bkgd_ptr->background_format == BKGD_DSRC) { rval = ir_locate_ex (bkgd_ptr->data_key, bkgd_ptr->exten, bkgd_ptr->version, 0); if (rval == ALL_OKAY) { new_ex = ginfo.expt; ir_free_ex_structure (new_ex); new_ex->data_key = 0; new_ex->version = ex->version; } } } ir_free_ex_structure (ex); /******************************************************************/ /* Set the data_key to zero to flag when the system has not been */ /* re-initialized. */ /******************************************************************/ ex->data_key = 0; } }