/usr/include/XdmfGeometry.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 | /*****************************************************************************/
/* XDMF */
/* eXtensible Data Model and Format */
/* */
/* Id : XdmfGeometry.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 XDMFGEOMETRY_HPP_
#define XDMFGEOMETRY_HPP_
// C Compatible Includes
#include "Xdmf.hpp"
#include "XdmfArray.hpp"
#include "XdmfGeometryType.hpp"
#ifdef __cplusplus
/**
* @brief Handles the coordinate positions of points in an XdmfGrid.
*
* XdmfGeometry is a required part of an XdmfGrid. It stores the
* coordinate locations of all points contained in an
* XdmfGrid. XdmfGeometry contains an XdmfGeometryType property which
* should be set that specifies the types of coordinate values stored.
*/
class XDMF_EXPORT XdmfGeometry : public XdmfArray {
public:
/**
* Create a new XdmfGeometry.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfGeometry.cpp
* @skipline //#initialization
* @until //#initialization
*
* Python
*
* @dontinclude XdmfExampleGeometry.py
* @skipline #//initialization
* @until #//initialization
*
* @return Constructed XdmfGeometry.
*/
static shared_ptr<XdmfGeometry> New();
virtual ~XdmfGeometry();
LOKI_DEFINE_VISITABLE(XdmfGeometry, XdmfArray)
static const std::string ItemTag;
std::map<std::string, std::string> getItemProperties() const;
std::string getItemTag() const;
/**
* Get the number of points stored in this geometry.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfGeometry.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#getNumberPoints
* @until //#getNumberPoints
*
* Python
*
* @dontinclude XdmfExampleGeometry.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//getNumberPoints
* @until #//getNumberPoints
*/
virtual unsigned int getNumberPoints() const;
/**
* Gets the origin of the geometry. This value defaults to (0, 0, 0)
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfGeometry.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#getOrigin
* @until //#getOrigin
*
* Python
*
* @dontinclude XdmfExampleGeometry.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//getOrigin
* @until #//getOrigin
*
* @return A vector containing the current location
* of the origin of this geometry
*/
std::vector<double> getOrigin() const;
/**
* Get the XdmfGeometryType associated with this geometry.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfGeometry.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#getType
* @until //#getType
*
* Python
*
* @dontinclude XdmfExampleGeometry.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//getType
* @until #//getType
*
* @return XdmfGeometryType of this geometry.
*/
shared_ptr<const XdmfGeometryType> getType() const;
/**
* Sets the origin of the geometry.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfGeometry.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#setOrigin
* @until //#setOrigin
*
* Python
*
* @dontinclude XdmfExampleGeometry.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//setOrigin
* @until #//setOrigin
*
* @param newX The new X value of the origin.
* @param newY The new Y value of the origin.
* @param newZ The new Z value of the origin.
*/
void setOrigin(double newX, double newY, double newZ = 0.0);
void setOrigin(std::vector<double> newOrigin);
/**
* Set the XdmfGeometryType associated with this geometry.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfGeometry.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#setType
* @until //#setType
*
* Python
*
* @dontinclude XdmfExampleGeometry.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//setType
* @until #//setType
*
* @param type The XdmfGeometryType to set.
*/
void setType(const shared_ptr<const XdmfGeometryType> type);
XdmfGeometry(XdmfGeometry &);
protected:
XdmfGeometry();
virtual void
populateItem(const std::map<std::string, std::string> & itemProperties,
const std::vector<shared_ptr<XdmfItem> > & childItems,
const XdmfCoreReader * const reader);
private:
XdmfGeometry(const XdmfGeometry &); // Not implemented.
void operator=(const XdmfGeometry &); // Not implemented.
int mNumberPoints;
shared_ptr<const XdmfGeometryType> mType;
std::vector<double> mOrigin;
};
#endif
#ifdef __cplusplus
extern "C" {
#endif
// C wrappers go here
struct XDMFGEOMETRY; // Simply as a typedef to ensure correct typing
typedef struct XDMFGEOMETRY XDMFGEOMETRY;
XDMF_EXPORT XDMFGEOMETRY * XdmfGeometryNew();
XDMF_EXPORT unsigned int XdmfGeometryGetNumberPoints(XDMFGEOMETRY * geometry);
XDMF_EXPORT double * XdmfGeometryGetOrigin(XDMFGEOMETRY * geometry);
XDMF_EXPORT int XdmfGeometryGetOriginSize(XDMFGEOMETRY * geometry);
XDMF_EXPORT int XdmfGeometryGetType(XDMFGEOMETRY * geometry);
XDMF_EXPORT void XdmfGeometrySetOrigin(XDMFGEOMETRY * geometry, double newX, double newY, double newZ);
XDMF_EXPORT void XdmfGeometrySetOriginArray(XDMFGEOMETRY * geometry, double * originVals, unsigned int numDims);
XDMF_EXPORT void XdmfGeometrySetType(XDMFGEOMETRY * geometry, int type, int * status);
XDMF_ITEM_C_CHILD_DECLARE(XdmfGeometry, XDMFGEOMETRY, XDMF)
XDMF_ARRAY_C_CHILD_DECLARE(XdmfGeometry, XDMFGEOMETRY, XDMF)
#ifdef __cplusplus
}
#endif
#endif /* XDMFGEOMETRY_HPP_ */
|