/* * 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 "@(#) read_hdr_fmt_two.c 1.1 05/08/19 SwRI" #include #include "gen_defs.h" #include "ret_codes.h" #include "libbase_idfs.h" /***************************************************************************** * * * IR_READ_HEADER_FORMAT_TWO SUBROUTINE * * * * DESCRIPTION * * This routine is called anytime a new header record needs to be read * * and the header format specifies header record definition number 2, which * * is a single-value tensor data definition. The contents of the header * * record has been read into memory and now the pointers that need to be * * redefined based on the values read from the header are processed. * * * * INPUT VARIABLES * * SDDAS_CHAR larger_header flag that indicates if a larger header * * was read * * void *tensor_data_ptr ptr to memory location for structure that * * holds returned tensor data values * * * * USAGE * * x = ir_read_header_format_two (larger_header, tensor_data_ptr) * * * * NECESSARY SUBPROGRAMS * * sizeof () the size of the specified object in bytes * * malloc() allocates memory * * ir_assign_pointers() assigns the pointers for the header, data,* * and calibration data elements * * ir_fix_pointers () assigns the pointers for those elements * * whose size may vary from header to header * * ir_network_order() converts data read from data/header files * * between network byte order and host byte * * order * * * * EXTERNAL VARIABLES * * struct general_info ginfo structure that holds information concern- * * ing the experiment that is being processed* * * * INTERNAL VARIABLES * * struct experiment_info *ex a pointer to the structure that holds * * specific experiment information * * struct ptr_rec *ptr a pointer to the structure which holds * * all pointers to the header and data for * * the experiment of interest * * SDDAS_SHORT 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 ir_read_header_format_two (SDDAS_CHAR larger_header, void *tensor_data_ptr) { extern struct general_info ginfo; struct experiment_info *ex; struct ptr_rec *ptr; SDDAS_SHORT rval; size_t bytes; void *tmp_ptr; /***************************************************************************/ /* Set a pointer to the structure which holds all pointers for header and */ /* data information for the experiment currently being processed. */ /***************************************************************************/ ex = ginfo.expt; ptr = ex->info_ptr; /*************************************************************************/ /* Allocate the structure which holds header record information defined */ /* only for the tensor data definition (header_format = 2). */ /*************************************************************************/ if (larger_header) { bytes = sizeof (struct tensor_info); if ((tmp_ptr = malloc (bytes)) == NO_MEMORY) return (HDR_FMT_TWO_MALLOC); ptr->base_tensor_info = tmp_ptr; ptr->hdr_fmt2_ptr = (struct tensor_info *) ptr->base_tensor_info; /*************************************************************************/ /* Since a full tensor is ALWAYS written (no partials), TENSOR_ELEMENTS */ /* never changes. Have to wait until a header is read since info. kept */ /* in this structure. */ /*************************************************************************/ ptr->hdr_fmt2_ptr->TENSOR_ELEMENTS = ex->tensor_elements; /***************************************************************************/ /* Some of the original header record format information is not pertinent */ /* to tensor data processing. */ /***************************************************************************/ ptr->base_idfs_info = NO_MEMORY; ptr->hdr_fmt1_ptr = NO_MEMORY; } /***********************************************************************/ /* Assign/adjust the pointers to the header, data, and cal. elements. */ /***********************************************************************/ if (larger_header) { rval = ir_assign_pointers (1, 0, tensor_data_ptr); if (rval != ALL_OKAY) return (rval); } else { rval = ir_fix_pointers (tensor_data_ptr); if (rval != ALL_OKAY) return (rval); } ir_network_order (1, 0); /**************************************************************************/ /* Make sure header defines the same number of data quality values as */ /* the tensor data IF a tensor of data quality flags is being returned. */ /**************************************************************************/ if (*ptr->hdr_fmt2_ptr->DQUAL_SIZE != 1) { if (*ptr->hdr_fmt2_ptr->DQUAL_SIZE != ptr->hdr_fmt2_ptr->TENSOR_ELEMENTS) return (HDR_FMT_TWO_DQUAL); } return (ALL_OKAY); }