/usr/include/XdmfSubset.hpp is in libxdmf-dev 3.0+git20160803-4.
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 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 | /*****************************************************************************/
/* XDMF */
/* eXtensible Data Model and Format */
/* */
/* Id : XdmfSubset.hpp */
/* */
/* Author: */
/* Andrew Burns */
/* andrew.j.burns2@us.army.mil */
/* US Army Research Laboratory */
/* Aberdeen Proving Ground, MD */
/* */
/* Copyright @ 2013 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 XDMFSUBSET_HPP_
#define XDMFSUBSET_HPP_
// C Compatible Includes
#include "XdmfCore.hpp"
#include "XdmfArrayReference.hpp"
#include "XdmfItem.hpp"
#ifdef __cplusplus
// Forward Declarations
class XdmfArray;
// Includes
#include <vector>
#include "XdmfSharedPtr.hpp"
/**
* @brief Couples an XdmfArray with heavy data stored in another XdmfArray.
*
* This class serves to allow an array to retrieve data that is a subsection
* of an already existing array.
*/
class XDMFCORE_EXPORT XdmfSubset: public XdmfArrayReference {
public:
/**
* Generates an XdmfSubset object based on the parameters provided
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfSubset.cpp
* @skipline //#initialization
* @until //#initialization
*
* Python
*
* @dontinclude XdmfExampleSubset.py
* @skipline #//initialization
* @until #//initialization
*
* @param referenceArray The array that the subset is generated from.
* @param start A vector of the starting points for each
* dimension.
* @param stride A vector of the strides for each dimension.
* @param dimensions A vector of the amount of values read from each
* dimension.
* @return A constructed XdmfSubset
*/
static shared_ptr<XdmfSubset>
New(shared_ptr<XdmfArray> referenceArray,
std::vector<unsigned int> & start,
std::vector<unsigned int> & stride,
std::vector<unsigned int> & dimensions);
virtual ~XdmfSubset();
LOKI_DEFINE_VISITABLE(XdmfSubset, XdmfItem)
static const std::string ItemTag;
/**
* Get the dimensions of the set referenced by this subset.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfSubset.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#getDimensions
* @until //#getDimensions
*
* Python
*
* @dontinclude XdmfExampleSubset.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//getDimensions
* @until #//getDimensions
*
* @return A vector containing the size in each dimension of the
* set referenced by this subset.
*/
std::vector<unsigned int> getDimensions() const;
std::map<std::string, std::string> getItemProperties() const;
std::string getItemTag() const;
/**
* Gets the array that the subset pulls data from.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfSubset.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#getReferenceArray
* @until //#getReferenceArray
*
* Python
*
* @dontinclude XdmfExampleSubset.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//getReferenceArray
* @until #//getReferenceArray
*
* @return The array that the subset pulls data from
*/
shared_ptr<XdmfArray> getReferenceArray();
/**
* Get the size of the set referenced by this subset.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfSubset.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#getSize
* @until //#getSize
*
* Python
*
* @dontinclude XdmfExampleSubset.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//getSize
* @until #//getSize
*
* @return An int containing the size of the subset.
*/
unsigned int getSize() const;
/**
* Get the start index of the set referenced by this subset.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfSubset.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#getStart
* @until //#getStart
*
* Python
*
* @dontinclude XdmfExampleSubset.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//getStart
* @until #//getStart
*
* @return A vector containing the start index in each dimension of
* the set referenced by this subset.
*/
std::vector<unsigned int> getStart() const;
/**
* Get the stride of the set referenced by this subset.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfSubset.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#getStride
* @until //#getStride
*
* Python
*
* @dontinclude XdmfExampleSubset.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//getStride
* @until #//getStride
*
* @return A vector containing the stride in each dimension of the
* heavy data set owned by this controller.
*/
std::vector<unsigned int> getStride() const;
/**
* Read data reference by this subset and return as an XdmfArray.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfSubset.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#read
* @until //#read
*
* Python
*
* @dontinclude XdmfExampleSubset.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//read
* @until #//read
*
* @return An array filled with data based on the subset's parameters.
*/
virtual shared_ptr<XdmfArray> read() const;
/**
* Set the dimensions of the set referenced by this subset.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfSubset.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#getDimensions
* @until //#getDimensions
* @skipline //#setDimensions
* @until //#setDimensions
*
* Python
*
* @dontinclude XdmfExampleSubset.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//getDimensions
* @until #//getDimensions
* @skipline #//setDimensions
* @until #//setDimensions
*
* @param newDimensions A vector containing the size in each dimension
* of the set to be referenced by this subset.
*/
void setDimensions(std::vector<unsigned int> newDimensions);
/**
* Set the Array that the subset is generated from.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfSubset.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#getReferenceArray
* @until //#getReferenceArray
* @skipline //#setReferenceArray
* @until //#setReferenceArray
*
* Python
*
* @dontinclude XdmfExampleSubset.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//getReferenceArray
* @until #//getReferenceArray
* @skipline #//setReferenceArray
* @until #//setReferenceArray
*
* @param newReference A shared pointer to the array that the subset
* will be generated from
*/
void setReferenceArray(shared_ptr<XdmfArray> newReference);
/**
* Set the start index of the set referenced by this subset.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfSubset.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#getStart
* @until //#getStart
* @skipline //#setStart
* @until //#setStart
*
* Python
*
* @dontinclude XdmfExampleSubset.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//getStart
* @until #//getStart
* @skipline #//setStart
* @until #//setStart
*
* @param newStarts A vector containing the start index in each
* dimension of the set to be referenced by this
* subset.
*/
void setStart(std::vector<unsigned int> newStarts);
/**
* Set the stride of the heavy data set owned by this controller.
*
* Example of use:
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfSubset.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#getStride
* @until //#getStride
* @skipline //#setStride
* @until //#setStride
*
* Python
*
* @dontinclude XdmfExampleSubset.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//getStride
* @until #//getStride
* @skipline #//setStride
* @until #//setStride
*
* @param newStrides A vector containing the stride in each
* dimension of the set referenced by this subset.
*/
void setStride(std::vector<unsigned int> newStrides);
void traverse(const shared_ptr<XdmfBaseVisitor> visitor);
XdmfSubset(XdmfSubset&);
protected:
XdmfSubset(shared_ptr<XdmfArray> referenceArray,
std::vector<unsigned int> & start,
std::vector<unsigned int> & stride,
std::vector<unsigned int> & dimensions);
void
populateItem(const std::map<std::string, std::string> & itemProperties,
const std::vector<shared_ptr<XdmfItem> > & childItems,
const XdmfCoreReader * const reader);
shared_ptr<XdmfArray> mParent;
std::vector<unsigned int> mDimensions;
std::vector<unsigned int> mStart;
std::vector<unsigned int> mStride;
private:
XdmfSubset(const XdmfSubset&); // Not implemented.
void operator=(const XdmfSubset &); // Not implemented.
};
#endif
#ifdef __cplusplus
extern "C" {
#endif
// C wrappers go here
struct XDMFSUBSET; // Simply as a typedef to ensure correct typing
typedef struct XDMFSUBSET XDMFSUBSET;
XDMFCORE_EXPORT XDMFSUBSET * XdmfSubsetNew(void * referenceArray, unsigned int * start, unsigned int * stride, unsigned int * dimensions, unsigned int numDims, int passControl, int * status);
XDMFCORE_EXPORT unsigned int * XdmfSubsetGetDimensions(XDMFSUBSET * subset);
XDMFCORE_EXPORT unsigned int XdmfSubsetGetNumberDimensions(XDMFSUBSET * subset);
XDMFCORE_EXPORT void * XdmfSubsetGetReferenceArray(XDMFSUBSET * subset);
XDMFCORE_EXPORT unsigned int XdmfSubsetGetSize(XDMFSUBSET * subset);
XDMFCORE_EXPORT unsigned int * XdmfSubsetGetStart(XDMFSUBSET * subset);
XDMFCORE_EXPORT unsigned int * XdmfSubsetGetStride(XDMFSUBSET * subset);
XDMFCORE_EXPORT void XdmfSubsetSetDimensions(XDMFSUBSET * subset, unsigned int * newDimensions, unsigned int numDims, int * status);
XDMFCORE_EXPORT void XdmfSubsetSetReferenceArray(XDMFSUBSET * subset, XDMFARRAY * referenceArray, int passControl);
XDMFCORE_EXPORT void XdmfSubsetSetStart(XDMFSUBSET * subset, unsigned int * newStarts, unsigned int numDims, int * status);
XDMFCORE_EXPORT void XdmfSubsetSetStride(XDMFSUBSET * subset, unsigned int * newStrides, unsigned int numDims, int * status);
// C Wrappers for parent classes are generated by macros
XDMF_ITEM_C_CHILD_DECLARE(XdmfSubset, XDMFSUBSET, XDMFCORE)
XDMF_ARRAYREFERENCE_C_CHILD_DECLARE(XdmfSubset, XDMFSUBSET, XDMFCORE)
#ifdef __cplusplus
}
#endif
#endif /* XDMFSUBSET_HPP_ */
|