/* * 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 "@(#) create_data.c 1.15 05/08/19 SwRI" #include #include "gen_defs.h" #include "ret_codes.h" #include "libbase_idfs.h" #include "vidf_tensor_defs.h" /******************************************************************************* * * * CREATE_IDF_DATA_STRUCTURE SUBROUTINE * * * * DESCRIPTION * * This routine is called to create or allocate a data structure that holds * * the idfs data once it is read from the files. The address of the newly * * allocated data structure is passed back to the calling module. An array * * of pointers is maintained so that when FREE_EXPERIMENT_INFO is called, the * * memory for all allocated data structures can be freed. There is no need * * to pass in the data key of interest; all items that depend upon sizes from * * the data set will be allocated/reallocated when new header records are * * read; thus the items end up being maxed out by the virtual instrument with * * the largest size for the item in question if the data structure is used by * * more than one data set. * * * * INPUT VARIABLES * * void **idf_data_ptr ptr to the memory location that holds the * * address of the structure that holds returned* * data values (read_drec) * * * * USAGE * * x = create_idf_data_structure (&idf_data_ptr) * * * * NECESSARY SUBPROGRAMS * * sizeof () the size of the specified object in bytes * * malloc() allocates memory * * realloc() reallocates previously allocated memory * * * * EXTERNAL VARIABLES * * struct general_info ginfo structure that holds information concerning * * the experiment that is being processed * * * * INTERNAL VARIABLES * * struct idf_data *EXP_DATA structure that holds all of the currently * * returned data values to be processed * * size_t bytes the number of bytes to allocate * * SDDAS_LONG index index into the array of pointers * * void *tmp_ptr pointer which holds address passed back by * * the call to the MALLOC routine * * * * SUBSYSTEM * * Display Level * * * ******************************************************************************/ SDDAS_SHORT create_idf_data_structure (void **idf_data_ptr) { extern struct general_info ginfo; struct idf_data *EXP_DATA; size_t bytes; SDDAS_LONG index; void *tmp_ptr; /**************************************************************************/ /* Allocate space to hold the addresses of all allocated data structures.*/ /* Start out with space for 25 structures. */ /**************************************************************************/ if (ginfo.idf_data_ptr == NO_MEMORY) { bytes = 25 * sizeof (void *); if ((tmp_ptr = malloc (bytes)) == NO_MEMORY) return (CREATE_DATA_ALL_MALLOC); ginfo.idf_data_ptr = (void **) tmp_ptr; } /**************************************************************************/ /* Reallocate space to hold the addresses of all allocated data */ /* structures. Keep adding 25 structures. */ /**************************************************************************/ else if ((ginfo.num_idf_data_ptr % 25) == 0) { bytes = (ginfo.num_idf_data_ptr + 25) * sizeof (void *); if ((tmp_ptr = realloc (ginfo.idf_data_ptr, bytes)) == NO_MEMORY) return (CREATE_DATA_ALL_REALLOC); ginfo.idf_data_ptr = (void **) tmp_ptr; } /*************************************************************************/ /* Allocate the data structure. */ /*************************************************************************/ bytes = sizeof (struct idf_data); index = ginfo.num_idf_data_ptr; if ((*(ginfo.idf_data_ptr + index) = malloc (bytes)) == NO_MEMORY) return (CREATE_DATA_MALLOC); *idf_data_ptr = *(ginfo.idf_data_ptr + index); ++ginfo.num_idf_data_ptr; /************************************************************************/ /* Initialize the data structure that is passed back to the user for */ /* usage with the generic read utility program. */ /************************************************************************/ EXP_DATA = (struct idf_data *) *(ginfo.idf_data_ptr + index); EXP_DATA->data_key = 0; EXP_DATA->header_format = ORIGINAL_HEADER; EXP_DATA->sensor = 0; EXP_DATA->byear = 0; EXP_DATA->bday = 0; EXP_DATA->bmilli = 0; EXP_DATA->bnano = 0; EXP_DATA->bsec = 0; EXP_DATA->bnsec = 0; EXP_DATA->eyear = 0; EXP_DATA->eday = 0; EXP_DATA->emilli = 0; EXP_DATA->enano = 0; EXP_DATA->esec = 0; EXP_DATA->ensec = 0; EXP_DATA->mode_byear = 0; EXP_DATA->mode_bday = 0; EXP_DATA->mode_bmilli = 0; EXP_DATA->mode_bnano = 0; EXP_DATA->mode_eyear = 0; EXP_DATA->mode_eday = 0; EXP_DATA->mode_emilli = 0; EXP_DATA->mode_enano = 0; EXP_DATA->data_accum_ms = 0; EXP_DATA->data_accum_ns = 0; EXP_DATA->data_lat_ms = 0; EXP_DATA->data_lat_ns = 0; EXP_DATA->swp_reset_ms = 0; EXP_DATA->swp_reset_ns = 0; EXP_DATA->sen_reset_ms = 0; EXP_DATA->sen_reset_ns = 0; EXP_DATA->num_swp_steps = 0; EXP_DATA->num_sample = 0; EXP_DATA->num_angle = 0; EXP_DATA->num_pitch = 0; EXP_DATA->num_potential = 0; EXP_DATA->num_background = 0; EXP_DATA->mode_len = 0; EXP_DATA->cal_len = 0; EXP_DATA->sun_sen = 0; EXP_DATA->spin_rate = 0; EXP_DATA->start_theta = 0.0; EXP_DATA->stop_theta = 0.0; EXP_DATA->cal_size = 0; EXP_DATA->data_size = 0; EXP_DATA->swp_size = 0; EXP_DATA->angle_size = 0; EXP_DATA->pitch_size = 0; EXP_DATA->potential_size = 0; EXP_DATA->background_size = 0; EXP_DATA->mode_size = 0; EXP_DATA->hdr_change = 0; EXP_DATA->d_qual = 0; /************************************************************************/ /* These elements are dependent upon information in the actual header */ /* file and are allocated as the information becomes available. */ /************************************************************************/ EXP_DATA->cal_data = NO_MEMORY; EXP_DATA->base_cal = NO_MEMORY; EXP_DATA->sen_data = NO_MEMORY; EXP_DATA->base_data = NO_MEMORY; EXP_DATA->swp_data = NO_MEMORY; EXP_DATA->base_swp = NO_MEMORY; EXP_DATA->start_az = NO_MEMORY; EXP_DATA->stop_az = NO_MEMORY; EXP_DATA->base_angle = NO_MEMORY; EXP_DATA->base_mode = NO_MEMORY; EXP_DATA->mode = NO_MEMORY; EXP_DATA->dir_cosines = NO_MEMORY; EXP_DATA->base_dir_cosines = NO_MEMORY; EXP_DATA->pitch_angles = NO_MEMORY; EXP_DATA->base_pitch = NO_MEMORY; EXP_DATA->potential = NO_MEMORY; EXP_DATA->base_potential = NO_MEMORY; EXP_DATA->background = NO_MEMORY; EXP_DATA->base_background = NO_MEMORY; EXP_DATA->base_cset = NO_MEMORY; EXP_DATA->cset_num = NO_MEMORY; EXP_DATA->idfs_transformation = NO_MEMORY; EXP_DATA->base_transform = NO_MEMORY; return (ALL_OKAY); }