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
|
/*****************************************************************************/
/* XDMF */
/* eXtensible Data Model and Format */
/* */
/* Id : XdmfCoreReader.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 XDMFCOREREADER_HPP_
#define XDMFCOREREADER_HPP_
// C Compatible Includes
#include "XdmfCore.hpp"
#include "XdmfHeavyDataController.hpp"
#include "XdmfHeavyDataWriter.hpp"
#include "XdmfItem.hpp"
#ifdef __cplusplus
// Forward Declarations
class XdmfCoreItemFactory;
// Includes
#include <string>
#include <vector>
#include "XdmfSharedPtr.hpp"
/**
* @brief Reads an Xdmf file stored on disk into memory.
*
* Reads an Xdmf file stored on disk into an Xdmf structure in memory.
* All light data is parsed in order to create appropriate Xdmf
* objects. Heavy data controllers are created and attached to
* XdmfArrays but no heavy data is read into memory.
*
* XdmfCoreReader is an abstract base class.
*/
class XDMFCORE_EXPORT XdmfCoreReader {
public:
virtual ~XdmfCoreReader() = 0;
/**
* Uses the internal item factory to create a copy of the internal pointer
* of the provided shared pointer. Primarily used for C wrapping.
*
* @param original The source shared pointer that the pointer will be pulled from.
* @return A duplicate of the object contained in the pointer.
*/
virtual XdmfItem * DuplicatePointer(shared_ptr<XdmfItem> original) const;
virtual std::vector<shared_ptr<XdmfHeavyDataController> >
generateHeavyDataControllers(std::map<std::string, std::string> controllerProperties,
const std::vector<unsigned int> & passedDimensions = std::vector<unsigned int>(),
shared_ptr<const XdmfArrayType> passedArrayType = shared_ptr<const XdmfArrayType>(),
const std::string & passedFormat = std::string()) const;
virtual shared_ptr<XdmfHeavyDataWriter>
generateHeavyDataWriter(std::string typeName, std::string path) const;
/**
* Parse a string containing light data into an Xdmf structure in
* memory.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfCoreReader.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#parse
* @until //#parse
*
* Python
*
* @dontinclude XdmfExampleCoreReader.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//parse
* @until #//parse
*
* @param lightData A string containing light data description of an
* Xdmf file.
*
* @return An XdmfItem at the root of the Xdmf tree.
*/
virtual shared_ptr<XdmfItem> parse(const std::string & lightData) const;
/**
* Read an Xdmf file from disk into memory.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfCoreReader.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#readpath
* @until //#readpath
* @skipline //#readroot
* @until //#readroot
*
* Python
*
* @dontinclude XdmfExampleCoreReader.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//readpath
* @until #//readpath
* @skipline #//readroot
* @until #//readroot
*
* @param filePath The path of the Xdmf file to read in from disk.
*
* @return An XdmfItem at the root of the Xdmf tree.
*/
virtual shared_ptr<XdmfItem> read(const std::string & filePath) const;
/**
* Read part of an Xdmf file from disk into memory.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfCoreReader.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#readpath
* @until //#readpath
* @skipline //#readXPath
* @until //#readXPath
*
* Python
*
* @dontinclude XdmfExampleCoreReader.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//readpath
* @until #//readpath
* @skipline #//readXPath
* @until #//readXPath
*
* @param filePath The path of the Xdmf file to read in from disk.
* @param xPath An XPath corresponding to the portion of the
* file to read.
*
* @return A vector of XdmfItems that are included
* in the XPath.
*/
virtual std::vector<shared_ptr<XdmfItem> >
read(const std::string & filePath,
const std::string & xPath) const;
/**
* Read an Xdmf file from disk into memory.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfCoreReader.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#readpath
* @until //#readpath
* @skipline //#readItems
* @until //#readItems
*
* Python
*
* @dontinclude XdmfExampleCoreReader.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//readpath
* @until #//readpath
* @skipline #//readItems
* @until #//readItems
*
* @param filePath The path of the Xdmf file to read in from disk.
*
* @return A vector of XdmfItems at the root of the Xdmf tree.
*/
virtual std::vector<shared_ptr<XdmfItem> >
readItems(const std::string & filePath) const;
/**
* Used by the other functions to read items from an open file.
*
* Since files are closed between reads, this does nothing by itself.
*
* @param xPath An XPath corresponding to the portion of the file to read.
*
* @return A vector of items at the X path provided.
*/
std::vector<shared_ptr<XdmfItem> >
readPathObjects(const std::string & xPath) const;
protected:
/**
* Constructor
*
* @param itemFactory an XdmfCoreItemFactory to construct XdmfItems
* for a specific language.
*/
XdmfCoreReader(const shared_ptr<const XdmfCoreItemFactory> itemFactory);
private:
/**
* PIMPL
*/
class XdmfCoreReaderImpl;
XdmfCoreReader(const XdmfCoreReader &); // Not implemented.
void operator=(const XdmfCoreReader &); // Not implemented.
XdmfCoreReaderImpl * const mImpl;
};
#endif
#ifdef __cplusplus
extern "C" {
#endif
// C wrappers go here
struct XDMFCOREREADER; // Simply as a typedef to ensure correct typing
typedef struct XDMFCOREREADER XDMFCOREREADER;
XDMFCORE_EXPORT XDMFITEM * XdmfCoreReaderRead(XDMFCOREREADER * reader, char * filePath, int * status);
#define XDMF_CORE_READER_C_CHILD_DECLARE(ClassName, CClassName, Level) \
\
Level##_EXPORT XDMFITEM * ClassName##Read( CClassName * reader, char * filePath, int * status);
#define XDMF_CORE_READER_C_CHILD_WRAPPER(ClassName, CClassName) \
\
XDMFITEM * ClassName##Read( CClassName * reader, char * filePath, int * status) \
{ \
return XdmfCoreReaderRead((XDMFCOREREADER *)((void *)reader), filePath, status); \
}
#ifdef __cplusplus
}
#endif
#endif /* XDMFCOREREADER_HPP_ */
|
