/usr/include/XdmfInformation.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 | /*****************************************************************************/
/* XDMF */
/* eXtensible Data Model and Format */
/* */
/* Id : XdmfInformation.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 XDMFINFORMATION_HPP_
#define XDMFINFORMATION_HPP_
// C Compatible Includes
#include "XdmfCore.hpp"
#include "XdmfItem.hpp"
#include "XdmfArray.hpp"
#ifdef __cplusplus
// Forward declarations
class XdmfArray;
/**
* @brief Holds a key/value pair that can be attached to an Xdmf
* structure.
*
* XdmfInformation stores two strings as a key value pair. These can
* be used to store input parameters to a code or for simple result
* data like wall time.
*/
class XDMFCORE_EXPORT XdmfInformation : public XdmfItem {
public:
/**
* Create a new XdmfInformation.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfInformation.cpp
* @skipline //#initialization
* @until //#initialization
*
* Python
*
* @dontinclude XdmfExampleInformation.py
* @skipline #//initialization
* @until #//initialization
*
* @return Constructed XdmfInformation.
*/
static shared_ptr<XdmfInformation> New();
/**
* Create a new XdmfInformation.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfInformation.cpp
* @skipline //#initializationfull
* @until //#initializationfull
*
* Python
*
* @dontinclude XdmfExampleInformation.py
* @skipline #//initializationfull
* @until #//initializationfull
*
* @param key A string containing the key of the XdmfInformation to create.
* @param value A string containing the value of the XdmfInformation to
* create.
*
* @return Constructed XdmfInformation
*/
static shared_ptr<XdmfInformation> New(const std::string & key,
const std::string & value);
virtual ~XdmfInformation();
LOKI_DEFINE_VISITABLE(XdmfInformation, XdmfItem)
XDMF_CHILDREN(XdmfInformation, XdmfArray, Array, Name)
static const std::string ItemTag;
std::map<std::string, std::string> getItemProperties() const;
virtual std::string getItemTag() const;
/**
* Get the key for this information item.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfInformation.cpp
* @skipline //#initializationfull
* @until //#initializationfull
* @skipline //#getKey
* @until //#getKey
*
* Python
*
* @dontinclude XdmfExampleInformation.py
* @skipline #//initializationfull
* @until #//initializationfull
* @skipline #//getKey
* @until #//getKey
*
* @return A string containing the key.
*/
std::string getKey() const;
/**
* Get the value for this information item.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfInformation.cpp
* @skipline //#initializationfull
* @until //#initializationfull
* @skipline //#getValue
* @until //#getValue
*
* Python
*
* @dontinclude XdmfExampleInformation.py
* @skipline #//initializationfull
* @until #//initializationfull
* @skipline #//getValue
* @until #//getValue
*
* @return A string containing the value.
*/
std::string getValue() const;
using XdmfItem::insert;
/**
* Set the key for this information item.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfInformation.cpp
* @skipline //#initializationfull
* @until //#initializationfull
* @skipline //#setKey
* @until //#setKey
*
* Python
*
* @dontinclude XdmfExampleInformation.py
* @skipline #//initializationfull
* @until #//initializationfull
* @skipline #//setKey
* @until #//setKey
*
* @param key A string containing the key to set.
*/
void setKey(const std::string & key);
/**
* Set the value for this information item.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfInformation.cpp
* @skipline //#initializationfull
* @until //#initializationfull
* @skipline //#setValue
* @until //#setValue
*
* Python
*
* @dontinclude XdmfExampleInformation.py
* @skipline #//initializationfull
* @until #//initializationfull
* @skipline #//setValue
* @until #//setValue
*
* @param value A string containing the value to set.
*/
void setValue(const std::string & value);
virtual void traverse(const shared_ptr<XdmfBaseVisitor> visitor);
XdmfInformation(XdmfInformation &);
protected:
XdmfInformation(const std::string & key = "",
const std::string & value = "");
virtual void
populateItem(const std::map<std::string, std::string> & itemProperties,
const std::vector<shared_ptr<XdmfItem> > & childItems,
const XdmfCoreReader * const reader);
private:
XdmfInformation(const XdmfInformation &);
void operator=(const XdmfInformation &); // Not implemented.
std::string mKey;
std::string mValue;
};
#endif
#ifdef __cplusplus
extern "C" {
#endif
// C wrappers go here
#ifndef XDMFINFORMATIONCDEFINE
#define XDMFINFORMATIONCDEFINE
struct XDMFINFORMATION; // Simply as a typedef to ensure correct typing
typedef struct XDMFINFORMATION XDMFINFORMATION;
#endif
XDMFCORE_EXPORT XDMFINFORMATION * XdmfInformationNew(char * key, char * value);
XDMFCORE_EXPORT XDMFARRAY * XdmfInformationGetArray(XDMFINFORMATION * information, unsigned int index);
XDMFCORE_EXPORT XDMFARRAY * XdmfInformationGetArrayByName(XDMFINFORMATION * information, char * name);
XDMFCORE_EXPORT char * XdmfInformationGetKey(XDMFINFORMATION * information);
XDMFCORE_EXPORT unsigned int XdmfInformationGetNumberArrays(XDMFINFORMATION * information);
XDMFCORE_EXPORT char * XdmfInformationGetValue(XDMFINFORMATION * information);
XDMFCORE_EXPORT void XdmfInformationInsertArray(XDMFINFORMATION * information, XDMFARRAY * array, int transferOwnership);
XDMFCORE_EXPORT void XdmfInformationRemoveArray(XDMFINFORMATION * information, unsigned int index);
XDMFCORE_EXPORT void XdmfInformationRemoveArrayByName(XDMFINFORMATION * information, char * name);
XDMFCORE_EXPORT void XdmfInformationSetKey(XDMFINFORMATION * information, char * key, int * status);
XDMFCORE_EXPORT void XdmfInformationSetValue(XDMFINFORMATION * information, char * value, int * status);
// C Wrappers for parent classes are generated by macros
XDMF_ITEM_C_CHILD_DECLARE(XdmfInformation, XDMFINFORMATION, XDMFCORE)
#ifdef __cplusplus
}
#endif
#endif /* XDMFINFORMATION_HPP_ */
|