/usr/include/XdmfHeavyDataController.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 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 | /*****************************************************************************/
/* XDMF */
/* eXtensible Data Model and Format */
/* */
/* Id : XdmfHeavyDataController.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 XDMFHEAVYDATACONTROLLER_HPP_
#define XDMFHEAVYDATACONTROLLER_HPP_
// C Compatible Includes
#include "XdmfCore.hpp"
#include "XdmfArrayType.hpp"
#ifdef __cplusplus
// Forward Declarations
class XdmfArray;
// Includes
#include <string>
#include <vector>
#include <map>
#include "XdmfSharedPtr.hpp"
/**
* @brief Couples an XdmfArray with heavy data stored on disk.
*
* This is an abstract base class to support the reading of different
* heavy data formats.
*
* Serves as an interface between data stored in XdmfArrays and data
* stored on disk. When an Xdmf file is read from or written to disk
* an XdmfHeavyController 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 XdmfHeavyDataController {
public:
virtual ~XdmfHeavyDataController() = 0;
/**
* Gets a string containing data on the starts,
* strides, dimensions, and dataspaces for this controller.
*
* @return The string description
*/
std::string getDataspaceDescription() const;
/**
* Get the dimensions of the dataspace owned by this
* controller. This is the dimension of the entire heavy dataset,
* which may be larger than the dimensions of the array (if reading
* a piece of a larger dataset).
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfHDF5Controller.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#getDataspaceDimensions
* @until //#getDataspaceDimensions
*
* Python
*
* @dontinclude XdmfExampleHDF5Controller.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//getDataspaceDimensions
* @until #//getDataspaceDimensions
*
* @return A vector containing the size in each dimension of the dataspace
* owned by this controller.
*/
std::vector<unsigned int> getDataspaceDimensions() const;
/**
* Get the size of dataspace of the heavy data set owned by this controller.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfHDF5Controller.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#getDataspaceSize
* @until //#getDataspaceSize
*
* Python
*
* @dontinclude XdmfExampleHDF5Controller.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//getDataspaceSize
* @until #//getDataspaceSize
*
* @return An int containing the size of the heavy data set.
*/
unsigned int getDataspaceSize() const;
/**
* Gets the controller in string form. For writing to file.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfHeavyDataController.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#getDescriptor
* @until //#getDescriptor
*
* Python
*
* @dontinclude XdmfExampleHeavyDataController.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//getDescriptor
* @until #//getDescriptor
*
* @return A string that contains relevant information for the controller
*/
virtual std::string getDescriptor() const;
/**
* Get the dimensions of the heavy data set owned by this controller.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfHeavyDataController.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#getDimensions
* @until //#getDimensions
*
* Python
*
* @dontinclude XdmfExampleHeavyDataController.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//getDimensions
* @until #//getDimensions
*
* @return A vector containing the size in each dimension of the heavy data
* set owned by this controller.
*/
std::vector<unsigned int> getDimensions() const;
/**
* Get the absolute path to the heavy data file on disk where the
* data set owned by this controller resides.
* For "/home/output.h5:/foo/data" this is "/home/output.h5"
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfHeavyDataController.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#getFilePath
* @until //#getFilePath
*
* Python
*
* @dontinclude XdmfExampleHeavyDataController.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//getFilePath
* @until #//getFilePath
*
* @return A std::string containing the path to the heavy data file.
*/
std::string getFilePath() const;
/**
* Get the name of this heavy data format. E.g. "HDF" for hdf5
* format.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfHeavyDataController.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#getName
* @until //#getName
*
* Python
*
* @dontinclude XdmfExampleHeavyDataController.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//getName
* @until #//getName
*
* @return std::string containing the name of this heavy data format
*/
virtual std::string getName() const = 0;
/**
* Get the size of the heavy data set owned by this controller.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfHeavyDataController.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#getSize
* @until //#getSize
*
* Python
*
* @dontinclude XdmfExampleHeavyDataController.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//getSize
* @until #//getSize
*
* @return An int containing the size of the heavy data set.
*/
unsigned int getSize() const;
/**
* Get the start index of the heavy data set owned by this controller.
*
* C++
*
* @dontinclude ExampleXdmfHDF5Controller.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#getStart
* @until //#getStart
*
* Python
*
* @dontinclude XdmfExampleHDF5Controller.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//getStart
* @until #//getStart
*
* @return A vector containing the start index in each dimension of
* the heavy data set owned by this controller.
*/
std::vector<unsigned int> getStart() const;
/**
* Get the stride of the heavy data set owned by this controller.
*
* C++
*
* @dontinclude ExampleXdmfHDF5Controller.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#getStride
* @until //#getStride
*
* Python
*
* @dontinclude XdmfExampleHDF5Controller.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;
/**
* For use in conjunction with heavy data controllers set to arrays
* the offset within the array from which the controller will be inserted
* Is also set when created by a writer.
*
* C++
*
* @dontinclude ExampleXdmfHeavyDataController.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#setArrayOffset
* @until //#setArrayOffset
*
* Python
*
* @dontinclude XdmfExampleHeavyDataController.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//setArrayOffset
* @until #//setArrayOffset
*
* @param newOffset The new index at which the controller will be written
*/
void setArrayOffset(unsigned int newOffset);
/**
* Gets the index at which the controller will offset when
* an array reads it from its associated controllers.
* Set when created by a Writer or set manually.
*
* C++
*
* @dontinclude ExampleXdmfHeavyDataController.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#setArrayOffset
* @until //#setArrayOffset
* @skipline //#getArrayOffset
* @until //#getArrayOffset
*
* Python
*
* @dontinclude XdmfExampleHeavyDataController.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//setArrayOffset
* @until #//setArrayOffset
* @skipline #//getArrayOffset
* @until #//getArrayOffset
*
* @return The offset that the array will read from
*/
unsigned int getArrayOffset() const;
virtual void getProperties(std::map<std::string, std::string> & collectedProperties) const = 0;
/**
* Get the array type of the heavy data set owned by this
* controller.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfHeavyDataController.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#getType
* @until //#getType
*
* Python
*
* @dontinclude XdmfExampleHeavyDataController.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//getType
* @until #//getType
*
* @return An XdmfArrayType containing the array type of the heavy data set.
*/
shared_ptr<const XdmfArrayType> getType() const;
/**
* Read data owned by this controller on disk into the passed
* XdmfArray.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfHeavyDataController.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#read
* @until //#read
*
* Python
*
* @dontinclude XdmfExampleHeavyDataController.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//read
* @until #//read
*
* @param array An XdmfArray to read data into.
*/
virtual void read(XdmfArray * const array) = 0;
XdmfHeavyDataController(const XdmfHeavyDataController&);
protected:
XdmfHeavyDataController(const std::string & filePath,
const shared_ptr<const XdmfArrayType> & type,
const std::vector<unsigned int> & starts,
const std::vector<unsigned int> & strides,
const std::vector<unsigned int> & dimensions,
const std::vector<unsigned int> & dataspaces);
const std::vector<unsigned int> mStart;
const std::vector<unsigned int> mStride;
const std::vector<unsigned int> mDimensions;
const std::vector<unsigned int> mDataspaceDimensions;
const std::string mFilePath;
unsigned int mArrayStartOffset;
const shared_ptr<const XdmfArrayType> mType;
private:
void operator=(const XdmfHeavyDataController &); // Not implemented.
};
#endif
#ifdef __cplusplus
extern "C" {
#endif
// C wrappers go here
struct XDMFHEAVYDATACONTROLLER; // Simply as a typedef to ensure correct typing
typedef struct XDMFHEAVYDATACONTROLLER XDMFHEAVYDATACONTROLLER;
XDMFCORE_EXPORT void XdmfHeavyDataControllerFree(XDMFHEAVYDATACONTROLLER * item);
XDMFCORE_EXPORT unsigned int * XdmfHeavyDataControllerGetDataspaceDimensions(XDMFHEAVYDATACONTROLLER * controller);
XDMFCORE_EXPORT unsigned int * XdmfHeavyDataControllerGetDimensions(XDMFHEAVYDATACONTROLLER * controller);
XDMFCORE_EXPORT char * XdmfHeavyDataControllerGetFilePath(XDMFHEAVYDATACONTROLLER * controller);
XDMFCORE_EXPORT char * XdmfHeavyDataControllerGetName(XDMFHEAVYDATACONTROLLER * controller);
XDMFCORE_EXPORT unsigned int XdmfHeavyDataControllerGetNumberDimensions(XDMFHEAVYDATACONTROLLER * controller);
XDMFCORE_EXPORT unsigned int XdmfHeavyDataControllerGetSize(XDMFHEAVYDATACONTROLLER * controller);
XDMFCORE_EXPORT unsigned int * XdmfHeavyDataControllerGetStart(XDMFHEAVYDATACONTROLLER * controller);
XDMFCORE_EXPORT unsigned int * XdmfHeavyDataControllerGetStride(XDMFHEAVYDATACONTROLLER * controller);
XDMFCORE_EXPORT void XdmfHeavyDataControllerSetArrayOffset(XDMFHEAVYDATACONTROLLER * controller, unsigned int newOffset);
XDMFCORE_EXPORT unsigned int XdmfHeavyDataControllerGetArrayOffset(XDMFHEAVYDATACONTROLLER * controller);
XDMFCORE_EXPORT int XdmfHeavyDataControllerGetType(XDMFHEAVYDATACONTROLLER * controller, int * status);
XDMFCORE_EXPORT void XdmfHeavyDataControllerRead(XDMFHEAVYDATACONTROLLER * controller, void * array, int * status);
#define XDMF_HEAVYCONTROLLER_C_CHILD_DECLARE(ClassName, CClassName, Level) \
\
Level##_EXPORT void ClassName##Free( CClassName * item); \
Level##_EXPORT unsigned int * ClassName##GetDataspaceDimensions( CClassName * controller); \
Level##_EXPORT unsigned int * ClassName##GetDimensions( CClassName * controller); \
Level##_EXPORT char * ClassName##GetFilePath( CClassName * controller); \
Level##_EXPORT char * ClassName##GetName( CClassName * controller); \
Level##_EXPORT unsigned int ClassName##GetNumberDimensions( CClassName * controller); \
Level##_EXPORT unsigned int ClassName##GetSize( CClassName * controller); \
Level##_EXPORT unsigned int * ClassName##GetStart( CClassName * controller); \
Level##_EXPORT unsigned int * ClassName##GetStride( CClassName * controller); \
Level##_EXPORT void ClassName##SetArrayOffset( CClassName * controller, unsigned int newOffset); \
Level##_EXPORT unsigned int ClassName##GetArrayOffset( CClassName * controller); \
Level##_EXPORT int ClassName##GetType( CClassName * controller, int * status); \
Level##_EXPORT void ClassName##Read( CClassName * controller, void * array, int * status);
#define XDMF_HEAVYCONTROLLER_C_CHILD_WRAPPER(ClassName, CClassName) \
\
void ClassName##Free( CClassName * item) \
{ \
XdmfHeavyDataControllerFree((XDMFHEAVYDATACONTROLLER *)((void *)item)); \
} \
\
unsigned int * ClassName##GetDataspaceDimensions( CClassName * controller) \
{ \
return XdmfHeavyDataControllerGetDataspaceDimensions((XDMFHEAVYDATACONTROLLER *)((void *)controller)); \
} \
\
unsigned int * ClassName##GetDimensions( CClassName * controller) \
{ \
return XdmfHeavyDataControllerGetDimensions((XDMFHEAVYDATACONTROLLER *)((void *)controller)); \
} \
\
char * ClassName##GetFilePath( CClassName * controller) \
{ \
return XdmfHeavyDataControllerGetFilePath((XDMFHEAVYDATACONTROLLER *)((void *)controller)); \
} \
\
char * ClassName##GetName( CClassName * controller) \
{ \
return XdmfHeavyDataControllerGetName((XDMFHEAVYDATACONTROLLER *)((void *)controller)); \
} \
\
unsigned int ClassName##GetNumberDimensions( CClassName * controller) \
{ \
return XdmfHeavyDataControllerGetNumberDimensions((XDMFHEAVYDATACONTROLLER *)((void *)controller)); \
} \
\
unsigned int ClassName##GetSize( CClassName * controller) \
{ \
return XdmfHeavyDataControllerGetSize((XDMFHEAVYDATACONTROLLER *)((void *)controller)); \
} \
\
unsigned int * ClassName##GetStart( CClassName * controller) \
{ \
return XdmfHeavyDataControllerGetStart((XDMFHEAVYDATACONTROLLER *)((void *)controller)); \
} \
\
unsigned int * ClassName##GetStride( CClassName * controller) \
{ \
return XdmfHeavyDataControllerGetStride((XDMFHEAVYDATACONTROLLER *)((void *)controller)); \
} \
\
void ClassName##SetArrayOffset( CClassName * controller, unsigned int newOffset) \
{ \
XdmfHeavyDataControllerSetArrayOffset((XDMFHEAVYDATACONTROLLER *)((void *)controller), newOffset); \
} \
\
unsigned int ClassName##GetArrayOffset( CClassName * controller) \
{ \
return XdmfHeavyDataControllerGetArrayOffset((XDMFHEAVYDATACONTROLLER *)((void *)controller)); \
} \
\
int ClassName##GetType( CClassName * controller, int * status) \
{ \
return XdmfHeavyDataControllerGetType((XDMFHEAVYDATACONTROLLER *)((void *)controller), status); \
} \
\
void ClassName##Read( CClassName * controller, void * array, int * status) \
{ \
XdmfHeavyDataControllerRead((XDMFHEAVYDATACONTROLLER *)((void *)controller), array, status); \
}
#ifdef __cplusplus
}
#endif
#endif /* XDMFHEAVYDATACONTROLLER_HPP_ */
|