XdmfAttributeCenter.hpp 4.79 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 : XdmfAttributeCenter.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.                                                 */
/*                                                                           */
/*****************************************************************************/

24 25 26
#ifndef XDMFATTRIBUTECENTER_HPP_
#define XDMFATTRIBUTECENTER_HPP_

27
// C Compatible Includes
28
#include "Xdmf.hpp"
29
#include "XdmfItemProperty.hpp"
30

31 32
#ifdef __cplusplus

33 34 35
/**
 * @brief Property describing where XdmfAttribute values are centered.
 *
36 37 38 39
 * XdmfAttributeCenter is a property used by XdmfAttribute to specify
 * where its values are centered on an XdmfGrid. A specific
 * XdmfAttributeCenter can be created by calling on of the static
 * methods in the class, i.e.  XdmfAttributeCenter::Cell().
40
 * Xdmf supports the following attribute centers:
41 42
 *
 * Example of use:
43 44 45 46
 *
 * C++
 *
 * @dontinclude ExampleXdmfAttribute.cpp
47 48 49 50 51 52
 * @skipline //#initialization
 * @until //#initialization
 * @skipline //#setCenter
 * @until //#setCenter
 * @skipline //#getCenter
 * @until //#getCenter
53 54 55 56
 *
 * Python
 *
 * @dontinclude XdmfExampleAttribute.py
57 58 59 60 61 62
 * @skipline #//initialization
 * @until #//initialization
 * @skipline #//setCenter
 * @until #//setCenter
 * @skipline #//getCenter
 * @until #//getCenter
63
 *
64 65 66 67 68
 *   Grid
 *   Cell
 *   Face
 *   Edge
 *   Node
69
 */
70
class XDMF_EXPORT XdmfAttributeCenter : public XdmfItemProperty {
71

72
public:
73

74
  virtual ~XdmfAttributeCenter();
75

76
  friend class XdmfAttribute;
77

78
  // Supported Xdmf Attribute Centers
79 80 81 82 83
  static shared_ptr<const XdmfAttributeCenter> Grid();
  static shared_ptr<const XdmfAttributeCenter> Cell();
  static shared_ptr<const XdmfAttributeCenter> Face();
  static shared_ptr<const XdmfAttributeCenter> Edge();
  static shared_ptr<const XdmfAttributeCenter> Node();
84
  static shared_ptr<const XdmfAttributeCenter> Other();
85

86 87
  void
  getProperties(std::map<std::string, std::string> & collectedProperties) const;
88

89

90
protected:
91

92
  /**
93 94 95 96 97
   * Protected constructor for XdmfAttributeCenter.  The constructor
   * is protected because all attribute centers supported by Xdmf
   * should be accessed through more specific static methods that
   * construct XdmfAttributeCenters -
   * i.e. XdmfAttributeCenter::Node().
98
   *
99
   * @param     name    The name of the XdmfAttributeCenter to construct.
100 101
   */
  XdmfAttributeCenter(const std::string & name);
102

103 104 105 106
  static std::map<std::string, shared_ptr<const XdmfAttributeCenter>(*)()> mAttributeCenterDefinitions;

  static void InitTypes();

107
private:
108

109 110
  XdmfAttributeCenter(const XdmfAttributeCenter &); // Not implemented.
  void operator=(const XdmfAttributeCenter &); // Not implemented.
111

112
  static shared_ptr<const XdmfAttributeCenter>
113
  New(const std::map<std::string, std::string> & itemProperties);
114

115
  std::string mName;
116 117
};

118 119 120 121 122 123 124 125 126 127 128 129 130
#endif

#ifdef __cplusplus
extern "C" {
#endif

// C wrappers go here

#define XDMF_ATTRIBUTE_CENTER_GRID 100
#define XDMF_ATTRIBUTE_CENTER_CELL 101
#define XDMF_ATTRIBUTE_CENTER_FACE 102
#define XDMF_ATTRIBUTE_CENTER_EDGE 103
#define XDMF_ATTRIBUTE_CENTER_NODE 104
131
#define XDMF_ATTRIBUTE_CENTER_OTHER 105
132 133 134 135 136 137

XDMF_EXPORT int XdmfAttributeCenterGrid();
XDMF_EXPORT int XdmfAttributeCenterCell();
XDMF_EXPORT int XdmfAttributeCenterFace();
XDMF_EXPORT int XdmfAttributeCenterEdge();
XDMF_EXPORT int XdmfAttributeCenterNode();
138
XDMF_EXPORT int XdmfAttributeCenterOther();
139 140 141 142 143

#ifdef __cplusplus
}
#endif

144
#endif /* XDMFATTRIBUTECENTER_HPP_ */