/usr/include/XdmfHeavyDataWriter.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 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 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 | /*****************************************************************************/
/* XDMF */
/* eXtensible Data Model and Format */
/* */
/* Id : XdmfHeavyDataWriter.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 XDMFHEAVYDATAWRITER_HPP_
#define XDMFHEAVYDATAWRITER_HPP_
#include "XdmfCore.hpp"
#include "XdmfArrayType.hpp"
#include "XdmfHeavyDataController.hpp"
#include "XdmfVisitor.hpp"
#ifdef __cplusplus
// Forward Declarations
class XdmfArray;
// Includes
#include <string>
#include <list>
/**
* @brief Traverses the Xdmf graph and writes heavy data stored in
* XdmfArrays to heavy data files on disk.
*
* This is an abstract base class to support the writing of different
* heavy data formats.
*
* XdmfHeavyDataWriter traverses an Xdmf graph structure and writes
* data stored in XdmfArrays to heavy data files on disk. Writing
* begins by calling the accept() operation on any XdmfItem and
* supplying this writer as the parameter. The writer will write all
* XdmfArrays under the XdmfItem to a heavy data file on disk. It will
* also attach an XdmfHeavyDataController to all XdmfArrays that it
* writes to disk.
*
* There are three modes of operation for this writer:
* Default - All initialized XdmfArrays are written to new heavy datasets
* regardless of whether they are attached to another heavy
* dataset on disk via an XdmfHeavyDataController.
* Overwrite - If an initialized XdmfArray is attached to an heavy dataset
* via an XdmfHeavyDataController the writer will write values
* to that location, overwriting all previous written values.
* The dataset on disk will be resized appropriately.
* Append - If an initialized XdmfArray is attached to an heavy dataset via
* an XdmfHeavyDataController the writer will append the values to
* the end of the dataset on disk.
* Hyperslab - If an initialized XdmfArray is attached to a heavy dataset
* via an XdmfHeavyDataController the writer will write to a
* hyperslab in the dataset based on the start, stride, and
* dimensions of the XdmfHeavyDataController.
*/
class XDMFCORE_EXPORT XdmfHeavyDataWriter : public XdmfVisitor,
public Loki::Visitor<XdmfArray> {
public:
enum Mode {
Default,
Overwrite,
Append,
Hyperslab
};
virtual ~XdmfHeavyDataWriter() = 0;
/**
* Close file. This is only needed when the file is opened manually
* through openFile().
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfHeavyDataWriter.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#closeFile
* @until //#closeFile
*
* Python
*
* @dontinclude XdmfExampleHeavyDataWriter.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//closeFile
* @until #//closeFile
*/
virtual void closeFile() = 0;
/**
* Gets whether the HDF5 Writer is allowed to split data sets when writing to hdf5.
* Splitting should only occur for massive data sets.
* Setting to false assures compatibility with previous editions.
* Default setting is false.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfHeavyDataWriter.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#getAllowSetSplitting
* @until //#getAllowSetSplitting
*
* Python
*
* @dontinclude XdmfExampleHeavyDataWriter.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//getAllowSetSplitting
* @until #//getAllowSetSplitting
*
* @return Whether to allow data sets to be split across hdf5 files
*/
int getAllowSetSplitting();
/**
* Gets the file index. Used when file splitting and incremented whent he current file is full.
*
* C++
*
* @dontinclude ExampleXdmfHeavyDataWriter.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#getFileIndex
* @until //#getFileIndex
*
* Python
*
* @dontinclude XdmfExampleHeavyDataWriter.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//getFileIndex
* @until #//getFileIndex
*
* @return The current file index.
*/
int getFileIndex();
/**
* Gets the amount of bytes that the heavy data writer uses as overhead for the data type.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfHeavyDataWriter.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#getFileOverhead
* @until //#getFileOverhead
*
* Python
*
* @dontinclude XdmfExampleHeavyDataWriter.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//getFileOverhead
* @until #//getFileOverhead
*
* @return Amount of bytes used as overhead
*/
unsigned int getFileOverhead();
/**
* Get the path to the heavy data file on disk this writer is writing to.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfHeavyDataWriter.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#getFilePath
* @until //#getFilePath
*
* Python
*
* @dontinclude XdmfExampleHeavyDataWriter.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//getFilePath
* @until #//getFilePath
*
* @return A std::string containing the path to the heavy file on disk this
* writer is writing to.
*/
std::string getFilePath() const;
/**
* Gets the file size limit of the HDF5 files produced by the writer in MB. Overflow is pushed to a new HDF5 file.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfHeavyDataWriter.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#getFileSizeLimit
* @until //#getFileSizeLimit
*
* Python
*
* @dontinclude XdmfExampleHeavyDataWriter.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//getFileSizeLimit
* @until #//getFileSizeLimit
*
* @return The size limit in MB
*/
int getFileSizeLimit();
/**
* Get the Mode of operation for this writer.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfHeavyDataWriter.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#getMode
* @until //#getMode
*
* Python
*
* @dontinclude XdmfExampleHeavyDataWriter.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//getMode
* @until #//getMode
*
* @return The Mode of operation for this writer.
*/
Mode getMode() const;
/**
* Get whether to release data from memory after writing to disk.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfHeavyDataWriter.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#getReleaseData
* @until //#getReleaseData
*
* Python
*
* @dontinclude XdmfExampleHeavyDataWriter.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//getReleaseData
* @until #//getReleaseData
*
* @return True if data is freed after writing
*/
bool getReleaseData() const;
/**
* Open file for writing. This is an optional command that can
* improve performance for some writers when writing many datasets
* to a single file. User must call closeFile() after completing
* output.
*
* By default, heavy data files are open and closed before and after
* writing each dataset to ensure that other writers have access to
* the file (we never know whether we will be writing to the file
* again). This is expensive in some cases, but is always
* safe. Opening the file once and writing many datasets may result
* in improved performance, but the user must tell the writer when
* to open and close the file.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfHeavyDataWriter.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#openFile
* @until //#openFile
*
* Python
*
* @dontinclude XdmfExampleHeavyDataWriter.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//openFile
* @until #//openFile
*/
virtual void openFile() = 0;
/**
* Sets whether to allow the HDF5 writer to split data sets when writing to hdf5.
* Splitting should only occur for massive data sets.
* Setting to false assures compatibility with previous editions.
* Default setting is false
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfHeavyDataWriter.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#setAllowSetSplitting
* @until //#setAllowSetSplitting
*
* Python
*
* @dontinclude XdmfExampleHeavyDataWriter.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//setAllowSetSplitting
* @until #//setAllowSetSplitting
*
* @param newAllow Whether to allow data sets to be split across hdf5 files
*/
void setAllowSetSplitting(bool newAllow);
/**
* Sets the file index. Used when file splitting and incremented when the current file is full. Set to 0 before using hyperslab or overwrite.
*
* C++
*
* @dontinclude ExampleXdmfHeavyDataWriter.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#getFileIndex
* @until //#getFileIndex
*
* Python
*
* @dontinclude XdmfExampleHeavyDataWriter.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//getFileIndex
* @until #//getFileIndex
*
* @param newIndex The index that the writer will append to the file name when incorperating file splitting
*/
void setFileIndex(int newIndex);
/**
* Sets the file size limit of the HDF5 files produced by the writer in MB. Overflow is pushed to a new HDF5 file.
* Using with arrays of string type may reduce performance.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfHeavyDataWriter.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#setFileSizeLimit
* @until //#setFileSizeLimit
*
* Python
*
* @dontinclude XdmfExampleHeavyDataWriter.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//setFileSizeLimit
* @until #//setFileSizeLimit
*
* @param newSize The size limit in MB
*/
void setFileSizeLimit(int newSize);
/**
* Set the mode of operation for this writer.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfHeavyDataWriter.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#setMode
* @until //#setMode
*
* Python
*
* @dontinclude XdmfExampleHeavyDataWriter.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//setMode
* @until #//setMode
*
* @param mode The Mode of operation for this writer.
*/
void setMode(const Mode mode);
/**
* Set whether to release data from memory after writing to disk.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfHeavyDataWriter.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#setReleaseData
* @until //#setReleaseData
*
* Python
*
* @dontinclude XdmfExampleHeavyDataWriter.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//setReleaseData
* @until #//setReleaseData
*
* @param releaseData True if data should be freed after writing
*/
void setReleaseData(const bool releaseData = true);
/**
* Write an XdmfArray to heavy data file on disk.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfHeavyDataWriter.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#visit
* @until //#visit
*
* Python
*
* @dontinclude XdmfExampleHeavyDataWriter.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//visit
* @until #//visit
*
* @param array An XdmfArray to write to heavy data.
* @param visitor A smart pointer to this visitor --- aids in grid traversal.
*/
using XdmfVisitor::visit;
virtual void visit(XdmfArray & array,
const shared_ptr<XdmfBaseVisitor> visitor) = 0;
protected:
XdmfHeavyDataWriter(const double compression = 1, const unsigned int overhead = 0);
XdmfHeavyDataWriter(const std::string & filePath, const double compression = 1, const unsigned int overhead = 0);
virtual shared_ptr<XdmfHeavyDataController>
createController(const std::string & filePath,
const std::string & descriptor,
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) = 0;
virtual int getDataSetSize(shared_ptr<XdmfHeavyDataController> descriptionController) = 0;
bool mAllowSplitDataSets;
int mDataSetId;
int mFileIndex;
std::string mFilePath;
unsigned int mFileSizeLimit;
Mode mMode;
bool mReleaseData;
double mCompressionRatio;
unsigned int mFileOverhead;
private:
XdmfHeavyDataWriter(const XdmfHeavyDataWriter &); // Not implemented.
void operator=(const XdmfHeavyDataWriter &); // Not implemented.
};
#endif
#ifdef __cplusplus
extern "C" {
#endif
struct XDMFHEAVYDATAWRITER; // Simply as a typedef to ensure correct typing
typedef struct XDMFHEAVYDATAWRITER XDMFHEAVYDATAWRITER;
#define XDMF_HEAVY_WRITER_MODE_DEFAULT 20
#define XDMF_HEAVY_WRITER_MODE_OVERWRITE 21
#define XDMF_HEAVY_WRITER_MODE_APPEND 22
#define XDMF_HEAVY_WRITER_MODE_HYPERSLAB 23
// C wrappers go here
XDMFCORE_EXPORT void XdmfHeavyDataWriterFree(XDMFHEAVYDATAWRITER * item);
XDMFCORE_EXPORT int XdmfHeavyDataWriterGetAllowSetSplitting(XDMFHEAVYDATAWRITER * writer);
XDMFCORE_EXPORT int XdmfHeavyDataWriterGetFileIndex(XDMFHEAVYDATAWRITER * writer);
XDMFCORE_EXPORT unsigned int XdmfHeavyDataWriterGetFileOverhead(XDMFHEAVYDATAWRITER * writer);
XDMFCORE_EXPORT char * XdmfHeavyDataWriterGetFilePath(XDMFHEAVYDATAWRITER * writer);
XDMFCORE_EXPORT int XdmfHeavyDataWriterGetFileSizeLimit(XDMFHEAVYDATAWRITER * writer);
XDMFCORE_EXPORT int XdmfHeavyDataWriterGetMode(XDMFHEAVYDATAWRITER * writer);
XDMFCORE_EXPORT int XdmfHeavyDataWriterGetReleaseData(XDMFHEAVYDATAWRITER * writer);
XDMFCORE_EXPORT void XdmfHeavyDataWriterSetAllowSetSplitting(XDMFHEAVYDATAWRITER * writer, int newAllow);
XDMFCORE_EXPORT void XdmfHeavyDataWriterSetFileIndex(XDMFHEAVYDATAWRITER * writer, int newIndex);
XDMFCORE_EXPORT void XdmfHeavyDataWriterSetFileSizeLimit(XDMFHEAVYDATAWRITER * writer, int newSize);
XDMFCORE_EXPORT void XdmfHeavyDataWriterSetMode(XDMFHEAVYDATAWRITER * writer, int mode, int * status);
XDMFCORE_EXPORT void XdmfHeavyDataWriterSetReleaseData(XDMFHEAVYDATAWRITER * writer, int releaseData);
#define XDMF_HEAVYWRITER_C_CHILD_DECLARE(ClassName, CClassName, Level) \
\
Level##_EXPORT void ClassName##Free( CClassName * item); \
Level##_EXPORT int ClassName##GetAllowSetSplitting( CClassName * writer); \
Level##_EXPORT int ClassName##GetFileIndex( CClassName * writer); \
Level##_EXPORT unsigned int ClassName##GetFileOverhead( CClassName * writer); \
Level##_EXPORT char * ClassName##GetFilePath( CClassName * writer); \
Level##_EXPORT int ClassName##GetFileSizeLimit( CClassName * writer); \
Level##_EXPORT int ClassName##GetMode( CClassName * writer); \
Level##_EXPORT int ClassName##GetReleaseData( CClassName * writer); \
Level##_EXPORT void ClassName##SetAllowSetSplitting( CClassName * writer, int newAllow); \
Level##_EXPORT void ClassName##SetFileIndex( CClassName * writer, int newIndex); \
Level##_EXPORT void ClassName##SetFileSizeLimit( CClassName * writer, int newSize); \
Level##_EXPORT void ClassName##SetMode( CClassName * writer, int mode, int * status); \
Level##_EXPORT void ClassName##SetReleaseData( CClassName * writer, int releaseData);
#define XDMF_HEAVYWRITER_C_CHILD_WRAPPER(ClassName, CClassName) \
\
void ClassName##Free( CClassName * item) \
{ \
XdmfHeavyDataWriterFree((XDMFHEAVYDATAWRITER *)((void *)item)); \
} \
\
int ClassName##GetAllowSetSplitting( CClassName * writer) \
{ \
return XdmfHeavyDataWriterGetAllowSetSplitting((XDMFHEAVYDATAWRITER *)((void *)writer)); \
} \
\
int ClassName##GetFileIndex( CClassName * writer) \
{ \
return XdmfHeavyDataWriterGetFileIndex((XDMFHEAVYDATAWRITER *)((void *)writer)); \
} \
\
unsigned int ClassName##GetFileOverhead( CClassName * writer) \
{ \
return XdmfHeavyDataWriterGetFileOverhead((XDMFHEAVYDATAWRITER *)((void *)writer)); \
} \
\
char * ClassName##GetFilePath( CClassName * writer) \
{ \
return XdmfHeavyDataWriterGetFilePath((XDMFHEAVYDATAWRITER *)((void *)writer)); \
} \
\
int ClassName##GetFileSizeLimit( CClassName * writer) \
{ \
return XdmfHeavyDataWriterGetFileSizeLimit((XDMFHEAVYDATAWRITER *)((void *)writer)); \
} \
\
int ClassName##GetMode( CClassName * writer) \
{ \
return XdmfHeavyDataWriterGetMode((XDMFHEAVYDATAWRITER *)((void *)writer)); \
} \
\
int ClassName##GetReleaseData( CClassName * writer) \
{ \
return XdmfHeavyDataWriterGetReleaseData((XDMFHEAVYDATAWRITER *)((void *)writer)); \
} \
\
void ClassName##SetAllowSetSplitting( CClassName * writer, int newAllow) \
{ \
XdmfHeavyDataWriterSetAllowSetSplitting((XDMFHEAVYDATAWRITER *)((void *)writer), newAllow); \
} \
\
void ClassName##SetFileIndex( CClassName * writer, int newIndex) \
{ \
XdmfHeavyDataWriterSetFileIndex((XDMFHEAVYDATAWRITER *)((void *)writer), newIndex); \
} \
\
void ClassName##SetFileSizeLimit( CClassName * writer, int newSize) \
{ \
XdmfHeavyDataWriterSetFileSizeLimit((XDMFHEAVYDATAWRITER *)((void *)writer), newSize); \
} \
\
void ClassName##SetMode( CClassName * writer, int mode, int * status) \
{ \
XdmfHeavyDataWriterSetMode((XDMFHEAVYDATAWRITER *)((void *)writer), mode, status); \
} \
\
void ClassName##SetReleaseData( CClassName * writer, int releaseData) \
{ \
XdmfHeavyDataWriterSetReleaseData((XDMFHEAVYDATAWRITER *)((void *)writer), releaseData); \
}
#ifdef __cplusplus
}
#endif
#endif /* XDMFHEAVYDATAWRITER_HPP_ */
|