/* * 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 "@(#) new_data.c 1.22 05/08/19 SwRI" #include #include #include "ret_codes.h" #include "gen_defs.h" #include "libbase_idfs.h" #include "libVIDF.h" /* for header format comparison */ /******************************************************************************* * * * IR_NEW_DATA_RECORD SUBROUTINE * * * * DESCRIPTION * * This routine is called by the read_drec and read_tensor_data routines * * whenever a new data record needs to be read. If upon record retrieval, an * * EOF code is encountered or if a partial record is read, an internal flag * * is set so that the next time read_drec / read_tensor_data is called, * * another attempt is made to read from the data file. This additional * * attempt is made only for real-time processing. For playback, a partial * * read is a fatal error. * * * * INPUT VARIABLES * * SDDAS_CHAR found_sensor flag which tells if the requested sensor is * * amongst the sensors returned and is associated* * with the time period being processed * * * * USAGE * * x = ir_new_data_record (found_sensor) * * * * NECESSARY SUBPROGRAMS * * lseek() moves the file pointer to a location within * * the file * * read() reads N bytes from the file associated with * * the file descriptor given * * ir_network_order() converts data read from data/header files * * between network byte order and host byte order* * * * EXTERNAL VARIABLES * * struct general_info structure that holds information concerning * * ginfo the experiment that is being processed * * SDDAS_CHAR ir_swap_data flag that is used to determine when the data * * matrix is to be converted to host byte order * * * * INTERNAL VARIABLES * * struct experiment_info a pointer to the structure that holds * * *ex 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 * * int num_bytes the number of bytes requested from the file * * int ret_bytes the number of bytes actually read by READ() * * SDDAS_LONG hdr_offset indicates which header record to access * * * * SUBSYSTEM * * Display Level * * * ******************************************************************************/ SDDAS_SHORT ir_new_data_record (SDDAS_CHAR found_sensor) { extern struct general_info ginfo; extern SDDAS_CHAR ir_swap_data; struct experiment_info *ex; struct ptr_rec *ptr; int num_bytes, ret_bytes; SDDAS_LONG hdr_offset; /***********************************************************************/ /* 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; /*************************************************************************/ /* Read the next data record in the data file. */ /*************************************************************************/ num_bytes = ptr->d_size; ret_bytes = read (ex->fdd, ex->DATA_MEM, num_bytes); ir_swap_data = 1; ir_network_order (0, 1); if (ret_bytes != num_bytes) { /**********************************************************************/ /* An error was encountered when trying to read from the file. */ /**********************************************************************/ if (ret_bytes < 0) { if (ex->header_format == ORIGINAL_HEADER) return (DREC_READ_ERROR); else return (TENSOR_READ_ERROR); } /**********************************************************************/ /* An EOF was encountered and the sensor being returned is not the */ /* sensor requested (sensor requested does not appear in the current */ /* time frame being processed). If a non-real time file is being */ /* processed, an error was encountered. */ /**********************************************************************/ else if (ret_bytes == 0 && !found_sensor) { ex->drec_eof = 1; if (ex->requested_time.btime_sec >= 0) { if (ex->header_format == ORIGINAL_HEADER) return (DREC_READ_ERROR); else return (TENSOR_READ_ERROR); } else { if (ex->header_format == ORIGINAL_HEADER) return (DREC_EOF_NO_SENSOR); else return (TENSOR_EOF_NO_SENSOR); } } /**********************************************************************/ /* An EOF was encountered for the sensor being requested. If a */ /* non-real time file is being processed, an error was encountered. */ /**********************************************************************/ else if (ret_bytes == 0 && found_sensor) { ex->drec_eof = 2; if (ex->requested_time.btime_sec >= 0) { if (ex->header_format == ORIGINAL_HEADER) return (DREC_READ_ERROR); else return (TENSOR_READ_ERROR); } else { if (ex->header_format == ORIGINAL_HEADER) return (DREC_EOF_SENSOR); else return (TENSOR_EOF_SENSOR); } } /********************************************************************/ /* Either we read before the listener could finish writing, or the */ /* listener never received the file closure packet and wrote down */ /* 20 bytes of -1 or -2 values. */ /********************************************************************/ else { /*******************************************************************/ /* We read before the listener could finish writing so back up */ /* the partial no. of bytes read for future read attempts. */ /*******************************************************************/ hdr_offset = *(ptr->HDR_OFF + 0); ex->drec_eof = (!found_sensor) ? 1 : 2; lseek (ex->fdd, (off_t) (-1 * ret_bytes), 1); /********************************************************************/ /* Check for LOS and/or next file signals. The file closure flags */ /* are always in the first hdr_offset field. */ /********************************************************************/ if (hdr_offset == NO_MORE_DATA) return (LOS_STATUS); else if (hdr_offset == NEXT_FILE) return (NEXT_FILE_STATUS); else if (ex->requested_time.btime_sec >= 0) return (PARTIAL_READ); else if (found_sensor) { if (ex->header_format == ORIGINAL_HEADER) return (DREC_EOF_SENSOR); else return (TENSOR_EOF_SENSOR); } else { if (ex->header_format == ORIGINAL_HEADER) return (DREC_EOF_NO_SENSOR); else return (TENSOR_EOF_NO_SENSOR); } } } ex->drec_eof = 0; return (ALL_OKAY); }