1 /* 2 * Copyright (c) 2012-2014, The University of Oxford 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions are met: 7 * 1. Redistributions of source code must retain the above copyright notice, 8 * this list of conditions and the following disclaimer. 9 * 2. Redistributions in binary form must reproduce the above copyright notice, 10 * this list of conditions and the following disclaimer in the documentation 11 * and/or other materials provided with the distribution. 12 * 3. Neither the name of the University of Oxford nor the names of its 13 * contributors may be used to endorse or promote products derived from this 14 * software without specific prior written permission. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 26 * POSSIBILITY OF SUCH DAMAGE. 27 */ 28 29 #ifndef OSKAR_BINARY_READ_MEM_H_ 30 #define OSKAR_BINARY_READ_MEM_H_ 31 32 /** 33 * @file oskar_binary_read_mem.h 34 */ 35 36 #include <oskar_global.h> 37 #include <binary/oskar_binary.h> 38 #include <mem/oskar_mem.h> 39 40 #ifdef __cplusplus 41 extern "C" { 42 #endif 43 44 /** 45 * @brief 46 * Loads an OSKAR memory block from an OSKAR binary file. 47 * 48 * @details 49 * This function loads the contents of an OSKAR memory block from a binary file. 50 * 51 * @param[in] mem Pointer to data structure. 52 * @param[in,out] stream An input stream. 53 * @param[in,out] index Pointer to an index structure pointer. 54 * @param[in] data_type Type of the memory (as in oskar_Mem). 55 * @param[in] id_group Tag group identifier. 56 * @param[in] id_tag Tag identifier. 57 * @param[in] user_index User-defined index. 58 * @param[in,out] status Status return code. 59 */ 60 OSKAR_EXPORT 61 void oskar_binary_read_mem(oskar_Binary* handle, oskar_Mem* mem, 62 unsigned char id_group, unsigned char id_tag, int user_index, 63 int* status); 64 65 /** 66 * @brief 67 * Loads an OSKAR memory block from an OSKAR binary file. 68 * 69 * @details 70 * This function loads the contents of an OSKAR memory block from a binary file. 71 * 72 * @param[in] mem Pointer to data structure. 73 * @param[in,out] stream An input stream. 74 * @param[in,out] index Pointer to an index structure pointer. 75 * @param[in] data_type Type of the memory (as in oskar_Mem). 76 * @param[in] name_group Tag group name. 77 * @param[in] name_tag Tag name. 78 * @param[in] user_index User-defined index. 79 * @param[in,out] status Status return code. 80 */ 81 OSKAR_EXPORT 82 void oskar_binary_read_mem_ext(oskar_Binary* handle, oskar_Mem* mem, 83 const char* name_group, const char* name_tag, int user_index, 84 int* status); 85 86 #ifdef __cplusplus 87 } 88 #endif 89 90 #endif /* OSKAR_BINARY_READ_MEM_H_ */ 91