/usr/include/XdmfBinaryController.hpp is in libxdmf-dev 3.0+git20160803-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 | /*****************************************************************************/
/* XDMF */
/* eXtensible Data Model and Format */
/* */
/* Id : XdmfBinaryController.hpp */
/* */
/* Author: */
/* Kenneth Leiter */
/* kenneth.leiter@arl.army.mil */
/* US Army Research Laboratory */
/* Aberdeen Proving Ground, MD */
/* */
/* Copyright @ 2011 US Army Research Laboratory */
/* All Rights Reserved */
/* See Copyright.txt for details */
/* */
/* This software is distributed WITHOUT ANY WARRANTY; without */
/* even the implied warranty of MERCHANTABILITY or FITNESS */
/* FOR A PARTICULAR PURPOSE. See the above copyright notice */
/* for more information. */
/* */
/*****************************************************************************/
#ifndef XDMFBinaryCONTROLLER_HPP_
#define XDMFBinaryCONTROLLER_HPP_
// C Compatible Includes
#include "XdmfCore.hpp"
#include "XdmfHeavyDataController.hpp"
#ifdef __cplusplus
/**
* @brief Couples an XdmfArray with Binary data stored on disk.
*
* Serves as an interface between data stored in XdmfArrays and data
* stored in binary files on disk. When an Xdmf file is read from or
* written to disk an XdmfBinaryController is attached to
* XdmfArrays. This allows data to be released from memory but still
* be accessible or have its location written to light data.
*/
class XDMFCORE_EXPORT XdmfBinaryController : public XdmfHeavyDataController {
public:
typedef enum Endian {
BIG,
LITTLE,
NATIVE
} Endian;
virtual ~XdmfBinaryController();
/**
* Create a new controller for an binary data set on disk.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfBinaryController.cpp
* @skipline //#initializationsimplified
* @until //#initializationsimplified
*
* Python
*
* @dontinclude XdmfExampleBinaryController.py
* @skipline #//initializationsimplified
* @until #//initializationsimplified
*
* @param filePath Location of the binary file.
* @param type Data type of the dataset to read.
* @param endian Endianness of the data.
* @param seek Distance in bytes to begin reading in file.
* @param dimensions Number of elements to select in each from the total
*
* @return New Binary Controller.
*/
static shared_ptr<XdmfBinaryController>
New(const std::string & filePath,
const shared_ptr<const XdmfArrayType> & type,
const Endian & endian,
const unsigned int seek,
const std::vector<unsigned int> & dimensions);
/**
* Create a new controller for an binary data set on disk.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfBinaryController.cpp
* @skipline //#initialization
* @until //#initialization
*
* Python
*
* @dontinclude XdmfExampleBinaryController.py
* @skipline #//initialization
* @until #//initialization
*
* @param filePath Location of the binary file.
* @param type Data type of the dataset to read.
* @param endian Endianness of the data.
* @param seek Distance in bytes to begin reading in file.
* @param starts Starting index for each dimension
* @param strides Distance between read values across the dataspace
* @param dimensions Number of elements to select in each from the total
* @param dataspaces Total number of elements to select in each
*
* @return New Binary Controller.
*/
static shared_ptr<XdmfBinaryController>
New(const std::string & filePath,
const shared_ptr<const XdmfArrayType> & type,
const Endian & endian,
const unsigned int seek,
const std::vector<unsigned int> & starts,
const std::vector<unsigned int> & strides,
const std::vector<unsigned int> & dimensions,
const std::vector<unsigned int> & dataspaces);
virtual std::string getDataspaceDescription() const;
/**
* Gets the endianness of the dataset that the controller points to.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfBinaryController.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#getEndian
* @until //#getEndian
*
* Python
*
* @dontinclude XdmfExampleBinaryController.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//getEndian
* @until #//getEndian
*
* @return The endianness of the dataset.
*/
virtual Endian getEndian() const;
virtual std::string getName() const;
virtual void
getProperties(std::map<std::string, std::string> & collectedProperties) const;
/**
* Gets the offset in bytes of the dataset that the controller points to in the file.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfBinaryController.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#getSeek
* @until //#getSeek
*
* Python
*
* @dontinclude XdmfExampleBinaryController.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//getSeek
* @until #//getSeek
*
* @return The offset in bytes.
*/
virtual unsigned int getSeek() const;
virtual void read(XdmfArray * const array);
XdmfBinaryController(const XdmfBinaryController &);
protected:
XdmfBinaryController(const std::string & filePath,
const shared_ptr<const XdmfArrayType> & type,
const Endian & endian,
const unsigned int seek,
const std::vector<unsigned int> & starts,
const std::vector<unsigned int> & strides,
const std::vector<unsigned int> & dimensions,
const std::vector<unsigned int> & dataspaces);
private:
void operator=(const XdmfBinaryController &); // Not implemented.
const Endian mEndian;
const unsigned int mSeek;
};
#endif
#ifdef __cplusplus
extern "C" {
#endif
#define XDMF_BINARY_CONTROLLER_ENDIAN_BIG 50
#define XDMF_BINARY_CONTROLLER_ENDIAN_LITTLE 51
#define XDMF_BINARY_CONTROLLER_ENDIAN_NATIVE 52
struct XDMFBINARYCONTROLLER; // Simply as a typedef to ensure correct typing
typedef struct XDMFBINARYCONTROLLER XDMFBINARYCONTROLLER;
XDMFCORE_EXPORT XDMFBINARYCONTROLLER * XdmfBinaryControllerNew(char * filePath,
int type,
int endian,
unsigned int seek,
unsigned int * dimensions,
unsigned int numDims,
int * status);
XDMFCORE_EXPORT XDMFBINARYCONTROLLER * XdmfBinaryControllerNewHyperslab(char * filePath,
int type,
int endian,
unsigned int seek,
unsigned int * starts,
unsigned int * strides,
unsigned int * dimensions,
unsigned int * dataspaces,
unsigned int numDims,
int * status);
XDMFCORE_EXPORT int XdmfBinaryControllerGetEndian(XDMFBINARYCONTROLLER * controller);
XDMFCORE_EXPORT unsigned int XdmfBinaryControllerGetSeek(XDMFBINARYCONTROLLER * controller);
XDMF_HEAVYCONTROLLER_C_CHILD_DECLARE(XdmfBinaryController, XDMFBINARYCONTROLLER, XDMFCORE)
#ifdef __cplusplus
}
#endif
#endif /* XDMFBinaryCONTROLLER_HPP_ */
|