/usr/include/paraview/vtkSQBOVReaderBase.h is in paraview-dev 5.0.1+dfsg1-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 | /*
* Copyright 2012 SciberQuest Inc.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* * Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* * Neither name of SciberQuest Inc. nor the names of any contributors may be
* used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE FOR
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
// .NAME vtkSQBOVReaderBase -- Connects the VTK pipeline to BOVReader class.
// .SECTION Description
//
// Implements the VTK style pipeline and manipulates and instance of
// BOVReader so that "brick of values" datasets, including time series,
// can be read in parallel.
//
// .SECTION See Also
// BOVReader
#ifndef vtkSQBOVReaderBase_h
#define vtkSQBOVReaderBase_h
#include "vtkSciberQuestModule.h" // for export macro
#include "vtkDataSetAlgorithm.h"
#include <vector> // for vector
#include <string> // for string
// #define vtkSQBOVReaderDEBUG
//BTX
class BOVReader;
class vtkPVXMLElement;
class vtkInformationStringKey;
class vtkInformationDoubleKey;
class vtkInformationDoubleVectorKey;
class vtkInformationIntegerKey;
class vtkInformationIntegerVectorKey;
//ETX
class VTKSCIBERQUEST_EXPORT vtkSQBOVReaderBase : public vtkDataSetAlgorithm
{
public:
static vtkSQBOVReaderBase *New();
vtkTypeMacro(vtkSQBOVReaderBase,vtkDataSetAlgorithm);
virtual void PrintSelf(ostream& os, vtkIndent indent);
// Description:
// Iitialize the reader from an XML document. You also need to
// pass in the bov file name so that subsetting and array selection
// can be applied which has to occur after the file has been opened.
//BTX
virtual int Initialize(
vtkPVXMLElement *root,
const char *fileName,
std::vector<std::string> &arrays);
//ETX
// Description:
// Get/Set the file to read. Setting the file name opens
// the file. Perhaps it's bad style but this is where open
// fits best in VTK/PV pipeline execution.
virtual void SetFileName(const char *file);
vtkGetStringMacro(FileName);
// Description
// Determine if the file can be read by opening it. If the open
// succeeds then we assume th file is readable. Open is restricted
// to the calling rank. Only one rank should call CanReadFile.
virtual int CanReadFile(const char *file);
// Descritpion:
// Get status indicating if a file is opened successfully.
virtual bool IsOpen();
// Description:
// Array selection.
virtual void SetPointArrayStatus(const char *name, int status);
virtual int GetPointArrayStatus(const char *name);
virtual int GetNumberOfPointArrays();
virtual const char* GetPointArrayName(int idx);
virtual void ClearPointArrayStatus();
// Description:
// Subseting interface.
virtual void SetSubset(
int ilo,
int ihi,
int jlo,
int jhi,
int klo,
int khi);
virtual void SetSubset(const int *s);
vtkGetVector6Macro(Subset,int);
// Description:
// For PV UI. Range domains only work with arrays of size 2.
virtual void SetISubset(int ilo, int ihi);
virtual void SetJSubset(int jlo, int jhi);
virtual void SetKSubset(int klo, int khi);
vtkGetVector2Macro(ISubsetRange,int);
vtkGetVector2Macro(JSubsetRange,int);
vtkGetVector2Macro(KSubsetRange,int);
// Description:
// Set the reader's projection mode.
// If set then the reader will project the field into one
// of the axis aligned spaces, XY,XZ, or YZ.
virtual void SetVectorProjection(int mode);
virtual int GetVectorProjection();
// Description:
// Time domain discovery interface.
virtual int GetNumberOfTimeSteps();
virtual void GetTimeSteps(double *times);
//BTX
enum
{
HINT_DEFAULT=0,
HINT_AUTOMATIC=0,
HINT_DISABLED=1,
HINT_ENABLED=2
};
//ETX
// Description:
// Set/Get MPI file hints.
vtkSetMacro(UseCollectiveIO,int);
vtkGetMacro(UseCollectiveIO,int);
vtkSetMacro(NumberOfIONodes,int);
vtkGetMacro(NumberOfIONodes,int);
vtkSetMacro(CollectBufferSize,int);
vtkGetMacro(CollectBufferSize,int);
vtkSetMacro(UseDirectIO,int);
vtkGetMacro(UseDirectIO,int);
vtkSetMacro(UseDeferredOpen,int);
vtkGetMacro(UseDeferredOpen,int);
vtkSetMacro(UseDataSieving,int);
vtkGetMacro(UseDataSieving,int);
vtkSetMacro(SieveBufferSize,int);
vtkGetMacro(SieveBufferSize,int);
// Description:
// Set the log level.
// 0 -- no logging
// 1 -- basic logging
// .
// n -- advanced logging
vtkSetMacro(LogLevel,int);
vtkGetMacro(LogLevel,int);
protected:
virtual int RequestInformation(
vtkInformation *req,
vtkInformationVector **inInfos,
vtkInformationVector *outInfos);
virtual int RequestDataObject(
vtkInformation *req,
vtkInformationVector** inInfos,
vtkInformationVector* outInfos);
vtkSQBOVReaderBase();
virtual ~vtkSQBOVReaderBase();
// iniitialize the object
virtual void Clear();
// pass the hints onto MPI
virtual void SetMPIFileHints();
//
virtual int GetTimeStepId(vtkInformation *inInfo, vtkInformation *outInfo);
private:
vtkSQBOVReaderBase(const vtkSQBOVReaderBase &); // Not implemented
void operator=(const vtkSQBOVReaderBase &); // Not implemented
protected:
BOVReader *Reader; // Implementation
char *FileName; // Name of data file to load.
bool FileNameChanged; // Flag indicating that the dataset needs to be opened
int Subset[6]; // Subset to read
int ISubsetRange[2]; // bounding extents of the subset
int JSubsetRange[2];
int KSubsetRange[2];
int WorldRank; // rank of this process
int WorldSize; // number of processes
int UseCollectiveIO; // Turn on/off collective IO
int NumberOfIONodes; // Number of aggregator for CIO
int CollectBufferSize; // Gather buffer size (if small IO is staged).
int UseDirectIO; // turn on/off direct I/O
int UseDeferredOpen; // Turn on/off deffered open (only agg.'s open)
int UseDataSieving; // Turn on/off data sieving
int SieveBufferSize; // Sieve size.
int VectorProjection; // to zero out one vector component
int LogLevel;
};
#endif
|