XdmfAttribute.hpp 7.82 KB
Newer Older
Kenneth Leiter's avatar
Kenneth Leiter committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
/*****************************************************************************/
/*                                    XDMF                                   */
/*                       eXtensible Data Model and Format                    */
/*                                                                           */
/*  Id : XdmfAttribute.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.                                                 */
/*                                                                           */
/*****************************************************************************/

Ken Leiter (Civ's avatar
Ken Leiter (Civ committed
24 25 26
#ifndef XDMFATTRIBUTE_HPP_
#define XDMFATTRIBUTE_HPP_

27
// C Compatible Includes
28
#include "Xdmf.hpp"
29
#include "XdmfArray.hpp"
30 31 32 33 34
#include "XdmfAttributeCenter.hpp"
#include "XdmfAttributeType.hpp"
#include "XdmfTime.hpp"

#ifdef __cplusplus
35

36
/**
37
 * @brief Holds values located at specific parts of an XdmfGrid.
38
 *
39 40 41 42 43
 * XdmfAttribute holds values centered at specific locations of an
 * XdmfGrid. An attribute contains two properties that should be set,
 * XdmfAttributeCenter, which describes where the values are centered,
 * and XdmfAttributeType, which describes what types of values the
 * attribute contains.
44
 */
45
class XDMF_EXPORT XdmfAttribute : public XdmfArray {
Ken Leiter (Civ's avatar
Ken Leiter (Civ committed
46

47
public:
48 49 50 51

  /**
   * Create a new XdmfAttribute.
   *
52 53 54 55
   * Example of use:
   *
   * C++
   *
56
   * @dontinclude ExampleXdmfAttribute.cpp
57 58
   * @skipline //#initialization
   * @until //#initialization
59 60 61
   *
   * Python
   *
62
   * @dontinclude XdmfExampleAttribute.py
63 64
   * @skipline #//initialization
   * @until #//initialization
65
   *
66
   * @return    Constructed XdmfAttribute.
67
   */
68
  static shared_ptr<XdmfAttribute> New();
69 70 71

  virtual ~XdmfAttribute();

72
  LOKI_DEFINE_VISITABLE(XdmfAttribute, XdmfArray)
73 74 75 76 77
  static const std::string ItemTag;

  /**
   * Get the XdmfAttributeCenter associated with this attribute.
   *
78 79 80 81
   * Example of use:
   *
   * C++
   *
82
   * @dontinclude ExampleXdmfAttribute.cpp
83 84 85 86 87 88
   * @skipline //#initialization
   * @until //#initialization
   * @skipline //#setCenter
   * @until //#setCenter
   * @skipline //#getCenter
   * @until //#getCenter
89 90 91
   *
   * Python
   *
92
   * @dontinclude XdmfExampleAttribute.py
93 94 95 96 97 98
   * @skipline #//initialization
   * @until #//initialization
   * @skipline #//setCenter
   * @until #//setCenter
   * @skipline #//getCenter
   * @until #//getCenter
99
   *
100
   * @return    XdmfAttributeCenter of the attribute.
101
   */
102
  shared_ptr<const XdmfAttributeCenter> getCenter() const;
103 104 105 106 107 108 109 110

  std::map<std::string, std::string> getItemProperties() const;

  std::string getItemTag() const;

  /**
   * Get the name of the attribute.
   *
111 112 113 114
   * Example of use:
   *
   * C++
   *
115
   * @dontinclude ExampleXdmfAttribute.cpp
116 117 118 119 120 121
   * @skipline //#initialization
   * @until //#initialization
   * @skipline //#setName
   * @until //#setName
   * @skipline //#getName
   * @until //#getName
122 123 124
   *
   * Python
   *
125
   * @dontinclude XdmfExampleAttribute.py
126 127 128 129 130 131
   * @skipline #//initialization
   * @until #//initialization
   * @skipline #//setName
   * @until #//setName
   * @skipline #//getName
   * @until #//getName
132
   *
133
   * @return    A string containing the name of the attribute.
134 135 136 137 138 139
   */
  std::string getName() const;

  /**
   * Get the XdmfAttributeType associated with this attribute.
   *
140 141 142 143
   * Example of use:
   *
   * C++
   *
144
   * @dontinclude ExampleXdmfAttribute.cpp
145 146 147 148 149 150
   * @skipline //#initialization
   * @until //#initialization
   * @skipline //#setType
   * @until //#setType
   * @skipline //#getType
   * @until //#getType
151 152 153
   *
   * Python
   *
154
   * @dontinclude XdmfExampleAttribute.py
155 156 157 158 159 160
   * @skipline #//initialization
   * @until #//initialization
   * @skipline #//setType
   * @until #//setType
   * @skipline #//getType
   * @until #//getType
161
   *
162
   * @return    XdmfAttributeType of the attribute.
163
   */
164
  shared_ptr<const XdmfAttributeType> getType() const;
165 166 167 168

  /**
   * Set the XdmfAttributeCenter associated with this attribute.
   *
169 170 171 172
   * Example of use:
   *
   * C++
   *
173
   * @dontinclude ExampleXdmfAttribute.cpp
174 175 176 177
   * @skipline //#initialization
   * @until //#initialization
   * @skipline //#setCenter
   * @until //#setCenter
178 179 180
   *
   * Python
   *
181
   * @dontinclude XdmfExampleAttribute.py
182 183 184 185
   * @skipline #//initialization
   * @until #//initialization
   * @skipline #//setCenter
   * @until #//setCenter
186
   *
187
   * @param     center  The XdmfAttributeCenter to set.
188
   */
189
  void setCenter(const shared_ptr<const XdmfAttributeCenter> center);
190 191 192 193

  /**
   * Set the name of the attribute.
   *
194 195 196 197
   * Example of use:
   *
   * C++
   *
198
   * @dontinclude ExampleXdmfAttribute.cpp
199 200 201 202
   * @skipline //#initialization
   * @until //#initialization
   * @skipline //#setName
   * @until //#setName
203 204 205
   *
   * Python
   *
206
   * @dontinclude XdmfExampleAttribute.py
207 208 209 210
   * @skipline #//initialization
   * @until #//initialization
   * @skipline #//setName
   * @until #//setName
211
   *
212
   * @param     name    A string containing the name to set.
213 214 215 216 217 218
   */
  void setName(const std::string & name);

  /**
   * Set the XdmfAttributeType associated with this attribute.
   *
219 220 221 222
   * Example of use:
   *
   * C++
   *
223
   * @dontinclude ExampleXdmfAttribute.cpp
224 225 226 227
   * @skipline //#initialization
   * @until //#initialization
   * @skipline //#setType
   * @until //#setType
228 229 230
   *
   * Python
   *
231
   * @dontinclude XdmfExampleAttribute.py
232 233 234 235
   * @skipline #//initialization
   * @until #//initialization
   * @skipline #//setType
   * @until #//setType
236
   *
237
   * @param     type    XdmfAttributeType to set.
238
   */
239
  void setType(const shared_ptr<const XdmfAttributeType> type);
240

241 242
  XdmfAttribute(XdmfAttribute &);

243
protected:
244 245 246 247 248

  XdmfAttribute();

  virtual void
  populateItem(const std::map<std::string, std::string> & itemProperties,
249
               const std::vector<shared_ptr<XdmfItem> > & childItems,
250 251
               const XdmfCoreReader * const reader);

252
private:
253 254 255 256

  XdmfAttribute(const XdmfAttribute &);  // Not implemented.
  void operator=(const XdmfAttribute &);  // Not implemented.

257
  shared_ptr<const XdmfAttributeCenter> mCenter;
258
  std::string mName;
259
  shared_ptr<const XdmfAttributeType> mType;
Ken Leiter (Civ's avatar
Ken Leiter (Civ committed
260 261
};

262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289
#endif

#ifdef __cplusplus
extern "C" {
#endif

// C wrappers go here

struct XDMFATTRIBUTE; // Simply as a typedef to ensure correct typing
typedef struct XDMFATTRIBUTE XDMFATTRIBUTE;

XDMF_EXPORT XDMFATTRIBUTE * XdmfAttributeNew();

XDMF_EXPORT int XdmfAttributeGetCenter(XDMFATTRIBUTE * attribute);

XDMF_EXPORT int XdmfAttributeGetType(XDMFATTRIBUTE * attribute);

XDMF_EXPORT void XdmfAttributeSetCenter(XDMFATTRIBUTE * attribute, int center, int * status);

XDMF_EXPORT void XdmfAttributeSetType(XDMFATTRIBUTE * attribute, int type, int * status);

XDMF_ITEM_C_CHILD_DECLARE(XdmfAttribute, XDMFATTRIBUTE, XDMF)
XDMF_ARRAY_C_CHILD_DECLARE(XdmfAttribute, XDMFATTRIBUTE, XDMF)

#ifdef __cplusplus
}
#endif

Ken Leiter (Civ's avatar
Ken Leiter (Civ committed
290
#endif /* XDMFATTRIBUTE_HPP_ */