/usr/include/XdmfSet.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 | /*****************************************************************************/
/* XDMF */
/* eXtensible Data Model and Format */
/* */
/* Id : XdmfSet.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 XDMFSET_HPP_
#define XDMFSET_HPP_
// C Compatible Includes
#include "Xdmf.hpp"
#include "XdmfArray.hpp"
#include "XdmfAttribute.hpp"
#include "XdmfSetType.hpp"
#ifdef __cplusplus
// Forward Declarations
class XdmfAttribute;
class XdmfHDF5Controller;
/**
* @brief Holds a collection of individual nodes, cells, faces, or
* edges that are part of an XdmfGrid.
*
* An XdmfSet holds a collection of nodes, cells, faces, or edges that
* are part of an XdmfGrid. For instance, a simulation may want to
* hold a set of nodes on a boundary. The individual elements making
* up the set are determined by their id. An XdmfSet can have
* XdmfAttributes attached that contain extra values attached to the
* elements in the set.
*/
class XDMF_EXPORT XdmfSet : public XdmfArray {
public:
/**
* Create a new XdmfSet.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfSet.cpp
* @skipline //#initialize
* @until //#initialize
*
* Python
*
* @dontinclude XdmfExampleSet.py
* @skipline #//initialize
* @until #//initialize
*
* @return Constructed XdmfSet.
*/
static shared_ptr<XdmfSet> New();
virtual ~XdmfSet();
LOKI_DEFINE_VISITABLE(XdmfSet, XdmfArray)
XDMF_CHILDREN(XdmfSet, XdmfAttribute, Attribute, Name)
static const std::string ItemTag;
std::map<std::string, std::string> getItemProperties() const;
std::string getItemTag() const;
/**
* Get the name of the set.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfSet.cpp
* @skipline //#initialize
* @until //#initialize
* @skipline //#setName
* @until //#setName
* @skipline //#getName
* @until //#getName
*
* Python
*
* @dontinclude XdmfExampleSet.py
* @skipline #//initialize
* @until #//initialize
* @skipline #//setName
* @until #//setName
* @skipline #//getName
* @until #//getName
*
* @return A string containing the name of the set.
*/
std::string getName() const;
/**
* Get the XdmfSetType associated with this set.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfSet.cpp
* @skipline //#initialize
* @until //#initialize
* @skipline //#setType
* @until //#setType
* @skipline //#getType
* @until //#getType
*
* Python
*
* @dontinclude XdmfExampleSet.py
* @skipline #//initialize
* @until #//initialize
* @skipline #//setType
* @until #//setType
* @skipline #//getType
* @until #//getType
*
* @return XdmfSetType of this set.
*/
shared_ptr<const XdmfSetType> getType() const;
using XdmfArray::insert;
#if defined(SWIG)
using XdmfItem::insert;
#endif
/**
* Set the name of the set.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfSet.cpp
* @skipline //#initialize
* @until //#initialize
* @skipline //#setName
* @until //#setName
*
* Python
*
* @dontinclude XdmfExampleSet.py
* @skipline #//initialize
* @until #//initialize
* @skipline #//setName
* @until #//setName
*
* @param name A string containing the name to set.
*/
void setName(const std::string & name);
/**
* Set the XdmfSetType associated with this set.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfSet.cpp
* @skipline //#initialize
* @until //#initialize
* @skipline //#setType
* @until //#setType
*
* Python
*
* @dontinclude XdmfExampleSet.py
* @skipline //#initialize
* @until //#initialize
* @skipline //#setType
* @until //#setType
*
* @param type The XdmfSetType to set.
*/
void setType(const shared_ptr<const XdmfSetType> type);
void traverse(const shared_ptr<XdmfBaseVisitor> visitor);
XdmfSet(XdmfSet &);
protected:
XdmfSet();
virtual void
populateItem(const std::map<std::string, std::string> & itemProperties,
const std::vector<shared_ptr<XdmfItem> > & childItems,
const XdmfCoreReader * const reader);
private:
XdmfSet(const XdmfSet &);
void operator=(const XdmfSet &); // Not implemented.
std::string mName;
shared_ptr<const XdmfSetType> mType;
};
#endif
#ifdef __cplusplus
extern "C" {
#endif
// C wrappers go here
struct XDMFSET; // Simply as a typedef to ensure correct typing
typedef struct XDMFSET XDMFSET;
XDMF_EXPORT XDMFSET * XdmfSetNew();
XDMF_EXPORT XDMFATTRIBUTE * XdmfSetGetAttribute(XDMFSET * set, unsigned int index);
XDMF_EXPORT XDMFATTRIBUTE * XdmfSetGetAttributeByName(XDMFSET * set, char * Name);
XDMF_EXPORT unsigned int XdmfSetGetNumberAttributes(XDMFSET * set);
XDMF_EXPORT int XdmfSetGetType(XDMFSET * set);
XDMF_EXPORT void XdmfSetInsertAttribute(XDMFSET * set, XDMFATTRIBUTE * Attribute, int passControl);
XDMF_EXPORT void XdmfSetRemoveAttribute(XDMFSET * set, unsigned int index);
XDMF_EXPORT void XdmfSetRemoveAttributeByName(XDMFSET * set, char * Name);
XDMF_EXPORT void XdmfSetSetType(XDMFSET * set, int type, int * status);
XDMF_ITEM_C_CHILD_DECLARE(XdmfSet, XDMFSET, XDMF)
XDMF_ARRAY_C_CHILD_DECLARE(XdmfSet, XDMFSET, XDMF)
#ifdef __cplusplus
}
#endif
#endif /* XDMFSET_HPP_ */
|