/usr/include/XdmfPlaceholder.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 | /*****************************************************************************/
/* XDMF */
/* eXtensible Data Model and Format */
/* */
/* Id : XdmfPlaceholder.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 XDMFPLACEHOLDER_HPP_
#define XDMFPLACEHOLDER_HPP_
// C Compatible Includes
#include "XdmfCore.hpp"
#include "XdmfHeavyDataController.hpp"
#ifdef __cplusplus
#include <map>
/**
* @brief Couples an XdmfArray with an array structure.
*
* Takes the place of a heavy data set. Allows an array to define
* its structure without having to have an associated dataset.
*/
class XDMFCORE_EXPORT XdmfPlaceholder : public XdmfHeavyDataController {
public:
virtual ~XdmfPlaceholder();
/**
* Create a new placeholder to define array structure.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfPlaceholder.cpp
* @skipline //#initialization
* @until //#initialization
*
* Python
*
* @dontinclude XdmfExamplePlaceholder.py
* @skipline #//initialization
* @until #//initialization
*
* @param filePath The location of the file the data set resides in.
* @param type The data type of the dataset to read.
* @param start The offset of the starting element in each
* dimension in the data set.
* @param stride The number of elements to move in each
* dimension from the data set.
* @param dimensions The number of elements to select in each
* dimension from the data set.
* (size in each dimension)
* @param dataspaceDimensions The number of elements in the entire
* data set (may be larger than
* dimensions if using hyperslabs).
*
* @return New Placeholder.
*/
static shared_ptr<XdmfPlaceholder>
New(const std::string & FilePath,
const shared_ptr<const XdmfArrayType> type,
const std::vector<unsigned int> & start,
const std::vector<unsigned int> & stride,
const std::vector<unsigned int> & dimensions,
const std::vector<unsigned int> & dataspaceDimensions);
virtual std::string getDescriptor() const;
virtual std::string getName() const;
virtual void
getProperties(std::map<std::string, std::string> & collectedProperties) const;
virtual void read(XdmfArray * const array);
XdmfPlaceholder(const XdmfPlaceholder &);
protected:
XdmfPlaceholder(const std::string & filePath,
const shared_ptr<const XdmfArrayType> type,
const std::vector<unsigned int> & start,
const std::vector<unsigned int> & stride,
const std::vector<unsigned int> & dimensions,
const std::vector<unsigned int> & dataspaceDimensions);
shared_ptr<XdmfHeavyDataController>
createSubController(const std::vector<unsigned int> & starts,
const std::vector<unsigned int> & strides,
const std::vector<unsigned int> & dimensions);
virtual shared_ptr<XdmfHeavyDataDescription>
getHeavyDataDescription();
void read(XdmfArray * const array, const int fapl);
private:
void operator=(const XdmfPlaceholder &); // Not implemented.
};
#endif
#ifdef __cplusplus
extern "C" {
#endif
struct XDMFPLACEHOLDER; // Simply as a typedef to ensure correct typing
typedef struct XDMFPLACEHOLDER XDMFPLACEHOLDER;
XDMFCORE_EXPORT XDMFPLACEHOLDER * XdmfPlaceholderNew(char * hdf5FilePath,
int type,
unsigned int * start,
unsigned int * stride,
unsigned int * dimensions,
unsigned int * dataspaceDimensions,
unsigned int numDims,
int * status);
// C Wrappers for parent classes are generated by macros
/*
XDMFCORE_EXPORT unsigned int * XdmfPlaceholderGetDataspaceDimensions(XDMFPLACEHOLDER * controller);
XDMFCORE_EXPORT unsigned int * XdmfPlaceholderGetStart(XDMFPLACEHOLDER * controller);
XDMFCORE_EXPORT unsigned int * XdmfPlaceholderGetStride(XDMFPLACEHOLDER * controller);
*/
XDMF_HEAVYCONTROLLER_C_CHILD_DECLARE(XdmfPlaceholder, XDMFPLACEHOLDER, XDMFCORE)
#ifdef __cplusplus
}
#endif
#endif /* XDMFPLACEHOLDER_HPP_ */
|